Merge pull request #294 from bytestream/master

Fixes #293

composer.json

@@ -11,9 +11,9 @@
     ],
     "require": {
         "php": ">=5.4.0",
-        "illuminate/support": "5.0.x|5.1.x",
-        "illuminate/console": "5.0.x|5.1.x",
-        "illuminate/filesystem": "5.0.x|5.1.x",
+        "illuminate/support": "5.0.x|5.1.x|5.2.x",
+        "illuminate/console": "5.0.x|5.1.x|5.2.x",
+        "illuminate/filesystem": "5.0.x|5.1.x|5.2.x",
         "phpdocumentor/reflection-docblock": "2.0.4",
         "symfony/class-loader": "~2.3"
     },

config/ide-helper.php

@@ -83,7 +83,7 @@ return array(
     */
     
     'interfaces' => array(
-        '\Illuminate\Contracts\Auth\Authenticatable' => config('auth.model', 'App\User'),
+
     ),
 
     /*

readme.md

@@ -1,12 +1,16 @@
 ## Laravel 5 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)
 
-### For Laravel 4.x, check [version 1.11](https://github.com/barryvdh/laravel-ide-helper/tree/1.11)
+__For Laravel 4.x, check [version 1.11](https://github.com/barryvdh/laravel-ide-helper/tree/1.11)__
 
 ### 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!_
 
+ * [`php artisan ide-helper:generate` - phpDoc generation for Laravel Facades ](#automatic-phpdoc-generation-for-laravel-facades)
+ * [`php artisan ide-helper:models` - phpDocs for models](#automatic-phpdocs-for-models)
+ * [`php artisan ide-helper:meta` - PhpStorm Meta file](#phpstorm-meta-for-container-instances)
+
 This package generates a file that your IDE understands, so it can provide accurate autocompletion. Generation is done based on the files in your project, so they are always 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).
 
@@ -16,55 +20,48 @@ If you don't want to generate it, you can add a pre-generated file to the root f
 
 Note: You do need CodeIntel for Sublime Text: https://github.com/SublimeCodeIntel/SublimeCodeIntel
 
-### New: PhpStorm Meta for Container instances
-
-It's possible to generate a PhpStorm meta file, to [add support for factory design pattern](https://confluence.jetbrains.com/display/PhpStorm/PhpStorm+Advanced+Metadata). For Laravel, this means we can make PhpStorm understand what kind of object we are resolving from the IoC Container. For example, `events` will return an `Illuminate\Events\Dispatcher` object, so with the meta file you can call `app('events')` and it will autocomplete the Dispatcher methods.
-
-    php artisan ide-helper:meta
-
-    app('events')->fire();
-    \App::make('events')->fire();
-
-    /** @var \Illuminate\Foundation\Application $app */
-    $app->make('events')->fire();
-    
-    // When the key is not found, it uses the argument as class name
-    app('App\SomeClass');
-
-Pre-generated example: https://gist.github.com/barryvdh/bb6ffc5d11e0a75dba67
-
-> Note: You might need to restart PhpStorm and make sure `.phpstorm.meta.php` is indexed.
-> Note: When you receive a FatalException about a class that is not found, check your config (for example, remove S3 as cloud driver when you don't have S3 configured. Remove Redis ServiceProvider when you don't use it).
-
-### Automatic phpDoc generation for Laravel Facades
+### Install
 
 Require this package with composer using the following command:
 
-    composer require barryvdh/laravel-ide-helper
+```bash
+composer require barryvdh/laravel-ide-helper
+```
 
 After updating composer, add the service provider to the `providers` array in `config/app.php`
 
-    Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class,
+```php
+Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class,
+```
+
+### Automatic phpDoc generation for Laravel Facades
+
 
 You can now re-generate the docs yourself (for future updates)
 
-    php artisan ide-helper:generate
+```bash
+php artisan ide-helper:generate
+```
 
 Note: `bootstrap/compiled.php` has to be cleared first, so run `php artisan clear-compiled` before generating (and `php artisan optimize` after).
 
 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"
-        ]
-    },
+```js
+"scripts":{
+    "post-update-cmd": [
+        "php artisan clear-compiled",
+        "php artisan ide-helper:generate",
+        "php artisan optimize"
+    ]
+},
+```
 
 You can also publish the config file to change implementations (ie. interface to specific class) or set defaults for `--helpers` or `--sublime`.
 
