mirror of
https://github.com/barryvdh/laravel-ide-helper.git
synced 2026-08-18 18:13:11 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0a8e5436d4 | ||
|
|
7c81b6388e | ||
|
|
66d6e3df01 | ||
|
|
1080504a78 | ||
|
|
647b8ff0d1 | ||
|
|
07e35d808c | ||
|
|
a44572676a | ||
|
|
e6f7ca7433 | ||
|
|
042d341b65 | ||
|
|
501ef7045a | ||
|
|
31e6479ee6 | ||
|
|
c0f4a497f9 | ||
|
|
00604a2431 | ||
|
|
ff18d80849 | ||
|
|
52ea63b5de | ||
|
|
7b263ffbce | ||
|
|
8f4ea3c100 | ||
|
|
3c348e7140 | ||
|
|
2f90dbdfce | ||
|
|
74935df8a1 | ||
|
|
b6fdfe0df7 | ||
|
|
99cebb5566 | ||
|
|
692b223e94 | ||
|
|
f321828778 | ||
|
|
6eb797f5ff | ||
|
|
604d327277 | ||
|
|
6ed5367f6b | ||
|
|
8c339bd6b0 | ||
|
|
52b9b52926 | ||
|
|
f909c82fcc | ||
|
|
e88c3669b7 | ||
|
|
5bd7eeda23 | ||
|
|
dae0b55bef | ||
|
|
3f9831c5cf | ||
|
|
2cc277440a | ||
|
|
14eab5ef84 |
@@ -1,15 +0,0 @@
|
|||||||
; 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
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# 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
-3
@@ -1,4 +1,3 @@
|
|||||||
build
|
/vendor
|
||||||
vendor
|
|
||||||
composer.lock
|
composer.lock
|
||||||
.idea
|
.idea/
|
||||||
|
|||||||
@@ -1,23 +0,0 @@
|
|||||||
filter:
|
|
||||||
excluded_paths: [tests/*]
|
|
||||||
|
|
||||||
checks:
|
|
||||||
php:
|
|
||||||
remove_extra_empty_lines: true
|
|
||||||
remove_php_closing_tag: true
|
|
||||||
remove_trailing_whitespace: true
|
|
||||||
fix_use_statements:
|
|
||||||
remove_unused: true
|
|
||||||
preserve_multiple: false
|
|
||||||
preserve_blanklines: true
|
|
||||||
order_alphabetically: true
|
|
||||||
fix_php_opening_tag: true
|
|
||||||
fix_linefeed: true
|
|
||||||
fix_line_ending: true
|
|
||||||
fix_identation_4spaces: true
|
|
||||||
fix_doc_comments: true
|
|
||||||
|
|
||||||
tools:
|
|
||||||
external_code_coverage:
|
|
||||||
timeout: 600
|
|
||||||
runs: 3
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
preset: psr2
|
|
||||||
+14
-19
@@ -1,31 +1,26 @@
|
|||||||
language: php
|
language: php
|
||||||
|
|
||||||
php:
|
php:
|
||||||
|
- 5.4
|
||||||
- 5.5
|
- 5.5
|
||||||
- 5.6
|
- 5.6
|
||||||
- 7.0
|
|
||||||
- hhvm
|
- 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:
|
matrix:
|
||||||
include:
|
include:
|
||||||
- php: 5.5
|
- php: 5.3
|
||||||
env: 'COMPOSER_FLAGS="--prefer-stable --prefer-lowest"'
|
dist: precise
|
||||||
|
allow_failures:
|
||||||
|
- php: hhvm
|
||||||
|
fast_finish: true
|
||||||
|
|
||||||
|
cache:
|
||||||
|
directories:
|
||||||
|
- vendor
|
||||||
|
- $HOME/.composer/cache
|
||||||
|
|
||||||
before_script:
|
before_script:
|
||||||
- travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-dist
|
- travis_retry composer self-update
|
||||||
|
- travis_retry composer install --no-interaction --no-suggest --no-progress
|
||||||
|
|
||||||
script:
|
script:
|
||||||
- vendor/bin/phpcs --standard=psr2 src/
|
- vendor/bin/phpunit
|
||||||
- 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
@@ -1,21 +0,0 @@
|
|||||||
# 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.
|
|
||||||
+12
-20
@@ -10,18 +10,19 @@
|
|||||||
}
|
}
|
||||||
],
|
],
|
||||||
"require": {
|
"require": {
|
||||||
"php": ">=5.4.0",
|
"php": ">=5.3.0",
|
||||||
"illuminate/support": "^5.0,<5.4",
|
"illuminate/config": "4.x",
|
||||||
"illuminate/console": "^5.0,<5.4",
|
"illuminate/support": "4.x",
|
||||||
"illuminate/filesystem": "^5.0,<5.4",
|
"illuminate/console": "4.x",
|
||||||
"barryvdh/reflection-docblock": "^2.0.4",
|
"illuminate/filesystem": "4.x",
|
||||||
"symfony/class-loader": "^2.3|^3.0"
|
"illuminate/database": "4.x",
|
||||||
|
"illuminate/view": "4.x",
|
||||||
|
"phpdocumentor/reflection-docblock": "^2.0.4",
|
||||||
|
"symfony/class-loader": "~2.3"
|
||||||
},
|
},
|
||||||
"require-dev": {
|
"require-dev": {
|
||||||
"phpunit/phpunit" : "4.*",
|
"doctrine/dbal": "~2.3",
|
||||||
"scrutinizer/ocular": "~1.1",
|
"phpunit/phpunit": "~4.0"
|
||||||
"squizlabs/php_codesniffer": "~2.3",
|
|
||||||
"doctrine/dbal": "~2.3"
|
|
||||||
},
|
},
|
||||||
"suggest": {
|
"suggest": {
|
||||||
"doctrine/dbal": "Load information from the database about models for phpdocs (~2.3)"
|
"doctrine/dbal": "Load information from the database about models for phpdocs (~2.3)"
|
||||||
@@ -31,18 +32,9 @@
|
|||||||
"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.2-dev"
|
"dev-master": "1.11-dev"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,168 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
return array(
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Filename & Format
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| The default filename (without extension) and the format (php or json)
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
|
|
||||||
'filename' => '_ide_helper',
|
|
||||||
'format' => 'php',
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Fluent helpers
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| Set to true to generate commonly used Fluent methods
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
|
|
||||||
'include_fluent' => false,
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Helper files to include
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| Include helper files. By default not included, but can be toggled with the
|
|
||||||
| -- helpers (-H) option. Extra helper files can be included.
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
|
|
||||||
'include_helpers' => false,
|
|
||||||
|
|
||||||
'helper_files' => array(
|
|
||||||
base_path().'/vendor/laravel/framework/src/Illuminate/Support/helpers.php',
|
|
||||||
),
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Model locations to include
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| Define in which directories the ide-helper:models command should look
|
|
||||||
| for models.
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
|
|
||||||
'model_locations' => array(
|
|
||||||
'app',
|
|
||||||
),
|
|
||||||
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Extra classes
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| These implementations are not really extended, but called with magic functions
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
|
|
||||||
'extra' => array(
|
|
||||||
'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
|
|
||||||
'Session' => array('Illuminate\Session\Store'),
|
|
||||||
),
|
|
||||||
|
|
||||||
'magic' => array(
|
|
||||||
'Log' => array(
|
|
||||||
'debug' => 'Monolog\Logger::addDebug',
|
|
||||||
'info' => 'Monolog\Logger::addInfo',
|
|
||||||
'notice' => 'Monolog\Logger::addNotice',
|
|
||||||
'warning' => 'Monolog\Logger::addWarning',
|
|
||||||
'error' => 'Monolog\Logger::addError',
|
|
||||||
'critical' => 'Monolog\Logger::addCritical',
|
|
||||||
'alert' => 'Monolog\Logger::addAlert',
|
|
||||||
'emergency' => 'Monolog\Logger::addEmergency',
|
|
||||||
)
|
|
||||||
),
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Interface implementations
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| These interfaces will be replaced with the implementing class. Some interfaces
|
|
||||||
| are detected by the helpers, others can be listed below.
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
|
|
||||||
'interfaces' => array(
|
|
||||||
|
|
||||||
),
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Support for custom DB types
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| This setting allow you to map any custom database type (that you may have
|
|
||||||
| created using CREATE TYPE statement or imported using database plugin
|
|
||||||
| / extension to a Doctrine type.
|
|
||||||
|
|
|
||||||
| Each key in this array is a name of the Doctrine2 DBAL Platform. Currently valid names are:
|
|
||||||
| 'postgresql', 'db2', 'drizzle', 'mysql', 'oracle', 'sqlanywhere', 'sqlite', 'mssql'
|
|
||||||
|
|
|
||||||
| This name is returned by getName() method of the specific Doctrine/DBAL/Platforms/AbstractPlatform descendant
|
|
||||||
|
|
|
||||||
| The value of the array is an array of type mappings. Key is the name of the custom type,
|
|
||||||
| (for example, "jsonb" from Postgres 9.4) and the value is the name of the corresponding Doctrine2 type (in
|
|
||||||
| our case it is 'json_array'. Doctrine types are listed here:
|
|
||||||
| http://doctrine-dbal.readthedocs.org/en/latest/reference/types.html
|
|
||||||
|
|
|
||||||
| So to support jsonb in your models when working with Postgres, just add the following entry to the array below:
|
|
||||||
|
|
|
||||||
| "postgresql" => array(
|
|
||||||
| "jsonb" => "json_array",
|
|
||||||
| ),
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
'custom_db_types' => array(
|
|
||||||
|
|
||||||
),
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Support for camel cased models
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| There are some Laravel packages (such as Eloquence) that allow for accessing
|
|
||||||
| Eloquent model properties via camel case, instead of snake case.
|
|
||||||
|
|
|
||||||
| Enabling this option will support these packages by saving all model
|
|
||||||
| properties as camel case, instead of snake case.
|
|
||||||
|
|
|
||||||
| For example, normally you would see this:
|
|
||||||
|
|
|
||||||
| * @property \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',
|
|
||||||
),
|
|
||||||
);
|
|
||||||
+18
@@ -0,0 +1,18 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||||
|
xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/4.0/phpunit.xsd"
|
||||||
|
backupGlobals="false"
|
||||||
|
backupStaticAttributes="false"
|
||||||
|
bootstrap="vendor/autoload.php"
|
||||||
|
colors="true"
|
||||||
|
convertErrorsToExceptions="true"
|
||||||
|
convertNoticesToExceptions="true"
|
||||||
|
convertWarningsToExceptions="true"
|
||||||
|
processIsolation="false"
|
||||||
|
stopOnFailure="false">
|
||||||
|
<testsuites>
|
||||||
|
<testsuite name="Package Test Suite">
|
||||||
|
<directory suffix=".php">./tests/</directory>
|
||||||
|
</testsuite>
|
||||||
|
</testsuites>
|
||||||
|
</phpunit>
|
||||||
@@ -1,29 +0,0 @@
|
|||||||
<?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>
|
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
{
|
||||||
|
"providers": [
|
||||||
|
"Barryvdh\\LaravelIdeHelper\\IdeHelperServiceProvider"
|
||||||
|
]
|
||||||
|
}
|
||||||
@@ -1,119 +1,99 @@
|
|||||||
## Laravel 5 IDE Helper Generator
|
## Laravel 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]
|
### For Laravel 5, check the [2.0 branch](https://github.com/barryvdh/laravel-ide-helper)
|
||||||
[![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!_
|
_Checkout [this Laracasts video](https://laracasts.com/series/how-to-be-awesome-in-phpstorm/episodes/15) for a quick introduction/explanation!_
|
||||||
|
|
||||||
* [`php artisan ide-helper:generate` - phpDoc generation for Laravel Facades ](#automatic-phpdoc-generation-for-laravel-facades)
|
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 always up-to-date.
|
||||||
* [`php artisan ide-helper:models` - phpDocs for models](#automatic-phpdocs-for-models)
|
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: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.
|
* Generated version: https://gist.github.com/barryvdh/5227822
|
||||||
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
|
### New: 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 ann `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();
|
||||||
|
```
|
||||||
|
|
||||||
|
Pre-generated example: https://gist.github.com/barryvdh/bb6ffc5d11e0a75dba67
|
||||||
|
|
||||||
|
> Note: You might need to restart PhpStorm and make sure `.phpstorm.meta.php` is indexed.
|
||||||
|
|
||||||
|
### 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
|
```bash
|
||||||
composer require barryvdh/laravel-ide-helper
|
composer require barryvdh/laravel-ide-helper ~1.11
|
||||||
```
|
```
|
||||||
|
|
||||||
After updating composer, add the service provider to the `providers` array in `config/app.php`
|
After updating composer, add the ServiceProvider to the providers array in `app/config/app.php`
|
||||||
|
|
||||||
```php
|
```php
|
||||||
Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class,
|
'Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider',
|
||||||
```
|
```
|
||||||
|
|
||||||
To install this package on only development systems, add the `--dev` flag to your composer command:
|
You can now re-generate the docs yourself (for future updates) in artisan
|
||||||
|
|
||||||
```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)
|
|
||||||
|
|
||||||
```bash
|
```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
|
```json
|
||||||
"scripts":{
|
"scripts":{
|
||||||
"post-update-cmd": [
|
"post-update-cmd":[
|
||||||
"Illuminate\\Foundation\\ComposerScripts::postUpdate",
|
"php artisan clear-compiled",
|
||||||
"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
|
```bash
|
||||||
php artisan vendor:publish --provider="Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider" --tag=config
|
php artisan config:publish barryvdh/laravel-ide-helper
|
||||||
```
|
```
|
||||||
|
|
||||||
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 working default connection, some facades will not be included.
|
||||||
You can use an in-memory SQLite driver by adding the -M option.
|
You can use a 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 it with the `--helpers (-H)` option.
|
You can choose to include helper files. This is not enabled by default, but you can override this 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.
|
> **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 `ide-helper:models` to generate
|
||||||
```bash
|
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)`).
|
||||||
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
|
|
||||||
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, only the newly found columns/relations are saved as phpdocs.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
php artisan ide-helper:models Post
|
php artisan ide-helper:models Post
|
||||||
```
|
```
|
||||||
|
|
||||||
```php
|
```php
|
||||||
/**
|
/**
|
||||||
* An Eloquent Model: 'Post'
|
* An Eloquent Model: 'Post'
|
||||||
@@ -129,21 +109,21 @@ php artisan ide-helper:models Post
|
|||||||
*/
|
*/
|
||||||
```
|
```
|
||||||
|
|
||||||
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
|
```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
|
```bash
|
||||||
php artisan ide-helper:models --dir="path/to/models" --dir="app/src/Model"
|
php artisan ide-helper:models --dir="app/workbench/name/package/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 config:publish barryvdh/laravel-ide-helper`) and set the default directories.
|
||||||
|
|
||||||
Models can be ignored using the `--ignore (-I)` option
|
Models can be ignored using the --ignore (-I) option
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
php artisan ide-helper:models --ignore="Post,User"
|
php artisan ide-helper:models --ignore="Post,User"
|
||||||
@@ -151,95 +131,6 @@ 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).
|
|
||||||
|
|
||||||
## Lumen Install
|
|
||||||
|
|
||||||
This pacakges 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 arreglements 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 Classes 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
|
|
||||||
|
|||||||
@@ -1,66 +0,0 @@
|
|||||||
<?= '<?php' ?>
|
|
||||||
|
|
||||||
/**
|
|
||||||
* A helper file for Laravel 5, to provide autocomplete information to your IDE
|
|
||||||
* Generated for Laravel <?= $version ?> on <?= date("Y-m-d") ?>.
|
|
||||||
*
|
|
||||||
* @author Barry vd. Heuvel <[email protected]>
|
|
||||||
* @see https://github.com/barryvdh/laravel-ide-helper
|
|
||||||
*/
|
|
||||||
|
|
||||||
<?php foreach($namespaces as $namespace => $aliases): ?>
|
|
||||||
namespace <?= $namespace == '__root' ? '' : $namespace ?>{
|
|
||||||
<?php if($namespace == '__root'): ?>
|
|
||||||
exit("This file should not be included, only analyzed by your IDE");
|
|
||||||
<?= $helpers ?>
|
|
||||||
<?php endif; ?>
|
|
||||||
<?php foreach($aliases as $alias): ?>
|
|
||||||
|
|
||||||
<?= $alias->getClassType() ?> <?= $alias->getShortName() ?> <?= $alias->getExtends() ? 'extends ' . $alias->getExtends() : '' ?>{
|
|
||||||
<?php foreach($alias->getMethods() as $method): ?>
|
|
||||||
|
|
||||||
<?= trim($method->getDocComment(' ')) ?>
|
|
||||||
|
|
||||||
public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>){<?php if($method->getDeclaringClass() !== $method->getRoot()): ?>
|
|
||||||
|
|
||||||
//Method inherited from <?= $method->getDeclaringClass() ?>
|
|
||||||
<?php endif; ?>
|
|
||||||
|
|
||||||
<?= $method->shouldReturn() ? 'return ': '' ?><?= $method->getRoot() ?>::<?= $method->getName() ?>(<?= $method->getParams() ?>);
|
|
||||||
}
|
|
||||||
<?php endforeach; ?>
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
<?php endforeach; ?>
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
<?php endforeach; ?>
|
|
||||||
|
|
||||||
|
|
||||||
<?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 $column) `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 $table) `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 ?>
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
<?= '<?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 ?>
|
|
||||||
];
|
|
||||||
}
|
|
||||||
+10
-16
@@ -71,7 +71,7 @@ class Alias
|
|||||||
if (class_exists($class) || interface_exists($class)) {
|
if (class_exists($class) || interface_exists($class)) {
|
||||||
$this->classes[] = $class;
|
$this->classes[] = $class;
|
||||||
} else {
|
} else {
|
||||||
echo "Class not exists: $class\r\n";
|
$this->error('Class not exists: ' . $class);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -86,11 +86,11 @@ class Alias
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the classtype, 'interface' or 'class'
|
* Get the classType, 'interface' or 'class'
|
||||||
*
|
*
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
public function getClasstype()
|
public function getClassType()
|
||||||
{
|
{
|
||||||
return $this->classType;
|
return $this->classType;
|
||||||
}
|
}
|
||||||
@@ -117,11 +117,14 @@ class Alias
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Return the short name (without namespace)
|
* Return the short name (without namespace)
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
*/
|
*/
|
||||||
public function getShortName()
|
public function getShortName()
|
||||||
{
|
{
|
||||||
return $this->short;
|
return $this->short;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the namespace from the alias
|
* Get the namespace from the alias
|
||||||
*
|
*
|
||||||
@@ -135,7 +138,7 @@ class Alias
|
|||||||
/**
|
/**
|
||||||
* Get the methods found by this Alias
|
* Get the methods found by this Alias
|
||||||
*
|
*
|
||||||
* @return array
|
* @return array|Method[]
|
||||||
*/
|
*/
|
||||||
public function getMethods()
|
public function getMethods()
|
||||||
{
|
{
|
||||||
@@ -202,12 +205,10 @@ 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() .
|
'PDOException: ' . $e->getMessage() . "\nPlease configure your database connection correctly, or use the sqlite memory driver (-M). Skipping $facade."
|
||||||
"\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.");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -254,7 +255,6 @@ class Alias
|
|||||||
*/
|
*/
|
||||||
protected function detectMethods()
|
protected function detectMethods()
|
||||||
{
|
{
|
||||||
|
|
||||||
foreach ($this->classes as $class) {
|
foreach ($this->classes as $class) {
|
||||||
$reflection = new \ReflectionClass($class);
|
$reflection = new \ReflectionClass($class);
|
||||||
|
|
||||||
@@ -265,13 +265,7 @@ 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(
|
$this->methods[] = new Method($method, $this->alias, $reflection, $method->name, $this->interfaces);
|
||||||
$method,
|
|
||||||
$this->alias,
|
|
||||||
$reflection,
|
|
||||||
$method->name,
|
|
||||||
$this->interfaces
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
$this->usedMethods[] = $method->name;
|
$this->usedMethods[] = $method->name;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -26,16 +26,12 @@ class GeneratorCommand extends Command
|
|||||||
{
|
{
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The console command name.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @var string
|
|
||||||
*/
|
*/
|
||||||
protected $name = 'ide-helper:generate';
|
protected $name = 'ide-helper:generate';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The console command description.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @var string
|
|
||||||
*/
|
*/
|
||||||
protected $description = 'Generate a new IDE Helper file.';
|
protected $description = 'Generate a new IDE Helper file.';
|
||||||
|
|
||||||
@@ -50,19 +46,14 @@ class GeneratorCommand extends Command
|
|||||||
|
|
||||||
protected $onlyExtend;
|
protected $onlyExtend;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* {@inheritdoc}
|
||||||
*
|
*
|
||||||
* @param \Illuminate\Config\Repository $config
|
* @param \Illuminate\Config\Repository $config
|
||||||
* @param \Illuminate\Filesystem\Filesystem $files
|
* @param \Illuminate\Filesystem\Filesystem $files
|
||||||
* @param \Illuminate\View\Factory $view
|
* @param \Illuminate\View\Factory $view
|
||||||
*/
|
*/
|
||||||
public function __construct(
|
public function __construct(ConfigRepository $config, Filesystem $files, $view) {
|
||||||
/*ConfigRepository */ $config,
|
|
||||||
Filesystem $files,
|
|
||||||
/* Illuminate\View\Factory */
|
|
||||||
$view
|
|
||||||
) {
|
|
||||||
$this->config = $config;
|
$this->config = $config;
|
||||||
$this->files = $files;
|
$this->files = $files;
|
||||||
$this->view = $view;
|
$this->view = $view;
|
||||||
@@ -76,11 +67,9 @@ class GeneratorCommand extends Command
|
|||||||
*/
|
*/
|
||||||
public function fire()
|
public function fire()
|
||||||
{
|
{
|
||||||
if (file_exists(base_path() . '/vendor/compiled.php') ||
|
if (file_exists($compiled = base_path() . '/bootstrap/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 your compiled file (php artisan clear-compiled)'
|
'Error generating IDE Helper: first delete bootstrap/compiled.php (php artisan clear-compiled)'
|
||||||
);
|
);
|
||||||
} else {
|
} else {
|
||||||
$filename = $this->argument('filename');
|
$filename = $this->argument('filename');
|
||||||
@@ -97,10 +86,9 @@ class GeneratorCommand extends Command
|
|||||||
$this->useMemoryDriver();
|
$this->useMemoryDriver();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
$helpers = '';
|
$helpers = '';
|
||||||
if ($this->option('helpers') || ($this->config->get('ide-helper.include_helpers'))) {
|
if ($this->option('helpers') || ($this->config->get('laravel-ide-helper::include_helpers'))) {
|
||||||
foreach ($this->config->get('ide-helper.helper_files', array()) as $helper) {
|
foreach ($this->config->get('laravel-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));
|
||||||
}
|
}
|
||||||
@@ -135,13 +123,11 @@ class GeneratorCommand extends Command
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the console command arguments.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @return array
|
|
||||||
*/
|
*/
|
||||||
protected function getArguments()
|
protected function getArguments()
|
||||||
{
|
{
|
||||||
$filename = $this->config->get('ide-helper.filename');
|
$filename = $this->config->get('laravel-ide-helper::filename');
|
||||||
|
|
||||||
return array(
|
return array(
|
||||||
array(
|
array(
|
||||||
@@ -151,19 +137,18 @@ class GeneratorCommand extends Command
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the console command options.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @return array
|
|
||||||
*/
|
*/
|
||||||
protected function getOptions()
|
protected function getOptions()
|
||||||
{
|
{
|
||||||
$format = $this->config->get('ide-helper.format');
|
$format = $this->config->get('laravel-ide-helper::format');
|
||||||
|
|
||||||
return array(
|
return array(
|
||||||
array('format', "F", InputOption::VALUE_OPTIONAL, 'The format for the IDE Helper', $format),
|
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'),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|||||||
+47
-49
@@ -12,53 +12,50 @@ namespace Barryvdh\LaravelIdeHelper\Console;
|
|||||||
|
|
||||||
use Illuminate\Console\Command;
|
use Illuminate\Console\Command;
|
||||||
use Symfony\Component\Console\Input\InputOption;
|
use Symfony\Component\Console\Input\InputOption;
|
||||||
use Symfony\Component\Console\Output\OutputInterface;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A command to generate phpstorm meta data
|
* A command to generate phpstorm meta data
|
||||||
*
|
*
|
||||||
* @author Barry vd. Heuvel <[email protected]>
|
* @author Barry vd. Heuvel <[email protected]>
|
||||||
|
* @property \Illuminate\Container\Container $laravel
|
||||||
*/
|
*/
|
||||||
class MetaCommand extends Command
|
class MetaCommand extends Command {
|
||||||
{
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The console command name.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @var string
|
|
||||||
*/
|
*/
|
||||||
protected $name = 'ide-helper:meta';
|
protected $name = 'ide-helper:meta';
|
||||||
protected $filename = '.phpstorm.meta.php';
|
protected $filename = '.phpstorm.meta.php';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The console command description.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @var string
|
|
||||||
*/
|
*/
|
||||||
protected $description = 'Generate metadata for PhpStorm';
|
protected $description = 'Generate metadata for PhpStorm';
|
||||||
|
|
||||||
/** @var \Illuminate\Contracts\Filesystem\Filesystem */
|
/** @var \Illuminate\Filesystem\Filesystem */
|
||||||
protected $files;
|
protected $files;
|
||||||
|
|
||||||
/** @var \Illuminate\Contracts\View\Factory */
|
/** @var \Illuminate\View\Factory */
|
||||||
protected $view;
|
protected $view;
|
||||||
|
|
||||||
protected $methods = [
|
protected $methods = array(
|
||||||
'new \Illuminate\Contracts\Container\Container',
|
//'\Illuminate\Foundation\Application::make',
|
||||||
'\Illuminate\Contracts\Container\Container::make(\'\')',
|
'new \Illuminate\Container\Container',
|
||||||
'\App::make(\'\')',
|
'\Illuminate\Container\Container::make',
|
||||||
'\app(\'\')',
|
'\App::make',
|
||||||
];
|
'app',
|
||||||
|
);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* {@inheritdoc}
|
||||||
*
|
*
|
||||||
* @param \Illuminate\Contracts\Filesystem\Filesystem $files
|
* @param \Illuminate\Container\Container $app
|
||||||
* @param \Illuminate\Contracts\View\Factory $view
|
|
||||||
*/
|
*/
|
||||||
public function __construct($files, $view)
|
public function __construct($app)
|
||||||
{
|
{
|
||||||
$this->files = $files;
|
$this->laravel = $app;
|
||||||
$this->view = $view;
|
$this->files = $app['files'];
|
||||||
|
$this->view = $app['view'];
|
||||||
parent::__construct();
|
parent::__construct();
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -69,31 +66,31 @@ class MetaCommand extends Command
|
|||||||
*/
|
*/
|
||||||
public function fire()
|
public function fire()
|
||||||
{
|
{
|
||||||
$this->registerClassAutoloadExceptions();
|
$bindings = array_flip($this->getAppAliases());
|
||||||
|
$exclude = $this->option('exclude');
|
||||||
$bindings = array();
|
if (!empty($exclude)) {
|
||||||
foreach ($this->getAbstracts() as $abstract) {
|
$exclude = '/' . str_replace('\|', '|', preg_quote($exclude, '/')) . '/';
|
||||||
// Validator and seeder cause problems
|
|
||||||
if (in_array($abstract, ['validator', 'seeder'])) {
|
|
||||||
continue;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
foreach ($this->getAbstracts() as $abstract) {
|
||||||
|
if (!empty($exclude) && preg_match($exclude, $abstract))
|
||||||
|
continue;
|
||||||
|
|
||||||
try {
|
try {
|
||||||
$concrete = $this->laravel->make($abstract);
|
$concrete = $this->laravel->make($abstract);
|
||||||
if (is_object($concrete)) {
|
if (is_object($concrete)) {
|
||||||
$bindings[$abstract] = get_class($concrete);
|
$bindings[$abstract] = get_class($concrete);
|
||||||
}
|
}
|
||||||
} catch (\Exception $e) {
|
} catch (\Exception $e) {
|
||||||
if ($this->output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
|
$this->error("Cannot make $abstract: " . $e->getMessage());
|
||||||
$this->comment("Cannot make '$abstract': ".$e->getMessage());
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
asort($bindings);
|
||||||
|
|
||||||
$content = $this->view->make('ide-helper::meta', [
|
$content = $this->view->make('laravel-ide-helper::meta', array(
|
||||||
'bindings' => $bindings,
|
'bindings' => $bindings,
|
||||||
'methods' => $this->methods,
|
'methods' => $this->methods,
|
||||||
])->render();
|
))->render();
|
||||||
|
|
||||||
$filename = $this->option('filename');
|
$filename = $this->option('filename');
|
||||||
$written = $this->files->put($filename, $content);
|
$written = $this->files->put($filename, $content);
|
||||||
@@ -112,31 +109,32 @@ class MetaCommand extends Command
|
|||||||
*/
|
*/
|
||||||
protected function getAbstracts()
|
protected function getAbstracts()
|
||||||
{
|
{
|
||||||
$abstracts = $this->laravel->getBindings();
|
return array_keys($this->laravel->getBindings());
|
||||||
|
|
||||||
// Return the abstract names only
|
|
||||||
return array_keys($abstracts);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Register an autoloader the throws exceptions when a class is not found.
|
* Get a list of aliases from the Laravel Application.
|
||||||
*/
|
|
||||||
protected function registerClassAutoloadExceptions()
|
|
||||||
{
|
|
||||||
spl_autoload_register(function ($class) {
|
|
||||||
throw new \Exception("Class '$class' not found.");
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the console command options.
|
|
||||||
*
|
*
|
||||||
* @return array
|
* @return array
|
||||||
*/
|
*/
|
||||||
|
protected function getAppAliases()
|
||||||
|
{
|
||||||
|
static $aliasProp;
|
||||||
|
if (!isset($aliasProp)) {
|
||||||
|
$aliasProp = new \ReflectionProperty('Illuminate\Container\Container', 'aliases');
|
||||||
|
$aliasProp->setAccessible(true);
|
||||||
|
}
|
||||||
|
return $aliasProp->getValue($this->laravel);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* {@inheritdoc}
|
||||||
|
*/
|
||||||
protected function getOptions()
|
protected function getOptions()
|
||||||
{
|
{
|
||||||
return array(
|
return array(
|
||||||
array('filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the meta file', $this->filename),
|
array('filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the meta file', $this->filename),
|
||||||
|
array('exclude', 'E', InputOption::VALUE_OPTIONAL, 'Laravel bindings to exclude (e.g. "bar.|.foo")'),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+72
-250
@@ -11,42 +11,31 @@
|
|||||||
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 Barryvdh\Reflection\DocBlock;
|
use phpDocumentor\Reflection\DocBlock;
|
||||||
use Barryvdh\Reflection\DocBlock\Context;
|
use phpDocumentor\Reflection\DocBlock\Context;
|
||||||
use Barryvdh\Reflection\DocBlock\Tag;
|
use phpDocumentor\Reflection\DocBlock\Tag;
|
||||||
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
|
||||||
*
|
*
|
||||||
* @author Barry vd. Heuvel <[email protected]>
|
* @author Barry vd. Heuvel <[email protected]>
|
||||||
|
* @property \Illuminate\Container\Container $laravel
|
||||||
*/
|
*/
|
||||||
class ModelsCommand extends Command
|
class ModelsCommand extends Command
|
||||||
{
|
{
|
||||||
/**
|
|
||||||
* @var Filesystem $files
|
|
||||||
*/
|
|
||||||
protected $files;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The console command name.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @var string
|
|
||||||
*/
|
*/
|
||||||
protected $name = 'ide-helper:models';
|
protected $name = 'ide-helper:models';
|
||||||
protected $filename = '_ide_helper_models.php';
|
protected $filename = '_ide_helper_models.php';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The console command description.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @var string
|
|
||||||
*/
|
*/
|
||||||
protected $description = 'Generate autocompletion for models';
|
protected $description = 'Generate autocompletion for models';
|
||||||
|
|
||||||
@@ -56,13 +45,19 @@ class ModelsCommand extends Command
|
|||||||
protected $dirs = array();
|
protected $dirs = array();
|
||||||
protected $reset;
|
protected $reset;
|
||||||
|
|
||||||
|
/** @var \Illuminate\Filesystem\Filesystem */
|
||||||
|
protected $files;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param Filesystem $files
|
* {@inheritdoc}
|
||||||
|
*
|
||||||
|
* @param \Illuminate\Container\Container $app
|
||||||
*/
|
*/
|
||||||
public function __construct(Filesystem $files)
|
public function __construct($app)
|
||||||
{
|
{
|
||||||
|
$this->laravel = $app;
|
||||||
|
$this->files = $app['files'];
|
||||||
parent::__construct();
|
parent::__construct();
|
||||||
$this->files = $files;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -75,7 +70,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('ide-helper.model_locations'),
|
$this->laravel['config']->get('laravel-ide-helper::model_locations'),
|
||||||
$this->option('dir')
|
$this->option('dir')
|
||||||
);
|
);
|
||||||
$model = $this->argument('model');
|
$model = $this->argument('model');
|
||||||
@@ -84,10 +79,7 @@ class ModelsCommand extends Command
|
|||||||
|
|
||||||
//If filename is default and Write is not specified, ask what to do
|
//If filename is default and Write is not specified, ask what to do
|
||||||
if (!$this->write && $filename === $this->filename && !$this->option('nowrite')) {
|
if (!$this->write && $filename === $this->filename && !$this->option('nowrite')) {
|
||||||
if ($this->confirm(
|
if ($this->confirm("Do you want to overwrite the existing model files? Choose no to write to $filename instead? (Yes/No): ")) {
|
||||||
"Do you want to overwrite the existing model files? Choose no to write to $filename instead? (Yes/No): "
|
|
||||||
)
|
|
||||||
) {
|
|
||||||
$this->write = true;
|
$this->write = true;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -104,11 +96,8 @@ class ModelsCommand extends Command
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the console command arguments.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @return array
|
|
||||||
*/
|
*/
|
||||||
protected function getArguments()
|
protected function getArguments()
|
||||||
{
|
{
|
||||||
@@ -118,9 +107,7 @@ class ModelsCommand extends Command
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the console command options.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @return array
|
|
||||||
*/
|
*/
|
||||||
protected function getOptions()
|
protected function getOptions()
|
||||||
{
|
{
|
||||||
@@ -136,11 +123,9 @@ class ModelsCommand extends Command
|
|||||||
|
|
||||||
protected function generateDocs($loadModels, $ignore = '')
|
protected function generateDocs($loadModels, $ignore = '')
|
||||||
{
|
{
|
||||||
|
|
||||||
|
|
||||||
$output = "<?php
|
$output = "<?php
|
||||||
/**
|
/**
|
||||||
* A helper file for your Eloquent Models
|
* An 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.
|
||||||
*
|
*
|
||||||
@@ -163,9 +148,7 @@ 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;
|
||||||
}
|
}
|
||||||
$this->properties = array();
|
$this->properties = array();
|
||||||
@@ -179,13 +162,10 @@ class ModelsCommand extends Command
|
|||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
if ($this->output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
|
|
||||||
$this->comment("Loading model '$name'");
|
$this->comment("Loading model '$name'");
|
||||||
}
|
|
||||||
|
|
||||||
if (!$reflectionClass->IsInstantiable()) {
|
if (!$reflectionClass->isInstantiable()) {
|
||||||
// ignore abstract class or interface
|
throw new \Exception($name . ' is not instantiable.');
|
||||||
continue;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
$model = $this->laravel->make($name);
|
$model = $this->laravel->make($name);
|
||||||
@@ -194,30 +174,24 @@ 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;
|
|
||||||
} 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.");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!$hasDoctrine) {
|
if (!$hasDoctrine) {
|
||||||
$this->error(
|
$this->error(
|
||||||
'Warning: `"doctrine/dbal": "~2.3"` is required to load database information. '.
|
'Warning: `"doctrine/dbal": "~2.3"` is required to load database information. Please require that in your composer.json and run `composer update`.'
|
||||||
'Please require that in your composer.json and run `composer update`.'
|
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
return $output;
|
return $output;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
protected function loadModels()
|
protected function loadModels()
|
||||||
{
|
{
|
||||||
$models = array();
|
$models = array();
|
||||||
@@ -232,73 +206,6 @@ 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.
|
||||||
*
|
*
|
||||||
@@ -308,21 +215,9 @@ 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);
|
||||||
$databasePlatform = $schema->getDatabasePlatform();
|
$schema->getDatabasePlatform()->registerDoctrineTypeMapping('enum', 'string');
|
||||||
$databasePlatform->registerDoctrineTypeMapping('enum', 'string');
|
|
||||||
|
|
||||||
$platformName = $databasePlatform->getName();
|
$columns = $schema->listTableColumns($table);
|
||||||
$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) {
|
||||||
@@ -362,7 +257,7 @@ class ModelsCommand extends Command
|
|||||||
$comment = $column->getComment();
|
$comment = $column->getComment();
|
||||||
$this->setProperty($name, $type, true, true, $comment);
|
$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),
|
||||||
array('$value')
|
array('$value')
|
||||||
);
|
);
|
||||||
@@ -378,23 +273,13 @@ class ModelsCommand extends Command
|
|||||||
$methods = get_class_methods($model);
|
$methods = get_class_methods($model);
|
||||||
if ($methods) {
|
if ($methods) {
|
||||||
foreach ($methods as $method) {
|
foreach ($methods as $method) {
|
||||||
if (Str::startsWith($method, 'get') && Str::endsWith(
|
if (Str::startsWith($method, 'get') && Str::endsWith($method, 'Attribute') && $method !== 'getAttribute') {
|
||||||
$method,
|
|
||||||
'Attribute'
|
|
||||||
) && $method !== 'getAttribute'
|
|
||||||
) {
|
|
||||||
//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)) {
|
||||||
$reflection = new \ReflectionMethod($model, $method);
|
$this->setProperty($name, null, true, null);
|
||||||
$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, 'Attribute') && $method !== 'setAttribute') {
|
||||||
$method,
|
|
||||||
'Attribute'
|
|
||||||
) && $method !== 'setAttribute'
|
|
||||||
) {
|
|
||||||
//Magic set<name>Attribute
|
//Magic set<name>Attribute
|
||||||
$name = Str::snake(substr($method, 3, -9));
|
$name = Str::snake(substr($method, 3, -9));
|
||||||
if (!empty($name)) {
|
if (!empty($name)) {
|
||||||
@@ -408,11 +293,10 @@ 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, '\Illuminate\Database\Query\Builder|\\' . $reflection->class, $args);
|
$this->setMethod($name, '\\' . $reflection->class, $args);
|
||||||
}
|
}
|
||||||
} elseif (!method_exists('Illuminate\Database\Eloquent\Model', $method)
|
} elseif (!method_exists('Eloquent', $method) && !Str::startsWith($method, 'get')) {
|
||||||
&& !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);
|
||||||
|
|
||||||
@@ -424,53 +308,31 @@ 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', 'belongsToMany', 'hasOne', 'belongsTo', 'morphTo', 'morphMany', 'morphToMany') as $relation) {
|
||||||
'hasMany',
|
|
||||||
'hasManyThrough',
|
|
||||||
'belongsToMany',
|
|
||||||
'hasOne',
|
|
||||||
'belongsTo',
|
|
||||||
'morphOne',
|
|
||||||
'morphTo',
|
|
||||||
'morphMany',
|
|
||||||
'morphToMany'
|
|
||||||
) as $relation) {
|
|
||||||
$search = '$this->' . $relation . '(';
|
$search = '$this->' . $relation . '(';
|
||||||
if ($pos = stripos($code, $search)) {
|
if ($pos = stripos($code, $search)) {
|
||||||
//Resolve the relation's model to a Relation object.
|
$code = substr($code, $pos + strlen($search));
|
||||||
$relationObj = $model->$method();
|
$arguments = explode(',', substr($code, 0, strpos($code, ');')));
|
||||||
|
//Remove quotes, ensure 1 \ in front of the model
|
||||||
if ($relationObj instanceof Relation) {
|
$returnModel = $this->getClassName($arguments[0], $model);
|
||||||
$relatedModel = '\\' . get_class($relationObj->getRelated());
|
if ($relation === 'belongsToMany' or $relation === 'hasMany' or $relation === 'morphMany' or $relation === 'morphToMany') {
|
||||||
|
|
||||||
$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,
|
||||||
$this->getCollectionClass($relatedModel) . '|' . $relatedModel . '[]',
|
'\Illuminate\Database\Eloquent\Collection|' . $returnModel . '[]',
|
||||||
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, $relatedModel, true, null);
|
$this->setProperty($method, $returnModel, true, null);
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -490,10 +352,10 @@ class ModelsCommand extends Command
|
|||||||
$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;
|
$this->properties[$name]['comment'] = (string)$comment;
|
||||||
}
|
}
|
||||||
if ($type !== null) {
|
if ($type !== null) {
|
||||||
$this->properties[$name]['type'] = $this->getTypeOverride($type);
|
$this->properties[$name]['type'] = $type;
|
||||||
}
|
}
|
||||||
if ($read !== null) {
|
if ($read !== null) {
|
||||||
$this->properties[$name]['read'] = $read;
|
$this->properties[$name]['read'] = $read;
|
||||||
@@ -505,9 +367,7 @@ class ModelsCommand extends Command
|
|||||||
|
|
||||||
protected function setMethod($name, $type = '', $arguments = array())
|
protected function setMethod($name, $type = '', $arguments = array())
|
||||||
{
|
{
|
||||||
$methods = array_change_key_case($this->methods, CASE_LOWER);
|
if (!isset($this->methods[$name])) {
|
||||||
|
|
||||||
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;
|
||||||
@@ -520,10 +380,9 @@ class ModelsCommand extends Command
|
|||||||
*/
|
*/
|
||||||
protected function createPhpDocs($class)
|
protected function createPhpDocs($class)
|
||||||
{
|
{
|
||||||
|
|
||||||
$reflection = new \ReflectionClass($class);
|
$reflection = new \ReflectionClass($class);
|
||||||
$namespace = $reflection->getNamespaceName();
|
$namespace = $reflection->getNamespaceName();
|
||||||
$classname = $reflection->getShortName();
|
$className = $reflection->getShortName();
|
||||||
$originalDoc = $reflection->getDocComment();
|
$originalDoc = $reflection->getDocComment();
|
||||||
|
|
||||||
if ($this->reset) {
|
if ($this->reset) {
|
||||||
@@ -539,10 +398,11 @@ class ModelsCommand extends Command
|
|||||||
$properties = array();
|
$properties = array();
|
||||||
$methods = array();
|
$methods = array();
|
||||||
foreach ($phpdoc->getTags() as $tag) {
|
foreach ($phpdoc->getTags() as $tag) {
|
||||||
|
/* @var Tag|Tag\PropertyTag|Tag\MethodTag $tag */
|
||||||
$name = $tag->getName();
|
$name = $tag->getName();
|
||||||
if ($name == "property" || $name == "property-read" || $name == "property-write") {
|
if ($name == 'property' || $name == 'property-read' || $name == 'property-write') {
|
||||||
$properties[] = $tag->getVariableName();
|
$properties[] = $tag->getVariableName();
|
||||||
} elseif ($name == "method") {
|
} elseif ($name == 'method') {
|
||||||
$methods[] = $tag->getMethodName();
|
$methods[] = $tag->getMethodName();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -559,13 +419,7 @@ class ModelsCommand extends Command
|
|||||||
} else {
|
} else {
|
||||||
$attr = 'property-read';
|
$attr = 'property-read';
|
||||||
}
|
}
|
||||||
|
$tag = Tag::createInstance("@{$attr} {$property['type']} {$name} {$property['comment']}", $phpdoc);
|
||||||
if ($this->hasCamelCaseModelProperties()) {
|
|
||||||
$name = Str::camel($name);
|
|
||||||
}
|
|
||||||
|
|
||||||
$tagLine = trim("@{$attr} {$property['type']} {$name} {$property['comment']}");
|
|
||||||
$tag = Tag::createInstance($tagLine, $phpdoc);
|
|
||||||
$phpdoc->appendTag($tag);
|
$phpdoc->appendTag($tag);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -578,23 +432,18 @@ class ModelsCommand extends Command
|
|||||||
$phpdoc->appendTag($tag);
|
$phpdoc->appendTag($tag);
|
||||||
}
|
}
|
||||||
|
|
||||||
if ($this->write && ! $phpdoc->getTagsByName('mixin')) {
|
$serializer = new DocBlock\Serializer();
|
||||||
$phpdoc->appendTag(Tag::createInstance("@mixin \\Eloquent", $phpdoc));
|
|
||||||
}
|
|
||||||
|
|
||||||
$serializer = new DocBlockSerializer();
|
|
||||||
$serializer->getDocComment($phpdoc);
|
$serializer->getDocComment($phpdoc);
|
||||||
$docComment = $serializer->getDocComment($phpdoc);
|
$docComment = $serializer->getDocComment($phpdoc);
|
||||||
|
|
||||||
|
|
||||||
if ($this->write) {
|
if ($this->write) {
|
||||||
$filename = $reflection->getFileName();
|
$filename = $reflection->getFileName();
|
||||||
$contents = $this->files->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 {
|
||||||
$needle = "class {$classname}";
|
$needle = "class {$className}";
|
||||||
$replace = "{$docComment}\nclass {$classname}";
|
$replace = "{$docComment}\nclass {$className}";
|
||||||
$pos = strpos($contents, $needle);
|
$pos = strpos($contents, $needle);
|
||||||
if ($pos !== false) {
|
if ($pos !== false) {
|
||||||
$contents = substr_replace($contents, $replace, $pos, strlen($needle));
|
$contents = substr_replace($contents, $replace, $pos, strlen($needle));
|
||||||
@@ -605,27 +454,25 @@ class ModelsCommand extends Command
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
$output = "namespace {$namespace}{\n{$docComment}\n\tclass {$classname} extends \Eloquent {}\n}\n\n";
|
$output = "namespace {$namespace}{\n{$docComment}\n\tclass {$className} {}\n}\n\n";
|
||||||
return $output;
|
return $output;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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)
|
||||||
{
|
{
|
||||||
//Loop through the default values for paremeters, and make the correct output string
|
//Loop through the default values for parameters, and make the correct output string
|
||||||
$params = array();
|
|
||||||
$paramsWithDefault = array();
|
$paramsWithDefault = array();
|
||||||
/** @var \ReflectionParameter $param */
|
|
||||||
foreach ($method->getParameters() as $param) {
|
foreach ($method->getParameters() as $param) {
|
||||||
$paramClass = $param->getClass();
|
$paramStr = '$' . $param->getName();
|
||||||
$paramStr = (!is_null($paramClass) ? '\\' . $paramClass->getName() . ' ' : '') . '$' . $param->getName();
|
|
||||||
$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';
|
||||||
@@ -642,53 +489,28 @@ class ModelsCommand extends Command
|
|||||||
}
|
}
|
||||||
$paramsWithDefault[] = $paramStr;
|
$paramsWithDefault[] = $paramStr;
|
||||||
}
|
}
|
||||||
|
|
||||||
return $paramsWithDefault;
|
return $paramsWithDefault;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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 getCollectionClass($className)
|
private function getClassName($className, $model)
|
||||||
{
|
{
|
||||||
// Return something in the very very unlikely scenario the model doesn't
|
// If the class name was resolved via get_class($this) or static::class
|
||||||
// have a newCollection() method.
|
if (strpos($className, 'get_class($this)') !== false || strpos($className, 'static::class') !== false) {
|
||||||
if (!method_exists($className, 'newCollection')) {
|
return get_class($model);
|
||||||
return '\Illuminate\Database\Eloquent\Collection';
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/** @var \Illuminate\Database\Eloquent\Model $model */
|
// If the class name was resolved via ::class (PHP 5.5+)
|
||||||
$model = new $className;
|
if (strpos($className, '::class') !== false) {
|
||||||
return '\\' . get_class($model->newCollection());
|
$end = -1 * strlen('::class');
|
||||||
|
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;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+37
-94
@@ -10,10 +10,8 @@
|
|||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper;
|
namespace Barryvdh\LaravelIdeHelper;
|
||||||
|
|
||||||
use Illuminate\Foundation\Application;
|
use /** @noinspection PhpUndefinedNamespaceInspection,PhpUndefinedClassInspection */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
|
||||||
@@ -38,21 +36,18 @@ 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(
|
public function __construct(ConfigRepository $config, $view, OutputInterface $output = null, $helpers = '')
|
||||||
/*ConfigRepository */ $config,
|
{
|
||||||
/* Illuminate\View\Factory */ $view,
|
|
||||||
OutputInterface $output = null,
|
|
||||||
$helpers = ''
|
|
||||||
) {
|
|
||||||
$this->config = $config;
|
$this->config = $config;
|
||||||
$this->view = $view;
|
$this->view = $view;
|
||||||
|
|
||||||
// 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('ide-helper.extra'));
|
$this->extra = array_merge($this->extra, $this->config->get('laravel-ide-helper::extra'));
|
||||||
$this->magic = array_merge($this->magic, $this->config->get('ide-helper.magic'));
|
$this->magic = array_merge($this->magic, $this->config->get('laravel-ide-helper::magic'));
|
||||||
$this->interfaces = array_merge($this->interfaces, $this->config->get('ide-helper.interfaces'));
|
$this->interfaces = array_merge($this->interfaces, $this->config->get('laravel-ide-helper::interfaces'));
|
||||||
|
|
||||||
// Make all interface classes absolute
|
// Make all interface classes absolute
|
||||||
foreach ($this->interfaces as &$interface) {
|
foreach ($this->interfaces as &$interface) {
|
||||||
$interface = '\\' . ltrim($interface, '\\');
|
$interface = '\\' . ltrim($interface, '\\');
|
||||||
@@ -69,7 +64,7 @@ class Generator
|
|||||||
public function generate($format = 'php')
|
public function generate($format = 'php')
|
||||||
{
|
{
|
||||||
// Check if the generator for this format exists
|
// Check if the generator for this format exists
|
||||||
$method = 'generate'.ucfirst($format).'Helper';
|
$method = 'generate' . ucfirst($format) . 'Helper';
|
||||||
if (method_exists($this, $method)) {
|
if (method_exists($this, $method)) {
|
||||||
return $this->$method();
|
return $this->$method();
|
||||||
}
|
}
|
||||||
@@ -80,11 +75,10 @@ class Generator
|
|||||||
public function generatePhpHelper()
|
public function generatePhpHelper()
|
||||||
{
|
{
|
||||||
$app = app();
|
$app = app();
|
||||||
return $this->view->make('ide-helper::helper')
|
return $this->view->make('laravel-ide-helper::ide-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)
|
||||||
->with('include_fluent', $this->config->get('ide-helper.include_fluent', false))
|
|
||||||
->render();
|
->render();
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -95,7 +89,7 @@ class Generator
|
|||||||
foreach ($aliases as $alias) {
|
foreach ($aliases as $alias) {
|
||||||
$functions = array();
|
$functions = array();
|
||||||
foreach ($alias->getMethods() as $method) {
|
foreach ($alias->getMethods() as $method) {
|
||||||
$functions[$method->getName()] = '('. $method->getParamsWithDefault().')';
|
$functions[$method->getName()] = '(' . $method->getParamsWithDefault() . ')';
|
||||||
}
|
}
|
||||||
$classes[$alias->getAlias()] = array(
|
$classes[$alias->getAlias()] = array(
|
||||||
'functions' => $functions,
|
'functions' => $functions,
|
||||||
@@ -117,93 +111,71 @@ 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)) {
|
||||||
if (class_exists('\Illuminate\Foundation\Application')) {
|
/** @noinspection PhpUndefinedClassInspection */
|
||||||
$authMethod = version_compare(Application::VERSION, '5.2', '>=') ? 'guard' : 'driver';
|
$class = get_class(\Auth::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)) {
|
||||||
|
/** @noinspection PhpUndefinedClassInspection */
|
||||||
$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') && is_a('Cache', '\Illuminate\Support\Facades\Cache', true)) {
|
if (class_exists('Cache') && is_a('Cache', '\Illuminate\Support\Facades\Cache', true)) {
|
||||||
|
/** @noinspection PhpUndefinedClassInspection */
|
||||||
$driver = get_class(\Cache::driver());
|
$driver = get_class(\Cache::driver());
|
||||||
|
/** @noinspection PhpUndefinedClassInspection */
|
||||||
$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') && is_a('Queue', '\Illuminate\Support\Facades\Queue', true)) {
|
if (class_exists('Queue') && is_a('Queue', '\Illuminate\Support\Facades\Queue', true)) {
|
||||||
|
/** @noinspection PhpUndefinedClassInspection */
|
||||||
$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') && is_a('SSH', '\Illuminate\Support\Facades\SSH', true)) {
|
if (class_exists('SSH') && is_a('SSH', '\Illuminate\Support\Facades\SSH', true)) {
|
||||||
|
/** @noinspection PhpUndefinedClassInspection */
|
||||||
$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) {}
|
||||||
}
|
|
||||||
|
|
||||||
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) {
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Find all namespaces/aliases that are valid for us to render
|
* Find all namespaces/aliases that are valid for us to render
|
||||||
*
|
*
|
||||||
* @return array
|
* @return array|Alias[][]
|
||||||
*/
|
*/
|
||||||
protected function getNamespaces()
|
protected function getNamespaces()
|
||||||
{
|
{
|
||||||
$namespaces = array();
|
$namespaces = array();
|
||||||
|
|
||||||
// Get all aliases
|
// Get all aliases
|
||||||
foreach ($this->getAliases() as $name => $facade) {
|
/** @noinspection PhpUndefinedClassInspection */
|
||||||
// Skip the Redis facade, if not available (otherwise Fatal PHP Error)
|
foreach (AliasLoader::getInstance()->getAliases() as $name => $facade) {
|
||||||
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]);
|
||||||
@@ -215,46 +187,12 @@ 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
|
||||||
*
|
*
|
||||||
@@ -264,15 +202,20 @@ class Generator
|
|||||||
public function getDriver($alias)
|
public function getDriver($alias)
|
||||||
{
|
{
|
||||||
try {
|
try {
|
||||||
if ($alias == "Auth") {
|
if ($alias == 'Auth') {
|
||||||
|
/** @noinspection PhpUndefinedClassInspection */
|
||||||
$driver = \Auth::driver();
|
$driver = \Auth::driver();
|
||||||
} elseif ($alias == "DB") {
|
} elseif ($alias == 'DB') {
|
||||||
|
/** @noinspection PhpUndefinedClassInspection */
|
||||||
$driver = \DB::connection();
|
$driver = \DB::connection();
|
||||||
} elseif ($alias == "Cache") {
|
} elseif ($alias == 'Cache') {
|
||||||
|
/** @noinspection PhpUndefinedClassInspection */
|
||||||
$driver = get_class(\Cache::driver());
|
$driver = get_class(\Cache::driver());
|
||||||
|
/** @noinspection PhpUndefinedClassInspection */
|
||||||
$store = get_class(\Cache::getStore());
|
$store = get_class(\Cache::getStore());
|
||||||
return array($driver, $store);
|
return array($driver, $store);
|
||||||
} elseif ($alias == "Queue") {
|
} elseif ($alias == 'Queue') {
|
||||||
|
/** @noinspection PhpUndefinedClassInspection */
|
||||||
$driver = \Queue::connection();
|
$driver = \Queue::connection();
|
||||||
} else {
|
} else {
|
||||||
return false;
|
return false;
|
||||||
|
|||||||
@@ -15,45 +15,30 @@ use Barryvdh\LaravelIdeHelper\Console\MetaCommand;
|
|||||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||||
use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
|
use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @property \Illuminate\Container\Container $app
|
||||||
|
*/
|
||||||
class IdeHelperServiceProvider extends ServiceProvider
|
class IdeHelperServiceProvider extends ServiceProvider
|
||||||
{
|
{
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Indicates if loading of the provider is deferred.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @var bool
|
|
||||||
*/
|
*/
|
||||||
protected $defer = true;
|
protected $defer = true;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Bootstrap the application events.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @return void
|
|
||||||
*/
|
*/
|
||||||
public function boot()
|
public function boot()
|
||||||
{
|
{
|
||||||
$viewPath = __DIR__.'/../resources/views';
|
$this->package('barryvdh/laravel-ide-helper', 'laravel-ide-helper', __DIR__);
|
||||||
$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');
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Register the service provider.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @return void
|
|
||||||
*/
|
*/
|
||||||
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']);
|
||||||
@@ -62,13 +47,13 @@ class IdeHelperServiceProvider extends ServiceProvider
|
|||||||
|
|
||||||
$this->app['command.ide-helper.models'] = $this->app->share(
|
$this->app['command.ide-helper.models'] = $this->app->share(
|
||||||
function ($app) {
|
function ($app) {
|
||||||
return new ModelsCommand($app['files']);
|
return new ModelsCommand($app);
|
||||||
}
|
}
|
||||||
);
|
);
|
||||||
|
|
||||||
$this->app['command.ide-helper.meta'] = $this->app->share(
|
$this->app['command.ide-helper.meta'] = $this->app->share(
|
||||||
function ($app) {
|
function ($app) {
|
||||||
return new MetaCommand($app['files'], $app['view']);
|
return new MetaCommand($app);
|
||||||
}
|
}
|
||||||
);
|
);
|
||||||
|
|
||||||
@@ -76,12 +61,19 @@ class IdeHelperServiceProvider extends ServiceProvider
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the services provided by the provider.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @return array
|
|
||||||
*/
|
*/
|
||||||
public function provides()
|
public function provides()
|
||||||
{
|
{
|
||||||
return array('command.ide-helper.generate', 'command.ide-helper.models');
|
return array('command.ide-helper.generate', 'command.ide-helper.models', 'command.ide-helper.meta');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* {@inheritdoc}
|
||||||
|
*/
|
||||||
|
protected function getAppViewPath($package, $namespace = null)
|
||||||
|
{
|
||||||
|
return $this->app['path'] . "/views/packages/{$package}";
|
||||||
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|||||||
+109
-91
@@ -10,22 +10,19 @@
|
|||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper;
|
namespace Barryvdh\LaravelIdeHelper;
|
||||||
|
|
||||||
use Barryvdh\Reflection\DocBlock;
|
use phpDocumentor\Reflection\DocBlock;
|
||||||
use Barryvdh\Reflection\DocBlock\Context;
|
use phpDocumentor\Reflection\DocBlock\Context;
|
||||||
use Barryvdh\Reflection\DocBlock\Tag;
|
use phpDocumentor\Reflection\DocBlock\Tag;
|
||||||
use Barryvdh\Reflection\DocBlock\Tag\ReturnTag;
|
use phpDocumentor\Reflection\DocBlock\Tag\ReturnTag;
|
||||||
use Barryvdh\Reflection\DocBlock\Tag\ParamTag;
|
|
||||||
use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
|
|
||||||
|
|
||||||
class Method
|
class Method
|
||||||
{
|
{
|
||||||
/** @var \Barryvdh\Reflection\DocBlock */
|
/** @var \phpDocumentor\Reflection\DocBlock */
|
||||||
protected $phpdoc;
|
protected $phpdoc;
|
||||||
|
|
||||||
/** @var \ReflectionMethod */
|
/** @var \ReflectionMethod */
|
||||||
protected $method;
|
protected $method;
|
||||||
|
|
||||||
protected $output = '';
|
|
||||||
protected $name;
|
protected $name;
|
||||||
protected $namespace;
|
protected $namespace;
|
||||||
protected $params = array();
|
protected $params = array();
|
||||||
@@ -45,27 +42,25 @@ class Method
|
|||||||
$this->method = $method;
|
$this->method = $method;
|
||||||
$this->interfaces = $interfaces;
|
$this->interfaces = $interfaces;
|
||||||
$this->name = $methodName ?: $method->name;
|
$this->name = $methodName ?: $method->name;
|
||||||
$this->namespace = $method->getDeclaringClass()->getNamespaceName();
|
$declaringClass = $method->getDeclaringClass();
|
||||||
|
$this->namespace = $declaringClass->getNamespaceName();
|
||||||
|
|
||||||
//Create a DocBlock and serializer instance
|
//Create a DocBlock and serializer instance
|
||||||
$this->phpdoc = new DocBlock($method, new Context($this->namespace));
|
$this->phpdoc = new DocBlock($method, new Context($this->namespace, static::getUseStatements($declaringClass)));
|
||||||
|
|
||||||
//Normalize the description and inherit the docs from parents/interfaces
|
//Normalize the description and inherit the docs from parents/interfaces
|
||||||
try {
|
try {
|
||||||
$this->normalizeParams($this->phpdoc);
|
$this->normalizeReturnTags($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);
|
||||||
|
|
||||||
//Make the method static
|
//Make the method static
|
||||||
$this->phpdoc->appendTag(Tag::createInstance('@static', $this->phpdoc));
|
//$this->phpdoc->appendTag(Tag::createInstance('@static', $this->phpdoc));
|
||||||
|
|
||||||
//Reference the 'real' function in the declaringclass
|
//Reference the 'real' function in the declaringClass
|
||||||
$declaringClass = $method->getDeclaringClass();
|
|
||||||
$this->declaringClassName = '\\' . ltrim($declaringClass->name, '\\');
|
$this->declaringClassName = '\\' . ltrim($declaringClass->name, '\\');
|
||||||
$this->root = '\\' . ltrim($class->getName(), '\\');
|
$this->root = '\\' . ltrim($class->getName(), '\\');
|
||||||
}
|
}
|
||||||
@@ -94,12 +89,17 @@ class Method
|
|||||||
* Get the docblock for this method
|
* Get the docblock for this method
|
||||||
*
|
*
|
||||||
* @param string $prefix
|
* @param string $prefix
|
||||||
* @return mixed
|
* @param bool $trim
|
||||||
|
* @return string
|
||||||
*/
|
*/
|
||||||
public function getDocComment($prefix = "\t\t")
|
public function getDocComment($prefix = "\t\t", $trim = false)
|
||||||
{
|
{
|
||||||
$serializer = new DocBlockSerializer(1, $prefix);
|
$serializer = new DocBlock\Serializer(1, $prefix);
|
||||||
return $serializer->getDocComment($this->phpdoc);
|
$str = $serializer->getDocComment($this->phpdoc);
|
||||||
|
if ($trim) {
|
||||||
|
$str = preg_replace(array('/\s+$/m', '#^(\s*/\*\*[\r\n])(?:\s*\*[\r\n])+#u', '#(?:[\r\n]\s*\*)+([\r\n]\s*\*/)$#u'), array('', '$1', '$1'), $str);
|
||||||
|
}
|
||||||
|
return $str;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -112,11 +112,31 @@ class Method
|
|||||||
return $this->name;
|
return $this->name;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Checks whether the method is deprecated
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
public function isDeprecated()
|
||||||
|
{
|
||||||
|
return $this->phpdoc->hasTag('deprecated');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the declared parameters for this method
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
public function getDocParams()
|
||||||
|
{
|
||||||
|
return $this->phpdoc->getTagsByName('param');
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the parameters for this method
|
* Get the parameters for this method
|
||||||
*
|
*
|
||||||
* @param bool $implode Wether to implode the array or not
|
* @param bool $implode Whether to implode the array or not
|
||||||
* @return string
|
* @return string|array
|
||||||
*/
|
*/
|
||||||
public function getParams($implode = true)
|
public function getParams($implode = true)
|
||||||
{
|
{
|
||||||
@@ -126,8 +146,8 @@ class Method
|
|||||||
/**
|
/**
|
||||||
* Get the parameters for this method including default values
|
* Get the parameters for this method including default values
|
||||||
*
|
*
|
||||||
* @param bool $implode Wether to implode the array or not
|
* @param bool $implode Whether to implode the array or not
|
||||||
* @return string
|
* @return string|array
|
||||||
*/
|
*/
|
||||||
public function getParamsWithDefault($implode = true)
|
public function getParamsWithDefault($implode = true)
|
||||||
{
|
{
|
||||||
@@ -145,103 +165,90 @@ class Method
|
|||||||
$description = $phpdoc->getText();
|
$description = $phpdoc->getText();
|
||||||
|
|
||||||
//Loop through parents/interfaces, to fill in {@inheritdoc}
|
//Loop through parents/interfaces, to fill in {@inheritdoc}
|
||||||
if (strpos($description, '{@inheritdoc}') !== false) {
|
if (stripos($description, '{@inheritdoc}') !== false && ($inheritdoc = $this->getInheritDoc($this->method))) {
|
||||||
$inheritdoc = $this->getInheritDoc($this->method);
|
|
||||||
$inheritDescription = $inheritdoc->getText();
|
$inheritDescription = $inheritdoc->getText();
|
||||||
|
|
||||||
$description = str_replace('{@inheritdoc}', $inheritDescription, $description);
|
$description = str_ireplace('{@inheritdoc}', $inheritDescription, $description);
|
||||||
$phpdoc->setText($description);
|
$phpdoc->setText($description);
|
||||||
|
|
||||||
$this->normalizeParams($inheritdoc);
|
$this->normalizeReturnTags($inheritdoc);
|
||||||
$this->normalizeReturn($inheritdoc);
|
|
||||||
|
|
||||||
//Add the tags that are inherited
|
//Add the tags that are inherited
|
||||||
$inheritTags = $inheritdoc->getTags();
|
foreach ($inheritdoc->getTags() as $tag) {
|
||||||
if ($inheritTags) {
|
|
||||||
/** @var Tag $tag */
|
|
||||||
foreach ($inheritTags as $tag) {
|
|
||||||
$tag->setDocBlock();
|
$tag->setDocBlock();
|
||||||
$phpdoc->appendTag($tag);
|
$phpdoc->appendTag($tag);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Normalize the parameters
|
|
||||||
*
|
|
||||||
* @param DocBlock $phpdoc
|
|
||||||
*/
|
|
||||||
protected function normalizeParams(DocBlock $phpdoc)
|
|
||||||
{
|
|
||||||
//Get the return type and adjust them for beter autocomplete
|
|
||||||
$paramTags = $phpdoc->getTagsByName('param');
|
|
||||||
if ($paramTags) {
|
|
||||||
/** @var ParamTag $tag */
|
|
||||||
foreach ($paramTags as $tag) {
|
|
||||||
// Convert the keywords
|
|
||||||
$content = $this->convertKeywords($tag->getContent());
|
|
||||||
$tag->setContent($content);
|
|
||||||
|
|
||||||
// Get the expanded type and re-set the content
|
|
||||||
$content = $tag->getType() . ' ' . $tag->getVariableName() . ' ' . $tag->getDescription();
|
|
||||||
$tag->setContent(trim($content));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Normalize the return tag (make full namespace, replace interfaces)
|
* Normalize the return tag (make full namespace, replace interfaces)
|
||||||
*
|
*
|
||||||
* @param DocBlock $phpdoc
|
* @param DocBlock $phpdoc
|
||||||
*/
|
*/
|
||||||
protected function normalizeReturn(DocBlock $phpdoc)
|
protected function normalizeReturnTags(DocBlock $phpdoc)
|
||||||
{
|
{
|
||||||
//Get the return type and adjust them for beter autocomplete
|
static $typeProp;
|
||||||
$returnTags = $phpdoc->getTagsByName('return');
|
if (!isset($typeProp)) {
|
||||||
if ($returnTags) {
|
$typeProp = new \ReflectionProperty('phpDocumentor\Reflection\DocBlock\Tag\ReturnTag', 'type');
|
||||||
/** @var ReturnTag $tag */
|
$typeProp->setAccessible(true);
|
||||||
$tag = reset($returnTags);
|
|
||||||
// Get the expanded type
|
|
||||||
$returnValue = $tag->getType();
|
|
||||||
|
|
||||||
// Replace the interfaces
|
|
||||||
foreach ($this->interfaces as $interface => $real) {
|
|
||||||
$returnValue = str_replace($interface, $real, $returnValue);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Set the changed content
|
|
||||||
$tag->setContent($returnValue . ' ' . $tag->getDescription());
|
|
||||||
$this->return = $returnValue;
|
|
||||||
} else {
|
|
||||||
$this->return = null;
|
$this->return = null;
|
||||||
|
//Get the return type and adjust them for better autocomplete
|
||||||
|
foreach ($phpdoc->getTags() as $tag) {
|
||||||
|
if ($tag instanceof ReturnTag) {
|
||||||
|
// Convert the keywords
|
||||||
|
$typeValue = static::convertKeywords($typeProp->getValue($tag));
|
||||||
|
$typeProp->setValue($tag, $typeValue);
|
||||||
|
|
||||||
|
// Get the expanded type
|
||||||
|
$typeValue = $tag->getType();
|
||||||
|
|
||||||
|
// Replace the interfaces
|
||||||
|
if (preg_match('/\bReturnTag$/', get_class($tag))) {
|
||||||
|
foreach ($this->interfaces as $interface => $real) {
|
||||||
|
$typeValue = preg_replace('/(^|\|)' . preg_quote($interface, '/') . '\b/', $real, $typeValue);
|
||||||
|
}
|
||||||
|
$this->return = $typeValue;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Re-set the type
|
||||||
|
$typeProp->setValue($tag, $typeValue);
|
||||||
|
$tag->setDescription($tag->getDescription());
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Convert keywwords that are incorrect.
|
* Convert keywords that are incorrect.
|
||||||
*
|
*
|
||||||
* @param string $string
|
* @param string $string
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
protected function convertKeywords($string)
|
protected static function convertKeywords($string)
|
||||||
{
|
{
|
||||||
$string = str_replace('\Closure', 'Closure', $string);
|
$types = explode('|', $string);
|
||||||
$string = str_replace('Closure', '\Closure', $string);
|
foreach ($types as &$type) {
|
||||||
$string = str_replace('dynamic', 'mixed', $string);
|
if ($type === 'Closure')
|
||||||
|
$type = '\Closure';
|
||||||
return $string;
|
elseif ($type === 'dynamic')
|
||||||
|
$type = 'mixed';
|
||||||
|
elseif (strrpos($type, '\\') && $type[0] !== '\\' && (class_exists($type) || interface_exists($type)))
|
||||||
|
$type = '\\' . $type;
|
||||||
|
}
|
||||||
|
return implode('|', $types);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Should the function return a value?
|
* Should the function return a value?
|
||||||
*
|
*
|
||||||
* @return bool
|
* @return bool|int
|
||||||
*/
|
*/
|
||||||
public function shouldReturn()
|
public function shouldReturn()
|
||||||
{
|
{
|
||||||
if ($this->return !== "void" && $this->method->name !== "__construct") {
|
if ($this->return !== 'void' && $this->method->name !== '__construct') {
|
||||||
return true;
|
return isset($this->return) ? true : 1;
|
||||||
}
|
}
|
||||||
|
|
||||||
return false;
|
return false;
|
||||||
@@ -251,16 +258,18 @@ class Method
|
|||||||
* Get the parameters and format them correctly
|
* Get the parameters and format them correctly
|
||||||
*
|
*
|
||||||
* @param \ReflectionMethod $method
|
* @param \ReflectionMethod $method
|
||||||
* @return array
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function getParameters($method)
|
public function getParameters($method)
|
||||||
{
|
{
|
||||||
//Loop through the default values for paremeters, and make the correct output string
|
//Loop through the default values for parameters, and make the correct output string
|
||||||
$params = array();
|
$params = array();
|
||||||
$paramsWithDefault = array();
|
$paramsWithDefault = array();
|
||||||
|
|
||||||
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()) {
|
||||||
$default = $param->isDefaultValueAvailable() ? $param->getDefaultValue() : null;
|
$default = $param->isDefaultValueAvailable() ? $param->getDefaultValue() : null;
|
||||||
if (is_bool($default)) {
|
if (is_bool($default)) {
|
||||||
@@ -271,13 +280,12 @@ 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) . "'";
|
||||||
}
|
}
|
||||||
$paramStr .= " = $default";
|
$paramStr .= " = $default";
|
||||||
}
|
}
|
||||||
|
|
||||||
$paramsWithDefault[] = $paramStr;
|
$paramsWithDefault[] = $paramStr;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -287,7 +295,7 @@ class Method
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @param \ReflectionMethod $reflectionMethod
|
* @param \ReflectionMethod $reflectionMethod
|
||||||
* @return DocBlock
|
* @return DocBlock|null
|
||||||
*/
|
*/
|
||||||
protected function getInheritDoc($reflectionMethod)
|
protected function getInheritDoc($reflectionMethod)
|
||||||
{
|
{
|
||||||
@@ -301,14 +309,24 @@ class Method
|
|||||||
}
|
}
|
||||||
if ($method) {
|
if ($method) {
|
||||||
$namespace = $method->getDeclaringClass()->getNamespaceName();
|
$namespace = $method->getDeclaringClass()->getNamespaceName();
|
||||||
$phpdoc = new DocBlock($method, new Context($namespace));
|
$phpdoc = new DocBlock($method, new Context($namespace, static::getUseStatements($method->getDeclaringClass())));
|
||||||
|
|
||||||
if (strpos($phpdoc->getText(), '{@inheritdoc}') !== false) {
|
if (stripos($phpdoc->getText(), '{@inheritdoc}') !== false) {
|
||||||
//Not at the end yet, try another parent/interface..
|
//Not at the end yet, try another parent/interface..
|
||||||
return $this->getInheritDoc($method);
|
return $this->getInheritDoc($method);
|
||||||
} else {
|
} else {
|
||||||
return $phpdoc;
|
return $phpdoc;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
protected static function getUseStatements(\ReflectionClass $class)
|
||||||
|
{
|
||||||
|
try {
|
||||||
|
return PhpReflection::getUseStatements($class);
|
||||||
|
} catch (\Exception $e) {
|
||||||
|
return array();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,166 @@
|
|||||||
|
<?php namespace Barryvdh\LaravelIdeHelper;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* PHP reflection helpers.
|
||||||
|
*
|
||||||
|
* This file is part of the Nette Framework (https://nette.org)
|
||||||
|
* Copyright (c) 2004 David Grudl (https://davidgrudl.com)
|
||||||
|
*
|
||||||
|
* @see https://github.com/nette/di/blob/v2.4/src/DI/PhpReflection.php
|
||||||
|
*/
|
||||||
|
class PhpReflection
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Expands class name into full name.
|
||||||
|
*
|
||||||
|
* @param string $name
|
||||||
|
* @param \ReflectionClass $rc
|
||||||
|
* @return string full name
|
||||||
|
* @throws \InvalidArgumentException
|
||||||
|
*/
|
||||||
|
public static function expandClassName($name, \ReflectionClass $rc)
|
||||||
|
{
|
||||||
|
$lower = strtolower($name);
|
||||||
|
if (empty($name)) {
|
||||||
|
throw new \InvalidArgumentException('Class name must not be empty.');
|
||||||
|
} elseif (self::isBuiltinType($lower)) {
|
||||||
|
return $lower;
|
||||||
|
} elseif ($lower === 'self' || $lower === 'static' || $lower === '$this') {
|
||||||
|
return $rc->getName();
|
||||||
|
} elseif ($name[0] === '\\') { // fully qualified name
|
||||||
|
return ltrim($name, '\\');
|
||||||
|
}
|
||||||
|
|
||||||
|
$uses = self::getUseStatements($rc);
|
||||||
|
$parts = explode('\\', $name, 2);
|
||||||
|
if (isset($uses[$parts[0]])) {
|
||||||
|
$parts[0] = $uses[$parts[0]];
|
||||||
|
return implode('\\', $parts);
|
||||||
|
} elseif ($rc->inNamespace()) {
|
||||||
|
return $rc->getNamespaceName() . '\\' . $name;
|
||||||
|
} else {
|
||||||
|
return $name;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param \ReflectionClass
|
||||||
|
* @return array of [alias => class]
|
||||||
|
*/
|
||||||
|
public static function getUseStatements(\ReflectionClass $class)
|
||||||
|
{
|
||||||
|
static $cache = array();
|
||||||
|
if (!isset($cache[$name = $class->getName()])) {
|
||||||
|
if ($class->isInternal() || !($code = @file_get_contents($class->getFileName()))) {
|
||||||
|
$cache[$name] = array();
|
||||||
|
} else {
|
||||||
|
$cache = self::parseUseStatements($code, $name) + $cache;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return $cache[$name];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
public static function isBuiltinType($type)
|
||||||
|
{
|
||||||
|
return in_array(strtolower($type), array('string', 'int', 'float', 'bool', 'array', 'callable'), true);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Parses PHP code.
|
||||||
|
*
|
||||||
|
* @param string $code
|
||||||
|
* @param string $forClass
|
||||||
|
* @return array of [class => [alias => class, ...]]
|
||||||
|
*/
|
||||||
|
public static function parseUseStatements($code, $forClass = null)
|
||||||
|
{
|
||||||
|
$tokens = token_get_all($code);
|
||||||
|
$namespace = $class = $classLevel = $level = null;
|
||||||
|
$res = $uses = array();
|
||||||
|
|
||||||
|
while ($token = current($tokens)) {
|
||||||
|
next($tokens);
|
||||||
|
switch (is_array($token) ? $token[0] : $token) {
|
||||||
|
case T_NAMESPACE:
|
||||||
|
$namespace = ltrim(self::fetch($tokens, array(T_STRING, T_NS_SEPARATOR)) . '\\', '\\');
|
||||||
|
$uses = array();
|
||||||
|
break;
|
||||||
|
|
||||||
|
case T_CLASS:
|
||||||
|
case T_INTERFACE:
|
||||||
|
case PHP_VERSION_ID < 50400 ? -1 : T_TRAIT:
|
||||||
|
if ($name = self::fetch($tokens, T_STRING)) {
|
||||||
|
$class = $namespace . $name;
|
||||||
|
$classLevel = $level + 1;
|
||||||
|
$res[$class] = $uses;
|
||||||
|
if ($class === $forClass) {
|
||||||
|
return $res;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
case T_USE:
|
||||||
|
while (!$class && ($name = self::fetch($tokens, array(T_STRING, T_NS_SEPARATOR)))) {
|
||||||
|
$name = ltrim($name, '\\');
|
||||||
|
if (self::fetch($tokens, '{')) {
|
||||||
|
while ($suffix = self::fetch($tokens, array(T_STRING, T_NS_SEPARATOR))) {
|
||||||
|
if (self::fetch($tokens, T_AS)) {
|
||||||
|
$uses[self::fetch($tokens, T_STRING)] = $name . $suffix;
|
||||||
|
} else {
|
||||||
|
$tmp = explode('\\', $suffix);
|
||||||
|
$uses[end($tmp)] = $name . $suffix;
|
||||||
|
}
|
||||||
|
if (!self::fetch($tokens, ',')) {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
} elseif (self::fetch($tokens, T_AS)) {
|
||||||
|
$uses[self::fetch($tokens, T_STRING)] = $name;
|
||||||
|
|
||||||
|
} else {
|
||||||
|
$tmp = explode('\\', $name);
|
||||||
|
$uses[end($tmp)] = $name;
|
||||||
|
}
|
||||||
|
if (!self::fetch($tokens, ',')) {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
case T_CURLY_OPEN:
|
||||||
|
case T_DOLLAR_OPEN_CURLY_BRACES:
|
||||||
|
case '{':
|
||||||
|
$level++;
|
||||||
|
break;
|
||||||
|
|
||||||
|
case '}':
|
||||||
|
if ($level === $classLevel) {
|
||||||
|
$class = $classLevel = null;
|
||||||
|
}
|
||||||
|
$level--;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return $res;
|
||||||
|
}
|
||||||
|
|
||||||
|
private static function fetch(&$tokens, $take)
|
||||||
|
{
|
||||||
|
$res = null;
|
||||||
|
while ($token = current($tokens)) {
|
||||||
|
list($token, $s) = is_array($token) ? $token : array($token, $token);
|
||||||
|
if (in_array($token, (array)$take, true)) {
|
||||||
|
$res .= $s;
|
||||||
|
} elseif (!in_array($token, array(T_DOC_COMMENT, T_WHITESPACE, T_COMMENT), true)) {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
next($tokens);
|
||||||
|
}
|
||||||
|
return $res;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,92 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
use Illuminate\Support\Facades\Config;
|
||||||
|
|
||||||
|
return array(
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Filename & Format
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| The default filename (without extension) and the format (php or json)
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
'filename' => '_ide_helper',
|
||||||
|
'format' => 'php',
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Helper files to include
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| Include helper files. By default not included, but can be toggled with the
|
||||||
|
| -- helpers (-H) option. Extra helper files can be included.
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
'include_helpers' => false,
|
||||||
|
|
||||||
|
'helper_files' => array(
|
||||||
|
base_path().'/vendor/laravel/framework/src/Illuminate/Support/helpers.php',
|
||||||
|
),
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Model locations to include
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| Define in which directories the ide-helper:models command should look
|
||||||
|
| for models.
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
'model_locations' => array(
|
||||||
|
'app/models',
|
||||||
|
),
|
||||||
|
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Extra classes
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| These implementations are not really extended, but called with magic functions
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
'extra' => array(
|
||||||
|
'Artisan' => array('Illuminate\Foundation\Artisan'),
|
||||||
|
'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
|
||||||
|
'Session' => array('Illuminate\Session\Store'),
|
||||||
|
),
|
||||||
|
|
||||||
|
'magic' => array(
|
||||||
|
'Log' => array(
|
||||||
|
'debug' => 'Monolog\Logger::addDebug',
|
||||||
|
'info' => 'Monolog\Logger::addInfo',
|
||||||
|
'notice' => 'Monolog\Logger::addNotice',
|
||||||
|
'warning' => 'Monolog\Logger::addWarning',
|
||||||
|
'error' => 'Monolog\Logger::addError',
|
||||||
|
'critical' => 'Monolog\Logger::addCritical',
|
||||||
|
'alert' => 'Monolog\Logger::addAlert',
|
||||||
|
'emergency' => 'Monolog\Logger::addEmergency',
|
||||||
|
)
|
||||||
|
),
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Interface implementations
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| These interfaces will be replaced with the implementing class. Some interfaces
|
||||||
|
| are detected by the helpers, others can be listed below.
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
'interfaces' => array(
|
||||||
|
'\Illuminate\Auth\UserInterface' => Config::get('auth.model', 'User'),
|
||||||
|
)
|
||||||
|
|
||||||
|
);
|
||||||
@@ -0,0 +1,46 @@
|
|||||||
|
<?= '<?php' ?>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An helper file for Laravel 4, to provide autocomplete information to your IDE
|
||||||
|
* Generated for Laravel <?= $version ?> on <?= date('Y-m-d') ?>.
|
||||||
|
*
|
||||||
|
* @author Barry vd. Heuvel <barryvdh@gmail.com>
|
||||||
|
* @see https://github.com/barryvdh/laravel-ide-helper
|
||||||
|
*/
|
||||||
|
|
||||||
|
<?php foreach ($namespaces as $namespace => $aliases/* @var \Barryvdh\LaravelIdeHelper\Alias[] $aliases */): ?>
|
||||||
|
namespace <?= $namespace == '__root' ? '' : $namespace ?>{
|
||||||
|
<?php if ($namespace == '__root'): ?>
|
||||||
|
exit('This file should not be included, only analyzed by your IDE');
|
||||||
|
<?= $helpers ?>
|
||||||
|
<?php endif; ?>
|
||||||
|
<?php foreach ($aliases as $alias): ?>
|
||||||
|
|
||||||
|
<?php if (($cBase = class_basename($alias->getExtends())) != $alias->getExtends() && $cBase != $alias->getShortName()): ?>
|
||||||
|
/** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */
|
||||||
|
<?php endif; ?>
|
||||||
|
<?= $alias->getClassType() ?> <?= $alias->getShortName() ?> <?= $alias->getExtends() ? 'extends ' . $alias->getExtends() : '' ?>{
|
||||||
|
<?php foreach ($alias->getMethods() as $method): ?>
|
||||||
|
|
||||||
|
<?php if (($nParams = count($method->getDocParams())) > count($mParams = $method->getParamsWithDefault(false))): ?>
|
||||||
|
/** @noinspection PhpDocSignatureInspection */
|
||||||
|
<?php endif; ?>
|
||||||
|
<?php if ($docComment = str_replace("/**\n\t\t */", '', trim($method->getDocComment("\t\t", true)))): ?>
|
||||||
|
<?= $docComment ?>
|
||||||
|
|
||||||
|
<?php endif; ?>
|
||||||
|
public static function <?= $method->getName() ?>(<?= ($docComment && $nParams < count($mParams)) ? '/** @noinspection PhpDocSignatureInspection */' . implode(', /** @noinspection PhpDocSignatureInspection */', $mParams) : $method->getParamsWithDefault() ?>){
|
||||||
|
<?php if ($method->getDeclaringClass() !== $method->getRoot()): ?>
|
||||||
|
//Method inherited from <?= $method->getDeclaringClass() ?>
|
||||||
|
|
||||||
|
<?php endif; ?>
|
||||||
|
/** @noinspection PhpUnnecessaryFullyQualifiedNameInspection,PhpDynamicAsStaticMethodCallInspection<?= ($method->shouldReturn() === 1 ? ',PhpVoidFunctionResultUsedInspection' : '') . ($method->isDeprecated() ? ',PhpDeprecationInspection' : '') ?> */
|
||||||
|
<?= $method->shouldReturn() ? 'return ' : '' ?><?= $method->getRoot() ?>::<?= $method->getName() ?>(<?= $method->getParams() ?>);
|
||||||
|
}
|
||||||
|
<?php endforeach; ?>
|
||||||
|
|
||||||
|
}
|
||||||
|
<?php endforeach; ?>
|
||||||
|
|
||||||
|
}
|
||||||
|
<?php endforeach; ?>
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
<?= '<?php' ?> namespace PHPSTORM_META {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* PhpStorm Meta file, to provide autocomplete information for PhpStorm
|
||||||
|
* Generated on <?= date('Y-m-d') ?>.
|
||||||
|
*
|
||||||
|
* @author Barry vd. Heuvel <barryvdh@gmail.com>
|
||||||
|
* @see https://github.com/barryvdh/laravel-ide-helper
|
||||||
|
*/
|
||||||
|
|
||||||
|
/** @noinspection PhpIllegalArrayKeyTypeInspection,PhpUnusedLocalVariableInspection,PhpUnnecessaryFullyQualifiedNameInspection */
|
||||||
|
$STATIC_METHOD_TYPES = array(
|
||||||
|
<?php foreach ($methods as $method): ?>
|
||||||
|
<?= strpos($method, 'new ') === 0 ? $method : $method . '(\'\')' ?> => array(
|
||||||
|
<?php foreach ($bindings as $abstract => $class): ?>
|
||||||
|
<?= var_export($abstract, true) ?> instanceof \<?= $class ?>,
|
||||||
|
<?php endforeach ?>
|
||||||
|
),
|
||||||
|
<?php endforeach ?>
|
||||||
|
);
|
||||||
|
|
||||||
|
}
|
||||||
+25
-45
@@ -1,58 +1,38 @@
|
|||||||
<?php
|
<?php namespace Barryvdh\LaravelIdeHelper;
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper;
|
class MethodTest extends \PHPUnit_Framework_TestCase
|
||||||
|
|
||||||
class ExampleTest extends \PHPUnit_Framework_TestCase
|
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* Test that we can actually instantiate the class
|
* @expectedException \PHPUnit_Framework_Error
|
||||||
|
* @expectedExceptionMessage Argument 1 passed to
|
||||||
*/
|
*/
|
||||||
public function testCanInstantiate()
|
public function testConstructorWithoutMethod()
|
||||||
{
|
{
|
||||||
$reflectionClass = new \ReflectionClass(ExampleClass::class);
|
new Method(null, null, null);
|
||||||
$reflectionMethod = $reflectionClass->getMethod('setName');
|
|
||||||
|
|
||||||
$method = new Method($reflectionMethod, 'Example', $reflectionClass);
|
|
||||||
|
|
||||||
$this->assertInstanceOf(Method::class, $method);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
public function testConstructor()
|
||||||
* Test the output of a class
|
|
||||||
*/
|
|
||||||
public function testOutput()
|
|
||||||
{
|
{
|
||||||
$reflectionClass = new \ReflectionClass(ExampleClass::class);
|
$method = new \ReflectionMethod('PHPUnit_Framework_TestCase', 'getMock');
|
||||||
$reflectionMethod = $reflectionClass->getMethod('setName');
|
$object = new Method($method, null, new \ReflectionClass(get_class($this)));
|
||||||
|
|
||||||
$method = new Method($reflectionMethod, 'Example', $reflectionClass);
|
$this->assertSame('\PHPUnit_Framework_TestCase', $object->getDeclaringClass());
|
||||||
|
$this->assertSame('\\' . get_class($this), $object->getRoot());
|
||||||
|
$this->assertSame('getMock', $object->getName());
|
||||||
|
|
||||||
$output = '/**
|
$prop = new \ReflectionProperty(get_class($object), 'namespace');
|
||||||
*
|
$prop->setAccessible(true);
|
||||||
*
|
$this->assertSame('', $prop->getValue($object));
|
||||||
* @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
|
$this->assertFalse($object->isDeprecated());
|
||||||
{
|
$this->assertCount($method->getNumberOfParameters(), $object->getDocParams());
|
||||||
/**
|
|
||||||
* @param string $last
|
$doc = $object->getDocComment('', true);
|
||||||
* @param string $first
|
$this->assertContains("\n * " . '@param array|null $methods', $doc);
|
||||||
*/
|
$this->assertContains("\n * " . '@return \PHPUnit_Framework_MockObject_MockObject', $doc);
|
||||||
public function setName($last, $first = 'Barry')
|
$this->assertContains("\n * " . '@throws \PHPUnit_Framework_Exception', $doc);
|
||||||
{
|
|
||||||
return;
|
$this->assertTrue($object->shouldReturn());
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
@@ -0,0 +1,83 @@
|
|||||||
|
<?php namespace Barryvdh\LaravelIdeHelper;
|
||||||
|
|
||||||
|
class ServiceProviderTest extends \PHPUnit_Framework_TestCase
|
||||||
|
{
|
||||||
|
/** @var \PHPUnit_Framework_MockObject_MockObject|\Illuminate\Container\Container */
|
||||||
|
protected $app;
|
||||||
|
/** @var IdeHelperServiceProvider */
|
||||||
|
protected $provider;
|
||||||
|
|
||||||
|
static function makeAppMock(\PHPUnit_Framework_TestCase $testCase)
|
||||||
|
{
|
||||||
|
$app = $testCase->getMock('Illuminate\Container\Container', array('make', 'bind'));
|
||||||
|
|
||||||
|
$fs = $testCase->getMock('Illuminate\Filesystem\Filesystem', null);
|
||||||
|
$config = $testCase->getMock('Illuminate\Config\Repository', array('get', 'set', 'package'), array(), '', false);
|
||||||
|
$events = $testCase->getMock('Illuminate\Events\Dispatcher', array('listen'), array($app));
|
||||||
|
$view = $testCase->getMock('Illuminate\View\Factory', array('addNamespace'), array(), '', false);
|
||||||
|
|
||||||
|
$app->expects($testCase->any())->method('make')->willReturnMap(array(
|
||||||
|
array('files', array(), $fs),
|
||||||
|
array('config', array(), $config),
|
||||||
|
array('events', array(), $events),
|
||||||
|
array('view', array(), $view),
|
||||||
|
array('path', array(), __DIR__),
|
||||||
|
));
|
||||||
|
|
||||||
|
return $app;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* {@inheritdoc}
|
||||||
|
*/
|
||||||
|
protected function setUp()
|
||||||
|
{
|
||||||
|
$this->app = static::makeAppMock($this);
|
||||||
|
/** @noinspection PhpParamsInspection */
|
||||||
|
$this->provider = new IdeHelperServiceProvider($this->app);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testDeferred()
|
||||||
|
{
|
||||||
|
$this->assertTrue($this->provider->isDeferred());
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testProvides()
|
||||||
|
{
|
||||||
|
$this->assertEquals(array('command.ide-helper.generate', 'command.ide-helper.models', 'command.ide-helper.meta'), $this->provider->provides());
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testRegister()
|
||||||
|
{
|
||||||
|
$this->app->expects($this->exactly(3))->method('bind')->withConsecutive(
|
||||||
|
array('command.ide-helper.generate', $this->isType(\PHPUnit_Framework_Constraint_IsType::TYPE_CALLABLE), $this->isFalse()),
|
||||||
|
array('command.ide-helper.models', $this->isType(\PHPUnit_Framework_Constraint_IsType::TYPE_CALLABLE), $this->isFalse()),
|
||||||
|
array('command.ide-helper.meta', $this->isType(\PHPUnit_Framework_Constraint_IsType::TYPE_CALLABLE), $this->isFalse())
|
||||||
|
);
|
||||||
|
|
||||||
|
/** @var \PHPUnit_Framework_MockObject_MockObject|\Illuminate\Events\Dispatcher $events */
|
||||||
|
$events = $this->app['events'];
|
||||||
|
$events->expects($this->once())->method('listen')->with('artisan.start', $this->callback(function ($listener) {
|
||||||
|
$params = print_r(array('commands' => array('command.ide-helper.generate', 'command.ide-helper.models', 'command.ide-helper.meta')), true);
|
||||||
|
return strpos(preg_replace('/^\s+/mu', '', print_r($listener, true)), preg_replace('/^\s+/mu', '', $params));
|
||||||
|
}), 0);
|
||||||
|
|
||||||
|
$this->provider->register();
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testBoot()
|
||||||
|
{
|
||||||
|
$path = realpath(__DIR__ . '/../src');
|
||||||
|
|
||||||
|
/** @var \PHPUnit_Framework_MockObject_MockObject|\Illuminate\Config\Repository $config */
|
||||||
|
$config = $this->app['config'];
|
||||||
|
$config->expects($this->once())->method('package')->with('barryvdh/laravel-ide-helper', $path . '/config', 'laravel-ide-helper');
|
||||||
|
|
||||||
|
/** @var \PHPUnit_Framework_MockObject_MockObject|\Illuminate\View\Factory $view */
|
||||||
|
$view = $this->app['view'];
|
||||||
|
$view->expects($this->once())->method('addNamespace')->with('laravel-ide-helper', $path . '/views');
|
||||||
|
|
||||||
|
$this->provider->boot();
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user