Refactor a bit

Use camel case for model scope generation

composer.json

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

readme.md

@@ -8,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
 
@@ -52,21 +52,35 @@ The Illuminate/Support/helpers.php is already set-up, but you can add/remove you
 
 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.
+You can now also write the comments directly to your Model file, using the `--write (-W)` option. By default, you are asked to overwrite or
-
+write to a seperate file (_ide_helper_models.php) 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 -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. 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.
 
-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
-`php artisan ide-helper:models Post,User`
 
-Note: With namespaces, uses \\ instead of \
+    /**
-`php artisan ide-helper:models API\\User`
+     * 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
+     */
 
-This creates a file with the phpDocs for each Model. You should check and change them to be more accurate.
+By default, models in app/models are scanned. The optional argument tells what models to use (also outside app/models).
-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
+
+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"
+
+Note: With namespaces, wrap your model name in " signs: `php artisan ide-helper:models "API\User"`, or escape the slashes (`Api\\User`)
 
 ### License
 

src/Barryvdh/LaravelIdeHelper/GeneratorCommand.php

@@ -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 phpDocumentor\Reflection\DocBlock;
-use Barryvdh\Reflection\DocBlock\Context;
+use phpDocumentor\Reflection\DocBlock\Context;
-use Barryvdh\Reflection\DocBlock\Tag;
+use phpDocumentor\Reflection\DocBlock\Tag;
-use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
+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');
@@ -157,11 +159,22 @@ exit('Only to be used as an helper for your IDE');\n\n";
                 $addOutput = ($root !== $facade);
                 $output .= $this->getMethods($root, $alias, $usedMethods, $addOutput);
 
+
+                $driver =  $this->getDriver($alias);
+                if($driver){
+                    $output .= $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);
                 }
 
+                //Add extra methods, from other classes (magic static calls)
+                if(array_key_exists($alias, $this->magic)){
+                    $output .= $this->addMagicMethods($this->magic[$alias], $alias, $usedMethods);
+                }
+
 
                 $output .= "}\n\n";
 
@@ -172,8 +185,8 @@ exit('Only to be used as an helper for your IDE');\n\n";
         }
 
         //Include the helper file, if requested
