Compare commits

...
60 Commits
Author SHA1 Message Date
Barry vd. Heuvel a9484c67d1 Merge branch 'master' of github.com:barryvdh/laravel-ide-helper 2016-06-13 21:36:24 +02:00
Barry vd. Heuvel 3064296216 Use fork of reflection docblock 2016-06-13 21:35:48 +02:00
Barry vd. Heuvel f057a4f820 Merge pull request #351 from ferdiunal/patch-1
Laravel 5.2.* composer.json file
2016-06-08 22:28:01 +02:00
Barry vd. Heuvel 091f78508c Add cache 2016-06-08 22:23:10 +02:00
Barry vd. Heuvel cf4fcd810c Prefest dist installs 2016-06-08 22:20:46 +02:00
Barry vd. Heuvel d3203de671 Remove other badges 2016-06-08 22:12:12 +02:00
Barry vd. Heuvel 093171e01f Update badges/licence 2016-06-08 22:11:14 +02:00
Barry vd. Heuvel 2d82419167 Test method output 2016-06-08 22:06:05 +02:00
Barry vd. Heuvel 0e84805e37 Update gitignore 2016-06-08 21:39:39 +02:00
Barry vd. Heuvel 7a07515149 Remove build dir 2016-06-08 21:39:24 +02:00
Barry vd. Heuvel bae462604e Add test config, CS rules and fix CS 2016-06-08 21:36:25 +02:00
Ferdi ÜNAL b28c8cbae1 Laravel 5.2.* composer.json file 2016-05-26 14:43:33 +03:00
Barry vd. Heuvel d734ecabcc Merge pull request #350 from Kurre/hasManyThrough-relationship
Add hasManyThrough relationship
2016-05-25 11:51:22 +02:00
Tommi Finnilä 4f227d5c57 Add hasManyThrough relationship 2016-05-25 09:28:34 +01:00
Barry vd. Heuvel 35ebf3a2ba Merge pull request #338 from cnanney/patch-1
Look for additional facade aliases in app config array
2016-05-12 07:32:54 +02:00
Barry vd. Heuvel f7b31bdbdc Merge pull request #345 from alexbowers/patch-1
Support Laravel 5.3.x (beta)
2016-05-01 09:29:05 +02:00
Alex Bowers 8de1673535 Update composer.json 2016-05-01 00:08:49 +01:00
Chris Nanney d818b72f82 Look for additional facade aliases in app config array
In my Lumen app, I load my providers and aliases from a `config/app.php` file like in Laravel. Maybe that is uncommon, but this simple PR will include those aliases as well if any are present.
2016-03-29 14:56:12 -05:00
Barry vd. Heuvel e97ed532f0 Merge pull request #327 from vedmant/master
Added support for default storage driver shortcuts, eg. Storage::exists('file.jpg');
2016-03-03 15:38:04 +01:00
Vedmant 606183ea12 Added support for default storage driver shortcuts, eg. Storage::exists('file.jpg'); 2016-03-03 16:33:28 +02:00
Barry vd. Heuvel f1ebd847aa Check on actual model, not facade
Fixes #311
2016-03-03 09:45:00 +01:00
Barry vd. Heuvel 83597196f9 Prevent double mixin tags 2016-03-03 09:43:49 +01:00
Barry vd. Heuvel 19553f63e4 Update composer.json 2016-03-02 11:03:09 +01:00
Barry vd. Heuvel f50470ba49 Add morphOne, fix morphTo
Fixes #236 thanks to @boxfrommars
2016-03-02 10:54:41 +01:00
Barry vd. Heuvel 7762e07f0a Use new provider config
Fixes #274, #324
2016-03-02 10:47:25 +01:00
Barry vd. Heuvel 467b5f5b5f Always add whereColumn
Fixes #300, #325
2016-03-02 10:42:37 +01:00
Barry vd. Heuvel c213be3d3c Merge pull request #305 from matiaspub/patch-1
Add extend \Eloquent for ide-helper:models command
2016-03-02 10:39:21 +01:00
Barry vd. Heuvel 4b8ba85b34 Merge pull request #315 from icedfish/ignore_exception
Ignore abstract class or interface, not throw exception
2016-01-28 09:19:58 +01:00
Barry vd. Heuvel d4c0ae5851 Merge pull request #314 from icedfish/recover-helper-function
recover model's whereXXX() helper function
2016-01-28 07:21:05 +01:00
Yu Bing 3a01e351de Ignore abstract class or interface, not throw exception 2016-01-28 11:37:08 +08:00
Yu Bing add34665a8 fix typo 2016-01-28 11:20:48 +08:00
Yu Bing c77752bb58 recover model's whereXXX() helper function 2016-01-28 11:18:42 +08:00
Barry vd. Heuvel aa8f772a46 Merge pull request #310 from naerymdan/master
Add support for Lumen 5.0, 5.1 and 5.2+
2016-01-22 14:33:15 +01:00
Vincent Labreche 0c4c55f349 Add support for Lumen 5.0, 5.1 and 5.2+ 2016-01-22 08:30:36 -05:00
Barry vd. Heuvel ed972acf19 Merge pull request #308 from barryvdh/revert-303-master
Revert "Don't use force aliases loading"
2016-01-21 15:55:37 +01:00
Barry vd. Heuvel 60e642e881 Revert "Don't use force aliases loading" 2016-01-21 15:55:29 +01:00
Sergius 4069863d0c Add extend \Eloquent for ide-helper:models command
It's help author to close many issues! )
Like: #269, #259, #248, #209, #191, #74, 
and https://github.com/laravel/framework/issues/7558 )))
etc. maybe
2016-01-12 15:33:05 +02:00
Barry vd. Heuvel da05897cb7 Merge pull request #303 from dkulyk/master
Don't use force aliases loading
2016-01-11 13:00:09 +01:00
Dmytro Kulyk 74bac1a4e9 Don't use force aliases loading
Another autoloader throw exception if aliases not exists.
2016-01-11 13:45:41 +02:00
Barry vd. Heuvel 33cee80609 Merge pull request #302 from Propaganistas/patch-1
Fix Auth driver detection in Laravel 5.2
2016-01-08 18:03:38 +01:00
Propaganistas dee3878566 Fix Auth driver detection in Laravel 5.2 2016-01-06 20:31:08 +01:00
Barry vd. Heuvel eb5736a7bd Merge pull request #298 from onigoetz/patch-1
Allow symfony/class-loader 3.0 to be installed
2016-01-03 11:48:37 +01:00
Stéphane Goetz cc794a2fba Allow symfony/class-loader 3.0 to be installed 2016-01-03 11:25:12 +01:00
Barry vd. Heuvel d82e8f191f Fix meta for 5.2 seeder
Fixes #287
2015-12-21 20:48:06 +01:00
Barry vd. Heuvel 5497e7d506 Merge pull request #294 from bytestream/master
Fixes #293
2015-12-14 14:33:18 +01:00
Kieran 2f83db311f Fixes #293 2015-12-14 13:29:24 +00:00
Barry vd. Heuvel d56bbb2356 Merge pull request #290 from nikolay-zakharov/dev-resource-fails
Fixed: fails to generate with resources
2015-12-11 15:38:48 +01:00
Nikolay Zakharov 2fb1135fc5 Fixed: fails to generate with resources 2015-12-11 17:18:14 +03:00
Barry vd. Heuvel aec17e3327 Update composer.json 2015-12-11 09:26:59 +01:00
Barry vd. Heuvel 0c560cb375 Merge pull request #288 from miraage/fix/models-command
fix(models-command): check for default reflectionparameter value
2015-12-07 08:55:26 +01:00
miraage 5708012a77 fix(models-command): check for default reflectionparameter value to prevent fail in variadic params 2015-12-06 13:49:27 +03:00
Barry vd. Heuvel af6d9a7fa1 Merge pull request #275 from Houbsi/master
Automatic phpDocs for models: added copy/past
2015-10-22 14:34:24 +02:00
Mike Houben f708b9a46c Automatic phpDocs for models: added copy/past
With this information it's much easier to install.
2015-10-22 14:31:54 +02:00
Barry vd. Heuvel e3de462538 Resolve user model at runtime
Fixes #274
2015-10-22 14:26:11 +02:00
Barry vd. Heuvel 76f09aaa65 Remove magic where 2015-10-19 09:32:38 +02:00
Barry vd. Heuvel 56f89502e3 Tweak relation object
Tweaks #273
2015-10-19 09:31:08 +02:00
Barry vd. Heuvel 11037acfe6 Merge pull request #273 from klaude/custom-collection-support
Add custom collection support
2015-10-19 09:30:05 +02:00
Kevin Laude e48974e545 Add custom collection support
Add support for models that override Eloquent's newCollection() with a
custom collection type. Do this by executing the relationship on the
model then executing that relationship's newCollection() method to see
what type of colletion class is returned.

