Merge pull request #707 from crhg/fix_getAliases

Fix alias class existence determination #698

.editorconfig

@@ -0,0 +1,15 @@
+; This file is for unifying the coding style for different editors and IDEs.
+; More information at http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_size = 4
+indent_style = space
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

.gitattributes

@@ -0,0 +1,10 @@
+# Path-based git attributes
+# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
+
+# Ignore all test and documentation with "export-ignore".
+/.gitattributes     export-ignore
+/.gitignore         export-ignore
+/.travis.yml        export-ignore
+/phpunit.xml.dist   export-ignore
+/.scrutinizer.yml   export-ignore
+/tests              export-ignore

.gitignore

@@ -1,3 +1,4 @@
-/vendor
+build
+vendor
 composer.lock
 .idea

.scrutinizer.yml

@@ -0,0 +1,23 @@
+filter:
+    excluded_paths: [tests/*]
+
+checks:
+    php:
+        remove_extra_empty_lines: true
+        remove_php_closing_tag: true
+        remove_trailing_whitespace: true
+        fix_use_statements:
+            remove_unused: true
+            preserve_multiple: false
+            preserve_blanklines: true
+            order_alphabetically: true
+        fix_php_opening_tag: true
+        fix_linefeed: true
+        fix_line_ending: true
+        fix_identation_4spaces: true
+        fix_doc_comments: true
+
+tools:
+    external_code_coverage:
+        timeout: 600
+        runs: 3

.styleci.yml

@@ -0,0 +1 @@
+preset: psr2

.travis.yml

@@ -0,0 +1,27 @@
+language: php
+
+php:
+  - 7.0
+  - 7.1
+  - 7.2
+
+# This triggers builds to run on the new TravisCI infrastructure.
+# See: http://docs.travis-ci.com/user/workers/container-based-infrastructure/
+sudo: false
+
+## Cache composer
+cache:
+  directories:
+    - $HOME/.composer/cache
+
+matrix:
+  include:
+    - php: 7.0
+      env: 'COMPOSER_FLAGS="--prefer-stable --prefer-lowest"'
+
+before_script:
+  - travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-dist
+
+script:
+  - vendor/bin/phpcs --standard=psr2 src/
+  - vendor/bin/phpunit

LICENSE.md

@@ -0,0 +1,21 @@
+# The MIT License (MIT)
+
+Copyright (c) Barry vd. Heuvel <barryvdh@gmail.com>
+
+> Permission is hereby granted, free of charge, to any person obtaining a copy
+> of this software and associated documentation files (the "Software"), to deal
+> in the Software without restriction, including without limitation the rights
+> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+> copies of the Software, and to permit persons to whom the Software is
+> furnished to do so, subject to the following conditions:
+>
+> The above copyright notice and this permission notice shall be included in
+> all copies or substantial portions of the Software.
+>
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+> THE SOFTWARE.

composer.json

@@ -10,14 +10,20 @@
         }
     ],
     "require": {
-        "php": ">=5.3.0",
+        "php": ">=7",
-        "illuminate/support": "4.x",
+        "illuminate/support": "^5.5,<5.8",
-        "illuminate/console": "4.x",
+        "illuminate/console": "^5.5,<5.8",
-        "illuminate/filesystem": "4.x",
+        "illuminate/filesystem": "^5.5,<5.8",
-        "phpdocumentor/reflection-docblock": "2.0.x",
+        "barryvdh/reflection-docblock": "^2.0.4",
-        "symfony/class-loader": "~2.3"
+        "composer/composer": "^1.6"
     },
     "require-dev": {
+        "illuminate/config": "^5.1,<5.8",
+        "illuminate/view": "^5.1,<5.8",
+        "phpro/grumphp": "^0.14",
+        "phpunit/phpunit" : "4.*",
+        "scrutinizer/ocular": "~1.1",
+        "squizlabs/php_codesniffer": "^3",
         "doctrine/dbal": "~2.3"
     },
     "suggest": {
@@ -28,9 +34,24 @@
             "Barryvdh\\LaravelIdeHelper\\": "src"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "Barryvdh\\LaravelIdeHelper\\": "tests"
+        }
+    },
+    "scripts": {
+        "test": "phpunit",
+        "check-style": "phpcs -p --standard=PSR2 src/",
+        "fix-style": "phpcbf -p --standard=PSR2 src/"
+    },
     "extra": {
         "branch-alias": {
-            "dev-master": "1.11-dev"
+            "dev-master": "2.5-dev"
+        },
+        "laravel": {
+            "providers": [
+                "Barryvdh\\LaravelIdeHelper\\IdeHelperServiceProvider"
+            ]
         }
     }
 }

config/ide-helper.php

@@ -0,0 +1,181 @@
+<?php
+
+return array(
+
+    /*
+    |--------------------------------------------------------------------------
+    | Filename & Format
+    |--------------------------------------------------------------------------
+    |
+    | The default filename (without extension) and the format (php or json)
+    |
+    */
+
+    'filename'  => '_ide_helper',
+    'format'    => 'php',
+    
+    'meta_filename' => '.phpstorm.meta.php',
+
+    /*
+    |--------------------------------------------------------------------------
+    | Fluent helpers
+    |--------------------------------------------------------------------------
+    |
+    | Set to true to generate commonly used Fluent methods
+    |
+    */
+
+    'include_fluent' => false,
+
+    /*
+    |--------------------------------------------------------------------------
+    | Write Model Magic methods
+    |--------------------------------------------------------------------------
+    |
+    | Set to false to disable write magic methods of model
+    |
+    */
+
+    'write_model_magic_where' => true,
+
+    /*
+    |--------------------------------------------------------------------------
+    | Helper files to include
+    |--------------------------------------------------------------------------
+    |
+    | Include helper files. By default not included, but can be toggled with the
+    | -- helpers (-H) option. Extra helper files can be included.
+    |
+    */
+
+    'include_helpers' => false,
+
+    'helper_files' => array(
+        base_path().'/vendor/laravel/framework/src/Illuminate/Support/helpers.php',
+    ),
+
+    /*
+    |--------------------------------------------------------------------------
+    | Model locations to include
+    |--------------------------------------------------------------------------
+    |
+    | Define in which directories the ide-helper:models command should look
+    | for models.
+    |
+    */
+
+    'model_locations' => array(
+        'app',
+    ),
+
+
+    /*
+    |--------------------------------------------------------------------------
+    | Extra classes
+    |--------------------------------------------------------------------------
+    |
+    | These implementations are not really extended, but called with magic functions
+    |
+    */
+
+    'extra' => array(
+        'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
+        'Session' => array('Illuminate\Session\Store'),
+    ),
+
+    'magic' => array(
+        'Log' => array(
+            'debug'     => 'Monolog\Logger::addDebug',
+            'info'      => 'Monolog\Logger::addInfo',
+            'notice'    => 'Monolog\Logger::addNotice',
+            'warning'   => 'Monolog\Logger::addWarning',
+            'error'     => 'Monolog\Logger::addError',
+            'critical'  => 'Monolog\Logger::addCritical',
+            'alert'     => 'Monolog\Logger::addAlert',
+            '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(
+
+    ),
+
+    /*
+    |--------------------------------------------------------------------------
+    | Support for custom DB types
+    |--------------------------------------------------------------------------
+    |
+    | This setting allow you to map any custom database type (that you may have
+    | created using CREATE TYPE statement or imported using database plugin
+    | / extension to a Doctrine type.
+    |
+    | Each key in this array is a name of the Doctrine2 DBAL Platform. Currently valid names are:
+    | 'postgresql', 'db2', 'drizzle', 'mysql', 'oracle', 'sqlanywhere', 'sqlite', 'mssql'
+    |
+    | This name is returned by getName() method of the specific Doctrine/DBAL/Platforms/AbstractPlatform descendant
+    |
+    | The value of the array is an array of type mappings. Key is the name of the custom type,
+    | (for example, "jsonb" from Postgres 9.4) and the value is the name of the corresponding Doctrine2 type (in
+    | our case it is 'json_array'. Doctrine types are listed here:
+    | http://doctrine-dbal.readthedocs.org/en/latest/reference/types.html
+    |
+    | So to support jsonb in your models when working with Postgres, just add the following entry to the array below:
+    |
+    | "postgresql" => array(
+    |       "jsonb" => "json_array",
+    |  ),
+    |
+    */
+    'custom_db_types' => array(
+
+    ),
+
+    /*
+     |--------------------------------------------------------------------------
+     | Support for camel cased models
+     |--------------------------------------------------------------------------
+     |
+     | There are some Laravel packages (such as Eloquence) that allow for accessing
+     | Eloquent model properties via camel case, instead of snake case.
+     |
+     | Enabling this option will support these packages by saving all model
+     | properties as camel case, instead of snake case.
+     |
+     | For example, normally you would see this:
+     |
+     |  * @property \Illuminate\Support\Carbon $created_at
+     |  * @property \Illuminate\Support\Carbon $updated_at
+     |
+     | With this enabled, the properties will be this:
+     |
+     |  * @property \Illuminate\Support\Carbon $createdAt
+     |  * @property \Illuminate\Support\Carbon $updatedAt
+     |
+     | Note, it is currently an all-or-nothing option.
+     |
+     */
+    'model_camel_case_properties' => false,
+
+    /*
+    |--------------------------------------------------------------------------
+    | Property Casts
+    |--------------------------------------------------------------------------
+    |
+    | Cast the given "real type" to the given "type".
+    |
+    */
+   'type_overrides' => array(
+        'integer' => 'int',
+        'boolean' => 'bool',
+   ),
+);

grumphp.yml

@@ -0,0 +1,15 @@
+parameters:
+    git_dir: .
+    bin_dir: vendor/bin
+    tasks:
+        phpunit:
+            config_file: ~
+            testsuite: ~
+            group: []
+            always_execute: false
+        phpcs:
+            standard: PSR2
+            warning_severity: ~
+            ignore_patterns:
+              - tests/
+            triggered_by: [php]

phpunit.xml.dist

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit bootstrap="vendor/autoload.php"
+         backupGlobals="false"
+         backupStaticAttributes="false"
+         colors="true"
+         verbose="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false">
+    <testsuites>
+        <testsuite name="Unit Tests">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory suffix=".php">src/</directory>
+        </whitelist>
+    </filter>
+</phpunit>

provides.json

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

readme.md

@@ -1,97 +1,262 @@
-## 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)
+
+[![Latest Version on Packagist][ico-version]][link-packagist]
+[![Software License][ico-license]](LICENSE.md)
+[![Build Status][ico-travis]][link-travis]
+[![Total Downloads][ico-downloads]][link-downloads]
+
+__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!_
+_Check out [this Laracasts video](https://laracasts.com/series/how-to-be-awesome-in-phpstorm/episodes/15) for a quick introduction/explanation!_
 
-This packages generates a file that your IDE can understand, so it can provide accurate autocompletion. Generation is done, based on the files in your project, so they are alway up-to-date.
+ * [`php artisan ide-helper:generate` - phpDoc generation for Laravel Facades ](#automatic-phpdoc-generation-for-laravel-facades)
-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)
+ * [`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)
 
-* Generated version: https://gist.github.com/barryvdh/5227822
+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).
 
-Note: You do need CodeIntel for Sublime Text: https://github.com/SublimeCodeIntel/SublimeCodeIntel
+* 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 CodeComplice for Sublime Text: https://github.com/spectacles/CodeComplice
+
+### Install
+
+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,
+```
+**Laravel 5.5** uses Package Auto-Discovery, so doesn't require you to manually add the ServiceProvider.
+
+To install this package on only development systems, add the `--dev` flag to your composer command:
+
+```bash
+composer require --dev barryvdh/laravel-ide-helper
+```
+
+In Laravel, instead of adding the service provider in the `config/app.php` file, you can add the following code to your `app/Providers/AppServiceProvider.php` file, within the `register()` method:
+
+```php
+public function register()
+{
+    if ($this->app->environment() !== 'production') {
+        $this->app->register(\Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class);
+    }
+    // ...
+}
+```
+
+This will allow your application to load the Laravel IDE Helper on non-production enviroments.
 
 ### 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):
+You can now re-generate the docs yourself (for future updates)
 
-    "barryvdh/laravel-ide-helper": "1.*"
+```bash
+php artisan ide-helper:generate
+```
 
-After updating composer, add the ServiceProvider to the providers array in app/config/app.php
+Note: `bootstrap/compiled.php` has to be cleared first, so run `php artisan clear-compiled` before generating.
-
-    'Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider',
-
-You can now re-generate the docs yourself (for future updates) in artisan
-
-    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:
 
-    "scripts":{
+```js
-        "post-update-cmd":[
+"scripts":{
-            "php artisan clear-compiled",
+    "post-update-cmd": [
-            "php artisan ide-helper:generate",
+        "Illuminate\\Foundation\\ComposerScripts::postUpdate",
-            "php artisan optimize",
+        "php artisan ide-helper:generate",
-        ]
+        "php artisan ide-helper:meta"
-    },
+    ]
+},
+```
 
-You can also publish the config-file to change implementations (ie. interface to specific class) or set defaults for --helpers or --sublime.
+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
+```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.
 
-Some classes need a working database connection. If you do not have a working default connection, some facades will not be included.
+Some classes need a working database connection. If you do not have a default working connection, some facades will not be included.
-You can use a in-memory sqlite driver, using the -M option.
+You can use an in-memory SQLite driver by adding 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.
+You can choose to include helper files. This is not enabled by default, but you can override it 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.
+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
+
+> You need to require `doctrine/dbal: ~2.3` in your own composer.json to get database columns.
 
 
-### Automatic phpDocs for Models
+```bash
+composer require doctrine/dbal
+```
 
-> **Note:** Since v1.10 you need to require `doctrine/dbal: ~2.3` in your own composer.json. 
+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)`.
-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)`).
 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, only the newly found columns/relations are saved as phpdocs.
+With the `--reset (-R)` option, the existing phpdocs are ignored, and only the newly found columns/relations are saved as phpdocs.
 
-    php artisan ide-helper:models Post
+```bash
+php artisan ide-helper:models Post
+```
 
-    /**
+```php
-     * An Eloquent Model: 'Post'
+/**
-     *
+ * An Eloquent Model: 'Post'
-     * @property integer $id
+ *
-     * @property integer $author_id
+ * @property integer $id
-     * @property string $title
+ * @property integer $author_id
-     * @property string $text
+ * @property string $title
-     * @property \Carbon\Carbon $created_at
+ * @property string $text
-     * @property \Carbon\Carbon $updated_at
+ * @property \Illuminate\Support\Carbon $created_at
-     * @property-read \User $author
+ * @property \Illuminate\Support\Carbon $updated_at
-     * @property-read \Illuminate\Database\Eloquent\Collection|\Comment[] $comments
+ * @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).
+By default, models in `app/models` are scanned. The optional argument tells what models to use (also outside app/models).
 
-    php artisan ide-helper:models Post User
+```bash
+php artisan ide-helper:models Post User
+```
 
-You can also scan a different directory, using the --dir option (relative from the base path):
+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"
+```bash
-   
+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.
+```
 
-Models can be ignored using the --ignore (-I) option
+You can publish the config file (`php artisan vendor:publish`) and set the default directories.
 
-    php artisan ide-helper:models --ignore="Post,User"
+Models can be ignored using the `--ignore (-I)` option
 
-Note: With namespaces, wrap your model name in " signs: `php artisan ide-helper:models "API\User"`, or escape the slashes (`Api\\User`)
+```bash
+php artisan ide-helper:models --ignore="Post,User"
+```
+
+Note: With namespaces, wrap your model name in double-quotes (`"`): `php artisan ide-helper:models "API\User"`, or escape the slashes (`Api\\User`)
+
+For properly recognition of `Model` methods (i.e. `paginate`, `findOrFail`) you should extend `\Eloquent` or add
+```php
+/** @mixin \Eloquent */
+```
+for your model class.
+
+### Automatic phpDocs generation for Laravel Fluent methods
+If you need phpDocs support for Fluent methods in migration, for example
+```php
+$table->string("somestring")->nullable()->index();
+```
+After publishing vendor, simply change the `include_fluent` line your `config/ide-helper.php` file into:
+```php
+'include_fluent' => true,
+```
+And then run `php artisan ide-helper:generate` , you will now see all of the Fluent methods are recognized by your IDE.
+
+
+## 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).
+
+## Lumen Install
+
+This package is focused on Laravel development, but it can also be used in Lumen with some workarounds. Because Lumen works a little different, as it is like a barebone version of Laravel and the main configuration parameters are instead located in `bootstrap/app.php`, some alterations must be made.
+
+#### Enabling Facades
+
+While Laravel IDE Helper can generate automatically default Facades for code hinting, Lumen doesn't come with Facades activated. If you plan in using them, you must enable them under the `Create The Application` section, uncommenting this line:
+
+```php
+// $app->withFacades();
+```
+
+From there, you should be able to use the `create_alias()` function to add additional Facades into your application.
+
+#### Adding the Service Provider
+
+You can install Laravel IDE Helper in `app/Providers/AppServiceProvider.php`, and uncommenting this line that registers the App Service Providers so it can properly load.
+
+```php
+// $app->register(App\Providers\AppServiceProvider::class);
+```
+
+If you are not using that line, that is usually handy to manage gracefully multiple Laravel/Lumen installations, you will have to add this line of code under the `Register Service Providers` section of your `bootstrap/app.php`.
+
+```php
+if ($app->environment() !== 'production') {
+    $app->register(\Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class);
+}
+```
+
+After that, Laravel IDE Helper should work correctly. During the generation process, the script may throw exceptions saying that some Class(s) doesn't exist or there are some undefined indexes. This is normal, as Lumen has some default packages stripped away, like Cookies, Storage and Session. If you plan to add these packages, you will have to add them manually and create additional Facades if needed.
+
+#### Adding Additional Facades
+
+Currently Lumen IDE Helper doesn't take into account additional Facades created under `bootstrap/app.php` using `create_alias()`, so you need to create a `config/app.php` file and add your custom aliases under an `aliases` array again, like so:
+
+```php
+return [
+    'aliases' => [
+        'CustomAliasOne' => Example\Support\Facades\CustomAliasOne::class,
+        'CustomAliasTwo' => Example\Support\Facades\CustomAliasTwo::class,
+        //...
+    ]
+];
+```
+
+After you run ```php artisan ide-helper:generate```, it's recommended (but not mandatory) to rename `config/app.php` to something else until you have to re-generate the docs or after passing to production enviroment. Lumen 5.1+ will read this file for configuration parameters if it is present, and may overlap some configurations if it is completely populated.
 
 ### License
 
 The Laravel IDE Helper Generator is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)
+
+
+[ico-version]: https://img.shields.io/packagist/v/barryvdh/laravel-ide-helper.svg?style=flat-square
+[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
+[ico-travis]: https://img.shields.io/travis/barryvdh/laravel-ide-helper/master.svg?style=flat-square
+[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/barryvdh/laravel-ide-helper.svg?style=flat-square
+[ico-code-quality]: https://img.shields.io/scrutinizer/g/barryvdh/laravel-ide-helper.svg?style=flat-square
+[ico-downloads]: https://img.shields.io/packagist/dt/barryvdh/laravel-ide-helper.svg?style=flat-square
+
+[link-packagist]: https://packagist.org/packages/barryvdh/laravel-ide-helper
+[link-travis]: https://travis-ci.org/barryvdh/laravel-ide-helper
+[link-scrutinizer]: https://scrutinizer-ci.com/g/barryvdh/laravel-ide-helper/code-structure
+[link-code-quality]: https://scrutinizer-ci.com/g/barryvdh/laravel-ide-helper
+[link-downloads]: https://packagist.org/packages/barryvdh/laravel-ide-helper
+[link-author]: https://github.com/barryvdh
+[link-contributors]: ../../contributors

resources/views/helper.php

@@ -0,0 +1,101 @@
+<?= '<?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
+
+/**
+ * A helper file for Laravel 5, to provide autocomplete information to your IDE
+ * Generated for Laravel <?= $version ?> on <?= date("Y-m-d H:i:s") ?>.
+ *
+ * This file should not be included in your code, only analyzed by your IDE!
+ *
+ * @author Barry vd. Heuvel <[email protected]>
+ * @see https://github.com/barryvdh/laravel-ide-helper
+ */
+
+<?php foreach($namespaces_by_extends_ns as $namespace => $aliases): ?>
+<?php if ($namespace == '\Illuminate\Database\Eloquent'): continue; endif; ?>
+namespace <?= $namespace == '__root' ? '' : trim($namespace, '\\') ?> { 
+<?php foreach($aliases as $alias): ?>
+
+    <?= trim($alias->getDocComment('    ')) ?> 
+    <?= $alias->getClassType() ?> <?= $alias->getExtendsClass() ?> {
+        <?php foreach($alias->getMethods() as $method): ?>
+
+        <?= trim($method->getDocComment('        ')) ?> 
+        public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>)
+        {<?php if($method->getDeclaringClass() !== $method->getRoot()): ?>
+
+            //Method inherited from <?= $method->getDeclaringClass() ?>
+            <?php endif; ?>
+
+            <?= $method->shouldReturn() ? 'return ': '' ?><?= $method->getRoot() ?>::<?= $method->getRealName() ?>(<?= $method->getParams() ?>);
+        }
+        <?php endforeach; ?> 
+    }
+<?php endforeach; ?> 
+}
+
+<?php endforeach; ?>
+
+<?php foreach($namespaces_by_alias_ns as $namespace => $aliases): ?>
+namespace <?= $namespace == '__root' ? '' : trim($namespace, '\\') ?> { 
+<?php foreach($aliases as $alias): ?>
+
+    <?= $alias->getClassType() ?> <?= $alias->getShortName() ?> extends <?= $alias->getExtends() ?> {<?php if ($alias->getExtendsNamespace() == '\Illuminate\Database\Eloquent'): ?>
+        <?php foreach($alias->getMethods() as $method): ?> 
+            <?= trim($method->getDocComment('            ')) ?> 
+            public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>)
+            {<?php if($method->getDeclaringClass() !== $method->getRoot()): ?>
+    
+                //Method inherited from <?= $method->getDeclaringClass() ?>
+                <?php endif; ?>
+    
+                <?= $method->shouldReturn() ? 'return ': '' ?><?= $method->getRoot() ?>::<?= $method->getRealName() ?>(<?= $method->getParams() ?>);
+            }
+        <?php endforeach; ?>
+<?php endif; ?>}
+<?php endforeach; ?> 
+}
+
+<?php endforeach; ?>
+
+<?php if($helpers): ?>
+namespace {
+<?= $helpers ?> 
+}
+<?php endif; ?>
+
+<?php if($include_fluent): ?>
+namespace Illuminate\Support {
+    /**
+     * Methods commonly used in migrations
+     *
+     * @method Fluent after(string $column) Add the after modifier
+     * @method Fluent charset(string $charset) Add the character set modifier
+     * @method Fluent collation(string $collation) Add the collation modifier
+     * @method Fluent comment(string $comment) Add comment
+     * @method Fluent default($value) Add the default modifier
+     * @method Fluent first() Select first row
+     * @method Fluent index(string $name = null) Add the in dex clause
+     * @method Fluent on(string $table) `on` of a foreign key
+     * @method Fluent onDelete(string $action) `on delete` of a foreign key
+     * @method Fluent onUpdate(string $action) `on update` of a foreign key
+     * @method Fluent primary() Add the primary key modifier
+     * @method Fluent references(string $column) `references` of a foreign key
+     * @method Fluent nullable(bool $value = true) Add the nullable modifier
+     * @method Fluent unique(string $name = null) Add unique index clause
+     * @method Fluent unsigned() Add the unsigned modifier
+     * @method Fluent useCurrent() Add the default timestamp value
+     * @method Fluent change() Add the change modifier
+     */
+    class Fluent {}
+}
+<?php endif ?>

resources/views/meta.php

@@ -0,0 +1,53 @@
+<?= '<?php' ?>
+
+// @formatter:off
+
+namespace PHPSTORM_META {
+
+   /**
+    * PhpStorm Meta file, to provide autocomplete information for PhpStorm
+    * Generated on <?= date("Y-m-d H:i:s") ?>.
+    *
+    * @author Barry vd. Heuvel <[email protected]>
+    * @see https://github.com/barryvdh/laravel-ide-helper
+    */
+<?php foreach ($methods as $method): ?>
+    override(<?= $method ?>, map([
+        '' => '@',
+<?php foreach($bindings as $abstract => $class): ?>
+        '<?= $abstract ?>' => \<?= $class ?>::class,
+<?php endforeach; ?>
+    ]));
+<?php endforeach; ?>
+
+    override(\Illuminate\Support\Arr::add(0), type(0));
+    override(\Illuminate\Support\Arr::except(0), type(0));
+    override(\Illuminate\Support\Arr::first(0), elementType(0));
+    override(\Illuminate\Support\Arr::last(0), elementType(0));
+    override(\Illuminate\Support\Arr::get(0), elementType(0));
+    override(\Illuminate\Support\Arr::only(0), type(0));
+    override(\Illuminate\Support\Arr::prepend(0), type(0));
+    override(\Illuminate\Support\Arr::pull(0), elementType(0));
+    override(\Illuminate\Support\Arr::set(0), type(0));
+    override(\Illuminate\Support\Arr::shuffle(0), type(0));
+    override(\Illuminate\Support\Arr::sort(0), type(0));
+    override(\Illuminate\Support\Arr::sortRecursive(0), type(0));
+    override(\Illuminate\Support\Arr::where(0), type(0));
+    override(\array_add(0), type(0));
+    override(\array_except(0), type(0));
+    override(\array_first(0), elementType(0));
+    override(\array_last(0), elementType(0));
+    override(\array_get(0), elementType(0));
+    override(\array_only(0), type(0));
+    override(\array_prepend(0), type(0));
+    override(\array_pull(0), elementType(0));
+    override(\array_set(0), type(0));
+    override(\array_sort(0), type(0));
+    override(\array_sort_recursive(0), type(0));
+    override(\array_where(0), type(0));
+    override(\head(0), elementType(0));
+    override(\last(0), elementType(0));
+    override(\with(0), type(0));
+    override(\tap(0), type(0));
+
+}

src/Alias.php

@@ -1,284 +1,414 @@
-<?php
+<?php
-/**
+/**
- * Laravel IDE Helper Generator
+ * Laravel IDE Helper Generator
- *
+ *
- * @author    Barry vd. Heuvel <[email protected]>
+ * @author    Barry vd. Heuvel <[email protected]>
- * @copyright 2014 Barry vd. Heuvel / Fruitcake Studio (http://www.fruitcakestudio.nl)
+ * @copyright 2014 Barry vd. Heuvel / Fruitcake Studio (http://www.fruitcakestudio.nl)
- * @license   http://www.opensource.org/licenses/mit-license.php MIT
+ * @license   http://www.opensource.org/licenses/mit-license.php MIT
- * @link      https://github.com/barryvdh/laravel-ide-helper
+ * @link      https://github.com/barryvdh/laravel-ide-helper
- */
+ */
-
+
-namespace Barryvdh\LaravelIdeHelper;
+namespace Barryvdh\LaravelIdeHelper;
-
+
-class Alias
+use Barryvdh\Reflection\DocBlock;
-{
+use Barryvdh\Reflection\DocBlock\Context;
-    protected $alias;
+use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
-    protected $facade;
+use ReflectionClass;
-    protected $extends = null;
+
-    protected $classType = 'class';
+class Alias
-    protected $short;
+{
-    protected $namespace = '__root';
+    protected $alias;
-    protected $root = null;
+    protected $facade;
-    protected $classes = array();
+    protected $extends = null;
-    protected $methods = array();
+    protected $extendsClass = null;
-    protected $usedMethods = array();
+    protected $extendsNamespace = null;
-    protected $valid = false;
+    protected $classType = 'class';
-    protected $magicMethods = array();
+    protected $short;
-    protected $interfaces = array();
+    protected $namespace = '__root';
-
+    protected $root = null;
-    /**
+    protected $classes = array();
-     * @param string $alias
+    protected $methods = array();
-     * @param string $facade
+    protected $usedMethods = array();
-     * @param array $magicMethods
+    protected $valid = false;
-     * @param array $interfaces
+    protected $magicMethods = array();
-     */
+    protected $interfaces = array();
-    public function __construct($alias, $facade, $magicMethods = array(), $interfaces = array())
+    protected $phpdoc = null;
-    {
+
-        $this->alias = $alias;
+    /**
-        $this->magicMethods = $magicMethods;
+     * @param string $alias
-        $this->interfaces = $interfaces;
+     * @param string $facade
-
+     * @param array $magicMethods
-        // Make the class absolute
+     * @param array $interfaces
-        $facade = '\\' . ltrim($facade, '\\');
+     */
-        $this->facade = $facade;
+    public function __construct($alias, $facade, $magicMethods = array(), $interfaces = array())
-
+    {
-        $this->detectRoot();
+        $this->alias = $alias;
-
+        $this->magicMethods = $magicMethods;
-        if ((!$this->isTrait() && $this->root)) {
+        $this->interfaces = $interfaces;
-            $this->valid = true;
+
-        } else {
+        // Make the class absolute
-            return;
+        $facade = '\\' . ltrim($facade, '\\');
-        }
+        $this->facade = $facade;
-
+
-        $this->addClass($this->root);
+        $this->detectRoot();
-        $this->detectNamespace();
+
-        $this->detectClassType();
+        if ((!$this->isTrait() && $this->root)) {
-        
+            $this->valid = true;
-        if($facade === '\Illuminate\Database\Eloquent\Model'){
+        } else {
-            $this->usedMethods = array('decrement', 'increment');
+            return;
-        }
+        }
-    }
+
-
+        $this->addClass($this->root);
-    /**
+        $this->detectFake();
-     * Add one or more classes to analyze
+        $this->detectNamespace();
-     *
+        $this->detectClassType();
-     * @param array|string $classes
+        $this->detectExtendsNamespace();
-     */
+
-    public function addClass($classes)
+        if (!empty($this->namespace)) {
-    {
+            //Create a DocBlock and serializer instance
-        $classes = (array)$classes;
+            $this->phpdoc = new DocBlock(new ReflectionClass($alias), new Context($this->namespace));
-        foreach ($classes as $class) {
+        }
-            if (class_exists($class) || interface_exists($class)) {
+
-                $this->classes[] = $class;
+
-            }else{
+        if ($facade === '\Illuminate\Database\Eloquent\Model') {
-                echo "Class not exists: $class\r\n";
+            $this->usedMethods = array('decrement', 'increment');
-            }
+        }
-        }
+    }
-    }
+
-
+    /**
-    /**
+     * Add one or more classes to analyze
-     * Check if this class is valid to process.
+     *
-     * @return bool
+     * @param array|string $classes
-     */
+     */
-    public function isValid()
+    public function addClass($classes)
-    {
+    {
-        return $this->valid;
+        $classes = (array)$classes;
-    }
+        foreach ($classes as $class) {
-
+            if (class_exists($class) || interface_exists($class)) {
-    /**
+                $this->classes[] = $class;
-     * Get the classtype, 'interface' or 'class'
+            } else {
-     *
+                echo "Class not exists: $class\r\n";
-     * @return string
+            }
-     */
+        }
-    public function getClasstype()
+    }
-    {
+
-        return $this->classType;
+    /**
-    }
+     * Check if this class is valid to process.
-
+     * @return bool
-    /**
+     */
-     * Get the class which this alias extends
+    public function isValid()
-     *
+    {
-     * @return null|string
+        return $this->valid;
-     */
+    }
-    public function getExtends()
+
-    {
+    /**
-        return $this->extends;
+     * Get the classtype, 'interface' or 'class'
-    }
+     *
-
+     * @return string
-    /**
+     */
-     * Get the Alias by which this class is called
+    public function getClasstype()
-     *
+    {
-     * @return string
+        return $this->classType;
-     */
+    }
-    public function getAlias()
+
-    {
+    /**
-        return $this->alias;
+     * Get the class which this alias extends
-    }
+     *
-
+     * @return null|string
-    /**
+     */
-     * Return the short name (without namespace)
+    public function getExtends()
-     */
+    {
-    public function getShortName(){
+        return $this->extends;
-        return $this->short;
+    }
-    }
+
-    /**
+    /**
-     * Get the namespace from the alias
+     * Get the class short name which this alias extends
-     *
+     *
-     * @return string
+     * @return null|string
-     */
+     */
-    public function getNamespace()
+    public function getExtendsClass()
-    {
+    {
-        return $this->namespace;
+        return $this->extendsClass;
-    }
+    }
-
+
-    /**
+    /**
-     * Get the methods found by this Alias
+     * Get the namespace of the class which this alias extends
-     *
+     *
-     * @return array
+     * @return null|string
-     */
+     */
-    public function getMethods()
+    public function getExtendsNamespace()
-    {
+    {
-        $this->addMagicMethods();
+        return $this->extendsNamespace;
-        $this->detectMethods();
+    }
-        return $this->methods;
+
-    }
+    /**
-
+     * Get the Alias by which this class is called
-    /**
+     *
-     * Detect the namespace
+     * @return string
-     */
+     */
-    protected function detectNamespace()
+    public function getAlias()
-    {
+    {
-        if (strpos($this->alias, '\\')) {
+        return $this->alias;
-            $nsParts = explode('\\', $this->alias);
+    }
-            $this->short = array_pop($nsParts);
+
-            $this->namespace = implode('\\', $nsParts);
+    /**
-        }else{
+     * Return the short name (without namespace)
-            $this->short = $this->alias;
+     */
-        }
+    public function getShortName()
-    }
+    {
-
+        return $this->short;
-    /**
+    }
-     * Detect the class type
+    /**
-     */
+     * Get the namespace from the alias
-    protected function detectClassType()
+     *
-    {
+     * @return string
-        //Some classes extend the facade
+     */
-        if (interface_exists($this->facade)) {
+    public function getNamespace()
-            $this->classType = 'interface';
+    {
-            $this->extends = $this->facade;
+        return $this->namespace;
-        } else {
+    }
-            $this->classType = 'class';
+
-            if (class_exists($this->facade)) {
+    /**
-                $this->extends = $this->facade;
+     * Get the methods found by this Alias
-            }
+     *
-        }
+     * @return array|Method[]
-    }
+     */
-
+    public function getMethods()
-    /**
+    {
-     * Get the real root of a facade
+        $this->addMagicMethods();
-     *
+        $this->detectMethods();
-     * @return bool|string
+        return $this->methods;
-     */
+    }
-    protected function detectRoot()
+
-    {
+    /**
-        $facade = $this->facade;
+     * Detect class returned by ::fake()
-
+     */
-        try {
+    protected function detectFake()
-            //If possible, get the facade root
+    {
-            if (method_exists($facade, 'getFacadeRoot')) {
+        $facade = $this->facade;
-                $root = get_class($facade::getFacadeRoot());
+        
-            } else {
+        if (!method_exists($facade, 'fake')) {
-                $root = $facade;
+            return;
-            }
+        }
-
+
-            //If it doesn't exist, skip it
+        $real = $facade::getFacadeRoot();
-            if (!class_exists($root) && !interface_exists($root)) {
+        
-                return;
+        try {
-            }
+            $facade::fake();
-
+            $fake = $facade::getFacadeRoot();
-            $this->root = $root;
+            if ($fake !== $real) {
-
+                $this->addClass(get_class($fake));
-            //When the database connection is not set, some classes will be skipped
+            }
-        } catch (\PDOException $e) {
+        } finally {
-            $this->error(
+            $facade::swap($real);
-                "PDOException: " . $e->getMessage() . "\nPlease configure your database connection correctly, or use the sqlite memory driver (-M). Skipping $facade."
+        }
-            );
+    }
-        } catch (\Exception $e) {
+
-            $this->error("Exception: " . $e->getMessage() . "\nSkipping $facade.");
+    /**
-        }
+     * Detect the namespace
-    }
+     */
-
+    protected function detectNamespace()
-    /**
+    {
-     * Detect if this class is a trait or not.
+        if (strpos($this->alias, '\\')) {
-     *
+            $nsParts = explode('\\', $this->alias);
-     * @return bool
+            $this->short = array_pop($nsParts);
-     */
+            $this->namespace = implode('\\', $nsParts);
-    protected function isTrait()
+        } else {
-    {
+            $this->short = $this->alias;
-        // Check if the facade is not a Trait
+        }
-        if (function_exists('trait_exists') && trait_exists($this->facade)) {
+    }
-            return true;
+
-        }
+    /**
-        return false;
+     * Detect the extends namespace
-    }
+     */
-
+    protected function detectExtendsNamespace()
-    /**
+    {
-     * Add magic methods, as defined in the configuration files
+        if (strpos($this->extends, '\\') !== false) {
-     */
+            $nsParts = explode('\\', $this->extends);
-    protected function addMagicMethods()
+            $this->extendsClass = array_pop($nsParts);
-    {
+            $this->extendsNamespace = implode('\\', $nsParts);
-        foreach($this->magicMethods as $magic => $real){
+        }
-            list($className, $name) = explode('::', $real);
+    }
-            if(!class_exists($className) && !interface_exists($className)){
+
-                continue;
+    /**
-            }
+     * Detect the class type
-            $method = new \ReflectionMethod($className, $name);
+     */
-            $class = new \ReflectionClass($className);
+    protected function detectClassType()
-
+    {
-            if(!in_array($method->name, $this->usedMethods)){
+        //Some classes extend the facade
-                if($class !== $this->root){
+        if (interface_exists($this->facade)) {
-                    $this->methods[] = new Method($method, $this->alias, $class, $magic, $this->interfaces);
+            $this->classType = 'interface';
-                }
+            $this->extends = $this->facade;
-                $this->usedMethods[] = $magic;
+        } else {
-            }
+            $this->classType = 'class';
-        }
+            if (class_exists($this->facade)) {
-    }
+                $this->extends = $this->facade;
-
+            }
-    /**
+        }
-     * Get the methods for one or multiple classes.
+    }
-     *
+
-     * @return string
+    /**
-     */
+     * Get the real root of a facade
-    protected function detectMethods()
+     *
-    {
+     * @return bool|string
-
+     */
-        foreach ($this->classes as $class) {
+    protected function detectRoot()
-            $reflection = new \ReflectionClass($class);
+    {
-
+        $facade = $this->facade;
-            $methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
+
-            if ($methods) {
+        try {
-                foreach ($methods as $method) {
+            //If possible, get the facade root
-                    if (!in_array($method->name, $this->usedMethods)) {
+            if (method_exists($facade, 'getFacadeRoot')) {
-                        // Only add the methods to the output when the root is not the same as the class.
+                $root = get_class($facade::getFacadeRoot());
-                        // And don't add the __*() methods
+            } else {
-                        if ($this->extends !== $class && substr($method->name, 0, 2) !== '__') {
+                $root = $facade;
-                            $this->methods[] = new Method($method, $this->alias, $reflection, $method->name, $this->interfaces);
+            }
-                        }
+
-                        $this->usedMethods[] = $method->name;
+            //If it doesn't exist, skip it
-                    }
+            if (!class_exists($root) && !interface_exists($root)) {
-                }
+                return;
-            }
+            }
-        }
+
-    }
+            $this->root = $root;
-
+
-    /**
+            //When the database connection is not set, some classes will be skipped
-     * Output an error.
+        } catch (\PDOException $e) {
-     *
+            $this->error(
-     * @param  string  $string
+                "PDOException: " . $e->getMessage() .
-     * @return void
+                "\nPlease configure your database connection correctly, or use the sqlite memory driver (-M)." .
-     */
+                " Skipping $facade."
-    protected function error($string)
+            );
-    {
+        } catch (\Exception $e) {
-        echo $string . "\r\n";
+            $this->error("Exception: " . $e->getMessage() . "\nSkipping $facade.");
-    }
+        }
-}
+    }
+
+    /**
+     * Detect if this class is a trait or not.
+     *
+     * @return bool
+     */
+    protected function isTrait()
+    {
+        // Check if the facade is not a Trait
+        if (function_exists('trait_exists') && trait_exists($this->facade)) {
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * Add magic methods, as defined in the configuration files
+     */
+    protected function addMagicMethods()
+    {
+        foreach ($this->magicMethods as $magic => $real) {
+            list($className, $name) = explode('::', $real);
+            if (!class_exists($className) && !interface_exists($className)) {
+                continue;
+            }
+            $method = new \ReflectionMethod($className, $name);
+            $class = new \ReflectionClass($className);
+
+            if (!in_array($magic, $this->usedMethods)) {
+                if ($class !== $this->root) {
+                    $this->methods[] = new Method($method, $this->alias, $class, $magic, $this->interfaces);
+                }
+                $this->usedMethods[] = $magic;
+            }
+        }
+    }
+
+    /**
+     * Get the methods for one or multiple classes.
+     *
+     * @return string
+     */
+    protected function detectMethods()
+    {
+
+        foreach ($this->classes as $class) {
+            $reflection = new \ReflectionClass($class);
+
+            $methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
+            if ($methods) {
+                foreach ($methods as $method) {
+                    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 && substr($method->name, 0, 2) !== '__') {
+                            $this->methods[] = new Method(
+                                $method,
+                                $this->alias,
+                                $reflection,
+                                $method->name,
+                                $this->interfaces
+                            );
+                        }
+                        $this->usedMethods[] = $method->name;
+                    }
+                }
+            }
+
+            // Check if the class is macroable
+            $traits = collect($reflection->getTraitNames());
+            if ($traits->contains('Illuminate\Support\Traits\Macroable')) {
+                $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
+                    );
+                }
+            }
+        }
+    }
+
+    /**
+     * @param $macro_func
+     *
+     * @return \ReflectionFunctionAbstract
+     * @throws \ReflectionException
+     */
+    protected function getMacroFunction($macro_func)
+    {
+        if (is_array($macro_func) && is_callable($macro_func)) {
+            return new \ReflectionMethod($macro_func[0], $macro_func[1]);
+        }
+
+        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);
+
+        if ($this->phpdoc) {
+            return $serializer->getDocComment($this->phpdoc);
+        }
+        
+        return '';
+    }
+
+    /**
+     * Output an error.
+     *
+     * @param  string  $string
+     * @return void
+     */
+    protected function error($string)
+    {
+        echo $string . "\r\n";
+    }
+}

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,14 +10,13 @@
 
 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;
 use Symfony\Component\Console\Input\InputArgument;
 
-
 /**
  * A command to generate autocomplete information for your IDE
  *
@@ -59,8 +58,9 @@ class GeneratorCommand extends Command
      * @param \Illuminate\View\Factory $view
      */
     public function __construct(
-        ConfigRepository $config,
+        /*ConfigRepository */ $config,
-        Filesystem $files, /* Illuminate\View\Factory */
+        Filesystem $files,
+        /* Illuminate\View\Factory */
         $view
     ) {
         $this->config = $config;
@@ -74,11 +74,13 @@ class GeneratorCommand extends Command
      *
      * @return void
      */
-    public function fire()
+    public function handle()
     {
-        if (file_exists($compiled = base_path() . '/bootstrap/compiled.php')) {
+        if (file_exists(base_path() . '/vendor/compiled.php') ||
+            file_exists(base_path() . '/bootstrap/cache/compiled.php') ||
+            file_exists(base_path() . '/storage/framework/compiled.php')) {
             $this->error(
-                'Error generating IDE Helper: first delete bootstrap/compiled.php (php artisan clear-compiled)'
+                'Error generating IDE Helper: first delete your compiled file (php artisan clear-compiled)'
             );
         } else {
             $filename = $this->argument('filename');
@@ -97,8 +99,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 +141,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 +157,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),
@@ -164,5 +166,4 @@ class GeneratorCommand extends Command
             array('sublime', "S", InputOption::VALUE_NONE, 'DEPRECATED: Use different style for SublimeText CodeIntel'),
         );
     }
-
 }

src/Console/MetaCommand.php

@@ -0,0 +1,155 @@
+<?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;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * 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';
+
+    /**
+     * 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;
+
+    /** @var \Illuminate\Contracts\Config */
+    protected $config;
+
+    protected $methods = [
+      'new \Illuminate\Contracts\Container\Container',
+      '\Illuminate\Contracts\Container\Container::make(0)',
+      '\Illuminate\Contracts\Container\Container::makeWith(0)',
+      '\App::make(0)',
+      '\App::makeWith(0)',
+      '\app(0)',
+      '\resolve(0)',
+    ];
+
+    /**
+     *
+     * @param \Illuminate\Contracts\Filesystem\Filesystem $files
+     * @param \Illuminate\Contracts\View\Factory $view
+     * @param \Illuminate\Contracts\Config $config
+     */
+    public function __construct($files, $view, $config)
+    {
+        $this->files = $files;
+        $this->view = $view;
+        $this->config = $config;
+        parent::__construct();
+    }
+
+    /**
+     * Execute the console command.
+     *
+     * @return void
+     */
+    public function handle()
+    {
+        $this->registerClassAutoloadExceptions();
+
+        $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('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 list of abstracts from the Laravel Application.
+     *
+     * @return array
+     */
+    protected function getAbstracts()
+    {
+        $abstracts = $this->laravel->getBindings();
+
+        // Return the abstract names only
+        $keys = array_keys($abstracts);
+
+        sort($keys);
+
+        return $keys;
+    }
+
+    /**
+     * Register an autoloader the throws exceptions when a class is not found.
+     */
+    protected function registerClassAutoloadExceptions()
+    {
+        spl_autoload_register(function ($class) {
+            throw new \Exception("Class '$class' not found.");
+        });
+    }
+
+    /**
+     * Get the console command options.
+     *
+     * @return array
+     */
+    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', $filename),
+        );
+    }
+}

src/Console/ModelsCommand.php

@@ -10,15 +10,19 @@
 
 namespace Barryvdh\LaravelIdeHelper\Console;
 
+use Composer\Autoload\ClassMapGenerator;
 use Illuminate\Console\Command;
+use Illuminate\Database\Eloquent\Relations\Relation;
 use Illuminate\Support\Str;
+use Illuminate\Filesystem\Filesystem;
+use ReflectionClass;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Input\InputArgument;
-use Symfony\Component\ClassLoader\ClassMapGenerator;
+use Symfony\Component\Console\Output\OutputInterface;
-use phpDocumentor\Reflection\DocBlock;
+use Barryvdh\Reflection\DocBlock;
-use phpDocumentor\Reflection\DocBlock\Context;
+use Barryvdh\Reflection\DocBlock\Context;
-use phpDocumentor\Reflection\DocBlock\Tag;
+use Barryvdh\Reflection\DocBlock\Tag;
-use phpDocumentor\Reflection\DocBlock\Serializer as DocBlockSerializer;
+use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
 
 /**
  * A command to generate autocomplete information for your IDE
@@ -27,6 +31,10 @@ use phpDocumentor\Reflection\DocBlock\Serializer as DocBlockSerializer;
  */
 class ModelsCommand extends Command
 {
+    /**
+     * @var Filesystem $files
+     */
+    protected $files;
 
     /**
      * The console command name.
@@ -43,34 +51,52 @@ class ModelsCommand extends Command
      */
     protected $description = 'Generate autocompletion for models';
 
+    protected $write_model_magic_where;
     protected $properties = array();
     protected $methods = array();
     protected $write = false;
     protected $dirs = array();
     protected $reset;
+    protected $keep_text;
+    /**
+     * @var bool[string]
+     */
+    protected $nullableColumns = [];
 
+    /**
+     * @param Filesystem $files
+     */
+    public function __construct(Filesystem $files)
+    {
+        parent::__construct();
+        $this->files = $files;
+    }
 
     /**
      * Execute the console command.
      *
      * @return void
      */
-    public function fire()
+    public function handle()
     {
         $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');
         $ignore = $this->option('ignore');
         $this->reset = $this->option('reset');
+        if ($this->option('smart-reset')) {
+            $this->keep_text = $this->reset = true;
+        }
+        $this->write_model_magic_where = $this->laravel['config']->get('ide-helper.write_model_magic_where', true);
 
         //If filename is default and Write is not specified, ask what to do
         if (!$this->write && $filename === $this->filename && !$this->option('nowrite')) {
             if ($this->confirm(
-                "Do you want to overwrite the existing model files? Choose no to write to $filename instead? (Yes/No): "
+                "Do you want to overwrite the existing model files? Choose no to write to $filename instead?"
             )
             ) {
                 $this->write = true;
@@ -80,7 +106,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 {
@@ -98,7 +124,7 @@ class ModelsCommand extends Command
     protected function getArguments()
     {
         return array(
-            array('model', InputArgument::OPTIONAL | InputArgument::IS_ARRAY, 'Which models to include', array()),
+          array('model', InputArgument::OPTIONAL | InputArgument::IS_ARRAY, 'Which models to include', array()),
         );
     }
 
@@ -110,12 +136,13 @@ class ModelsCommand extends Command
     protected function getOptions()
     {
         return array(
-            array('filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the helper file', $this->filename),
+          array('filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the helper file', $this->filename),
-            array('dir', 'D', InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY, 'The model dir', array()),
+          array('dir', 'D', InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY, 'The model dir', array()),
-            array('write', 'W', InputOption::VALUE_NONE, 'Write to Model file'),
+          array('write', 'W', InputOption::VALUE_NONE, 'Write to Model file'),
-            array('nowrite', 'N', InputOption::VALUE_NONE, 'Don\'t write to Model file'),
+          array('nowrite', 'N', InputOption::VALUE_NONE, 'Don\'t write to Model file'),
-            array('reset', 'R', InputOption::VALUE_NONE, 'Remove the original phpdocs instead of appending'),
+          array('reset', 'R', InputOption::VALUE_NONE, 'Remove the original phpdocs instead of appending'),
-            array('ignore', 'I', InputOption::VALUE_OPTIONAL, 'Which models to ignore', ''),
+          array('smart-reset', 'r', InputOption::VALUE_NONE, 'Refresh the properties/methods list, but keep the text'),
+          array('ignore', 'I', InputOption::VALUE_OPTIONAL, 'Which models to ignore', ''),
         );
     }
 
@@ -124,8 +151,10 @@ class ModelsCommand extends Command
 
 
         $output = "<?php
+
+// @formatter:off
 /**
- * An helper file for your Eloquent Models
+ * A helper file for your Eloquent Models
  * Copy the phpDocs from this file to the correct Model,
  * And remove them from this file, to prevent double declarations.
  *
@@ -148,49 +177,60 @@ class ModelsCommand extends Command
 
         foreach ($models as $name) {
             if (in_array($name, $ignore)) {
-                $this->comment("Ignoring model '$name'");
+                if ($this->output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
+                    $this->comment("Ignoring model '$name'");
+                }
                 continue;
-            } else {
-                $this->comment("Loading model '$name'");
             }
             $this->properties = array();
             $this->methods = array();
             if (class_exists($name)) {
                 try {
                     // handle abstract classes, interfaces, ...
-                    $reflectionClass = new \ReflectionClass($name);
+                    $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();
+                    if ($this->output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
+                        $this->comment("Loading model '$name'");
+                    }
+
+                    if (!$reflectionClass->IsInstantiable()) {
+                        // ignore abstract class or interface
+                        continue;
+                    }
+
+                    $model = $this->laravel->make($name);
+
                     if ($hasDoctrine) {
                         $this->getPropertiesFromTable($model);
                     }
+
+                    if (method_exists($model, 'getCasts')) {
+                        $this->castPropertiesType($model);
+                    }
+
                     $this->getPropertiesFromMethods($model);
-                    $output .= $this->createPhpDocs($name);
+                    $this->getSoftDeleteMethods($model);
+                    $output                .= $this->createPhpDocs($name);
+                    $ignore[]              = $name;
+                    $this->nullableColumns = [];
                 } catch (\Exception $e) {
                     $this->error("Exception: " . $e->getMessage() . "\nCould not analyze class $name.");
                 }
-            } elseif (interface_exists($name) || (function_exists('trait_exists') && trait_exists($name))) {
-                $this->info("Skipping interface/trait $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`.'
             );
         }
 
         return $output;
-
     }
 
 