-    php artisan vendor:publish --provider="Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider" --tag=config
+```bash
+php artisan vendor:publish --provider="Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider" --tag=config
+```
 
 The generator tries to identify the real class, but if it cannot be found, you can define it in the config file.
 
@@ -78,43 +75,82 @@ The `Illuminate/Support/helpers.php` is already set-up, but you can add/remove y
 
 > You need to require `doctrine/dbal: ~2.3` in your own composer.json to get database columns.
 
+
+```bash
+composer require doctrine/dbal
+```
+
 If you don't want to write your properties yourself, you can use the command `php artisan 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, and only the newly found columns/relations are saved as phpdocs.
 
-    php artisan ide-helper:models Post
+```bash
+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
-     */
+```php
+/**
+ * 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
+ */
+```
 
 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
+```bash
+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="path/to/models" --dir="app/src/Model"
+```bash
+php artisan ide-helper:models --dir="path/to/models" --dir="app/src/Model"
+```
 
 You can publish the config file (`php artisan vendor:publish`) and set the default directories.
 
 Models can be ignored using the `--ignore (-I)` option
 
-    php artisan ide-helper:models --ignore="Post,User"
+```bash
+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`)
 
+## PhpStorm Meta for Container instances
+
+It's possible to generate a PhpStorm meta file, to [add support for factory design pattern](https://confluence.jetbrains.com/display/PhpStorm/PhpStorm+Advanced+Metadata). For Laravel, this means we can make PhpStorm understand what kind of object we are resolving from the IoC Container. For example, `events` will return an `Illuminate\Events\Dispatcher` object, so with the meta file you can call `app('events')` and it will autocomplete the Dispatcher methods.
+
+``` bash
+php artisan ide-helper:meta
+```
+
+```php
+app('events')->fire();
+\App::make('events')->fire();
+
+/** @var \Illuminate\Foundation\Application $app */
+$app->make('events')->fire();
+
+// When the key is not found, it uses the argument as class name
+app('App\SomeClass');
+```
+
+Pre-generated example: https://gist.github.com/barryvdh/bb6ffc5d11e0a75dba67
+
+> Note: You might need to restart PhpStorm and make sure `.phpstorm.meta.php` is indexed.
+> Note: When you receive a FatalException about a class that is not found, check your config (for example, remove S3 as cloud driver when you don't have S3 configured. Remove Redis ServiceProvider when you don't use it).
+
 ### License
 
 The Laravel IDE Helper Generator is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)

src/Console/ModelsCommand.php

@@ -11,6 +11,7 @@
 namespace Barryvdh\LaravelIdeHelper\Console;
 
 use Illuminate\Console\Command;
+use Illuminate\Database\Eloquent\Relations\Relation;
 use Illuminate\Support\Str;
 use Illuminate\Filesystem\Filesystem;
 use Symfony\Component\Console\Input\InputOption;
@@ -74,8 +75,8 @@ class ModelsCommand extends Command
         $filename = $this->option('filename');
         $this->write = $this->option('write');
         $this->dirs = array_merge(
-            $this->laravel['config']->get('ide-helper.model_locations'),
-            $this->option('dir')
+          $this->laravel['config']->get('ide-helper.model_locations'),
+          $this->option('dir')
         );
         $model = $this->argument('model');
         $ignore = $this->option('ignore');
@@ -84,7 +85,7 @@ class ModelsCommand extends Command
         //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): "
