Check for correct facades

JSON standard does not allow trailing comma

provides.json

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

readme.md

@@ -1,6 +1,8 @@
 ## Laravel 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 5, check the [2.0 branch](https://github.com/barryvdh/laravel-ide-helper)
+
 ### 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!_
@@ -14,9 +16,9 @@ Note: You do need CodeIntel for Sublime Text: https://github.com/SublimeCodeInte
 
 ### Automatic phpDoc generation for Laravel Facades
 
-Require this package in your composer.json and run composer update (or run `composer require barryvdh/laravel-ide-helper:1.*` directly):
+Require this package with composer using the following command:
 
-    "barryvdh/laravel-ide-helper": "1.*"
+    composer require barryvdh/laravel-ide-helper
 
 After updating composer, add the ServiceProvider to the providers array in app/config/app.php
 
@@ -34,7 +36,7 @@ You can configure your composer.json to do this after each commit:
         "post-update-cmd":[
             "php artisan clear-compiled",
             "php artisan ide-helper:generate",
-            "php artisan optimize",
+            "php artisan optimize"
         ]
     },
 

src/Alias.php

@@ -12,11 +12,11 @@ namespace Barryvdh\LaravelIdeHelper;
 
 class Alias
 {
-
     protected $alias;
     protected $facade;
     protected $extends = null;
     protected $classType = 'class';
+    protected $short;
     protected $namespace = '__root';
     protected $root = null;
     protected $classes = array();
@@ -42,7 +42,6 @@ class Alias
         $facade = '\\' . ltrim($facade, '\\');
         $this->facade = $facade;
 
-
         $this->detectRoot();
 
         if ((!$this->isTrait() && $this->root)) {
@@ -55,7 +54,9 @@ class Alias
         $this->detectNamespace();
         $this->detectClassType();
         
-
+        if($facade === '\Illuminate\Database\Eloquent\Model'){
+            $this->usedMethods = array('decrement', 'increment');
+        }
     }
 
     /**
@@ -114,6 +115,12 @@ class Alias
         return $this->alias;
     }
 
+    /**
+     * Return the short name (without namespace)
+     */
+    public function getShortName(){
+        return $this->short;
+    }
     /**
      * Get the namespace from the alias
      *
@@ -145,6 +152,8 @@ class Alias
             $nsParts = explode('\\', $this->alias);
             $this->short = array_pop($nsParts);
             $this->namespace = implode('\\', $nsParts);
+        }else{
+            $this->short = $this->alias;
         }
     }
 
@@ -184,7 +193,6 @@ class Alias
 
             //If it doesn't exist, skip it
             if (!class_exists($root) && !interface_exists($root)) {
-                $this->error("Class $root is not found.");
                 return;
             }
 
@@ -253,7 +261,7 @@ class Alias
                     if (!in_array($method->name, $this->usedMethods)) {
                         // Only add the methods to the output when the root is not the same as the class.
                         // And don't add the __*() methods
-                        if ($this->extends !== $class && $method->name !== '__clone') {
+                        if ($this->extends !== $class && substr($method->name, 0, 2) !== '__') {
                             $this->methods[] = new Method($method, $this->alias, $reflection, $method->name, $this->interfaces);
                         }
                         $this->usedMethods[] = $method->name;

src/Console/GeneratorCommand.php

@@ -82,6 +82,14 @@ class GeneratorCommand extends Command
             );
         } else {
             $filename = $this->argument('filename');
+            $format = $this->option('format');
+
+            // Strip the php extension
+            if (substr($filename, -4, 4) == '.php') {
+                $filename = substr($filename, 0, -4);
+            }
+
+            $filename .= '.' . $format;
 
             if ($this->option('memory')) {
                 $this->useMemoryDriver();
@@ -100,7 +108,7 @@ class GeneratorCommand extends Command
             }
 
             $generator = new Generator($this->config, $this->view, $this->getOutput(), $helpers);
-            $content = $generator->generate();
+            $content = $generator->generate($format);
             $written = $this->files->put($filename, $content);
 
             if ($written !== false) {
@@ -131,12 +139,11 @@ class GeneratorCommand extends Command
      */
     protected function getArguments()
     {
+        $filename = $this->config->get('laravel-ide-helper::filename');
+
         return array(
             array(
-                'filename',
+                'filename', InputArgument::OPTIONAL, 'The path to the helper file', $filename
-                InputArgument::OPTIONAL,
-                'The path to the helper file',
-                $this->config->get('laravel-ide-helper::filename')
             ),
         );
     }
@@ -148,7 +155,10 @@ class GeneratorCommand extends Command
      */
     protected function getOptions()
     {
+        $format = $this->config->get('laravel-ide-helper::format');
+
         return array(
+            array('format', "F", InputOption::VALUE_OPTIONAL, 'The format for the IDE Helper', $format),
             array('helpers', "H", InputOption::VALUE_NONE, 'Include the helper files'),
             array('memory', "M", InputOption::VALUE_NONE, 'Use sqlite memory driver'),
             array('sublime', "S", InputOption::VALUE_NONE, 'DEPRECATED: Use different style for SublimeText CodeIntel'),

src/Console/ModelsCommand.php

@@ -150,8 +150,6 @@ class ModelsCommand extends Command
             if (in_array($name, $ignore)) {
                 $this->comment("Ignoring model '$name'");
                 continue;
-            } else {
-                $this->comment("Loading model '$name'");
             }
             $this->properties = array();
             $this->methods = array();
@@ -159,31 +157,35 @@ class ModelsCommand extends Command
                 try {
                     // handle abstract classes, interfaces, ...
                     $reflectionClass = new \ReflectionClass($name);
-                    if (!$reflectionClass->IsInstantiable()) {
+
-                        throw new \Exception($name . ' is not instanciable.');
+                    if (!$reflectionClass->isSubclassOf('Illuminate\Database\Eloquent\Model')) {
-                    } elseif (!$reflectionClass->isSubclassOf('Illuminate\Database\Eloquent\Model')) {
-                        $this->comment("Class '$name' is not a model");
                         continue;
                     }
 
-                    $model = new $name();
+                    $this->comment("Loading model '$name'");
+
+                    if (!$reflectionClass->IsInstantiable()) {
+                        throw new \Exception($name . ' is not instantiable.');
+                    }
+
+                    $model = $this->laravel->make($name);
+
                     if ($hasDoctrine) {
                         $this->getPropertiesFromTable($model);
                     }
+
                     $this->getPropertiesFromMethods($model);
                     $output .= $this->createPhpDocs($name);
                 } catch (\Exception $e) {
                     $this->error("Exception: " . $e->getMessage() . "\nCould not analyze class $name.");
                 }
-            } else {
-                $this->error("Class $name does not exist");
             }
 
         }
 
         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`.'
             );
         }
 
@@ -254,8 +256,8 @@ class ModelsCommand extends Command
                     }
                 }
 
-
+                $comment = $column->getComment();
-                $this->setProperty($name, $type, true, true);
+                $this->setProperty($name, $type, true, true, $comment);
                 $this->setMethod(
                     Str::camel("where_" . $name),
                     '\Illuminate\Database\Query\Builder|\\' . get_class($model),
@@ -331,9 +333,9 @@ class ModelsCommand extends Command
                         $search = '$this->' . $relation . '(';
                         if ($pos = stripos($code, $search)) {
                             $code = substr($code, $pos + strlen($search));
-                            $arguments = explode(',', substr($code, 0, stripos($code, ')')));
+                            $arguments = explode(',', substr($code, 0, strpos($code, ');')));
                             //Remove quotes, ensure 1 \ in front of the model
-                            $returnModel = "\\" . ltrim(trim($arguments[0], " \"'"), "\\");
+                            $returnModel = $this->getClassName($arguments[0], $model);
                             if ($relation === "belongsToMany" or $relation === 'hasMany' or $relation === 'morphMany' or $relation === 'morphToMany') {
                                 //Collection or array of models (because Collection is Arrayable)
                                 $this->setProperty(
@@ -359,14 +361,16 @@ class ModelsCommand extends Command
      * @param string|null $type
      * @param bool|null $read
      * @param bool|null $write
+     * @param string|null $comment
      */
-    protected function setProperty($name, $type = null, $read = null, $write = null)
+    protected function setProperty($name, $type = null, $read = null, $write = null, $comment='')
     {
         if (!isset($this->properties[$name])) {
             $this->properties[$name] = array();
             $this->properties[$name]['type'] = 'mixed';
             $this->properties[$name]['read'] = false;
             $this->properties[$name]['write'] = false;
+            $this->properties[$name]['comment'] = (string) $comment;
         }
         if ($type !== null) {
             $this->properties[$name]['type'] = $type;
@@ -433,7 +437,7 @@ class ModelsCommand extends Command
             } else {
                 $attr = 'property-read';
             }
-            $tag = Tag::createInstance("@{$attr} {$property['type']} {$name}", $phpdoc);
+            $tag = Tag::createInstance("@{$attr} {$property['type']} {$name} {$property['comment']}", $phpdoc);
             $phpdoc->appendTag($tag);
         }
 
@@ -442,7 +446,7 @@ class ModelsCommand extends Command
                 continue;
             }
             $arguments = implode(', ', $method['arguments']);
-            $tag = Tag::createInstance("@method static {$method['type']} {$name}({$arguments}) ", $phpdoc);
+            $tag = Tag::createInstance("@method static {$method['type']} {$name}({$arguments})", $phpdoc);
             $phpdoc->appendTag($tag);
         }
 
@@ -507,4 +511,24 @@ class ModelsCommand extends Command
         return $paramsWithDefault;
     }
 
+    /**
+     * @param string $className
+     * @param \Illuminate\Database\Eloquent\Model $model
+     * @return string
+     */
+    private function getClassName($className, $model)
+    {
+        // 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);
+        }
+
+        // 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, " \"'"), "\\") ;
+    }
 }

src/Generator.php

@@ -50,15 +50,31 @@ class Generator
         $this->extra = array_merge($this->extra, $this->config->get('laravel-ide-helper::extra'));
         $this->magic = array_merge($this->magic, $this->config->get('laravel-ide-helper::magic'));
         $this->interfaces = array_merge($this->interfaces, $this->config->get('laravel-ide-helper::interfaces'));
+        // Make all interface classes absolute
+        foreach ($this->interfaces as &$interface) {
+            $interface = '\\' . ltrim($interface, '\\');
+        }
         $this->helpers = $helpers;
     }
 
     /**
      * Generate the helper file contents;
      *
+     * @param  string  $format  The format to generate the helper in (php/json)
      * @return string;
      */
-    public function generate()
+    public function generate($format = 'php')
+    {
+        // Check if the generator for this format exists
+        $method = 'generate'.ucfirst($format).'Helper';
+        if (method_exists($this, $method)) {
+            return $this->$method();
+        }
+
+        return $this->generatePhpHelper();
+    }
+
+    public function generatePhpHelper()
     {
         $app = app();
         return $this->view->make('laravel-ide-helper::ide-helper')
@@ -68,10 +84,37 @@ class Generator
             ->render();
     }
 
+    public function generateJsonHelper()
+    {
+        $classes = array();
+        foreach ($this->getNamespaces() as $aliases) {
+            foreach($aliases as $alias) {
+                $functions = array();
+                foreach ($alias->getMethods() as $method) {
+                    $functions[$method->getName()] = '('. $method->getParamsWithDefault().')';
+                }
+                $classes[$alias->getAlias()] = array(
+                    'functions' => $functions,
+                );
+            }
+        }
+
+        $flags = JSON_FORCE_OBJECT;
+        if (defined('JSON_PRETTY_PRINT')) {
+            $flags |= JSON_PRETTY_PRINT;
+        }
+
+        return json_encode(array(
+            'php' => array(
+                'classes' => $classes,
+            ),
+        ), $flags);
+    }
+
     protected function detectDrivers()
     {
         try{
-            if (class_exists('Cache')) {
+            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;
@@ -79,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;
@@ -87,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);
@@ -96,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;
@@ -104,17 +147,13 @@ 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;
             }
         }catch (\Exception $e) {}
 
-        // Make all interface classes absolute
-        foreach ($this->interfaces as &$interface) {
-            $interface = '\\' . ltrim($interface, '\\');
-        }
     }
 
     /**

src/IdeHelperServiceProvider.php

@@ -12,8 +12,7 @@ namespace Barryvdh\LaravelIdeHelper;
 
 use Illuminate\Support\ServiceProvider;
 use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
-use Barryvdh\LaravelIdeHelper\Console\Generator2Command;
+use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
-Use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
 
 class IdeHelperServiceProvider extends ServiceProvider
 {
@@ -67,4 +66,36 @@ 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');
+    }
+
 }

src/Method.php

@@ -52,9 +52,9 @@ class Method
 
         //Normalize the description and inherit the docs from parents/interfaces
         try {
-            $this->normalizeDescription();
+            $this->normalizeParams($this->phpdoc);
-            $this->normalizeParams();
+            $this->normalizeReturn($this->phpdoc);
-            $this->normalizeReturn();
+            $this->normalizeDescription($this->phpdoc);
         } catch (\Exception $e) {}
 
         //Get the parameters, including formatted default values
@@ -136,11 +136,12 @@ class Method
     /**
      * Get the description and get the inherited docs.
      *
+     * @param DocBlock $phpdoc
      */
-    protected function normalizeDescription()
+    protected function normalizeDescription(DocBlock $phpdoc)
     {
         //Get the short + long description from the DocBlock
-        $description = $this->phpdoc->getText();
+        $description = $phpdoc->getText();
 
         //Loop through parents/interfaces, to fill in {@inheritdoc}
         if (strpos($description, '{@inheritdoc}') !== false) {
@@ -148,14 +149,18 @@ class Method
             $inheritDescription = $inheritdoc->getText();
 
             $description = str_replace('{@inheritdoc}', $inheritDescription, $description);
-            $this->phpdoc->setText($description);
+            $phpdoc->setText($description);
+
+            $this->normalizeParams($inheritdoc);
+            $this->normalizeReturn($inheritdoc);
 
             //Add the tags that are inherited
             $inheritTags = $inheritdoc->getTags();
             if ($inheritTags) {
+                /** @var Tag $tag */
                 foreach ($inheritTags as $tag) {
                     $tag->setDocBlock();
-                    $this->phpdoc->appendTag($tag);
+                    $phpdoc->appendTag($tag);
                 }
             }
         }
@@ -163,11 +168,13 @@ class Method
 
     /**
      * Normalize the parameters
+     *
+     * @param DocBlock $phpdoc
      */
-    protected function normalizeParams()
+    protected function normalizeParams(DocBlock $phpdoc)
     {
         //Get the return type and adjust them for beter autocomplete
-        $paramTags = $this->phpdoc->getTagsByName('param');
+        $paramTags = $phpdoc->getTagsByName('param');
         if ($paramTags) {
             /** @var ParamTag $tag */
             foreach($paramTags as $tag){
@@ -184,11 +191,13 @@ class Method
 
     /**
      * Normalize the return tag (make full namespace, replace interfaces)
+     *
+     * @param DocBlock $phpdoc
      */
-    protected function normalizeReturn()
+    protected function normalizeReturn(DocBlock $phpdoc)
     {
         //Get the return type and adjust them for beter autocomplete
-        $returnTags = $this->phpdoc->getTagsByName('return');
+        $returnTags = $phpdoc->getTagsByName('return');
         if ($returnTags) {
             /** @var ReturnTag $tag */
             $tag = reset($returnTags);
@@ -252,7 +261,7 @@ class Method
             $paramStr = '$' . $param->getName();
             $params[] = $paramStr;
             if ($param->isOptional()) {
-                $default = $param->getDefaultValue();
+                $default = $param->isDefaultValueAvailable() ? $param->getDefaultValue() : null;
                 if (is_bool($default)) {
                     $default = $default ? 'true' : 'false';
                 } elseif (is_array($default)) {
@@ -275,7 +284,7 @@ class Method
 
     /**
      * @param \ReflectionMethod $reflectionMethod
-     * @return string
+     * @return DocBlock
      */
     protected function getInheritDoc($reflectionMethod)
     {
@@ -288,7 +297,9 @@ class Method
             $method = $reflectionMethod->getPrototype();
         }
         if ($method) {
-            $phpdoc = new DocBlock($method);
+            $namespace = $method->getDeclaringClass()->getNamespaceName();
+            $phpdoc = new DocBlock($method, new Context($namespace));
+            
             if (strpos($phpdoc->getText(), '{@inheritdoc}') !== false) {
                 //Not at the end yet, try another parent/interface..
                 return $this->getInheritDoc($method);

src/config/config.php

@@ -1,17 +1,20 @@
 <?php 
 
+use Illuminate\Support\Facades\Config;
+
 return array(
 
     /*
     |--------------------------------------------------------------------------
-    | Filename
+    | Filename & Format
     |--------------------------------------------------------------------------
     |
-    | The default path to the helper file
+    | The default filename (without extension) and the format (php or json)
     |
     */
 
-    'filename' => '_ide_helper.php',
+    'filename'  => '_ide_helper',
+    'format'    => 'php',
 
     /*
     |--------------------------------------------------------------------------
@@ -71,8 +74,19 @@ return array(
             'emergency' => 'Monolog\Logger::addEmergency',
         )
     ),
+    
+    /*
+    |--------------------------------------------------------------------------
+    | Interface implementations
+    |--------------------------------------------------------------------------
+    |
+    | These interfaces will be replaced with the implementing class. Some interfaces
+    | are detected by the helpers, others can be listed below.
+    |
+    */
+    
     'interfaces' => array(
-        '\Illuminate\Auth\UserInterface' => '\User',
+        '\Illuminate\Auth\UserInterface' => Config::get('auth.model', 'User'),
     )
 
 );

src/views/ide-helper.php

@@ -16,10 +16,10 @@ namespace <?= $namespace == '__root' ? '' : $namespace ?>{
 <?php endif; ?>
 <?php foreach($aliases as $alias): ?>
 
-    <?= $alias->getClassType() ?> <?= $alias->getAlias() ?> <?= $alias->getExtends() ? 'extends ' . $alias->getExtends() : '' ?>{
+    <?= $alias->getClassType() ?> <?= $alias->getShortName() ?> <?= $alias->getExtends() ? 'extends ' . $alias->getExtends() : '' ?>{
         <?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()): ?>