@@ -208,6 +248,77 @@ class ModelsCommand extends Command
         return $models;
     }
 
+    /**
+     * cast the properties's type from $casts.
+     *
+     * @param \Illuminate\Database\Eloquent\Model $model
+     */
+    protected function castPropertiesType($model)
+    {
+        $casts = $model->getCasts();
+        foreach ($casts as $name => $type) {
+            switch ($type) {
+                case 'boolean':
+                case 'bool':
+                    $realType = 'boolean';
+                    break;
+                case 'string':
+                    $realType = 'string';
+                    break;
+                case 'array':
+                case 'json':
+                    $realType = 'array';
+                    break;
+                case 'object':
+                    $realType = 'object';
+                    break;
+                case 'int':
+                case 'integer':
+                case 'timestamp':
+                    $realType = 'integer';
+                    break;
+                case 'real':
+                case 'double':
+                case 'float':
+                    $realType = 'float';
+                    break;
+                case 'date':
+                case 'datetime':
+                    $realType = '\Illuminate\Support\Carbon';
+                    break;
+                case 'collection':
+                    $realType = '\Illuminate\Support\Collection';
+                    break;
+                default:
+                    $realType = 'mixed';
+                    break;
+            }
+
+            if (!isset($this->properties[$name])) {
+                continue;
+            } else {
+                $this->properties[$name]['type'] = $this->getTypeOverride($realType);
+
+                if (isset($this->nullableColumns[$name])) {
+                    $this->properties[$name]['type'] .= '|null';
+                }
+            }
+        }
+    }
+
+    /**
+     * Returns the overide type for the give type.
+     *
+     * @param string $type
+     * @return string
+     */
+    protected function getTypeOverride($type)
+    {
+        $typeOverrides = $this->laravel['config']->get('ide-helper.type_overrides', array());
+
+        return isset($typeOverrides[$type]) ? $typeOverrides[$type] : $type;
+    }
+
     /**
      * Load the properties from the database table.
      *
@@ -217,15 +328,27 @@ class ModelsCommand extends Command
     {
         $table = $model->getConnection()->getTablePrefix() . $model->getTable();
         $schema = $model->getConnection()->getDoctrineSchemaManager($table);
-        $schema->getDatabasePlatform()->registerDoctrineTypeMapping('enum', 'string');
+        $databasePlatform = $schema->getDatabasePlatform();
+        $databasePlatform->registerDoctrineTypeMapping('enum', 'string');
 
-        $columns = $schema->listTableColumns($table);
+        $platformName = $databasePlatform->getName();
+        $customTypes = $this->laravel['config']->get("ide-helper.custom_db_types.{$platformName}", array());
+        foreach ($customTypes as $yourTypeName => $doctrineTypeName) {
+            $databasePlatform->registerDoctrineTypeMapping($yourTypeName, $doctrineTypeName);
+        }
+
+        $database = null;
+        if (strpos($table, '.')) {
+            list($database, $table) = explode('.', $table);
+        }
+
+        $columns = $schema->listTableColumns($table, $database);
 
         if ($columns) {
             foreach ($columns as $column) {
                 $name = $column->getName();
                 if (in_array($name, $model->getDates())) {
-                    $type = '\Carbon\Carbon';
+                    $type = '\Illuminate\Support\Carbon';
                 } else {
                     $type = $column->getType()->getName();
                     switch ($type) {
@@ -243,26 +366,39 @@ class ModelsCommand extends Command
                         case 'smallint':
                             $type = 'integer';
                             break;
+                        case 'boolean':
+                            switch (config('database.default')) {
+                                case 'sqlite':
+                                case 'mysql':
+                                    $type = 'integer';
+                                    break;
+                                default:
+                                    $type = 'boolean';
+                                    break;
+                            }
+                            break;
                         case 'decimal':
                         case 'float':
                             $type = 'float';
                             break;
-                        case 'boolean':
-                            $type = 'boolean';
-                            break;
                         default:
                             $type = 'mixed';
                             break;
                     }
                 }
 
-
+                $comment = $column->getComment();
-                $this->setProperty($name, $type, true, true);
+                if (!$column->getNotnull()) {
-                $this->setMethod(
+                    $this->nullableColumns[$name] = true;
-                    Str::camel("where_" . $name),
+                }
-                    '\Illuminate\Database\Query\Builder|\\' . get_class($model),
+                $this->setProperty($name, $type, true, true, $comment, !$column->getNotnull());
-                    array('$value')
+                if ($this->write_model_magic_where) {
-                );
+                    $this->setMethod(
+                        Str::camel("where_" . $name),
+                        '\Illuminate\Database\Eloquent\Builder|\\' . get_class($model),
+                        array('$value')
+                    );
+                }
             }
         }
     }
@@ -274,21 +410,24 @@ class ModelsCommand extends Command
     {
         $methods = get_class_methods($model);
         if ($methods) {
+            sort($methods);
             foreach ($methods as $method) {
                 if (Str::startsWith($method, 'get') && Str::endsWith(
-                        $method,
+                    $method,
-                        'Attribute'
+                    'Attribute'
-                    ) && $method !== 'getAttribute'
+                ) && $method !== 'getAttribute'
                 ) {
                     //Magic get<name>Attribute
                     $name = Str::snake(substr($method, 3, -9));
                     if (!empty($name)) {
-                        $this->setProperty($name, null, true, null);
+                        $reflection = new \ReflectionMethod($model, $method);
+                        $type = $this->getReturnTypeFromDocBlock($reflection);
+                        $this->setProperty($name, $type, true, null);
                     }
                 } elseif (Str::startsWith($method, 'set') && Str::endsWith(
-                        $method,
+                    $method,
-                        'Attribute'
+                    'Attribute'
-                    ) && $method !== 'setAttribute'
+                ) && $method !== 'setAttribute'
                 ) {
                     //Magic set<name>Attribute
                     $name = Str::snake(substr($method, 3, -9));
@@ -303,10 +442,14 @@ class ModelsCommand extends Command
                         $args = $this->getParameters($reflection);
                         //Remove the first ($query) argument
                         array_shift($args);
-                        $this->setMethod($name, '\\' . $reflection->class, $args);
+                        $this->setMethod($name, '\Illuminate\Database\Eloquent\Builder|\\' . $reflection->class, $args);
                     }
-                } elseif (!method_exists('Eloquent', $method) && !Str::startsWith($method, 'get')) {
+                } 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')
+                ) {
                     //Use reflection to inspect the code, based on Illuminate/Support/SerializableClosure.php
                     $reflection = new \ReflectionMethod($model, $method);
 
@@ -318,60 +461,120 @@ 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);
 
                     foreach (array(
-                                 'hasMany',
+                               'hasMany',
-                                 'belongsToMany',
+                               'hasManyThrough',
-                                 'hasOne',
+                               'belongsToMany',
-                                 'belongsTo',
+                               'hasOne',
-                                 'morphTo',
+                               'belongsTo',
-                                 'morphMany',
+                               'morphOne',
-                                 'morphToMany'
+                               'morphTo',
+                               'morphMany',
+                               'morphToMany',
+                               'morphedByMany'
                              ) as $relation) {
                         $search = '$this->' . $relation . '(';
                         if ($pos = stripos($code, $search)) {
-                            $code = substr($code, $pos + strlen($search));
+                            //Resolve the relation's model to a Relation object.
-                            $arguments = explode(',', substr($code, 0, stripos($code, ')')));
+                            $methodReflection = new \ReflectionMethod($model, $method);
-                            //Remove quotes, ensure 1 \ in front of the model
+                            if ($methodReflection->getNumberOfParameters()) {
-                            $returnModel = "\\" . ltrim(trim($arguments[0], " \"'"), "\\");
+                                return;
-                            if ($relation === "belongsToMany" or $relation === 'hasMany' or $relation === 'morphMany' or $relation === 'morphToMany') {
+                            }
-                                //Collection or array of models (because Collection is Arrayable)
+
-                                $this->setProperty(
+                            $relationObj = $model->$method();
-                                    $method,
+
-                                    '\Illuminate\Database\Eloquent\Collection|' . $returnModel . '[]',
+                            if ($relationObj instanceof Relation) {
-                                    true,
+                                $relatedModel = '\\' . get_class($relationObj->getRelated());
-                                    null
+
-                                );
+                                $relations = [
-                            } else {
+                                    'hasManyThrough',
-                                //Single model is returned
+                                    'belongsToMany',
-                                $this->setProperty($method, $returnModel, true, null);
+                                    'hasMany',
+                                    'morphMany',
+                                    'morphToMany',
+                                    'morphedByMany',
+                                ];
+                                if (in_array($relation, $relations)) {
+                                    //Collection or array of models (because Collection is Arrayable)
+                                    $this->setProperty(
+                                        $method,
+                                        $this->getCollectionClass($relatedModel) . '|' . $relatedModel . '[]',
+                                        true,
+                                        null
+                                    );
+                                } elseif ($relation === "morphTo") {
+                                    // Model isn't specified because relation is polymorphic
+                                    $this->setProperty(
+                                        $method,
+                                        '\Illuminate\Database\Eloquent\Model|\Eloquent',
+                                        true,
+                                        null
+                                    );
+                                } else {
+                                    //Single model is returned
+                                    $this->setProperty(
+                                        $method,
+                                        $relatedModel,
+                                        true,
+                                        null,
+                                        '',
+                                        $this->isRelationForeignKeyNullable($relationObj)
+                                    );
+                                }
                             }
                         }
                     }
-
                 }
             }
         }
     }
 
     /**
-     * @param string $name
+     * Check if the foreign key of the relation is nullable
-     * @param string|null $type
+     *
-     * @param bool|null $read
+     * @param Relation $relation
-     * @param bool|null $write
+     *
+     * @return bool
      */
