Merge branch 'master' into feature/fix-callable-macros

src/Alias.php

@@ -10,6 +10,11 @@
 
 namespace Barryvdh\LaravelIdeHelper;
 
+use Barryvdh\Reflection\DocBlock;
+use Barryvdh\Reflection\DocBlock\Context;
+use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
+use ReflectionClass;
+
 class Alias
 {
     protected $alias;
@@ -27,6 +32,7 @@ class Alias
     protected $valid = false;
     protected $magicMethods = array();
     protected $interfaces = array();
+    protected $phpdoc = null;
 
     /**
      * @param string $alias
@@ -56,7 +62,13 @@ class Alias
         $this->detectNamespace();
         $this->detectClassType();
         $this->detectExtendsNamespace();
-        
+
+        if(!empty($this->namespace)) {
+            //Create a DocBlock and serializer instance
+            $this->phpdoc = new DocBlock(new ReflectionClass($alias), new Context($this->namespace));
+        }
+
+
         if ($facade === '\Illuminate\Database\Eloquent\Model') {
             $this->usedMethods = array('decrement', 'increment');
         }
@@ -346,6 +358,17 @@ class Alias
 
         return new \ReflectionFunction($macro_func);
     }
+  
+     * Get the docblock for this alias
+     *
+     * @param string $prefix
+     * @return mixed
+     */
+    public function getDocComment($prefix = "\t\t")
+    {
+        $serializer = new DocBlockSerializer(1, $prefix);
+        return ($this->phpdoc) ? $serializer->getDocComment($this->phpdoc) : '';
+    }
 
     /**
      * Output an error.

src/Console/EloquentCommand.php

@@ -0,0 +1,61 @@
+<?php
+/**
+ * Laravel IDE Helper Generator - Eloquent Model Mixin
+ *
+ * @author    Charles A. Peterson <[email protected]>
+ * @copyright 2017 Charles A. Peterson / 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 Barryvdh\LaravelIdeHelper\Eloquent;
+use Illuminate\Console\Command;
+use Illuminate\Filesystem\Filesystem;
+
+/**
+ * A command to add \Eloquent mixin to Eloquent\Model
+ *
+ * @author Charles A. Peterson <[email protected]>
+ */
+class EloquentCommand extends Command
+{
+    /**
+     * The console command name.
+     *
+     * @var string
+     */
+    protected $name = 'ide-helper:eloquent';
+
+    /**
+     * @var Filesystem $files
+     */
+    protected $files;
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Add \Eloquent helper to \Eloquent\Model';
+
+    /**
+     * @param Filesystem $files
+     */
+    public function __construct(Filesystem $files)
+    {
+        parent::__construct();
+        $this->files = $files;
+    }
+
+    /**
+     * Execute the console command.
+     *
+     * @return void
+     */
+    public function handle()
+    {
+        Eloquent::writeEloquentModelHelper($this, $this->files);
+    }
+}

src/Console/GeneratorCommand.php

@@ -10,8 +10,8 @@
 
 namespace Barryvdh\LaravelIdeHelper\Console;
 
+use Barryvdh\LaravelIdeHelper\Eloquent;
 use Barryvdh\LaravelIdeHelper\Generator;
-use Illuminate\Config\Repository as ConfigRepository;
 use Illuminate\Console\Command;
 use Illuminate\Filesystem\Filesystem;
 use Symfony\Component\Console\Input\InputOption;
@@ -115,6 +115,7 @@ class GeneratorCommand extends Command
 
             if ($written !== false) {
                 $this->info("A new helper file was written to $filename");
+                Eloquent::writeEloquentModelHelper($this, $this->files);
             } else {
                 $this->error("The helper file could not be created at $filename");
             }

src/Console/MetaCommand.php

@@ -28,7 +28,6 @@ class MetaCommand extends Command
      * @var string
      */
     protected $name = 'ide-helper:meta';
-    protected $filename = '.phpstorm.meta.php';
 
     /**
      * The console command description.
@@ -43,6 +42,9 @@ class MetaCommand extends Command
     /** @var \Illuminate\Contracts\View\Factory */
     protected $view;
 
+    /** @var \Illuminate\Contracts\Config */
+    protected $config;
+
     protected $methods = [
       'new \Illuminate\Contracts\Container\Container',
       '\Illuminate\Contracts\Container\Container::make(0)',
@@ -57,11 +59,13 @@ class MetaCommand extends Command
      *
      * @param \Illuminate\Contracts\Filesystem\Filesystem $files
      * @param \Illuminate\Contracts\View\Factory $view
+     * @param \Illuminate\Contracts\Config $config
      */
-    public function __construct($files, $view)
+    public function __construct($files, $view, $config)
     {
         $this->files = $files;
         $this->view = $view;
+        $this->config = $config;
         parent::__construct();
     }
 
@@ -138,8 +142,10 @@ class MetaCommand extends Command
      */
     protected function getOptions()
     {
+        $filename = $this->config->get('ide-helper.meta_filename');
+
         return array(
-            array('filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the meta file', $this->filename),
+            array('filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the meta file', $filename),
         );
     }
 }

src/Console/ModelsCommand.php

@@ -10,6 +10,7 @@
 
 namespace Barryvdh\LaravelIdeHelper\Console;
 
+use Composer\Autoload\ClassMapGenerator;
 use Illuminate\Console\Command;
 use Illuminate\Database\Eloquent\Relations\Relation;
 use Illuminate\Support\Str;
@@ -17,7 +18,6 @@ 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 Barryvdh\Reflection\DocBlock;
 use Barryvdh\Reflection\DocBlock\Context;
 use Barryvdh\Reflection\DocBlock\Tag;
@@ -145,6 +145,7 @@ class ModelsCommand extends Command
 
 
         $output = "<?php
+//@formatter:off
 /**
  * A helper file for your Eloquent Models
  * Copy the phpDocs from this file to the correct Model,
@@ -460,7 +461,8 @@ class ModelsCommand extends Command
                                'morphOne',
                                'morphTo',
                                'morphMany',
-                               'morphToMany'
+                               'morphToMany',
+                               'morphedByMany'
                              ) as $relation) {
                         $search = '$this->' . $relation . '(';
                         if ($pos = stripos($code, $search)) {
@@ -470,7 +472,14 @@ class ModelsCommand extends Command
                             if ($relationObj instanceof Relation) {
                                 $relatedModel = '\\' . get_class($relationObj->getRelated());
 
-                                $relations = ['hasManyThrough', 'belongsToMany', 'hasMany', 'morphMany', 'morphToMany'];
+                                $relations = [
+                                    'hasManyThrough',
+                                    'belongsToMany',
+                                    'hasMany',
+                                    'morphMany',
+                                    'morphToMany',
+                                    'morphedByMany',
+                                ];
                                 if (in_array($relation, $relations)) {
                                     //Collection or array of models (because Collection is Arrayable)
                                     $this->setProperty(

src/Eloquent.php

@@ -0,0 +1,78 @@
+<?php
+
+/**
+ * Laravel IDE Helper to add \Eloquent mixin to Eloquent\Model
+ *
+ * @author Charles A. Peterson <[email protected]>
+ */
+namespace Barryvdh\LaravelIdeHelper;
+
+use Illuminate\Console\Command;
+use Illuminate\Filesystem\Filesystem;
+use Barryvdh\Reflection\DocBlock;
+use Barryvdh\Reflection\DocBlock\Context;
+use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
+use Barryvdh\Reflection\DocBlock\Tag;
+
+class Eloquent
+{
+    /**
+     * Write mixin helper to the Eloquent\Model
+     * This is needed since laravel/framework v5.4.29
+     *
+     * @param Command    $command
+     * @param Filesystem $files
+     *
+     * @return void
+     */
+    public static function writeEloquentModelHelper(Command $command, Filesystem $files)
+    {
+        $class = 'Illuminate\Database\Eloquent\Model';
+
+        $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);
+
+                return;
+            }
+        }
+
+        // add the Eloquent mixin
+        $phpdoc->appendTag(Tag::createInstance("@mixin \\Eloquent", $phpdoc));
+
+        $serializer = new DocBlockSerializer();
+        $serializer->getDocComment($phpdoc);
+        $docComment = $serializer->getDocComment($phpdoc);
+
+        $filename = $reflection->getFileName();
+        if ($filename) {
+            $contents = $files->get($filename);
+            if ($contents) {
+                $count    = 0;
+                $contents = str_replace($originalDoc, $docComment, $contents, $count);
+                if ($count > 0) {
+                    if ($files->put($filename, $contents)) {
+                        $command->info('Wrote @mixin \Eloquent to ' . $filename);
+                    } else {
+                        $command->error('File write failed to ' . $filename);
+                    }
+                } else {
+                    $command->error('Content did not change ' . $contents);
+                }
+            } else {
+                $command->error('No file contents found ' . $filename);
+            }
+        } else {
+            $command->error('Filename not found ' . $class);
+        }
+    }
+}

