Use full namespace

When function is inherited, link to the original class.

readme.md

@@ -4,11 +4,16 @@
 
 Add the helper file to your laravel folder (not in a public folder). The file isn't used by Laravel, but it has to be indexed by your IDE.
 
-* Netbeans and PHPStorm version: https://gist.github.com/barryvdh/5227822
+* Generated version: https://gist.github.com/barryvdh/5227822
-* SublimeText CodeIntel version: https://gist.github.com/barryvdh/5227814
 
 ### Automatic phpDoc generation for Laravel Facades
 
+#### NOTE: run before optimising. If bootstrap/compiled.php is loaded, it doesn't work.
+
+    php artisan clear-compiled
+    php artisan ide-helper:generate
+    php artisan optimize
+
 Require this package in your composer.json:
 
     "barryvdh/laravel-ide-helper": "1.*"
@@ -21,18 +26,14 @@ You can now re-generate the docs yourself (for future updates) in artisan
 
     php artisan ide-helper:generate
 
-If you use SublimeText CodeIntel, the format is a bit different. So add --sublime (or -S) to your command
-
-    php artisan ide-helper:generate -S
-
 Note: You do need CodeIntel for Sublime Text: https://github.com/Kronuz/SublimeCodeIntel
 
 You can configure your composer.json to do this after each commit:
 
     "scripts":{
         "post-update-cmd":[
-            "php artisan optimize",
             "php artisan ide-helper:generate",
+            "php artisan optimize",
         ]
     },
 
@@ -52,17 +53,19 @@ The Illuminate/Support/helpers.php is already set-up, but you can add/remove you
 ### Work in progress: Model docs
 
 If you don't want to write your properties yourself, you can use the (experimental) command `ide-helper:models` to generate
-phpDocs, based on table columns, relations and getters/setters. Very alpha, so please provide feedback if you want.
+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 in the root of the project, so you can move the docs to the real model.
+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.
 
-For now, only models in app/models are scanned. The optional argument tells what models to use.
+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.
+It should keep the existing comments and only append new properties/methods.
+
+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.
-It doesn't know if datetimes are returned as string or DateTime/Carbon, but I assume they are.
 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.
 

src/Barryvdh/LaravelIdeHelper/GeneratorCommand.php

@@ -42,7 +42,6 @@ class GeneratorCommand extends Command {
     protected $nonstatic;
     protected $onlyExtend;
     protected $helpers;
-    protected $sublime;
 
 
     /**
@@ -52,34 +51,35 @@ class GeneratorCommand extends Command {
      */
     public function fire()
     {
-        $filename = $this->argument('filename');
+        if (file_exists($compiled = base_path().'/bootstrap/compiled.php')){
-
+            $this->error('Error generating IDE Helper: first delete bootstrap/compiled.php (php artisan clear-compiled)');
-        if($this->option('memory')){
-            $this->useMemoryDriver();
-        }
-
-        $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->option('nohelpers'))){
-            $this->helpers = \Config::get('laravel-ide-helper::helper_files');
         }else{
-            $this->helpers = array();
+            $filename = $this->argument('filename');
+    
+            if($this->option('memory')){
+                $this->useMemoryDriver();
+            }
+    
+            $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->option('nohelpers'))){
+                $this->helpers = \Config::get('laravel-ide-helper::helper_files');
+            }else{
+                $this->helpers = array();
+            }
+
+            $content = $this->generateDocs();
+    
+            $written = \File::put($filename, $content);
+    
+            if($written !== false){
+                $this->info("A new helper file was written to $filename");
+            }else{
+                $this->error("The helper file could not be created at $filename");
+            }
         }    