-    protected function setProperty($name, $type = null, $read = null, $write = null)
+    private function isRelationForeignKeyNullable(Relation $relation)
+    {
+        $reflectionObj = new \ReflectionObject($relation);
+        if (!$reflectionObj->hasProperty('foreignKey')) {
+            return false;
+        }
+        $fkProp = $reflectionObj->getProperty('foreignKey');
+        $fkProp->setAccessible(true);
+
+        return isset($this->nullableColumns[$fkProp->getValue($relation)]);
+    }
+
+    /**
+     * @param string      $name
+     * @param string|null $type
+     * @param bool|null   $read
+     * @param bool|null   $write
+     * @param string|null $comment
+     * @param bool        $nullable
+     */
+    protected function setProperty($name, $type = null, $read = null, $write = null, $comment = '', $nullable = false)
     {
         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;
+            $newType = $this->getTypeOverride($type);
+            if ($nullable) {
+                $newType .='|null';
+            }
+            $this->properties[$name]['type'] = $newType;
         }
         if ($read !== null) {
             $this->properties[$name]['read'] = $read;
@@ -383,7 +586,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;
@@ -397,13 +602,19 @@ class ModelsCommand extends Command
     protected function createPhpDocs($class)
     {
 
-        $reflection = new \ReflectionClass($class);
+        $reflection = new ReflectionClass($class);
         $namespace = $reflection->getNamespaceName();
         $classname = $reflection->getShortName();
         $originalDoc = $reflection->getDocComment();
+        $keyword = $this->getClassKeyword($reflection);
 
         if ($this->reset) {
             $phpdoc = new DocBlock('', new Context($namespace));
+            if ($this->keep_text) {
+                $phpdoc->setText(
+                    (new DocBlock($reflection, new Context($namespace)))->getText()
+                );
+            }
         } else {
             $phpdoc = new DocBlock($reflection, new Context($namespace));
         }
@@ -435,19 +646,31 @@ class ModelsCommand extends Command
             } else {
                 $attr = 'property-read';
             }
-            $tag = Tag::createInstance("@{$attr} {$property['type']} {$name}", $phpdoc);
+
+            if ($this->hasCamelCaseModelProperties()) {
+                $name = Str::camel($name);
+            }
+
+            $tagLine = trim("@{$attr} {$property['type']} {$name} {$property['comment']}");
+            $tag = Tag::createInstance($tagLine, $phpdoc);
             $phpdoc->appendTag($tag);
         }
 
