Fix meta for 5.2 seeder

Fixes #287

composer.json

@@ -11,9 +11,9 @@
     ],
     "require": {
         "php": ">=5.4.0",
-        "illuminate/support": "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",
+        "illuminate/console": "5.0.x|5.1.x|5.2.x",
-        "illuminate/filesystem": "5.0.x|5.1.x",
+        "illuminate/filesystem": "5.0.x|5.1.x|5.2.x",
         "phpdocumentor/reflection-docblock": "2.0.4",
         "symfony/class-loader": "~2.3"
     },
@@ -30,7 +30,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "2.0-dev"
+            "dev-master": "2.1-dev"
         }
     }
 }

config/ide-helper.php

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

readme.md

@@ -1,54 +1,53 @@
 ## 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).
 
-* Generated version: https://gist.github.com/barryvdh/5227822
+* Generated version for L5: https://gist.github.com/barryvdh/5227822
+* Generated version for Lumen: https://gist.github.com/barryvdh/be17164b0ad51f832f20
+* Generated Phpstorm Meta file: https://gist.github.com/barryvdh/bb6ffc5d11e0a75dba67
 
 Note: You do need CodeIntel for Sublime Text: https://github.com/SublimeCodeIntel/SublimeCodeIntel
 
-### New: PhpStorm Meta for Container instances
+### Install
-
-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();
-
-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
 
 Require this package with composer using the following command:
 
+```bash
 composer require barryvdh/laravel-ide-helper
+```
 
 After updating composer, add the service provider to the `providers` array in `config/app.php`
 
+```php
 Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class,
+```
+
+### Automatic phpDoc generation for Laravel Facades
+
 
 You can now re-generate the docs yourself (for future updates)
 