-
-        $this->sublime = $this->option('sublime') || \Config::get('laravel-ide-helper::sublime');
-
-        $content = $this->generateDocs();
-
-        $written = \File::put($filename, $content);
-
-        if($written !== false){
-            $this->info("A new helper file was written to $filename");
-        }else{
-            $this->error("The helper file could not be created at $filename");
-        }
-
     }
 
     protected function useMemoryDriver(){
@@ -113,7 +113,7 @@ class GeneratorCommand extends Command {
         return array(
             array('helpers', "H", InputOption::VALUE_NONE, 'Include the helper files'),
             array('memory', "M", InputOption::VALUE_NONE, 'Use sqlite memory driver'),
-            array('sublime', "S", InputOption::VALUE_NONE, 'Use different style for SublimeText CodeIntel'),
+            array('sublime', "S", InputOption::VALUE_NONE, 'DEPRECATED: Use different style for SublimeText CodeIntel'),
         );
     }
 
@@ -177,7 +177,6 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
                 }else{
                     $output .= " class $alias{\n";
                 }
-                $output .= "\t/**\n\t * @var \\$root \$root\n\t */\n\t static private \$root;\n\n";
 
                 if(!in_array($alias, $this->onlyExtend))
                 {
@@ -196,7 +195,8 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
                         {
                             if(!in_array($method->name, $usedMethods)){
                                 $static = !in_array($method->name, $nonstaticMethods);
-                                $output .= $this->parseMethod($method, $alias, $root, $static);
+                                $declaringClass = $method->getDeclaringClass();
+                                $output .= $this->parseMethod($method, $alias, "\\$declaringClass->name", $static);
                                 $usedMethods[] = $method->name;
                             }
                         }
@@ -308,13 +308,17 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
             $tag = reset($returnTags);
             $returnValue = $tag->getType();
 
-            if(!$this->sublime and $alias == 'Eloquent' and
+            if($method->name == "__construct"){
+                $returnValue = '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
-                $returnValue = "static";
+                $returnValue .= "static";
-            }elseif(!$this->sublime and $alias == 'Eloquent' and in_array($method->name, array('all', 'get'))){
+            }elseif($alias == 'Eloquent' and in_array($method->name, array('all', 'get'))){
                 $returnValue .= "|\Eloquent[]|static[]";
+            }elseif($alias == 'Eloquent' and in_array($method->name, array('hasOne', 'hasMany', 'belongsTo', 'belongsToMany', 'morphOne', 'morphTo', 'morphMany'))){
+                $returnValue .= "|\Eloquent";
             }
            $tag->setContent($returnValue . " ". $tag->getDescription());
         }else{
@@ -348,14 +352,12 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
         $output .= implode($paramsWithDefault, ", ");
         $output .= "){\r\n";
 
-        $return = ($returnValue && $returnValue !== "void") ? 'return' : '';
+        $return = ($returnValue && $returnValue !== "void" && $method->name !== "__construct") ? 'return' : '';
+
+
+        $output .=  "\t\t$return $root::";
+
 
-        if($this->sublime){
-            $output .= "\t\t\$$rootParam = new $root();\r\n";
-            $output .=  "\t\t$return \$$rootParam->";
-        }else{
-            $output .=  "\t\t$return static::\$$rootParam->";
-        }
         $output .=  $method->name."(".implode($params, ", ").");\r\n";
         $output .= "\t }\n\n";
 

src/Barryvdh/LaravelIdeHelper/ModelsCommand.php

@@ -13,6 +13,10 @@ use Illuminate\Console\Command;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\ClassLoader\ClassMapGenerator;
+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
  *
@@ -36,6 +40,9 @@ class ModelsCommand extends Command {
 
     protected $properties = array();
     protected $methods = array();
+    protected $write = false;
+    protected $dir;
+
 
 
     /**
@@ -46,16 +53,19 @@ class ModelsCommand extends Command {
     public function fire()
     {
         $filename = $this->option('filename');
+        $this->write = $this->option('write');
+        $this->dir = $this->option('dir');
         $model = $this->argument('model');
 
         $content = $this->generateDocs($model);
 
-        $written = \File::put($filename, $content);
+        if(!$this->write){
-
+            $written = \File::put($filename, $content);
-        if($written !== false){
+            if($written !== false){
-            $this->info("Model information was written to $filename");
+                $this->info("Model information was written to $filename");
-        }else{
+            }else{
-            $this->error("Failed to write model information to $filename");
+                $this->error("Failed to write model information to $filename");
+            }
         }
 
     }
@@ -83,6 +93,8 @@ class ModelsCommand extends Command {
     {
         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('write', 'W', InputOption::VALUE_NONE, 'Write to Model file'),
         );
     }
 
@@ -129,9 +141,12 @@ class ModelsCommand extends Command {
 
 
     protected function loadModels(){
+        $dir = base_path().'/'.$this->dir;
         $models = array();
-        foreach(ClassMapGenerator::createMap(app_path().'/models') as $model=> $path){
+        if(file_exists($dir)){
-            $models[] = $model;
+            foreach(ClassMapGenerator::createMap($dir) as $model=> $path){
+                $models[] = $model;
+            }
         }
         return $models;
     }
@@ -291,16 +306,32 @@ class ModelsCommand extends Command {
      */
     protected function createPhpDocs($class){
 
-        if(strpos($class, '\\') !== false){
+        $reflection = new \ReflectionClass($class);
-            $parts = explode('\\', $class);
+        $namespace = $reflection->getNamespaceName();
-            $class = array_pop($parts);
+        $classname = $reflection->getShortName();
-            $namespace = implode($parts, '\\');
+        $originalDoc = $reflection->getDocComment();
-        }else{
+        $phpdoc = new DocBlock($reflection, new Context($namespace));
-            $namespace = '';
+
+        if(!$phpdoc->getText()){
+            $phpdoc->setText("Generated properties for $class");
         }
-        $output = "namespace $namespace{\n";
+
-        $output .= "\t/**\n\t *\n\t * Generated properties for $class\n\t *\n";
+        $properties = array();
+        $methods = array();
+        foreach($phpdoc->getTags() as $tag){
+            $name = $tag->getName();
+            if($name == "property" || $name == "property-read" || $name == "property-write"){
+                $properties[] =$tag->getVariableName();
+            }elseif($name == "method"){
+                $methods[] = $tag->getMethodName();
+            }
+        }
+
         foreach($this->properties as $name => $property){
+            $name = "\$$name";
+            if(in_array($name, $properties)){
+                continue;
+            }
             if($property['read'] && $property['write']){
                 $attr = 'property';
             }elseif($property['write']){
@@ -308,16 +339,43 @@ class ModelsCommand extends Command {
             }else{
                 $attr = 'property-read';
             }
-            $type = $property['type'];
+            $tag = Tag::createInstance("@{$attr} {$property['type']} {$name}", $phpdoc);
-            $output .= "\t * @$attr $type \$$name \n";
+            $phpdoc->appendTag($tag);
         }
 
         foreach($this->methods as $name => $method){
-            $type = $method['type'];
+            if(in_array($name, $methods)){
-            $output .= "\t * @method $type $name() \n";
+                continue;
+            }
+            $name = "$name()";
+            $tag = Tag::createInstance("@method {$method['type']} {$name}", $phpdoc);
+            $phpdoc->appendTag($tag);
         }
 
-        $output .= "\t *\n\t */\n\tclass $class {}\n}\n\n";
+        $serializer = new DocBlockSerializer();
+        $serializer->getDocComment($phpdoc);
+        $docComment = $serializer->getDocComment($phpdoc);
+
+
+        if($this->write){
+            $filename = $reflection->getFileName();
+            $contents = \File::get($filename);
+            if($originalDoc){
+                $contents = str_replace($originalDoc, $docComment, $contents);
+            }else{
+                $needle = "class {$classname}";
+                $replace = "{$docComment}\nclass {$classname}";
+                $pos = strpos($contents,$needle);
+                if ($pos !== false) {
+                    $contents = substr_replace($contents,$replace,$pos,strlen($needle));
+                }
+            }
+            if(\File::put($filename, $contents)){
+                $this->info('Written new phpDocBlock to '.$filename);
+            }
+        }
+
+        $output = "namespace {$namespace}{\n{$docComment}\n\tclass {$classname} {}\n}\n\n";
         return $output;
     }
 

src/config/config.php

@@ -70,7 +70,7 @@ return array(
     */
 
     'nonstatic' => array(
-        'Eloquent'  => array('freshTimestamp', 'newCollection', 'toArray', 'toJson', 'toSql'),
+        'Eloquent'  => array('freshTimestamp', 'newCollection', 'toArray', 'toJson', 'toSql', 'delete'),
     ),
 
     /*