Tweak @noinspection

Fixes #184

composer.json

@@ -10,10 +10,10 @@
         }
     ],
     "require": {
-        "php": ">=5.3.0",
+        "php": ">=5.4.0",
-        "illuminate/support": "4.x|5.0.x",
+        "illuminate/support": "5.0.x",
-        "illuminate/console": "4.x|5.0.x",
+        "illuminate/console": "5.0.x",
-        "illuminate/filesystem": "4.x|5.0.x",
+        "illuminate/filesystem": "5.0.x",
         "phpdocumentor/reflection-docblock": "2.0.x",
         "symfony/class-loader": "~2.3"
     },
@@ -30,7 +30,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "1.11-dev"
+            "dev-master": "2.0-dev"
         }
     }
 }

config/ide-helper.php

@@ -1,7 +1,5 @@
 <?php 
 
-use Illuminate\Support\Facades\Config;
-
 return array(
 
     /*
@@ -43,7 +41,7 @@ return array(
     */
 
     'model_locations' => array(
-        'app/models',
+        'app',
     ),
 
 
@@ -57,7 +55,6 @@ return array(
     */
 
     'extra' => array(
-        'Artisan' => array('Illuminate\Foundation\Artisan'),
         'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
         'Session' => array('Illuminate\Session\Store'),
     ),
@@ -86,7 +83,7 @@ return array(
     */
     
     'interfaces' => array(
-        '\Illuminate\Auth\UserInterface' => Config::get('auth.model', 'User'),
+        '\Illuminate\Contracts\Auth\Authenticatable' => config('auth.model', 'App\User'),
     )
 
 );

provides.json

@@ -1,5 +0,0 @@
-{
-  "providers": [
-    "Barryvdh\\LaravelIdeHelper\\IdeHelperServiceProvider"
-  ]
-}

readme.md

@@ -1,6 +1,8 @@
-## Laravel IDE Helper Generator
+## 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)
+
 ### 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!_
@@ -12,13 +14,30 @@ 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 ann `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:
 
     composer require barryvdh/laravel-ide-helper
 
-After updating composer, add the ServiceProvider to the providers array in app/config/app.php
+After updating composer, add the ServiceProvider to the providers array in config/app.php
 
     'Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider',
 
@@ -40,7 +59,7 @@ You can configure your composer.json to do this after each commit:
 
 You can also publish the config-file to change implementations (ie. interface to specific class) or set defaults for --helpers or --sublime.
 
-    php artisan config:publish barryvdh/laravel-ide-helper
+    php artisan vendor:publish --provider=barryvdh/laravel-ide-helper --tag=config
 
 The generator tries to identify the real class, but if it cannot be found, you can define it in the config file.
 
@@ -50,10 +69,9 @@ You can use a in-memory sqlite driver, using the -M option.
 You can choose to include helper files. This is not enabled by default, but you can override this with the --helpers (-H) option.
 The Illuminate/Support/helpers.php is already set-up, but you can add/remove your own files in the config file.
 
-
 ### Automatic phpDocs for Models
 
-> **Note:** Since v1.10 you need to require `doctrine/dbal: ~2.3` in your own composer.json. 
+> You need to require `doctrine/dbal: ~2.3` in your own composer.json to get database columns. 
 
 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. 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)`).
@@ -82,9 +100,9 @@ By default, models in app/models are scanned. The optional argument tells what m
 
 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" --dir="app/src/Model"
+    php artisan ide-helper:models --dir="path/to/models" --dir="app/src/Model"
    
-You can publish the config file (`php artisan config:publish barryvdh/laravel-ide-helper`) and set the default directories.
+You can publish the config file (`php artisan vendor:publish`) and set the default directories.
 
 Models can be ignored using the --ignore (-I) option
 

resources/views/helper.php

@@ -1,39 +1,39 @@
-<?= '<?php' ?>
+<?= '<?php' ?>
-
+
-/**
+/**
- * An helper file for Laravel 4, to provide autocomplete information to your IDE
+ * An helper file for Laravel 5, to provide autocomplete information to your IDE
- * Generated for Laravel <?= $version ?> on <?= date("Y-m-d") ?>.
+ * Generated for Laravel <?= $version ?> on <?= date("Y-m-d") ?>.
- *
+ *
- * @author Barry vd. Heuvel <barryvdh@gmail.com>
+ * @author Barry vd. Heuvel <barryvdh@gmail.com>
- * @see https://github.com/barryvdh/laravel-ide-helper
+ * @see https://github.com/barryvdh/laravel-ide-helper
- */
+ */
-
+
-<?php foreach($namespaces as $namespace => $aliases): ?>
+<?php foreach($namespaces as $namespace => $aliases): ?>
-namespace <?= $namespace == '__root' ? '' : $namespace ?>{
+namespace <?= $namespace == '__root' ? '' : $namespace ?>{
-<?php if($namespace == '__root'): ?>
+<?php if($namespace == '__root'): ?>
-    exit("This file should not be included, only analyzed by your IDE");
+    exit("This file should not be included, only analyzed by your IDE");
-<?= $helpers ?>
+<?= $helpers ?>
-<?php endif; ?>
+<?php endif; ?>
-<?php foreach($aliases as $alias): ?>
+<?php foreach($aliases as $alias): ?>
-
+
-    <?= $alias->getClassType() ?> <?= $alias->getShortName() ?> <?= $alias->getExtends() ? 'extends ' . $alias->getExtends() : '' ?>{
+    <?= $alias->getClassType() ?> <?= $alias->getShortName() ?> <?= $alias->getExtends() ? 'extends ' . $alias->getExtends() : '' ?>{
-        <?php foreach($alias->getMethods() as $method): ?>
+        <?php foreach($alias->getMethods() as $method): ?>
-
+
-        <?= trim($method->getDocComment('        ')) ?>
+        <?= trim($method->getDocComment('        ')) ?>
-
+
-        public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>){<?php if($method->getDeclaringClass() !== $method->getRoot()): ?>
+        public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>){<?php if($method->getDeclaringClass() !== $method->getRoot()): ?>
-
+
-            //Method inherited from <?= $method->getDeclaringClass() ?>
+            //Method inherited from <?= $method->getDeclaringClass() ?>
-            <?php endif; ?>
+            <?php endif; ?>
-
+
-            <?= $method->shouldReturn() ? 'return ': '' ?><?= $method->getRoot() ?>::<?= $method->getName() ?>(<?= $method->getParams() ?>);
+            <?= $method->shouldReturn() ? 'return ': '' ?><?= $method->getRoot() ?>::<?= $method->getName() ?>(<?= $method->getParams() ?>);
-        }
+        }
-        <?php endforeach; ?>
+        <?php endforeach; ?>
-
+
-    }
+    }
-
+
-<?php endforeach; ?>
+<?php endforeach; ?>
-
+
-}
+}
-
+
-<?php endforeach; ?>
+<?php endforeach; ?>

