prevent loading views if view class not in container (#691)

* Fix missing doc-block.

* Fixes a bug where a missing DocBlock caused errors.

* Change Option Shorthand to W
Because it is not allowed to have two char shorthands for options.

* Revert code refactoring.

* Fix copied config header.

.travis.yml

@@ -1,7 +1,6 @@
 language: php
 
 php:
-  - 5.6
   - 7.0
   - 7.1
   - 7.2
@@ -17,11 +16,11 @@ cache:
 
 matrix:
   include:
-    - php: 5.6
+    - php: 7.0
       env: 'COMPOSER_FLAGS="--prefer-stable --prefer-lowest"'
 
 before_script:
-  - travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-dist
+  - travis_wait 20 travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-dist
 
 script:
   - vendor/bin/phpcs --standard=psr2 src/

composer.json

@@ -14,7 +14,7 @@
         "illuminate/support": "^5.5,<5.8",
         "illuminate/console": "^5.5,<5.8",
         "illuminate/filesystem": "^5.5,<5.8",
-        "barryvdh/reflection-docblock": "^2.0.4",
+        "barryvdh/reflection-docblock": "^2.0.6",
         "composer/composer": "^1.6"
     },
     "require-dev": {

config/ide-helper.php

@@ -38,6 +38,21 @@ return array(
 
     'write_model_magic_where' => true,
 
+    /*
+    |--------------------------------------------------------------------------
+    | Write Eloquent Model Mixins
+    |--------------------------------------------------------------------------
+    |
+    | This will add the necessary DocBlock mixins to the model class
+    | contained in the Laravel Framework. This helps the IDE with
+    | auto-completion.
+    |
+    | Please be aware that this setting changes a file within the /vendor directory.
+    |
+    */
+
+    'write_eloquent_model_mixins' => false,
+
     /*
     |--------------------------------------------------------------------------
     | Helper files to include

resources/views/helper.php

@@ -1,4 +1,12 @@
 <?= '<?php' ?>
+<?php
+/**
+ * @var \Barryvdh\LaravelIdeHelper\Alias[][] $namespaces_by_alias_ns
+ * @var \Barryvdh\LaravelIdeHelper\Alias[][] $namespaces_by_extends_ns
+ * @var bool $include_fluent
+ * @var string $helpers
+ */
+?>
 
 // @formatter:off
 
@@ -28,7 +36,7 @@ namespace <?= $namespace == '__root' ? '' : trim($namespace, '\\') ?> {
             //Method inherited from <?= $method->getDeclaringClass() ?>
             <?php endif; ?>
 
-            <?= $method->shouldReturn() ? 'return ': '' ?><?= $method->getRoot() ?>::<?= $method->getName() ?>(<?= $method->getParams() ?>);
+            <?= $method->shouldReturn() ? 'return ': '' ?><?= $method->getRoot() ?>::<?= $method->getRealName() ?>(<?= $method->getParams() ?>);
         }
         <?php endforeach; ?> 
     }
@@ -50,7 +58,7 @@ namespace <?= $namespace == '__root' ? '' : trim($namespace, '\\') ?> {
                 //Method inherited from <?= $method->getDeclaringClass() ?>
                 <?php endif; ?>
     
-                <?= $method->shouldReturn() ? 'return ': '' ?><?= $method->getRoot() ?>::<?= $method->getName() ?>(<?= $method->getParams() ?>);
+                <?= $method->shouldReturn() ? 'return ': '' ?><?= $method->getRoot() ?>::<?= $method->getRealName() ?>(<?= $method->getParams() ?>);
             }
         <?php endforeach; ?>
 <?php endif; ?>}

src/Alias.php

@@ -13,6 +13,7 @@ namespace Barryvdh\LaravelIdeHelper;
 use Barryvdh\Reflection\DocBlock;
 use Barryvdh\Reflection\DocBlock\Context;
 use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
+use Barryvdh\Reflection\DocBlock\Tag\MethodTag;
 use ReflectionClass;
 
 class Alias
