mirror of
https://github.com/barryvdh/laravel-ide-helper.git
synced 2026-08-18 18:13:11 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
555d3e3700 | ||
|
|
963ead0a01 | ||
|
|
8c306035aa | ||
|
|
f1e93f042d | ||
|
|
5280b47750 | ||
|
|
525733122e | ||
|
|
a7fc2ec489 | ||
|
|
8caca941b3 | ||
|
|
e96943fe6f | ||
|
|
df3ecb2843 | ||
|
|
105f14a50d | ||
|
|
5fad258f5d | ||
|
|
13e65d3885 | ||
|
|
22612733a2 | ||
|
|
dc476f9736 | ||
|
|
71cb03ca6a | ||
|
|
abe2df5853 | ||
|
|
2de6ab6038 | ||
|
|
c229335651 | ||
|
|
495361e501 | ||
|
|
7583353915 | ||
|
|
16c570c589 | ||
|
|
884eaeeb1a | ||
|
|
b6706683b2 | ||
|
|
6f9b90c204 | ||
|
|
e1a0f034a1 | ||
|
|
b75f879383 | ||
|
|
ad800d197f | ||
|
|
f3a3533b2d | ||
|
|
e938cd3a31 | ||
|
|
f8c6ec95f6 | ||
|
|
0a4ff969d2 | ||
|
|
4b47c0b61c | ||
|
|
7598293bc6 | ||
|
|
035b14176b | ||
|
|
cb08c6ff81 | ||
|
|
28af7cd19c | ||
|
|
8f004f5d6b | ||
|
|
da677f1ba5 | ||
|
|
321844d9a5 | ||
|
|
928389d7a4 | ||
|
|
dbfcfd66c5 | ||
|
|
a9484c67d1 | ||
|
|
3064296216 | ||
|
|
f057a4f820 | ||
|
|
091f78508c | ||
|
|
cf4fcd810c | ||
|
|
d3203de671 | ||
|
|
093171e01f | ||
|
|
2d82419167 | ||
|
|
0e84805e37 | ||
|
|
7a07515149 | ||
|
|
bae462604e | ||
|
|
b28c8cbae1 | ||
|
|
d734ecabcc | ||
|
|
4f227d5c57 | ||
|
|
35ebf3a2ba | ||
|
|
f7b31bdbdc | ||
|
|
8de1673535 | ||
|
|
d818b72f82 | ||
|
|
e97ed532f0 | ||
|
|
606183ea12 | ||
|
|
a72cd81e5f | ||
|
|
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 |
@@ -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.
|
||||||
+18
-6
@@ -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.5",
|
||||||
"illuminate/console": "5.0.x|5.1.x",
|
"illuminate/console": "^5.0,<5.5",
|
||||||
"illuminate/filesystem": "5.0.x|5.1.x",
|
"illuminate/filesystem": "^5.0,<5.5",
|
||||||
"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,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": "2.1-dev"
|
"dev-master": "2.2-dev"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+50
-1
@@ -14,6 +14,17 @@ return array(
|
|||||||
'filename' => '_ide_helper',
|
'filename' => '_ide_helper',
|
||||||
'format' => 'php',
|
'format' => 'php',
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Fluent helpers
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| Set to true to generate commonly used Fluent methods
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
'include_fluent' => false,
|
||||||
|
|
||||||
/*
|
/*
|
||||||
|--------------------------------------------------------------------------
|
|--------------------------------------------------------------------------
|
||||||
| Helper files to include
|
| Helper files to include
|
||||||
@@ -83,7 +94,7 @@ return array(
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
'interfaces' => array(
|
'interfaces' => array(
|
||||||
'\Illuminate\Contracts\Auth\Authenticatable' => config('auth.model', 'App\User'),
|
|
||||||
),
|
),
|
||||||
|
|
||||||
/*
|
/*
|
||||||
@@ -116,4 +127,42 @@ return array(
|
|||||||
|
|
||||||
),
|
),
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Support for camel cased models
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| There are some Laravel packages (such as Eloquence) that allow for accessing
|
||||||
|
| Eloquent model properties via camel case, instead of snake case.
|
||||||
|
|
|
||||||
|
| Enabling this option will support these packages by saving all model
|
||||||
|
| properties as camel case, instead of snake case.
|
||||||
|
|
|
||||||
|
| For example, normally you would see this:
|
||||||
|
|
|
||||||
|
| * @property \Carbon\Carbon $created_at
|
||||||
|
| * @property \Carbon\Carbon $updated_at
|
||||||
|
|
|
||||||
|
| With this enabled, the properties will be this:
|
||||||
|
|
|
||||||
|
| * @property \Carbon\Carbon $createdAt
|
||||||
|
| * @property \Carbon\Carbon $updatedAt
|
||||||
|
|
|
||||||
|
| Note, it is currently an all-or-nothing option.
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
'model_camel_case_properties' => false,
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Property Casts
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| Cast the given "real type" to the given "type".
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
'type_overrides' => array(
|
||||||
|
'integer' => 'int',
|
||||||
|
'boolean' => 'bool',
|
||||||
|
),
|
||||||
);
|
);
|
||||||
|
|||||||
@@ -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,12 +1,20 @@
|
|||||||
## Laravel 5 IDE Helper Generator
|
## Laravel 5 IDE Helper Generator
|
||||||
[](https://packagist.org/packages/barryvdh/laravel-ide-helper) [](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
|
||||||
|
|
||||||
_Check out [this Laracasts video](https://laracasts.com/series/how-to-be-awesome-in-phpstorm/episodes/15) for a quick introduction/explanation!_
|
_Check out [this Laracasts video](https://laracasts.com/series/how-to-be-awesome-in-phpstorm/episodes/15) for a quick introduction/explanation!_
|
||||||
|
|
||||||
|
* [`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,76 +24,97 @@ 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:
|
||||||
|
|
||||||
|
```bash
|
||||||
composer require barryvdh/laravel-ide-helper
|
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`
|
||||||
|
|
||||||
|
```php
|
||||||
Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class,
|
Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class,
|
||||||
|
```
|
||||||
|
|
||||||
|
To install this package on only development systems, add the `--dev` flag to your composer command:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
composer require --dev barryvdh/laravel-ide-helper
|
||||||
|
```
|
||||||
|
|
||||||
|
In Laravel, instead of adding the service provider in the `config/app.php` file, you can add the following code to your `app/Providers/AppServiceProvider.php` file, within the `register()` method:
|
||||||
|
|
||||||
|
```php
|
||||||
|
public function register()
|
||||||
|
{
|
||||||
|
if ($this->app->environment() !== 'production') {
|
||||||
|
$this->app->register(\Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class);
|
||||||
|
}
|
||||||
|
// ...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
This will allow your application to load the Laravel IDE Helper on non-production enviroments.
|
||||||
|
|
||||||
|
### Automatic phpDoc generation for Laravel Facades
|
||||||
|
|
||||||
You can now re-generate the docs yourself (for future updates)
|
You can now re-generate the docs yourself (for future updates)
|
||||||
|
|
||||||
|
```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 ide-helper:meta",
|
||||||
"php artisan optimize"
|
"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`.
|
||||||
|
|
||||||
|
```bash
|
||||||
php artisan vendor:publish --provider="Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider" --tag=config
|
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 default working 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 an in-memory SQLite driver, using the -M option.
|
You can use an in-memory SQLite driver by adding the -M option.
|
||||||
|
|
||||||
You can choose to include helper files. This is not enabled by default, but you can override it 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
|
### Automatic phpDocs for models
|
||||||
|
|
||||||
> 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.
|
||||||
|
|
||||||
|
```bash
|
||||||
php artisan ide-helper:models Post
|
php artisan ide-helper:models Post
|
||||||
|
```
|
||||||
|
|
||||||
|
```php
|
||||||
/**
|
/**
|
||||||
* An Eloquent Model: 'Post'
|
* An Eloquent Model: 'Post'
|
||||||
*
|
*
|
||||||
@@ -98,23 +127,130 @@ With the `--reset (-R)` option, the existing phpdocs are ignored, and only the n
|
|||||||
* @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):
|
||||||
|
|
||||||
|
```bash
|
||||||
php artisan ide-helper:models --dir="path/to/models" --dir="app/src/Model"
|
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
|
||||||
|
|
||||||
|
```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`)
|
||||||
|
|
||||||
|
### Automatic phpDocs generation for Laravel Fluent methods
|
||||||
|
If you need phpDocs support for Fluent methods in migration, for example
|
||||||
|
```php
|
||||||
|
$table->string(“somestring”)->nullable()->index();
|
||||||
|
```
|
||||||
|
After publishing vendor, simply change the `include_fluent` line your `config/ide-helper.php` file into:
|
||||||
|
```php
|
||||||
|
'include_fluent' => true,
|
||||||
|
```
|
||||||
|
And then run `php artisan ide-helper:generate` , you will now see all of the Fluent methods are recognized by your IDE now.
|
||||||
|
|
||||||
|
|
||||||
|
## PhpStorm Meta for Container instances
|
||||||
|
|
||||||
|
It's possible to generate a PhpStorm meta file to [add support for factory design pattern](https://confluence.jetbrains.com/display/PhpStorm/PhpStorm+Advanced+Metadata). For Laravel, this means we can make PhpStorm understand what kind of object we are resolving from the IoC Container. For example, `events` will return an `Illuminate\Events\Dispatcher` object, so with the meta file you can call `app('events')` and it will autocomplete the Dispatcher methods.
|
||||||
|
|
||||||
|
``` bash
|
||||||
|
php artisan ide-helper:meta
|
||||||
|
```
|
||||||
|
|
||||||
|
```php
|
||||||
|
app('events')->fire();
|
||||||
|
\App::make('events')->fire();
|
||||||
|
|
||||||
|
/** @var \Illuminate\Foundation\Application $app */
|
||||||
|
$app->make('events')->fire();
|
||||||
|
|
||||||
|
// When the key is not found, it uses the argument as class name
|
||||||
|
app('App\SomeClass');
|
||||||
|
```
|
||||||
|
|
||||||
|
Pre-generated example: https://gist.github.com/barryvdh/bb6ffc5d11e0a75dba67
|
||||||
|
|
||||||
|
> Note: You might need to restart PhpStorm and make sure `.phpstorm.meta.php` is indexed.
|
||||||
|
> Note: When you receive a FatalException about a class that is not found, check your config (for example, remove S3 as cloud driver when you don't have S3 configured. Remove Redis ServiceProvider when you don't use it).
|
||||||
|
|
||||||
|
## Lumen Install
|
||||||
|
|
||||||
|
This package is focused on Laravel development, but it can also be used in Lumen with some workarounds. Because Lumen works a little different, as it is like a barebone version of Laravel and the main configuration parameters are instead located in `bootstrap/app.php`, some alterations must be made.
|
||||||
|
|
||||||
|
#### Enabling Facades
|
||||||
|
|
||||||
|
While Laravel IDE Helper can generate automatically default Facades for code hinting, Lumen doesn't come with Facades activated. If you plan in using them, you must enable them under the `Create The Application` section, uncommenting this line:
|
||||||
|
|
||||||
|
```php
|
||||||
|
// $app->withFacades();
|
||||||
|
```
|
||||||
|
|
||||||
|
From there, you should be able to use the `create_alias()` function to add additional Facades into your application.
|
||||||
|
|
||||||
|
#### Adding the Service Provider
|
||||||
|
|
||||||
|
You can install Laravel IDE Helper in `app/Providers/AppServiceProvider.php`, and uncommenting this line that registers the App Service Providers so it can properly load.
|
||||||
|
|
||||||
|
```php
|
||||||
|
// $app->register(App\Providers\AppServiceProvider::class);
|
||||||
|
```
|
||||||
|
|
||||||
|
If you are not using that line, that is usually handy to manage gracefully multiple Laravel/Lumen installations, you will have to add this line of code under the `Register Service Providers` section of your `bootstrap/app.php`.
|
||||||
|
|
||||||
|
```php
|
||||||
|
if ($app->environment() !== 'production') {
|
||||||
|
$app->register(\Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
After that, Laravel IDE Helper should work correctly. During the generation process, the script may throw exceptions saying that some Class(s) doesn't exist or there are some undefined indexes. This is normal, as Lumen has some default packages stripped away, like Cookies, Storage and Session. If you plan to add these packages, you will have to add them manually and create additional Facades if needed.
|
||||||
|
|
||||||
|
#### Adding Additional Facades
|
||||||
|
|
||||||
|
Currently Lumen IDE Helper doesn't take into account additional Facades created under `bootstrap/app.php` using `create_alias()`, so you need to create a `config/app.php` file and add your custom aliases under an `aliases` array again, like so:
|
||||||
|
|
||||||
|
```php
|
||||||
|
return [
|
||||||
|
'aliases' => [
|
||||||
|
'CustomAliasOne' => Example\Support\Facades\CustomAliasOne::class,
|
||||||
|
'CustomAliasTwo' => Example\Support\Facades\CustomAliasTwo::class,
|
||||||
|
//...
|
||||||
|
]
|
||||||
|
];
|
||||||
|
```
|
||||||
|
|
||||||
|
After you run ```php artisan ide-helper:generate```, it's recommended (but not mandatory) to rename `config/app.php` to something else until you have to re-generate the docs or after passing to production enviroment. Lumen 5.1+ will read this file for configuration parameters if it is present, and may overlap some configurations if it is completely populated.
|
||||||
|
|
||||||
### License
|
### 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
|
||||||
|
|||||||
@@ -7,21 +7,21 @@
|
|||||||
* @author Barry vd. Heuvel <[email protected]>
|
* @author Barry vd. Heuvel <[email protected]>
|
||||||
* @see https://github.com/barryvdh/laravel-ide-helper
|
* @see https://github.com/barryvdh/laravel-ide-helper
|
||||||
*/
|
*/
|
||||||
|
namespace {
|
||||||
|
exit("This file should not be included, only analyzed by your IDE");
|
||||||
|
}
|
||||||
|
|
||||||
<?php foreach($namespaces as $namespace => $aliases): ?>
|
<?php foreach($namespaces as $namespace => $aliases): ?>
|
||||||
namespace <?= $namespace == '__root' ? '' : $namespace ?>{
|
namespace <?= $namespace == '__root' ? '' : trim($namespace, '\\') ?> {
|
||||||
<?php if($namespace == '__root'): ?>
|
|
||||||
exit("This file should not be included, only analyzed by your IDE");
|
|
||||||
<?= $helpers ?>
|
|
||||||
<?php endif; ?>
|
|
||||||
<?php foreach($aliases as $alias): ?>
|
<?php foreach($aliases as $alias): ?>
|
||||||
|
|
||||||
<?= $alias->getClassType() ?> <?= $alias->getShortName() ?> <?= $alias->getExtends() ? 'extends ' . $alias->getExtends() : '' ?>{
|
<?= $alias->getClassType() ?> <?= $alias->getExtendsCLass() ?> {
|
||||||
<?php foreach($alias->getMethods() as $method): ?>
|
<?php foreach($alias->getMethods() as $method): ?>
|
||||||
|
|
||||||
<?= trim($method->getDocComment(' ')) ?>
|
<?= trim($method->getDocComment(' ')) ?>
|
||||||
|
|
||||||
public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>){<?php if($method->getDeclaringClass() !== $method->getRoot()): ?>
|
public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>)
|
||||||
|
{<?php if($method->getDeclaringClass() !== $method->getRoot()): ?>
|
||||||
|
|
||||||
//Method inherited from <?= $method->getDeclaringClass() ?>
|
//Method inherited from <?= $method->getDeclaringClass() ?>
|
||||||
<?php endif; ?>
|
<?php endif; ?>
|
||||||
@@ -31,9 +31,44 @@ namespace <?= $namespace == '__root' ? '' : $namespace ?>{
|
|||||||
<?php endforeach; ?>
|
<?php endforeach; ?>
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
<?php endforeach; ?>
|
<?php endforeach; ?>
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
<?php endforeach; ?>
|
<?php endforeach; ?>
|
||||||
|
|
||||||
|
namespace {
|
||||||
|
<?= $helpers ?>
|
||||||
|
|
||||||
|
<?php foreach($namespaces as $namespace => $aliases): ?>
|
||||||
|
<?php foreach($aliases as $alias): ?>
|
||||||
|
<?= $alias->getClassType() ?> <?= $alias->getShortName() ?> extends <?= $alias->getExtends() ?> {}
|
||||||
|
|
||||||
|
<?php endforeach; ?>
|
||||||
|
<?php endforeach; ?>
|
||||||
|
}
|
||||||
|
|
||||||
|
<?php if($include_fluent): ?>
|
||||||
|
namespace Illuminate\Support {
|
||||||
|
/**
|
||||||
|
* Methods commonly used in migrations
|
||||||
|
*
|
||||||
|
* @method Fluent after(string $column) Add the after modifier
|
||||||
|
* @method Fluent charset(string $charset) Add the character set modifier
|
||||||
|
* @method Fluent collation(string $collation) Add the collation modifier
|
||||||
|
* @method Fluent comment(string $comment) Add comment
|
||||||
|
* @method Fluent default(mixed $value) Add the default modifier
|
||||||
|
* @method Fluent first() Select first row
|
||||||
|
* @method Fluent index(string $name = null) Add the in dex clause
|
||||||
|
* @method Fluent on(string $table) `on` of a foreign key
|
||||||
|
* @method Fluent onDelete(string $action) `on delete` of a foreign key
|
||||||
|
* @method Fluent onUpdate(string $action) `on update` of a foreign key
|
||||||
|
* @method Fluent primary() Add the primary key modifier
|
||||||
|
* @method Fluent references(string $column) `references` of a foreign key
|
||||||
|
* @method Fluent nullable() Add the nullable modifier
|
||||||
|
* @method Fluent unique(string $name = null) Add unique index clause
|
||||||
|
* @method Fluent unsigned() Add the unsigned modifier
|
||||||
|
* @method Fluent useCurrent() Add the default timestamp value
|
||||||
|
*/
|
||||||
|
class Fluent {}
|
||||||
|
}
|
||||||
|
<?php endif ?>
|
||||||
|
|||||||
+47
-3
@@ -15,6 +15,8 @@ class Alias
|
|||||||
protected $alias;
|
protected $alias;
|
||||||
protected $facade;
|
protected $facade;
|
||||||
protected $extends = null;
|
protected $extends = null;
|
||||||
|
protected $extendsClass = null;
|
||||||
|
protected $extendsNamespace = null;
|
||||||
protected $classType = 'class';
|
protected $classType = 'class';
|
||||||
protected $short;
|
protected $short;
|
||||||
protected $namespace = '__root';
|
protected $namespace = '__root';
|
||||||
@@ -53,6 +55,7 @@ class Alias
|
|||||||
$this->addClass($this->root);
|
$this->addClass($this->root);
|
||||||
$this->detectNamespace();
|
$this->detectNamespace();
|
||||||
$this->detectClassType();
|
$this->detectClassType();
|
||||||
|
$this->detectExtendsNamespace();
|
||||||
|
|
||||||
if ($facade === '\Illuminate\Database\Eloquent\Model') {
|
if ($facade === '\Illuminate\Database\Eloquent\Model') {
|
||||||
$this->usedMethods = array('decrement', 'increment');
|
$this->usedMethods = array('decrement', 'increment');
|
||||||
@@ -105,6 +108,26 @@ class Alias
|
|||||||
return $this->extends;
|
return $this->extends;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the class short name which this alias extends
|
||||||
|
*
|
||||||
|
* @return null|string
|
||||||
|
*/
|
||||||
|
public function getExtendsClass()
|
||||||
|
{
|
||||||
|
return $this->extendsClass;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the namespace of the class which this alias extends
|
||||||
|
*
|
||||||
|
* @return null|string
|
||||||
|
*/
|
||||||
|
public function getExtendsNamespace()
|
||||||
|
{
|
||||||
|
return $this->extendsNamespace;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the Alias by which this class is called
|
* Get the Alias by which this class is called
|
||||||
*
|
*
|
||||||
@@ -118,7 +141,8 @@ class 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;
|
||||||
}
|
}
|
||||||
/**
|
/**
|
||||||
@@ -157,6 +181,18 @@ class Alias
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Detect the extends namespace
|
||||||
|
*/
|
||||||
|
protected function detectExtendsNamespace()
|
||||||
|
{
|
||||||
|
if (strpos($this->extends, '\\') !== false) {
|
||||||
|
$nsParts = explode('\\', $this->extends);
|
||||||
|
$this->extendsClass = array_pop($nsParts);
|
||||||
|
$this->extendsNamespace = implode('\\', $nsParts);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Detect the class type
|
* Detect the class type
|
||||||
*/
|
*/
|
||||||
@@ -201,7 +237,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.");
|
||||||
@@ -262,7 +300,13 @@ class Alias
|
|||||||
// 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 && substr($method->name, 0, 2) !== '__') {
|
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
|
||||||
*
|
*
|
||||||
@@ -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'),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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.
|
||||||
@@ -46,7 +47,7 @@ class MetaCommand extends Command {
|
|||||||
'new \Illuminate\Contracts\Container\Container',
|
'new \Illuminate\Contracts\Container\Container',
|
||||||
'\Illuminate\Contracts\Container\Container::make(\'\')',
|
'\Illuminate\Contracts\Container\Container::make(\'\')',
|
||||||
'\App::make(\'\')',
|
'\App::make(\'\')',
|
||||||
'app(\'\')',
|
'\app(\'\')',
|
||||||
];
|
];
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -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;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+164
-39
@@ -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
|
||||||
@@ -139,7 +140,7 @@ class ModelsCommand extends Command
|
|||||||
|
|
||||||
$output = "<?php
|
$output = "<?php
|
||||||
/**
|
/**
|
||||||
* An helper file for your Eloquent Models
|
* A helper file for your Eloquent Models
|
||||||
* Copy the phpDocs from this file to the correct Model,
|
* Copy the phpDocs from this file to the correct Model,
|
||||||
* And remove them from this file, to prevent double declarations.
|
* And remove them from this file, to prevent double declarations.
|
||||||
*
|
*
|
||||||
@@ -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);
|
||||||
@@ -192,6 +194,10 @@ class ModelsCommand extends Command
|
|||||||
$this->getPropertiesFromTable($model);
|
$this->getPropertiesFromTable($model);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (method_exists($model, 'getCasts')) {
|
||||||
|
$this->castPropertiesType($model);
|
||||||
|
}
|
||||||
|
|
||||||
$this->getPropertiesFromMethods($model);
|
$this->getPropertiesFromMethods($model);
|
||||||
$output .= $this->createPhpDocs($name);
|
$output .= $this->createPhpDocs($name);
|
||||||
$ignore[] = $name;
|
$ignore[] = $name;
|
||||||
@@ -199,17 +205,16 @@ 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`.'
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
return $output;
|
return $output;
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
@@ -227,6 +232,73 @@ class ModelsCommand extends Command
|
|||||||
return $models;
|
return $models;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* cast the properties's type from $casts.
|
||||||
|
*
|
||||||
|
* @param \Illuminate\Database\Eloquent\Model $model
|
||||||
|
*/
|
||||||
|
protected function castPropertiesType($model)
|
||||||
|
{
|
||||||
|
$casts = $model->getCasts();
|
||||||
|
foreach ($casts as $name => $type) {
|
||||||
|
switch ($type) {
|
||||||
|
case 'boolean':
|
||||||
|
case 'bool':
|
||||||
|
$realType = 'boolean';
|
||||||
|
break;
|
||||||
|
case 'string':
|
||||||
|
$realType = 'string';
|
||||||
|
break;
|
||||||
|
case 'array':
|
||||||
|
case 'json':
|
||||||
|
$realType = 'array';
|
||||||
|
break;
|
||||||
|
case 'object':
|
||||||
|
$realType = 'object';
|
||||||
|
break;
|
||||||
|
case 'int':
|
||||||
|
case 'integer':
|
||||||
|
case 'timestamp':
|
||||||
|
$realType = 'integer';
|
||||||
|
break;
|
||||||
|
case 'real':
|
||||||
|
case 'double':
|
||||||
|
case 'float':
|
||||||
|
$realType = 'float';
|
||||||
|
break;
|
||||||
|
case 'date':
|
||||||
|
case 'datetime':
|
||||||
|
$realType = '\Carbon\Carbon';
|
||||||
|
break;
|
||||||
|
case 'collection':
|
||||||
|
$realType = '\Illuminate\Support\Collection';
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
$realType = 'mixed';
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!isset($this->properties[$name])) {
|
||||||
|
continue;
|
||||||
|
} else {
|
||||||
|
$this->properties[$name]['type'] = $this->getTypeOverride($realType);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the overide type for the give type.
|
||||||
|
*
|
||||||
|
* @param string $type
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
protected function getTypeOverride($type)
|
||||||
|
{
|
||||||
|
$typeOverrides = $this->laravel['config']->get('ide-helper.type_overrides', array());
|
||||||
|
|
||||||
|
return isset($typeOverrides[$type]) ? $typeOverrides[$type] : $type;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Load the properties from the database table.
|
* Load the properties from the database table.
|
||||||
*
|
*
|
||||||
@@ -305,6 +377,7 @@ class ModelsCommand extends Command
|
|||||||
{
|
{
|
||||||
$methods = get_class_methods($model);
|
$methods = get_class_methods($model);
|
||||||
if ($methods) {
|
if ($methods) {
|
||||||
|
sort($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,
|
||||||
@@ -314,7 +387,9 @@ class ModelsCommand extends Command
|
|||||||
//Magic get<name>Attribute
|
//Magic get<name>Attribute
|
||||||
$name = Str::snake(substr($method, 3, -9));
|
$name = Str::snake(substr($method, 3, -9));
|
||||||
if (!empty($name)) {
|
if (!empty($name)) {
|
||||||
$this->setProperty($name, null, true, null);
|
$reflection = new \ReflectionMethod($model, $method);
|
||||||
|
$type = $this->getReturnTypeFromDocBlock($reflection);
|
||||||
|
$this->setProperty($name, $type, true, null);
|
||||||
}
|
}
|
||||||
} elseif (Str::startsWith($method, 'set') && Str::endsWith(
|
} elseif (Str::startsWith($method, 'set') && Str::endsWith(
|
||||||
$method,
|
$method,
|
||||||
@@ -336,8 +411,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);
|
||||||
|
|
||||||
@@ -355,35 +431,43 @@ class ModelsCommand extends Command
|
|||||||
|
|
||||||
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.
|
||||||
$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);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -410,7 +494,7 @@ class ModelsCommand extends Command
|
|||||||
$this->properties[$name]['comment'] = (string) $comment;
|
$this->properties[$name]['comment'] = (string) $comment;
|
||||||
}
|
}
|
||||||
if ($type !== null) {
|
if ($type !== null) {
|
||||||
$this->properties[$name]['type'] = $type;
|
$this->properties[$name]['type'] = $this->getTypeOverride($type);
|
||||||
}
|
}
|
||||||
if ($read !== null) {
|
if ($read !== null) {
|
||||||
$this->properties[$name]['read'] = $read;
|
$this->properties[$name]['read'] = $read;
|
||||||
@@ -422,7 +506,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;
|
||||||
@@ -474,11 +560,18 @@ class ModelsCommand extends Command
|
|||||||
} else {
|
} else {
|
||||||
$attr = 'property-read';
|
$attr = 'property-read';
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if ($this->hasCamelCaseModelProperties()) {
|
||||||
|
$name = Str::camel($name);
|
||||||
|
}
|
||||||
|
|
||||||
$tagLine = trim("@{$attr} {$property['type']} {$name} {$property['comment']}");
|
$tagLine = trim("@{$attr} {$property['type']} {$name} {$property['comment']}");
|
||||||
$tag = Tag::createInstance($tagLine, $phpdoc);
|
$tag = Tag::createInstance($tagLine, $phpdoc);
|
||||||
$phpdoc->appendTag($tag);
|
$phpdoc->appendTag($tag);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
ksort($this->methods);
|
||||||
|
|
||||||
foreach ($this->methods as $name => $method) {
|
foreach ($this->methods as $name => $method) {
|
||||||
if (in_array($name, $methods)) {
|
if (in_array($name, $methods)) {
|
||||||
continue;
|
continue;
|
||||||
@@ -488,6 +581,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 +608,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 +623,12 @@ 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();
|
$paramClass = $param->getClass();
|
||||||
|
$paramStr = (!is_null($paramClass) ? '\\' . $paramClass->getName() . ' ' : '') . '$' . $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 +649,49 @@ 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, " \"'"), "\\") ;
|
/**
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
protected function hasCamelCaseModelProperties()
|
||||||
|
{
|
||||||
|
return $this->laravel['config']->get('ide-helper.model_camel_case_properties', false);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get method return type based on it DocBlock comment
|
||||||
|
*
|
||||||
|
* @param \ReflectionMethod $reflection
|
||||||
|
*
|
||||||
|
* @return null|string
|
||||||
|
*/
|
||||||
|
protected function getReturnTypeFromDocBlock(\ReflectionMethod $reflection)
|
||||||
|
{
|
||||||
|
$type = null;
|
||||||
|
$phpdoc = new DocBlock($reflection);
|
||||||
|
|
||||||
|
if ($phpdoc->hasTag('return')) {
|
||||||
|
$type = $phpdoc->getTagsByName('return')[0]->getContent();
|
||||||
|
}
|
||||||
|
|
||||||
|
return $type;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+56
-27
@@ -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 = ''
|
||||||
@@ -81,6 +84,7 @@ class Generator
|
|||||||
->with('namespaces', $this->getNamespaces())
|
->with('namespaces', $this->getNamespaces())
|
||||||
->with('helpers', $this->helpers)
|
->with('helpers', $this->helpers)
|
||||||
->with('version', $app->version())
|
->with('version', $app->version())
|
||||||
|
->with('include_fluent', $this->config->get('ide-helper.include_fluent', false))
|
||||||
->render();
|
->render();
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -113,13 +117,26 @@ class Generator
|
|||||||
|
|
||||||
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') && is_a('Auth', '\Illuminate\Support\Facades\Auth', true)) {
|
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') && is_a('DB', '\Illuminate\Support\Facades\DB', true)) {
|
if (class_exists('DB') && is_a('DB', '\Illuminate\Support\Facades\DB', true)) {
|
||||||
@@ -127,7 +144,8 @@ class Generator
|
|||||||
$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') && is_a('Cache', '\Illuminate\Support\Facades\Cache', true)) {
|
if (class_exists('Cache') && is_a('Cache', '\Illuminate\Support\Facades\Cache', true)) {
|
||||||
@@ -136,7 +154,8 @@ class Generator
|
|||||||
$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') && is_a('Queue', '\Illuminate\Support\Facades\Queue', true)) {
|
if (class_exists('Queue') && is_a('Queue', '\Illuminate\Support\Facades\Queue', true)) {
|
||||||
@@ -144,7 +163,8 @@ class Generator
|
|||||||
$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') && is_a('SSH', '\Illuminate\Support\Facades\SSH', true)) {
|
if (class_exists('SSH') && is_a('SSH', '\Illuminate\Support\Facades\SSH', true)) {
|
||||||
@@ -152,8 +172,17 @@ class Generator
|
|||||||
$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) {
|
||||||
|
}
|
||||||
|
|
||||||
|
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) {
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -175,19 +204,17 @@ class Generator
|
|||||||
$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]);
|
||||||
}
|
}
|
||||||
|
|
||||||
$namespace = $alias->getNamespace();
|
$namespace = $alias->getExtendsNamespace() ?: $alias->getNamespace();
|
||||||
if (!isset($namespaces[$namespace])) {
|
if (!isset($namespaces[$namespace])) {
|
||||||
$namespaces[$namespace] = array();
|
$namespaces[$namespace] = array();
|
||||||
}
|
}
|
||||||
$namespaces[$namespace][] = $alias;
|
$namespaces[$namespace][] = $alias;
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return $namespaces;
|
return $namespaces;
|
||||||
@@ -201,25 +228,27 @@ class Generator
|
|||||||
}
|
}
|
||||||
|
|
||||||
$facades = [
|
$facades = [
|
||||||
'Illuminate\Support\Facades\App' => 'App',
|
'App' => 'Illuminate\Support\Facades\App',
|
||||||
'Illuminate\Support\Facades\Auth' => 'Auth',
|
'Auth' => 'Illuminate\Support\Facades\Auth',
|
||||||
'Illuminate\Support\Facades\Bus' => 'Bus',
|
'Bus' => 'Illuminate\Support\Facades\Bus',
|
||||||
'Illuminate\Support\Facades\DB' => 'DB',
|
'DB' => 'Illuminate\Support\Facades\DB',
|
||||||
'Illuminate\Support\Facades\Cache' => 'Cache',
|
'Cache' => 'Illuminate\Support\Facades\Cache',
|
||||||
'Illuminate\Support\Facades\Cookie' => 'Cookie',
|
'Cookie' => 'Illuminate\Support\Facades\Cookie',
|
||||||
'Illuminate\Support\Facades\Crypt' => 'Crypt',
|
'Crypt' => 'Illuminate\Support\Facades\Crypt',
|
||||||
'Illuminate\Support\Facades\Event' => 'Event',
|
'Event' => 'Illuminate\Support\Facades\Event',
|
||||||
'Illuminate\Support\Facades\Hash' => 'Hash',
|
'Hash' => 'Illuminate\Support\Facades\Hash',
|
||||||
'Illuminate\Support\Facades\Log' => 'Log',
|
'Log' => 'Illuminate\Support\Facades\Log',
|
||||||
'Illuminate\Support\Facades\Mail' => 'Mail',
|
'Mail' => 'Illuminate\Support\Facades\Mail',
|
||||||
'Illuminate\Support\Facades\Queue' => 'Queue',
|
'Queue' => 'Illuminate\Support\Facades\Queue',
|
||||||
'Illuminate\Support\Facades\Request' => 'Request',
|
'Request' => 'Illuminate\Support\Facades\Request',
|
||||||
'Illuminate\Support\Facades\Schema' => 'Schema',
|
'Schema' => 'Illuminate\Support\Facades\Schema',
|
||||||
'Illuminate\Support\Facades\Session' => 'Session',
|
'Session' => 'Illuminate\Support\Facades\Session',
|
||||||
'Illuminate\Support\Facades\Storage' => 'Storage',
|
'Storage' => 'Illuminate\Support\Facades\Storage',
|
||||||
// 'Illuminate\Support\Facades\Validator' => 'Validator',
|
//'Validator' => 'Illuminate\Support\Facades\Validator',
|
||||||
];
|
];
|
||||||
|
|
||||||
|
$facades = array_merge($facades, $this->config->get('app.aliases', []));
|
||||||
|
|
||||||
// Only return the ones that actually exist
|
// Only return the ones that actually exist
|
||||||
return array_filter($facades, function ($alias) {
|
return array_filter($facades, function ($alias) {
|
||||||
return class_exists($alias);
|
return class_exists($alias);
|
||||||
|
|||||||
@@ -54,19 +54,22 @@ class IdeHelperServiceProvider extends ServiceProvider
|
|||||||
$configPath = __DIR__ . '/../config/ide-helper.php';
|
$configPath = __DIR__ . '/../config/ide-helper.php';
|
||||||
$this->mergeConfigFrom($configPath, 'ide-helper');
|
$this->mergeConfigFrom($configPath, 'ide-helper');
|
||||||
|
|
||||||
$this->app['command.ide-helper.generate'] = $this->app->share(
|
$this->app->singleton(
|
||||||
|
'command.ide-helper.generate',
|
||||||
function ($app) {
|
function ($app) {
|
||||||
return new GeneratorCommand($app['config'], $app['files'], $app['view']);
|
return new GeneratorCommand($app['config'], $app['files'], $app['view']);
|
||||||
}
|
}
|
||||||
);
|
);
|
||||||
|
|
||||||
$this->app['command.ide-helper.models'] = $this->app->share(
|
$this->app->singleton(
|
||||||
|
'command.ide-helper.models',
|
||||||
function ($app) {
|
function ($app) {
|
||||||
return new ModelsCommand($app['files']);
|
return new ModelsCommand($app['files']);
|
||||||
}
|
}
|
||||||
);
|
);
|
||||||
|
|
||||||
$this->app['command.ide-helper.meta'] = $this->app->share(
|
$this->app->singleton(
|
||||||
|
'command.ide-helper.meta',
|
||||||
function ($app) {
|
function ($app) {
|
||||||
return new MetaCommand($app['files'], $app['view']);
|
return new MetaCommand($app['files'], $app['view']);
|
||||||
}
|
}
|
||||||
@@ -84,5 +87,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');
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|||||||
+13
-10
@@ -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)
|
||||||
@@ -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