Remove the now-unused
Barryvdh\LaravelIdeHelper\Console\ModelsCommand::getClassName() method.
2015-10-18 20:54:25 -05:00
Barry vd. Heuvel 38a97cf07c Swap facade/alias
See #202
2015-08-18 10:57:06 +02:00
Barry vd. Heuvel 74ee804dde Update readme 2015-08-14 09:50:36 +02:00
19 changed files with 1311 additions and 995 deletions
+15
View File
@@ -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
+10
View File
@@ -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
+2 -1
View File
@@ -1,3 +1,4 @@
/vendor build
vendor
composer.lock composer.lock
.idea .idea
+23
View File
@@ -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
+1
View File
@@ -0,0 +1 @@
preset: psr2
+31
View File
@@ -0,0 +1,31 @@
language: php
php:
- 5.5
- 5.6
- 7.0
- hhvm
# 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: 5.5
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 --coverage-text --coverage-clover=coverage.clover
after_script:
- if [[ $TRAVIS_PHP_VERSION != 'hhvm' && $TRAVIS_PHP_VERSION != '7.0' ]]; then php vendor/bin/ocular code-coverage:upload --format=php-clover coverage.clover; fi
+21
View File
@@ -0,0 +1,21 @@
# The MIT License (MIT)
Copyright (c) 2016 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.
+17 -5
View File
@@ -11,13 +11,16 @@
], ],
"require": { "require": {
"php": ">=5.4.0", "php": ">=5.4.0",
"illuminate/support": "5.0.x|5.1.x", "illuminate/support": "^5.0,<5.4",
"illuminate/console": "5.0.x|5.1.x", "illuminate/console": "^5.0,<5.4",
"illuminate/filesystem": "5.0.x|5.1.x", "illuminate/filesystem": "^5.0,<5.4",
"phpdocumentor/reflection-docblock": "2.0.4", "barryvdh/reflection-docblock": "^2.0.4",
"symfony/class-loader": "~2.3" "symfony/class-loader": "^2.3|^3.0"
}, },
"require-dev": { "require-dev": {
"phpunit/phpunit" : "4.*",
"scrutinizer/ocular": "~1.1",
"squizlabs/php_codesniffer": "~2.3",
"doctrine/dbal": "~2.3" "doctrine/dbal": "~2.3"
}, },
"suggest": { "suggest": {
@@ -28,6 +31,15 @@
"Barryvdh\\LaravelIdeHelper\\": "src" "Barryvdh\\LaravelIdeHelper\\": "src"
} }
}, },
"autoload-dev": {
"psr-4": {
":vendor\\:package_name\\": "tests"
}
},
"scripts": {
"test": "phpunit",
"cs": "phpcs --standard=psr2 src/"
},
"extra": { "extra": {
"branch-alias": { "branch-alias": {
"dev-master": "2.1-dev" "dev-master": "2.1-dev"
+1 -1
View File
@@ -83,7 +83,7 @@ return array(
*/ */
'interfaces' => array( 'interfaces' => array(
'\Illuminate\Contracts\Auth\Authenticatable' => config('auth.model', 'App\User'),
), ),
/* /*
+29
View File
@@ -0,0 +1,29 @@
<?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=":vendor Test Suite">
<directory>tests</directory>
</testsuite>
</testsuites>
<filter>
<whitelist>
<directory suffix=".php">src/</directory>
</whitelist>
</filter>
<logging>
<log type="tap" target="build/report.tap"/>
<log type="junit" target="build/report.junit.xml"/>
<log type="coverage-html" target="build/coverage" charset="UTF-8" yui="true" highlight="true"/>
<log type="coverage-text" target="build/coverage.txt"/>
<log type="coverage-clover" target="build/logs/clover.xml"/>
</logging>
</phpunit>
+107 -50
View File
@@ -1,12 +1,20 @@
## Laravel 5 IDE Helper Generator ## Laravel 5 IDE Helper Generator
[![Latest Stable Version](https://poser.pugx.org/barryvdh/laravel-ide-helper/version.png)](https://packagist.org/packages/barryvdh/laravel-ide-helper) [![Total Downloads](https://poser.pugx.org/barryvdh/laravel-ide-helper/d/total.png)](https://packagist.org/packages/barryvdh/laravel-ide-helper)
### For Laravel 4.x, check [version 1.11](https://github.com/barryvdh/laravel-ide-helper/tree/1.11) [![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 ### 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!_ _Checkout [this Laracasts video](https://laracasts.com/series/how-to-be-awesome-in-phpstorm/episodes/15) for a quick introduction/explanation!_
* [`php artisan ide-helper:generate` - phpDoc generation for Laravel Facades ](#automatic-phpdoc-generation-for-laravel-facades)
* [`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)
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. 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). 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).
@@ -16,55 +24,49 @@ If you don't want to generate it, you can add a pre-generated file to the root f
Note: You do need CodeIntel for Sublime Text: https://github.com/SublimeCodeIntel/SublimeCodeIntel Note: You do need CodeIntel for Sublime Text: https://github.com/SublimeCodeIntel/SublimeCodeIntel
### New: PhpStorm Meta for Container instances ### Install
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.
php artisan ide-helper:meta
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).
### Automatic phpDoc generation for Laravel Facades
Require this package with composer using the following command: Require this package with composer using the following command:
composer require barryvdh/laravel-ide-helper ```bash
composer require barryvdh/laravel-ide-helper
```
After updating composer, add the service provider to the `providers` array in `config/app.php` After updating composer, add the service provider to the `providers` array in `config/app.php`
Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class, ```php
Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class,
```
### Automatic phpDoc generation for Laravel Facades
You can now re-generate the docs yourself (for future updates) You can now re-generate the docs yourself (for future updates)
php artisan ide-helper:generate ```bash
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). 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: 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",
}, "php artisan optimize"
]
},
```
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 vendor:publish --provider="Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider" --tag=config ```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. The generator tries to identify the real class, but if it cannot be found, you can define it in the config file.
@@ -78,43 +80,98 @@ The `Illuminate/Support/helpers.php` is already set-up, but you can add/remove y
> You need to require `doctrine/dbal: ~2.3` in your own composer.json to get database columns. > You need to require `doctrine/dbal: ~2.3` in your own composer.json to get database columns.
```bash
composer require doctrine/dbal
```
If you don't want to write your properties yourself, you can use the command `php artisan ide-helper:models` to generate 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)`. 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. 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. 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, and 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 \Carbon\Carbon $created_at
* @property-read \User $author * @property \Carbon\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="path/to/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 vendor:publish`) and set the default directories. You can publish the config file (`php artisan vendor:publish`) and set the default directories.
Models can be ignored using the `--ignore (-I)` option Models can be ignored using the `--ignore (-I)` option
php artisan ide-helper:models --ignore="Post,User" ```bash
php artisan ide-helper:models --ignore="Post,User"
```
Note: With namespaces, wrap your model name in " signs: `php artisan ide-helper:models "API\User"`, or escape the slashes (`Api\\User`) Note: With namespaces, wrap your model name in " signs: `php artisan ide-helper:models "API\User"`, or escape the slashes (`Api\\User`)
## 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).
### License ### License
The Laravel IDE Helper Generator is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT) 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
+293 -284
View File
@@ -1,284 +1,293 @@
<?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 class Alias
{ {
protected $alias; protected $alias;
protected $facade; protected $facade;
protected $extends = null; protected $extends = null;
protected $classType = 'class'; protected $classType = 'class';
protected $short; protected $short;
protected $namespace = '__root'; protected $namespace = '__root';
protected $root = null; protected $root = null;
protected $classes = array(); protected $classes = array();
protected $methods = array(); protected $methods = array();
protected $usedMethods = array(); protected $usedMethods = array();
protected $valid = false; protected $valid = false;
protected $magicMethods = array(); protected $magicMethods = array();
protected $interfaces = array(); protected $interfaces = array();
/** /**
* @param string $alias * @param string $alias
* @param string $facade * @param string $facade
* @param array $magicMethods * @param array $magicMethods
* @param array $interfaces * @param array $interfaces
*/ */
public function __construct($alias, $facade, $magicMethods = array(), $interfaces = array()) public function __construct($alias, $facade, $magicMethods = array(), $interfaces = array())
{ {
$this->alias = $alias; $this->alias = $alias;
$this->magicMethods = $magicMethods; $this->magicMethods = $magicMethods;
$this->interfaces = $interfaces; $this->interfaces = $interfaces;
// Make the class absolute // Make the class absolute
$facade = '\\' . ltrim($facade, '\\'); $facade = '\\' . ltrim($facade, '\\');
$this->facade = $facade; $this->facade = $facade;
$this->detectRoot(); $this->detectRoot();
if ((!$this->isTrait() && $this->root)) { if ((!$this->isTrait() && $this->root)) {
$this->valid = true; $this->valid = true;
} else { } else {
return; return;
} }
$this->addClass($this->root); $this->addClass($this->root);
$this->detectNamespace(); $this->detectNamespace();
$this->detectClassType(); $this->detectClassType();
if($facade === '\Illuminate\Database\Eloquent\Model'){ if ($facade === '\Illuminate\Database\Eloquent\Model') {
$this->usedMethods = array('decrement', 'increment'); $this->usedMethods = array('decrement', 'increment');
} }
} }
/** /**
* Add one or more classes to analyze * Add one or more classes to analyze
* *
* @param array|string $classes * @param array|string $classes
*/ */
public function addClass($classes) public function addClass($classes)
{ {
$classes = (array)$classes; $classes = (array)$classes;
foreach ($classes as $class) { foreach ($classes as $class) {
if (class_exists($class) || interface_exists($class)) { if (class_exists($class) || interface_exists($class)) {
$this->classes[] = $class; $this->classes[] = $class;
}else{ } else {
echo "Class not exists: $class\r\n"; echo "Class not exists: $class\r\n";
} }
} }
} }
/** /**
* Check if this class is valid to process. * Check if this class is valid to process.
* @return bool * @return bool
*/ */
public function isValid() public function isValid()
{ {
return $this->valid; return $this->valid;
} }
/** /**
* Get the classtype, 'interface' or 'class' * Get the classtype, 'interface' or 'class'
* *
* @return string * @return string
*/ */
public function getClasstype() public function getClasstype()
{ {
return $this->classType; return $this->classType;
} }
/** /**
* Get the class which this alias extends * Get the class which this alias extends
* *
* @return null|string * @return null|string
*/ */
public function getExtends() public function getExtends()
{ {
return $this->extends; return $this->extends;
} }
/** /**
* Get the Alias by which this class is called * Get the Alias by which this class is called
* *
* @return string * @return string
*/ */
public function getAlias() public function getAlias()
{ {
return $this->alias; return $this->alias;
} }
/** /**
* Return the short name (without namespace) * Return the short name (without namespace)
*/ */
public function getShortName(){ public function getShortName()
return $this->short; {
} return $this->short;
/** }
* Get the namespace from the alias /**
* * Get the namespace from the alias
* @return string *
*/ * @return string
public function getNamespace() */
{ public function getNamespace()
return $this->namespace; {
} return $this->namespace;
}
/**
* Get the methods found by this Alias /**
* * Get the methods found by this Alias
* @return array *
*/ * @return array
public function getMethods() */
{ public function getMethods()
$this->addMagicMethods(); {
$this->detectMethods(); $this->addMagicMethods();
return $this->methods; $this->detectMethods();
} return $this->methods;
}
/**
* Detect the namespace /**
*/ * Detect the namespace
protected function detectNamespace() */
{ protected function detectNamespace()
if (strpos($this->alias, '\\')) { {
$nsParts = explode('\\', $this->alias); if (strpos($this->alias, '\\')) {
$this->short = array_pop($nsParts); $nsParts = explode('\\', $this->alias);
$this->namespace = implode('\\', $nsParts); $this->short = array_pop($nsParts);
}else{ $this->namespace = implode('\\', $nsParts);
$this->short = $this->alias; } else {
} $this->short = $this->alias;
} }
}
/**
* Detect the class type /**
*/ * Detect the class type
protected function detectClassType() */
{ protected function detectClassType()
//Some classes extend the facade {
if (interface_exists($this->facade)) { //Some classes extend the facade
$this->classType = 'interface'; if (interface_exists($this->facade)) {
$this->extends = $this->facade; $this->classType = 'interface';
} else { $this->extends = $this->facade;
$this->classType = 'class'; } else {
if (class_exists($this->facade)) { $this->classType = 'class';
$this->extends = $this->facade; if (class_exists($this->facade)) {
} $this->extends = $this->facade;
} }
} }
}
/**
* Get the real root of a facade /**
* * Get the real root of a facade
* @return bool|string *
*/ * @return bool|string
protected function detectRoot() */
{ protected function detectRoot()
$facade = $this->facade; {
$facade = $this->facade;
try {
//If possible, get the facade root try {
if (method_exists($facade, 'getFacadeRoot')) { //If possible, get the facade root
$root = get_class($facade::getFacadeRoot()); if (method_exists($facade, 'getFacadeRoot')) {
} else { $root = get_class($facade::getFacadeRoot());
$root = $facade; } else {
} $root = $facade;
}
//If it doesn't exist, skip it
if (!class_exists($root) && !interface_exists($root)) { //If it doesn't exist, skip it
return; if (!class_exists($root) && !interface_exists($root)) {
} return;
}
$this->root = $root;
$this->root = $root;
//When the database connection is not set, some classes will be skipped
} catch (\PDOException $e) { //When the database connection is not set, some classes will be skipped
$this->error( } catch (\PDOException $e) {
"PDOException: " . $e->getMessage() . "\nPlease configure your database connection correctly, or use the sqlite memory driver (-M). Skipping $facade." $this->error(
); "PDOException: " . $e->getMessage() .
} catch (\Exception $e) { "\nPlease configure your database connection correctly, or use the sqlite memory driver (-M)." .
$this->error("Exception: " . $e->getMessage() . "\nSkipping $facade."); " Skipping $facade."
} );
} } catch (\Exception $e) {
$this->error("Exception: " . $e->getMessage() . "\nSkipping $facade.");
/** }
* Detect if this class is a trait or not. }
*
* @return bool /**
*/ * Detect if this class is a trait or not.
protected function isTrait() *
{ * @return bool
// Check if the facade is not a Trait */
if (function_exists('trait_exists') && trait_exists($this->facade)) { protected function isTrait()
return true; {
} // Check if the facade is not a Trait
return false; 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() /**
{ * Add magic methods, as defined in the configuration files
foreach($this->magicMethods as $magic => $real){ */
list($className, $name) = explode('::', $real); protected function addMagicMethods()
if(!class_exists($className) && !interface_exists($className)){ {
continue; foreach ($this->magicMethods as $magic => $real) {
} list($className, $name) = explode('::', $real);
$method = new \ReflectionMethod($className, $name); if (!class_exists($className) && !interface_exists($className)) {
$class = new \ReflectionClass($className); continue;
}
if(!in_array($method->name, $this->usedMethods)){ $method = new \ReflectionMethod($className, $name);
if($class !== $this->root){ $class = new \ReflectionClass($className);
$this->methods[] = new Method($method, $this->alias, $class, $magic, $this->interfaces);
} if (!in_array($method->name, $this->usedMethods)) {
$this->usedMethods[] = $magic; 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 /**
*/ * Get the methods for one or multiple classes.
protected function detectMethods() *
{ * @return string
*/
foreach ($this->classes as $class) { protected function detectMethods()
$reflection = new \ReflectionClass($class); {
$methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC); foreach ($this->classes as $class) {
if ($methods) { $reflection = new \ReflectionClass($class);
foreach ($methods as $method) {
if (!in_array($method->name, $this->usedMethods)) { $methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
// Only add the methods to the output when the root is not the same as the class. if ($methods) {
// And don't add the __*() methods foreach ($methods as $method) {
if ($this->extends !== $class && substr($method->name, 0, 2) !== '__') { if (!in_array($method->name, $this->usedMethods)) {
$this->methods[] = new Method($method, $this->alias, $reflection, $method->name, $this->interfaces); // Only add the methods to the output when the root is not the same as the class.
} // And don't add the __*() methods
$this->usedMethods[] = $method->name; if ($this->extends !== $class && substr($method->name, 0, 2) !== '__') {
} $this->methods[] = new Method(
} $method,
} $this->alias,
} $reflection,
} $method->name,
$this->interfaces
/** );
* Output an error. }
* $this->usedMethods[] = $method->name;
* @param string $string }
* @return void }
*/ }
protected function error($string) }
{ }
echo $string . "\r\n";
} /**
} * Output an error.
*
* @param string $string
* @return void
*/
protected function error($string)
{
echo $string . "\r\n";
}
}
+2 -3
View File
@@ -17,7 +17,6 @@ use Illuminate\Filesystem\Filesystem;
use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputArgument;
/** /**
* A command to generate autocomplete information for your IDE * A command to generate autocomplete information for your IDE
* *
@@ -60,7 +59,8 @@ class GeneratorCommand extends Command
*/ */
public function __construct( public function __construct(
/*ConfigRepository */ $config, /*ConfigRepository */ $config,
Filesystem $files, /* Illuminate\View\Factory */ Filesystem $files,
/* Illuminate\View\Factory */
$view $view
) { ) {
$this->config = $config; $this->config = $config;
@@ -166,5 +166,4 @@ class GeneratorCommand extends Command
array('sublime', "S", InputOption::VALUE_NONE, 'DEPRECATED: Use different style for SublimeText CodeIntel'), array('sublime', "S", InputOption::VALUE_NONE, 'DEPRECATED: Use different style for SublimeText CodeIntel'),
); );
} }
} }
+8 -6
View File
@@ -19,7 +19,8 @@ use Symfony\Component\Console\Output\OutputInterface;
* *
* @author Barry vd. Heuvel <[email protected]> * @author Barry vd. Heuvel <[email protected]>
*/ */
class MetaCommand extends Command { class MetaCommand extends Command
{
/** /**
* The console command name. * The console command name.
@@ -54,7 +55,8 @@ class MetaCommand extends Command {
* @param \Illuminate\Contracts\Filesystem\Filesystem $files * @param \Illuminate\Contracts\Filesystem\Filesystem $files
* @param \Illuminate\Contracts\View\Factory $view * @param \Illuminate\Contracts\View\Factory $view
*/ */
public function __construct($files, $view) { public function __construct($files, $view)
{
$this->files = $files; $this->files = $files;
$this->view = $view; $this->view = $view;
parent::__construct(); parent::__construct();
@@ -71,8 +73,8 @@ class MetaCommand extends Command {
$bindings = array(); $bindings = array();
foreach ($this->getAbstracts() as $abstract) { foreach ($this->getAbstracts() as $abstract) {
// Validator causes problems in Lumen // Validator and seeder cause problems
if ($abstract == 'validator') { if (in_array($abstract, ['validator', 'seeder'])) {
continue; continue;
} }
@@ -81,7 +83,7 @@ class MetaCommand extends Command {
if (is_object($concrete)) { if (is_object($concrete)) {
$bindings[$abstract] = get_class($concrete); $bindings[$abstract] = get_class($concrete);
} }
}catch (\Exception $e) { } catch (\Exception $e) {
if ($this->output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) { if ($this->output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
$this->comment("Cannot make '$abstract': ".$e->getMessage()); $this->comment("Cannot make '$abstract': ".$e->getMessage());
} }
@@ -105,7 +107,7 @@ class MetaCommand extends Command {
/** /**
* Get a list of abstracts from the Laravel Application. * Get a list of abstracts from the Laravel Application.
* *
* @return array * @return array
*/ */
protected function getAbstracts() protected function getAbstracts()
+74 -57
View File
@@ -11,16 +11,17 @@
namespace Barryvdh\LaravelIdeHelper\Console; namespace Barryvdh\LaravelIdeHelper\Console;
use Illuminate\Console\Command; use Illuminate\Console\Command;
use Illuminate\Database\Eloquent\Relations\Relation;
use Illuminate\Support\Str; use Illuminate\Support\Str;
use Illuminate\Filesystem\Filesystem; use Illuminate\Filesystem\Filesystem;
use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\ClassLoader\ClassMapGenerator; use Symfony\Component\ClassLoader\ClassMapGenerator;
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 * A command to generate autocomplete information for your IDE
@@ -112,7 +113,7 @@ class ModelsCommand extends Command
protected function getArguments() protected function getArguments()
{ {
return array( 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()),
); );
} }
@@ -124,12 +125,12 @@ class ModelsCommand extends Command
protected function getOptions() protected function getOptions()
{ {
return array( 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('ignore', 'I', InputOption::VALUE_OPTIONAL, 'Which models to ignore', ''),
); );
} }
@@ -183,7 +184,8 @@ class ModelsCommand extends Command
} }
if (!$reflectionClass->IsInstantiable()) { if (!$reflectionClass->IsInstantiable()) {
throw new \Exception($name . ' is not instantiable.'); // ignore abstract class or interface
continue;
} }
$model = $this->laravel->make($name); $model = $this->laravel->make($name);
@@ -199,12 +201,12 @@ class ModelsCommand extends Command
$this->error("Exception: " . $e->getMessage() . "\nCould not analyze class $name."); $this->error("Exception: " . $e->getMessage() . "\nCould not analyze class $name.");
} }
} }
} }
if (!$hasDoctrine) { if (!$hasDoctrine) {
$this->error( $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`.'
); );
} }
@@ -307,9 +309,9 @@ class ModelsCommand extends Command
if ($methods) { if ($methods) {
foreach ($methods as $method) { foreach ($methods as $method) {
if (Str::startsWith($method, 'get') && Str::endsWith( if (Str::startsWith($method, 'get') && Str::endsWith(
$method, $method,
'Attribute' 'Attribute'
) && $method !== 'getAttribute' ) && $method !== 'getAttribute'
) { ) {
//Magic get<name>Attribute //Magic get<name>Attribute
$name = Str::snake(substr($method, 3, -9)); $name = Str::snake(substr($method, 3, -9));
@@ -317,9 +319,9 @@ class ModelsCommand extends Command
$this->setProperty($name, null, true, null); $this->setProperty($name, null, true, null);
} }
} elseif (Str::startsWith($method, 'set') && Str::endsWith( } elseif (Str::startsWith($method, 'set') && Str::endsWith(
$method, $method,
'Attribute' 'Attribute'
) && $method !== 'setAttribute' ) && $method !== 'setAttribute'
) { ) {
//Magic set<name>Attribute //Magic set<name>Attribute
$name = Str::snake(substr($method, 3, -9)); $name = Str::snake(substr($method, 3, -9));
@@ -336,8 +338,9 @@ class ModelsCommand extends Command
array_shift($args); array_shift($args);
$this->setMethod($name, '\Illuminate\Database\Query\Builder|\\' . $reflection->class, $args); $this->setMethod($name, '\Illuminate\Database\Query\Builder|\\' . $reflection->class, $args);
} }
} elseif (!method_exists('Eloquent', $method) && !Str::startsWith($method, 'get')) { } elseif (!method_exists('Illuminate\Database\Eloquent\Model', $method)
&& !Str::startsWith($method, 'get')
) {
//Use reflection to inspect the code, based on Illuminate/Support/SerializableClosure.php //Use reflection to inspect the code, based on Illuminate/Support/SerializableClosure.php
$reflection = new \ReflectionMethod($model, $method); $reflection = new \ReflectionMethod($model, $method);
@@ -354,36 +357,44 @@ class ModelsCommand extends Command
$code = substr($code, $begin, strrpos($code, '}') - $begin + 1); $code = substr($code, $begin, strrpos($code, '}') - $begin + 1);
foreach (array( foreach (array(
'hasMany', 'hasMany',
'belongsToMany', 'hasManyThrough',
'hasOne', 'belongsToMany',
'belongsTo', 'hasOne',
'morphTo', 'belongsTo',
'morphMany', 'morphOne',
'morphToMany' 'morphTo',
'morphMany',
'morphToMany'
) as $relation) { ) as $relation) {
$search = '$this->' . $relation . '('; $search = '$this->' . $relation . '(';
if ($pos = stripos($code, $search)) { if ($pos = stripos($code, $search)) {
$code = substr($code, $pos + strlen($search)); //Resolve the relation's model to a Relation object.
$end = strpos($code, ')->') ?:strpos($code, ');'); $relationObj = $model->$method();
if (false !== $end) {
$arguments = substr($code, 0, $end); if ($relationObj instanceof Relation) {
$arguments = array_map(function($item) { $relatedModel = '\\' . get_class($relationObj->getRelated());
return trim($item, ' \'\"');
}, explode(',', $arguments)); $relations = ['hasManyThrough', 'belongsToMany', 'hasMany', 'morphMany', 'morphToMany'];
//Remove quotes, ensure 1 \ in front of the model if (in_array($relation, $relations)) {
$returnModel = $this->getClassName($arguments[0], $model);
if ($relation === "belongsToMany" or $relation === 'hasMany' or $relation === 'morphMany' or $relation === 'morphToMany') {
//Collection or array of models (because Collection is Arrayable) //Collection or array of models (because Collection is Arrayable)
$this->setProperty( $this->setProperty(
$method, $method,
'\Illuminate\Database\Eloquent\Collection|' . $returnModel . '[]', $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, true,
null null
); );
} else { } else {
//Single model is returned //Single model is returned
$this->setProperty($method, $returnModel, true, null); $this->setProperty($method, $relatedModel, true, null);
} }
} }
} }
@@ -400,7 +411,7 @@ class ModelsCommand extends Command
* @param bool|null $write * @param bool|null $write
* @param string|null $comment * @param string|null $comment
*/ */
protected function setProperty($name, $type = null, $read = null, $write = null, $comment='') protected function setProperty($name, $type = null, $read = null, $write = null, $comment = '')
{ {
if (!isset($this->properties[$name])) { if (!isset($this->properties[$name])) {
$this->properties[$name] = array(); $this->properties[$name] = array();
@@ -422,7 +433,9 @@ class ModelsCommand extends Command
protected function setMethod($name, $type = '', $arguments = array()) 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] = array();
$this->methods[$name]['type'] = $type; $this->methods[$name]['type'] = $type;
$this->methods[$name]['arguments'] = $arguments; $this->methods[$name]['arguments'] = $arguments;
@@ -488,6 +501,10 @@ class ModelsCommand extends Command
$phpdoc->appendTag($tag); $phpdoc->appendTag($tag);
} }
if ($this->write && ! $phpdoc->getTagsByName('mixin')) {
$phpdoc->appendTag(Tag::createInstance("@mixin \\Eloquent", $phpdoc));
}
$serializer = new DocBlockSerializer(); $serializer = new DocBlockSerializer();
$serializer->getDocComment($phpdoc); $serializer->getDocComment($phpdoc);
$docComment = $serializer->getDocComment($phpdoc); $docComment = $serializer->getDocComment($phpdoc);
@@ -511,7 +528,7 @@ class ModelsCommand extends Command
} }
} }
$output = "namespace {$namespace}{\n{$docComment}\n\tclass {$classname} {}\n}\n\n"; $output = "namespace {$namespace}{\n{$docComment}\n\tclass {$classname} extends \Eloquent {}\n}\n\n";
return $output; return $output;
} }
@@ -526,10 +543,11 @@ class ModelsCommand extends Command
//Loop through the default values for paremeters, and make the correct output string //Loop through the default values for paremeters, and make the correct output string
$params = array(); $params = array();
$paramsWithDefault = array(); $paramsWithDefault = array();
/** @var \ReflectionParameter $param */
foreach ($method->getParameters() as $param) { foreach ($method->getParameters() as $param) {
$paramStr = '$' . $param->getName(); $paramStr = '$' . $param->getName();
$params[] = $paramStr; $params[] = $paramStr;
if ($param->isOptional()) { if ($param->isOptional() && $param->isDefaultValueAvailable()) {
$default = $param->getDefaultValue(); $default = $param->getDefaultValue();
if (is_bool($default)) { if (is_bool($default)) {
$default = $default ? 'true' : 'false'; $default = $default ? 'true' : 'false';
@@ -550,23 +568,22 @@ class ModelsCommand extends Command
} }
/** /**
* Determine a model classes' collection type.
*
* @see http://laravel.com/docs/eloquent-collections#custom-collections
* @param string $className * @param string $className
* @param \Illuminate\Database\Eloquent\Model $model
* @return string * @return string
*/ */
private function getClassName($className, $model) private function getCollectionClass($className)
{ {
// If the class name was resolved via get_class($this) or static::class // Return something in the very very unlikely scenario the model doesn't
if (strpos($className, 'get_class($this)') !== false || strpos($className, 'static::class') !== false) { // have a newCollection() method.
return "\\" . get_class($model); if (!method_exists($className, 'newCollection')) {
return '\Illuminate\Database\Eloquent\Collection';
} }
// If the class name was resolved via ::class (PHP 5.5+) /** @var \Illuminate\Database\Eloquent\Model $model */
if (strpos($className, '::class') !== false) { $model = new $className;
$end = -1 * strlen('::class'); return '\\' . get_class($model->newCollection());
return substr($className, 0, $end);
}
return "\\" . ltrim(trim($className, " \"'"), "\\") ;
} }
} }
+302 -273
View File
@@ -1,273 +1,302 @@
<?php <?php
/** /**
* Laravel IDE Helper Generator * Laravel IDE Helper Generator
* *
* @author Barry vd. Heuvel <barryvdh@gmail.com> * @author Barry vd. Heuvel <barryvdh@gmail.com>
* @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\Config\Repository as ConfigRepository;
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('ide-helper.extra')); // Find the drivers to add to the extra/interfaces
$this->magic = array_merge($this->magic, $this->config->get('ide-helper.magic')); $this->detectDrivers();
$this->interfaces = array_merge($this->interfaces, $this->config->get('ide-helper.interfaces'));
// Make all interface classes absolute $this->extra = array_merge($this->extra, $this->config->get('ide-helper.extra'));
foreach ($this->interfaces as &$interface) { $this->magic = array_merge($this->magic, $this->config->get('ide-helper.magic'));
$interface = '\\' . ltrim($interface, '\\'); $this->interfaces = array_merge($this->interfaces, $this->config->get('ide-helper.interfaces'));
} // Make all interface classes absolute
$this->helpers = $helpers; foreach ($this->interfaces as &$interface) {
} $interface = '\\' . ltrim($interface, '\\');
}
/** $this->helpers = $helpers;
* Generate the helper file contents; }
*
* @param string $format The format to generate the helper in (php/json) /**
* @return string; * Generate the helper file contents;
*/ *
public function generate($format = 'php') * @param string $format The format to generate the helper in (php/json)
{ * @return string;
// Check if the generator for this format exists */
$method = 'generate'.ucfirst($format).'Helper'; public function generate($format = 'php')
if (method_exists($this, $method)) { {
return $this->$method(); // Check if the generator for this format exists
} $method = 'generate'.ucfirst($format).'Helper';
if (method_exists($this, $method)) {
return $this->generatePhpHelper(); return $this->$method();
} }
public function generatePhpHelper() return $this->generatePhpHelper();
{ }
$app = app();
return $this->view->make('ide-helper::helper') public function generatePhpHelper()
->with('namespaces', $this->getNamespaces()) {
->with('helpers', $this->helpers) $app = app();
->with('version', $app->version()) return $this->view->make('ide-helper::helper')
->render(); ->with('namespaces', $this->getNamespaces())
} ->with('helpers', $this->helpers)
->with('version', $app->version())
public function generateJsonHelper() ->render();
{ }
$classes = array();
foreach ($this->getNamespaces() as $aliases) { public function generateJsonHelper()
foreach($aliases as $alias) { {
$functions = array(); $classes = array();
foreach ($alias->getMethods() as $method) { foreach ($this->getNamespaces() as $aliases) {
$functions[$method->getName()] = '('. $method->getParamsWithDefault().')'; foreach ($aliases as $alias) {
} $functions = array();
$classes[$alias->getAlias()] = array( foreach ($alias->getMethods() as $method) {
'functions' => $functions, $functions[$method->getName()] = '('. $method->getParamsWithDefault().')';
); }
} $classes[$alias->getAlias()] = array(
} 'functions' => $functions,
);
$flags = JSON_FORCE_OBJECT; }
if (defined('JSON_PRETTY_PRINT')) { }
$flags |= JSON_PRETTY_PRINT;
} $flags = JSON_FORCE_OBJECT;
if (defined('JSON_PRETTY_PRINT')) {
return json_encode(array( $flags |= JSON_PRETTY_PRINT;
'php' => array( }
'classes' => $classes,
), return json_encode(array(
), $flags); 'php' => array(
} 'classes' => $classes,
),
protected function detectDrivers() ), $flags);
{ }
try{
if (class_exists('Auth') && is_a('Auth', '\Illuminate\Support\Facades\Auth', true)) { protected function detectDrivers()
$class = get_class(\Auth::driver()); {
$this->extra['Auth'] = array($class); $defaultUserModel = config('auth.providers.users.model', config('auth.model', 'App\User'));
$this->interfaces['\Illuminate\Auth\UserProviderInterface'] = $class; $this->interfaces['\Illuminate\Contracts\Auth\Authenticatable'] = $defaultUserModel;
}
}catch (\Exception $e) {} try {
if (class_exists('Auth') && is_a('Auth', '\Illuminate\Support\Facades\Auth', true)) {
try{ if (class_exists('\Illuminate\Foundation\Application')) {
if (class_exists('DB') && is_a('DB', '\Illuminate\Support\Facades\DB', true)) { $authMethod = version_compare(Application::VERSION, '5.2', '>=') ? 'guard' : 'driver';
$class = get_class(\DB::connection()); } else {
$this->extra['DB'] = array($class); $refClass = new ReflectionClass('\Laravel\Lumen\Application');
$this->interfaces['\Illuminate\Database\ConnectionInterface'] = $class; $versionStr = $refClass->newInstanceWithoutConstructor()->version();
} $authMethod = strpos($versionStr, 'Lumen (5.0') === 0 ?
}catch (\Exception $e) {} 'driver' :
(strpos($versionStr, 'Lumen (5.1') === 0 ? 'driver' : 'guard');
try{ }
if (class_exists('Cache') && is_a('Cache', '\Illuminate\Support\Facades\Cache', true)) { $class = get_class(\Auth::$authMethod());
$driver = get_class(\Cache::driver()); $this->extra['Auth'] = array($class);
$store = get_class(\Cache::getStore()); $this->interfaces['\Illuminate\Auth\UserProviderInterface'] = $class;
$this->extra['Cache'] = array($driver, $store); }
$this->interfaces['\Illuminate\Cache\StoreInterface'] = $store; } catch (\Exception $e) {
} }
}catch (\Exception $e) {}
try {
try{ if (class_exists('DB') && is_a('DB', '\Illuminate\Support\Facades\DB', true)) {
if (class_exists('Queue') && is_a('Queue', '\Illuminate\Support\Facades\Queue', true)) { $class = get_class(\DB::connection());
$class = get_class(\Queue::connection()); $this->extra['DB'] = array($class);
$this->extra['Queue'] = array($class); $this->interfaces['\Illuminate\Database\ConnectionInterface'] = $class;
$this->interfaces['\Illuminate\Queue\QueueInterface'] = $class; }
} } catch (\Exception $e) {
}catch (\Exception $e) {} }
try{ try {
if (class_exists('SSH') && is_a('SSH', '\Illuminate\Support\Facades\SSH', true)){ if (class_exists('Cache') && is_a('Cache', '\Illuminate\Support\Facades\Cache', true)) {
$class = get_class(\SSH::connection()); $driver = get_class(\Cache::driver());
$this->extra['SSH'] = array($class); $store = get_class(\Cache::getStore());
$this->interfaces['\Illuminate\Remote\ConnectionInterface'] = $class; $this->extra['Cache'] = array($driver, $store);
} $this->interfaces['\Illuminate\Cache\StoreInterface'] = $store;
}catch (\Exception $e) {} }
} catch (\Exception $e) {
} }
/** try {
* Find all namespaces/aliases that are valid for us to render if (class_exists('Queue') && is_a('Queue', '\Illuminate\Support\Facades\Queue', true)) {
* $class = get_class(\Queue::connection());
* @return array $this->extra['Queue'] = array($class);
*/ $this->interfaces['\Illuminate\Queue\QueueInterface'] = $class;
protected function getNamespaces() }
{ } catch (\Exception $e) {
$namespaces = array(); }
// Get all aliases try {
foreach ($this->getAliases() as $name => $facade) { if (class_exists('SSH') && is_a('SSH', '\Illuminate\Support\Facades\SSH', true)) {
// Skip the Redis facade, if not available (otherwise Fatal PHP Error) $class = get_class(\SSH::connection());
if ($facade == 'Illuminate\Support\Facades\Redis' && !class_exists('Predis\Client')) { $this->extra['SSH'] = array($class);
continue; $this->interfaces['\Illuminate\Remote\ConnectionInterface'] = $class;
} }
} catch (\Exception $e) {
$magicMethods = array_key_exists($name, $this->magic) ? $this->magic[$name] : array(); }
$alias = new Alias($name, $facade, $magicMethods, $this->interfaces);
if ($alias->isValid()) { try {
if (class_exists('Storage') && is_a('Storage', '\Illuminate\Support\Facades\Storage', true)) {
//Add extra methods, from other classes (magic static calls) $class = get_class(\Storage::disk());
if (array_key_exists($name, $this->extra)) { $this->extra['Storage'] = array($class);
$alias->addClass($this->extra[$name]); $this->interfaces['\Illuminate\Contracts\Filesystem\Filesystem'] = $class;
} }
} catch (\Exception $e) {
$namespace = $alias->getNamespace(); }
if (!isset($namespaces[$namespace])) {
$namespaces[$namespace] = array(); }
}
$namespaces[$namespace][] = $alias; /**
} * Find all namespaces/aliases that are valid for us to render
*
} * @return array
*/
return $namespaces; protected function getNamespaces()
} {
$namespaces = array();
protected function getAliases()
{ // Get all aliases
// For Laravel, use the AliasLoader foreach ($this->getAliases() as $name => $facade) {
if (class_exists('Illuminate\Foundation\AliasLoader')) { // Skip the Redis facade, if not available (otherwise Fatal PHP Error)
return AliasLoader::getInstance()->getAliases(); if ($facade == 'Illuminate\Support\Facades\Redis' && !class_exists('Predis\Client')) {
} continue;
}
$facades = [
'Illuminate\Support\Facades\App' => 'App', $magicMethods = array_key_exists($name, $this->magic) ? $this->magic[$name] : array();
'Illuminate\Support\Facades\Auth' => 'Auth', $alias = new Alias($name, $facade, $magicMethods, $this->interfaces);
'Illuminate\Support\Facades\Bus' => 'Bus', if ($alias->isValid()) {
'Illuminate\Support\Facades\DB' => 'DB', //Add extra methods, from other classes (magic static calls)
'Illuminate\Support\Facades\Cache' => 'Cache', if (array_key_exists($name, $this->extra)) {
'Illuminate\Support\Facades\Cookie' => 'Cookie', $alias->addClass($this->extra[$name]);
'Illuminate\Support\Facades\Crypt' => 'Crypt', }
'Illuminate\Support\Facades\Event' => 'Event',
'Illuminate\Support\Facades\Hash' => 'Hash', $namespace = $alias->getNamespace();
'Illuminate\Support\Facades\Log' => 'Log', if (!isset($namespaces[$namespace])) {
'Illuminate\Support\Facades\Mail' => 'Mail', $namespaces[$namespace] = array();
'Illuminate\Support\Facades\Queue' => 'Queue', }
'Illuminate\Support\Facades\Request' => 'Request', $namespaces[$namespace][] = $alias;
'Illuminate\Support\Facades\Schema' => 'Schema', }
'Illuminate\Support\Facades\Session' => 'Session', }
'Illuminate\Support\Facades\Storage' => 'Storage',
// 'Illuminate\Support\Facades\Validator' => 'Validator', return $namespaces;
]; }
// Only return the ones that actually exist protected function getAliases()
return array_filter($facades, function($alias){ {
return class_exists($alias); // For Laravel, use the AliasLoader
}); if (class_exists('Illuminate\Foundation\AliasLoader')) {
} return AliasLoader::getInstance()->getAliases();
}
/**
* Get the driver/connection/store from the managers $facades = [
* 'App' => 'Illuminate\Support\Facades\App',
* @param $alias 'Auth' => 'Illuminate\Support\Facades\Auth',
* @return array|bool|string 'Bus' => 'Illuminate\Support\Facades\Bus',
*/ 'DB' => 'Illuminate\Support\Facades\DB',
public function getDriver($alias) 'Cache' => 'Illuminate\Support\Facades\Cache',
{ 'Cookie' => 'Illuminate\Support\Facades\Cookie',
try { 'Crypt' => 'Illuminate\Support\Facades\Crypt',
if ($alias == "Auth") { 'Event' => 'Illuminate\Support\Facades\Event',
$driver = \Auth::driver(); 'Hash' => 'Illuminate\Support\Facades\Hash',
} elseif ($alias == "DB") { 'Log' => 'Illuminate\Support\Facades\Log',
$driver = \DB::connection(); 'Mail' => 'Illuminate\Support\Facades\Mail',
} elseif ($alias == "Cache") { 'Queue' => 'Illuminate\Support\Facades\Queue',
$driver = get_class(\Cache::driver()); 'Request' => 'Illuminate\Support\Facades\Request',
$store = get_class(\Cache::getStore()); 'Schema' => 'Illuminate\Support\Facades\Schema',
return array($driver, $store); 'Session' => 'Illuminate\Support\Facades\Session',
} elseif ($alias == "Queue") { 'Storage' => 'Illuminate\Support\Facades\Storage',
$driver = \Queue::connection(); //'Validator' => 'Illuminate\Support\Facades\Validator',
} else { ];
return false;
} $facades = array_merge($facades, $this->config->get('app.aliases', []));
return get_class($driver); // Only return the ones that actually exist
} catch (\Exception $e) { return array_filter($facades, function ($alias) {
$this->error("Could not determine driver/connection for $alias."); return class_exists($alias);
return false; });
} }
}
/**
/** * Get the driver/connection/store from the managers
* Write a string as error output. *
* * @param $alias
* @param string $string * @return array|bool|string
* @return void */
*/ public function getDriver($alias)
protected function error($string) {
{ try {
if($this->output){ if ($alias == "Auth") {
$this->output->writeln("<error>$string</error>"); $driver = \Auth::driver();
}else{ } elseif ($alias == "DB") {
echo $string . "\r\n"; $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";
}
}
}
+3 -4
View File
@@ -67,9 +67,9 @@ class IdeHelperServiceProvider extends ServiceProvider
); );
$this->app['command.ide-helper.meta'] = $this->app->share( $this->app['command.ide-helper.meta'] = $this->app->share(
function ($app) { function ($app) {
return new MetaCommand($app['files'], $app['view']); return new MetaCommand($app['files'], $app['view']);
} }
); );
$this->commands('command.ide-helper.generate', 'command.ide-helper.models', 'command.ide-helper.meta'); $this->commands('command.ide-helper.generate', 'command.ide-helper.models', 'command.ide-helper.meta');
@@ -84,5 +84,4 @@ class IdeHelperServiceProvider extends ServiceProvider
{ {
return array('command.ide-helper.generate', 'command.ide-helper.models'); return array('command.ide-helper.generate', 'command.ide-helper.models');
} }
} }
+314 -311
View File
@@ -1,311 +1,314 @@
<?php <?php
/** /**
* Laravel IDE Helper Generator * Laravel IDE Helper Generator
* *
* @author Barry vd. Heuvel <barryvdh@gmail.com> * @author Barry vd. Heuvel <barryvdh@gmail.com>
* @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 $name;
protected $namespace; protected $namespace;
protected $params = array(); protected $params = array();
protected $params_with_default = array(); protected $params_with_default = array();
protected $interfaces = array(); protected $interfaces = array();
protected $return = null; protected $return = null;
/** /**
* @param \ReflectionMethod $method * @param \ReflectionMethod $method
* @param string $alias * @param string $alias
* @param string $class * @param \ReflectionClass $class
* @param string|null $methodName * @param string|null $methodName
* @param array $interfaces * @param array $interfaces
*/ */
public function __construct(\ReflectionMethod $method, $alias, $class, $methodName = null, $interfaces = array()) public function __construct(\ReflectionMethod $method, $alias, $class, $methodName = null, $interfaces = array())
{ {
$this->method = $method; $this->method = $method;
$this->interfaces = $interfaces; $this->interfaces = $interfaces;
$this->name = $methodName ?: $method->name; $this->name = $methodName ?: $method->name;
$this->namespace = $method->getDeclaringClass()->getNamespaceName(); $this->namespace = $method->getDeclaringClass()->getNamespaceName();
//Create a DocBlock and serializer instance //Create a DocBlock and serializer instance
$this->phpdoc = new DocBlock($method, new Context($this->namespace)); $this->phpdoc = new DocBlock($method, new Context($this->namespace));
//Normalize the description and inherit the docs from parents/interfaces //Normalize the description and inherit the docs from parents/interfaces
try { try {
$this->normalizeParams($this->phpdoc); $this->normalizeParams($this->phpdoc);
$this->normalizeReturn($this->phpdoc); $this->normalizeReturn($this->phpdoc);
$this->normalizeDescription($this->phpdoc); $this->normalizeDescription($this->phpdoc);
} catch (\Exception $e) {} } catch (\Exception $e) {
}
//Get the parameters, including formatted default values
$this->getParameters($method); //Get the parameters, including formatted default values
$this->getParameters($method);
//Make the method static
$this->phpdoc->appendTag(Tag::createInstance('@static', $this->phpdoc)); //Make the method static
$this->phpdoc->appendTag(Tag::createInstance('@static', $this->phpdoc));
//Reference the 'real' function in the declaringclass
$declaringClass = $method->getDeclaringClass(); //Reference the 'real' function in the declaringclass
$this->declaringClassName = '\\' . ltrim($declaringClass->name, '\\'); $declaringClass = $method->getDeclaringClass();
$this->root = '\\' . ltrim($class->getName(), '\\'); $this->declaringClassName = '\\' . ltrim($declaringClass->name, '\\');
} $this->root = '\\' . ltrim($class->getName(), '\\');
}
/**
* Get the class wherein the function resides /**
* * Get the class wherein the function resides
* @return string *
*/ * @return string
public function getDeclaringClass() */
{ public function getDeclaringClass()
return $this->declaringClassName; {
} return $this->declaringClassName;
}
/**
* Return the class from which this function would be called /**
* * Return the class from which this function would be called
* @return string *
*/ * @return string
public function getRoot() */
{ public function getRoot()
return $this->root; {
} return $this->root;
}
/**
* Get the docblock for this method /**
* * Get the docblock for this method
* @param string $prefix *
* @return mixed * @param string $prefix
*/ * @return mixed
public function getDocComment($prefix = "\t\t") */
{ public function getDocComment($prefix = "\t\t")
$serializer = new DocBlockSerializer(1, $prefix); {
return $serializer->getDocComment($this->phpdoc); $serializer = new DocBlockSerializer(1, $prefix);
} return $serializer->getDocComment($this->phpdoc);
}
/**
* Get the method name /**
* * Get the method name
* @return string *
*/ * @return string
public function getName() */
{ public function getName()
return $this->name; {
} return $this->name;
}
/**
* Get the parameters for this method /**
* * Get the parameters for this method
* @param bool $implode Wether to implode the array or not *
* @return string * @param bool $implode Wether to implode the array or not
*/ * @return string
public function getParams($implode = true) */
{ public function getParams($implode = true)
return $implode ? implode(', ', $this->params) : $this->params; {
} return $implode ? implode(', ', $this->params) : $this->params;
}
/**
* Get the parameters for this method including default values /**
* * Get the parameters for this method including default values
* @param bool $implode Wether to implode the array or not *
* @return string * @param bool $implode Wether to implode the array or not
*/ * @return string
public function getParamsWithDefault($implode = true) */
{ public function getParamsWithDefault($implode = true)
return $implode ? implode(', ', $this->params_with_default) : $this->params_with_default; {
} return $implode ? implode(', ', $this->params_with_default) : $this->params_with_default;
}
/**
* Get the description and get the inherited docs. /**
* * Get the description and get the inherited docs.
* @param DocBlock $phpdoc *
*/ * @param DocBlock $phpdoc
protected function normalizeDescription(DocBlock $phpdoc) */
{ protected function normalizeDescription(DocBlock $phpdoc)
//Get the short + long description from the DocBlock {
$description = $phpdoc->getText(); //Get the short + long description from the DocBlock
$description = $phpdoc->getText();
//Loop through parents/interfaces, to fill in {@inheritdoc}
if (strpos($description, '{@inheritdoc}') !== false) { //Loop through parents/interfaces, to fill in {@inheritdoc}
$inheritdoc = $this->getInheritDoc($this->method); if (strpos($description, '{@inheritdoc}') !== false) {
$inheritDescription = $inheritdoc->getText(); $inheritdoc = $this->getInheritDoc($this->method);
$inheritDescription = $inheritdoc->getText();
$description = str_replace('{@inheritdoc}', $inheritDescription, $description);
$phpdoc->setText($description); $description = str_replace('{@inheritdoc}', $inheritDescription, $description);
$phpdoc->setText($description);
$this->normalizeParams($inheritdoc);
$this->normalizeReturn($inheritdoc); $this->normalizeParams($inheritdoc);
$this->normalizeReturn($inheritdoc);
//Add the tags that are inherited
$inheritTags = $inheritdoc->getTags(); //Add the tags that are inherited
if ($inheritTags) { $inheritTags = $inheritdoc->getTags();
/** @var Tag $tag */ if ($inheritTags) {
foreach ($inheritTags as $tag) { /** @var Tag $tag */
$tag->setDocBlock(); foreach ($inheritTags as $tag) {
$phpdoc->appendTag($tag); $tag->setDocBlock();
} $phpdoc->appendTag($tag);
} }
} }
} }
}
/**
* Normalize the parameters /**
* * Normalize the parameters
* @param DocBlock $phpdoc *
*/ * @param DocBlock $phpdoc
protected function normalizeParams(DocBlock $phpdoc) */
{ protected function normalizeParams(DocBlock $phpdoc)
//Get the return type and adjust them for beter autocomplete {
$paramTags = $phpdoc->getTagsByName('param'); //Get the return type and adjust them for beter autocomplete
if ($paramTags) { $paramTags = $phpdoc->getTagsByName('param');
/** @var ParamTag $tag */ if ($paramTags) {
foreach($paramTags as $tag){ /** @var ParamTag $tag */
// Convert the keywords foreach ($paramTags as $tag) {
$content = $this->convertKeywords($tag->getContent()); // Convert the keywords
$tag->setContent($content); $content = $this->convertKeywords($tag->getContent());
$tag->setContent($content);
// Get the expanded type and re-set the content
$content = $tag->getType() . ' ' . $tag->getVariableName() . ' ' . $tag->getDescription(); // Get the expanded type and re-set the content
$tag->setContent(trim($content)); $content = $tag->getType() . ' ' . $tag->getVariableName() . ' ' . $tag->getDescription();
} $tag->setContent(trim($content));
} }
} }
}
/**
* Normalize the return tag (make full namespace, replace interfaces) /**
* * Normalize the return tag (make full namespace, replace interfaces)
* @param DocBlock $phpdoc *
*/ * @param DocBlock $phpdoc
protected function normalizeReturn(DocBlock $phpdoc) */
{ protected function normalizeReturn(DocBlock $phpdoc)
//Get the return type and adjust them for beter autocomplete {
$returnTags = $phpdoc->getTagsByName('return'); //Get the return type and adjust them for beter autocomplete
if ($returnTags) { $returnTags = $phpdoc->getTagsByName('return');
/** @var ReturnTag $tag */ if ($returnTags) {
$tag = reset($returnTags); /** @var ReturnTag $tag */
// Get the expanded type $tag = reset($returnTags);
$returnValue = $tag->getType(); // Get the expanded type
$returnValue = $tag->getType();
// Replace the interfaces
foreach($this->interfaces as $interface => $real){ // Replace the interfaces
$returnValue = str_replace($interface, $real, $returnValue); foreach ($this->interfaces as $interface => $real) {
} $returnValue = str_replace($interface, $real, $returnValue);
}
// Set the changed content
$tag->setContent($returnValue . ' ' . $tag->getDescription()); // Set the changed content
$this->return = $returnValue; $tag->setContent($returnValue . ' ' . $tag->getDescription());
}else{ $this->return = $returnValue;
$this->return = null; } else {
} $this->return = null;
} }
}
/**
* Convert keywwords that are incorrect. /**
* * Convert keywwords that are incorrect.
* @param string $string *
* @return string * @param string $string
*/ * @return string
protected function convertKeywords($string) */
{ protected function convertKeywords($string)
$string = str_replace('\Closure', 'Closure', $string); {
$string = str_replace('Closure', '\Closure', $string); $string = str_replace('\Closure', 'Closure', $string);
$string = str_replace('dynamic', 'mixed', $string); $string = str_replace('Closure', '\Closure', $string);
$string = str_replace('dynamic', 'mixed', $string);
return $string;
} return $string;
}
/**
* Should the function return a value? /**
* * Should the function return a value?
* @return bool *
*/ * @return bool
public function shouldReturn() */
{ public function shouldReturn()
if($this->return !== "void" && $this->method->name !== "__construct"){ {
return true; if ($this->return !== "void" && $this->method->name !== "__construct") {
} return true;
}
return false;
} return false;
}
/**
* Get the parameters and format them correctly /**
* * Get the parameters and format them correctly
* @param $method *
* @return array * @param \ReflectionMethod $method
*/ * @return array
public function getParameters($method) */
{ public function getParameters($method)
//Loop through the default values for paremeters, and make the correct output string {
$params = array(); //Loop through the default values for paremeters, and make the correct output string
$paramsWithDefault = array(); $params = array();
foreach ($method->getParameters() as $param) { $paramsWithDefault = array();
$paramStr = '$' . $param->getName(); foreach ($method->getParameters() as $param) {
$params[] = $paramStr; $paramStr = '$' . $param->getName();
if ($param->isOptional()) { $params[] = $paramStr;
$default = $param->isDefaultValueAvailable() ? $param->getDefaultValue() : null; if ($param->isOptional()) {
if (is_bool($default)) { $default = $param->isDefaultValueAvailable() ? $param->getDefaultValue() : null;
$default = $default ? 'true' : 'false'; if (is_bool($default)) {
} elseif (is_array($default)) { $default = $default ? 'true' : 'false';
$default = 'array()'; } elseif (is_array($default)) {
} elseif (is_null($default)) { $default = 'array()';
$default = 'null'; } elseif (is_null($default)) {
} elseif (is_int($default)) { $default = 'null';
//$default = $default; } elseif (is_int($default)) {
} else { //$default = $default;
$default = "'" . trim($default) . "'"; } elseif (is_resource($default)) {
} //skip to not fail
$paramStr .= " = $default"; } else {
} $default = "'" . trim($default) . "'";
$paramsWithDefault[] = $paramStr; }
} $paramStr .= " = $default";
}
$this->params = $params; $paramsWithDefault[] = $paramStr;
$this->params_with_default = $paramsWithDefault; }
}
$this->params = $params;
/** $this->params_with_default = $paramsWithDefault;
* @param \ReflectionMethod $reflectionMethod }
* @return DocBlock
*/ /**
protected function getInheritDoc($reflectionMethod) * @param \ReflectionMethod $reflectionMethod
{ * @return DocBlock
$parentClass = $reflectionMethod->getDeclaringClass()->getParentClass(); */
protected function getInheritDoc($reflectionMethod)
//Get either a parent or the interface {
if ($parentClass) { $parentClass = $reflectionMethod->getDeclaringClass()->getParentClass();
$method = $parentClass->getMethod($reflectionMethod->getName());
} else { //Get either a parent or the interface
$method = $reflectionMethod->getPrototype(); if ($parentClass) {
} $method = $parentClass->getMethod($reflectionMethod->getName());
if ($method) { } else {
$namespace = $method->getDeclaringClass()->getNamespaceName(); $method = $reflectionMethod->getPrototype();
$phpdoc = new DocBlock($method, new Context($namespace)); }
if ($method) {
if (strpos($phpdoc->getText(), '{@inheritdoc}') !== false) { $namespace = $method->getDeclaringClass()->getNamespaceName();
//Not at the end yet, try another parent/interface.. $phpdoc = new DocBlock($method, new Context($namespace));
return $this->getInheritDoc($method);
} else { if (strpos($phpdoc->getText(), '{@inheritdoc}') !== false) {
return $phpdoc; //Not at the end yet, try another parent/interface..
} return $this->getInheritDoc($method);
} } else {
} return $phpdoc;
} }
}
}
}
+58
View File
@@ -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;
}
}