+        ksort($this->methods);
+
         foreach ($this->methods as $name => $method) {
             if (in_array($name, $methods)) {
                 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);
         }
 
+        if ($this->write && ! $phpdoc->getTagsByName('mixin')) {
+            $phpdoc->appendTag(Tag::createInstance("@mixin \\Eloquent", $phpdoc));
+        }
+
         $serializer = new DocBlockSerializer();
         $serializer->getDocComment($phpdoc);
         $docComment = $serializer->getDocComment($phpdoc);
@@ -455,7 +678,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 {
@@ -466,12 +689,12 @@ 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);
             }
         }
 
-        $output = "namespace {$namespace}{\n{$docComment}\n\tclass {$classname} {}\n}\n\n";
+        $output = "namespace {$namespace}{\n{$docComment}\n\t{$keyword}class {$classname} extends \Eloquent {}\n}\n\n";
         return $output;
     }
 
@@ -486,10 +709,12 @@ 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();
+            $paramClass = $param->getClass();
+            $paramStr = (!is_null($paramClass) ? '\\' . $paramClass->getName() . ' ' : '') . '$' . $param->getName();
             $params[] = $paramStr;
-            if ($param->isOptional()) {
+            if ($param->isOptional() && $param->isDefaultValueAvailable()) {
                 $default = $param->getDefaultValue();
                 if (is_bool($default)) {
                     $default = $default ? 'true' : 'false';
@@ -509,4 +734,84 @@ class ModelsCommand extends Command
         return $paramsWithDefault;
     }
 
+    /**
+     * Determine a model classes' collection type.
+     *
+     * @see http://laravel.com/docs/eloquent-collections#custom-collections
+     * @param string $className
+     * @return string
+     */
+    private function getCollectionClass($className)
+    {
+        // Return something in the very very unlikely scenario the model doesn't
+        // have a newCollection() method.
+        if (!method_exists($className, 'newCollection')) {
+            return '\Illuminate\Database\Eloquent\Collection';
+        }
+
+        /** @var \Illuminate\Database\Eloquent\Model $model */
+        $model = new $className;
+        return '\\' . get_class($model->newCollection());
+    }
+
+    /**
+     * @return bool
+     */
+    protected function hasCamelCaseModelProperties()
+    {
+        return $this->laravel['config']->get('ide-helper.model_camel_case_properties', false);
+    }
+
+    /**
+     * Get method return type based on it DocBlock comment
+     *
+     * @param \ReflectionMethod $reflection
+     *
+     * @return null|string
+     */
+    protected function getReturnTypeFromDocBlock(\ReflectionMethod $reflection)
+    {
+        $type = null;
+        $phpdoc = new DocBlock($reflection);
+
+        if ($phpdoc->hasTag('return')) {
+            $type = $phpdoc->getTagsByName('return')[0]->getType();
+        }
+
+        return $type;
+    }
+
+    /**
+     * Generates methods provided by the SoftDeletes trait
+     * @param \Illuminate\Database\Eloquent\Model $model
+     */
+    protected function getSoftDeleteMethods($model)
+    {
+        $traits = class_uses(get_class($model), true);
+        if (in_array('Illuminate\\Database\\Eloquent\\SoftDeletes', $traits)) {
+            $this->setMethod('forceDelete', 'bool|null', []);
+            $this->setMethod('restore', 'bool|null', []);
+
+            $this->setMethod('withTrashed', '\Illuminate\Database\Query\Builder|\\' . get_class($model), []);
+            $this->setMethod('withoutTrashed', '\Illuminate\Database\Query\Builder|\\' . get_class($model), []);
+            $this->setMethod('onlyTrashed', '\Illuminate\Database\Query\Builder|\\' . get_class($model), []);
+        }
+    }
+
+    /**
+     * @param ReflectionClass $reflection
+     * @return string
+     */
+    private function getClassKeyword(ReflectionClass $reflection)
+    {
+        if ($reflection->isFinal()) {
+            $keyword = 'final ';
+        } elseif ($reflection->isAbstract()) {
+            $keyword = 'abstract ';
+        } else {
+            $keyword = '';
+        }
+
+        return $keyword;
+    }
 }

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/Generator.php

@@ -1,235 +1,328 @@
-<?php
+<?php
-/**
+/**
- * Laravel IDE Helper Generator
+ * Laravel IDE Helper Generator
- *
+ *
- * @author    Barry vd. Heuvel <[email protected]>
+ * @author    Barry vd. Heuvel <[email protected]>
- * @copyright 2014 Barry vd. Heuvel / Fruitcake Studio (http://www.fruitcakestudio.nl)
+ * @copyright 2014 Barry vd. Heuvel / Fruitcake Studio (http://www.fruitcakestudio.nl)
- * @license   http://www.opensource.org/licenses/mit-license.php MIT
+ * @license   http://www.opensource.org/licenses/mit-license.php MIT
- * @link      https://github.com/barryvdh/laravel-ide-helper
+ * @link      https://github.com/barryvdh/laravel-ide-helper
- */
+ */
-
+
-namespace Barryvdh\LaravelIdeHelper;
+namespace Barryvdh\LaravelIdeHelper;
-
+
-use Illuminate\Foundation\AliasLoader;
+use Illuminate\Foundation\Application;
-use Illuminate\Config\Repository as ConfigRepository;
+use Illuminate\Foundation\AliasLoader;
-use Symfony\Component\Console\Output\OutputInterface;
+use Illuminate\Support\Collection;
-
+use ReflectionClass;
-class Generator
+use Symfony\Component\Console\Output\OutputInterface;
-{
+
-    /** @var \Illuminate\Config\Repository */
+class Generator
-    protected $config;
+{
-
+    /** @var \Illuminate\Config\Repository */
-    /** @var \Illuminate\View\Factory */
+    protected $config;
-    protected $view;
+
-
+    /** @var \Illuminate\View\Factory */
-    /** @var \Symfony\Component\Console\Output\OutputInterface */
+    protected $view;
-    protected $output;
+
-
+    /** @var \Symfony\Component\Console\Output\OutputInterface */
-    protected $extra = array();
+    protected $output;
-    protected $magic = array();
+
-    protected $interfaces = array();
+    protected $extra = array();
-    protected $helpers;
+    protected $magic = array();
-
+    protected $interfaces = array();
-    /**
+    protected $helpers;
-     * @param \Illuminate\Config\Repository $config
+
-     * @param \Illuminate\View\Factory $view
+    /**
-     * @param \Symfony\Component\Console\Output\OutputInterface $output
+     * @param \Illuminate\Config\Repository $config
-     * @param string $helpers
+     * @param \Illuminate\View\Factory $view
-     */
+     * @param \Symfony\Component\Console\Output\OutputInterface $output
-    public function __construct(ConfigRepository $config,
+     * @param string $helpers
-        /* Illuminate\View\Factory */ $view,
+     */
-        OutputInterface $output = null,
+    public function __construct(
-        $helpers = ''
+        /*ConfigRepository */ $config,
-    ) {
+        /* Illuminate\View\Factory */ $view,
-        $this->config = $config;
+        OutputInterface $output = null,
-        $this->view = $view;
+        $helpers = ''
-
+    ) {
-        // Find the drivers to add to the extra/interfaces
+        $this->config = $config;
-        $this->detectDrivers();
+        $this->view = $view;
-
+
-        $this->extra = array_merge($this->extra, $this->config->get('laravel-ide-helper::extra'));
+        // Find the drivers to add to the extra/interfaces
-        $this->magic = array_merge($this->magic, $this->config->get('laravel-ide-helper::magic'));
+        $this->detectDrivers();
-        $this->interfaces = array_merge($this->interfaces, $this->config->get('laravel-ide-helper::interfaces'));
+
-        $this->helpers = $helpers;
+        $this->extra = array_merge($this->extra, $this->config->get('ide-helper.extra'));
-    }
+        $this->magic = array_merge($this->magic, $this->config->get('ide-helper.magic'));
-
+        $this->interfaces = array_merge($this->interfaces, $this->config->get('ide-helper.interfaces'));
-    /**
+        // Make all interface classes absolute
-     * Generate the helper file contents;
+        foreach ($this->interfaces as &$interface) {
-     *
+            $interface = '\\' . ltrim($interface, '\\');
-     * @param  string  $format  The format to generate the helper in (php/json)
+        }
-     * @return string;
+        $this->helpers = $helpers;
-     */
+    }
-    public function generate($format = 'php')
+
-    {
+    /**
-        // Check if the generator for this format exists
+     * Generate the helper file contents;
-        $method = 'generate'.ucfirst($format).'Helper';
+     *
-        if (method_exists($this, $method)) {
+     * @param  string  $format  The format to generate the helper in (php/json)
-            return $this->$method();
+     * @return string;
-        }
+     */
-
+    public function generate($format = 'php')
-        return $this->generatePhpHelper();
+    {
-    }
+        // Check if the generator for this format exists
-
+        $method = 'generate'.ucfirst($format).'Helper';
-    public function generatePhpHelper()
+        if (method_exists($this, $method)) {
-    {
+            return $this->$method();
-        $app = app();
+        }
-        return $this->view->make('laravel-ide-helper::ide-helper')
+
-            ->with('namespaces', $this->getNamespaces())
+        return $this->generatePhpHelper();
-            ->with('helpers', $this->helpers)
+    }
-            ->with('version', $app::VERSION)
+
-            ->render();
+    public function generatePhpHelper()
-    }
+    {
-
+        $app = app();
-    public function generateJsonHelper()
+        return $this->view->make('helper')
-    {
+            ->with('namespaces_by_extends_ns', $this->getAliasesByExtendsNamespace())
-        $classes = array();
+            ->with('namespaces_by_alias_ns', $this->getAliasesByAliasNamespace())
-        foreach ($this->getNamespaces() as $aliases) {
+            ->with('helpers', $this->helpers)
-            foreach($aliases as $alias) {
+            ->with('version', $app->version())
-                $functions = array();
+            ->with('include_fluent', $this->config->get('ide-helper.include_fluent', true))
-                foreach ($alias->getMethods() as $method) {
+            ->render();
-                    $functions[$method->getName()] = '('. $method->getParamsWithDefault().')';
+    }
-                }
+
-                $classes[$alias->getAlias()] = array(
+    public function generateJsonHelper()
-                    'functions' => $functions,
+    {
-                );
+        $classes = array();
-            }
+        foreach ($this->getValidAliases() as $aliases) {
-        }
+            foreach ($aliases as $alias) {
-
+                $functions = array();
-        $flags = JSON_FORCE_OBJECT;
+                foreach ($alias->getMethods() as $method) {
-        if (defined('JSON_PRETTY_PRINT')) {
+                    $functions[$method->getName()] = '('. $method->getParamsWithDefault().')';
-            $flags |= JSON_PRETTY_PRINT;
+                }
-        }
+                $classes[$alias->getAlias()] = array(
-
+                    'functions' => $functions,
-        return json_encode(array(
+                );
-            'php' => array(
+            }
-                'classes' => $classes,
+        }
-            ),
+
-        ), $flags);
+        $flags = JSON_FORCE_OBJECT;
-    }
+        if (defined('JSON_PRETTY_PRINT')) {
-
+            $flags |= JSON_PRETTY_PRINT;
-    protected function detectDrivers()
+        }
-    {
+
-        try{
+        return json_encode(array(
-            if (class_exists('Auth')) {
+            'php' => array(
-                $class = get_class(\Auth::driver());
+                'classes' => $classes,
-                $this->extra['Auth'] = array($class);
+            ),
-                $this->interfaces['\Illuminate\Auth\UserProviderInterface'] = $class;
+        ), $flags);
-            }
+    }
-        }catch (\Exception $e) {}
+
-
+    protected function detectDrivers()
-        try{
+    {
-            if (class_exists('DB')) {
+        $defaultUserModel = config('auth.providers.users.model', config('auth.model', 'App\User'));
-                $class = get_class(\DB::connection());
+        $this->interfaces['\Illuminate\Contracts\Auth\Authenticatable'] = $defaultUserModel;
-                $this->extra['DB'] = array($class);
+
-                $this->interfaces['\Illuminate\Database\ConnectionInterface'] = $class;
+        try {
-            }
+            if (class_exists('Auth') && is_a('Auth', '\Illuminate\Support\Facades\Auth', true)) {
-        }catch (\Exception $e) {}
+                if (class_exists('\Illuminate\Foundation\Application')) {
-
+                    $authMethod = version_compare(Application::VERSION, '5.2', '>=') ? 'guard' : 'driver';
-        try{
+                } else {
-            if (class_exists('Cache')) {
+                    $refClass = new ReflectionClass('\Laravel\Lumen\Application');
-                $driver = get_class(\Cache::driver());
+                    $versionStr = $refClass->newInstanceWithoutConstructor()->version();
-                $store = get_class(\Cache::getStore());
+                    $authMethod = strpos($versionStr, 'Lumen (5.0') === 0 ?
-                $this->extra['Cache'] = array($driver, $store);
+                        'driver' :
-                $this->interfaces['\Illuminate\Cache\StoreInterface'] = $store;
+                        (strpos($versionStr, 'Lumen (5.1') === 0 ? 'driver' : 'guard');
-            }
+                }
-        }catch (\Exception $e) {}
+                $class = get_class(\Auth::$authMethod());
-
+                $this->extra['Auth'] = array($class);
-        try{
+                $this->interfaces['\Illuminate\Auth\UserProviderInterface'] = $class;
-            if (class_exists('Queue')) {
+            }
-                $class = get_class(\Queue::connection());
+        } catch (\Exception $e) {
-                $this->extra['Queue'] = array($class);
+        }
-                $this->interfaces['\Illuminate\Queue\QueueInterface'] = $class;
+
-            }
+        try {
-        }catch (\Exception $e) {}
+            if (class_exists('DB') && is_a('DB', '\Illuminate\Support\Facades\DB', true)) {
-
+                $class = get_class(\DB::connection());
-        try{
+                $this->extra['DB'] = array($class);
-            if (class_exists('SSH')){
+                $this->interfaces['\Illuminate\Database\ConnectionInterface'] = $class;
-                $class = get_class(\SSH::connection());
+            }
-                $this->extra['SSH'] = array($class);
+        } catch (\Exception $e) {
-                $this->interfaces['\Illuminate\Remote\ConnectionInterface'] = $class;
+        }
-            }
+
-        }catch (\Exception $e) {}
+        try {
-
+            if (class_exists('Cache') && is_a('Cache', '\Illuminate\Support\Facades\Cache', true)) {
-        // Make all interface classes absolute
+                $driver = get_class(\Cache::driver());
-        foreach ($this->interfaces as &$interface) {
+                $store = get_class(\Cache::getStore());
-            $interface = '\\' . ltrim($interface, '\\');
+                $this->extra['Cache'] = array($driver, $store);
-        }
+                $this->interfaces['\Illuminate\Cache\StoreInterface'] = $store;
-    }
+            }
-
+        } catch (\Exception $e) {
-    /**
+        }
-     * Find all namespaces/aliases that are valid for us to render
+
-     *
+        try {
-     * @return array
+            if (class_exists('Queue') && is_a('Queue', '\Illuminate\Support\Facades\Queue', true)) {
-     */
+                $class = get_class(\Queue::connection());
-    protected function getNamespaces()
+                $this->extra['Queue'] = array($class);
-    {
+                $this->interfaces['\Illuminate\Queue\QueueInterface'] = $class;
-        $namespaces = array();
+            }
-
+        } catch (\Exception $e) {
-        // Get all aliases
+        }
-        foreach (AliasLoader::getInstance()->getAliases() as $name => $facade) {
+
-            $magicMethods = array_key_exists($name, $this->magic) ? $this->magic[$name] : array();
+        try {
-            $alias = new Alias($name, $facade, $magicMethods, $this->interfaces);
+            if (class_exists('SSH') && is_a('SSH', '\Illuminate\Support\Facades\SSH', true)) {
-            if ($alias->isValid()) {
+                $class = get_class(\SSH::connection());
-
+                $this->extra['SSH'] = array($class);
-                //Add extra methods, from other classes (magic static calls)
+                $this->interfaces['\Illuminate\Remote\ConnectionInterface'] = $class;
-                if (array_key_exists($name, $this->extra)) {
+            }
-                    $alias->addClass($this->extra[$name]);
+        } catch (\Exception $e) {
-                }
+        }
-
+
-                $namespace = $alias->getNamespace();
+        try {
-                if (!isset($namespaces[$namespace])) {
+            if (class_exists('Storage') && is_a('Storage', '\Illuminate\Support\Facades\Storage', true)) {
-                    $namespaces[$namespace] = array();
+                $class = get_class(\Storage::disk());
-                }
+                $this->extra['Storage'] = array($class);
-                $namespaces[$namespace][] = $alias;
+                $this->interfaces['\Illuminate\Contracts\Filesystem\Filesystem'] = $class;
-            }
+            }
-
+        } catch (\Exception $e) {
-        }
+        }
-
+    }
-        return $namespaces;
+
-    }
+    /**
-
+     * Find all aliases that are valid for us to render
-    /**
+     *
-     * Get the driver/connection/store from the managers
+     * @return Collection
-     *
+     */
-     * @param $alias
+    protected function getValidAliases()
-     * @return array|bool|string
+    {
-     */
+        $aliases = new Collection();
-    public function getDriver($alias)
+
-    {
+        // Get all aliases
-        try {
+        foreach ($this->getAliases() as $name => $facade) {
-            if ($alias == "Auth") {
+            // Skip the Redis facade, if not available (otherwise Fatal PHP Error)
-                $driver = \Auth::driver();
+            if ($facade == 'Illuminate\Support\Facades\Redis' && !class_exists('Predis\Client')) {
-            } elseif ($alias == "DB") {
+                continue;
-                $driver = \DB::connection();
+            }
-            } elseif ($alias == "Cache") {
+
-                $driver = get_class(\Cache::driver());
+            $magicMethods = array_key_exists($name, $this->magic) ? $this->magic[$name] : array();
-                $store = get_class(\Cache::getStore());
+            $alias = new Alias($name, $facade, $magicMethods, $this->interfaces);
-                return array($driver, $store);
+            if ($alias->isValid()) {
-            } elseif ($alias == "Queue") {
+                //Add extra methods, from other classes (magic static calls)
-                $driver = \Queue::connection();
+                if (array_key_exists($name, $this->extra)) {
-            } else {
+                    $alias->addClass($this->extra[$name]);
-                return false;
+                }
-            }
+
-
+                $aliases[] = $alias;
-            return get_class($driver);
+            }
-        } catch (\Exception $e) {
+        }
-            $this->error("Could not determine driver/connection for $alias.");
+
-            return false;
+        return $aliases;
-        }
+    }
-    }
+
-
+    /**
-    /**
+     * Regroup aliases by namespace of extended classes
-     * Write a string as error output.
+     *
-     *
+     * @return Collection
-     * @param  string  $string
+     */
-     * @return void
+    protected function getAliasesByExtendsNamespace()
-     */
+    {
-    protected function error($string)
+        return $this->getValidAliases()->groupBy(function (Alias $alias) {
-    {
+            return $alias->getExtendsNamespace();
-        if($this->output){
+        });
-            $this->output->writeln("<error>$string</error>");
+    }
-        }else{
+
-            echo $string . "\r\n";
+    /**
-        }
+     * Regroup aliases by namespace of alias
-    }
+     *
-}
+     * @return Collection
+     */
+    protected function getAliasesByAliasNamespace()
+    {
+        return $this->getValidAliases()->groupBy(function (Alias $alias) {
+            return $alias->getNamespace();
+        });
+    }
+
+    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',
+          'Gate' => 'Illuminate\Support\Facades\Gate',
+        ];
+
+        $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);
+            },
+            ARRAY_FILTER_USE_KEY
+        );
+    }
+
+    /**
+     * Get the driver/connection/store from the managers
+     *
+     * @param $alias
+     * @return array|bool|string
+     */
+    public function getDriver($alias)
+    {
+        try {
+            if ($alias == "Auth") {
+                $driver = \Auth::driver();
+            } elseif ($alias == "DB") {
+                $driver = \DB::connection();
+            } elseif ($alias == "Cache") {
+                $driver = get_class(\Cache::driver());
+                $store = get_class(\Cache::getStore());
+                return array($driver, $store);
+            } elseif ($alias == "Queue") {
+                $driver = \Queue::connection();
+            } else {
+                return false;
+            }
+
+            return get_class($driver);
+        } catch (\Exception $e) {
+            $this->error("Could not determine driver/connection for $alias.");
+            return false;
+        }
+    }
+
+    /**
+     * Write a string as error output.
+     *
+     * @param  string  $string
+     * @return void
+     */
+    protected function error($string)
+    {
+        if ($this->output) {
+            $this->output->writeln("<error>$string</error>");
+        } else {
+            echo $string . "\r\n";
+        }
+    }
+}