@@ -171,10 +172,14 @@ class Alias
     /**
      * Get the methods found by this Alias
      *
-     * @return array
+     * @return array|Method[]
      */
     public function getMethods()
     {
+        if (count($this->methods) > 0) {
+            return $this->methods;
+        }
+
         $this->addMagicMethods();
         $this->detectMethods();
         return $this->methods;
@@ -310,7 +315,7 @@ class Alias
             $method = new \ReflectionMethod($className, $name);
             $class = new \ReflectionClass($className);
 
-            if (!in_array($method->name, $this->usedMethods)) {
+            if (!in_array($magic, $this->usedMethods)) {
                 if ($class !== $this->root) {
                     $this->methods[] = new Method($method, $this->alias, $class, $magic, $this->interfaces);
                 }
@@ -356,14 +361,17 @@ class Alias
                 $properties = $reflection->getStaticProperties();
                 $macros = isset($properties['macros']) ? $properties['macros'] : [];
                 foreach ($macros as $macro_name => $macro_func) {
-                    // Add macros
-                    $this->methods[] = new Macro(
-                        $this->getMacroFunction($macro_func),
-                        $this->alias,
-                        $reflection,
-                        $macro_name,
-                        $this->interfaces
-                    );
+                    if (!in_array($macro_name, $this->usedMethods)) {
+                        // Add macros
+                        $this->methods[] = new Macro(
+                            $this->getMacroFunction($macro_func),
+                            $this->alias,
+                            $reflection,
+                            $macro_name,
+                            $this->interfaces
+                        );
+                        $this->usedMethods[] = $macro_name;
+                    }
                 }
             }
         }
@@ -395,12 +403,32 @@ class Alias
         $serializer = new DocBlockSerializer(1, $prefix);
 
         if ($this->phpdoc) {
+            $this->removeDuplicateMethodsFromPhpDoc();
             return $serializer->getDocComment($this->phpdoc);
         }
         
         return '';
     }
 
