Compare commits

..
69 Commits
Author SHA1 Message Date
Barry vd. Heuvel a9dae91e4d Require doctrine for dev 2014-06-29 16:07:17 +02:00
Barry vd. Heuvel 645926fd37 Improve trait check
Fixes #83
2014-06-29 13:34:52 +02:00
Barry vd. Heuvel 0b70167182 Make doctrine optional
Not needed for most people.
2014-06-29 12:35:57 +02:00
Barry vd. Heuvel 138b3deeb1 Loosen reflection-docblock 2014-06-29 12:09:11 +02:00
Barry vd. Heuvel 9f265f0178 Add 1.x-dev branch-alias 2014-06-29 12:03:46 +02:00
Barry vd. Heuvel 26e02d295f Update readme.md 2014-06-25 19:29:03 +02:00
Barry vd. Heuvel bfe955ce1f Add laracasts link 2014-06-25 19:25:35 +02:00
Barry vd. Heuvel 50e760bac1 Merge pull request #85 from ismailbaskin/master
Allowing to this package installed by rtablada/package-installer
2014-06-06 08:56:41 +02:00
Ismail BASKIN e882cdf84d Allowing to this package installed by rtablada/package-installer 2014-06-05 20:19:22 +03:00
Barry vd. Heuvel c1286d5a9e Skip traits
See #83
2014-06-05 09:44:37 +02:00
Barry vd. Heuvel b92d24429d Enable
Might be useful after all ;)
2014-05-20 10:41:24 +02:00
Barry vd. Heuvel f77f5ae770 Disable where field
Maybe make it optional? Feels kind of bloated..
2014-04-25 13:47:00 +02:00
Barry vd. Heuvel 82ffa52d79 Merge pull request #77 from ukautz/feature-polymorphic
Added property methods for polymorphic relations
2014-04-22 14:29:06 +02:00
Ulrich Kautz d8ed55be7a Added property methods for polymorphic relations 2014-04-22 14:25:44 +02:00
Barry vd. Heuvel 16f77638f1 Move helpers to root
To get them in the namespace.
2014-03-20 16:20:31 +01:00
Barry vd. Heuvel 348ecb361c Fix helper files.
Fixes #72
2014-03-20 16:15:55 +01:00
Barry vd. Heuvel df8852e8dd Use FQN for extending/root
Otherwise it doesn't work in namespaces.
2014-03-18 14:22:52 +01:00
Barry vd. Heuvel 95ab3676dc Merge pull request #71 from szkuwa/master
Wrapping everything with namespaces to allow namespaced aliases
2014-03-18 14:14:18 +01:00
Michał Bieda bf6ca64a08 Wrapping everything with namespaces to allow namespaced aliases 2014-03-18 13:59:57 +01:00
Barry vd. Heuvel 4e36c08168 Update readme 2014-03-05 18:35:42 +01:00
Barry vd. Heuvel 0577429e4e Merge pull request #67 from SebSept/master
"An Eloquent Model:" is not necessary, removed it.
2014-03-04 08:49:25 +01:00
Sébastien Monterisi 77fbef112d "An Eloquent Model:" is not necessary, removed it.
Not needind it since that information is gathered by IDE* with class definition.

```class Party extends Eloquent {```