src/IdeHelperServiceProvider.php

@@ -10,10 +10,15 @@
 
 namespace Barryvdh\LaravelIdeHelper;
 
-use Illuminate\Support\ServiceProvider;
+use Barryvdh\LaravelIdeHelper\Console\EloquentCommand;
 use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
-use Barryvdh\LaravelIdeHelper\Console\Generator2Command;
+use Barryvdh\LaravelIdeHelper\Console\MetaCommand;
-Use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
+use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
+use Illuminate\Support\ServiceProvider;
+use Illuminate\View\Engines\EngineResolver;
+use Illuminate\View\Engines\PhpEngine;
+use Illuminate\View\Factory;
+use Illuminate\View\FileViewFinder;
 
 class IdeHelperServiceProvider extends ServiceProvider
 {
@@ -32,7 +37,16 @@ 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';
+        if (function_exists('config_path')) {
+            $publishPath = config_path('ide-helper.php');
+        } else {
+            $publishPath = base_path('config/ide-helper.php');
+        }
+        $this->publishes([$configPath => $publishPath], 'config');
     }
 
     /**
@@ -42,19 +56,44 @@ class IdeHelperServiceProvider extends ServiceProvider
      */
     public function register()
     {
-        $this->app['command.ide-helper.generate'] = $this->app->share(
+        $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) {
+                return new GeneratorCommand($app['config'], $app['files'], $localViewFactory);
+            }
+        );
+
+        $this->app->singleton(
+            'command.ide-helper.models',
             function ($app) {
-                return new GeneratorCommand($app['config'], $app['files'], $app['view']);
+                return new ModelsCommand($app['files']);
             }
         );
 