+```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:
 
+```js
 "scripts":{
     "post-update-cmd": [
         "php artisan clear-compiled",
@@ -56,10 +55,13 @@ You can configure your composer.json to do this after each commit:
         "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/laravel-ide-helper --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.
 
@@ -73,14 +75,22 @@ 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.
 
+```bash
 php artisan ide-helper:models Post
+```
 
+```php
 /**
  * An Eloquent Model: 'Post'
  *
@@ -93,23 +103,54 @@ With the `--reset (-R)` option, the existing phpdocs are ignored, and only the n
  * @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).
 
+```bash
 php artisan ide-helper:models Post User
+```
 
 You can also scan a different directory, using the `--dir` option (relative from the base path):
 
+```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
 
+```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)

resources/views/meta.php

@@ -1,4 +1,6 @@
-<?= '<?php' ?> namespace PHPSTORM_META {
+<?= '<?php' ?>
+
+namespace PHPSTORM_META {
 
    /**
     * PhpStorm Meta file, to provide autocomplete information for PhpStorm
@@ -7,13 +9,10 @@
     * @author Barry vd. Heuvel <[email protected]>
     * @see https://github.com/barryvdh/laravel-ide-helper
     */
-
-    /** @noinspection PhpIllegalArrayKeyTypeInspection */
-    /** @noinspection PhpUnusedLocalVariableInspection */
-    /** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */
     $STATIC_METHOD_TYPES = [
 <?php foreach($methods as $method): ?>
-        <?= $method ?>('') => [
+        <?= $method ?> => [
+            '' == '@',
 <?php foreach($bindings as $abstract => $class): ?>
             '<?= $abstract ?>' instanceof \<?= $class ?>,
 <?php endforeach ?>        ],

src/Console/MetaCommand.php

@@ -12,6 +12,7 @@ namespace Barryvdh\LaravelIdeHelper\Console;
 
 use Illuminate\Console\Command;
 use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
 
 /**
  * A command to generate phpstorm meta data
@@ -42,12 +43,10 @@ class MetaCommand extends Command {
     protected $view;
     
     protected $methods = [
-      '\Illuminate\Foundation\Application::make',
+      'new \Illuminate\Contracts\Container\Container',
-      '\Illuminate\Contracts\Foundation\Application::make',
+      '\Illuminate\Contracts\Container\Container::make(\'\')',
-      '\Illuminate\Contracts\Container\Container::make',
+      '\App::make(\'\')',
-      '\Illuminate\Container\Container::make',
+      'app(\'\')',
-      '\App::make',
-      'app',
     ];
 
     /**
@@ -72,15 +71,22 @@ class MetaCommand extends Command {
 
         $bindings = array();
         foreach ($this->getAbstracts() as $abstract) {
+            // Validator and seeder cause problems
+            if (in_array($abstract, ['validator', 'seeder'])) {
+                continue;
+            }
+            
             try {
                 $concrete = $this->laravel->make($abstract);
                 if (is_object($concrete)) {
                     $bindings[$abstract] = get_class($concrete);
                 }
             }catch (\Exception $e) {
+                if ($this->output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
                     $this->comment("Cannot make '$abstract': ".$e->getMessage());
                 }
             }
+        }
 
         $content = $this->view->make('ide-helper::meta', [
           'bindings' => $bindings,

src/Console/ModelsCommand.php

@@ -11,9 +11,12 @@
 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;
 use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\ClassLoader\ClassMapGenerator;
 use phpDocumentor\Reflection\DocBlock;
 use phpDocumentor\Reflection\DocBlock\Context;
@@ -27,6 +30,10 @@ use phpDocumentor\Reflection\DocBlock\Serializer as DocBlockSerializer;
  */
 class ModelsCommand extends Command
 {
+    /**
+     * @var Filesystem $files
+     */
+    protected $files;
 
     /**
      * The console command name.
@@ -49,6 +56,14 @@ class ModelsCommand extends Command
     protected $dirs = array();
     protected $reset;
 
+    /**
+     * @param Filesystem $files
+     */
+    public function __construct(Filesystem $files)
+    {
+        parent::__construct();
+        $this->files = $files;
+    }
 
     /**
      * Execute the console command.
@@ -80,7 +95,7 @@ class ModelsCommand extends Command
         $content = $this->generateDocs($model, $ignore);
 
         if (!$this->write) {
-            $written = \File::put($filename, $content);
+            $written = $this->files->put($filename, $content);
             if ($written !== false) {
                 $this->info("Model information was written to $filename");
             } else {
@@ -148,7 +163,9 @@ class ModelsCommand extends Command
 
         foreach ($models as $name) {
             if (in_array($name, $ignore)) {
+                if ($this->output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
                     $this->comment("Ignoring model '$name'");
+                }
                 continue;
             }
             $this->properties = array();
@@ -162,7 +179,9 @@ class ModelsCommand extends Command
                         continue;
                     }
 
+                    if ($this->output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
                         $this->comment("Loading model '$name'");
+                    }
 
                     if (!$reflectionClass->IsInstantiable()) {
                         throw new \Exception($name . ' is not instantiable.');
@@ -176,6 +195,7 @@ class ModelsCommand extends Command
 
                     $this->getPropertiesFromMethods($model);
                     $output .= $this->createPhpDocs($name);
+                    $ignore[] = $name;
                 } catch (\Exception $e) {
                     $this->error("Exception: " . $e->getMessage() . "\nCould not analyze class $name.");
                 }
@@ -270,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')
-                );
             }
         }
     }
@@ -330,6 +345,7 @@ class ModelsCommand extends Command
                         $code .= $file->current();
                         $file->next();
                     }
+                    $code = trim(preg_replace('/\s\s+/', '', $code));
                     $begin = strpos($code, 'function(');
                     $code = substr($code, $begin, strrpos($code, '}') - $begin + 1);
 
@@ -344,25 +360,28 @@ class ModelsCommand extends Command
                              ) as $relation) {
                         $search = '$this->' . $relation . '(';
                         if ($pos = stripos($code, $search)) {
-                            $code = substr($code, $pos + strlen($search));
+
-                            $arguments = explode(',', substr($code, 0, strpos($code, ')')));
+                            //Resolve the relation's model to a Relation object.
-                            //Remove quotes, ensure 1 \ in front of the model
+                            $relationObj = $model->$method();
-                            $returnModel = $this->getClassName($arguments[0], $model);
+
-                            if ($relation === "belongsToMany" or $relation === 'hasMany' or $relation === 'morphMany' or $relation === 'morphToMany') {
+                            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 . '[]',
+                                      $this->getCollectionClass($relatedModel) . '|' . $relatedModel . '[]',
                                       true,
                                       null
                                     );
                                 } else {
                                     //Single model is returned
-                                $this->setProperty($method, $returnModel, true, null);
+                                    $this->setProperty($method, $relatedModel, true, null);
+                                }
                             }
                         }
                     }
-
                 }
             }
         }
@@ -397,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;
@@ -449,7 +470,8 @@ class ModelsCommand extends Command
             } else {
                 $attr = 'property-read';
             }
-            $tag = Tag::createInstance("@{$attr} {$property['type']} {$name} {$property['comment']}", $phpdoc);
+            $tagLine = trim("@{$attr} {$property['type']} {$name} {$property['comment']}");
+            $tag = Tag::createInstance($tagLine, $phpdoc);
             $phpdoc->appendTag($tag);
         }
 
@@ -469,7 +491,7 @@ class ModelsCommand extends Command
 
         if ($this->write) {
             $filename = $reflection->getFileName();
-            $contents = \File::get($filename);
+            $contents = $this->files->get($filename);
             if ($originalDoc) {
                 $contents = str_replace($originalDoc, $docComment, $contents);
             } else {
@@ -480,7 +502,7 @@ class ModelsCommand extends Command
                     $contents = substr_replace($contents, $replace, $pos, strlen($needle));
                 }
             }
-            if (\File::put($filename, $contents)) {
+            if ($this->files->put($filename, $contents)) {
                 $this->info('Written new phpDocBlock to ' . $filename);
             }
         }
@@ -500,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';
@@ -524,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
+        // Return something in the very very unlikely scenario the model doesn't
-        if (strpos($className, 'get_class($this)') !== false || strpos($className, 'static::class') !== false) {
+        // have a newCollection() method.
-            return get_class($model);
+        if (!method_exists($className, 'newCollection')) {
+            return '\Illuminate\Database\Eloquent\Collection';
         }
 
-        // If the class name was resolved via ::class (PHP 5.5+)
+        /** @var \Illuminate\Database\Eloquent\Model $model */
-        if (strpos($className, '::class') !== false) {
+        $model = new $className;
-            $end = -1 * strlen('::class');
+        return '\\' . get_class($model->newCollection());
-            return substr($className, 0, $end);
-        }
-
-        return "\\" . ltrim(trim($className, " \"'"), "\\") ;
     }
 }

src/Generator.php

@@ -80,7 +80,7 @@ class Generator
         return $this->view->make('ide-helper::helper')
             ->with('namespaces', $this->getNamespaces())
             ->with('helpers', $this->helpers)
-            ->with('version', $app::VERSION)
+            ->with('version', $app->version())
             ->render();
     }
 
@@ -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());
@@ -166,8 +168,7 @@ class Generator
         $namespaces = array();
 
         // Get all aliases
-        foreach (AliasLoader::getInstance()->getAliases() as $name => $facade) {
+        foreach ($this->getAliases() as $name => $facade) {
-            
             // Skip the Redis facade, if not available (otherwise Fatal PHP Error)
             if ($facade == 'Illuminate\Support\Facades\Redis' && !class_exists('Predis\Client')) {
                 continue;
@@ -194,6 +195,39 @@ class Generator
         return $namespaces;
     }
 
+    protected function getAliases()
+    {
+        // For Laravel, use the AliasLoader
+        if (class_exists('Illuminate\Foundation\AliasLoader')) {
+            return AliasLoader::getInstance()->getAliases();
+        }
+
+        $facades = [
+          '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
+        return array_filter($facades, function($alias){
+            return class_exists($alias);
+        });
+    }
+
     /**
      * Get the driver/connection/store from the managers
      *

src/IdeHelperServiceProvider.php

@@ -36,7 +36,12 @@ class IdeHelperServiceProvider extends ServiceProvider
         $this->loadViewsFrom($viewPath, 'ide-helper');
         
         $configPath = __DIR__ . '/../config/ide-helper.php';
-        $this->publishes([$configPath => config_path('ide-helper.php')], 'config');
+        if (function_exists('config_path')) {
+            $publishPath = config_path('ide-helper.php');
+        } else {
+            $publishPath = base_path('config/ide-helper.php');
+        }
+        $this->publishes([$configPath => $publishPath], 'config');
     }
 
     /**
@@ -56,8 +61,8 @@ class IdeHelperServiceProvider extends ServiceProvider
         );
 
         $this->app['command.ide-helper.models'] = $this->app->share(
-            function () {
+            function ($app) {
-                return new ModelsCommand();
+                return new ModelsCommand($app['files']);
             }
         );
         

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) . "'";
                 }