*:(almost all ide will, I guess)
2014-03-04 02:25:02 +01:00
Barry vd. Heuvel bb92081dde Merge pull request #65 from hailwood/patch-1
Update ModelsCommand.php
2014-02-25 10:03:02 +01:00
Matthew Hailwood 23b41db33d Update ModelsCommand.php
Fix for #61 - also returns query builder instance
2014-02-23 18:05:03 +13:00
Barry vd. Heuvel 7b47af171d Use getDates() for type check
Fixes #63
2014-02-21 12:00:54 +01:00
Barry vd. Heuvel 512574de9a Add dynamic whereField()
Fixes #61
Also added backslash to method return types and use full Str facade, not
an alias.
2014-02-21 11:51:39 +01:00
Barry vd. Heuvel 46558e9060 Typo in method name check
Fixes #62
2014-02-21 11:28:59 +01:00
Barry vd. Heuvel f79776d06f Merge pull request #60 from briankiewel/patch-1
Update readme.md
2014-02-19 14:40:47 +01:00
Brian Kiewel 6a1f7d61cf Update readme.md
Escaped underscores in model file name and spelling correction
2014-02-19 08:35:43 -05:00
Barry vd. Heuvel 14cd044103 Catch exception for normalizing
Mainly for catching exceptions in inheritdoc etc. Should fix #59
2014-02-14 11:48:19 +01:00
Barry vd. Heuvel b6a9d8e4f9 Update readme 2014-02-07 10:36:05 +01:00
Barry vd. Heuvel e6493fd9e8 Tweak multiple models
Use array instead of comma seperated
2014-02-07 10:05:51 +01:00
Barry vd. Heuvel caeb0227b6 Check if the class is a model before instantiating 2014-02-07 09:51:09 +01:00
Barry vd. Heuvel 948eb369a6 Add additional directories
For #57 (and #58), tweak a bit.
Make the input option an array, so commandline can also add multiple
dirs. Add app/models to the config, prepend the base_path() to every
dir.
2014-02-07 09:50:07 +01:00
Matthew Hailwood 107fda3c20 Add support for model_locations 2014-02-07 12:11:17 +13:00
Matthew Hailwood 0166a1bc9b Update config.php
Add model_locations key
2014-02-07 12:09:31 +13:00
Barry vd. Heuvel cae77c279d Allow multi-line relations
Fixes #56
Searches for $this->hasMany( etc.
Also allows both " and ' quotes.
2014-02-06 10:45:31 +01:00
Barry vd. Heuvel 2c3c1e96d5 Add CacheStore 2014-02-03 13:10:09 +01:00
Barry vd. Heuvel 874cd4c1a2 Add prefix to table
Fixes #54
2014-01-29 16:24:09 +01:00
Barry vd. Heuvel 0dc098a7ba Merge pull request #47 from AoSiX/patch-1
Test if model class is instanciable
2013-12-17 03:04:30 -08:00
TANT Julien 7ee52d7e61 restore the try { statement 2013-12-17 11:53:02 +01:00
TANT Julien 430c5d7db4 Test if model class is instanciable
to handle abstract classes, interfaces...
2013-12-16 22:38:06 +01:00
Barry vd. Heuvel facba3a5e6 Merge pull request #45 from bryceray1121/master
Removing \r from generator in order to prevent ^M from being inserted in...
2013-12-06 08:51:01 -08:00
bryce.ray 7d09f324fa Removing \r from generator in order to prevent ^M from being inserted into line endings after generation 2013-12-06 10:24:13 -06:00
Barry vd. Heuvel af34b1cca2 Add extra class for Artisan
Adds the call() command. Fixes #42
2013-11-13 11:55:25 +01:00
Barry vd. Heuvel 463bfdd70a Add doctrine dependancy for L4.1
Fixes #38
2013-10-18 11:16:02 +02:00
Barry vd. Heuvel ff7d2a33b0 Update readme 2013-10-18 10:29:48 +02:00
Barry vd. Heuvel 3ebfcd1c6c Make facade for interface possible
Fixes #36
2013-10-18 10:17:11 +02:00
Barry vd. Heuvel c3afd5f63c Add ignore option
To ignore models, use the --ignore (-I) argument:
php artisan ide-helper:models --ignore="Admin\Model"
php artisan ide-helper:models -I Post,User
Fixes #35
2013-10-18 10:04:46 +02:00
Barry vd. Heuvel 92abb112e9 Force No answer for writing to files
To write to single file instead, use --nowrite or -N (as mentioned in
#35)
2013-10-18 09:52:41 +02:00
Barry vd. Heuvel 7e1c64fb95 Add SessionStore to Session Facade
Because of changes to the session facade. Fixes #37
2013-10-18 09:35:33 +02:00
Barry vd. Heuvel 5e5cfce28c Refactor a bit 2013-08-25 17:56:29 +02:00
Barry vd. Heuvel 098090ed36 Merge pull request #32 from claar/patch-1
Use camel case for model scope generation
2013-08-25 06:31:59 -07:00
Barry vd. Heuvel 7f055cec7e Merge pull request #33 from claar/patch-2
Include return value when generating scope methods
2013-08-25 06:30:45 -07:00
Ben Claar 5a0f8f1b64 Include return value when generating scope methods
It's handy to specify return values in phpDoc comments. This patch sets the return value to the containing class.
2013-08-23 16:25:03 -05:00
Ben Claar 92ec89bf87 Use camel case for model scope generation
In L4, scope functions only work with camel case (http://four.laravel.com/docs/eloquent#query-scopes)
2013-08-23 14:47:14 -05:00
Barry vd. Heuvel afeaf2f28b Add arguments for query scopes
Should fix #31
2013-08-23 13:47:25 +02:00
Barry vd. Heuvel 865bd8d32b Update readme 2013-08-23 13:31:10 +02:00
Barry vd. Heuvel e368338ba7 Make writing to files more default behaviour
But ask before overwriting. You can still force with -W
2013-08-23 13:29:44 +02:00
Barry vd. Heuvel 7bd3e1cc0a Update docblock 2013-08-23 13:19:57 +02:00
Barry vd. Heuvel 28ce1492ad Update namespace for ReflectionDocblock 2013-08-08 19:09:24 +02:00
Barry vd. Heuvel d9516325f0 Add magic methods
Adds the magic calls to Log::error() etc. Perhaps more to come.
Fixes #27
2013-08-08 18:20:43 +02:00
Barry vd. Heuvel d1e396f658 Move back to original phpdocumentor/reflection-docblock
Because it is stable now.
2013-08-08 17:58:31 +02:00
Barry vd. Heuvel a916da0ce4 Make deferred 2013-08-05 13:52:44 +02:00
Barry vd. Heuvel fc887b4431 Clarify readme 2013-07-31 10:35:22 +02:00
Barry vd. Heuvel 7b08db2682 Catch PDO errors when getting drivers/connections 2013-07-31 10:33:32 +02:00
Barry vd. Heuvel 742aeb2f56 Add --dir option to readme
As described in #18
2013-07-29 16:32:40 +02:00
Barry vd. Heuvel c1619fd6b3 Merge pull request #28 from tortuetorche/patch-1
Loading helper files is broken in GeneratorCommand.php
2013-07-26 05:38:41 -07:00
Tortue Torche 1a593833a2 Fix wrong var name $helpers to correctly load helper files in GeneratorCommand.php. 2013-07-26 13:07:30 +02:00
7 changed files with 384 additions and 171 deletions
+12 -1
View File
@@ -14,13 +14,24 @@
"illuminate/support": "4.x",
"illuminate/console": "4.x",
"illuminate/filesystem": "4.x",
"barryvdh/reflection-docblock": ">=2.0.1",
"phpdocumentor/reflection-docblock": "2.0.x",
"symfony/class-loader": "~2.3"
},
"require-dev": {
"doctrine/dbal": "~2.3"
},
"suggest": {
"doctrine/dbal": "Load information from the database about models for phpdocs (~2.3)"
},
"autoload": {
"psr-0": {
"Barryvdh\\LaravelIdeHelper": "src/"
}
},
"extra": {
"branch-alias": {
"dev-master": "1.x-dev"
}
},
"minimum-stability": "dev"
}
+5
View File
@@ -0,0 +1,5 @@
{
"providers": [
"Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider"
]
}
+20 -7
View File
@@ -3,6 +3,8 @@
### Complete phpDocs, directly from the source
_Checkout [this Laracasts video](https://laracasts.com/series/how-to-be-awesome-in-phpstorm/episodes/15) for a quick introduction/explanation!_
This packages generates a file that your IDE can understand, so it can provide accurate autocompletion. Generation is done, based on the files in your project, so they are alway up-to-date.
If you don't want to generate it, you can add a pre-generated file to the root folder of your laravel project. (But this isn't as up-to-date as self generated files)
@@ -30,6 +32,7 @@ You can configure your composer.json to do this after each commit:
"scripts":{
"post-update-cmd":[
"php artisan clear-compiled",
"php artisan ide-helper:generate",
"php artisan optimize",
]
@@ -50,11 +53,11 @@ The Illuminate/Support/helpers.php is already set-up, but you can add/remove you
### Automatic phpDocs for Models
If you don't want to write your properties yourself, you can use the command `ide-helper:models` to generate
phpDocs, based on table columns, relations and getters/setters. Still in beta, so please provide feedback if you want.
Docs are written to a phpfile (_ide_helper_models.php) in the root of the project, so you can move the docs to the real model.
> **Note:** Since v1.10 you need to require `doctrine/dbal: ~2.3` in your own composer.json.
You can now also write the comments directly to your Model file, using the `--write (-W)` option. Please make sure to backup your models, before writing the info.
If you don't want to write your properties yourself, you can use the command `ide-helper:models` to generate
phpDocs, based on table columns, relations and getters/setters. You can write the comments directly to your Model file, using the `--write (-W)` option. By default, you are asked to overwrite or write to a separate file (\_ide\_helper\_models.php) (You can force No with `--nowrite (-N)`).
Please make sure to backup your models, before writing the info.
It should keep the existing comments and only append new properties/methods. The existing phpdoc is replaced, or added if not found.
With the `--reset (-R)` option, the existing phpdocs are ignored, only the newly found columns/relations are saved as phpdocs.
@@ -73,11 +76,21 @@ With the `--reset (-R)` option, the existing phpdocs are ignored, only the newly
* @property-read \Illuminate\Database\Eloquent\Collection|\Comment[] $comments
*/
For now, only models in app/models are scanned. The optional argument tells what models to use (also outside app/models).
By default, models in app/models are scanned. The optional argument tells what models to use (also outside app/models).
php artisan ide-helper:models Post,User
php artisan ide-helper:models Post User
Note: With namespaces, uses `\\` instead of `\`: `php artisan ide-helper:models API\\User`
You can also scan a different directory, using the --dir option (relative from the base path):
php artisan ide-helper:models --dir="app/workbench/name/package/models" --dir="app/src/Model"
You can publish the config file (`php artisan config:publish barryvdh/laravel-ide-helper`) and set the default directories.
Models can be ignored using the --ignore (-I) option
php artisan ide-helper:models --ignore="Post,User"
Note: With namespaces, wrap your model name in " signs: `php artisan ide-helper:models "API\User"`, or escape the slashes (`Api\\User`)
### License
@@ -13,10 +13,10 @@ use Illuminate\Console\Command;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputArgument;
use Illuminate\Foundation\AliasLoader;
use Barryvdh\Reflection\DocBlock;
use Barryvdh\Reflection\DocBlock\Context;
use Barryvdh\Reflection\DocBlock\Tag;
use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
use phpDocumentor\Reflection\DocBlock;
use phpDocumentor\Reflection\DocBlock\Context;
use phpDocumentor\Reflection\DocBlock\Tag;
use phpDocumentor\Reflection\DocBlock\Serializer as DocBlockSerializer;
/**
* A command to generate autocomplete information for your IDE
*
@@ -41,6 +41,7 @@ class GeneratorCommand extends Command {
protected $extra;
protected $onlyExtend;
protected $helpers;
protected $magic;
/**
@@ -60,6 +61,7 @@ class GeneratorCommand extends Command {
}
$this->extra = \Config::get('laravel-ide-helper::extra');
$this->magic = \Config::get('laravel-ide-helper::magic');
if( $this->option('helpers') || (\Config::get('laravel-ide-helper::include_helpers') )){
$this->helpers = \Config::get('laravel-ide-helper::helper_files');
@@ -123,70 +125,98 @@ class GeneratorCommand extends Command {
$aliasLoader = AliasLoader::getInstance();
$output = "<?php
$outputString = "<?php
/**
* An helper file for Laravel 4, to provide autocomplete information to your IDE
* Generated with https://github.com/barryvdh/laravel-ide-helper
*
* @author Barry vd. Heuvel <[email protected]>
*/
exit('Only to be used as an helper for your IDE');\n\n";
*/\n\n";
$output['__root'] = "\texit('Only to be used as an helper for your IDE');\n\n";
//Get all aliases
$aliases = $aliasLoader->getAliases();
foreach($aliases as $alias => $facade){
//Check if the facade is not a Trait
if(function_exists('trait_exists') && trait_exists($facade)){
continue;
}
$facade = '\\'.ltrim($facade, '\\');
$root = $this->getRoot($facade);
if(!$root){
continue;
}
try{
if (strpos($alias, '\\')){
$nsParts = explode('\\', $alias);
$alias = array_pop($nsParts);
$ns = implode('\\', $nsParts);
} else {
$ns = '__root';
}
if (!isset($output[$ns])) $output[$ns] = '';
//Some classes extend the facade
if(class_exists($facade)){
$output .= "class $alias extends $facade{\n";
if(interface_exists($facade)){
$output[$ns] .= "\tinterface $alias extends $facade{\n";
}elseif(class_exists($facade)){
$output[$ns] .= "\tclass $alias extends $facade{\n";
}else{
$output .= "class $alias{\n";
$output[$ns] .= "\tclass $alias{\n";
}
$usedMethods = array();
//Only add the methods to the output when the root is not the same as the facade.
$addOutput = ($root !== $facade);
$output .= $this->getMethods($root, $alias, $usedMethods, $addOutput);
$output[$ns] .= $this->getMethods($root, $alias, $usedMethods, $addOutput);
$driver = $this->getDriver($alias);
if($driver){
$output .= $this->getMethods($driver, $alias, $usedMethods);
$output[$ns] .= $this->getMethods($driver, $alias, $usedMethods);
}
//Add extra methods, from other classes (magic static calls)
if(array_key_exists($alias, $this->extra)){
$output .= $this->getMethods($this->extra[$alias], $alias, $usedMethods);
$output[$ns] .= $this->getMethods($this->extra[$alias], $alias, $usedMethods);
}
//Add extra methods, from other classes (magic static calls)
if(array_key_exists($alias, $this->magic)){
$output[$ns] .= $this->addMagicMethods($this->magic[$alias], $alias, $usedMethods);
}
$output .= "}\n\n";
$output[$ns] .= "\t}\n";
}catch(\Exception $e){
$this->error("Exception: ".$e->getMessage()."\nCould not analyze $root.");
}
}
//Include the helper file, if requested
if(!empty($helpers)){
foreach($helpers as $helper){
if(!empty($this->helpers)){
foreach($this->helpers as $helper){
if (file_exists($helper)){
$output .= str_replace(array('<?php', '?>'), '', \File::get($helper));
$output['__root'] .= str_replace(array('<?php', '?>'), '', \File::get($helper));
}
}
}
return $output;
foreach ($output as $ns => $body){
if ($ns == '__root'){
$ns = '';
}
$outputString .= "namespace $ns{\n";
$outputString .= $body;
$outputString .= "}\n\n";
}
return $outputString;
}
/**
@@ -223,20 +253,33 @@ exit('Only to be used as an helper for your IDE');\n\n";
}
/**
* Get the driver/connection/store from the managers
*
* @param $alias
* @return array|bool|string
*/
public function getDriver($alias){
if($alias == "Auth"){
$driver = \Auth::driver();
}elseif($alias == "DB"){
$driver = \DB::connection();
}elseif($alias == "Cache"){
$driver = \Cache::driver();
}elseif($alias == "Queue"){
$driver = \Queue::connection();
}else{
try{
if($alias == "Auth"){
$driver = \Auth::driver();
}elseif($alias == "DB"){
$driver = \DB::connection();
}elseif($alias == "Cache"){
$driver = get_class(\Cache::driver());
$store = get_class(\Cache::getStore());
return array($driver, $store);
}elseif($alias == "Queue"){
$driver = \Queue::connection();
}else{
return false;
}
return get_class($driver);
}catch(\Exception $e){
$this->error("Could not determine driver/connection for $alias.");
return false;
}
return get_class($driver);
}
/**
@@ -277,29 +320,69 @@ exit('Only to be used as an helper for your IDE');\n\n";
}
/**
* @param \ReflectionMethod $method
* @param string $alias
* Get the methods for one or multiple magic methods.
*
* @param $methods
* @param $alias
* @param $usedMethods
* @param bool $addOutput
* @return string
*/
protected function parseMethod($method, $alias, $class){
protected function addMagicMethods($methods, $alias, &$usedMethods, $addOutput = true){
$output = '';
foreach($methods as $magic => $real){
list($className, $name) = explode('::', $real);
if(!class_exists($className) && !interface_exists($className)){
continue;
}
$method = new \ReflectionMethod($className, $name);
$class = new \ReflectionClass($className);
if(!in_array($method->name, $usedMethods)){
if( $addOutput){
$output .= $this->parseMethod($method, $alias, $class, $magic);
}
$usedMethods[] = $method->name;
}
$usedMethods[] = $magic;
}
return $output;
}
/**
* @param \ReflectionMethod $method
* @param string $alias
* @param $class
* @param null $methodName
* @return string
*/
protected function parseMethod($method, $alias, $class, $methodName = null){
$output = '';
// Don't add the __clone() functions
if($method->name === '__clone'){
return $output;
}
$methodName = $methodName ?: $method->name;
$namespace = $method->getDeclaringClass()->getNamespaceName();
//Create a DocBlock and serializer instance
$phpdoc = new DocBlock($method, new Context($namespace));
$serializer = new DocBlockSerializer(1, "\t");
$serializer = new DocBlockSerializer(1, "\t\t");
//Normalize the description and inherit the docs from parents/interfaces
$this->normalizeDescription($phpdoc, $method);
try{
$this->normalizeDescription($phpdoc, $method);
}catch(\Exception $e){
$this->info("Cannot normalize method $alias::$methodName..");
}
//Correct the return values
$returnValue = $this->normalizeReturn($phpdoc, $method, $alias);
$returnValue = $this->getReturn($phpdoc);
//Get the parameters, including formatted default values
list($params, $paramsWithDefault) = $this->getParameters($method);
@@ -308,27 +391,28 @@ exit('Only to be used as an helper for your IDE');\n\n";
$phpdoc->appendTag(Tag::createInstance('@static', $phpdoc));
//Write the output, using the DocBlock serializer
$output .= $serializer->getDocComment($phpdoc) ."\n\t public static function ".$method->name."(";
$output .= $serializer->getDocComment($phpdoc) ."\n\t\t public static function ".$methodName."(";
$output .= implode($paramsWithDefault, ", ");
$output .= "){\r\n";
$output .= "){\n";
//Only return when not a constructor and not void.
$return = ($returnValue && $returnValue !== "void" && $method->name !== "__construct") ? 'return' : '';
//Reference the 'real' function in the declaringclass
$declaringClass = $method->getDeclaringClass();
$root = $class->getName();
$declaringClassName = '\\'.ltrim($declaringClass->name, '\\');
$root = '\\'.ltrim($class->getName(), '\\');
if($declaringClass->name != $root){
$output .= "\t\t//Method inherited from $declaringClass->name\r\n";
$output .= "\t\t\t//Method inherited from $declaringClassName\n";
}
$output .= "\t\t$return $root::";
$output .= "\t\t\t$return $root::";
//Write the default parameters in the function call
$output .= $method->name."(".implode($params, ", ").");\r\n";
$output .= "\t }\n\n";
$output .= $method->name."(".implode($params, ", ").");\n";
$output .= "\t\t }\n\n";
return $output;
}
@@ -366,23 +450,15 @@ exit('Only to be used as an helper for your IDE');\n\n";
* Make some changes to the return types, if needed.
*
* @param $phpdoc
* @param $method
* @param $alias
* @return null
* @return string|null
*/
protected function normalizeReturn(&$phpdoc, $method, $alias){
protected function getReturn($phpdoc){
//Get the return type and adjust them for beter autocomplete
$returnTags = $phpdoc->getTagsByName('return');
if($returnTags){
/** @var $tag */
$tag = reset($returnTags);
$returnValue = $tag->getType();
if($method->name == "__construct"){
$tag->setType('self');
}elseif($alias == 'Eloquent' and in_array($method->name, array('hasOne', 'hasMany', 'belongsTo', 'belongsToMany', 'morphOne', 'morphTo', 'morphMany'))){
$tag->addType('\Eloquent');
}
}else{
$returnValue = null;
}
@@ -19,7 +19,7 @@ class IdeHelperServiceProvider extends ServiceProvider {
*
* @var bool
*/
protected $defer = false;
protected $defer = true;
/**
* Bootstrap the application events.
+186 -107
View File
@@ -3,20 +3,23 @@
* Laravel IDE Helper Generator
*
* @author Barry vd. Heuvel <[email protected]>
* @copyright 2013 Barry vd. Heuvel / Fruitcake Studio (http://www.fruitcakestudio.nl)
* @copyright 2014 Barry vd. Heuvel / Fruitcake Studio (http://www.fruitcakestudio.nl)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link https://github.com/barryvdh/laravel-ide-helper
*/
namespace Barryvdh\LaravelIdeHelper;
use Illuminate\Console\Command;
use Illuminate\Support\Str;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\ClassLoader\ClassMapGenerator;
use Barryvdh\Reflection\DocBlock;
use Barryvdh\Reflection\DocBlock\Context;
use Barryvdh\Reflection\DocBlock\Tag;
use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
use phpDocumentor\Reflection\DocBlock;
use phpDocumentor\Reflection\DocBlock\Context;
use phpDocumentor\Reflection\DocBlock\Tag;
use phpDocumentor\Reflection\DocBlock\Serializer as DocBlockSerializer;
/**
* A command to generate autocomplete information for your IDE
*
@@ -30,6 +33,7 @@ class ModelsCommand extends Command {
* @var string
*/
protected $name = 'ide-helper:models';
protected $filename = '_ide_helper_models.php';
/**
* The console command description.
@@ -41,7 +45,7 @@ class ModelsCommand extends Command {
protected $properties = array();
protected $methods = array();
protected $write = false;
protected $dir;
protected $dirs = array();
protected $reset;
@@ -55,11 +59,19 @@ class ModelsCommand extends Command {
{
$filename = $this->option('filename');
$this->write = $this->option('write');
$this->dir = $this->option('dir');
$this->dirs = array_merge($this->laravel['config']->get('laravel-ide-helper::model_locations'), $this->option('dir'));
$model = $this->argument('model');
$ignore = $this->option('ignore');
$this->reset = $this->option('reset');
$content = $this->generateDocs($model);
//If filename is default and Write is not specified, ask what to do
if(!$this->write && $filename === $this->filename && !$this->option('nowrite')){
if($this->confirm("Do you want to overwrite the existing model files? Choose no to write to $filename instead? (Yes/No): ")){
$this->write = true;
}
}
$content = $this->generateDocs($model, $ignore);
if(!$this->write){
$written = \File::put($filename, $content);
@@ -69,7 +81,6 @@ class ModelsCommand extends Command {
$this->error("Failed to write model information to $filename");
}
}
}
@@ -81,8 +92,7 @@ class ModelsCommand extends Command {
protected function getArguments()
{
return array(
array('model', InputArgument::OPTIONAL, 'Which models to include', '*'),
array('model', InputArgument::OPTIONAL | InputArgument::IS_ARRAY, 'Which models to include', array()),
);
}
@@ -94,14 +104,16 @@ class ModelsCommand extends Command {
protected function getOptions()
{
return array(
array('filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the helper file', '_ide_helper_models.php'),
array('dir', 'D', InputOption::VALUE_OPTIONAL, 'The model dir','app/models'),
array('filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the helper file', $this->filename),
array('dir', 'D', InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY, 'The model dir', array()),
array('write', 'W', InputOption::VALUE_NONE, 'Write to Model file'),
array('nowrite', 'N', InputOption::VALUE_NONE, 'Don\'t write to Model file'),
array('reset', 'R', InputOption::VALUE_NONE, 'Remove the original phpdocs instead of appending'),
array('ignore', 'I', InputOption::VALUE_OPTIONAL, 'Which models to ignore', ''),
);
}
protected function generateDocs($model){
protected function generateDocs($loadModels, $ignore = ''){
$output = "<?php
@@ -114,19 +126,43 @@ class ModelsCommand extends Command {
*/
\n\n";
if($model === '*'){
$hasDoctrine = interface_exists('Doctrine\DBAL\Driver');
if(empty($loadModels)){
$models = $this->loadModels();
}else{
$models = explode(',', $model);
$models = array();
foreach($loadModels as $model){
$models = array_merge($models, explode(',', $model));
}
}
$ignore = explode(',', $ignore);
foreach($models as $name){
if(in_array($name, $ignore)){
$this->comment("Ignoring model '$name'");
continue;
}else{
$this->comment("Loading model '$name'");
}
$this->properties = array();
$this->methods = array();
if(class_exists($name)){
try{
try {
// handle abstract classes, interfaces, ...
$reflectionClass = new \ReflectionClass($name);
if (!$reflectionClass->IsInstantiable()) {
throw new \Exception($name . ' is not instanciable.');
}elseif(!$reflectionClass->isSubclassOf('Illuminate\Database\Eloquent\Model')){
$this->comment("Class '$name' is not a model");
continue;
}
$model = new $name();
$this->getPropertiesFromTable($model);
if($hasDoctrine){
$this->getPropertiesFromTable($model);
}
$this->getPropertiesFromMethods($model);
$output .= $this->createPhpDocs($name);
}catch(\Exception $e){
@@ -137,6 +173,10 @@ class ModelsCommand extends Command {
}
}
if(!$hasDoctrine){
$this->error("Warning: 'doctrine/dbal: ~2.3' is required to load database information. Please require that in your composer.json and run 'composer update'.");
}
return $output;
@@ -144,11 +184,13 @@ class ModelsCommand extends Command {
protected function loadModels(){
$dir = base_path().'/'.$this->dir;
$models = array();
if(file_exists($dir)){
foreach(ClassMapGenerator::createMap($dir) as $model=> $path){
$models[] = $model;
foreach($this->dirs as $dir){
$dir = base_path() . '/' . $dir;
if(file_exists($dir)){
foreach(ClassMapGenerator::createMap($dir) as $model=> $path){
$models[] = $model;
}
}
}
return $models;
@@ -160,7 +202,7 @@ class ModelsCommand extends Command {
* @param \Illuminate\Database\Eloquent\Model $model
*/
protected function getPropertiesFromTable($model){
$table = $model->getTable();
$table = $model->getConnection()->getTablePrefix() . $model->getTable();
$schema = $model->getConnection()->getDoctrineSchemaManager($table);
$schema->getDatabasePlatform()->registerDoctrineTypeMapping('enum', 'string');
@@ -169,37 +211,41 @@ class ModelsCommand extends Command {
if($columns){
foreach ($columns as $column) {
$name = $column->getName();
$type = $column->getType()->getName();
switch($type){
case 'string':
case 'text':
case 'date':
case 'time':
case 'guid':
$type = 'string';
break;
case 'integer':
case 'bigint':
case 'smallint':
$type = 'integer';
break;
case 'decimal':
if(in_array($name, $model->getDates())){
$type = '\Carbon\Carbon';
}else{
$type = $column->getType()->getName();
switch($type){
case 'string':
case 'text':
case 'date':
case 'time':
case 'guid':
case 'datetimetz':
case 'datetime':
$type = 'string';
break;
case 'integer':
case 'bigint':
case 'smallint':
$type = 'integer';
break;
case 'decimal':
case 'float':
$type = 'float';
break;
case 'boolean':
$type = 'boolean';
break;
case 'datetimetz': //String or DateTime, depending on $dates
case 'datetime':
$type = '\Carbon\Carbon';
break;
default:
$type = 'mixed';
break;
$type = 'float';
break;
case 'boolean':
$type = 'boolean';
break;
default:
$type = 'mixed';
break;
}
}
$this->setProperty($name, $type, true, true);
$this->setMethod(Str::camel("where_".$name), '\Illuminate\Database\Query\Builder|\\'.get_class($model), array('$value'));
}
}
}
@@ -210,62 +256,64 @@ class ModelsCommand extends Command {
protected function getPropertiesFromMethods($model){
$methods = get_class_methods($model);
if($methods){
foreach($methods as $method){
if(\Str::startsWith($method, 'get') && \Str::endsWith($method, 'Attribute') && $method !== 'setAttribute'){
//Magic get<name>Attribute
$name = \Str::snake(substr($method, 3, -9));
if(!empty($name)){
foreach($methods as $method){
if(Str::startsWith($method, 'get') && Str::endsWith($method, 'Attribute') && $method !== 'getAttribute'){
//Magic get<name>Attribute
$name = Str::snake(substr($method, 3, -9));
if(!empty($name)){
$this->setProperty($name, null, true, null);
}
}elseif(\Str::startsWith($method, 'set') && \Str::endsWith($method, 'Attribute') && $method !== 'setAttribute'){
//Magic set<name>Attribute
$name = \Str::snake(substr($method, 3, -9));
if(!empty($name)){
}
}elseif(Str::startsWith($method, 'set') && Str::endsWith($method, 'Attribute') && $method !== 'setAttribute'){
//Magic set<name>Attribute
$name = Str::snake(substr($method, 3, -9));
if(!empty($name)){
$this->setProperty($name, null, null, true);
}
}elseif(\Str::startsWith($method, 'scope') && $method !== 'scopeQuery'){
//Magic set<name>Attribute
$name = \Str::snake(substr($method, 5));
if(!empty($name)){
$this->setMethod($name, 'static');
}
}elseif(!method_exists('Eloquent', $method) && !\Str::startsWith($method, 'get')){
}
}elseif(Str::startsWith($method, 'scope') && $method !== 'scopeQuery'){
//Magic set<name>Attribute
$name = Str::camel(substr($method, 5));
if(!empty($name)){
$reflection = new \ReflectionMethod($model, $method);
$args = $this->getParameters($reflection);
//Remove the first ($query) argument
array_shift($args);
$this->setMethod($name, '\\'.$reflection->class, $args);
}
}elseif(!method_exists('Eloquent', $method) && !Str::startsWith($method, 'get')){
//Use reflection to inspect the code, based on Illuminate/Support/SerializableClosure.php
$reflection = new \ReflectionMethod($model, $method);
//Use reflection to inspect the code, based on Illuminate/Support/SerializableClosure.php
$reflection = new \ReflectionMethod($model, $method);
$file = new \SplFileObject($reflection->getFileName());
$file->seek($reflection->getStartLine() - 1);
$file = new \SplFileObject($reflection->getFileName());
$file->seek($reflection->getStartLine() - 1);
$code = '';
while ($file->key() < $reflection->getEndLine())
{
$code .= $file->current(); $file->next();
}
$begin = strpos($code, 'function(');
$code = substr($code, $begin, strrpos($code, '}') - $begin + 1);
$code = '';
while ($file->key() < $reflection->getEndLine())
{
$code .= $file->current(); $file->next();
}
$begin = strpos($code, 'function(');
$code = substr($code, $begin, strrpos($code, '}') - $begin + 1);
$begin = stripos($code, 'return $this->');
$parts = explode("'", substr($code, $begin+14),3); //"return $this->" is 14 chars
if (isset($parts[2]))
{
list($relation, $returnModel, $rest) = $parts;
$returnModel = "\\".ltrim($returnModel, "\\");
$relation = trim($relation, ' (');
if($relation === "belongsTo" or $relation === 'hasOne'){
//Single model is returned
$this->setProperty($method, $returnModel, true, null);
}elseif($relation === "belongsToMany" or $relation === 'hasMany'){
//Collection or array of models (because Collection is Arrayable)
$this->setProperty($method, '\Illuminate\Database\Eloquent\Collection|'.$returnModel.'[]', true, null);
}
}else{
//Not a relation
}
foreach(array('hasMany', 'belongsToMany', 'hasOne', 'belongsTo', 'morphTo', 'morphMany', 'morphToMany') as $relation){
$search = '$this->'.$relation.'(';
if($pos = stripos($code, $search)){
$code = substr($code, $pos + strlen($search));
$arguments = explode(',', substr($code, 0, stripos($code, ')')));
//Remove quotes, ensure 1 \ in front of the model
$returnModel = "\\".ltrim(trim($arguments[0], " \"'"), "\\");
if($relation === "belongsToMany" or $relation === 'hasMany' or $relation === 'morphMany' or $relation === 'morphToMany'){
//Collection or array of models (because Collection is Arrayable)
$this->setProperty($method, '\Illuminate\Database\Eloquent\Collection|'.$returnModel.'[]', true, null);
}else{
//Single model is returned
$this->setProperty($method, $returnModel, true, null);
}
}
}
}
}
}
}
}
}
@@ -293,13 +341,11 @@ class ModelsCommand extends Command {
}
}
protected function setMethod($name, $type = null){
protected function setMethod($name, $type = '', $arguments=array()){
if(!isset($this->methods[$name])){
$this->methods[$name] = array();
$this->methods[$name]['type'] = 'static';
}
if($type !== null){
$this->methods[$name]['type'] = $type;
$this->methods[$name]['arguments'] = $arguments;
}
}
@@ -321,7 +367,7 @@ class ModelsCommand extends Command {
}
if(!$phpdoc->getText()){
$phpdoc->setText("An Eloquent Model: '$class'");
$phpdoc->setText($class);
}
$properties = array();
@@ -355,8 +401,8 @@ class ModelsCommand extends Command {
if(in_array($name, $methods)){
continue;
}
$name = "$name()";
$tag = Tag::createInstance("@method {$method['type']} {$name}", $phpdoc);
$arguments = implode(', ',$method['arguments']);
$tag = Tag::createInstance("@method static {$method['type']} {$name}({$arguments}) ", $phpdoc);
$phpdoc->appendTag($tag);
}
@@ -387,4 +433,37 @@ class ModelsCommand extends Command {
return $output;
}
/**
* Get the parameters and format them correctly
*
* @param $method
* @return array
*/
public function getParameters($method){
//Loop through the default values for paremeters, and make the correct output string
$params = array();
$paramsWithDefault = array();
foreach ($method->getParameters() as $param) {
$paramStr = '$'.$param->getName();
$params[] = $paramStr;
if ($param->isOptional()) {
$default = $param->getDefaultValue();
if(is_bool($default)){
$default = $default? 'true':'false';
}elseif(is_array($default)){
$default = 'array()';
}elseif(is_null($default)){
$default = 'null';
}elseif(is_int($default)){
//$default = $default;
}else{
$default = "'".trim($default)."'";
}
$paramStr .= " = $default";
}
$paramsWithDefault[] = $paramStr;
}
return $paramsWithDefault;
}
}
+30 -1
View File
@@ -29,6 +29,20 @@ return array(
base_path().'/vendor/laravel/framework/src/Illuminate/Support/helpers.php',
),
/*
|--------------------------------------------------------------------------
| Model locations to include
|--------------------------------------------------------------------------
|
| Define in which directories the ide-helper:models command should look
| for models.
|
*/
'model_locations' => array(
'app/models',
),
/*
|--------------------------------------------------------------------------
@@ -40,7 +54,22 @@ return array(
*/
'extra' => array(
'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
'Artisan' => array('Illuminate\Foundation\Artisan'),
'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
'Session' => array('Illuminate\Session\Store'),
),
'magic' => array(
'Log' => array(
'debug' => 'Monolog\Logger::addDebug',
'info' => 'Monolog\Logger::addInfo',
'notice' => 'Monolog\Logger::addNotice',
'warning' => 'Monolog\Logger::addWarning',
'error' => 'Monolog\Logger::addError',
'critical' => 'Monolog\Logger::addCritical',
'alert' => 'Monolog\Logger::addAlert',
'emergency' => 'Monolog\Logger::addEmergency',
)
)
);