src/IdeHelperServiceProvider.php

@@ -10,10 +10,11 @@
 
 namespace Barryvdh\LaravelIdeHelper;
 
-use Illuminate\Support\ServiceProvider;
+use Barryvdh\LaravelIdeHelper\Console\EloquentCommand;
+use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
 use Barryvdh\LaravelIdeHelper\Console\MetaCommand;
 use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
-use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
+use Illuminate\Support\ServiceProvider;
 use Illuminate\View\Engines\EngineResolver;
 use Illuminate\View\Engines\PhpEngine;
 use Illuminate\View\Factory;
@@ -38,7 +39,7 @@ class IdeHelperServiceProvider extends ServiceProvider
     {
         $viewPath = __DIR__.'/../resources/views';
         $this->loadViewsFrom($viewPath, 'ide-helper');
-        
+
         $configPath = __DIR__ . '/../config/ide-helper.php';
         if (function_exists('config_path')) {
             $publishPath = config_path('ide-helper.php');
@@ -58,7 +59,7 @@ class IdeHelperServiceProvider extends ServiceProvider
         $configPath = __DIR__ . '/../config/ide-helper.php';
         $this->mergeConfigFrom($configPath, 'ide-helper');
         $localViewFactory = $this->createLocalViewFactory();
-        
+
         $this->app->singleton(
             'command.ide-helper.generate',
             function ($app) use ($localViewFactory) {
@@ -72,15 +73,27 @@ class IdeHelperServiceProvider extends ServiceProvider
                 return new ModelsCommand($app['files']);
             }
         );
-        
+
         $this->app->singleton(
             'command.ide-helper.meta',
             function ($app) use ($localViewFactory) {
-                return new MetaCommand($app['files'], $localViewFactory);
+                return new MetaCommand($app['files'], $localViewFactory, $app['config']);
             }
         );
 
-        $this->commands('command.ide-helper.generate', 'command.ide-helper.models', 'command.ide-helper.meta');
+        $this->app->singleton(
+            'command.ide-helper.eloquent',
+            function ($app) use ($localViewFactory) {
+                return new EloquentCommand($app['files']);
+            }
+        );
+
+        $this->commands(
+            'command.ide-helper.generate',
+            'command.ide-helper.models',
+            'command.ide-helper.meta',
+            'command.ide-helper.eloquent'
+        );
     }
 
     /**