mirror of
https://github.com/barryvdh/laravel-ide-helper.git
synced 2026-08-18 18:13:11 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a9484c67d1 | ||
|
|
3064296216 | ||
|
|
f057a4f820 | ||
|
|
091f78508c | ||
|
|
cf4fcd810c | ||
|
|
d3203de671 | ||
|
|
093171e01f | ||
|
|
2d82419167 | ||
|
|
0e84805e37 | ||
|
|
7a07515149 | ||
|
|
bae462604e | ||
|
|
b28c8cbae1 | ||
|
|
d734ecabcc | ||
|
|
4f227d5c57 | ||
|
|
35ebf3a2ba | ||
|
|
f7b31bdbdc | ||
|
|
8de1673535 | ||
|
|
d818b72f82 | ||
|
|
e97ed532f0 | ||
|
|
606183ea12 | ||
|
|
f1ebd847aa | ||
|
|
83597196f9 | ||
|
|
19553f63e4 | ||
|
|
f50470ba49 | ||
|
|
7762e07f0a | ||
|
|
467b5f5b5f | ||
|
|
c213be3d3c | ||
|
|
4b8ba85b34 | ||
|
|
d4c0ae5851 | ||
|
|
3a01e351de | ||
|
|
add34665a8 | ||
|
|
c77752bb58 | ||
|
|
aa8f772a46 | ||
|
|
0c4c55f349 | ||
|
|
ed972acf19 | ||
|
|
60e642e881 | ||
|
|
4069863d0c | ||
|
|
da05897cb7 | ||
|
|
74bac1a4e9 | ||
|
|
33cee80609 | ||
|
|
dee3878566 | ||
|
|
eb5736a7bd | ||
|
|
cc794a2fba | ||
|
|
d82e8f191f | ||
|
|
5497e7d506 | ||
|
|
2f83db311f | ||
|
|
d56bbb2356 | ||
|
|
2fb1135fc5 | ||
|
|
aec17e3327 | ||
|
|
0c560cb375 | ||
|
|
5708012a77 | ||
|
|
af6d9a7fa1 | ||
|
|
f708b9a46c | ||
|
|
e3de462538 | ||
|
|
76f09aaa65 | ||
|
|
56f89502e3 | ||
|
|
11037acfe6 | ||
|
|
e48974e545 | ||
|
|
38a97cf07c | ||
|
|
74ee804dde | ||
|
|
83999f8467 | ||
|
|
fab54d90dd | ||
|
|
5d4056fe87 | ||
|
|
3fbe330998 | ||
|
|
78d233fea7 | ||
|
|
0d13a51ff5 | ||
|
|
326e8ea25f | ||
|
|
e7ee934bb1 | ||
|
|
99953adb73 | ||
|
|
0d333c6228 | ||
|
|
0a717d1e79 | ||
|
|
dc62d35bed | ||
|
|
2b7733c6b9 | ||
|
|
76674be735 | ||
|
|
e34b7fb84b | ||
|
|
e77a7b5a9c | ||
|
|
19f7d75c10 | ||
|
|
0373861536 | ||
|
|
3a4671f3ea | ||
|
|
8515b7ac0b | ||
|
|
541b9508e2 | ||
|
|
afe1fe88ba | ||
|
|
a59a5e1ae1 | ||
|
|
bb3bba2c5b | ||
|
|
5aa0f55d2f | ||
|
|
89b585b242 | ||
|
|
f5b1248a37 | ||
|
|
8b190ac295 | ||
|
|
a861bcaf1b | ||
|
|
bb3bd2645d | ||
|
|
687a8c9b47 | ||
|
|
b1dedc3ee6 | ||
|
|
dac46a081d | ||
|
|
0c38360317 | ||
|
|
1d3a98f0e5 | ||
|
|
d9f79eb128 | ||
|
|
7ef2d2f398 | ||
|
|
5afcbdc7c8 | ||
|
|
d8d5517f2c | ||
|
|
f518de4ae1 | ||
|
|
a89273d7ad | ||
|
|
d9004f98cc | ||
|
|
765a274c05 | ||
|
|
b6a5262f3b | ||
|
|
d922d7e7ce | ||
|
|
89240e3ceb | ||
|
|
d9077b753c | ||
|
|
683ed695a5 | ||
|
|
f8c4d4e77a | ||
|
|
b1a4494b1c | ||
|
|
70c06f5b37 | ||
|
|
8378f1bd67 | ||
|
|
81b7febfc6 | ||
|
|
208043b56f | ||
|
|
4cd891eadc | ||
|
|
7917ba911f | ||
|
|
1f5e436d00 | ||
|
|
fb3280eaff | ||
|
|
800ac05377 | ||
|
|
50059faa6f | ||
|
|
bb8d0169ba | ||
|
|
fe692a4e77 | ||
|
|
c3a622fcc9 | ||
|
|
317ef794a5 | ||
|
|
5c846ca16a | ||
|
|
1d4df779d8 | ||
|
|
8f0d346eaa | ||
|
|
73003c0bea | ||
|
|
f12c785688 | ||
|
|
c0aaabb6d7 | ||
|
|
1e6752a29f | ||
|
|
ab50c245d0 | ||
|
|
ab85ca4c5a | ||
|
|
c94012232f | ||
|
|
b9685a1f83 | ||
|
|
7bc74b1844 | ||
|
|
cfa0333446 | ||
|
|
5c6fa1d43f | ||
|
|
23db0e06ca | ||
|
|
52b3accd70 | ||
|
|
cc07cd3b2c | ||
|
|
3113f58f45 | ||
|
|
d00dc62ed6 | ||
|
|
073d90b791 | ||
|
|
5d4af73c29 | ||
|
|
39ffaa62f4 | ||
|
|
231e125821 | ||
|
|
f446326967 | ||
|
|
57dc033061 | ||
|
|
e2b59c6cb5 | ||
|
|
736f2f387e | ||
|
|
486d9d9c4d | ||
|
|
ac8b868261 | ||
|
|
c0eb7e2d7e | ||
|
|
89a17fc7b9 | ||
|
|
ec43d4e65b | ||
|
|
03cc70759b | ||
|
|
f94743fda5 | ||
|
|
3eabba3e5d | ||
|
|
f2de8d3c65 | ||
|
|
10e16a0bdc | ||
|
|
f135845100 | ||
|
|
3c54b17760 | ||
|
|
9a67d9132f | ||
|
|
bd33e05304 | ||
|
|
83bdb7acd7 | ||
|
|
4fc9c671e8 | ||
|
|
6c18c3f39a |
@@ -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
|
||||||
@@ -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
@@ -1,3 +1,4 @@
|
|||||||
/vendor
|
build
|
||||||
|
vendor
|
||||||
composer.lock
|
composer.lock
|
||||||
.idea
|
.idea
|
||||||
|
|||||||
@@ -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
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
preset: psr2
|
||||||
+31
@@ -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
@@ -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.
|
||||||
+19
-7
@@ -10,14 +10,17 @@
|
|||||||
}
|
}
|
||||||
],
|
],
|
||||||
"require": {
|
"require": {
|
||||||
"php": ">=5.3.0",
|
"php": ">=5.4.0",
|
||||||
"illuminate/support": "4.x",
|
"illuminate/support": "^5.0,<5.4",
|
||||||
"illuminate/console": "4.x",
|
"illuminate/console": "^5.0,<5.4",
|
||||||
"illuminate/filesystem": "4.x",
|
"illuminate/filesystem": "^5.0,<5.4",
|
||||||
"phpdocumentor/reflection-docblock": "2.0.x",
|
"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,9 +31,18 @@
|
|||||||
"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": "1.11-dev"
|
"dev-master": "2.1-dev"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -4,14 +4,15 @@ return array(
|
|||||||
|
|
||||||
/*
|
/*
|
||||||
|--------------------------------------------------------------------------
|
|--------------------------------------------------------------------------
|
||||||
| Filename
|
| Filename & Format
|
||||||
|--------------------------------------------------------------------------
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
|
||||||
| The default path to the helper file
|
| The default filename (without extension) and the format (php or json)
|
||||||
|
|
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
'filename' => '_ide_helper.php',
|
'filename' => '_ide_helper',
|
||||||
|
'format' => 'php',
|
||||||
|
|
||||||
/*
|
/*
|
||||||
|--------------------------------------------------------------------------
|
|--------------------------------------------------------------------------
|
||||||
@@ -40,7 +41,7 @@ return array(
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
'model_locations' => array(
|
'model_locations' => array(
|
||||||
'app/models',
|
'app',
|
||||||
),
|
),
|
||||||
|
|
||||||
|
|
||||||
@@ -54,7 +55,6 @@ return array(
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
'extra' => array(
|
'extra' => array(
|
||||||
'Artisan' => array('Illuminate\Foundation\Artisan'),
|
|
||||||
'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
|
'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
|
||||||
'Session' => array('Illuminate\Session\Store'),
|
'Session' => array('Illuminate\Session\Store'),
|
||||||
),
|
),
|
||||||
@@ -83,7 +83,37 @@ return array(
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
'interfaces' => array(
|
'interfaces' => array(
|
||||||
'\Illuminate\Auth\UserInterface' => '\User',
|
|
||||||
)
|
),
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| 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(
|
||||||
|
|
||||||
|
),
|
||||||
|
|
||||||
);
|
);
|
||||||
@@ -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>
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
{
|
|
||||||
"providers": [
|
|
||||||
"Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
@@ -1,68 +1,101 @@
|
|||||||
## Laravel IDE Helper Generator
|
## Laravel 5 IDE Helper Generator
|
||||||
[](https://packagist.org/packages/barryvdh/laravel-ide-helper) [](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
|
### 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!_
|
||||||
|
|
||||||
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).
|
||||||
|
|
||||||
|
* 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 CodeIntel for Sublime Text: https://github.com/SublimeCodeIntel/SublimeCodeIntel
|
Note: You do need CodeIntel for Sublime Text: https://github.com/SublimeCodeIntel/SublimeCodeIntel
|
||||||
|
|
||||||
|
### 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,
|
||||||
|
```
|
||||||
|
|
||||||
### Automatic phpDoc generation for Laravel Facades
|
### 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):
|
|
||||||
|
|
||||||
"barryvdh/laravel-ide-helper": "1.*"
|
You can now re-generate the docs yourself (for future updates)
|
||||||
|
|
||||||
After updating composer, add the ServiceProvider to the providers array in app/config/app.php
|
|
||||||
|
|
||||||
'Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider',
|
|
||||||
|
|
||||||
You can now re-generate the docs yourself (for future updates) in artisan
|
|
||||||
|
|
||||||
|
```bash
|
||||||
php artisan ide-helper:generate
|
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:
|
||||||
|
|
||||||
|
```js
|
||||||
"scripts":{
|
"scripts":{
|
||||||
"post-update-cmd": [
|
"post-update-cmd": [
|
||||||
"php artisan clear-compiled",
|
"Illuminate\\Foundation\\ComposerScripts::postUpdate",
|
||||||
"php artisan ide-helper:generate",
|
"php artisan ide-helper:generate",
|
||||||
"php artisan optimize",
|
"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 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.
|
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, using 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.
|
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, 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.
|
||||||
|
|
||||||
|
```bash
|
||||||
php artisan ide-helper:models Post
|
php artisan ide-helper:models Post
|
||||||
|
```
|
||||||
|
|
||||||
|
```php
|
||||||
/**
|
/**
|
||||||
* An Eloquent Model: 'Post'
|
* An Eloquent Model: 'Post'
|
||||||
*
|
*
|
||||||
@@ -75,23 +108,70 @@ With the `--reset (-R)` option, the existing phpdocs are ignored, only the newly
|
|||||||
* @property-read \User $author
|
* @property-read \User $author
|
||||||
* @property-read \Illuminate\Database\Eloquent\Collection|\Comment[] $comments
|
* @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).
|
||||||
|
|
||||||
|
```bash
|
||||||
php artisan ide-helper:models Post User
|
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.
|
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
|
||||||
|
|
||||||
|
```bash
|
||||||
php artisan ide-helper:models --ignore="Post,User"
|
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
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
<?= '<?php' ?>
|
<?= '<?php' ?>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* An helper file for Laravel 4, to provide autocomplete information to your IDE
|
* A helper file for Laravel 5, to provide autocomplete information to your IDE
|
||||||
* Generated for Laravel <?= $version ?> on <?= date("Y-m-d") ?>.
|
* Generated for Laravel <?= $version ?> on <?= date("Y-m-d") ?>.
|
||||||
*
|
*
|
||||||
* @author Barry vd. Heuvel <barryvdh@gmail.com>
|
* @author Barry vd. Heuvel <barryvdh@gmail.com>
|
||||||
@@ -16,7 +16,7 @@ namespace <?= $namespace == '__root' ? '' : $namespace ?>{
|
|||||||
<?php endif; ?>
|
<?php endif; ?>
|
||||||
<?php foreach($aliases as $alias): ?>
|
<?php foreach($aliases as $alias): ?>
|
||||||
|
|
||||||
<?= $alias->getClassType() ?> <?= $alias->getAlias() ?> <?= $alias->getExtends() ? 'extends ' . $alias->getExtends() : '' ?>{
|
<?= $alias->getClassType() ?> <?= $alias->getShortName() ?> <?= $alias->getExtends() ? 'extends ' . $alias->getExtends() : '' ?>{
|
||||||
<?php foreach($alias->getMethods() as $method): ?>
|
<?php foreach($alias->getMethods() as $method): ?>
|
||||||
|
|
||||||
<?= trim($method->getDocComment(' ')) ?>
|
<?= trim($method->getDocComment(' ')) ?>
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
<?= '<?php' ?>
|
||||||
|
|
||||||
|
namespace PHPSTORM_META {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* PhpStorm Meta file, to provide autocomplete information for PhpStorm
|
||||||
|
* Generated on <?= date("Y-m-d") ?>.
|
||||||
|
*
|
||||||
|
* @author Barry vd. Heuvel <[email protected]>
|
||||||
|
* @see https://github.com/barryvdh/laravel-ide-helper
|
||||||
|
*/
|
||||||
|
$STATIC_METHOD_TYPES = [
|
||||||
|
<?php foreach($methods as $method): ?>
|
||||||
|
<?= $method ?> => [
|
||||||
|
'' == '@',
|
||||||
|
<?php foreach($bindings as $abstract => $class): ?>
|
||||||
|
'<?= $abstract ?>' instanceof \<?= $class ?>,
|
||||||
|
<?php endforeach ?> ],
|
||||||
|
<?php endforeach ?>
|
||||||
|
];
|
||||||
|
}
|
||||||
+24
-6
@@ -12,11 +12,11 @@ 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 $namespace = '__root';
|
protected $namespace = '__root';
|
||||||
protected $root = null;
|
protected $root = null;
|
||||||
protected $classes = array();
|
protected $classes = array();
|
||||||
@@ -42,7 +42,6 @@ class Alias
|
|||||||
$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)) {
|
||||||
@@ -55,7 +54,9 @@ class Alias
|
|||||||
$this->detectNamespace();
|
$this->detectNamespace();
|
||||||
$this->detectClassType();
|
$this->detectClassType();
|
||||||
|
|
||||||
|
if ($facade === '\Illuminate\Database\Eloquent\Model') {
|
||||||
|
$this->usedMethods = array('decrement', 'increment');
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -114,6 +115,13 @@ class Alias
|
|||||||
return $this->alias;
|
return $this->alias;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return the short name (without namespace)
|
||||||
|
*/
|
||||||
|
public function getShortName()
|
||||||
|
{
|
||||||
|
return $this->short;
|
||||||
|
}
|
||||||
/**
|
/**
|
||||||
* Get the namespace from the alias
|
* Get the namespace from the alias
|
||||||
*
|
*
|
||||||
@@ -145,6 +153,8 @@ class Alias
|
|||||||
$nsParts = explode('\\', $this->alias);
|
$nsParts = explode('\\', $this->alias);
|
||||||
$this->short = array_pop($nsParts);
|
$this->short = array_pop($nsParts);
|
||||||
$this->namespace = implode('\\', $nsParts);
|
$this->namespace = implode('\\', $nsParts);
|
||||||
|
} else {
|
||||||
|
$this->short = $this->alias;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -192,7 +202,9 @@ class Alias
|
|||||||
//When the database connection is not set, some classes will be skipped
|
//When the database connection is not set, some classes will be skipped
|
||||||
} catch (\PDOException $e) {
|
} catch (\PDOException $e) {
|
||||||
$this->error(
|
$this->error(
|
||||||
"PDOException: " . $e->getMessage() . "\nPlease configure your database connection correctly, or use the sqlite memory driver (-M). Skipping $facade."
|
"PDOException: " . $e->getMessage() .
|
||||||
|
"\nPlease configure your database connection correctly, or use the sqlite memory driver (-M)." .
|
||||||
|
" Skipping $facade."
|
||||||
);
|
);
|
||||||
} catch (\Exception $e) {
|
} catch (\Exception $e) {
|
||||||
$this->error("Exception: " . $e->getMessage() . "\nSkipping $facade.");
|
$this->error("Exception: " . $e->getMessage() . "\nSkipping $facade.");
|
||||||
@@ -252,8 +264,14 @@ class Alias
|
|||||||
if (!in_array($method->name, $this->usedMethods)) {
|
if (!in_array($method->name, $this->usedMethods)) {
|
||||||
// Only add the methods to the output when the root is not the same as the class.
|
// Only add the methods to the output when the root is not the same as the class.
|
||||||
// And don't add the __*() methods
|
// And don't add the __*() methods
|
||||||
if ($this->extends !== $class && $method->name !== '__clone') {
|
if ($this->extends !== $class && substr($method->name, 0, 2) !== '__') {
|
||||||
$this->methods[] = new Method($method, $this->alias, $reflection, $method->name, $this->interfaces);
|
$this->methods[] = new Method(
|
||||||
|
$method,
|
||||||
|
$this->alias,
|
||||||
|
$reflection,
|
||||||
|
$method->name,
|
||||||
|
$this->interfaces
|
||||||
|
);
|
||||||
}
|
}
|
||||||
$this->usedMethods[] = $method->name;
|
$this->usedMethods[] = $method->name;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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
|
||||||
*
|
*
|
||||||
@@ -59,8 +58,9 @@ class GeneratorCommand extends Command
|
|||||||
* @param \Illuminate\View\Factory $view
|
* @param \Illuminate\View\Factory $view
|
||||||
*/
|
*/
|
||||||
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;
|
||||||
@@ -76,12 +76,22 @@ class GeneratorCommand extends Command
|
|||||||
*/
|
*/
|
||||||
public function fire()
|
public function fire()
|
||||||
{
|
{
|
||||||
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(
|
$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 {
|
} else {
|
||||||
$filename = $this->argument('filename');
|
$filename = $this->argument('filename');
|
||||||
|
$format = $this->option('format');
|
||||||
|
|
||||||
|
// Strip the php extension
|
||||||
|
if (substr($filename, -4, 4) == '.php') {
|
||||||
|
$filename = substr($filename, 0, -4);
|
||||||
|
}
|
||||||
|
|
||||||
|
$filename .= '.' . $format;
|
||||||
|
|
||||||
if ($this->option('memory')) {
|
if ($this->option('memory')) {
|
||||||
$this->useMemoryDriver();
|
$this->useMemoryDriver();
|
||||||
@@ -89,8 +99,8 @@ class GeneratorCommand extends Command
|
|||||||
|
|
||||||
|
|
||||||
$helpers = '';
|
$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)) {
|
if (file_exists($helper)) {
|
||||||
$helpers .= str_replace(array('<?php', '?>'), '', $this->files->get($helper));
|
$helpers .= str_replace(array('<?php', '?>'), '', $this->files->get($helper));
|
||||||
}
|
}
|
||||||
@@ -100,7 +110,7 @@ class GeneratorCommand extends Command
|
|||||||
}
|
}
|
||||||
|
|
||||||
$generator = new Generator($this->config, $this->view, $this->getOutput(), $helpers);
|
$generator = new Generator($this->config, $this->view, $this->getOutput(), $helpers);
|
||||||
$content = $generator->generate();
|
$content = $generator->generate($format);
|
||||||
$written = $this->files->put($filename, $content);
|
$written = $this->files->put($filename, $content);
|
||||||
|
|
||||||
if ($written !== false) {
|
if ($written !== false) {
|
||||||
@@ -131,12 +141,11 @@ class GeneratorCommand extends Command
|
|||||||
*/
|
*/
|
||||||
protected function getArguments()
|
protected function getArguments()
|
||||||
{
|
{
|
||||||
|
$filename = $this->config->get('ide-helper.filename');
|
||||||
|
|
||||||
return array(
|
return array(
|
||||||
array(
|
array(
|
||||||
'filename',
|
'filename', InputArgument::OPTIONAL, 'The path to the helper file', $filename
|
||||||
InputArgument::OPTIONAL,
|
|
||||||
'The path to the helper file',
|
|
||||||
$this->config->get('laravel-ide-helper::filename')
|
|
||||||
),
|
),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
@@ -148,11 +157,13 @@ class GeneratorCommand extends Command
|
|||||||
*/
|
*/
|
||||||
protected function getOptions()
|
protected function getOptions()
|
||||||
{
|
{
|
||||||
|
$format = $this->config->get('ide-helper.format');
|
||||||
|
|
||||||
return array(
|
return array(
|
||||||
|
array('format', "F", InputOption::VALUE_OPTIONAL, 'The format for the IDE Helper', $format),
|
||||||
array('helpers', "H", InputOption::VALUE_NONE, 'Include the helper files'),
|
array('helpers', "H", InputOption::VALUE_NONE, 'Include the helper files'),
|
||||||
array('memory', "M", InputOption::VALUE_NONE, 'Use sqlite memory driver'),
|
array('memory', "M", InputOption::VALUE_NONE, 'Use sqlite memory driver'),
|
||||||
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'),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,142 @@
|
|||||||
|
<?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';
|
||||||
|
protected $filename = '.phpstorm.meta.php';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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;
|
||||||
|
|
||||||
|
protected $methods = [
|
||||||
|
'new \Illuminate\Contracts\Container\Container',
|
||||||
|
'\Illuminate\Contracts\Container\Container::make(\'\')',
|
||||||
|
'\App::make(\'\')',
|
||||||
|
'app(\'\')',
|
||||||
|
];
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* @param \Illuminate\Contracts\Filesystem\Filesystem $files
|
||||||
|
* @param \Illuminate\Contracts\View\Factory $view
|
||||||
|
*/
|
||||||
|
public function __construct($files, $view)
|
||||||
|
{
|
||||||
|
$this->files = $files;
|
||||||
|
$this->view = $view;
|
||||||
|
parent::__construct();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Execute the console command.
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function fire()
|
||||||
|
{
|
||||||
|
$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('ide-helper::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
|
||||||
|
return array_keys($abstracts);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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()
|
||||||
|
{
|
||||||
|
return array(
|
||||||
|
array('filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the meta file', $this->filename),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
+118
-41
@@ -11,14 +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 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\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
|
||||||
@@ -27,6 +30,10 @@ use phpDocumentor\Reflection\DocBlock\Serializer as DocBlockSerializer;
|
|||||||
*/
|
*/
|
||||||
class ModelsCommand extends Command
|
class ModelsCommand extends Command
|
||||||
{
|
{
|
||||||
|
/**
|
||||||
|
* @var Filesystem $files
|
||||||
|
*/
|
||||||
|
protected $files;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The console command name.
|
* The console command name.
|
||||||
@@ -49,6 +56,14 @@ class ModelsCommand extends Command
|
|||||||
protected $dirs = array();
|
protected $dirs = array();
|
||||||
protected $reset;
|
protected $reset;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param Filesystem $files
|
||||||
|
*/
|
||||||
|
public function __construct(Filesystem $files)
|
||||||
|
{
|
||||||
|
parent::__construct();
|
||||||
|
$this->files = $files;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Execute the console command.
|
* Execute the console command.
|
||||||
@@ -60,7 +75,7 @@ class ModelsCommand extends Command
|
|||||||
$filename = $this->option('filename');
|
$filename = $this->option('filename');
|
||||||
$this->write = $this->option('write');
|
$this->write = $this->option('write');
|
||||||
$this->dirs = array_merge(
|
$this->dirs = array_merge(
|
||||||
$this->laravel['config']->get('laravel-ide-helper::model_locations'),
|
$this->laravel['config']->get('ide-helper.model_locations'),
|
||||||
$this->option('dir')
|
$this->option('dir')
|
||||||
);
|
);
|
||||||
$model = $this->argument('model');
|
$model = $this->argument('model');
|
||||||
@@ -80,7 +95,7 @@ class ModelsCommand extends Command
|
|||||||
$content = $this->generateDocs($model, $ignore);
|
$content = $this->generateDocs($model, $ignore);
|
||||||
|
|
||||||
if (!$this->write) {
|
if (!$this->write) {
|
||||||
$written = \File::put($filename, $content);
|
$written = $this->files->put($filename, $content);
|
||||||
if ($written !== false) {
|
if ($written !== false) {
|
||||||
$this->info("Model information was written to $filename");
|
$this->info("Model information was written to $filename");
|
||||||
} else {
|
} else {
|
||||||
@@ -148,10 +163,10 @@ class ModelsCommand extends Command
|
|||||||
|
|
||||||
foreach ($models as $name) {
|
foreach ($models as $name) {
|
||||||
if (in_array($name, $ignore)) {
|
if (in_array($name, $ignore)) {
|
||||||
|
if ($this->output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
|
||||||
$this->comment("Ignoring model '$name'");
|
$this->comment("Ignoring model '$name'");
|
||||||
|
}
|
||||||
continue;
|
continue;
|
||||||
} else {
|
|
||||||
$this->comment("Loading model '$name'");
|
|
||||||
}
|
}
|
||||||
$this->properties = array();
|
$this->properties = array();
|
||||||
$this->methods = array();
|
$this->methods = array();
|
||||||
@@ -159,33 +174,39 @@ class ModelsCommand extends Command
|
|||||||
try {
|
try {
|
||||||
// handle abstract classes, interfaces, ...
|
// 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;
|
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) {
|
if ($hasDoctrine) {
|
||||||
$this->getPropertiesFromTable($model);
|
$this->getPropertiesFromTable($model);
|
||||||
}
|
}
|
||||||
|
|
||||||
$this->getPropertiesFromMethods($model);
|
$this->getPropertiesFromMethods($model);
|
||||||
$output .= $this->createPhpDocs($name);
|
$output .= $this->createPhpDocs($name);
|
||||||
|
$ignore[] = $name;
|
||||||
} catch (\Exception $e) {
|
} catch (\Exception $e) {
|
||||||
$this->error("Exception: " . $e->getMessage() . "\nCould not analyze class $name.");
|
$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) {
|
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`.'
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -217,9 +238,21 @@ class ModelsCommand extends Command
|
|||||||
{
|
{
|
||||||
$table = $model->getConnection()->getTablePrefix() . $model->getTable();
|
$table = $model->getConnection()->getTablePrefix() . $model->getTable();
|
||||||
$schema = $model->getConnection()->getDoctrineSchemaManager($table);
|
$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) {
|
if ($columns) {
|
||||||
foreach ($columns as $column) {
|
foreach ($columns as $column) {
|
||||||
@@ -256,8 +289,8 @@ class ModelsCommand extends Command
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
$comment = $column->getComment();
|
||||||
$this->setProperty($name, $type, true, true);
|
$this->setProperty($name, $type, true, true, $comment);
|
||||||
$this->setMethod(
|
$this->setMethod(
|
||||||
Str::camel("where_" . $name),
|
Str::camel("where_" . $name),
|
||||||
'\Illuminate\Database\Query\Builder|\\' . get_class($model),
|
'\Illuminate\Database\Query\Builder|\\' . get_class($model),
|
||||||
@@ -303,10 +336,11 @@ class ModelsCommand extends Command
|
|||||||
$args = $this->getParameters($reflection);
|
$args = $this->getParameters($reflection);
|
||||||
//Remove the first ($query) argument
|
//Remove the first ($query) argument
|
||||||
array_shift($args);
|
array_shift($args);
|
||||||
$this->setMethod($name, '\\' . $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);
|
||||||
|
|
||||||
@@ -318,39 +352,53 @@ class ModelsCommand extends Command
|
|||||||
$code .= $file->current();
|
$code .= $file->current();
|
||||||
$file->next();
|
$file->next();
|
||||||
}
|
}
|
||||||
|
$code = trim(preg_replace('/\s\s+/', '', $code));
|
||||||
$begin = strpos($code, 'function(');
|
$begin = strpos($code, 'function(');
|
||||||
$code = substr($code, $begin, strrpos($code, '}') - $begin + 1);
|
$code = substr($code, $begin, strrpos($code, '}') - $begin + 1);
|
||||||
|
|
||||||
foreach (array(
|
foreach (array(
|
||||||
'hasMany',
|
'hasMany',
|
||||||
|
'hasManyThrough',
|
||||||
'belongsToMany',
|
'belongsToMany',
|
||||||
'hasOne',
|
'hasOne',
|
||||||
'belongsTo',
|
'belongsTo',
|
||||||
|
'morphOne',
|
||||||
'morphTo',
|
'morphTo',
|
||||||
'morphMany',
|
'morphMany',
|
||||||
'morphToMany'
|
'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.
|
||||||
$arguments = explode(',', substr($code, 0, stripos($code, ')')));
|
$relationObj = $model->$method();
|
||||||
//Remove quotes, ensure 1 \ in front of the model
|
|
||||||
$returnModel = "\\" . ltrim(trim($arguments[0], " \"'"), "\\");
|
if ($relationObj instanceof Relation) {
|
||||||
if ($relation === "belongsToMany" or $relation === 'hasMany' or $relation === 'morphMany' or $relation === 'morphToMany') {
|
$relatedModel = '\\' . get_class($relationObj->getRelated());
|
||||||
|
|
||||||
|
$relations = ['hasManyThrough', 'belongsToMany', 'hasMany', 'morphMany', 'morphToMany'];
|
||||||
|
if (in_array($relation, $relations)) {
|
||||||
//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);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -361,14 +409,16 @@ class ModelsCommand extends Command
|
|||||||
* @param string|null $type
|
* @param string|null $type
|
||||||
* @param bool|null $read
|
* @param bool|null $read
|
||||||
* @param bool|null $write
|
* @param bool|null $write
|
||||||
|
* @param string|null $comment
|
||||||
*/
|
*/
|
||||||
protected function setProperty($name, $type = null, $read = null, $write = null)
|
protected function setProperty($name, $type = null, $read = null, $write = null, $comment = '')
|
||||||
{
|
{
|
||||||
if (!isset($this->properties[$name])) {
|
if (!isset($this->properties[$name])) {
|
||||||
$this->properties[$name] = array();
|
$this->properties[$name] = array();
|
||||||
$this->properties[$name]['type'] = 'mixed';
|
$this->properties[$name]['type'] = 'mixed';
|
||||||
$this->properties[$name]['read'] = false;
|
$this->properties[$name]['read'] = false;
|
||||||
$this->properties[$name]['write'] = false;
|
$this->properties[$name]['write'] = false;
|
||||||
|
$this->properties[$name]['comment'] = (string) $comment;
|
||||||
}
|
}
|
||||||
if ($type !== null) {
|
if ($type !== null) {
|
||||||
$this->properties[$name]['type'] = $type;
|
$this->properties[$name]['type'] = $type;
|
||||||
@@ -383,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;
|
||||||
@@ -435,7 +487,8 @@ class ModelsCommand extends Command
|
|||||||
} else {
|
} else {
|
||||||
$attr = 'property-read';
|
$attr = 'property-read';
|
||||||
}
|
}
|
||||||
$tag = Tag::createInstance("@{$attr} {$property['type']} {$name}", $phpdoc);
|
$tagLine = trim("@{$attr} {$property['type']} {$name} {$property['comment']}");
|
||||||
|
$tag = Tag::createInstance($tagLine, $phpdoc);
|
||||||
$phpdoc->appendTag($tag);
|
$phpdoc->appendTag($tag);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -448,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);
|
||||||
@@ -455,7 +512,7 @@ class ModelsCommand extends Command
|
|||||||
|
|
||||||
if ($this->write) {
|
if ($this->write) {
|
||||||
$filename = $reflection->getFileName();
|
$filename = $reflection->getFileName();
|
||||||
$contents = \File::get($filename);
|
$contents = $this->files->get($filename);
|
||||||
if ($originalDoc) {
|
if ($originalDoc) {
|
||||||
$contents = str_replace($originalDoc, $docComment, $contents);
|
$contents = str_replace($originalDoc, $docComment, $contents);
|
||||||
} else {
|
} else {
|
||||||
@@ -466,12 +523,12 @@ class ModelsCommand extends Command
|
|||||||
$contents = substr_replace($contents, $replace, $pos, strlen($needle));
|
$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);
|
$this->info('Written new phpDocBlock to ' . $filename);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
$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;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -486,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';
|
||||||
@@ -509,4 +567,23 @@ class ModelsCommand extends Command
|
|||||||
return $paramsWithDefault;
|
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());
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+131
-25
@@ -10,8 +10,10 @@
|
|||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper;
|
namespace Barryvdh\LaravelIdeHelper;
|
||||||
|
|
||||||
|
use Illuminate\Foundation\Application;
|
||||||
use Illuminate\Foundation\AliasLoader;
|
use Illuminate\Foundation\AliasLoader;
|
||||||
use Illuminate\Config\Repository as ConfigRepository;
|
use Illuminate\Config\Repository as ConfigRepository;
|
||||||
|
use ReflectionClass;
|
||||||
use Symfony\Component\Console\Output\OutputInterface;
|
use Symfony\Component\Console\Output\OutputInterface;
|
||||||
|
|
||||||
class Generator
|
class Generator
|
||||||
@@ -36,7 +38,8 @@ class Generator
|
|||||||
* @param \Symfony\Component\Console\Output\OutputInterface $output
|
* @param \Symfony\Component\Console\Output\OutputInterface $output
|
||||||
* @param string $helpers
|
* @param string $helpers
|
||||||
*/
|
*/
|
||||||
public function __construct(ConfigRepository $config,
|
public function __construct(
|
||||||
|
/*ConfigRepository */ $config,
|
||||||
/* Illuminate\View\Factory */ $view,
|
/* Illuminate\View\Factory */ $view,
|
||||||
OutputInterface $output = null,
|
OutputInterface $output = null,
|
||||||
$helpers = ''
|
$helpers = ''
|
||||||
@@ -47,74 +50,139 @@ class Generator
|
|||||||
// Find the drivers to add to the extra/interfaces
|
// Find the drivers to add to the extra/interfaces
|
||||||
$this->detectDrivers();
|
$this->detectDrivers();
|
||||||
|
|
||||||
$this->extra = array_merge($this->extra, $this->config->get('laravel-ide-helper::extra'));
|
$this->extra = array_merge($this->extra, $this->config->get('ide-helper.extra'));
|
||||||
$this->magic = array_merge($this->magic, $this->config->get('laravel-ide-helper::magic'));
|
$this->magic = array_merge($this->magic, $this->config->get('ide-helper.magic'));
|
||||||
$this->interfaces = array_merge($this->interfaces, $this->config->get('laravel-ide-helper::interfaces'));
|
$this->interfaces = array_merge($this->interfaces, $this->config->get('ide-helper.interfaces'));
|
||||||
|
// Make all interface classes absolute
|
||||||
|
foreach ($this->interfaces as &$interface) {
|
||||||
|
$interface = '\\' . ltrim($interface, '\\');
|
||||||
|
}
|
||||||
$this->helpers = $helpers;
|
$this->helpers = $helpers;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Generate the helper file contents;
|
* Generate the helper file contents;
|
||||||
*
|
*
|
||||||
|
* @param string $format The format to generate the helper in (php/json)
|
||||||
* @return string;
|
* @return string;
|
||||||
*/
|
*/
|
||||||
public function generate()
|
public function generate($format = 'php')
|
||||||
|
{
|
||||||
|
// Check if the generator for this format exists
|
||||||
|
$method = 'generate'.ucfirst($format).'Helper';
|
||||||
|
if (method_exists($this, $method)) {
|
||||||
|
return $this->$method();
|
||||||
|
}
|
||||||
|
|
||||||
|
return $this->generatePhpHelper();
|
||||||
|
}
|
||||||
|
|
||||||
|
public function generatePhpHelper()
|
||||||
{
|
{
|
||||||
$app = app();
|
$app = app();
|
||||||
return $this->view->make('laravel-ide-helper::ide-helper')
|
return $this->view->make('ide-helper::helper')
|
||||||
->with('namespaces', $this->getNamespaces())
|
->with('namespaces', $this->getNamespaces())
|
||||||
->with('helpers', $this->helpers)
|
->with('helpers', $this->helpers)
|
||||||
->with('version', $app::VERSION)
|
->with('version', $app->version())
|
||||||
->render();
|
->render();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function generateJsonHelper()
|
||||||
|
{
|
||||||
|
$classes = array();
|
||||||
|
foreach ($this->getNamespaces() as $aliases) {
|
||||||
|
foreach ($aliases as $alias) {
|
||||||
|
$functions = array();
|
||||||
|
foreach ($alias->getMethods() as $method) {
|
||||||
|
$functions[$method->getName()] = '('. $method->getParamsWithDefault().')';
|
||||||
|
}
|
||||||
|
$classes[$alias->getAlias()] = array(
|
||||||
|
'functions' => $functions,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$flags = JSON_FORCE_OBJECT;
|
||||||
|
if (defined('JSON_PRETTY_PRINT')) {
|
||||||
|
$flags |= JSON_PRETTY_PRINT;
|
||||||
|
}
|
||||||
|
|
||||||
|
return json_encode(array(
|
||||||
|
'php' => array(
|
||||||
|
'classes' => $classes,
|
||||||
|
),
|
||||||
|
), $flags);
|
||||||
|
}
|
||||||
|
|
||||||
protected function detectDrivers()
|
protected function detectDrivers()
|
||||||
{
|
{
|
||||||
|
$defaultUserModel = config('auth.providers.users.model', config('auth.model', 'App\User'));
|
||||||
|
$this->interfaces['\Illuminate\Contracts\Auth\Authenticatable'] = $defaultUserModel;
|
||||||
|
|
||||||
try {
|
try {
|
||||||
if (class_exists('Auth')) {
|
if (class_exists('Auth') && is_a('Auth', '\Illuminate\Support\Facades\Auth', true)) {
|
||||||
$class = get_class(\Auth::driver());
|
if (class_exists('\Illuminate\Foundation\Application')) {
|
||||||
|
$authMethod = version_compare(Application::VERSION, '5.2', '>=') ? 'guard' : 'driver';
|
||||||
|
} else {
|
||||||
|
$refClass = new ReflectionClass('\Laravel\Lumen\Application');
|
||||||
|
$versionStr = $refClass->newInstanceWithoutConstructor()->version();
|
||||||
|
$authMethod = strpos($versionStr, 'Lumen (5.0') === 0 ?
|
||||||
|
'driver' :
|
||||||
|
(strpos($versionStr, 'Lumen (5.1') === 0 ? 'driver' : 'guard');
|
||||||
|
}
|
||||||
|
$class = get_class(\Auth::$authMethod());
|
||||||
$this->extra['Auth'] = array($class);
|
$this->extra['Auth'] = array($class);
|
||||||
$this->interfaces['\Illuminate\Auth\UserProviderInterface'] = $class;
|
$this->interfaces['\Illuminate\Auth\UserProviderInterface'] = $class;
|
||||||
}
|
}
|
||||||
}catch (\Exception $e) {}
|
} catch (\Exception $e) {
|
||||||
|
}
|
||||||
|
|
||||||
try {
|
try {
|
||||||
if (class_exists('DB')) {
|
if (class_exists('DB') && is_a('DB', '\Illuminate\Support\Facades\DB', true)) {
|
||||||
$class = get_class(\DB::connection());
|
$class = get_class(\DB::connection());
|
||||||
$this->extra['DB'] = array($class);
|
$this->extra['DB'] = array($class);
|
||||||
$this->interfaces['\Illuminate\Database\ConnectionInterface'] = $class;
|
$this->interfaces['\Illuminate\Database\ConnectionInterface'] = $class;
|
||||||
}
|
}
|
||||||
}catch (\Exception $e) {}
|
} catch (\Exception $e) {
|
||||||
|
}
|
||||||
|
|
||||||
try {
|
try {
|
||||||
if (class_exists('Cache')) {
|
if (class_exists('Cache') && is_a('Cache', '\Illuminate\Support\Facades\Cache', true)) {
|
||||||
$driver = get_class(\Cache::driver());
|
$driver = get_class(\Cache::driver());
|
||||||
$store = get_class(\Cache::getStore());
|
$store = get_class(\Cache::getStore());
|
||||||
$this->extra['Cache'] = array($driver, $store);
|
$this->extra['Cache'] = array($driver, $store);
|
||||||
$this->interfaces['\Illuminate\Cache\StoreInterface'] = $store;
|
$this->interfaces['\Illuminate\Cache\StoreInterface'] = $store;
|
||||||
}
|
}
|
||||||
}catch (\Exception $e) {}
|
} catch (\Exception $e) {
|
||||||
|
}
|
||||||
|
|
||||||
try {
|
try {
|
||||||
if (class_exists('Queue')) {
|
if (class_exists('Queue') && is_a('Queue', '\Illuminate\Support\Facades\Queue', true)) {
|
||||||
$class = get_class(\Queue::connection());
|
$class = get_class(\Queue::connection());
|
||||||
$this->extra['Queue'] = array($class);
|
$this->extra['Queue'] = array($class);
|
||||||
$this->interfaces['\Illuminate\Queue\QueueInterface'] = $class;
|
$this->interfaces['\Illuminate\Queue\QueueInterface'] = $class;
|
||||||
}
|
}
|
||||||
}catch (\Exception $e) {}
|
} catch (\Exception $e) {
|
||||||
|
}
|
||||||
|
|
||||||
try {
|
try {
|
||||||
if (class_exists('SSH')){
|
if (class_exists('SSH') && is_a('SSH', '\Illuminate\Support\Facades\SSH', true)) {
|
||||||
$class = get_class(\SSH::connection());
|
$class = get_class(\SSH::connection());
|
||||||
$this->extra['SSH'] = array($class);
|
$this->extra['SSH'] = array($class);
|
||||||
$this->interfaces['\Illuminate\Remote\ConnectionInterface'] = $class;
|
$this->interfaces['\Illuminate\Remote\ConnectionInterface'] = $class;
|
||||||
}
|
}
|
||||||
}catch (\Exception $e) {}
|
} catch (\Exception $e) {
|
||||||
|
|
||||||
// Make all interface classes absolute
|
|
||||||
foreach ($this->interfaces as &$interface) {
|
|
||||||
$interface = '\\' . ltrim($interface, '\\');
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
if (class_exists('Storage') && is_a('Storage', '\Illuminate\Support\Facades\Storage', true)) {
|
||||||
|
$class = get_class(\Storage::disk());
|
||||||
|
$this->extra['Storage'] = array($class);
|
||||||
|
$this->interfaces['\Illuminate\Contracts\Filesystem\Filesystem'] = $class;
|
||||||
|
}
|
||||||
|
} catch (\Exception $e) {
|
||||||
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -127,11 +195,15 @@ class Generator
|
|||||||
$namespaces = array();
|
$namespaces = array();
|
||||||
|
|
||||||
// Get all aliases
|
// Get all aliases
|
||||||
foreach (AliasLoader::getInstance()->getAliases() as $name => $facade) {
|
foreach ($this->getAliases() as $name => $facade) {
|
||||||
|
// Skip the Redis facade, if not available (otherwise Fatal PHP Error)
|
||||||
|
if ($facade == 'Illuminate\Support\Facades\Redis' && !class_exists('Predis\Client')) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
$magicMethods = array_key_exists($name, $this->magic) ? $this->magic[$name] : array();
|
$magicMethods = array_key_exists($name, $this->magic) ? $this->magic[$name] : array();
|
||||||
$alias = new Alias($name, $facade, $magicMethods, $this->interfaces);
|
$alias = new Alias($name, $facade, $magicMethods, $this->interfaces);
|
||||||
if ($alias->isValid()) {
|
if ($alias->isValid()) {
|
||||||
|
|
||||||
//Add extra methods, from other classes (magic static calls)
|
//Add extra methods, from other classes (magic static calls)
|
||||||
if (array_key_exists($name, $this->extra)) {
|
if (array_key_exists($name, $this->extra)) {
|
||||||
$alias->addClass($this->extra[$name]);
|
$alias->addClass($this->extra[$name]);
|
||||||
@@ -143,12 +215,46 @@ class Generator
|
|||||||
}
|
}
|
||||||
$namespaces[$namespace][] = $alias;
|
$namespaces[$namespace][] = $alias;
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return $namespaces;
|
return $namespaces;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
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',
|
||||||
|
];
|
||||||
|
|
||||||
|
$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);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the driver/connection/store from the managers
|
* Get the driver/connection/store from the managers
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -11,9 +11,9 @@
|
|||||||
namespace Barryvdh\LaravelIdeHelper;
|
namespace Barryvdh\LaravelIdeHelper;
|
||||||
|
|
||||||
use Illuminate\Support\ServiceProvider;
|
use Illuminate\Support\ServiceProvider;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Console\MetaCommand;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||||
use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
|
use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
|
||||||
use Barryvdh\LaravelIdeHelper\Console\Generator2Command;
|
|
||||||
Use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
|
||||||
|
|
||||||
class IdeHelperServiceProvider extends ServiceProvider
|
class IdeHelperServiceProvider extends ServiceProvider
|
||||||
{
|
{
|
||||||
@@ -32,7 +32,16 @@ class IdeHelperServiceProvider extends ServiceProvider
|
|||||||
*/
|
*/
|
||||||
public function boot()
|
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,6 +51,9 @@ class IdeHelperServiceProvider extends ServiceProvider
|
|||||||
*/
|
*/
|
||||||
public function register()
|
public function register()
|
||||||
{
|
{
|
||||||
|
$configPath = __DIR__ . '/../config/ide-helper.php';
|
||||||
|
$this->mergeConfigFrom($configPath, 'ide-helper');
|
||||||
|
|
||||||
$this->app['command.ide-helper.generate'] = $this->app->share(
|
$this->app['command.ide-helper.generate'] = $this->app->share(
|
||||||
function ($app) {
|
function ($app) {
|
||||||
return new GeneratorCommand($app['config'], $app['files'], $app['view']);
|
return new GeneratorCommand($app['config'], $app['files'], $app['view']);
|
||||||
@@ -49,12 +61,18 @@ class IdeHelperServiceProvider extends ServiceProvider
|
|||||||
);
|
);
|
||||||
|
|
||||||
$this->app['command.ide-helper.models'] = $this->app->share(
|
$this->app['command.ide-helper.models'] = $this->app->share(
|
||||||
function () {
|
function ($app) {
|
||||||
return new ModelsCommand();
|
return new ModelsCommand($app['files']);
|
||||||
}
|
}
|
||||||
);
|
);
|
||||||
|
|
||||||
$this->commands('command.ide-helper.generate', 'command.ide-helper.models');
|
$this->app['command.ide-helper.meta'] = $this->app->share(
|
||||||
|
function ($app) {
|
||||||
|
return new MetaCommand($app['files'], $app['view']);
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->commands('command.ide-helper.generate', 'command.ide-helper.models', 'command.ide-helper.meta');
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -66,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');
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|||||||
+14
-11
@@ -10,16 +10,16 @@
|
|||||||
|
|
||||||
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 */
|
||||||
@@ -36,7 +36,7 @@ class Method
|
|||||||
/**
|
/**
|
||||||
* @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
|
||||||
*/
|
*/
|
||||||
@@ -55,7 +55,8 @@ class Method
|
|||||||
$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
|
//Get the parameters, including formatted default values
|
||||||
$this->getParameters($method);
|
$this->getParameters($method);
|
||||||
@@ -249,7 +250,7 @@ class Method
|
|||||||
/**
|
/**
|
||||||
* Get the parameters and format them correctly
|
* Get the parameters and format them correctly
|
||||||
*
|
*
|
||||||
* @param $method
|
* @param \ReflectionMethod $method
|
||||||
* @return array
|
* @return array
|
||||||
*/
|
*/
|
||||||
public function getParameters($method)
|
public function getParameters($method)
|
||||||
@@ -261,7 +262,7 @@ class Method
|
|||||||
$paramStr = '$' . $param->getName();
|
$paramStr = '$' . $param->getName();
|
||||||
$params[] = $paramStr;
|
$params[] = $paramStr;
|
||||||
if ($param->isOptional()) {
|
if ($param->isOptional()) {
|
||||||
$default = $param->getDefaultValue();
|
$default = $param->isDefaultValueAvailable() ? $param->getDefaultValue() : null;
|
||||||
if (is_bool($default)) {
|
if (is_bool($default)) {
|
||||||
$default = $default ? 'true' : 'false';
|
$default = $default ? 'true' : 'false';
|
||||||
} elseif (is_array($default)) {
|
} elseif (is_array($default)) {
|
||||||
@@ -270,6 +271,8 @@ class Method
|
|||||||
$default = 'null';
|
$default = 'null';
|
||||||
} elseif (is_int($default)) {
|
} elseif (is_int($default)) {
|
||||||
//$default = $default;
|
//$default = $default;
|
||||||
|
} elseif (is_resource($default)) {
|
||||||
|
//skip to not fail
|
||||||
} else {
|
} else {
|
||||||
$default = "'" . trim($default) . "'";
|
$default = "'" . trim($default) . "'";
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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;
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user