Allow 4.1 (and future version)

Not really nice in NetBeans.
Also reference the calling class and show the implementing class in
comments (phpStorm will understand it anyways)

composer.json

@@ -11,11 +11,11 @@
     ],
     "require": {
         "php": ">=5.3.0",
-        "illuminate/support": "4.0.x",
-        "illuminate/console": "4.0.x",
-        "illuminate/filesystem": "4.0.x",
+        "illuminate/support": "4.x",
+        "illuminate/console": "4.x",
+        "illuminate/filesystem": "4.x",
         "barryvdh/reflection-docblock": ">=2.0.1",
-        "symfony/class-loader": "2.3.*"
+        "symfony/class-loader": "~2.3"
     },
     "autoload": {
         "psr-0": {

readme.md

@@ -1,4 +1,5 @@
 ## Laravel IDE Helper Generator
+[![Latest Stable Version](https://poser.pugx.org/barryvdh/laravel-ide-helper/version.png)](https://packagist.org/packages/barryvdh/laravel-ide-helper) [![Total Downloads](https://poser.pugx.org/barryvdh/laravel-ide-helper/d/total.png)](https://packagist.org/packages/barryvdh/laravel-ide-helper)
 
 ### Complete phpDocs, directly from the source
 
@@ -7,7 +8,7 @@ If you don't want to generate it, you can add a pre-generated file to the root f
 
 * Generated version: https://gist.github.com/barryvdh/5227822
 
-Note: You do need CodeIntel for Sublime Text: https://github.com/Kronuz/SublimeCodeIntel
+Note: You do need CodeIntel for Sublime Text: https://github.com/SublimeCodeIntel/SublimeCodeIntel
 
 ### Automatic phpDoc generation for Laravel Facades
 
@@ -53,19 +54,30 @@ If you don't want to write your properties yourself, you can use the command `id
 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.
 
-You can now also write the comments directly to your Model file, using the -W argument. Please make sure to backup your models, before writing the info.
+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.
 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.
+
+    php artisan ide-helper:models Post
+
+    /**
+     * An Eloquent Model: 'Post'
+     *
+     * @property integer $id
+     * @property integer $author_id
+     * @property string $title
+     * @property string $text
+     * @property \Carbon\Carbon $created_at
+     * @property \Carbon\Carbon $updated_at
+     * @property-read \User $author
+     * @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).
-`php artisan ide-helper:models Post,User`
 
-Note: With namespaces, uses \\ instead of \
-`php artisan ide-helper:models API\\User`
-
-This creates a file with the phpDocs for each Model. You should check and change them to be more accurate.
-Also, all relations are Eloquent|Eloquent[] by default, you can change them to the actual Model.
-After copying the phpdocs to your model, you can clear the file, so your IDE only uses the real source.
+    php artisan ide-helper:models Post,User
 
+Note: With namespaces, uses `\\` instead of `\`: `php artisan ide-helper:models API\\User`
 
 ### License
 

src/Barryvdh/LaravelIdeHelper/GeneratorCommand.php

@@ -39,7 +39,6 @@ class GeneratorCommand extends Command {
     protected $description = 'Generate a new IDE Helper file.';
 
     protected $extra;
-    protected $nonstatic;
     protected $onlyExtend;
     protected $helpers;
 
@@ -61,9 +60,7 @@ class GeneratorCommand extends Command {
             }
     
             $this->extra = \Config::get('laravel-ide-helper::extra');
-            $this->nonstatic = \Config::get('laravel-ide-helper::nonstatic');
-            $this->onlyExtend = \Config::get('laravel-ide-helper::only_extend');
-    
+
             if( $this->option('helpers') || (\Config::get('laravel-ide-helper::include_helpers') )){
                 $this->helpers = \Config::get('laravel-ide-helper::helper_files');
             }else{
@@ -133,113 +130,46 @@ class GeneratorCommand extends Command {
  *
  * @author Barry vd. Heuvel <[email protected]>
  */
-namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
+exit('Only to be used as an helper for your IDE');\n\n";
 
         //Get all aliases
         $aliases = $aliasLoader->getAliases();
 
         foreach($aliases as $alias => $facade){
 
-            try{
-                //If possible, get the facade root
-                if(method_exists($facade, 'getFacadeRoot')){
-                    $root = get_class($facade::getFacadeRoot());
-                }else{
-                    $root = $facade;
-                }
-
-                //If it doesn't exist, skip it
-                if(!class_exists($root) && !interface_exists($root)){
-                    $this->error("Class $root is not found.");
-                    continue;
-                }
-
-            //When the database connection is not set, some classes will be skipped
-            }catch(\PDOException $e){
-                $this->error("PDOException: ".$e->getMessage()."\nPlease configure your database connection correctly, or use the sqlite memory driver (-M). Skipping $facade.");
-                continue;
-            }catch(\Exception $e){
-                $this->error("Exception: ".$e->getMessage()."\nSkipping $facade.");
+            $root = $this->getRoot($facade);
+            if(!$root){
                 continue;
             }
 
-            //Get the namespace from the alias.
-            if(strpos($alias, '\\') !== false){
-                $parts = explode('\\', $alias);
-                $alias = array_pop($parts);
-                $namespace = implode($parts, '\\');
-            }else{
-                $namespace = '';
-            }
-
             try{
-                //Reflect on the class
-                $reflection = new \ReflectionClass($root);
-
-                $output .= "namespace $namespace {\n";
 
                 //Some classes extend the facade
-                if($root !== $facade or in_array($alias, $this->onlyExtend)){
-                    //If the root class is not the same as the facade extend it.
-                    $output .= " class $alias extends $facade{\n";
+                if(class_exists($facade)){
+                    $output .= "class $alias extends $facade{\n";
                 }else{
-                    $output .= " class $alias{\n";
+                    $output .= "class $alias{\n";
                 }
 
-                //If they extend, don't include them.
-                if(!in_array($alias, $this->onlyExtend))
-                {
-                    $usedMethods = array();
+                $usedMethods = array();
 
-                    //Check if there are non-static methods for this alias
-                    if(array_key_exists($alias, $this->nonstatic) ){
-                        $nonstaticMethods = $this->nonstatic[$alias];
-                    }else{
-                        $nonstaticMethods = 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);
 
-                    //Get all public methods for this class
-                    $methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
-                    if($methods)
-                    {
-                        foreach ($methods as $method)
-                        {
-                            //Skip methods that are already used
-                            if(!in_array($method->name, $usedMethods)){
-                                $static = !in_array($method->name, $nonstaticMethods);
-                                $declaringClass = $method->getDeclaringClass();
-                                $output .= $this->parseMethod($method, $alias, $static);
-                                $usedMethods[] = $method->name;
-                            }
-                        }
-                    }
 
-                    //Add extra methods, from other classes (magic calls)
-                    if(array_key_exists($alias, $this->extra)){
-                        foreach($this->extra[$alias] as $extraClass){
-                            if(!class_exists($extraClass) && !interface_exists($extraClass)){
-                                continue;
-                            }
-                            $reflection = new \ReflectionClass($extraClass);
-
-                            $methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
-                            if($methods)
-                            {
-                                foreach ($methods as $method)
-                                {
-                                    if(!in_array($method->name, $usedMethods)){
-                                        $static = !in_array($method->name, $nonstaticMethods);
-                                        $output .= $this->parseMethod($method, $alias, $static);
-                                        $usedMethods[] = $method->name;
-                                    }
-
-                                }
-                            }
-
-                        }
-                    }
+                $driver =  $this->getDriver($alias);
+                if($driver){
+                    $output .= $this->getMethods($driver, $alias, $usedMethods);
                 }
-                $output .= " }\n}\n\n";
+
+                //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 .= "}\n\n";
 
             }catch(\Exception $e){
                 $this->error("Exception: ".$e->getMessage()."\nCould not analyze $root.");
@@ -260,14 +190,98 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
     }
 
     /**
-     * @param \ReflectionMethod $method
-     * @param string $alias
-     * @param string $root
-     * @param bool $static
-     * @param string $rootParam
+     * Get the real root of a facade
+     *
+     * @param $facade
+     * @return bool|string
+     */
+    protected function getRoot($facade){
+        try{
+            //If possible, get the facade root
+            if(method_exists($facade, 'getFacadeRoot')){
+                $root = get_class($facade::getFacadeRoot());
+            }else{
+                $root = $facade;
+            }
+
+            //If it doesn't exist, skip it
+            if(!class_exists($root) && !interface_exists($root)){
+                $this->error("Class $root is not found.");
+                return false;
+            }
+
+            return $root;
+
+            //When the database connection is not set, some classes will be skipped
+        }catch(\PDOException $e){
+            $this->error("PDOException: ".$e->getMessage()."\nPlease configure your database connection correctly, or use the sqlite memory driver (-M). Skipping $facade.");
+            return false;
+        }catch(\Exception $e){
+            $this->error("Exception: ".$e->getMessage()."\nSkipping $facade.");
+            return false;
+        }
+
+    }
+
+    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{
+            return false;
+        }
+
+        return get_class($driver);
+    }
+
+    /**
+     * Get the methods for one or multiple classes.
+     *
+     * @param $classes
+     * @param $alias
+     * @param $usedMethods
+     * @param bool $addOutput
      * @return string
      */
-    protected function parseMethod($method, $alias, $static = true){
+    protected function getMethods($classes, $alias, &$usedMethods, $addOutput = true){
+        if(!is_array($classes)){
+            $classes = array($classes);
+        }
+        $output = '';
+        foreach($classes as $class){
+            if(!class_exists($class) && !interface_exists($class)){
+                continue;
+            }
+            $reflection = new \ReflectionClass($class);
+
+            $methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
+            if($methods)
+            {
+                foreach ($methods as $method)
+                {
+                    if(!in_array($method->name, $usedMethods)){
+                        if( $addOutput){
+                            $output .= $this->parseMethod($method, $alias, $reflection);
+                        }
+                        $usedMethods[] = $method->name;
+                    }
+                }
+            }
+        }
+        return $output;
+    }
+
+    /**
+     * @param \ReflectionMethod $method
+     * @param string $alias
+     * @return string
+     */
+    protected function parseMethod($method, $alias, $class){
         $output = '';
 
         // Don't add the __clone() functions
@@ -281,6 +295,51 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
         $phpdoc = new DocBlock($method, new Context($namespace));
         $serializer = new DocBlockSerializer(1, "\t");
 
+        //Normalize the description and inherit the docs from parents/interfaces
+        $this->normalizeDescription($phpdoc, $method);
+
+        //Correct the return values
+        $returnValue = $this->normalizeReturn($phpdoc, $method, $alias);
+
+        //Get the parameters, including formatted default values
+        list($params, $paramsWithDefault) = $this->getParameters($method);
+
+        //Make the method static
+        $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 .= implode($paramsWithDefault, ", ");
+        $output .= "){\r\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();
+
+        if($declaringClass->name != $root){
+            $output .= "\t\t//Method inherited from $declaringClass->name\r\n";
+        }
+
+        $output .=  "\t\t$return $root::";
+
+        //Write the default parameters in the function call
+        $output .=  $method->name."(".implode($params, ", ").");\r\n";
+        $output .= "\t }\n\n";
+
+        return $output;
+    }
+
+    /**
+     * Get the description and get the inherited docs.
+     *
+     * @param $phpdoc
+     * @param $method
+     */
+    protected function normalizeDescription(&$phpdoc, $method){
         //Get the short + long description from the DocBlock
         $description = $phpdoc->getText();
 
@@ -301,11 +360,17 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
                 }
             }
         }
+    }
 
-        //Make the method static
-        $phpdoc->appendTag(Tag::createInstance('@static', $phpdoc));
-
-
+    /**
+     * Make some changes to the return types, if needed.
+     *
+     * @param $phpdoc
+     * @param $method
+     * @param $alias
+     * @return null
+     */
+    protected function normalizeReturn(&$phpdoc, $method, $alias){
         //Get the return type and adjust them for beter autocomplete
         $returnTags = $phpdoc->getTagsByName('return');
         if($returnTags){
@@ -315,24 +380,22 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
 
             if($method->name == "__construct"){
                 $tag->setType('self');
-            }elseif($alias == 'Eloquent' and
-                (in_array($method->name, array('pluck', 'first', 'fill', 'newInstance', 'newFromBuilder', 'create', 'find', 'findOrFail'))
-                    or $returnValue === '\Illuminate\Database\Query\Builder')){
-                //Reference the calling class, to provide more accurate auto-complete
-                $tag->addType('static');
-            }elseif($alias == 'Eloquent' and in_array($method->name, array('all', 'get'))){
-                $tag->addType('\Eloquent[]');
-                $tag->addType('static[]');
             }elseif($alias == 'Eloquent' and in_array($method->name, array('hasOne', 'hasMany', 'belongsTo', 'belongsToMany', 'morphOne', 'morphTo', 'morphMany'))){
                 $tag->addType('\Eloquent');
             }
         }else{
             $returnValue = null;
         }
+        return $returnValue;
+    }
 
-        //Write the output, using the DocBlock serializer
-        $output .= $serializer->getDocComment($phpdoc) ."\n\t public ".($static ? 'static' : '')." function ".$method->name."(";
-
+    /**
+     * 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();
@@ -356,21 +419,7 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
             }
             $paramsWithDefault[] = $paramStr;
         }
-        $output .= implode($paramsWithDefault, ", ");
-        $output .= "){\r\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
-        $root = $method->getDeclaringClass()->getName();
-        $output .=  "\t\t$return \\$root::";
-
-        //Write the default parameters in the function call
-        $output .=  $method->name."(".implode($params, ", ").");\r\n";
-        $output .= "\t }\n\n";
-
-        return $output;
+        return array($params, $paramsWithDefault);
     }
 
     /**

src/Barryvdh/LaravelIdeHelper/ModelsCommand.php

@@ -42,6 +42,7 @@ class ModelsCommand extends Command {
     protected $methods = array();
     protected $write = false;
     protected $dir;
+    protected $reset;
 
 
 
@@ -56,6 +57,7 @@ class ModelsCommand extends Command {
         $this->write = $this->option('write');
         $this->dir = $this->option('dir');
         $model = $this->argument('model');
+        $this->reset = $this->option('reset');
 
         $content = $this->generateDocs($model);
 
@@ -95,6 +97,7 @@ class ModelsCommand extends Command {
             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('write', 'W', InputOption::VALUE_NONE, 'Write to Model file'),
+            array('reset', 'R', InputOption::VALUE_NONE, 'Remove the original phpdocs instead of appending'),
         );
     }
 
@@ -310,10 +313,15 @@ class ModelsCommand extends Command {
         $namespace = $reflection->getNamespaceName();
         $classname = $reflection->getShortName();
         $originalDoc = $reflection->getDocComment();
-        $phpdoc = new DocBlock($reflection, new Context($namespace));
+
+        if($this->reset){
+            $phpdoc = new DocBlock('', new Context($namespace));
+        }else{
+            $phpdoc = new DocBlock($reflection, new Context($namespace));
+        }
 
         if(!$phpdoc->getText()){
-            $phpdoc->setText("Generated properties for $class");
+            $phpdoc->setText("An Eloquent Model: '$class'");
         }
 
         $properties = array();

src/config/config.php

@@ -13,18 +13,6 @@ return array(
 
     'filename' => '_ide_helper.php',
 
-    /*
-    |--------------------------------------------------------------------------
-    | Sublime version
-    |--------------------------------------------------------------------------
-    |
-    | Use a different code format, better for SublimeText (instead of Netbeans/phpStorm)
-    | Can also be used with the --sublime (-S) option.
-    |
-    */
-
-    'sublime' => false,
-
     /*
     |--------------------------------------------------------------------------
     | Helper files to include
@@ -52,38 +40,7 @@ return array(
     */
 
     'extra' => array(
-        'Auth'      => array('Illuminate\Auth\Guard'),
-        'Cache'     => array('Illuminate\Cache\StoreInterface', 'Illuminate\Cache\Repository'),
-        'DB'        => array('Illuminate\Database\Connection'),
         'Eloquent'  => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
-        'Queue'     => array('Illuminate\Queue\QueueInterface'),
-    ),
-
-
-    /*
-    |--------------------------------------------------------------------------
-    | Non-static methods
-    |--------------------------------------------------------------------------
-    |
-    | These functions aren't actually facade calls, so don't make them static
-    |
-    */
-
-    'nonstatic' => array(
-        'Eloquent'  => array('freshTimestamp', 'newCollection', 'toArray', 'toJson', 'toSql', 'delete'),
-    ),
-
-    /*
-    |--------------------------------------------------------------------------
-    | Only extend
-    |--------------------------------------------------------------------------
-    |
-    | These implementations aren't called static, so only extend them.
-    |
-    */
-
-    'only_extend' => array(
-        'Seeder',
     ),
 
 );