-        $this->app['command.ide-helper.models'] = $this->app->share(
+        $this->app->singleton(
-            function () {
+            'command.ide-helper.meta',
-                return new ModelsCommand();
+            function ($app) use ($localViewFactory) {
+                return new MetaCommand($app['files'], $localViewFactory, $app['config']);
             }
         );
 
-        $this->commands('command.ide-helper.generate', 'command.ide-helper.models');
+        $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'
+        );
     }
 
     /**
@@ -67,4 +106,19 @@ class IdeHelperServiceProvider extends ServiceProvider
         return array('command.ide-helper.generate', 'command.ide-helper.models');
     }
 
+    /**
+     * @return Factory
+     */
+    private function createLocalViewFactory()
+    {
+        $resolver = new EngineResolver();
+        $resolver->register('php', function () {
+            return new PhpEngine();
+        });
+        $finder = new FileViewFinder($this->app['files'], [__DIR__ . '/../resources/views']);
+        $factory = new Factory($resolver, $finder, $this->app['events']);
+        $factory->addExtension('php', 'php');
+
+        return $factory;
+    }
 }

src/Macro.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace Barryvdh\LaravelIdeHelper;
+
+use Barryvdh\Reflection\DocBlock;
+use Barryvdh\Reflection\DocBlock\Tag;
+
+class Macro extends Method
+{
+    /**
+     * Macro constructor.
+     *
+     * @param \ReflectionFunctionAbstract $method
+     * @param string              $alias
+     * @param \ReflectionClass    $class
+     * @param null                $methodName
+     * @param array               $interfaces
+     */
+    public function __construct(
+        $method,
+        $alias,
+        $class,
+        $methodName = null,
+        $interfaces = array()
+    ) {
+        parent::__construct($method, $alias, $class, $methodName, $interfaces);
+    }
+
+    /**
+     * @param \ReflectionFunctionAbstract $method
+     */
+    protected function initPhpDoc($method)
+    {
+        $this->phpdoc = new DocBlock($method);
+    }
+
+    /**
+     * @param \ReflectionFunctionAbstract $method
+     * @param \ReflectionClass $class
+     */
+    protected function initClassDefinedProperties($method, \ReflectionClass $class)
+    {
+        $this->namespace = $class->getNamespaceName();
+        $this->declaringClassName = '\\' . ltrim($class->name, '\\');
+    }
+}

