Move helpers to root

To get them in the namespace.

composer.json

@@ -15,7 +15,8 @@
         "illuminate/console": "4.x",
         "illuminate/filesystem": "4.x",
         "phpdocumentor/reflection-docblock": "2.0.0",
-        "symfony/class-loader": "~2.3"
+        "symfony/class-loader": "~2.3",
+        "doctrine/dbal": "~2.3"
     },
     "autoload": {
         "psr-0": {

readme.md

@@ -30,6 +30,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",
         ]
@@ -53,7 +54,8 @@ 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.
 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.
+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.
 
@@ -74,11 +76,17 @@ With the `--reset (-R)` option, the existing phpdocs are ignored, only the newly
 
 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
 
 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"
+    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`)
 

src/Barryvdh/LaravelIdeHelper/GeneratorCommand.php

@@ -125,58 +125,68 @@ 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]>
- */
+ */\n\n";
-exit('Only to be used as an helper for your IDE');\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){
-
+            $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)){
+                if(interface_exists($facade)){
-                    $output .= "class $alias extends $facade{\n";
+                    $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 .= $this->addMagicMethods($this->magic[$alias], $alias, $usedMethods);
+                    $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.");
@@ -188,12 +198,21 @@ exit('Only to be used as an helper for your IDE');\n\n";
         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;
     }
 
     /**
@@ -230,6 +249,12 @@ 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){
         try{
             if($alias == "Auth"){
@@ -237,7 +262,9 @@ exit('Only to be used as an helper for your IDE');\n\n";
             }elseif($alias == "DB"){
                 $driver = \DB::connection();
             }elseif($alias == "Cache"){
-                $driver = \Cache::driver();
+                $driver = get_class(\Cache::driver());
+                $store = get_class(\Cache::getStore());
+                return array($driver, $store);
             }elseif($alias == "Queue"){
                 $driver = \Queue::connection();
             }else{
@@ -341,10 +368,14 @@ exit('Only to be used as an helper for your IDE');\n\n";
 
         //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->getReturn($phpdoc);
@@ -356,27 +387,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 ".$methodName."(";
+        $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 .=  $method->name."(".implode($params, ", ").");\n";
-        $output .= "\t }\n\n";
+        $output .= "\t\t }\n\n";
 
         return $output;
     }

src/Barryvdh/LaravelIdeHelper/ModelsCommand.php

@@ -3,13 +3,15 @@
  * 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;
@@ -17,6 +19,7 @@ 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
  *
@@ -42,7 +45,7 @@ class ModelsCommand extends Command {
     protected $properties = array();
     protected $methods = array();
     protected $write = false;
-    protected $dir;
+    protected $dirs = array();
     protected $reset;
 
 
@@ -56,18 +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');
 
         //If filename is default and Write is not specified, ask what to do
-        if(!$this->write && $filename === $this->filename){
+        if(!$this->write && $filename === $this->filename && !$this->option('nowrite')){
-            if($this->confirm("Do you want to overwrite the existing model files for '$model'? Choose no to write to $filename instead? (Yes/No): ")){
+            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);
+        $content = $this->generateDocs($model, $ignore);
 
         if(!$this->write){
             $written = \File::put($filename, $content);
@@ -88,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()),
-
         );
     }
 
@@ -102,13 +105,15 @@ class ModelsCommand extends Command {
     {
         return array(
             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('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
@@ -121,17 +126,37 @@ class ModelsCommand extends Command {
  */
 \n\n";
 
-        if($model === '*'){
+        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);
                     $this->getPropertiesFromMethods($model);
@@ -151,11 +176,13 @@ class ModelsCommand extends Command {
 
 
     protected function loadModels(){
-        $dir = base_path().'/'.$this->dir;
         $models = array();
-        if(file_exists($dir)){
+        foreach($this->dirs as $dir){
-            foreach(ClassMapGenerator::createMap($dir) as $model=> $path){
+            $dir = base_path() . '/' . $dir;
-                $models[] = $model;
+            if(file_exists($dir)){
+                foreach(ClassMapGenerator::createMap($dir) as $model=> $path){
+                    $models[] = $model;
+                }
             }
         }
         return $models;
@@ -167,7 +194,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');
 
@@ -176,37 +203,41 @@ class ModelsCommand extends Command {
         if($columns){
             foreach ($columns as $column) {
                 $name = $column->getName();
-                $type =  $column->getType()->getName();
+                if(in_array($name, $model->getDates())){
-
+                    $type = '\Carbon\Carbon';
-                switch($type){
+                }else{
-                    case 'string':
+                    $type =  $column->getType()->getName();
-                    case 'text':
+                    switch($type){
-                    case 'date':
+                        case 'string':
-                    case 'time':
+                        case 'text':
-                    case 'guid':
+                        case 'date':
-                        $type = 'string';
+                        case 'time':
-                        break;
+                        case 'guid':
-                    case 'integer':
+                        case 'datetimetz':
-                    case 'bigint':
+                        case 'datetime':
-                    case 'smallint':
+                            $type = 'string';
-                        $type = 'integer';
+                            break;
-                        break;
+                        case 'integer':
-                    case 'decimal':
+                        case 'bigint':
+                        case 'smallint':
+                            $type = 'integer';
+                            break;
+                        case 'decimal':
                         case 'float':
-                        $type = 'float';
+                            $type = 'float';
-                        break;
+                            break;
-                    case 'boolean':
+                        case 'boolean':
-                        $type = 'boolean';
+                            $type = 'boolean';
-                        break;
+                            break;
-                    case 'datetimetz':  //String or DateTime, depending on $dates
+                        default:
-                    case 'datetime':
+                            $type = 'mixed';
-                        $type = '\Carbon\Carbon';
+                            break;
-                        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'));
             }
         }
     }
@@ -217,66 +248,64 @@ class ModelsCommand extends Command {
     protected function getPropertiesFromMethods($model){
         $methods = get_class_methods($model);
         if($methods){
-           foreach($methods as $method){
+            foreach($methods as $method){
-               if(\Str::startsWith($method, 'get') && \Str::endsWith($method, 'Attribute') && $method !== 'setAttribute'){
+                if(Str::startsWith($method, 'get') && Str::endsWith($method, 'Attribute') && $method !== 'getAttribute'){
-                   //Magic get<name>Attribute
+                    //Magic get<name>Attribute
-                   $name =  \Str::snake(substr($method, 3, -9));
+                    $name =  Str::snake(substr($method, 3, -9));
-                   if(!empty($name)){
+                    if(!empty($name)){
                         $this->setProperty($name, null, true, null);
-                   }
+                    }
-               }elseif(\Str::startsWith($method, 'set') && \Str::endsWith($method, 'Attribute') && $method !== 'setAttribute'){
+                }elseif(Str::startsWith($method, 'set') && Str::endsWith($method, 'Attribute') && $method !== 'setAttribute'){
-                   //Magic set<name>Attribute
+                    //Magic set<name>Attribute
-                   $name =  \Str::snake(substr($method, 3, -9));
+                    $name =  Str::snake(substr($method, 3, -9));
-                   if(!empty($name)){
+                    if(!empty($name)){
                         $this->setProperty($name, null, null, true);
-                   }
+                    }
-               }elseif(\Str::startsWith($method, 'scope') && $method !== 'scopeQuery'){
+                }elseif(Str::startsWith($method, 'scope') && $method !== 'scopeQuery'){
-                   //Magic set<name>Attribute
+                    //Magic set<name>Attribute
-                   $name =  \Str::camel(substr($method, 5));
+                    $name =  Str::camel(substr($method, 5));
-                   if(!empty($name)){
+                    if(!empty($name)){
-                       $reflection = new \ReflectionMethod($model, $method);
+                        $reflection = new \ReflectionMethod($model, $method);
-                       $args = $this->getParameters($reflection);
+                        $args = $this->getParameters($reflection);
-                       //Remove the first ($query) argument
+                        //Remove the first ($query) argument
-                       array_shift($args);
+                        array_shift($args);
-                       $this->setMethod($name, $reflection->class, $args);
+                        $this->setMethod($name, '\\'.$reflection->class, $args);
-                   }
+                    }
-               }elseif(!method_exists('Eloquent', $method) && !\Str::startsWith($method, 'get')){
+                }elseif(!method_exists('Eloquent', $method) && !Str::startsWith($method, 'get')){
 
-                   //Use reflection to inspect the code, based on Illuminate/Support/SerializableClosure.php
+                    //Use reflection to inspect the code, based on Illuminate/Support/SerializableClosure.php
-                   $reflection = new \ReflectionMethod($model, $method);
+                    $reflection = new \ReflectionMethod($model, $method);
 
-                   $file = new \SplFileObject($reflection->getFileName());
+                    $file = new \SplFileObject($reflection->getFileName());
-                   $file->seek($reflection->getStartLine() - 1);
+                    $file->seek($reflection->getStartLine() - 1);
 
-                   $code = '';
+                    $code = '';
-                   while ($file->key() < $reflection->getEndLine())
+                    while ($file->key() < $reflection->getEndLine())
-                   {
+                    {
-                       $code .= $file->current(); $file->next();
+                        $code .= $file->current(); $file->next();
-                   }
+                    }
-                   $begin = strpos($code, 'function(');
+                    $begin = strpos($code, 'function(');
-                   $code = substr($code, $begin, strrpos($code, '}') - $begin + 1);
+                    $code = substr($code, $begin, strrpos($code, '}') - $begin + 1);
 
-                   $begin = stripos($code, 'return $this->');
+                    foreach(array('hasMany', 'belongsToMany', 'hasOne', 'belongsTo') as $relation){
-                   $parts = explode("'", substr($code, $begin+14),3);  //"return $this->" is 14 chars
+                        $search = '$this->'.$relation.'(';
-                   if (isset($parts[2]))
+                        if($pos = stripos($code, $search)){
-                   {
+                            $code = substr($code, $pos + strlen($search));
-                       list($relation, $returnModel, $rest) = $parts;
+                            $arguments = explode(',', substr($code, 0, stripos($code, ')')));
-                       $returnModel = "\\".ltrim($returnModel, "\\");
+                            //Remove quotes, ensure 1 \ in front of the model
-                       $relation = trim($relation, ' (');
+                            $returnModel = "\\".ltrim(trim($arguments[0], " \"'"), "\\");
+                            if($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{
+                                //Single model is returned
+                                $this->setProperty($method, $returnModel, true, null);
+                            }
+                        }
+                    }
 
-                       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
-                   }
-
-               }
-           }
         }
     }
 
@@ -330,7 +359,7 @@ class ModelsCommand extends Command {
         }
 
         if(!$phpdoc->getText()){
-            $phpdoc->setText("An Eloquent Model: '$class'");
+            $phpdoc->setText($class);
         }
 
         $properties = array();

src/config/config.php

@@ -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,9 @@ 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(