+              "Do you want to overwrite the existing model files? Choose no to write to $filename instead? (Yes/No): "
             )
             ) {
                 $this->write = true;
@@ -112,7 +113,7 @@ class ModelsCommand extends Command
     protected function getArguments()
     {
         return array(
-            array('model', InputArgument::OPTIONAL | InputArgument::IS_ARRAY, 'Which models to include', array()),
+          array('model', InputArgument::OPTIONAL | InputArgument::IS_ARRAY, 'Which models to include', array()),
         );
     }
 
@@ -124,12 +125,12 @@ class ModelsCommand extends Command
     protected function getOptions()
     {
         return array(
-            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', ''),
+          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', ''),
         );
     }
 
@@ -204,7 +205,7 @@ 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`.'
+              'Warning: `"doctrine/dbal": "~2.3"` is required to load database information. Please require that in your composer.json and run `composer update`.'
             );
         }
 
@@ -289,11 +290,6 @@ class ModelsCommand extends Command
 
                 $comment = $column->getComment();
                 $this->setProperty($name, $type, true, true, $comment);
-                $this->setMethod(
-                    Str::camel("where_" . $name),
-                    '\Illuminate\Database\Query\Builder|\\' . get_class($model),
-                    array('$value')
-                );
             }
         }
     }
@@ -307,9 +303,9 @@ class ModelsCommand extends Command
         if ($methods) {
             foreach ($methods as $method) {
                 if (Str::startsWith($method, 'get') && Str::endsWith(
-                        $method,
-                        'Attribute'
-                    ) && $method !== 'getAttribute'
+                    $method,
+                    'Attribute'
+                  ) && $method !== 'getAttribute'
                 ) {
                     //Magic get<name>Attribute
                     $name = Str::snake(substr($method, 3, -9));
@@ -317,9 +313,9 @@ class ModelsCommand extends Command
                         $this->setProperty($name, null, true, null);
                     }
                 } elseif (Str::startsWith($method, 'set') && Str::endsWith(
-                        $method,
-                        'Attribute'
-                    ) && $method !== 'setAttribute'
+                    $method,
+                    'Attribute'
+                  ) && $method !== 'setAttribute'
                 ) {
                     //Magic set<name>Attribute
                     $name = Str::snake(substr($method, 3, -9));
@@ -354,36 +350,34 @@ class ModelsCommand extends Command
                     $code = substr($code, $begin, strrpos($code, '}') - $begin + 1);
 
                     foreach (array(
-                                 'hasMany',
-                                 'belongsToMany',
-                                 'hasOne',
-                                 'belongsTo',
-                                 'morphTo',
-                                 'morphMany',
-                                 'morphToMany'
+                               'hasMany',
+                               'belongsToMany',
+                               'hasOne',
+                               'belongsTo',
+                               'morphTo',
+                               'morphMany',
+                               'morphToMany'
                              ) as $relation) {
                         $search = '$this->' . $relation . '(';
                         if ($pos = stripos($code, $search)) {
-                            $code = substr($code, $pos + strlen($search));
-                            $end = strpos($code, ')->') ?:strpos($code, ');');
-                            if (false !== $end) {
-                                $arguments = substr($code, 0, $end);
-                                $arguments = array_map(function($item) {
-                                    return trim($item, ' \'\"');
-                                }, explode(',', $arguments));
-                                //Remove quotes, ensure 1 \ in front of the model
-                                $returnModel = $this->getClassName($arguments[0], $model);
-                                if ($relation === "belongsToMany" or $relation === 'hasMany' or $relation === 'morphMany' or $relation === 'morphToMany') {
+
+                            //Resolve the relation's model to a Relation object.
+                            $relationObj = $model->$method();
+
+                            if ($relationObj instanceof Relation) {
+                                $relatedModel = '\\' . get_class($relationObj->getRelated());
+
+                                if (in_array($relation, ['belongsToMany', 'hasMany', 'morphMany', 'morphToMany'])) {
                                     //Collection or array of models (because Collection is Arrayable)
                                     $this->setProperty(
-                                        $method,
-                                        '\Illuminate\Database\Eloquent\Collection|' . $returnModel . '[]',
-                                        true,
-                                        null
+                                      $method,
+                                      $this->getCollectionClass($relatedModel) . '|' . $relatedModel . '[]',
+                                      true,
+                                      null
                                     );
                                 } else {
                                     //Single model is returned
-                                    $this->setProperty($method, $returnModel, true, null);
+                                    $this->setProperty($method, $relatedModel, true, null);
                                 }
                             }
                         }
@@ -422,7 +416,9 @@ class ModelsCommand extends Command
 
     protected function setMethod($name, $type = '', $arguments = array())
     {
-        if (!isset($this->methods[$name])) {
+        $methods = array_change_key_case($this->methods, CASE_LOWER);
+
+        if (!isset($methods[strtolower($name)])) {
             $this->methods[$name] = array();
             $this->methods[$name]['type'] = $type;
             $this->methods[$name]['arguments'] = $arguments;
@@ -526,10 +522,11 @@ class ModelsCommand extends Command
         //Loop through the default values for paremeters, and make the correct output string
         $params = array();
         $paramsWithDefault = array();
+        /** @var \ReflectionParameter $param */
         foreach ($method->getParameters() as $param) {
             $paramStr = '$' . $param->getName();
             $params[] = $paramStr;
-            if ($param->isOptional()) {
+            if ($param->isOptional() && $param->isDefaultValueAvailable()) {
                 $default = $param->getDefaultValue();
                 if (is_bool($default)) {
                     $default = $default ? 'true' : 'false';
@@ -550,23 +547,22 @@ class ModelsCommand extends Command
     }
 
     /**
+     * Determine a model classes' collection type.
+     *
+     * @see http://laravel.com/docs/eloquent-collections#custom-collections
      * @param string $className
-     * @param \Illuminate\Database\Eloquent\Model $model
      * @return string
      */
-    private function getClassName($className, $model)
+    private function getCollectionClass($className)
     {
-        // If the class name was resolved via get_class($this) or static::class
-        if (strpos($className, 'get_class($this)') !== false || strpos($className, 'static::class') !== false) {
-            return "\\" . get_class($model);
+        // Return something in the very very unlikely scenario the model doesn't
+        // have a newCollection() method.
+        if (!method_exists($className, 'newCollection')) {
+            return '\Illuminate\Database\Eloquent\Collection';
         }
 
-        // If the class name was resolved via ::class (PHP 5.5+)
-        if (strpos($className, '::class') !== false) {
-            $end = -1 * strlen('::class');
-            return substr($className, 0, $end);
-        }
-
-        return "\\" . ltrim(trim($className, " \"'"), "\\") ;
+        /** @var \Illuminate\Database\Eloquent\Model $model */
+        $model = new $className;
+        return '\\' . get_class($model->newCollection());
     }
 }

src/Generator.php

@@ -113,6 +113,8 @@ class Generator
 
     protected function detectDrivers()
     {
+        $this->interfaces['\Illuminate\Contracts\Auth\Authenticatable'] = config('auth.model', 'App\User');
+        
         try{
             if (class_exists('Auth') && is_a('Auth', '\Illuminate\Support\Facades\Auth', true)) {
                 $class = get_class(\Auth::driver());
@@ -201,23 +203,23 @@ class Generator
         }
 
         $facades = [
-            'Illuminate\Support\Facades\App' => 'App',
-            'Illuminate\Support\Facades\Auth' => 'Auth',
-            'Illuminate\Support\Facades\Bus' => 'Bus',
-            'Illuminate\Support\Facades\DB' => 'DB',
-            'Illuminate\Support\Facades\Cache' => 'Cache',
-            'Illuminate\Support\Facades\Cookie' => 'Cookie',
-            'Illuminate\Support\Facades\Crypt' => 'Crypt',
-            'Illuminate\Support\Facades\Event' => 'Event',
-            'Illuminate\Support\Facades\Hash' => 'Hash',
-            'Illuminate\Support\Facades\Log' => 'Log',
-            'Illuminate\Support\Facades\Mail' => 'Mail',
-            'Illuminate\Support\Facades\Queue' => 'Queue',
-            'Illuminate\Support\Facades\Request' => 'Request',
-            'Illuminate\Support\Facades\Schema' => 'Schema',
-            'Illuminate\Support\Facades\Session' => 'Session',
-            'Illuminate\Support\Facades\Storage' => 'Storage',
-          //  'Illuminate\Support\Facades\Validator' => 'Validator',
+          'App' => 'Illuminate\Support\Facades\App',
+          'Auth' => 'Illuminate\Support\Facades\Auth',
+          'Bus' => 'Illuminate\Support\Facades\Bus',
+          'DB' => 'Illuminate\Support\Facades\DB',
+          'Cache' => 'Illuminate\Support\Facades\Cache',
+          'Cookie' => 'Illuminate\Support\Facades\Cookie',
+          'Crypt' => 'Illuminate\Support\Facades\Crypt',
+          'Event' => 'Illuminate\Support\Facades\Event',
+          'Hash' => 'Illuminate\Support\Facades\Hash',
+          'Log' => 'Illuminate\Support\Facades\Log',
+          'Mail' => 'Illuminate\Support\Facades\Mail',
+          'Queue' => 'Illuminate\Support\Facades\Queue',
+          'Request' => 'Illuminate\Support\Facades\Request',
+          'Schema' => 'Illuminate\Support\Facades\Schema',
+          'Session' => 'Illuminate\Support\Facades\Session',
+          'Storage' => 'Illuminate\Support\Facades\Storage',
+          //'Validator' => 'Illuminate\Support\Facades\Validator',
         ];
 
         // Only return the ones that actually exist

src/Method.php

@@ -270,6 +270,8 @@ class Method
                     $default = 'null';
                 } elseif (is_int($default)) {
                     //$default = $default;
+                } elseif (is_resource($default)) {
+                    //skip to not fail
                 } else {
                     $default = "'" . trim($default) . "'";
                 }