resources/views/meta.php

@@ -0,0 +1,21 @@
+<?= '<?php' ?> namespace PHPSTORM_META {
+
+   /**
+    * PhpStorm Meta file, to provide autocomplete information for PhpStorm
+    * Generated on <?= date("Y-m-d") ?>.
+    *
+    * @author Barry vd. Heuvel <[email protected]>
+    * @see https://github.com/barryvdh/laravel-ide-helper
+    */
+
+    /** @noinspection PhpIllegalArrayKeyTypeInspection */
+    /** @noinspection PhpUnusedLocalVariableInspection */
+    $STATIC_METHOD_TYPES = [
+<?php foreach($methods as $method): ?>
+        <?= $method ?>('') => [
+<?php foreach($bindings as $abstract => $class): ?>
+            '<?= $abstract ?>' instanceof \<?= $class ?>,
+<?php endforeach ?>        ],
+<?php endforeach ?>
+    ];
+}

src/Console/GeneratorCommand.php

@@ -59,7 +59,7 @@ class GeneratorCommand extends Command
      * @param \Illuminate\View\Factory $view
      */
     public function __construct(
-        ConfigRepository $config,
+        /*ConfigRepository */ $config,
         Filesystem $files, /* Illuminate\View\Factory */
         $view
     ) {
@@ -97,8 +97,8 @@ class GeneratorCommand extends Command
 
 
             $helpers = '';
-            if ($this->option('helpers') || ($this->config->get('laravel-ide-helper::include_helpers'))) {
+            if ($this->option('helpers') || ($this->config->get('ide-helper.include_helpers'))) {
-                foreach ($this->config->get('laravel-ide-helper::helper_files', array()) as $helper) {
+                foreach ($this->config->get('ide-helper.helper_files', array()) as $helper) {
                     if (file_exists($helper)) {
                         $helpers .= str_replace(array('<?php', '?>'), '', $this->files->get($helper));
                     }
@@ -139,7 +139,7 @@ class GeneratorCommand extends Command
      */
     protected function getArguments()
     {
-        $filename = $this->config->get('laravel-ide-helper::filename');
+        $filename = $this->config->get('ide-helper.filename');
 
         return array(
             array(
@@ -155,7 +155,7 @@ class GeneratorCommand extends Command
      */
     protected function getOptions()
     {
-        $format = $this->config->get('laravel-ide-helper::format');
+        $format = $this->config->get('ide-helper.format');
 
         return array(
             array('format', "F", InputOption::VALUE_OPTIONAL, 'The format for the IDE Helper', $format),

src/Console/MetaCommand.php

@@ -0,0 +1,132 @@
+<?php
+/**
+ * Laravel IDE Helper Generator
+ *
+ * @author    Barry vd. Heuvel <[email protected]>
+ * @copyright 2015 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\Console;
+
+use Illuminate\Console\Command;
+use Symfony\Component\Console\Input\InputOption;
+
+/**
+ * A command to generate phpstorm meta data
+ *
+ * @author Barry vd. Heuvel <[email protected]>
+ */
+class MetaCommand extends Command {
+
+    /**
+     * The console command name.
+     *
+     * @var string
+     */
+    protected $name = 'ide-helper:meta';
+    protected $filename = '.phpstorm.meta.php';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Generate metadata for PhpStorm';
+
+    /** @var \Illuminate\Contracts\Filesystem\Filesystem */
+    protected $files;
+
+    /** @var \Illuminate\Contracts\View\Factory */
+    protected $view;
+    
+    protected $methods = [
+      '\Illuminate\Foundation\Application::make',
+      '\Illuminate\Contracts\Foundation\Application::make',
+      '\Illuminate\Contracts\Container\Container::make',
+      '\Illuminate\Container\Container::make',
+      '\App::make',
+      'app',
+    ];
+
+    /**
+     *
+     * @param \Illuminate\Contracts\Filesystem\Filesystem $files
+     * @param \Illuminate\Contracts\View\Factory $view
+     */
+    public function __construct($files, $view) {
+        $this->files = $files;
+        $this->view = $view;
+        parent::__construct();
+    }
+
+    /**
+     * Execute the console command.
+     *
+     * @return void
+     */
+    public function fire()
+    {
+        $bindings = array();
+        foreach ($this->getAbstracts() as $abstract) {
+            try {
+                $concrete = $this->laravel->make($abstract);
+                if (is_object($concrete)) {
+                    $bindings[$abstract] = get_class($concrete);
+                }
+            }catch (\Exception $e) {
+                $this->error("Cannot make $abstract: ".$e->getMessage());
+            }
+        }
+
+        $content = $this->view->make('ide-helper::meta', [
+          'bindings' => $bindings,
+          'methods' => $this->methods,
+        ])->render();
+
+        $filename = $this->option('filename');
+        $written = $this->files->put($filename, $content);
+
+        if ($written !== false) {
+            $this->info("A new meta file was written to $filename");
+        } else {
+            $this->error("The meta file could not be created at $filename");
+        }
+    }
+
+    /**
+     * Get a filtered list of abstracts from the Laravel Application.
+     * 
+     * @return array
+     */
+    protected function getAbstracts()
+    {
+        $abstracts = $this->laravel->getBindings();
+        
+        // Remove the S3 cloud driver when not available
+        if (config('filesystems.cloud') === 's3' && !class_exists('League\Flysystem\AwsS3v2\AwsS3Adapter')) {
+            unset($abstracts['filesystem.cloud']);
+        }
+        
+        // Remove Redis when not available
+        if (isset($abstracts['redis']) && !class_exists('Predis\Client')) {
+            unset($abstracts['redis']);
+        }
+
+        // Return the abstract names only
+        return array_keys($abstracts);
+    }
+
+    /**
+     * Get the console command options.
+     *
+     * @return array
+     */
+    protected function getOptions()
+    {
+        return array(
+            array('filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the meta file', $this->filename),
+        );
+    }
+}

src/Console/ModelsCommand.php

@@ -60,7 +60,7 @@ class ModelsCommand extends Command
         $filename = $this->option('filename');
         $this->write = $this->option('write');
         $this->dirs = array_merge(
-            $this->laravel['config']->get('laravel-ide-helper::model_locations'),
+            $this->laravel['config']->get('ide-helper.model_locations'),
             $this->option('dir')
         );
         $model = $this->argument('model');

src/Generator.php

@@ -36,7 +36,7 @@ class Generator
      * @param \Symfony\Component\Console\Output\OutputInterface $output
      * @param string $helpers
      */
-    public function __construct(ConfigRepository $config,
+    public function __construct(/*ConfigRepository */ $config,
         /* Illuminate\View\Factory */ $view,
         OutputInterface $output = null,
         $helpers = ''
@@ -47,9 +47,9 @@ class Generator
         // Find the drivers to add to the extra/interfaces
         $this->detectDrivers();
 
-        $this->extra = array_merge($this->extra, $this->config->get('laravel-ide-helper::extra'));
+        $this->extra = array_merge($this->extra, $this->config->get('ide-helper.extra'));
-        $this->magic = array_merge($this->magic, $this->config->get('laravel-ide-helper::magic'));
+        $this->magic = array_merge($this->magic, $this->config->get('ide-helper.magic'));
-        $this->interfaces = array_merge($this->interfaces, $this->config->get('laravel-ide-helper::interfaces'));
+        $this->interfaces = array_merge($this->interfaces, $this->config->get('ide-helper.interfaces'));
         // Make all interface classes absolute
         foreach ($this->interfaces as &$interface) {
             $interface = '\\' . ltrim($interface, '\\');
@@ -77,7 +77,7 @@ class Generator
     public function generatePhpHelper()
     {
         $app = app();
-        return $this->view->make('laravel-ide-helper::ide-helper')
+        return $this->view->make('ide-helper::helper')
             ->with('namespaces', $this->getNamespaces())
             ->with('helpers', $this->helpers)
             ->with('version', $app::VERSION)
@@ -114,7 +114,7 @@ class Generator
     protected function detectDrivers()
     {
         try{
-            if (class_exists('Auth')) {
+            if (class_exists('Auth') && is_a('Auth', '\Illuminate\Support\Facades\Auth', true)) {
                 $class = get_class(\Auth::driver());
                 $this->extra['Auth'] = array($class);
                 $this->interfaces['\Illuminate\Auth\UserProviderInterface'] = $class;
@@ -122,7 +122,7 @@ class Generator
         }catch (\Exception $e) {}
 
         try{
-            if (class_exists('DB')) {
+            if (class_exists('DB') && is_a('DB', '\Illuminate\Support\Facades\DB', true)) {
                 $class = get_class(\DB::connection());
                 $this->extra['DB'] = array($class);
                 $this->interfaces['\Illuminate\Database\ConnectionInterface'] = $class;
@@ -130,7 +130,7 @@ class Generator
         }catch (\Exception $e) {}
 
         try{
-            if (class_exists('Cache')) {
+            if (class_exists('Cache') && is_a('Cache', '\Illuminate\Support\Facades\Cache', true)) {
                 $driver = get_class(\Cache::driver());
                 $store = get_class(\Cache::getStore());
                 $this->extra['Cache'] = array($driver, $store);
@@ -139,7 +139,7 @@ class Generator
         }catch (\Exception $e) {}
 
         try{
-            if (class_exists('Queue')) {
+            if (class_exists('Queue') && is_a('Queue', '\Illuminate\Support\Facades\Queue', true)) {
                 $class = get_class(\Queue::connection());
                 $this->extra['Queue'] = array($class);
                 $this->interfaces['\Illuminate\Queue\QueueInterface'] = $class;
@@ -147,7 +147,7 @@ class Generator
         }catch (\Exception $e) {}
 
         try{
-            if (class_exists('SSH')){
+            if (class_exists('SSH') && is_a('SSH', '\Illuminate\Support\Facades\SSH', true)){
                 $class = get_class(\SSH::connection());
                 $this->extra['SSH'] = array($class);
                 $this->interfaces['\Illuminate\Remote\ConnectionInterface'] = $class;
@@ -167,6 +167,12 @@ class Generator
 
         // Get all aliases
         foreach (AliasLoader::getInstance()->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;
+            }
+            
             $magicMethods = array_key_exists($name, $this->magic) ? $this->magic[$name] : array();
             $alias = new Alias($name, $facade, $magicMethods, $this->interfaces);
             if ($alias->isValid()) {

src/IdeHelperServiceProvider.php

@@ -11,8 +11,9 @@
 namespace Barryvdh\LaravelIdeHelper;
 
 use Illuminate\Support\ServiceProvider;
-use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
+use Barryvdh\LaravelIdeHelper\Console\MetaCommand;
 use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
+use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
 
 class IdeHelperServiceProvider extends ServiceProvider
 {
@@ -31,7 +32,11 @@ class IdeHelperServiceProvider extends ServiceProvider
      */
     public function boot()
     {
-        $this->package('barryvdh/laravel-ide-helper', 'laravel-ide-helper', __DIR__);
+        $viewPath = __DIR__.'/../resources/views';
+        $this->loadViewsFrom($viewPath, 'ide-helper');
+        
+        $configPath = __DIR__ . '/../config/ide-helper.php';
+        $this->publishes([$configPath => config_path('ide-helper.php')], 'config');
     }
 
     /**
@@ -41,6 +46,9 @@ class IdeHelperServiceProvider extends ServiceProvider
      */
     public function register()
     {
+        $configPath = __DIR__ . '/../config/ide-helper.php';
+        $this->mergeConfigFrom($configPath, 'ide-helper');
+        
         $this->app['command.ide-helper.generate'] = $this->app->share(
             function ($app) {
                 return new GeneratorCommand($app['config'], $app['files'], $app['view']);
@@ -52,8 +60,14 @@ class IdeHelperServiceProvider extends ServiceProvider
                 return new ModelsCommand();
             }
         );
+        
+        $this->app['command.ide-helper.meta'] = $this->app->share(
+          function ($app) {
+              return new MetaCommand($app['files'], $app['view']);
+          }
+        );
 
-        $this->commands('command.ide-helper.generate', 'command.ide-helper.models');
+        $this->commands('command.ide-helper.generate', 'command.ide-helper.models', 'command.ide-helper.meta');
     }
 
     /**
@@ -65,37 +79,5 @@ class IdeHelperServiceProvider extends ServiceProvider
     {
         return array('command.ide-helper.generate', 'command.ide-helper.models');
     }
-    
-    /**
-     * Register the package's component namespaces.
-     *
-     * @param  string  $package
-     * @param  string  $namespace
-     * @param  string  $path
-     * @return void
-     */
-    public function package($package, $namespace = null, $path = null)
-    {
-
-        // Is it possible to register the config?
-        if (method_exists($this->app['config'], 'package')) {
-            $this->app['config']->package($package, $path.'/config', $namespace);
-        } else {
-            // Load the config for now..
-            $config = $this->app['files']->getRequire($path .'/config/config.php');
-            foreach($config as $key => $value){
-                $this->app['config']->set($namespace.'::'.$key, $value);
-            }
-        }
-
-        // Register view files
-        $appView = $this->app['path']."/views/packages/{$package}";
-        if ($this->app['files']->isDirectory($appView))
-        {
-            $this->app['view']->addNamespace($namespace, $appView);
-        }
-
-        $this->app['view']->addNamespace($namespace, $path.'/views');
-    }
 
 }