src/Method.php

@@ -1,311 +1,344 @@
-<?php
+<?php
-/**
+/**
- * Laravel IDE Helper Generator
+ * Laravel IDE Helper Generator
- *
+ *
- * @author    Barry vd. Heuvel <[email protected]>
+ * @author    Barry vd. Heuvel <[email protected]>
- * @copyright 2014 Barry vd. Heuvel / Fruitcake Studio (http://www.fruitcakestudio.nl)
+ * @copyright 2014 Barry vd. Heuvel / Fruitcake Studio (http://www.fruitcakestudio.nl)
- * @license   http://www.opensource.org/licenses/mit-license.php MIT
+ * @license   http://www.opensource.org/licenses/mit-license.php MIT
- * @link      https://github.com/barryvdh/laravel-ide-helper
+ * @link      https://github.com/barryvdh/laravel-ide-helper
- */
+ */
-
+
-namespace Barryvdh\LaravelIdeHelper;
+namespace Barryvdh\LaravelIdeHelper;
-
+
-use phpDocumentor\Reflection\DocBlock;
+use Barryvdh\Reflection\DocBlock;
-use phpDocumentor\Reflection\DocBlock\Context;
+use Barryvdh\Reflection\DocBlock\Context;
-use phpDocumentor\Reflection\DocBlock\Tag;
+use Barryvdh\Reflection\DocBlock\Tag;
-use phpDocumentor\Reflection\DocBlock\Tag\ReturnTag;
+use Barryvdh\Reflection\DocBlock\Tag\ReturnTag;
-use phpDocumentor\Reflection\DocBlock\Tag\ParamTag;
+use Barryvdh\Reflection\DocBlock\Tag\ParamTag;
-use phpDocumentor\Reflection\DocBlock\Serializer as DocBlockSerializer;
+use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
-
+
-class Method
+class Method
-{
+{
-    /** @var \phpDocumentor\Reflection\DocBlock  */
+    /** @var \Barryvdh\Reflection\DocBlock  */
-    protected $phpdoc;
+    protected $phpdoc;
-
+
-    /** @var \ReflectionMethod  */
+    /** @var \ReflectionMethod  */
-    protected $method;
+    protected $method;
-
+
-    protected $output = '';
+    protected $output = '';
-    protected $name;
+    protected $declaringClassName;
-    protected $namespace;
+    protected $name;
-    protected $params = array();
+    protected $namespace;
-    protected $params_with_default = array();
+    protected $params = array();
-    protected $interfaces = array();
+    protected $params_with_default = array();
-    protected $return = null;
+    protected $interfaces = array();
-
+    protected $real_name;
-    /**
+    protected $return = null;
-     * @param \ReflectionMethod $method
+
-     * @param string $alias
+    /**
-     * @param string $class
+     * @param \ReflectionMethod|\ReflectionFunctionAbstract $method
-     * @param string|null $methodName
+     * @param string $alias
-     * @param array $interfaces
+     * @param \ReflectionClass $class
-     */
+     * @param string|null $methodName
-    public function __construct(\ReflectionMethod $method, $alias, $class, $methodName = null, $interfaces = array())
+     * @param array $interfaces
-    {
+     */
-        $this->method = $method;
+    public function __construct($method, $alias, $class, $methodName = null, $interfaces = array())
-        $this->interfaces = $interfaces;
+    {
-        $this->name = $methodName ?: $method->name;
+        $this->method = $method;
-        $this->namespace = $method->getDeclaringClass()->getNamespaceName();
+        $this->interfaces = $interfaces;
-
+        $this->name = $methodName ?: $method->name;
-        //Create a DocBlock and serializer instance
+        $this->real_name = $method->name;
-        $this->phpdoc = new DocBlock($method, new Context($this->namespace));
+        $this->initClassDefinedProperties($method, $class);
-
+
-        //Normalize the description and inherit the docs from parents/interfaces
+        //Create a DocBlock and serializer instance
-        try {
+        $this->initPhpDoc($method);
-            $this->normalizeParams($this->phpdoc);
+
-            $this->normalizeReturn($this->phpdoc);
+        //Normalize the description and inherit the docs from parents/interfaces
-            $this->normalizeDescription($this->phpdoc);
+        try {
-        } catch (\Exception $e) {}
+            $this->normalizeParams($this->phpdoc);
-
+            $this->normalizeReturn($this->phpdoc);
-        //Get the parameters, including formatted default values
+            $this->normalizeDescription($this->phpdoc);
-        $this->getParameters($method);
+        } catch (\Exception $e) {
-
+        }
-        //Make the method static
+
-        $this->phpdoc->appendTag(Tag::createInstance('@static', $this->phpdoc));
+        //Get the parameters, including formatted default values
-
+        $this->getParameters($method);
-        //Reference the 'real' function in the declaringclass
+
-        $declaringClass = $method->getDeclaringClass();
+        //Make the method static
-        $this->declaringClassName = '\\' . ltrim($declaringClass->name, '\\');
+        $this->phpdoc->appendTag(Tag::createInstance('@static', $this->phpdoc));
-        $this->root = '\\' . ltrim($class->getName(), '\\');
+
-    }
+        //Reference the 'real' function in the declaring class
-
+        $this->root = '\\' . ltrim($class->getName(), '\\');
-    /**
+    }
-     * Get the class wherein the function resides
+
-     *
+    /**
-     * @return string
+     * @param \ReflectionMethod $method
-     */
+     */
-    public function getDeclaringClass()
+    protected function initPhpDoc($method)
-    {
+    {
-        return $this->declaringClassName;
+        $this->phpdoc = new DocBlock($method, new Context($this->namespace));
-    }
+    }
-
+
-    /**
+    /**
-     * Return the class from which this function would be called
+     * @param \ReflectionMethod $method
-     *
+     * @param \ReflectionClass $class
-     * @return string
+     */
-     */
+    protected function initClassDefinedProperties($method, \ReflectionClass $class)
-    public function getRoot()
+    {
-    {
+        $declaringClass = $method->getDeclaringClass();
-        return $this->root;
+        $this->namespace = $declaringClass->getNamespaceName();
-    }
+        $this->declaringClassName = '\\' . ltrim($declaringClass->name, '\\');
-
+    }
-    /**
+
-     * Get the docblock for this method
+    /**
-     *
+     * Get the class wherein the function resides
-     * @param string $prefix
+     *
-     * @return mixed
+     * @return string
-     */
+     */
-    public function getDocComment($prefix = "\t\t")
+    public function getDeclaringClass()
-    {
+    {
-        $serializer = new DocBlockSerializer(1, $prefix);
+        return $this->declaringClassName;
-        return $serializer->getDocComment($this->phpdoc);
+    }
-    }
+
-
+    /**
-    /**
+     * Return the class from which this function would be called
-     * Get the method name
+     *
-     *
+     * @return string
-     * @return string
+     */
-     */
+    public function getRoot()
-    public function getName()
+    {
-    {
+        return $this->root;
-        return $this->name;
+    }
-    }
+
-
+    /**
-    /**
+     * Get the docblock for this method
-     * Get the parameters for this method
+     *
-     *
+     * @param string $prefix
-     * @param bool $implode Wether to implode the array or not
+     * @return mixed
-     * @return string
+     */
-     */
+    public function getDocComment($prefix = "\t\t")
-    public function getParams($implode = true)
+    {
-    {
+        $serializer = new DocBlockSerializer(1, $prefix);
-        return $implode ? implode(', ', $this->params) : $this->params;
+        return $serializer->getDocComment($this->phpdoc);
-    }
+    }
-
+
-    /**
+    /**
-     * Get the parameters for this method including default values
+     * Get the method name
-     *
+     *
-     * @param bool $implode Wether to implode the array or not
+     * @return string
-     * @return string
+     */
-     */
+    public function getName()
-    public function getParamsWithDefault($implode = true)
+    {
-    {
+        return $this->name;
-        return $implode ? implode(', ', $this->params_with_default) : $this->params_with_default;
+    }
-    }
+
-
+    /**
-    /**
+     * Get the real method name
-     * Get the description and get the inherited docs.
+     *
-     *
+     * @return string
-     * @param DocBlock $phpdoc
+     */
-     */
+    public function getRealName()
-    protected function normalizeDescription(DocBlock $phpdoc)
+    {
-    {
+        return $this->real_name;
-        //Get the short + long description from the DocBlock
+    }
-        $description = $phpdoc->getText();
+
-
+    /**
-        //Loop through parents/interfaces, to fill in {@inheritdoc}
+     * Get the parameters for this method
-        if (strpos($description, '{@inheritdoc}') !== false) {
+     *
-            $inheritdoc = $this->getInheritDoc($this->method);
+     * @param bool $implode Wether to implode the array or not
-            $inheritDescription = $inheritdoc->getText();
+     * @return string
-
+     */
-            $description = str_replace('{@inheritdoc}', $inheritDescription, $description);
+    public function getParams($implode = true)
-            $phpdoc->setText($description);
+    {
-
+        return $implode ? implode(', ', $this->params) : $this->params;
-            $this->normalizeParams($inheritdoc);
+    }
-            $this->normalizeReturn($inheritdoc);
+
-
+    /**
-            //Add the tags that are inherited
+     * Get the parameters for this method including default values
-            $inheritTags = $inheritdoc->getTags();
+     *
-            if ($inheritTags) {
+     * @param bool $implode Wether to implode the array or not
-                /** @var Tag $tag */
+     * @return string
-                foreach ($inheritTags as $tag) {
+     */
-                    $tag->setDocBlock();
+    public function getParamsWithDefault($implode = true)
-                    $phpdoc->appendTag($tag);
+    {
-                }
+        return $implode ? implode(', ', $this->params_with_default) : $this->params_with_default;
-            }
+    }
-        }
+
-    }
+    /**
-
+     * Get the description and get the inherited docs.
-    /**
+     *
-     * Normalize the parameters
+     * @param DocBlock $phpdoc
-     *
+     */
-     * @param DocBlock $phpdoc
+    protected function normalizeDescription(DocBlock $phpdoc)
-     */
+    {
-    protected function normalizeParams(DocBlock $phpdoc)
+        //Get the short + long description from the DocBlock
-    {
+        $description = $phpdoc->getText();
-        //Get the return type and adjust them for beter autocomplete
+
-        $paramTags = $phpdoc->getTagsByName('param');
+        //Loop through parents/interfaces, to fill in {@inheritdoc}
-        if ($paramTags) {
+        if (strpos($description, '{@inheritdoc}') !== false) {
-            /** @var ParamTag $tag */
+            $inheritdoc = $this->getInheritDoc($this->method);
-            foreach($paramTags as $tag){
+            $inheritDescription = $inheritdoc->getText();
-                // Convert the keywords
+
-                $content = $this->convertKeywords($tag->getContent());
+            $description = str_replace('{@inheritdoc}', $inheritDescription, $description);
-                $tag->setContent($content);
+            $phpdoc->setText($description);
-
+
-                // Get the expanded type and re-set the content
+            $this->normalizeParams($inheritdoc);
-                $content = $tag->getType() . ' ' . $tag->getVariableName() . ' ' . $tag->getDescription();
+            $this->normalizeReturn($inheritdoc);
-                $tag->setContent(trim($content));
+
-            }
+            //Add the tags that are inherited
-        }
+            $inheritTags = $inheritdoc->getTags();
-    }
+            if ($inheritTags) {
-
+                /** @var Tag $tag */
-    /**
+                foreach ($inheritTags as $tag) {
-     * Normalize the return tag (make full namespace, replace interfaces)
+                    $tag->setDocBlock();
-     *
+                    $phpdoc->appendTag($tag);
-     * @param DocBlock $phpdoc
+                }
-     */
+            }
-    protected function normalizeReturn(DocBlock $phpdoc)
+        }
-    {
+    }
-        //Get the return type and adjust them for beter autocomplete
+
-        $returnTags = $phpdoc->getTagsByName('return');
+    /**
-        if ($returnTags) {
+     * Normalize the parameters
-            /** @var ReturnTag $tag */
+     *
-            $tag = reset($returnTags);
+     * @param DocBlock $phpdoc
-            // Get the expanded type
+     */
-            $returnValue = $tag->getType();
+    protected function normalizeParams(DocBlock $phpdoc)
-
+    {
-            // Replace the interfaces
+        //Get the return type and adjust them for beter autocomplete
-            foreach($this->interfaces as $interface => $real){
+        $paramTags = $phpdoc->getTagsByName('param');
-                $returnValue = str_replace($interface, $real, $returnValue);
+        if ($paramTags) {
-            }
+            /** @var ParamTag $tag */
-
+            foreach ($paramTags as $tag) {
-            // Set the changed content
+                // Convert the keywords
-            $tag->setContent($returnValue . ' ' . $tag->getDescription());
+                $content = $this->convertKeywords($tag->getContent());
-            $this->return = $returnValue;
+                $tag->setContent($content);
-        }else{
+
-            $this->return = null;
+                // Get the expanded type and re-set the content
-        }
+                $content = $tag->getType() . ' ' . $tag->getVariableName() . ' ' . $tag->getDescription();
-    }
+                $tag->setContent(trim($content));
-
+            }
-    /**
+        }
-     * Convert keywwords that are incorrect.
+    }
-     *
+
-     * @param  string $string
+    /**
-     * @return string
+     * Normalize the return tag (make full namespace, replace interfaces)
-     */
+     *
-    protected function convertKeywords($string)
+     * @param DocBlock $phpdoc
-    {
+     */
-        $string = str_replace('\Closure', 'Closure', $string);
+    protected function normalizeReturn(DocBlock $phpdoc)
-        $string = str_replace('Closure', '\Closure', $string);
+    {
-        $string = str_replace('dynamic', 'mixed', $string);
+        //Get the return type and adjust them for beter autocomplete
-
+        $returnTags = $phpdoc->getTagsByName('return');
-        return $string;
+        if ($returnTags) {
-    }
+            /** @var ReturnTag $tag */
-
+            $tag = reset($returnTags);
-    /**
+            // Get the expanded type
-     * Should the function return a value?
+            $returnValue = $tag->getType();
-     *
+
-     * @return bool
+            // Replace the interfaces
-     */
+            foreach ($this->interfaces as $interface => $real) {
-    public function shouldReturn()
+                $returnValue = str_replace($interface, $real, $returnValue);
-    {
+            }
-        if($this->return !== "void" && $this->method->name !== "__construct"){
+
-            return true;
+            // Set the changed content
-        }
+            $tag->setContent($returnValue . ' ' . $tag->getDescription());
-
+            $this->return = $returnValue;
-        return false;
+        } else {
-    }
+            $this->return = null;
-
+        }
-    /**
+    }
-     * Get the parameters and format them correctly
+
-     *
+    /**
-     * @param $method
+     * Convert keywwords that are incorrect.
-     * @return array
+     *
-     */
+     * @param  string $string
-    public function getParameters($method)
+     * @return string
-    {
+     */
-        //Loop through the default values for paremeters, and make the correct output string
+    protected function convertKeywords($string)
-        $params = array();
+    {
-        $paramsWithDefault = array();
+        $string = str_replace('\Closure', 'Closure', $string);
-        foreach ($method->getParameters() as $param) {
+        $string = str_replace('Closure', '\Closure', $string);
-            $paramStr = '$' . $param->getName();
+        $string = str_replace('dynamic', 'mixed', $string);
-            $params[] = $paramStr;
+
-            if ($param->isOptional()) {
+        return $string;
-                $default = $param->getDefaultValue();
+    }
-                if (is_bool($default)) {
+
-                    $default = $default ? 'true' : 'false';
+    /**
-                } elseif (is_array($default)) {
+     * Should the function return a value?
-                    $default = 'array()';
+     *
-                } elseif (is_null($default)) {
+     * @return bool
-                    $default = 'null';
+     */
-                } elseif (is_int($default)) {
+    public function shouldReturn()
-                    //$default = $default;
+    {
-                } else {
+        if ($this->return !== "void" && $this->method->name !== "__construct") {
-                    $default = "'" . trim($default) . "'";
+            return true;
-                }
+        }
-                $paramStr .= " = $default";
+
-            }
+        return false;
-            $paramsWithDefault[] = $paramStr;
+    }
-        }
+
-
+    /**
-        $this->params = $params;
+     * Get the parameters and format them correctly
-        $this->params_with_default = $paramsWithDefault;
+     *
-    }
+     * @param  \ReflectionMethod $method
-
+     * @return array
-    /**
+     */
-     * @param \ReflectionMethod $reflectionMethod
+    public function getParameters($method)
-     * @return DocBlock
+    {
-     */
+        //Loop through the default values for paremeters, and make the correct output string
-    protected function getInheritDoc($reflectionMethod)
+        $params = array();
-    {
+        $paramsWithDefault = array();
-        $parentClass = $reflectionMethod->getDeclaringClass()->getParentClass();
+        foreach ($method->getParameters() as $param) {
-
+            $paramStr = '$' . $param->getName();
-        //Get either a parent or the interface
+            $params[] = $paramStr;
-        if ($parentClass) {
+            if ($param->isOptional()) {
-            $method = $parentClass->getMethod($reflectionMethod->getName());
+                $default = $param->isDefaultValueAvailable() ? $param->getDefaultValue() : null;
-        } else {
+                if (is_bool($default)) {
-            $method = $reflectionMethod->getPrototype();
+                    $default = $default ? 'true' : 'false';
-        }
+                } elseif (is_array($default)) {
-        if ($method) {
+                    $default = 'array()';
-            $namespace = $method->getDeclaringClass()->getNamespaceName();
+                } elseif (is_null($default)) {
-            $phpdoc = new DocBlock($method, new Context($namespace));
+                    $default = 'null';
-            
+                } elseif (is_int($default)) {
-            if (strpos($phpdoc->getText(), '{@inheritdoc}') !== false) {
+                    //$default = $default;
-                //Not at the end yet, try another parent/interface..
+                } elseif (is_resource($default)) {
-                return $this->getInheritDoc($method);
+                    //skip to not fail
-            } else {
+                } else {
-                return $phpdoc;
+                    $default = "'" . trim($default) . "'";
-            }
+                }
-        }
+                $paramStr .= " = $default";
-    }
+            }
-}
+            $paramsWithDefault[] = $paramStr;
+        }
+
+        $this->params = $params;
+        $this->params_with_default = $paramsWithDefault;
+    }
+
+    /**
+     * @param \ReflectionMethod $reflectionMethod
+     * @return DocBlock
+     */
+    protected function getInheritDoc($reflectionMethod)
+    {
+        $parentClass = $reflectionMethod->getDeclaringClass()->getParentClass();
+
+        //Get either a parent or the interface
+        if ($parentClass) {
+            $method = $parentClass->getMethod($reflectionMethod->getName());
+        } else {
+            $method = $reflectionMethod->getPrototype();
+        }
+        if ($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);
+            } else {
+                return $phpdoc;
+            }
+        }
+    }
+}