-        if(!empty($helpers)){
+        if(!empty($this->helpers)){
-            foreach($helpers as $helper){
+            foreach($this->helpers as $helper){
                 if (file_exists($helper)){
                     $output .= str_replace(array('<?php', '?>'), '', \File::get($helper));
                 }
@@ -183,6 +196,12 @@ exit('Only to be used as an helper for your IDE');\n\n";
         return $output;
     }
 
+    /**
+     * Get the real root of a facade
+     *
+     * @param $facade
+     * @return bool|string
+     */
     protected function getRoot($facade){
         try{
             //If possible, get the facade root
@@ -210,6 +229,37 @@ exit('Only to be used as an helper for your IDE');\n\n";
         }
 
     }
+
+    public function getDriver($alias){
+        try{
+            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);
+        }catch(\Exception $e){
+            $this->error("Could not determine driver/connection for $alias.");
+            return false;
+        }
+    }
+
+    /**
+     * Get the methods for one or multiple classes.
+     *
+     * @param $classes
+     * @param $alias
+     * @param $usedMethods
+     * @param bool $addOutput
+     * @return string
+     */
     protected function getMethods($classes, $alias, &$usedMethods, $addOutput = true){
         if(!is_array($classes)){
             $classes = array($classes);
@@ -221,14 +271,14 @@ exit('Only to be used as an helper for your IDE');\n\n";
             }
             $reflection = new \ReflectionClass($class);
 
-            $methods = $reflection->getMethods();
+            $methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
             if($methods)
             {
                 foreach ($methods as $method)
                 {
                     if(!in_array($method->name, $usedMethods)){
-                        if($method->isPublic() && $addOutput){
+                        if( $addOutput){
-                            $output .= $this->parseMethod($method, $alias);
+                            $output .= $this->parseMethod($method, $alias, $reflection);
                         }
                         $usedMethods[] = $method->name;
                     }
@@ -237,21 +287,55 @@ exit('Only to be used as an helper for your IDE');\n\n";
         }
         return $output;
     }
+
+    /**
+     * Get the methods for one or multiple magic methods.
+     *
+     * @param $methods
+     * @param $alias
+     * @param $usedMethods
+     * @param bool $addOutput
+     * @return string
+     */
+    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 string $root
+     * @param $class
-     * @param bool $static
+     * @param null $methodName
-     * @param string $rootParam
      * @return string
      */
-    protected function parseMethod($method, $alias){
+    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();
 
@@ -263,7 +347,7 @@ exit('Only to be used as an helper for your IDE');\n\n";
         $this->normalizeDescription($phpdoc, $method);
 
         //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);
@@ -272,7 +356,7 @@ 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 public static function ".$methodName."(";
 
         $output .= implode($paramsWithDefault, ", ");
         $output .= "){\r\n";
@@ -281,8 +365,14 @@ exit('Only to be used as an helper for your IDE');\n\n";
         $return = ($returnValue && $returnValue !== "void" && $method->name !== "__construct") ? 'return' : '';
 
         //Reference the 'real' function in the declaringclass
-        $root = $method->getDeclaringClass()->getName();
+        $declaringClass = $method->getDeclaringClass();
-        $output .=  "\t\t$return \\$root::";
+        $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";
@@ -291,6 +381,12 @@ exit('Only to be used as an helper for your IDE');\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();
@@ -314,33 +410,31 @@ exit('Only to be used as an helper for your IDE');\n\n";
         }
     }
 
-    protected function normalizeReturn(&$phpdoc, $method, $alias){
+    /**
+     * Make some changes to the return types, if needed.
+     *
+     * @param $phpdoc
+     * @return string|null
+     */
+    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('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;
     }
 
+    /**
+     * 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();

src/Barryvdh/LaravelIdeHelper/IdeHelperServiceProvider.php

@@ -19,7 +19,7 @@ class IdeHelperServiceProvider extends ServiceProvider {
 	 *
 	 * @var bool
 	 */
-	protected $defer = false;
+	protected $defer = true;
 
 	/**
 	 * Bootstrap the application events.

src/Barryvdh/LaravelIdeHelper/ModelsCommand.php

@@ -13,10 +13,10 @@ use Illuminate\Console\Command;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\ClassLoader\ClassMapGenerator;
-use Barryvdh\Reflection\DocBlock;
+use phpDocumentor\Reflection\DocBlock;
-use Barryvdh\Reflection\DocBlock\Context;
+use phpDocumentor\Reflection\DocBlock\Context;
-use Barryvdh\Reflection\DocBlock\Tag;
+use phpDocumentor\Reflection\DocBlock\Tag;
-use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
+use phpDocumentor\Reflection\DocBlock\Serializer as DocBlockSerializer;
 /**
  * A command to generate autocomplete information for your IDE
  *
@@ -30,6 +30,7 @@ class ModelsCommand extends Command {
      * @var string
      */
     protected $name = 'ide-helper:models';
+    protected $filename = '_ide_helper_models.php';
 
     /**
      * The console command description.
@@ -42,6 +43,7 @@ class ModelsCommand extends Command {
     protected $methods = array();
     protected $write = false;
     protected $dir;
+    protected $reset;
 
 
 
@@ -56,6 +58,14 @@ class ModelsCommand extends Command {
         $this->write = $this->option('write');
         $this->dir = $this->option('dir');
         $model = $this->argument('model');
+        $this->reset = $this->option('reset');
+
+        //If filename is default and Write is not specified, ask what to do
+        if(!$this->write && $filename === $this->filename){
+            if($this->confirm("Do you want to overwrite the existing model files for '$model'? Choose no to write to $filename instead? (Yes/No): ")){
+                $this->write = true;
+            }
+        }
 
         $content = $this->generateDocs($model);
 
@@ -67,7 +77,6 @@ class ModelsCommand extends Command {
                 $this->error("Failed to write model information to $filename");
             }
         }
-
     }
 
 
@@ -92,9 +101,10 @@ 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('filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the helper file', $this->filename),
             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'),
         );
     }
 
@@ -222,9 +232,13 @@ class ModelsCommand extends Command {
                    }
                }elseif(\Str::startsWith($method, 'scope') && $method !== 'scopeQuery'){
                    //Magic set<name>Attribute
-                   $name =  \Str::snake(substr($method, 5));
+                   $name =  \Str::camel(substr($method, 5));
                    if(!empty($name)){
-                       $this->setMethod($name, 'static');
+                       $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')){
 
@@ -290,13 +304,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;
         }
     }
 
@@ -310,7 +322,12 @@ 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("An Eloquent Model: '$class'");
@@ -347,8 +364,8 @@ class ModelsCommand extends Command {
             if(in_array($name, $methods)){
                 continue;
             }
-            $name = "$name()";
+            $arguments = implode(', ',$method['arguments']);
-            $tag = Tag::createInstance("@method {$method['type']} {$name}", $phpdoc);
+            $tag = Tag::createInstance("@method static {$method['type']} {$name}({$arguments}) ", $phpdoc);
             $phpdoc->appendTag($tag);
         }
 
@@ -379,4 +396,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;
+    }
+
 }

src/config/config.php

@@ -40,11 +40,20 @@ return array(
     */
 
     'extra' => array(
-        'Auth'      => array('Illuminate\Auth\Guard'),
-        'Cache'     => array('Illuminate\Cache\StoreInterface', 'Illuminate\Cache\Repository'),
-        'DB'        => array('Illuminate\Database\Connection'),
-        'Queue'     => array('Illuminate\Queue\QueueInterface'),
         'Eloquent'  => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
     ),
 
+    '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',
+        )
+    )
+
 );