+    /**
+     * Removes method tags from the doc comment that already appear as functions inside the class.
+     * This prevents duplicate function errors in the IDE.
+     *
+     * @return void
+     */
+    protected function removeDuplicateMethodsFromPhpDoc()
+    {
+        $methodNames = array_map(function (Method $method) {
+            return $method->getName();
+        }, $this->getMethods());
+
+        foreach ($this->phpdoc->getTags() as $tag) {
+            if ($tag instanceof MethodTag && in_array($tag->getMethodName(), $methodNames)) {
+                $this->phpdoc->deleteTag($tag);
+            }
+        }
+    }
+
     /**
      * Output an error.
      *

src/Console/GeneratorCommand.php

@@ -115,7 +115,10 @@ class GeneratorCommand extends Command
 
             if ($written !== false) {
                 $this->info("A new helper file was written to $filename");
-                Eloquent::writeEloquentModelHelper($this, $this->files);
+
+                if ($this->option('write_mixins')) {
+                    Eloquent::writeEloquentModelHelper($this, $this->files);
+                }
             } else {
                 $this->error("The helper file could not be created at $filename");
             }
@@ -159,9 +162,11 @@ class GeneratorCommand extends Command
     protected function getOptions()
     {
         $format = $this->config->get('ide-helper.format');
+        $writeMixins = $this->config->get('ide-helper.write_eloquent_model_mixins');
 
         return array(
             array('format', "F", InputOption::VALUE_OPTIONAL, 'The format for the IDE Helper', $format),
+            array('write_mixins', "W", InputOption::VALUE_OPTIONAL, 'Write mixins to Laravel Model?', $writeMixins),
             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

@@ -444,6 +444,9 @@ class ModelsCommand extends Command
                         array_shift($args);
                         $this->setMethod($name, '\Illuminate\Database\Eloquent\Builder|\\' . $reflection->class, $args);
                     }
+                } elseif (in_array($method, ['query', 'newQuery', 'newModelQuery'])) {
+                    $reflection = new \ReflectionClass($model);
+                    $this->setMethod($method, '\Illuminate\Database\Eloquent\Builder|\\' . $reflection->getName());
                 } elseif (!method_exists('Illuminate\Database\Eloquent\Model', $method)
                     && !Str::startsWith($method, 'get')
                 ) {
@@ -479,7 +482,7 @@ class ModelsCommand extends Command
                             //Resolve the relation's model to a Relation object.
                             $methodReflection = new \ReflectionMethod($model, $method);
                             if ($methodReflection->getNumberOfParameters()) {
-                                return;
+                                continue;
                             }
 
                             $relationObj = $model->$method();

src/Eloquent.php

@@ -32,27 +32,57 @@ class Eloquent
         $reflection  = new \ReflectionClass($class);
         $namespace   = $reflection->getNamespaceName();
         $originalDoc = $reflection->getDocComment();
+
         if (!$originalDoc) {
             $command->info('Unexpected no document on ' . $class);
         }
         $phpdoc = new DocBlock($reflection, new Context($namespace));
 
         $mixins = $phpdoc->getTagsByName('mixin');
-        foreach ($mixins as $m) {
-            if ($m->getContent() === '\Eloquent') {
-                $command->info('Tag Exists: @mixin \Eloquent in ' . $class);
+        $expectedMixins = [
+            '\Eloquent'                             => false,
+            '\Illuminate\Database\Eloquent\Builder' => false,
+            '\Illuminate\Database\Query\Builder'    => false,
+        ];
 
-                return;
+        foreach ($mixins as $m) {
+            $mixin = $m->getContent();
+
+            if (isset($expectedMixins[$mixin])) {
+                $command->info('Tag Exists: @mixin ' . $mixin . ' in ' . $class);
+
+                $expectedMixins[$mixin] = true;
             }
         }
 
-        // add the Eloquent mixin
-        $phpdoc->appendTag(Tag::createInstance("@mixin \\Eloquent", $phpdoc));
+        $changed = false;
+        foreach ($expectedMixins as $expectedMixin => $present) {
+            if ($present === false) {
+                $phpdoc->appendTag(Tag::createInstance('@mixin ' . $expectedMixin, $phpdoc));
+
+                $changed = true;
+            }
+        }
+
+        // If nothing's changed, stop here.
+        if (!$changed) {
+            return;
+        }
 
         $serializer = new DocBlockSerializer();
         $serializer->getDocComment($phpdoc);
         $docComment = $serializer->getDocComment($phpdoc);
 
+        /*
+            The new DocBlock is appended to the beginning of the class declaration.
+            Since there is no DocBlock, the declaration is used as a guide.
+        */
+        if (!$originalDoc) {
+            $originalDoc = 'abstract class Model implements';
+
+            $docComment .= "\nabstract class Model implements";
+        }
+
         $filename = $reflection->getFileName();
         if ($filename) {
             $contents = $files->get($filename);
@@ -61,7 +91,7 @@ class Eloquent
                 $contents = str_replace($originalDoc, $docComment, $contents, $count);
                 if ($count > 0) {
                     if ($files->put($filename, $contents)) {
-                        $command->info('Wrote @mixin \Eloquent to ' . $filename);
+                        $command->info('Wrote expected docblock to ' . $filename);
                     } else {
                         $command->error('File write failed to ' . $filename);
                     }

src/Generator.php

@@ -198,7 +198,7 @@ class Generator
         // Get all aliases
         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')) {
+            if ($facade == 'Illuminate\Support\Facades\Redis' && $name == 'Redis' && !class_exists('Predis\Client')) {
                 continue;
             }
 
@@ -272,9 +272,13 @@ class Generator
         $facades = array_merge($facades, $this->config->get('app.aliases', []));
 
         // Only return the ones that actually exist
-        return array_filter($facades, function ($alias) {
-            return class_exists($alias);
-        });
+        return array_filter(
+            $facades,
+            function ($alias) {
+                return class_exists($alias);
+            },
+            ARRAY_FILTER_USE_KEY
+        );
     }
 
     /**

src/IdeHelperServiceProvider.php

@@ -37,8 +37,10 @@ class IdeHelperServiceProvider extends ServiceProvider
      */
     public function boot()
     {
-        $viewPath = __DIR__.'/../resources/views';
-        $this->loadViewsFrom($viewPath, 'ide-helper');
+        if ($this->app->has('view')) {
+            $viewPath = __DIR__ . '/../resources/views';
+            $this->loadViewsFrom($viewPath, 'ide-helper');
+        }
 
         $configPath = __DIR__ . '/../config/ide-helper.php';
         if (function_exists('config_path')) {

src/Macro.php

@@ -17,36 +17,30 @@ class Macro extends Method
      * @param array               $interfaces
      */
     public function __construct(
-        \ReflectionFunctionAbstract $method,
+        $method,
         $alias,
         $class,
         $methodName = null,
         $interfaces = array()
     ) {
-        $this->method = $method;
-        $this->interfaces = $interfaces;
-        $this->name = $methodName ?: $method->name;
-        $this->namespace = $class->getNamespaceName();
+        parent::__construct($method, $alias, $class, $methodName, $interfaces);
+    }
 
-        //Create a DocBlock and serializer instance
+    /**
+     * @param \ReflectionFunctionAbstract $method
+     */
+    protected function initPhpDoc($method)
+    {
         $this->phpdoc = new DocBlock($method);
+    }
 
-        //Normalize the description and inherit the docs from parents/interfaces
-        try {
-            $this->normalizeParams($this->phpdoc);
-            $this->normalizeReturn($this->phpdoc);
-            $this->normalizeDescription($this->phpdoc);
-        } catch (\Exception $e) {
-        }
-
-        //Get the parameters, including formatted default values
-        $this->getParameters($method);
-
-        //Make the method static
-        $this->phpdoc->appendTag(Tag::createInstance('@static', $this->phpdoc));
-
-        //Reference the 'real' function in the declaringclass
+    /**
+     * @param \ReflectionFunctionAbstract $method
+     * @param \ReflectionClass $class
+     */
+    protected function initClassDefinedProperties($method, \ReflectionClass $class)
+    {
+        $this->namespace = $class->getNamespaceName();
         $this->declaringClassName = '\\' . ltrim($class->name, '\\');
-        $this->root = '\\' . ltrim($class->getName(), '\\');
     }
 }

src/Method.php

@@ -26,29 +26,32 @@ class Method
     protected $method;
 
     protected $output = '';
+    protected $declaringClassName;
     protected $name;
     protected $namespace;
     protected $params = array();
     protected $params_with_default = array();
     protected $interfaces = array();
+    protected $real_name;
     protected $return = null;
 
     /**
-     * @param \ReflectionMethod $method
+     * @param \ReflectionMethod|\ReflectionFunctionAbstract $method
      * @param string $alias
      * @param \ReflectionClass $class
      * @param string|null $methodName
      * @param array $interfaces
      */
-    public function __construct(\ReflectionMethod $method, $alias, $class, $methodName = null, $interfaces = array())
+    public function __construct($method, $alias, $class, $methodName = null, $interfaces = array())
     {
         $this->method = $method;
         $this->interfaces = $interfaces;
         $this->name = $methodName ?: $method->name;
-        $this->namespace = $method->getDeclaringClass()->getNamespaceName();
+        $this->real_name = $method->isClosure() ? $this->name : $method->name;
+        $this->initClassDefinedProperties($method, $class);
 
         //Create a DocBlock and serializer instance
-        $this->phpdoc = new DocBlock($method, new Context($this->namespace));
+        $this->initPhpDoc($method);
 
         //Normalize the description and inherit the docs from parents/interfaces
         try {
@@ -64,12 +67,29 @@ class Method
         //Make the method static
         $this->phpdoc->appendTag(Tag::createInstance('@static', $this->phpdoc));
 
-        //Reference the 'real' function in the declaringclass
-        $declaringClass = $method->getDeclaringClass();
-        $this->declaringClassName = '\\' . ltrim($declaringClass->name, '\\');
+        //Reference the 'real' function in the declaring class
         $this->root = '\\' . ltrim($class->getName(), '\\');
     }
 
+    /**
+     * @param \ReflectionMethod $method
+     */
+    protected function initPhpDoc($method)
+    {
+        $this->phpdoc = new DocBlock($method, new Context($this->namespace));
+    }
+
+    /**
+     * @param \ReflectionMethod $method
+     * @param \ReflectionClass $class
+     */
+    protected function initClassDefinedProperties($method, \ReflectionClass $class)
+    {
+        $declaringClass = $method->getDeclaringClass();
+        $this->namespace = $declaringClass->getNamespaceName();
+        $this->declaringClassName = '\\' . ltrim($declaringClass->name, '\\');
+    }
+
     /**
      * Get the class wherein the function resides
      *
@@ -112,6 +132,16 @@ class Method
         return $this->name;
     }
 
+    /**
+     * Get the real method name
+     *
+     * @return string
+     */
+    public function getRealName()
+    {
+        return $this->real_name;
+    }
+
     /**
      * Get the parameters for this method
      *