src/config/config.php

@@ -1,90 +0,0 @@
-<?php
-
-return array(
-
-    /*
-    |--------------------------------------------------------------------------
-    | Filename & Format
-    |--------------------------------------------------------------------------
-    |
-    | The default filename (without extension) and the format (php or json)
-    |
-    */
-
-    'filename'  => '_ide_helper',
-    'format'    => 'php',
-
-    /*
-    |--------------------------------------------------------------------------
-    | Helper files to include
-    |--------------------------------------------------------------------------
-    |
-    | Include helper files. By default not included, but can be toggled with the
-    | -- helpers (-H) option. Extra helper files can be included.
-    |
-    */
-
-    'include_helpers' => false,
-
-    'helper_files' => array(
-        base_path().'/vendor/laravel/framework/src/Illuminate/Support/helpers.php',
-    ),
-
-    /*
-    |--------------------------------------------------------------------------
-    | Model locations to include
-    |--------------------------------------------------------------------------
-    |
-    | Define in which directories the ide-helper:models command should look
-    | for models.
-    |
-    */
-
-    'model_locations' => array(
-        'app/models',
-    ),
-
-
-    /*
-    |--------------------------------------------------------------------------
-    | Extra classes
-    |--------------------------------------------------------------------------
-    |
-    | These implementations are not really extended, but called with magic functions
-    |
-    */
-
-    'extra' => array(
-        'Artisan' => array('Illuminate\Foundation\Artisan'),
-        'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
-        'Session' => array('Illuminate\Session\Store'),
-    ),
-
-    'magic' => array(
-        'Log' => array(
-            'debug'     => 'Monolog\Logger::addDebug',
-            'info'      => 'Monolog\Logger::addInfo',
-            'notice'    => 'Monolog\Logger::addNotice',
-            'warning'   => 'Monolog\Logger::addWarning',
-            'error'     => 'Monolog\Logger::addError',
-            'critical'  => 'Monolog\Logger::addCritical',
-            'alert'     => 'Monolog\Logger::addAlert',
-            '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',
-    )
-
-);

src/views/ide-helper.php

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

tests/MethodTest.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace Barryvdh\LaravelIdeHelper;
+
+class ExampleTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * Test that we can actually instantiate the class
+     */
+    public function testCanInstantiate()
+    {
+        $reflectionClass = new \ReflectionClass(ExampleClass::class);
+        $reflectionMethod = $reflectionClass->getMethod('setName');
+
+        $method = new Method($reflectionMethod, 'Example', $reflectionClass);
+
+        $this->assertInstanceOf(Method::class, $method);
+    }
+
+    /**
+     * Test the output of a class
+     */
+    public function testOutput()
+    {
+        $reflectionClass = new \ReflectionClass(ExampleClass::class);
+        $reflectionMethod = $reflectionClass->getMethod('setName');
+
+        $method = new Method($reflectionMethod, 'Example', $reflectionClass);
+
+        $output = '/**
+ * 
+ *
+ * @param string $last
+ * @param string $first
+ * @static 
+ */';
+        $this->assertEquals($output, $method->getDocComment(''));
+        $this->assertEquals('setName', $method->getName());
+        $this->assertEquals('\\'.ExampleClass::class, $method->getDeclaringClass());
+        $this->assertEquals('$last, $first', $method->getParams(true));
+        $this->assertEquals(['$last', '$first'], $method->getParams(false));
+        $this->assertEquals('$last, $first = \'Barry\'', $method->getParamsWithDefault(true));
+        $this->assertEquals(['$last', '$first = \'Barry\''], $method->getParamsWithDefault(false));
+        $this->assertEquals(true, $method->shouldReturn());
+    }
+}
+
+class ExampleClass
+{
+    /**
+     * @param string $last
+     * @param string $first
+     */
+    public function setName($last, $first = 'Barry')
+    {
+        return;
+    }
+}