mirror of
https://github.com/barryvdh/laravel-ide-helper.git
synced 2026-08-18 18:13:11 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
 Barry vd. Heuvel
|
692b223e94 | ||
|
Barry vd. Heuvel
|
f321828778 | ||
|
Barry vd. Heuvel
|
6eb797f5ff | ||
|
Barry vd. Heuvel
|
604d327277 | ||
|
Barry vd. Heuvel
|
6ed5367f6b | ||
|
Barry vd. Heuvel
|
8c339bd6b0 | ||
|
Barry vd. Heuvel
|
52b9b52926 | ||
|
Barry vd. Heuvel
|
f909c82fcc | ||
|
Barry vd. Heuvel
|
e88c3669b7 | ||
|
Barry vd. Heuvel
|
5bd7eeda23 | ||
|
Barry vd. Heuvel
|
dae0b55bef | ||
|
Barry vd. Heuvel
|
3f9831c5cf | ||
|
Barry vd. Heuvel
|
2cc277440a | ||
|
Barry vd. Heuvel
|
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
|
|
||||||
+1
-2
@@ -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
|
|
||||||
-27
@@ -1,27 +0,0 @@
|
|||||||
language: php
|
|
||||||
|
|
||||||
php:
|
|
||||||
- 7.0
|
|
||||||
- 7.1
|
|
||||||
- 7.2
|
|
||||||
|
|
||||||
# This triggers builds to run on the new TravisCI infrastructure.
|
|
||||||
# See: http://docs.travis-ci.com/user/workers/container-based-infrastructure/
|
|
||||||
sudo: false
|
|
||||||
|
|
||||||
## Cache composer
|
|
||||||
cache:
|
|
||||||
directories:
|
|
||||||
- $HOME/.composer/cache
|
|
||||||
|
|
||||||
matrix:
|
|
||||||
include:
|
|
||||||
- php: 7.0
|
|
||||||
env: 'COMPOSER_FLAGS="--prefer-stable --prefer-lowest"'
|
|
||||||
|
|
||||||
before_script:
|
|
||||||
- travis_wait 20 travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-dist
|
|
||||||
|
|
||||||
script:
|
|
||||||
- vendor/bin/phpcs --standard=psr2 src/
|
|
||||||
- vendor/bin/phpunit
|
|
||||||
-21
@@ -1,21 +0,0 @@
|
|||||||
# The MIT License (MIT)
|
|
||||||
|
|
||||||
Copyright (c) Barry vd. Heuvel <barryvdh@gmail.com>
|
|
||||||
|
|
||||||
> Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
||||||
> of this software and associated documentation files (the "Software"), to deal
|
|
||||||
> in the Software without restriction, including without limitation the rights
|
|
||||||
> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
> copies of the Software, and to permit persons to whom the Software is
|
|
||||||
> furnished to do so, subject to the following conditions:
|
|
||||||
>
|
|
||||||
> The above copyright notice and this permission notice shall be included in
|
|
||||||
> all copies or substantial portions of the Software.
|
|
||||||
>
|
|
||||||
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
||||||
> THE SOFTWARE.
|
|
||||||
+7
-28
@@ -10,20 +10,14 @@
|
|||||||
}
|
}
|
||||||
],
|
],
|
||||||
"require": {
|
"require": {
|
||||||
"php": ">=7",
|
"php": ">=5.3.0",
|
||||||
"illuminate/support": "^5.5,<5.8",
|
"illuminate/support": "4.x",
|
||||||
"illuminate/console": "^5.5,<5.8",
|
"illuminate/console": "4.x",
|
||||||
"illuminate/filesystem": "^5.5,<5.8",
|
"illuminate/filesystem": "4.x",
|
||||||
"barryvdh/reflection-docblock": "^2.0.6",
|
"phpdocumentor/reflection-docblock": "2.0.x",
|
||||||
"composer/composer": "^1.6"
|
"symfony/class-loader": "~2.3"
|
||||||
},
|
},
|
||||||
"require-dev": {
|
"require-dev": {
|
||||||
"illuminate/config": "^5.1,<5.8",
|
|
||||||
"illuminate/view": "^5.1,<5.8",
|
|
||||||
"phpro/grumphp": "^0.14",
|
|
||||||
"phpunit/phpunit" : "4.*",
|
|
||||||
"scrutinizer/ocular": "~1.1",
|
|
||||||
"squizlabs/php_codesniffer": "^3",
|
|
||||||
"doctrine/dbal": "~2.3"
|
"doctrine/dbal": "~2.3"
|
||||||
},
|
},
|
||||||
"suggest": {
|
"suggest": {
|
||||||
@@ -34,24 +28,9 @@
|
|||||||
"Barryvdh\\LaravelIdeHelper\\": "src"
|
"Barryvdh\\LaravelIdeHelper\\": "src"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"autoload-dev": {
|
|
||||||
"psr-4": {
|
|
||||||
"Barryvdh\\LaravelIdeHelper\\": "tests"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"scripts": {
|
|
||||||
"test": "phpunit",
|
|
||||||
"check-style": "phpcs -p --standard=PSR2 src/",
|
|
||||||
"fix-style": "phpcbf -p --standard=PSR2 src/"
|
|
||||||
},
|
|
||||||
"extra": {
|
"extra": {
|
||||||
"branch-alias": {
|
"branch-alias": {
|
||||||
"dev-master": "2.5-dev"
|
"dev-master": "1.11-dev"
|
||||||
},
|
|
||||||
"laravel": {
|
|
||||||
"providers": [
|
|
||||||
"Barryvdh\\LaravelIdeHelper\\IdeHelperServiceProvider"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,196 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
return array(
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Filename & Format
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| The default filename (without extension) and the format (php or json)
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
|
|
||||||
'filename' => '_ide_helper',
|
|
||||||
'format' => 'php',
|
|
||||||
|
|
||||||
'meta_filename' => '.phpstorm.meta.php',
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Fluent helpers
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| Set to true to generate commonly used Fluent methods
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
|
|
||||||
'include_fluent' => false,
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Write Model Magic methods
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| Set to false to disable write magic methods of model
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
|
|
||||||
'write_model_magic_where' => true,
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Write Eloquent Model Mixins
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| This will add the necessary DocBlock mixins to the model class
|
|
||||||
| contained in the Laravel Framework. This helps the IDE with
|
|
||||||
| auto-completion.
|
|
||||||
|
|
|
||||||
| Please be aware that this setting changes a file within the /vendor directory.
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
|
|
||||||
'write_eloquent_model_mixins' => 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 \Illuminate\Support\Carbon $created_at
|
|
||||||
| * @property \Illuminate\Support\Carbon $updated_at
|
|
||||||
|
|
|
||||||
| With this enabled, the properties will be this:
|
|
||||||
|
|
|
||||||
| * @property \Illuminate\Support\Carbon $createdAt
|
|
||||||
| * @property \Illuminate\Support\Carbon $updatedAt
|
|
||||||
|
|
|
||||||
| Note, it is currently an all-or-nothing option.
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
'model_camel_case_properties' => false,
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Property Casts
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| Cast the given "real type" to the given "type".
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
'type_overrides' => array(
|
|
||||||
'integer' => 'int',
|
|
||||||
'boolean' => 'bool',
|
|
||||||
),
|
|
||||||
);
|
|
||||||
-15
@@ -1,15 +0,0 @@
|
|||||||
parameters:
|
|
||||||
git_dir: .
|
|
||||||
bin_dir: vendor/bin
|
|
||||||
tasks:
|
|
||||||
phpunit:
|
|
||||||
config_file: ~
|
|
||||||
testsuite: ~
|
|
||||||
group: []
|
|
||||||
always_execute: false
|
|
||||||
phpcs:
|
|
||||||
standard: PSR2
|
|
||||||
warning_severity: ~
|
|
||||||
ignore_patterns:
|
|
||||||
- tests/
|
|
||||||
triggered_by: [php]
|
|
||||||
@@ -1,22 +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="Unit Tests">
|
|
||||||
<directory>tests</directory>
|
|
||||||
</testsuite>
|
|
||||||
</testsuites>
|
|
||||||
<filter>
|
|
||||||
<whitelist>
|
|
||||||
<directory suffix=".php">src/</directory>
|
|
||||||
</whitelist>
|
|
||||||
</filter>
|
|
||||||
</phpunit>
|
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
{
|
||||||
|
"providers": [
|
||||||
|
"Barryvdh\\LaravelIdeHelper\\IdeHelperServiceProvider"
|
||||||
|
]
|
||||||
|
}
|
||||||
@@ -1,262 +1,114 @@
|
|||||||
## 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 alway 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
|
Note: You do need CodeIntel for Sublime Text: https://github.com/SublimeCodeIntel/SublimeCodeIntel
|
||||||
* Generated version for Lumen: https://gist.github.com/barryvdh/be17164b0ad51f832f20
|
|
||||||
* Generated Phpstorm Meta file: https://gist.github.com/barryvdh/bb6ffc5d11e0a75dba67
|
|
||||||
|
|
||||||
Note: You do need CodeComplice for Sublime Text: https://github.com/spectacles/CodeComplice
|
### New: PhpStorm Meta for Container instances
|
||||||
|
|
||||||
### Install
|
It's possible to generate a PhpStorm meta file, to [add support for factory design pattern](https://confluence.jetbrains.com/display/PhpStorm/PhpStorm+Advanced+Metadata). For Laravel, this means we can make PhpStorm understand what kind of object we are resolving from the IoC Container. For example, `events` will return ann `Illuminate\Events\Dispatcher` object, so with the meta file you can call `app('events')` and it will autocomplete the Dispatcher methods.
|
||||||
|
|
||||||
Require this package with composer using the following command:
|
php artisan ide-helper:meta
|
||||||
|
|
||||||
|
app('events')->fire();
|
||||||
|
\App::make('events')->fire();
|
||||||
|
|
||||||
|
/** @var \Illuminate\Foundation\Application $app */
|
||||||
|
$app->make('events')->fire();
|
||||||
|
|
||||||
```bash
|
Pre-generated example: https://gist.github.com/barryvdh/bb6ffc5d11e0a75dba67
|
||||||
composer require barryvdh/laravel-ide-helper
|
|
||||||
```
|
|
||||||
|
|
||||||
After updating composer, add the service provider to the `providers` array in `config/app.php`
|
> Note: You might need to restart PhpStorm and make sure `.phpstorm.meta.php` is indexed.
|
||||||
|
|
||||||
```php
|
|
||||||
Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class,
|
|
||||||
```
|
|
||||||
**Laravel 5.5** uses Package Auto-Discovery, so doesn't require you to manually add the ServiceProvider.
|
|
||||||
|
|
||||||
To install this package on only development systems, add the `--dev` flag to your composer command:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
composer require --dev barryvdh/laravel-ide-helper
|
|
||||||
```
|
|
||||||
|
|
||||||
In Laravel, instead of adding the service provider in the `config/app.php` file, you can add the following code to your `app/Providers/AppServiceProvider.php` file, within the `register()` method:
|
|
||||||
|
|
||||||
```php
|
|
||||||
public function register()
|
|
||||||
{
|
|
||||||
if ($this->app->environment() !== 'production') {
|
|
||||||
$this->app->register(\Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class);
|
|
||||||
}
|
|
||||||
// ...
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
This will allow your application to load the Laravel IDE Helper on non-production enviroments.
|
|
||||||
|
|
||||||
### Automatic phpDoc generation for Laravel Facades
|
### Automatic phpDoc generation for Laravel Facades
|
||||||
|
|
||||||
You can now re-generate the docs yourself (for future updates)
|
Require this package with composer using the following command:
|
||||||
|
|
||||||
```bash
|
composer require barryvdh/laravel-ide-helper ~1.11
|
||||||
php artisan ide-helper:generate
|
|
||||||
```
|
|
||||||
|
|
||||||
Note: `bootstrap/compiled.php` has to be cleared first, so run `php artisan clear-compiled` before generating.
|
After updating composer, add the ServiceProvider to the providers array in app/config/app.php
|
||||||
|
|
||||||
|
'Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider',
|
||||||
|
|
||||||
|
You can now re-generate the docs yourself (for future updates) in artisan
|
||||||
|
|
||||||
|
php artisan ide-helper:generate
|
||||||
|
|
||||||
|
Note: bootstrap/compiled.php has to be cleared first, so run `php artisan clear-compiled` before generating (and `php artisan optimize` after..)
|
||||||
|
|
||||||
You can configure your composer.json to do this after each commit:
|
You can configure your composer.json to do this after each commit:
|
||||||
|
|
||||||
```js
|
"scripts":{
|
||||||
"scripts":{
|
"post-update-cmd":[
|
||||||
"post-update-cmd": [
|
"php artisan clear-compiled",
|
||||||
"Illuminate\\Foundation\\ComposerScripts::postUpdate",
|
"php artisan ide-helper:generate",
|
||||||
"php artisan ide-helper:generate",
|
"php artisan optimize"
|
||||||
"php artisan ide-helper:meta"
|
]
|
||||||
]
|
},
|
||||||
},
|
|
||||||
```
|
|
||||||
|
|
||||||
You can also publish the config file to change implementations (ie. interface to specific class) or set defaults for `--helpers` or `--sublime`.
|
You can also publish the config-file to change implementations (ie. interface to specific class) or set defaults for --helpers or --sublime.
|
||||||
|
|
||||||
```bash
|
php artisan config:publish barryvdh/laravel-ide-helper
|
||||||
php artisan vendor:publish --provider="Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider" --tag=config
|
|
||||||
```
|
|
||||||
|
|
||||||
The generator tries to identify the real class, but if it cannot be found, you can define it in the config file.
|
The generator tries to identify the real class, but if it cannot be found, you can define it in the config file.
|
||||||
|
|
||||||
Some classes need a working database connection. If you do not have a default working connection, some facades will not be included.
|
Some classes need a working database connection. If you do not have a 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
|
php artisan ide-helper:models Post
|
||||||
php artisan ide-helper:models Post
|
|
||||||
```
|
|
||||||
|
|
||||||
```php
|
/**
|
||||||
/**
|
* An Eloquent Model: 'Post'
|
||||||
* An Eloquent Model: 'Post'
|
*
|
||||||
*
|
* @property integer $id
|
||||||
* @property integer $id
|
* @property integer $author_id
|
||||||
* @property integer $author_id
|
* @property string $title
|
||||||
* @property string $title
|
* @property string $text
|
||||||
* @property string $text
|
* @property \Carbon\Carbon $created_at
|
||||||
* @property \Illuminate\Support\Carbon $created_at
|
* @property \Carbon\Carbon $updated_at
|
||||||
* @property \Illuminate\Support\Carbon $updated_at
|
* @property-read \User $author
|
||||||
* @property-read \User $author
|
* @property-read \Illuminate\Database\Eloquent\Collection|\Comment[] $comments
|
||||||
* @property-read \Illuminate\Database\Eloquent\Collection|\Comment[] $comments
|
*/
|
||||||
*/
|
|
||||||
```
|
|
||||||
|
|
||||||
By default, models in `app/models` are scanned. The optional argument tells what models to use (also outside app/models).
|
By default, models in app/models are scanned. The optional argument tells what models to use (also outside app/models).
|
||||||
|
|
||||||
```bash
|
php artisan ide-helper:models Post User
|
||||||
php artisan ide-helper:models Post User
|
|
||||||
```
|
|
||||||
|
|
||||||
You can also scan a different directory, using the `--dir` option (relative from the base path):
|
You can also scan a different directory, using the --dir option (relative from the base path):
|
||||||
|
|
||||||
```bash
|
php artisan ide-helper:models --dir="app/workbench/name/package/models" --dir="app/src/Model"
|
||||||
php artisan ide-helper:models --dir="path/to/models" --dir="app/src/Model"
|
|
||||||
```
|
You can publish the config file (`php artisan config:publish barryvdh/laravel-ide-helper`) and set the default directories.
|
||||||
|
|
||||||
You can publish the config file (`php artisan vendor:publish`) and set the default directories.
|
Models can be ignored using the --ignore (-I) option
|
||||||
|
|
||||||
Models can be ignored using the `--ignore (-I)` option
|
php artisan ide-helper:models --ignore="Post,User"
|
||||||
|
|
||||||
```bash
|
Note: With namespaces, wrap your model name in " signs: `php artisan ide-helper:models "API\User"`, or escape the slashes (`Api\\User`)
|
||||||
php artisan ide-helper:models --ignore="Post,User"
|
|
||||||
```
|
|
||||||
|
|
||||||
Note: With namespaces, wrap your model name in double-quotes (`"`): `php artisan ide-helper:models "API\User"`, or escape the slashes (`Api\\User`)
|
|
||||||
|
|
||||||
For properly recognition of `Model` methods (i.e. `paginate`, `findOrFail`) you should extend `\Eloquent` or add
|
|
||||||
```php
|
|
||||||
/** @mixin \Eloquent */
|
|
||||||
```
|
|
||||||
for your model class.
|
|
||||||
|
|
||||||
### Automatic phpDocs generation for Laravel Fluent methods
|
|
||||||
If you need phpDocs support for Fluent methods in migration, for example
|
|
||||||
```php
|
|
||||||
$table->string("somestring")->nullable()->index();
|
|
||||||
```
|
|
||||||
After publishing vendor, simply change the `include_fluent` line your `config/ide-helper.php` file into:
|
|
||||||
```php
|
|
||||||
'include_fluent' => true,
|
|
||||||
```
|
|
||||||
And then run `php artisan ide-helper:generate` , you will now see all of the Fluent methods are recognized by your IDE.
|
|
||||||
|
|
||||||
|
|
||||||
## PhpStorm Meta for Container instances
|
|
||||||
|
|
||||||
It's possible to generate a PhpStorm meta file to [add support for factory design pattern](https://confluence.jetbrains.com/display/PhpStorm/PhpStorm+Advanced+Metadata). For Laravel, this means we can make PhpStorm understand what kind of object we are resolving from the IoC Container. For example, `events` will return an `Illuminate\Events\Dispatcher` object, so with the meta file you can call `app('events')` and it will autocomplete the Dispatcher methods.
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
php artisan ide-helper:meta
|
|
||||||
```
|
|
||||||
|
|
||||||
```php
|
|
||||||
app('events')->fire();
|
|
||||||
\App::make('events')->fire();
|
|
||||||
|
|
||||||
/** @var \Illuminate\Foundation\Application $app */
|
|
||||||
$app->make('events')->fire();
|
|
||||||
|
|
||||||
// When the key is not found, it uses the argument as class name
|
|
||||||
app('App\SomeClass');
|
|
||||||
```
|
|
||||||
|
|
||||||
Pre-generated example: https://gist.github.com/barryvdh/bb6ffc5d11e0a75dba67
|
|
||||||
|
|
||||||
> Note: You might need to restart PhpStorm and make sure `.phpstorm.meta.php` is indexed.
|
|
||||||
> Note: When you receive a FatalException about a class that is not found, check your config (for example, remove S3 as cloud driver when you don't have S3 configured. Remove Redis ServiceProvider when you don't use it).
|
|
||||||
|
|
||||||
## Lumen Install
|
|
||||||
|
|
||||||
This package is focused on Laravel development, but it can also be used in Lumen with some workarounds. Because Lumen works a little different, as it is like a barebone version of Laravel and the main configuration parameters are instead located in `bootstrap/app.php`, some alterations must be made.
|
|
||||||
|
|
||||||
#### Enabling Facades
|
|
||||||
|
|
||||||
While Laravel IDE Helper can generate automatically default Facades for code hinting, Lumen doesn't come with Facades activated. If you plan in using them, you must enable them under the `Create The Application` section, uncommenting this line:
|
|
||||||
|
|
||||||
```php
|
|
||||||
// $app->withFacades();
|
|
||||||
```
|
|
||||||
|
|
||||||
From there, you should be able to use the `create_alias()` function to add additional Facades into your application.
|
|
||||||
|
|
||||||
#### Adding the Service Provider
|
|
||||||
|
|
||||||
You can install Laravel IDE Helper in `app/Providers/AppServiceProvider.php`, and uncommenting this line that registers the App Service Providers so it can properly load.
|
|
||||||
|
|
||||||
```php
|
|
||||||
// $app->register(App\Providers\AppServiceProvider::class);
|
|
||||||
```
|
|
||||||
|
|
||||||
If you are not using that line, that is usually handy to manage gracefully multiple Laravel/Lumen installations, you will have to add this line of code under the `Register Service Providers` section of your `bootstrap/app.php`.
|
|
||||||
|
|
||||||
```php
|
|
||||||
if ($app->environment() !== 'production') {
|
|
||||||
$app->register(\Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class);
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
After that, Laravel IDE Helper should work correctly. During the generation process, the script may throw exceptions saying that some Class(s) doesn't exist or there are some undefined indexes. This is normal, as Lumen has some default packages stripped away, like Cookies, Storage and Session. If you plan to add these packages, you will have to add them manually and create additional Facades if needed.
|
|
||||||
|
|
||||||
#### Adding Additional Facades
|
|
||||||
|
|
||||||
Currently Lumen IDE Helper doesn't take into account additional Facades created under `bootstrap/app.php` using `create_alias()`, so you need to create a `config/app.php` file and add your custom aliases under an `aliases` array again, like so:
|
|
||||||
|
|
||||||
```php
|
|
||||||
return [
|
|
||||||
'aliases' => [
|
|
||||||
'CustomAliasOne' => Example\Support\Facades\CustomAliasOne::class,
|
|
||||||
'CustomAliasTwo' => Example\Support\Facades\CustomAliasTwo::class,
|
|
||||||
//...
|
|
||||||
]
|
|
||||||
];
|
|
||||||
```
|
|
||||||
|
|
||||||
After you run ```php artisan ide-helper:generate```, it's recommended (but not mandatory) to rename `config/app.php` to something else until you have to re-generate the docs or after passing to production enviroment. Lumen 5.1+ will read this file for configuration parameters if it is present, and may overlap some configurations if it is completely populated.
|
|
||||||
|
|
||||||
### License
|
### 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,101 +0,0 @@
|
|||||||
<?= '<?php' ?>
|
|
||||||
<?php
|
|
||||||
/**
|
|
||||||
* @var \Barryvdh\LaravelIdeHelper\Alias[][] $namespaces_by_alias_ns
|
|
||||||
* @var \Barryvdh\LaravelIdeHelper\Alias[][] $namespaces_by_extends_ns
|
|
||||||
* @var bool $include_fluent
|
|
||||||
* @var string $helpers
|
|
||||||
*/
|
|
||||||
?>
|
|
||||||
|
|
||||||
// @formatter:off
|
|
||||||
|
|
||||||
/**
|
|
||||||
* A helper file for Laravel 5, to provide autocomplete information to your IDE
|
|
||||||
* Generated for Laravel <?= $version ?> on <?= date("Y-m-d H:i:s") ?>.
|
|
||||||
*
|
|
||||||
* This file should not be included in your code, only analyzed by your IDE!
|
|
||||||
*
|
|
||||||
* @author Barry vd. Heuvel <[email protected]>
|
|
||||||
* @see https://github.com/barryvdh/laravel-ide-helper
|
|
||||||
*/
|
|
||||||
|
|
||||||
<?php foreach($namespaces_by_extends_ns as $namespace => $aliases): ?>
|
|
||||||
<?php if ($namespace == '\Illuminate\Database\Eloquent'): continue; endif; ?>
|
|
||||||
namespace <?= $namespace == '__root' ? '' : trim($namespace, '\\') ?> {
|
|
||||||
<?php foreach($aliases as $alias): ?>
|
|
||||||
|
|
||||||
<?= trim($alias->getDocComment(' ')) ?>
|
|
||||||
<?= $alias->getClassType() ?> <?= $alias->getExtendsClass() ?> {
|
|
||||||
<?php foreach($alias->getMethods() as $method): ?>
|
|
||||||
|
|
||||||
<?= trim($method->getDocComment(' ')) ?>
|
|
||||||
public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>)
|
|
||||||
{<?php if($method->getDeclaringClass() !== $method->getRoot()): ?>
|
|
||||||
|
|
||||||
//Method inherited from <?= $method->getDeclaringClass() ?>
|
|
||||||
<?php endif; ?>
|
|
||||||
|
|
||||||
<?= $method->shouldReturn() ? 'return ': '' ?><?= $method->getRoot() ?>::<?= $method->getRealName() ?>(<?= $method->getParams() ?>);
|
|
||||||
}
|
|
||||||
<?php endforeach; ?>
|
|
||||||
}
|
|
||||||
<?php endforeach; ?>
|
|
||||||
}
|
|
||||||
|
|
||||||
<?php endforeach; ?>
|
|
||||||
|
|
||||||
<?php foreach($namespaces_by_alias_ns as $namespace => $aliases): ?>
|
|
||||||
namespace <?= $namespace == '__root' ? '' : trim($namespace, '\\') ?> {
|
|
||||||
<?php foreach($aliases as $alias): ?>
|
|
||||||
|
|
||||||
<?= $alias->getClassType() ?> <?= $alias->getShortName() ?> extends <?= $alias->getExtends() ?> {<?php if ($alias->getExtendsNamespace() == '\Illuminate\Database\Eloquent'): ?>
|
|
||||||
<?php foreach($alias->getMethods() as $method): ?>
|
|
||||||
<?= trim($method->getDocComment(' ')) ?>
|
|
||||||
public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>)
|
|
||||||
{<?php if($method->getDeclaringClass() !== $method->getRoot()): ?>
|
|
||||||
|
|
||||||
//Method inherited from <?= $method->getDeclaringClass() ?>
|
|
||||||
<?php endif; ?>
|
|
||||||
|
|
||||||
<?= $method->shouldReturn() ? 'return ': '' ?><?= $method->getRoot() ?>::<?= $method->getRealName() ?>(<?= $method->getParams() ?>);
|
|
||||||
}
|
|
||||||
<?php endforeach; ?>
|
|
||||||
<?php endif; ?>}
|
|
||||||
<?php endforeach; ?>
|
|
||||||
}
|
|
||||||
|
|
||||||
<?php endforeach; ?>
|
|
||||||
|
|
||||||
<?php if($helpers): ?>
|
|
||||||
namespace {
|
|
||||||
<?= $helpers ?>
|
|
||||||
}
|
|
||||||
<?php endif; ?>
|
|
||||||
|
|
||||||
<?php if($include_fluent): ?>
|
|
||||||
namespace Illuminate\Support {
|
|
||||||
/**
|
|
||||||
* Methods commonly used in migrations
|
|
||||||
*
|
|
||||||
* @method Fluent after(string $column) Add the after modifier
|
|
||||||
* @method Fluent charset(string $charset) Add the character set modifier
|
|
||||||
* @method Fluent collation(string $collation) Add the collation modifier
|
|
||||||
* @method Fluent comment(string $comment) Add comment
|
|
||||||
* @method Fluent default($value) Add the default modifier
|
|
||||||
* @method Fluent first() Select first row
|
|
||||||
* @method Fluent index(string $name = null) Add the in dex clause
|
|
||||||
* @method Fluent on(string $table) `on` of a foreign key
|
|
||||||
* @method Fluent onDelete(string $action) `on delete` of a foreign key
|
|
||||||
* @method Fluent onUpdate(string $action) `on update` of a foreign key
|
|
||||||
* @method Fluent primary() Add the primary key modifier
|
|
||||||
* @method Fluent references(string $column) `references` of a foreign key
|
|
||||||
* @method Fluent nullable(bool $value = true) Add the nullable modifier
|
|
||||||
* @method Fluent unique(string $name = null) Add unique index clause
|
|
||||||
* @method Fluent unsigned() Add the unsigned modifier
|
|
||||||
* @method Fluent useCurrent() Add the default timestamp value
|
|
||||||
* @method Fluent change() Add the change modifier
|
|
||||||
*/
|
|
||||||
class Fluent {}
|
|
||||||
}
|
|
||||||
<?php endif ?>
|
|
||||||
@@ -1,53 +0,0 @@
|
|||||||
<?= '<?php' ?>
|
|
||||||
|
|
||||||
// @formatter:off
|
|
||||||
|
|
||||||
namespace PHPSTORM_META {
|
|
||||||
|
|
||||||
/**
|
|
||||||
* PhpStorm Meta file, to provide autocomplete information for PhpStorm
|
|
||||||
* Generated on <?= date("Y-m-d H:i:s") ?>.
|
|
||||||
*
|
|
||||||
* @author Barry vd. Heuvel <[email protected]>
|
|
||||||
* @see https://github.com/barryvdh/laravel-ide-helper
|
|
||||||
*/
|
|
||||||
<?php foreach ($methods as $method): ?>
|
|
||||||
override(<?= $method ?>, map([
|
|
||||||
'' => '@',
|
|
||||||
<?php foreach($bindings as $abstract => $class): ?>
|
|
||||||
'<?= $abstract ?>' => \<?= $class ?>::class,
|
|
||||||
<?php endforeach; ?>
|
|
||||||
]));
|
|
||||||
<?php endforeach; ?>
|
|
||||||
|
|
||||||
override(\Illuminate\Support\Arr::add(0), type(0));
|
|
||||||
override(\Illuminate\Support\Arr::except(0), type(0));
|
|
||||||
override(\Illuminate\Support\Arr::first(0), elementType(0));
|
|
||||||
override(\Illuminate\Support\Arr::last(0), elementType(0));
|
|
||||||
override(\Illuminate\Support\Arr::get(0), elementType(0));
|
|
||||||
override(\Illuminate\Support\Arr::only(0), type(0));
|
|
||||||
override(\Illuminate\Support\Arr::prepend(0), type(0));
|
|
||||||
override(\Illuminate\Support\Arr::pull(0), elementType(0));
|
|
||||||
override(\Illuminate\Support\Arr::set(0), type(0));
|
|
||||||
override(\Illuminate\Support\Arr::shuffle(0), type(0));
|
|
||||||
override(\Illuminate\Support\Arr::sort(0), type(0));
|
|
||||||
override(\Illuminate\Support\Arr::sortRecursive(0), type(0));
|
|
||||||
override(\Illuminate\Support\Arr::where(0), type(0));
|
|
||||||
override(\array_add(0), type(0));
|
|
||||||
override(\array_except(0), type(0));
|
|
||||||
override(\array_first(0), elementType(0));
|
|
||||||
override(\array_last(0), elementType(0));
|
|
||||||
override(\array_get(0), elementType(0));
|
|
||||||
override(\array_only(0), type(0));
|
|
||||||
override(\array_prepend(0), type(0));
|
|
||||||
override(\array_pull(0), elementType(0));
|
|
||||||
override(\array_set(0), type(0));
|
|
||||||
override(\array_sort(0), type(0));
|
|
||||||
override(\array_sort_recursive(0), type(0));
|
|
||||||
override(\array_where(0), type(0));
|
|
||||||
override(\head(0), elementType(0));
|
|
||||||
override(\last(0), elementType(0));
|
|
||||||
override(\with(0), type(0));
|
|
||||||
override(\tap(0), type(0));
|
|
||||||
|
|
||||||
}
|
|
||||||
+284
-442
@@ -1,442 +1,284 @@
|
|||||||
<?php
|
<?php
|
||||||
/**
|
/**
|
||||||
* Laravel IDE Helper Generator
|
* Laravel IDE Helper Generator
|
||||||
*
|
*
|
||||||
* @author Barry vd. Heuvel <[email protected]>
|
* @author Barry vd. Heuvel <[email protected]>
|
||||||
* @copyright 2014 Barry vd. Heuvel / Fruitcake Studio (http://www.fruitcakestudio.nl)
|
* @copyright 2014 Barry vd. Heuvel / Fruitcake Studio (http://www.fruitcakestudio.nl)
|
||||||
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
||||||
* @link https://github.com/barryvdh/laravel-ide-helper
|
* @link https://github.com/barryvdh/laravel-ide-helper
|
||||||
*/
|
*/
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper;
|
namespace Barryvdh\LaravelIdeHelper;
|
||||||
|
|
||||||
use Barryvdh\Reflection\DocBlock;
|
class Alias
|
||||||
use Barryvdh\Reflection\DocBlock\Context;
|
{
|
||||||
use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
|
protected $alias;
|
||||||
use Barryvdh\Reflection\DocBlock\Tag\MethodTag;
|
protected $facade;
|
||||||
use ReflectionClass;
|
protected $extends = null;
|
||||||
|
protected $classType = 'class';
|
||||||
class Alias
|
protected $short;
|
||||||
{
|
protected $namespace = '__root';
|
||||||
protected $alias;
|
protected $root = null;
|
||||||
protected $facade;
|
protected $classes = array();
|
||||||
protected $extends = null;
|
protected $methods = array();
|
||||||
protected $extendsClass = null;
|
protected $usedMethods = array();
|
||||||
protected $extendsNamespace = null;
|
protected $valid = false;
|
||||||
protected $classType = 'class';
|
protected $magicMethods = array();
|
||||||
protected $short;
|
protected $interfaces = array();
|
||||||
protected $namespace = '__root';
|
|
||||||
protected $root = null;
|
/**
|
||||||
protected $classes = array();
|
* @param string $alias
|
||||||
protected $methods = array();
|
* @param string $facade
|
||||||
protected $usedMethods = array();
|
* @param array $magicMethods
|
||||||
protected $valid = false;
|
* @param array $interfaces
|
||||||
protected $magicMethods = array();
|
*/
|
||||||
protected $interfaces = array();
|
public function __construct($alias, $facade, $magicMethods = array(), $interfaces = array())
|
||||||
protected $phpdoc = null;
|
{
|
||||||
|
$this->alias = $alias;
|
||||||
/**
|
$this->magicMethods = $magicMethods;
|
||||||
* @param string $alias
|
$this->interfaces = $interfaces;
|
||||||
* @param string $facade
|
|
||||||
* @param array $magicMethods
|
// Make the class absolute
|
||||||
* @param array $interfaces
|
$facade = '\\' . ltrim($facade, '\\');
|
||||||
*/
|
$this->facade = $facade;
|
||||||
public function __construct($alias, $facade, $magicMethods = array(), $interfaces = array())
|
|
||||||
{
|
$this->detectRoot();
|
||||||
$this->alias = $alias;
|
|
||||||
$this->magicMethods = $magicMethods;
|
if ((!$this->isTrait() && $this->root)) {
|
||||||
$this->interfaces = $interfaces;
|
$this->valid = true;
|
||||||
|
} else {
|
||||||
// Make the class absolute
|
return;
|
||||||
$facade = '\\' . ltrim($facade, '\\');
|
}
|
||||||
$this->facade = $facade;
|
|
||||||
|
$this->addClass($this->root);
|
||||||
$this->detectRoot();
|
$this->detectNamespace();
|
||||||
|
$this->detectClassType();
|
||||||
if ((!$this->isTrait() && $this->root)) {
|
|
||||||
$this->valid = true;
|
if($facade === '\Illuminate\Database\Eloquent\Model'){
|
||||||
} else {
|
$this->usedMethods = array('decrement', 'increment');
|
||||||
return;
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
$this->addClass($this->root);
|
/**
|
||||||
$this->detectFake();
|
* Add one or more classes to analyze
|
||||||
$this->detectNamespace();
|
*
|
||||||
$this->detectClassType();
|
* @param array|string $classes
|
||||||
$this->detectExtendsNamespace();
|
*/
|
||||||
|
public function addClass($classes)
|
||||||
if (!empty($this->namespace)) {
|
{
|
||||||
//Create a DocBlock and serializer instance
|
$classes = (array)$classes;
|
||||||
$this->phpdoc = new DocBlock(new ReflectionClass($alias), new Context($this->namespace));
|
foreach ($classes as $class) {
|
||||||
}
|
if (class_exists($class) || interface_exists($class)) {
|
||||||
|
$this->classes[] = $class;
|
||||||
|
}else{
|
||||||
if ($facade === '\Illuminate\Database\Eloquent\Model') {
|
echo "Class not exists: $class\r\n";
|
||||||
$this->usedMethods = array('decrement', 'increment');
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Add one or more classes to analyze
|
* Check if this class is valid to process.
|
||||||
*
|
* @return bool
|
||||||
* @param array|string $classes
|
*/
|
||||||
*/
|
public function isValid()
|
||||||
public function addClass($classes)
|
{
|
||||||
{
|
return $this->valid;
|
||||||
$classes = (array)$classes;
|
}
|
||||||
foreach ($classes as $class) {
|
|
||||||
if (class_exists($class) || interface_exists($class)) {
|
/**
|
||||||
$this->classes[] = $class;
|
* Get the classtype, 'interface' or 'class'
|
||||||
} else {
|
*
|
||||||
echo "Class not exists: $class\r\n";
|
* @return string
|
||||||
}
|
*/
|
||||||
}
|
public function getClasstype()
|
||||||
}
|
{
|
||||||
|
return $this->classType;
|
||||||
/**
|
}
|
||||||
* Check if this class is valid to process.
|
|
||||||
* @return bool
|
/**
|
||||||
*/
|
* Get the class which this alias extends
|
||||||
public function isValid()
|
*
|
||||||
{
|
* @return null|string
|
||||||
return $this->valid;
|
*/
|
||||||
}
|
public function getExtends()
|
||||||
|
{
|
||||||
/**
|
return $this->extends;
|
||||||
* Get the classtype, 'interface' or 'class'
|
}
|
||||||
*
|
|
||||||
* @return string
|
/**
|
||||||
*/
|
* Get the Alias by which this class is called
|
||||||
public function getClasstype()
|
*
|
||||||
{
|
* @return string
|
||||||
return $this->classType;
|
*/
|
||||||
}
|
public function getAlias()
|
||||||
|
{
|
||||||
/**
|
return $this->alias;
|
||||||
* Get the class which this alias extends
|
}
|
||||||
*
|
|
||||||
* @return null|string
|
/**
|
||||||
*/
|
* Return the short name (without namespace)
|
||||||
public function getExtends()
|
*/
|
||||||
{
|
public function getShortName(){
|
||||||
return $this->extends;
|
return $this->short;
|
||||||
}
|
}
|
||||||
|
/**
|
||||||
/**
|
* Get the namespace from the alias
|
||||||
* Get the class short name which this alias extends
|
*
|
||||||
*
|
* @return string
|
||||||
* @return null|string
|
*/
|
||||||
*/
|
public function getNamespace()
|
||||||
public function getExtendsClass()
|
{
|
||||||
{
|
return $this->namespace;
|
||||||
return $this->extendsClass;
|
}
|
||||||
}
|
|
||||||
|
/**
|
||||||
/**
|
* Get the methods found by this Alias
|
||||||
* Get the namespace of the class which this alias extends
|
*
|
||||||
*
|
* @return array
|
||||||
* @return null|string
|
*/
|
||||||
*/
|
public function getMethods()
|
||||||
public function getExtendsNamespace()
|
{
|
||||||
{
|
$this->addMagicMethods();
|
||||||
return $this->extendsNamespace;
|
$this->detectMethods();
|
||||||
}
|
return $this->methods;
|
||||||
|
}
|
||||||
/**
|
|
||||||
* Get the Alias by which this class is called
|
/**
|
||||||
*
|
* Detect the namespace
|
||||||
* @return string
|
*/
|
||||||
*/
|
protected function detectNamespace()
|
||||||
public function getAlias()
|
{
|
||||||
{
|
if (strpos($this->alias, '\\')) {
|
||||||
return $this->alias;
|
$nsParts = explode('\\', $this->alias);
|
||||||
}
|
$this->short = array_pop($nsParts);
|
||||||
|
$this->namespace = implode('\\', $nsParts);
|
||||||
/**
|
}else{
|
||||||
* Return the short name (without namespace)
|
$this->short = $this->alias;
|
||||||
*/
|
}
|
||||||
public function getShortName()
|
}
|
||||||
{
|
|
||||||
return $this->short;
|
/**
|
||||||
}
|
* Detect the class type
|
||||||
/**
|
*/
|
||||||
* Get the namespace from the alias
|
protected function detectClassType()
|
||||||
*
|
{
|
||||||
* @return string
|
//Some classes extend the facade
|
||||||
*/
|
if (interface_exists($this->facade)) {
|
||||||
public function getNamespace()
|
$this->classType = 'interface';
|
||||||
{
|
$this->extends = $this->facade;
|
||||||
return $this->namespace;
|
} else {
|
||||||
}
|
$this->classType = 'class';
|
||||||
|
if (class_exists($this->facade)) {
|
||||||
/**
|
$this->extends = $this->facade;
|
||||||
* Get the methods found by this Alias
|
}
|
||||||
*
|
}
|
||||||
* @return array|Method[]
|
}
|
||||||
*/
|
|
||||||
public function getMethods()
|
/**
|
||||||
{
|
* Get the real root of a facade
|
||||||
if (count($this->methods) > 0) {
|
*
|
||||||
return $this->methods;
|
* @return bool|string
|
||||||
}
|
*/
|
||||||
|
protected function detectRoot()
|
||||||
$this->addMagicMethods();
|
{
|
||||||
$this->detectMethods();
|
$facade = $this->facade;
|
||||||
return $this->methods;
|
|
||||||
}
|
try {
|
||||||
|
//If possible, get the facade root
|
||||||
/**
|
if (method_exists($facade, 'getFacadeRoot')) {
|
||||||
* Detect class returned by ::fake()
|
$root = get_class($facade::getFacadeRoot());
|
||||||
*/
|
} else {
|
||||||
protected function detectFake()
|
$root = $facade;
|
||||||
{
|
}
|
||||||
$facade = $this->facade;
|
|
||||||
|
//If it doesn't exist, skip it
|
||||||
if (!method_exists($facade, 'fake')) {
|
if (!class_exists($root) && !interface_exists($root)) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
$real = $facade::getFacadeRoot();
|
$this->root = $root;
|
||||||
|
|
||||||
try {
|
//When the database connection is not set, some classes will be skipped
|
||||||
$facade::fake();
|
} catch (\PDOException $e) {
|
||||||
$fake = $facade::getFacadeRoot();
|
$this->error(
|
||||||
if ($fake !== $real) {
|
"PDOException: " . $e->getMessage() . "\nPlease configure your database connection correctly, or use the sqlite memory driver (-M). Skipping $facade."
|
||||||
$this->addClass(get_class($fake));
|
);
|
||||||
}
|
} catch (\Exception $e) {
|
||||||
} finally {
|
$this->error("Exception: " . $e->getMessage() . "\nSkipping $facade.");
|
||||||
$facade::swap($real);
|
}
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
/**
|
||||||
/**
|
* Detect if this class is a trait or not.
|
||||||
* Detect the namespace
|
*
|
||||||
*/
|
* @return bool
|
||||||
protected function detectNamespace()
|
*/
|
||||||
{
|
protected function isTrait()
|
||||||
if (strpos($this->alias, '\\')) {
|
{
|
||||||
$nsParts = explode('\\', $this->alias);
|
// Check if the facade is not a Trait
|
||||||
$this->short = array_pop($nsParts);
|
if (function_exists('trait_exists') && trait_exists($this->facade)) {
|
||||||
$this->namespace = implode('\\', $nsParts);
|
return true;
|
||||||
} else {
|
}
|
||||||
$this->short = $this->alias;
|
return false;
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
/**
|
||||||
/**
|
* Add magic methods, as defined in the configuration files
|
||||||
* Detect the extends namespace
|
*/
|
||||||
*/
|
protected function addMagicMethods()
|
||||||
protected function detectExtendsNamespace()
|
{
|
||||||
{
|
foreach($this->magicMethods as $magic => $real){
|
||||||
if (strpos($this->extends, '\\') !== false) {
|
list($className, $name) = explode('::', $real);
|
||||||
$nsParts = explode('\\', $this->extends);
|
if(!class_exists($className) && !interface_exists($className)){
|
||||||
$this->extendsClass = array_pop($nsParts);
|
continue;
|
||||||
$this->extendsNamespace = implode('\\', $nsParts);
|
}
|
||||||
}
|
$method = new \ReflectionMethod($className, $name);
|
||||||
}
|
$class = new \ReflectionClass($className);
|
||||||
|
|
||||||
/**
|
if(!in_array($method->name, $this->usedMethods)){
|
||||||
* Detect the class type
|
if($class !== $this->root){
|
||||||
*/
|
$this->methods[] = new Method($method, $this->alias, $class, $magic, $this->interfaces);
|
||||||
protected function detectClassType()
|
}
|
||||||
{
|
$this->usedMethods[] = $magic;
|
||||||
//Some classes extend the facade
|
}
|
||||||
if (interface_exists($this->facade)) {
|
}
|
||||||
$this->classType = 'interface';
|
}
|
||||||
$this->extends = $this->facade;
|
|
||||||
} else {
|
/**
|
||||||
$this->classType = 'class';
|
* Get the methods for one or multiple classes.
|
||||||
if (class_exists($this->facade)) {
|
*
|
||||||
$this->extends = $this->facade;
|
* @return string
|
||||||
}
|
*/
|
||||||
}
|
protected function detectMethods()
|
||||||
}
|
{
|
||||||
|
|
||||||
/**
|
foreach ($this->classes as $class) {
|
||||||
* Get the real root of a facade
|
$reflection = new \ReflectionClass($class);
|
||||||
*
|
|
||||||
* @return bool|string
|
$methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
|
||||||
*/
|
if ($methods) {
|
||||||
protected function detectRoot()
|
foreach ($methods as $method) {
|
||||||
{
|
if (!in_array($method->name, $this->usedMethods)) {
|
||||||
$facade = $this->facade;
|
// Only add the methods to the output when the root is not the same as the class.
|
||||||
|
// And don't add the __*() methods
|
||||||
try {
|
if ($this->extends !== $class && substr($method->name, 0, 2) !== '__') {
|
||||||
//If possible, get the facade root
|
$this->methods[] = new Method($method, $this->alias, $reflection, $method->name, $this->interfaces);
|
||||||
if (method_exists($facade, 'getFacadeRoot')) {
|
}
|
||||||
$root = get_class($facade::getFacadeRoot());
|
$this->usedMethods[] = $method->name;
|
||||||
} else {
|
}
|
||||||
$root = $facade;
|
}
|
||||||
}
|
}
|
||||||
|
}
|
||||||
//If it doesn't exist, skip it
|
}
|
||||||
if (!class_exists($root) && !interface_exists($root)) {
|
|
||||||
return;
|
/**
|
||||||
}
|
* Output an error.
|
||||||
|
*
|
||||||
$this->root = $root;
|
* @param string $string
|
||||||
|
* @return void
|
||||||
//When the database connection is not set, some classes will be skipped
|
*/
|
||||||
} catch (\PDOException $e) {
|
protected function error($string)
|
||||||
$this->error(
|
{
|
||||||
"PDOException: " . $e->getMessage() .
|
echo $string . "\r\n";
|
||||||
"\nPlease configure your database connection correctly, or use the sqlite memory driver (-M)." .
|
}
|
||||||
" Skipping $facade."
|
}
|
||||||
);
|
|
||||||
} catch (\Exception $e) {
|
|
||||||
$this->error("Exception: " . $e->getMessage() . "\nSkipping $facade.");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Detect if this class is a trait or not.
|
|
||||||
*
|
|
||||||
* @return bool
|
|
||||||
*/
|
|
||||||
protected function isTrait()
|
|
||||||
{
|
|
||||||
// Check if the facade is not a Trait
|
|
||||||
if (function_exists('trait_exists') && trait_exists($this->facade)) {
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Add magic methods, as defined in the configuration files
|
|
||||||
*/
|
|
||||||
protected function addMagicMethods()
|
|
||||||
{
|
|
||||||
foreach ($this->magicMethods as $magic => $real) {
|
|
||||||
list($className, $name) = explode('::', $real);
|
|
||||||
if (!class_exists($className) && !interface_exists($className)) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
$method = new \ReflectionMethod($className, $name);
|
|
||||||
$class = new \ReflectionClass($className);
|
|
||||||
|
|
||||||
if (!in_array($magic, $this->usedMethods)) {
|
|
||||||
if ($class !== $this->root) {
|
|
||||||
$this->methods[] = new Method($method, $this->alias, $class, $magic, $this->interfaces);
|
|
||||||
}
|
|
||||||
$this->usedMethods[] = $magic;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the methods for one or multiple classes.
|
|
||||||
*
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
protected function detectMethods()
|
|
||||||
{
|
|
||||||
|
|
||||||
foreach ($this->classes as $class) {
|
|
||||||
$reflection = new \ReflectionClass($class);
|
|
||||||
|
|
||||||
$methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
|
|
||||||
if ($methods) {
|
|
||||||
foreach ($methods as $method) {
|
|
||||||
if (!in_array($method->name, $this->usedMethods)) {
|
|
||||||
// Only add the methods to the output when the root is not the same as the class.
|
|
||||||
// And don't add the __*() methods
|
|
||||||
if ($this->extends !== $class && substr($method->name, 0, 2) !== '__') {
|
|
||||||
$this->methods[] = new Method(
|
|
||||||
$method,
|
|
||||||
$this->alias,
|
|
||||||
$reflection,
|
|
||||||
$method->name,
|
|
||||||
$this->interfaces
|
|
||||||
);
|
|
||||||
}
|
|
||||||
$this->usedMethods[] = $method->name;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Check if the class is macroable
|
|
||||||
$traits = collect($reflection->getTraitNames());
|
|
||||||
if ($traits->contains('Illuminate\Support\Traits\Macroable')) {
|
|
||||||
$properties = $reflection->getStaticProperties();
|
|
||||||
$macros = isset($properties['macros']) ? $properties['macros'] : [];
|
|
||||||
foreach ($macros as $macro_name => $macro_func) {
|
|
||||||
if (!in_array($macro_name, $this->usedMethods)) {
|
|
||||||
// Add macros
|
|
||||||
$this->methods[] = new Macro(
|
|
||||||
$this->getMacroFunction($macro_func),
|
|
||||||
$this->alias,
|
|
||||||
$reflection,
|
|
||||||
$macro_name,
|
|
||||||
$this->interfaces
|
|
||||||
);
|
|
||||||
$this->usedMethods[] = $macro_name;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param $macro_func
|
|
||||||
*
|
|
||||||
* @return \ReflectionFunctionAbstract
|
|
||||||
* @throws \ReflectionException
|
|
||||||
*/
|
|
||||||
protected function getMacroFunction($macro_func)
|
|
||||||
{
|
|
||||||
if (is_array($macro_func) && is_callable($macro_func)) {
|
|
||||||
return new \ReflectionMethod($macro_func[0], $macro_func[1]);
|
|
||||||
}
|
|
||||||
|
|
||||||
return new \ReflectionFunction($macro_func);
|
|
||||||
}
|
|
||||||
|
|
||||||
/*
|
|
||||||
* Get the docblock for this alias
|
|
||||||
*
|
|
||||||
* @param string $prefix
|
|
||||||
* @return mixed
|
|
||||||
*/
|
|
||||||
public function getDocComment($prefix = "\t\t")
|
|
||||||
{
|
|
||||||
$serializer = new DocBlockSerializer(1, $prefix);
|
|
||||||
|
|
||||||
if ($this->phpdoc) {
|
|
||||||
$this->removeDuplicateMethodsFromPhpDoc();
|
|
||||||
return $serializer->getDocComment($this->phpdoc);
|
|
||||||
}
|
|
||||||
|
|
||||||
return '';
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Removes method tags from the doc comment that already appear as functions inside the class.
|
|
||||||
* This prevents duplicate function errors in the IDE.
|
|
||||||
*
|
|
||||||
* @return void
|
|
||||||
*/
|
|
||||||
protected function removeDuplicateMethodsFromPhpDoc()
|
|
||||||
{
|
|
||||||
$methodNames = array_map(function (Method $method) {
|
|
||||||
return $method->getName();
|
|
||||||
}, $this->getMethods());
|
|
||||||
|
|
||||||
foreach ($this->phpdoc->getTags() as $tag) {
|
|
||||||
if ($tag instanceof MethodTag && in_array($tag->getMethodName(), $methodNames)) {
|
|
||||||
$this->phpdoc->deleteTag($tag);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Output an error.
|
|
||||||
*
|
|
||||||
* @param string $string
|
|
||||||
* @return void
|
|
||||||
*/
|
|
||||||
protected function error($string)
|
|
||||||
{
|
|
||||||
echo $string . "\r\n";
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -1,61 +0,0 @@
|
|||||||
<?php
|
|
||||||
/**
|
|
||||||
* Laravel IDE Helper Generator - Eloquent Model Mixin
|
|
||||||
*
|
|
||||||
* @author Charles A. Peterson <[email protected]>
|
|
||||||
* @copyright 2017 Charles A. Peterson / Fruitcake Studio (http://www.fruitcakestudio.nl)
|
|
||||||
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
|
||||||
* @link https://github.com/barryvdh/laravel-ide-helper
|
|
||||||
*/
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Console;
|
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Eloquent;
|
|
||||||
use Illuminate\Console\Command;
|
|
||||||
use Illuminate\Filesystem\Filesystem;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* A command to add \Eloquent mixin to Eloquent\Model
|
|
||||||
*
|
|
||||||
* @author Charles A. Peterson <[email protected]>
|
|
||||||
*/
|
|
||||||
class EloquentCommand extends Command
|
|
||||||
{
|
|
||||||
/**
|
|
||||||
* The console command name.
|
|
||||||
*
|
|
||||||
* @var string
|
|
||||||
*/
|
|
||||||
protected $name = 'ide-helper:eloquent';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @var Filesystem $files
|
|
||||||
*/
|
|
||||||
protected $files;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The console command description.
|
|
||||||
*
|
|
||||||
* @var string
|
|
||||||
*/
|
|
||||||
protected $description = 'Add \Eloquent helper to \Eloquent\Model';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param Filesystem $files
|
|
||||||
*/
|
|
||||||
public function __construct(Filesystem $files)
|
|
||||||
{
|
|
||||||
parent::__construct();
|
|
||||||
$this->files = $files;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Execute the console command.
|
|
||||||
*
|
|
||||||
* @return void
|
|
||||||
*/
|
|
||||||
public function handle()
|
|
||||||
{
|
|
||||||
Eloquent::writeEloquentModelHelper($this, $this->files);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -10,13 +10,14 @@
|
|||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Console;
|
namespace Barryvdh\LaravelIdeHelper\Console;
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Eloquent;
|
|
||||||
use Barryvdh\LaravelIdeHelper\Generator;
|
use Barryvdh\LaravelIdeHelper\Generator;
|
||||||
|
use Illuminate\Config\Repository as ConfigRepository;
|
||||||
use Illuminate\Console\Command;
|
use Illuminate\Console\Command;
|
||||||
use Illuminate\Filesystem\Filesystem;
|
use Illuminate\Filesystem\Filesystem;
|
||||||
use Symfony\Component\Console\Input\InputOption;
|
use Symfony\Component\Console\Input\InputOption;
|
||||||
use Symfony\Component\Console\Input\InputArgument;
|
use Symfony\Component\Console\Input\InputArgument;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A command to generate autocomplete information for your IDE
|
* A command to generate autocomplete information for your IDE
|
||||||
*
|
*
|
||||||
@@ -58,9 +59,8 @@ class GeneratorCommand extends Command
|
|||||||
* @param \Illuminate\View\Factory $view
|
* @param \Illuminate\View\Factory $view
|
||||||
*/
|
*/
|
||||||
public function __construct(
|
public function __construct(
|
||||||
/*ConfigRepository */ $config,
|
ConfigRepository $config,
|
||||||
Filesystem $files,
|
Filesystem $files, /* Illuminate\View\Factory */
|
||||||
/* Illuminate\View\Factory */
|
|
||||||
$view
|
$view
|
||||||
) {
|
) {
|
||||||
$this->config = $config;
|
$this->config = $config;
|
||||||
@@ -74,13 +74,11 @@ class GeneratorCommand extends Command
|
|||||||
*
|
*
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function handle()
|
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');
|
||||||
@@ -99,8 +97,8 @@ class GeneratorCommand extends Command
|
|||||||
|
|
||||||
|
|
||||||
$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));
|
||||||
}
|
}
|
||||||
@@ -115,10 +113,6 @@ class GeneratorCommand extends Command
|
|||||||
|
|
||||||
if ($written !== false) {
|
if ($written !== false) {
|
||||||
$this->info("A new helper file was written to $filename");
|
$this->info("A new helper file was written to $filename");
|
||||||
|
|
||||||
if ($this->option('write_mixins')) {
|
|
||||||
Eloquent::writeEloquentModelHelper($this, $this->files);
|
|
||||||
}
|
|
||||||
} else {
|
} else {
|
||||||
$this->error("The helper file could not be created at $filename");
|
$this->error("The helper file could not be created at $filename");
|
||||||
}
|
}
|
||||||
@@ -145,7 +139,7 @@ class GeneratorCommand extends Command
|
|||||||
*/
|
*/
|
||||||
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(
|
||||||
@@ -161,15 +155,14 @@ class GeneratorCommand extends Command
|
|||||||
*/
|
*/
|
||||||
protected function getOptions()
|
protected function getOptions()
|
||||||
{
|
{
|
||||||
$format = $this->config->get('ide-helper.format');
|
$format = $this->config->get('laravel-ide-helper::format');
|
||||||
$writeMixins = $this->config->get('ide-helper.write_eloquent_model_mixins');
|
|
||||||
|
|
||||||
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('write_mixins', "W", InputOption::VALUE_OPTIONAL, 'Write mixins to Laravel Model?', $writeMixins),
|
|
||||||
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'),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|||||||
+24
-70
@@ -12,15 +12,13 @@ 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]>
|
||||||
*/
|
*/
|
||||||
class MetaCommand extends Command
|
class MetaCommand extends Command {
|
||||||
{
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The console command name.
|
* The console command name.
|
||||||
@@ -28,6 +26,7 @@ class MetaCommand extends Command
|
|||||||
* @var string
|
* @var string
|
||||||
*/
|
*/
|
||||||
protected $name = 'ide-helper:meta';
|
protected $name = 'ide-helper:meta';
|
||||||
|
protected $filename = '.phpstorm.meta.php';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The console command description.
|
* The console command description.
|
||||||
@@ -36,36 +35,27 @@ class MetaCommand extends Command
|
|||||||
*/
|
*/
|
||||||
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;
|
||||||
|
|
||||||
/** @var \Illuminate\Contracts\Config */
|
protected $methods = array(
|
||||||
protected $config;
|
'\Illuminate\Foundation\Application::make',
|
||||||
|
'\Illuminate\Container\Container::make',
|
||||||
protected $methods = [
|
'\App::make',
|
||||||
'new \Illuminate\Contracts\Container\Container',
|
'app',
|
||||||
'\Illuminate\Contracts\Container\Container::make(0)',
|
);
|
||||||
'\Illuminate\Contracts\Container\Container::makeWith(0)',
|
|
||||||
'\App::make(0)',
|
|
||||||
'\App::makeWith(0)',
|
|
||||||
'\app(0)',
|
|
||||||
'\resolve(0)',
|
|
||||||
];
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
* @param \Illuminate\Contracts\Filesystem\Filesystem $files
|
* @param \Illuminate\Filesystem\Filesystem $files
|
||||||
* @param \Illuminate\Contracts\View\Factory $view
|
* @param \Illuminate\View\Factory $view
|
||||||
* @param \Illuminate\Contracts\Config $config
|
|
||||||
*/
|
*/
|
||||||
public function __construct($files, $view, $config)
|
public function __construct($files, $view) {
|
||||||
{
|
|
||||||
$this->files = $files;
|
$this->files = $files;
|
||||||
$this->view = $view;
|
$this->view = $view;
|
||||||
$this->config = $config;
|
|
||||||
parent::__construct();
|
parent::__construct();
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -74,35 +64,28 @@ class MetaCommand extends Command
|
|||||||
*
|
*
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function handle()
|
public function fire()
|
||||||
{
|
{
|
||||||
$this->registerClassAutoloadExceptions();
|
$filename = $this->option('filename');
|
||||||
|
|
||||||
$bindings = array();
|
$bindings = array();
|
||||||
foreach ($this->getAbstracts() as $abstract) {
|
|
||||||
// Validator and seeder cause problems
|
|
||||||
if (in_array($abstract, ['validator', 'seeder'])) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
foreach ($this->laravel->getBindings() as $abstract => $options) {
|
||||||
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());
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
$content = $this->view->make('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');
|
|
||||||
$written = $this->files->put($filename, $content);
|
$written = $this->files->put($filename, $content);
|
||||||
|
|
||||||
if ($written !== false) {
|
if ($written !== false) {
|
||||||
@@ -112,33 +95,6 @@ class MetaCommand extends Command
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Get a list of abstracts from the Laravel Application.
|
|
||||||
*
|
|
||||||
* @return array
|
|
||||||
*/
|
|
||||||
protected function getAbstracts()
|
|
||||||
{
|
|
||||||
$abstracts = $this->laravel->getBindings();
|
|
||||||
|
|
||||||
// Return the abstract names only
|
|
||||||
$keys = array_keys($abstracts);
|
|
||||||
|
|
||||||
sort($keys);
|
|
||||||
|
|
||||||
return $keys;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Register an autoloader the throws exceptions when a class is not found.
|
|
||||||
*/
|
|
||||||
protected function registerClassAutoloadExceptions()
|
|
||||||
{
|
|
||||||
spl_autoload_register(function ($class) {
|
|
||||||
throw new \Exception("Class '$class' not found.");
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the console command options.
|
* Get the console command options.
|
||||||
*
|
*
|
||||||
@@ -146,10 +102,8 @@ class MetaCommand extends Command
|
|||||||
*/
|
*/
|
||||||
protected function getOptions()
|
protected function getOptions()
|
||||||
{
|
{
|
||||||
$filename = $this->config->get('ide-helper.meta_filename');
|
|
||||||
|
|
||||||
return array(
|
return array(
|
||||||
array('filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the meta file', $filename),
|
array('filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the meta file', $this->filename),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+94
-377
@@ -10,19 +10,15 @@
|
|||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Console;
|
namespace Barryvdh\LaravelIdeHelper\Console;
|
||||||
|
|
||||||
use Composer\Autoload\ClassMapGenerator;
|
|
||||||
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 ReflectionClass;
|
|
||||||
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 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;
|
use phpDocumentor\Reflection\DocBlock\Serializer as DocBlockSerializer;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A command to generate autocomplete information for your IDE
|
* A command to generate autocomplete information for your IDE
|
||||||
@@ -31,10 +27,6 @@ use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
|
|||||||
*/
|
*/
|
||||||
class ModelsCommand extends Command
|
class ModelsCommand extends Command
|
||||||
{
|
{
|
||||||
/**
|
|
||||||
* @var Filesystem $files
|
|
||||||
*/
|
|
||||||
protected $files;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The console command name.
|
* The console command name.
|
||||||
@@ -51,52 +43,34 @@ class ModelsCommand extends Command
|
|||||||
*/
|
*/
|
||||||
protected $description = 'Generate autocompletion for models';
|
protected $description = 'Generate autocompletion for models';
|
||||||
|
|
||||||
protected $write_model_magic_where;
|
|
||||||
protected $properties = array();
|
protected $properties = array();
|
||||||
protected $methods = array();
|
protected $methods = array();
|
||||||
protected $write = false;
|
protected $write = false;
|
||||||
protected $dirs = array();
|
protected $dirs = array();
|
||||||
protected $reset;
|
protected $reset;
|
||||||
protected $keep_text;
|
|
||||||
/**
|
|
||||||
* @var bool[string]
|
|
||||||
*/
|
|
||||||
protected $nullableColumns = [];
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param Filesystem $files
|
|
||||||
*/
|
|
||||||
public function __construct(Filesystem $files)
|
|
||||||
{
|
|
||||||
parent::__construct();
|
|
||||||
$this->files = $files;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Execute the console command.
|
* Execute the console command.
|
||||||
*
|
*
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function handle()
|
public function fire()
|
||||||
{
|
{
|
||||||
$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');
|
||||||
$ignore = $this->option('ignore');
|
$ignore = $this->option('ignore');
|
||||||
$this->reset = $this->option('reset');
|
$this->reset = $this->option('reset');
|
||||||
if ($this->option('smart-reset')) {
|
|
||||||
$this->keep_text = $this->reset = true;
|
|
||||||
}
|
|
||||||
$this->write_model_magic_where = $this->laravel['config']->get('ide-helper.write_model_magic_where', true);
|
|
||||||
|
|
||||||
//If filename is default and Write is not specified, ask what to do
|
//If 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?"
|
"Do you want to overwrite the existing model files? Choose no to write to $filename instead? (Yes/No): "
|
||||||
)
|
)
|
||||||
) {
|
) {
|
||||||
$this->write = true;
|
$this->write = true;
|
||||||
@@ -106,7 +80,7 @@ class ModelsCommand extends Command
|
|||||||
$content = $this->generateDocs($model, $ignore);
|
$content = $this->generateDocs($model, $ignore);
|
||||||
|
|
||||||
if (!$this->write) {
|
if (!$this->write) {
|
||||||
$written = $this->files->put($filename, $content);
|
$written = \File::put($filename, $content);
|
||||||
if ($written !== false) {
|
if ($written !== false) {
|
||||||
$this->info("Model information was written to $filename");
|
$this->info("Model information was written to $filename");
|
||||||
} else {
|
} else {
|
||||||
@@ -124,7 +98,7 @@ class ModelsCommand extends Command
|
|||||||
protected function getArguments()
|
protected function getArguments()
|
||||||
{
|
{
|
||||||
return array(
|
return array(
|
||||||
array('model', InputArgument::OPTIONAL | InputArgument::IS_ARRAY, 'Which models to include', array()),
|
array('model', InputArgument::OPTIONAL | InputArgument::IS_ARRAY, 'Which models to include', array()),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -136,13 +110,12 @@ class ModelsCommand extends Command
|
|||||||
protected function getOptions()
|
protected function getOptions()
|
||||||
{
|
{
|
||||||
return array(
|
return array(
|
||||||
array('filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the helper file', $this->filename),
|
array('filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the helper file', $this->filename),
|
||||||
array('dir', 'D', InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY, 'The model dir', array()),
|
array('dir', 'D', InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY, 'The model dir', array()),
|
||||||
array('write', 'W', InputOption::VALUE_NONE, 'Write to Model file'),
|
array('write', 'W', InputOption::VALUE_NONE, 'Write to Model file'),
|
||||||
array('nowrite', 'N', InputOption::VALUE_NONE, 'Don\'t write to Model file'),
|
array('nowrite', 'N', InputOption::VALUE_NONE, 'Don\'t write to Model file'),
|
||||||
array('reset', 'R', InputOption::VALUE_NONE, 'Remove the original phpdocs instead of appending'),
|
array('reset', 'R', InputOption::VALUE_NONE, 'Remove the original phpdocs instead of appending'),
|
||||||
array('smart-reset', 'r', InputOption::VALUE_NONE, 'Refresh the properties/methods list, but keep the text'),
|
array('ignore', 'I', InputOption::VALUE_OPTIONAL, 'Which models to ignore', ''),
|
||||||
array('ignore', 'I', InputOption::VALUE_OPTIONAL, 'Which models to ignore', ''),
|
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -151,10 +124,8 @@ class ModelsCommand extends Command
|
|||||||
|
|
||||||
|
|
||||||
$output = "<?php
|
$output = "<?php
|
||||||
|
|
||||||
// @formatter:off
|
|
||||||
/**
|
/**
|
||||||
* 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.
|
||||||
*
|
*
|
||||||
@@ -177,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();
|
||||||
@@ -187,19 +156,16 @@ class ModelsCommand extends Command
|
|||||||
if (class_exists($name)) {
|
if (class_exists($name)) {
|
||||||
try {
|
try {
|
||||||
// handle abstract classes, interfaces, ...
|
// handle abstract classes, interfaces, ...
|
||||||
$reflectionClass = new ReflectionClass($name);
|
$reflectionClass = new \ReflectionClass($name);
|
||||||
|
|
||||||
if (!$reflectionClass->isSubclassOf('Illuminate\Database\Eloquent\Model')) {
|
if (!$reflectionClass->isSubclassOf('Illuminate\Database\Eloquent\Model')) {
|
||||||
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);
|
||||||
@@ -208,29 +174,23 @@ class ModelsCommand extends Command
|
|||||||
$this->getPropertiesFromTable($model);
|
$this->getPropertiesFromTable($model);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (method_exists($model, 'getCasts')) {
|
|
||||||
$this->castPropertiesType($model);
|
|
||||||
}
|
|
||||||
|
|
||||||
$this->getPropertiesFromMethods($model);
|
$this->getPropertiesFromMethods($model);
|
||||||
$this->getSoftDeleteMethods($model);
|
$output .= $this->createPhpDocs($name);
|
||||||
$output .= $this->createPhpDocs($name);
|
|
||||||
$ignore[] = $name;
|
|
||||||
$this->nullableColumns = [];
|
|
||||||
} 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;
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
@@ -248,77 +208,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 = '\Illuminate\Support\Carbon';
|
|
||||||
break;
|
|
||||||
case 'collection':
|
|
||||||
$realType = '\Illuminate\Support\Collection';
|
|
||||||
break;
|
|
||||||
default:
|
|
||||||
$realType = 'mixed';
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!isset($this->properties[$name])) {
|
|
||||||
continue;
|
|
||||||
} else {
|
|
||||||
$this->properties[$name]['type'] = $this->getTypeOverride($realType);
|
|
||||||
|
|
||||||
if (isset($this->nullableColumns[$name])) {
|
|
||||||
$this->properties[$name]['type'] .= '|null';
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the overide type for the give type.
|
|
||||||
*
|
|
||||||
* @param string $type
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
protected function getTypeOverride($type)
|
|
||||||
{
|
|
||||||
$typeOverrides = $this->laravel['config']->get('ide-helper.type_overrides', array());
|
|
||||||
|
|
||||||
return isset($typeOverrides[$type]) ? $typeOverrides[$type] : $type;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Load the properties from the database table.
|
* Load the properties from the database table.
|
||||||
*
|
*
|
||||||
@@ -328,27 +217,15 @@ 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) {
|
||||||
$name = $column->getName();
|
$name = $column->getName();
|
||||||
if (in_array($name, $model->getDates())) {
|
if (in_array($name, $model->getDates())) {
|
||||||
$type = '\Illuminate\Support\Carbon';
|
$type = '\Carbon\Carbon';
|
||||||
} else {
|
} else {
|
||||||
$type = $column->getType()->getName();
|
$type = $column->getType()->getName();
|
||||||
switch ($type) {
|
switch ($type) {
|
||||||
@@ -366,21 +243,13 @@ class ModelsCommand extends Command
|
|||||||
case 'smallint':
|
case 'smallint':
|
||||||
$type = 'integer';
|
$type = 'integer';
|
||||||
break;
|
break;
|
||||||
case 'boolean':
|
|
||||||
switch (config('database.default')) {
|
|
||||||
case 'sqlite':
|
|
||||||
case 'mysql':
|
|
||||||
$type = 'integer';
|
|
||||||
break;
|
|
||||||
default:
|
|
||||||
$type = 'boolean';
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
break;
|
|
||||||
case 'decimal':
|
case 'decimal':
|
||||||
case 'float':
|
case 'float':
|
||||||
$type = 'float';
|
$type = 'float';
|
||||||
break;
|
break;
|
||||||
|
case 'boolean':
|
||||||
|
$type = 'boolean';
|
||||||
|
break;
|
||||||
default:
|
default:
|
||||||
$type = 'mixed';
|
$type = 'mixed';
|
||||||
break;
|
break;
|
||||||
@@ -388,17 +257,12 @@ class ModelsCommand extends Command
|
|||||||
}
|
}
|
||||||
|
|
||||||
$comment = $column->getComment();
|
$comment = $column->getComment();
|
||||||
if (!$column->getNotnull()) {
|
$this->setProperty($name, $type, true, true, $comment);
|
||||||
$this->nullableColumns[$name] = true;
|
$this->setMethod(
|
||||||
}
|
Str::camel("where_" . $name),
|
||||||
$this->setProperty($name, $type, true, true, $comment, !$column->getNotnull());
|
'\Illuminate\Database\Query\Builder|\\' . get_class($model),
|
||||||
if ($this->write_model_magic_where) {
|
array('$value')
|
||||||
$this->setMethod(
|
);
|
||||||
Str::camel("where_" . $name),
|
|
||||||
'\Illuminate\Database\Eloquent\Builder|\\' . get_class($model),
|
|
||||||
array('$value')
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -410,24 +274,21 @@ class ModelsCommand extends Command
|
|||||||
{
|
{
|
||||||
$methods = get_class_methods($model);
|
$methods = get_class_methods($model);
|
||||||
if ($methods) {
|
if ($methods) {
|
||||||
sort($methods);
|
|
||||||
foreach ($methods as $method) {
|
foreach ($methods as $method) {
|
||||||
if (Str::startsWith($method, 'get') && Str::endsWith(
|
if (Str::startsWith($method, 'get') && Str::endsWith(
|
||||||
$method,
|
$method,
|
||||||
'Attribute'
|
'Attribute'
|
||||||
) && $method !== 'getAttribute'
|
) && $method !== 'getAttribute'
|
||||||
) {
|
) {
|
||||||
//Magic get<name>Attribute
|
//Magic get<name>Attribute
|
||||||
$name = Str::snake(substr($method, 3, -9));
|
$name = Str::snake(substr($method, 3, -9));
|
||||||
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,
|
$method,
|
||||||
'Attribute'
|
'Attribute'
|
||||||
) && $method !== 'setAttribute'
|
) && $method !== 'setAttribute'
|
||||||
) {
|
) {
|
||||||
//Magic set<name>Attribute
|
//Magic set<name>Attribute
|
||||||
$name = Str::snake(substr($method, 3, -9));
|
$name = Str::snake(substr($method, 3, -9));
|
||||||
@@ -442,14 +303,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\Eloquent\Builder|\\' . $reflection->class, $args);
|
$this->setMethod($name, '\\' . $reflection->class, $args);
|
||||||
}
|
}
|
||||||
} elseif (in_array($method, ['query', 'newQuery', 'newModelQuery'])) {
|
} elseif (!method_exists('Eloquent', $method) && !Str::startsWith($method, 'get')) {
|
||||||
$reflection = new \ReflectionClass($model);
|
|
||||||
$this->setMethod($method, '\Illuminate\Database\Eloquent\Builder|\\' . $reflection->getName());
|
|
||||||
} elseif (!method_exists('Illuminate\Database\Eloquent\Model', $method)
|
|
||||||
&& !Str::startsWith($method, 'get')
|
|
||||||
) {
|
|
||||||
//Use reflection to inspect the code, based on Illuminate/Support/SerializableClosure.php
|
//Use reflection to inspect the code, based on Illuminate/Support/SerializableClosure.php
|
||||||
$reflection = new \ReflectionMethod($model, $method);
|
$reflection = new \ReflectionMethod($model, $method);
|
||||||
|
|
||||||
@@ -461,106 +318,52 @@ class ModelsCommand extends Command
|
|||||||
$code .= $file->current();
|
$code .= $file->current();
|
||||||
$file->next();
|
$file->next();
|
||||||
}
|
}
|
||||||
$code = trim(preg_replace('/\s\s+/', '', $code));
|
|
||||||
$begin = strpos($code, 'function(');
|
$begin = strpos($code, 'function(');
|
||||||
$code = substr($code, $begin, strrpos($code, '}') - $begin + 1);
|
$code = substr($code, $begin, strrpos($code, '}') - $begin + 1);
|
||||||
|
|
||||||
foreach (array(
|
foreach (array(
|
||||||
'hasMany',
|
'hasMany',
|
||||||
'hasManyThrough',
|
'belongsToMany',
|
||||||
'belongsToMany',
|
'hasOne',
|
||||||
'hasOne',
|
'belongsTo',
|
||||||
'belongsTo',
|
'morphTo',
|
||||||
'morphOne',
|
'morphMany',
|
||||||
'morphTo',
|
'morphToMany'
|
||||||
'morphMany',
|
|
||||||
'morphToMany',
|
|
||||||
'morphedByMany'
|
|
||||||
) as $relation) {
|
) 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));
|
||||||
$methodReflection = new \ReflectionMethod($model, $method);
|
$arguments = explode(',', substr($code, 0, strpos($code, ');')));
|
||||||
if ($methodReflection->getNumberOfParameters()) {
|
//Remove quotes, ensure 1 \ in front of the model
|
||||||
continue;
|
$returnModel = $this->getClassName($arguments[0], $model);
|
||||||
}
|
if ($relation === "belongsToMany" or $relation === 'hasMany' or $relation === 'morphMany' or $relation === 'morphToMany') {
|
||||||
|
//Collection or array of models (because Collection is Arrayable)
|
||||||
$relationObj = $model->$method();
|
$this->setProperty(
|
||||||
|
$method,
|
||||||
if ($relationObj instanceof Relation) {
|
'\Illuminate\Database\Eloquent\Collection|' . $returnModel . '[]',
|
||||||
$relatedModel = '\\' . get_class($relationObj->getRelated());
|
true,
|
||||||
|
null
|
||||||
$relations = [
|
);
|
||||||
'hasManyThrough',
|
} else {
|
||||||
'belongsToMany',
|
//Single model is returned
|
||||||
'hasMany',
|
$this->setProperty($method, $returnModel, true, null);
|
||||||
'morphMany',
|
|
||||||
'morphToMany',
|
|
||||||
'morphedByMany',
|
|
||||||
];
|
|
||||||
if (in_array($relation, $relations)) {
|
|
||||||
//Collection or array of models (because Collection is Arrayable)
|
|
||||||
$this->setProperty(
|
|
||||||
$method,
|
|
||||||
$this->getCollectionClass($relatedModel) . '|' . $relatedModel . '[]',
|
|
||||||
true,
|
|
||||||
null
|
|
||||||
);
|
|
||||||
} elseif ($relation === "morphTo") {
|
|
||||||
// Model isn't specified because relation is polymorphic
|
|
||||||
$this->setProperty(
|
|
||||||
$method,
|
|
||||||
'\Illuminate\Database\Eloquent\Model|\Eloquent',
|
|
||||||
true,
|
|
||||||
null
|
|
||||||
);
|
|
||||||
} else {
|
|
||||||
//Single model is returned
|
|
||||||
$this->setProperty(
|
|
||||||
$method,
|
|
||||||
$relatedModel,
|
|
||||||
true,
|
|
||||||
null,
|
|
||||||
'',
|
|
||||||
$this->isRelationForeignKeyNullable($relationObj)
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Check if the foreign key of the relation is nullable
|
* @param string $name
|
||||||
*
|
|
||||||
* @param Relation $relation
|
|
||||||
*
|
|
||||||
* @return bool
|
|
||||||
*/
|
|
||||||
private function isRelationForeignKeyNullable(Relation $relation)
|
|
||||||
{
|
|
||||||
$reflectionObj = new \ReflectionObject($relation);
|
|
||||||
if (!$reflectionObj->hasProperty('foreignKey')) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
$fkProp = $reflectionObj->getProperty('foreignKey');
|
|
||||||
$fkProp->setAccessible(true);
|
|
||||||
|
|
||||||
return isset($this->nullableColumns[$fkProp->getValue($relation)]);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param string $name
|
|
||||||
* @param string|null $type
|
* @param string|null $type
|
||||||
* @param bool|null $read
|
* @param bool|null $read
|
||||||
* @param bool|null $write
|
* @param bool|null $write
|
||||||
* @param string|null $comment
|
* @param string|null $comment
|
||||||
* @param bool $nullable
|
|
||||||
*/
|
*/
|
||||||
protected function setProperty($name, $type = null, $read = null, $write = null, $comment = '', $nullable = false)
|
protected function setProperty($name, $type = null, $read = null, $write = null, $comment='')
|
||||||
{
|
{
|
||||||
if (!isset($this->properties[$name])) {
|
if (!isset($this->properties[$name])) {
|
||||||
$this->properties[$name] = array();
|
$this->properties[$name] = array();
|
||||||
@@ -570,11 +373,7 @@ class ModelsCommand extends Command
|
|||||||
$this->properties[$name]['comment'] = (string) $comment;
|
$this->properties[$name]['comment'] = (string) $comment;
|
||||||
}
|
}
|
||||||
if ($type !== null) {
|
if ($type !== null) {
|
||||||
$newType = $this->getTypeOverride($type);
|
$this->properties[$name]['type'] = $type;
|
||||||
if ($nullable) {
|
|
||||||
$newType .='|null';
|
|
||||||
}
|
|
||||||
$this->properties[$name]['type'] = $newType;
|
|
||||||
}
|
}
|
||||||
if ($read !== null) {
|
if ($read !== null) {
|
||||||
$this->properties[$name]['read'] = $read;
|
$this->properties[$name]['read'] = $read;
|
||||||
@@ -586,9 +385,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;
|
||||||
@@ -602,19 +399,13 @@ 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();
|
||||||
$keyword = $this->getClassKeyword($reflection);
|
|
||||||
|
|
||||||
if ($this->reset) {
|
if ($this->reset) {
|
||||||
$phpdoc = new DocBlock('', new Context($namespace));
|
$phpdoc = new DocBlock('', new Context($namespace));
|
||||||
if ($this->keep_text) {
|
|
||||||
$phpdoc->setText(
|
|
||||||
(new DocBlock($reflection, new Context($namespace)))->getText()
|
|
||||||
);
|
|
||||||
}
|
|
||||||
} else {
|
} else {
|
||||||
$phpdoc = new DocBlock($reflection, new Context($namespace));
|
$phpdoc = new DocBlock($reflection, new Context($namespace));
|
||||||
}
|
}
|
||||||
@@ -646,18 +437,10 @@ 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);
|
||||||
}
|
}
|
||||||
|
|
||||||
ksort($this->methods);
|
|
||||||
|
|
||||||
foreach ($this->methods as $name => $method) {
|
foreach ($this->methods as $name => $method) {
|
||||||
if (in_array($name, $methods)) {
|
if (in_array($name, $methods)) {
|
||||||
continue;
|
continue;
|
||||||
@@ -667,10 +450,6 @@ class ModelsCommand extends Command
|
|||||||
$phpdoc->appendTag($tag);
|
$phpdoc->appendTag($tag);
|
||||||
}
|
}
|
||||||
|
|
||||||
if ($this->write && ! $phpdoc->getTagsByName('mixin')) {
|
|
||||||
$phpdoc->appendTag(Tag::createInstance("@mixin \\Eloquent", $phpdoc));
|
|
||||||
}
|
|
||||||
|
|
||||||
$serializer = new DocBlockSerializer();
|
$serializer = new DocBlockSerializer();
|
||||||
$serializer->getDocComment($phpdoc);
|
$serializer->getDocComment($phpdoc);
|
||||||
$docComment = $serializer->getDocComment($phpdoc);
|
$docComment = $serializer->getDocComment($phpdoc);
|
||||||
@@ -678,7 +457,7 @@ class ModelsCommand extends Command
|
|||||||
|
|
||||||
if ($this->write) {
|
if ($this->write) {
|
||||||
$filename = $reflection->getFileName();
|
$filename = $reflection->getFileName();
|
||||||
$contents = $this->files->get($filename);
|
$contents = \File::get($filename);
|
||||||
if ($originalDoc) {
|
if ($originalDoc) {
|
||||||
$contents = str_replace($originalDoc, $docComment, $contents);
|
$contents = str_replace($originalDoc, $docComment, $contents);
|
||||||
} else {
|
} else {
|
||||||
@@ -689,12 +468,12 @@ class ModelsCommand extends Command
|
|||||||
$contents = substr_replace($contents, $replace, $pos, strlen($needle));
|
$contents = substr_replace($contents, $replace, $pos, strlen($needle));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if ($this->files->put($filename, $contents)) {
|
if (\File::put($filename, $contents)) {
|
||||||
$this->info('Written new phpDocBlock to ' . $filename);
|
$this->info('Written new phpDocBlock to ' . $filename);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
$output = "namespace {$namespace}{\n{$docComment}\n\t{$keyword}class {$classname} extends \Eloquent {}\n}\n\n";
|
$output = "namespace {$namespace}{\n{$docComment}\n\tclass {$classname} {}\n}\n\n";
|
||||||
return $output;
|
return $output;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -709,12 +488,10 @@ class ModelsCommand extends Command
|
|||||||
//Loop through the default values for paremeters, and make the correct output string
|
//Loop through the default values for paremeters, and make the correct output string
|
||||||
$params = array();
|
$params = array();
|
||||||
$paramsWithDefault = array();
|
$paramsWithDefault = array();
|
||||||
/** @var \ReflectionParameter $param */
|
|
||||||
foreach ($method->getParameters() as $param) {
|
foreach ($method->getParameters() as $param) {
|
||||||
$paramClass = $param->getClass();
|
$paramStr = '$' . $param->getName();
|
||||||
$paramStr = (!is_null($paramClass) ? '\\' . $paramClass->getName() . ' ' : '') . '$' . $param->getName();
|
|
||||||
$params[] = $paramStr;
|
$params[] = $paramStr;
|
||||||
if ($param->isOptional() && $param->isDefaultValueAvailable()) {
|
if ($param->isOptional()) {
|
||||||
$default = $param->getDefaultValue();
|
$default = $param->getDefaultValue();
|
||||||
if (is_bool($default)) {
|
if (is_bool($default)) {
|
||||||
$default = $default ? 'true' : 'false';
|
$default = $default ? 'true' : 'false';
|
||||||
@@ -735,83 +512,23 @@ class ModelsCommand extends Command
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Determine a model classes' collection type.
|
|
||||||
*
|
|
||||||
* @see http://laravel.com/docs/eloquent-collections#custom-collections
|
|
||||||
* @param string $className
|
* @param string $className
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
private function getCollectionClass($className)
|
|
||||||
{
|
|
||||||
// Return something in the very very unlikely scenario the model doesn't
|
|
||||||
// have a newCollection() method.
|
|
||||||
if (!method_exists($className, 'newCollection')) {
|
|
||||||
return '\Illuminate\Database\Eloquent\Collection';
|
|
||||||
}
|
|
||||||
|
|
||||||
/** @var \Illuminate\Database\Eloquent\Model $model */
|
|
||||||
$model = new $className;
|
|
||||||
return '\\' . get_class($model->newCollection());
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @return bool
|
|
||||||
*/
|
|
||||||
protected function hasCamelCaseModelProperties()
|
|
||||||
{
|
|
||||||
return $this->laravel['config']->get('ide-helper.model_camel_case_properties', false);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get method return type based on it DocBlock comment
|
|
||||||
*
|
|
||||||
* @param \ReflectionMethod $reflection
|
|
||||||
*
|
|
||||||
* @return null|string
|
|
||||||
*/
|
|
||||||
protected function getReturnTypeFromDocBlock(\ReflectionMethod $reflection)
|
|
||||||
{
|
|
||||||
$type = null;
|
|
||||||
$phpdoc = new DocBlock($reflection);
|
|
||||||
|
|
||||||
if ($phpdoc->hasTag('return')) {
|
|
||||||
$type = $phpdoc->getTagsByName('return')[0]->getType();
|
|
||||||
}
|
|
||||||
|
|
||||||
return $type;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Generates methods provided by the SoftDeletes trait
|
|
||||||
* @param \Illuminate\Database\Eloquent\Model $model
|
* @param \Illuminate\Database\Eloquent\Model $model
|
||||||
*/
|
|
||||||
protected function getSoftDeleteMethods($model)
|
|
||||||
{
|
|
||||||
$traits = class_uses(get_class($model), true);
|
|
||||||
if (in_array('Illuminate\\Database\\Eloquent\\SoftDeletes', $traits)) {
|
|
||||||
$this->setMethod('forceDelete', 'bool|null', []);
|
|
||||||
$this->setMethod('restore', 'bool|null', []);
|
|
||||||
|
|
||||||
$this->setMethod('withTrashed', '\Illuminate\Database\Query\Builder|\\' . get_class($model), []);
|
|
||||||
$this->setMethod('withoutTrashed', '\Illuminate\Database\Query\Builder|\\' . get_class($model), []);
|
|
||||||
$this->setMethod('onlyTrashed', '\Illuminate\Database\Query\Builder|\\' . get_class($model), []);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param ReflectionClass $reflection
|
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
private function getClassKeyword(ReflectionClass $reflection)
|
private function getClassName($className, $model)
|
||||||
{
|
{
|
||||||
if ($reflection->isFinal()) {
|
// If the class name was resolved via get_class($this) or static::class
|
||||||
$keyword = 'final ';
|
if (strpos($className, 'get_class($this)') !== false || strpos($className, 'static::class') !== false) {
|
||||||
} elseif ($reflection->isAbstract()) {
|
return get_class($model);
|
||||||
$keyword = 'abstract ';
|
|
||||||
} else {
|
|
||||||
$keyword = '';
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return $keyword;
|
// If the class name was resolved via ::class (PHP 5.5+)
|
||||||
|
if (strpos($className, '::class') !== false) {
|
||||||
|
$end = -1 * strlen('::class');
|
||||||
|
return substr($className, 0, $end);
|
||||||
|
}
|
||||||
|
|
||||||
|
return "\\" . ltrim(trim($className, " \"'"), "\\") ;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,108 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Laravel IDE Helper to add \Eloquent mixin to Eloquent\Model
|
|
||||||
*
|
|
||||||
* @author Charles A. Peterson <artistan@gmail.com>
|
|
||||||
*/
|
|
||||||
namespace Barryvdh\LaravelIdeHelper;
|
|
||||||
|
|
||||||
use Illuminate\Console\Command;
|
|
||||||
use Illuminate\Filesystem\Filesystem;
|
|
||||||
use Barryvdh\Reflection\DocBlock;
|
|
||||||
use Barryvdh\Reflection\DocBlock\Context;
|
|
||||||
use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
|
|
||||||
use Barryvdh\Reflection\DocBlock\Tag;
|
|
||||||
|
|
||||||
class Eloquent
|
|
||||||
{
|
|
||||||
/**
|
|
||||||
* Write mixin helper to the Eloquent\Model
|
|
||||||
* This is needed since laravel/framework v5.4.29
|
|
||||||
*
|
|
||||||
* @param Command $command
|
|
||||||
* @param Filesystem $files
|
|
||||||
*
|
|
||||||
* @return void
|
|
||||||
*/
|
|
||||||
public static function writeEloquentModelHelper(Command $command, Filesystem $files)
|
|
||||||
{
|
|
||||||
$class = 'Illuminate\Database\Eloquent\Model';
|
|
||||||
|
|
||||||
$reflection = new \ReflectionClass($class);
|
|
||||||
$namespace = $reflection->getNamespaceName();
|
|
||||||
$originalDoc = $reflection->getDocComment();
|
|
||||||
|
|
||||||
if (!$originalDoc) {
|
|
||||||
$command->info('Unexpected no document on ' . $class);
|
|
||||||
}
|
|
||||||
$phpdoc = new DocBlock($reflection, new Context($namespace));
|
|
||||||
|
|
||||||
$mixins = $phpdoc->getTagsByName('mixin');
|
|
||||||
$expectedMixins = [
|
|
||||||
'\Eloquent' => false,
|
|
||||||
'\Illuminate\Database\Eloquent\Builder' => false,
|
|
||||||
'\Illuminate\Database\Query\Builder' => false,
|
|
||||||
];
|
|
||||||
|
|
||||||
foreach ($mixins as $m) {
|
|
||||||
$mixin = $m->getContent();
|
|
||||||
|
|
||||||
if (isset($expectedMixins[$mixin])) {
|
|
||||||
$command->info('Tag Exists: @mixin ' . $mixin . ' in ' . $class);
|
|
||||||
|
|
||||||
$expectedMixins[$mixin] = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
$changed = false;
|
|
||||||
foreach ($expectedMixins as $expectedMixin => $present) {
|
|
||||||
if ($present === false) {
|
|
||||||
$phpdoc->appendTag(Tag::createInstance('@mixin ' . $expectedMixin, $phpdoc));
|
|
||||||
|
|
||||||
$changed = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// If nothing's changed, stop here.
|
|
||||||
if (!$changed) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
$serializer = new DocBlockSerializer();
|
|
||||||
$serializer->getDocComment($phpdoc);
|
|
||||||
$docComment = $serializer->getDocComment($phpdoc);
|
|
||||||
|
|
||||||
/*
|
|
||||||
The new DocBlock is appended to the beginning of the class declaration.
|
|
||||||
Since there is no DocBlock, the declaration is used as a guide.
|
|
||||||
*/
|
|
||||||
if (!$originalDoc) {
|
|
||||||
$originalDoc = 'abstract class Model implements';
|
|
||||||
|
|
||||||
$docComment .= "\nabstract class Model implements";
|
|
||||||
}
|
|
||||||
|
|
||||||
$filename = $reflection->getFileName();
|
|
||||||
if ($filename) {
|
|
||||||
$contents = $files->get($filename);
|
|
||||||
if ($contents) {
|
|
||||||
$count = 0;
|
|
||||||
$contents = str_replace($originalDoc, $docComment, $contents, $count);
|
|
||||||
if ($count > 0) {
|
|
||||||
if ($files->put($filename, $contents)) {
|
|
||||||
$command->info('Wrote expected docblock to ' . $filename);
|
|
||||||
} else {
|
|
||||||
$command->error('File write failed to ' . $filename);
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
$command->error('Content did not change ' . $contents);
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
$command->error('No file contents found ' . $filename);
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
$command->error('Filename not found ' . $class);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
+234
-327
@@ -1,328 +1,235 @@
|
|||||||
<?php
|
<?php
|
||||||
/**
|
/**
|
||||||
* Laravel IDE Helper Generator
|
* Laravel IDE Helper Generator
|
||||||
*
|
*
|
||||||
* @author Barry vd. Heuvel <barryvdh@gmail.com>
|
* @author Barry vd. Heuvel <barryvdh@gmail.com>
|
||||||
* @copyright 2014 Barry vd. Heuvel / Fruitcake Studio (http://www.fruitcakestudio.nl)
|
* @copyright 2014 Barry vd. Heuvel / Fruitcake Studio (http://www.fruitcakestudio.nl)
|
||||||
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
||||||
* @link https://github.com/barryvdh/laravel-ide-helper
|
* @link https://github.com/barryvdh/laravel-ide-helper
|
||||||
*/
|
*/
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper;
|
namespace Barryvdh\LaravelIdeHelper;
|
||||||
|
|
||||||
use Illuminate\Foundation\Application;
|
use Illuminate\Foundation\AliasLoader;
|
||||||
use Illuminate\Foundation\AliasLoader;
|
use Illuminate\Config\Repository as ConfigRepository;
|
||||||
use Illuminate\Support\Collection;
|
use Symfony\Component\Console\Output\OutputInterface;
|
||||||
use ReflectionClass;
|
|
||||||
use Symfony\Component\Console\Output\OutputInterface;
|
class Generator
|
||||||
|
{
|
||||||
class Generator
|
/** @var \Illuminate\Config\Repository */
|
||||||
{
|
protected $config;
|
||||||
/** @var \Illuminate\Config\Repository */
|
|
||||||
protected $config;
|
/** @var \Illuminate\View\Factory */
|
||||||
|
protected $view;
|
||||||
/** @var \Illuminate\View\Factory */
|
|
||||||
protected $view;
|
/** @var \Symfony\Component\Console\Output\OutputInterface */
|
||||||
|
protected $output;
|
||||||
/** @var \Symfony\Component\Console\Output\OutputInterface */
|
|
||||||
protected $output;
|
protected $extra = array();
|
||||||
|
protected $magic = array();
|
||||||
protected $extra = array();
|
protected $interfaces = array();
|
||||||
protected $magic = array();
|
protected $helpers;
|
||||||
protected $interfaces = array();
|
|
||||||
protected $helpers;
|
/**
|
||||||
|
* @param \Illuminate\Config\Repository $config
|
||||||
/**
|
* @param \Illuminate\View\Factory $view
|
||||||
* @param \Illuminate\Config\Repository $config
|
* @param \Symfony\Component\Console\Output\OutputInterface $output
|
||||||
* @param \Illuminate\View\Factory $view
|
* @param string $helpers
|
||||||
* @param \Symfony\Component\Console\Output\OutputInterface $output
|
*/
|
||||||
* @param string $helpers
|
public function __construct(ConfigRepository $config,
|
||||||
*/
|
/* Illuminate\View\Factory */ $view,
|
||||||
public function __construct(
|
OutputInterface $output = null,
|
||||||
/*ConfigRepository */ $config,
|
$helpers = ''
|
||||||
/* Illuminate\View\Factory */ $view,
|
) {
|
||||||
OutputInterface $output = null,
|
$this->config = $config;
|
||||||
$helpers = ''
|
$this->view = $view;
|
||||||
) {
|
|
||||||
$this->config = $config;
|
// Find the drivers to add to the extra/interfaces
|
||||||
$this->view = $view;
|
$this->detectDrivers();
|
||||||
|
|
||||||
// Find the drivers to add to the extra/interfaces
|
$this->extra = array_merge($this->extra, $this->config->get('laravel-ide-helper::extra'));
|
||||||
$this->detectDrivers();
|
$this->magic = array_merge($this->magic, $this->config->get('laravel-ide-helper::magic'));
|
||||||
|
$this->interfaces = array_merge($this->interfaces, $this->config->get('laravel-ide-helper::interfaces'));
|
||||||
$this->extra = array_merge($this->extra, $this->config->get('ide-helper.extra'));
|
// Make all interface classes absolute
|
||||||
$this->magic = array_merge($this->magic, $this->config->get('ide-helper.magic'));
|
foreach ($this->interfaces as &$interface) {
|
||||||
$this->interfaces = array_merge($this->interfaces, $this->config->get('ide-helper.interfaces'));
|
$interface = '\\' . ltrim($interface, '\\');
|
||||||
// Make all interface classes absolute
|
}
|
||||||
foreach ($this->interfaces as &$interface) {
|
$this->helpers = $helpers;
|
||||||
$interface = '\\' . ltrim($interface, '\\');
|
}
|
||||||
}
|
|
||||||
$this->helpers = $helpers;
|
/**
|
||||||
}
|
* Generate the helper file contents;
|
||||||
|
*
|
||||||
/**
|
* @param string $format The format to generate the helper in (php/json)
|
||||||
* Generate the helper file contents;
|
* @return string;
|
||||||
*
|
*/
|
||||||
* @param string $format The format to generate the helper in (php/json)
|
public function generate($format = 'php')
|
||||||
* @return string;
|
{
|
||||||
*/
|
// Check if the generator for this format exists
|
||||||
public function generate($format = 'php')
|
$method = 'generate'.ucfirst($format).'Helper';
|
||||||
{
|
if (method_exists($this, $method)) {
|
||||||
// Check if the generator for this format exists
|
return $this->$method();
|
||||||
$method = 'generate'.ucfirst($format).'Helper';
|
}
|
||||||
if (method_exists($this, $method)) {
|
|
||||||
return $this->$method();
|
return $this->generatePhpHelper();
|
||||||
}
|
}
|
||||||
|
|
||||||
return $this->generatePhpHelper();
|
public function generatePhpHelper()
|
||||||
}
|
{
|
||||||
|
$app = app();
|
||||||
public function generatePhpHelper()
|
return $this->view->make('laravel-ide-helper::ide-helper')
|
||||||
{
|
->with('namespaces', $this->getNamespaces())
|
||||||
$app = app();
|
->with('helpers', $this->helpers)
|
||||||
return $this->view->make('helper')
|
->with('version', $app::VERSION)
|
||||||
->with('namespaces_by_extends_ns', $this->getAliasesByExtendsNamespace())
|
->render();
|
||||||
->with('namespaces_by_alias_ns', $this->getAliasesByAliasNamespace())
|
}
|
||||||
->with('helpers', $this->helpers)
|
|
||||||
->with('version', $app->version())
|
public function generateJsonHelper()
|
||||||
->with('include_fluent', $this->config->get('ide-helper.include_fluent', true))
|
{
|
||||||
->render();
|
$classes = array();
|
||||||
}
|
foreach ($this->getNamespaces() as $aliases) {
|
||||||
|
foreach($aliases as $alias) {
|
||||||
public function generateJsonHelper()
|
$functions = array();
|
||||||
{
|
foreach ($alias->getMethods() as $method) {
|
||||||
$classes = array();
|
$functions[$method->getName()] = '('. $method->getParamsWithDefault().')';
|
||||||
foreach ($this->getValidAliases() as $aliases) {
|
}
|
||||||
foreach ($aliases as $alias) {
|
$classes[$alias->getAlias()] = array(
|
||||||
$functions = array();
|
'functions' => $functions,
|
||||||
foreach ($alias->getMethods() as $method) {
|
);
|
||||||
$functions[$method->getName()] = '('. $method->getParamsWithDefault().')';
|
}
|
||||||
}
|
}
|
||||||
$classes[$alias->getAlias()] = array(
|
|
||||||
'functions' => $functions,
|
$flags = JSON_FORCE_OBJECT;
|
||||||
);
|
if (defined('JSON_PRETTY_PRINT')) {
|
||||||
}
|
$flags |= JSON_PRETTY_PRINT;
|
||||||
}
|
}
|
||||||
|
|
||||||
$flags = JSON_FORCE_OBJECT;
|
return json_encode(array(
|
||||||
if (defined('JSON_PRETTY_PRINT')) {
|
'php' => array(
|
||||||
$flags |= JSON_PRETTY_PRINT;
|
'classes' => $classes,
|
||||||
}
|
),
|
||||||
|
), $flags);
|
||||||
return json_encode(array(
|
}
|
||||||
'php' => array(
|
|
||||||
'classes' => $classes,
|
protected function detectDrivers()
|
||||||
),
|
{
|
||||||
), $flags);
|
try{
|
||||||
}
|
|
||||||
|
|
||||||
protected function detectDrivers()
|
|
||||||
{
|
|
||||||
$defaultUserModel = config('auth.providers.users.model', config('auth.model', 'App\User'));
|
|
||||||
$this->interfaces['\Illuminate\Contracts\Auth\Authenticatable'] = $defaultUserModel;
|
|
||||||
|
|
||||||
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')) {
|
$class = get_class(\Auth::driver());
|
||||||
$authMethod = version_compare(Application::VERSION, '5.2', '>=') ? 'guard' : 'driver';
|
$this->extra['Auth'] = array($class);
|
||||||
} else {
|
$this->interfaces['\Illuminate\Auth\UserProviderInterface'] = $class;
|
||||||
$refClass = new ReflectionClass('\Laravel\Lumen\Application');
|
}
|
||||||
$versionStr = $refClass->newInstanceWithoutConstructor()->version();
|
}catch (\Exception $e) {}
|
||||||
$authMethod = strpos($versionStr, 'Lumen (5.0') === 0 ?
|
|
||||||
'driver' :
|
try{
|
||||||
(strpos($versionStr, 'Lumen (5.1') === 0 ? 'driver' : 'guard');
|
if (class_exists('DB') && is_a('DB', '\Illuminate\Support\Facades\DB', true)) {
|
||||||
}
|
$class = get_class(\DB::connection());
|
||||||
$class = get_class(\Auth::$authMethod());
|
$this->extra['DB'] = array($class);
|
||||||
$this->extra['Auth'] = array($class);
|
$this->interfaces['\Illuminate\Database\ConnectionInterface'] = $class;
|
||||||
$this->interfaces['\Illuminate\Auth\UserProviderInterface'] = $class;
|
}
|
||||||
}
|
}catch (\Exception $e) {}
|
||||||
} catch (\Exception $e) {
|
|
||||||
}
|
try{
|
||||||
|
if (class_exists('Cache') && is_a('Cache', '\Illuminate\Support\Facades\Cache', true)) {
|
||||||
try {
|
$driver = get_class(\Cache::driver());
|
||||||
if (class_exists('DB') && is_a('DB', '\Illuminate\Support\Facades\DB', true)) {
|
$store = get_class(\Cache::getStore());
|
||||||
$class = get_class(\DB::connection());
|
$this->extra['Cache'] = array($driver, $store);
|
||||||
$this->extra['DB'] = array($class);
|
$this->interfaces['\Illuminate\Cache\StoreInterface'] = $store;
|
||||||
$this->interfaces['\Illuminate\Database\ConnectionInterface'] = $class;
|
}
|
||||||
}
|
}catch (\Exception $e) {}
|
||||||
} catch (\Exception $e) {
|
|
||||||
}
|
try{
|
||||||
|
if (class_exists('Queue') && is_a('Queue', '\Illuminate\Support\Facades\Queue', true)) {
|
||||||
try {
|
$class = get_class(\Queue::connection());
|
||||||
if (class_exists('Cache') && is_a('Cache', '\Illuminate\Support\Facades\Cache', true)) {
|
$this->extra['Queue'] = array($class);
|
||||||
$driver = get_class(\Cache::driver());
|
$this->interfaces['\Illuminate\Queue\QueueInterface'] = $class;
|
||||||
$store = get_class(\Cache::getStore());
|
}
|
||||||
$this->extra['Cache'] = array($driver, $store);
|
}catch (\Exception $e) {}
|
||||||
$this->interfaces['\Illuminate\Cache\StoreInterface'] = $store;
|
|
||||||
}
|
try{
|
||||||
} catch (\Exception $e) {
|
if (class_exists('SSH') && is_a('SSH', '\Illuminate\Support\Facades\SSH', true)){
|
||||||
}
|
$class = get_class(\SSH::connection());
|
||||||
|
$this->extra['SSH'] = array($class);
|
||||||
try {
|
$this->interfaces['\Illuminate\Remote\ConnectionInterface'] = $class;
|
||||||
if (class_exists('Queue') && is_a('Queue', '\Illuminate\Support\Facades\Queue', true)) {
|
}
|
||||||
$class = get_class(\Queue::connection());
|
}catch (\Exception $e) {}
|
||||||
$this->extra['Queue'] = array($class);
|
|
||||||
$this->interfaces['\Illuminate\Queue\QueueInterface'] = $class;
|
}
|
||||||
}
|
|
||||||
} catch (\Exception $e) {
|
/**
|
||||||
}
|
* Find all namespaces/aliases that are valid for us to render
|
||||||
|
*
|
||||||
try {
|
* @return array
|
||||||
if (class_exists('SSH') && is_a('SSH', '\Illuminate\Support\Facades\SSH', true)) {
|
*/
|
||||||
$class = get_class(\SSH::connection());
|
protected function getNamespaces()
|
||||||
$this->extra['SSH'] = array($class);
|
{
|
||||||
$this->interfaces['\Illuminate\Remote\ConnectionInterface'] = $class;
|
$namespaces = array();
|
||||||
}
|
|
||||||
} catch (\Exception $e) {
|
// Get all aliases
|
||||||
}
|
foreach (AliasLoader::getInstance()->getAliases() as $name => $facade) {
|
||||||
|
$magicMethods = array_key_exists($name, $this->magic) ? $this->magic[$name] : array();
|
||||||
try {
|
$alias = new Alias($name, $facade, $magicMethods, $this->interfaces);
|
||||||
if (class_exists('Storage') && is_a('Storage', '\Illuminate\Support\Facades\Storage', true)) {
|
if ($alias->isValid()) {
|
||||||
$class = get_class(\Storage::disk());
|
|
||||||
$this->extra['Storage'] = array($class);
|
//Add extra methods, from other classes (magic static calls)
|
||||||
$this->interfaces['\Illuminate\Contracts\Filesystem\Filesystem'] = $class;
|
if (array_key_exists($name, $this->extra)) {
|
||||||
}
|
$alias->addClass($this->extra[$name]);
|
||||||
} catch (\Exception $e) {
|
}
|
||||||
}
|
|
||||||
}
|
$namespace = $alias->getNamespace();
|
||||||
|
if (!isset($namespaces[$namespace])) {
|
||||||
/**
|
$namespaces[$namespace] = array();
|
||||||
* Find all aliases that are valid for us to render
|
}
|
||||||
*
|
$namespaces[$namespace][] = $alias;
|
||||||
* @return Collection
|
}
|
||||||
*/
|
|
||||||
protected function getValidAliases()
|
}
|
||||||
{
|
|
||||||
$aliases = new Collection();
|
return $namespaces;
|
||||||
|
}
|
||||||
// Get all aliases
|
|
||||||
foreach ($this->getAliases() as $name => $facade) {
|
/**
|
||||||
// Skip the Redis facade, if not available (otherwise Fatal PHP Error)
|
* Get the driver/connection/store from the managers
|
||||||
if ($facade == 'Illuminate\Support\Facades\Redis' && $name == 'Redis' && !class_exists('Predis\Client')) {
|
*
|
||||||
continue;
|
* @param $alias
|
||||||
}
|
* @return array|bool|string
|
||||||
|
*/
|
||||||
$magicMethods = array_key_exists($name, $this->magic) ? $this->magic[$name] : array();
|
public function getDriver($alias)
|
||||||
$alias = new Alias($name, $facade, $magicMethods, $this->interfaces);
|
{
|
||||||
if ($alias->isValid()) {
|
try {
|
||||||
//Add extra methods, from other classes (magic static calls)
|
if ($alias == "Auth") {
|
||||||
if (array_key_exists($name, $this->extra)) {
|
$driver = \Auth::driver();
|
||||||
$alias->addClass($this->extra[$name]);
|
} elseif ($alias == "DB") {
|
||||||
}
|
$driver = \DB::connection();
|
||||||
|
} elseif ($alias == "Cache") {
|
||||||
$aliases[] = $alias;
|
$driver = get_class(\Cache::driver());
|
||||||
}
|
$store = get_class(\Cache::getStore());
|
||||||
}
|
return array($driver, $store);
|
||||||
|
} elseif ($alias == "Queue") {
|
||||||
return $aliases;
|
$driver = \Queue::connection();
|
||||||
}
|
} else {
|
||||||
|
return false;
|
||||||
/**
|
}
|
||||||
* Regroup aliases by namespace of extended classes
|
|
||||||
*
|
return get_class($driver);
|
||||||
* @return Collection
|
} catch (\Exception $e) {
|
||||||
*/
|
$this->error("Could not determine driver/connection for $alias.");
|
||||||
protected function getAliasesByExtendsNamespace()
|
return false;
|
||||||
{
|
}
|
||||||
return $this->getValidAliases()->groupBy(function (Alias $alias) {
|
}
|
||||||
return $alias->getExtendsNamespace();
|
|
||||||
});
|
/**
|
||||||
}
|
* Write a string as error output.
|
||||||
|
*
|
||||||
/**
|
* @param string $string
|
||||||
* Regroup aliases by namespace of alias
|
* @return void
|
||||||
*
|
*/
|
||||||
* @return Collection
|
protected function error($string)
|
||||||
*/
|
{
|
||||||
protected function getAliasesByAliasNamespace()
|
if($this->output){
|
||||||
{
|
$this->output->writeln("<error>$string</error>");
|
||||||
return $this->getValidAliases()->groupBy(function (Alias $alias) {
|
}else{
|
||||||
return $alias->getNamespace();
|
echo $string . "\r\n";
|
||||||
});
|
}
|
||||||
}
|
}
|
||||||
|
}
|
||||||
protected function getAliases()
|
|
||||||
{
|
|
||||||
// For Laravel, use the AliasLoader
|
|
||||||
if (class_exists('Illuminate\Foundation\AliasLoader')) {
|
|
||||||
return AliasLoader::getInstance()->getAliases();
|
|
||||||
}
|
|
||||||
|
|
||||||
$facades = [
|
|
||||||
'App' => 'Illuminate\Support\Facades\App',
|
|
||||||
'Auth' => 'Illuminate\Support\Facades\Auth',
|
|
||||||
'Bus' => 'Illuminate\Support\Facades\Bus',
|
|
||||||
'DB' => 'Illuminate\Support\Facades\DB',
|
|
||||||
'Cache' => 'Illuminate\Support\Facades\Cache',
|
|
||||||
'Cookie' => 'Illuminate\Support\Facades\Cookie',
|
|
||||||
'Crypt' => 'Illuminate\Support\Facades\Crypt',
|
|
||||||
'Event' => 'Illuminate\Support\Facades\Event',
|
|
||||||
'Hash' => 'Illuminate\Support\Facades\Hash',
|
|
||||||
'Log' => 'Illuminate\Support\Facades\Log',
|
|
||||||
'Mail' => 'Illuminate\Support\Facades\Mail',
|
|
||||||
'Queue' => 'Illuminate\Support\Facades\Queue',
|
|
||||||
'Request' => 'Illuminate\Support\Facades\Request',
|
|
||||||
'Schema' => 'Illuminate\Support\Facades\Schema',
|
|
||||||
'Session' => 'Illuminate\Support\Facades\Session',
|
|
||||||
'Storage' => 'Illuminate\Support\Facades\Storage',
|
|
||||||
'Validator' => 'Illuminate\Support\Facades\Validator',
|
|
||||||
'Gate' => 'Illuminate\Support\Facades\Gate',
|
|
||||||
];
|
|
||||||
|
|
||||||
$facades = array_merge($facades, $this->config->get('app.aliases', []));
|
|
||||||
|
|
||||||
// Only return the ones that actually exist
|
|
||||||
return array_filter(
|
|
||||||
$facades,
|
|
||||||
function ($alias) {
|
|
||||||
return class_exists($alias);
|
|
||||||
},
|
|
||||||
ARRAY_FILTER_USE_KEY
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the driver/connection/store from the managers
|
|
||||||
*
|
|
||||||
* @param $alias
|
|
||||||
* @return array|bool|string
|
|
||||||
*/
|
|
||||||
public function getDriver($alias)
|
|
||||||
{
|
|
||||||
try {
|
|
||||||
if ($alias == "Auth") {
|
|
||||||
$driver = \Auth::driver();
|
|
||||||
} elseif ($alias == "DB") {
|
|
||||||
$driver = \DB::connection();
|
|
||||||
} elseif ($alias == "Cache") {
|
|
||||||
$driver = get_class(\Cache::driver());
|
|
||||||
$store = get_class(\Cache::getStore());
|
|
||||||
return array($driver, $store);
|
|
||||||
} elseif ($alias == "Queue") {
|
|
||||||
$driver = \Queue::connection();
|
|
||||||
} else {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
return get_class($driver);
|
|
||||||
} catch (\Exception $e) {
|
|
||||||
$this->error("Could not determine driver/connection for $alias.");
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Write a string as error output.
|
|
||||||
*
|
|
||||||
* @param string $string
|
|
||||||
* @return void
|
|
||||||
*/
|
|
||||||
protected function error($string)
|
|
||||||
{
|
|
||||||
if ($this->output) {
|
|
||||||
$this->output->writeln("<error>$string</error>");
|
|
||||||
} else {
|
|
||||||
echo $string . "\r\n";
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -10,15 +10,10 @@
|
|||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper;
|
namespace Barryvdh\LaravelIdeHelper;
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Console\EloquentCommand;
|
use Illuminate\Support\ServiceProvider;
|
||||||
use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
|
|
||||||
use Barryvdh\LaravelIdeHelper\Console\MetaCommand;
|
use Barryvdh\LaravelIdeHelper\Console\MetaCommand;
|
||||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||||
use Illuminate\Support\ServiceProvider;
|
use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
|
||||||
use Illuminate\View\Engines\EngineResolver;
|
|
||||||
use Illuminate\View\Engines\PhpEngine;
|
|
||||||
use Illuminate\View\Factory;
|
|
||||||
use Illuminate\View\FileViewFinder;
|
|
||||||
|
|
||||||
class IdeHelperServiceProvider extends ServiceProvider
|
class IdeHelperServiceProvider extends ServiceProvider
|
||||||
{
|
{
|
||||||
@@ -37,18 +32,7 @@ class IdeHelperServiceProvider extends ServiceProvider
|
|||||||
*/
|
*/
|
||||||
public function boot()
|
public function boot()
|
||||||
{
|
{
|
||||||
if ($this->app->has('view')) {
|
$this->package('barryvdh/laravel-ide-helper', 'laravel-ide-helper', __DIR__);
|
||||||
$viewPath = __DIR__ . '/../resources/views';
|
|
||||||
$this->loadViewsFrom($viewPath, 'ide-helper');
|
|
||||||
}
|
|
||||||
|
|
||||||
$configPath = __DIR__ . '/../config/ide-helper.php';
|
|
||||||
if (function_exists('config_path')) {
|
|
||||||
$publishPath = config_path('ide-helper.php');
|
|
||||||
} else {
|
|
||||||
$publishPath = base_path('config/ide-helper.php');
|
|
||||||
}
|
|
||||||
$this->publishes([$configPath => $publishPath], 'config');
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -58,44 +42,25 @@ class IdeHelperServiceProvider extends ServiceProvider
|
|||||||
*/
|
*/
|
||||||
public function register()
|
public function register()
|
||||||
{
|
{
|
||||||
$configPath = __DIR__ . '/../config/ide-helper.php';
|
$this->app['command.ide-helper.generate'] = $this->app->share(
|
||||||
$this->mergeConfigFrom($configPath, 'ide-helper');
|
|
||||||
$localViewFactory = $this->createLocalViewFactory();
|
|
||||||
|
|
||||||
$this->app->singleton(
|
|
||||||
'command.ide-helper.generate',
|
|
||||||
function ($app) use ($localViewFactory) {
|
|
||||||
return new GeneratorCommand($app['config'], $app['files'], $localViewFactory);
|
|
||||||
}
|
|
||||||
);
|
|
||||||
|
|
||||||
$this->app->singleton(
|
|
||||||
'command.ide-helper.models',
|
|
||||||
function ($app) {
|
function ($app) {
|
||||||
return new ModelsCommand($app['files']);
|
return new GeneratorCommand($app['config'], $app['files'], $app['view']);
|
||||||
}
|
}
|
||||||
);
|
);
|
||||||
|
|
||||||
$this->app->singleton(
|
$this->app['command.ide-helper.models'] = $this->app->share(
|
||||||
'command.ide-helper.meta',
|
function () {
|
||||||
function ($app) use ($localViewFactory) {
|
return new ModelsCommand();
|
||||||
return new MetaCommand($app['files'], $localViewFactory, $app['config']);
|
|
||||||
}
|
}
|
||||||
);
|
);
|
||||||
|
|
||||||
$this->app->singleton(
|
$this->app['command.ide-helper.meta'] = $this->app->share(
|
||||||
'command.ide-helper.eloquent',
|
function ($app) {
|
||||||
function ($app) use ($localViewFactory) {
|
return new MetaCommand($app['files'], $app['view']);
|
||||||
return new EloquentCommand($app['files']);
|
}
|
||||||
}
|
|
||||||
);
|
);
|
||||||
|
|
||||||
$this->commands(
|
$this->commands('command.ide-helper.generate', 'command.ide-helper.models', 'command.ide-helper.meta');
|
||||||
'command.ide-helper.generate',
|
|
||||||
'command.ide-helper.models',
|
|
||||||
'command.ide-helper.meta',
|
|
||||||
'command.ide-helper.eloquent'
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -107,20 +72,37 @@ class IdeHelperServiceProvider extends ServiceProvider
|
|||||||
{
|
{
|
||||||
return array('command.ide-helper.generate', 'command.ide-helper.models');
|
return array('command.ide-helper.generate', 'command.ide-helper.models');
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return Factory
|
* Register the package's component namespaces.
|
||||||
|
*
|
||||||
|
* @param string $package
|
||||||
|
* @param string $namespace
|
||||||
|
* @param string $path
|
||||||
|
* @return void
|
||||||
*/
|
*/
|
||||||
private function createLocalViewFactory()
|
public function package($package, $namespace = null, $path = null)
|
||||||
{
|
{
|
||||||
$resolver = new EngineResolver();
|
|
||||||
$resolver->register('php', function () {
|
|
||||||
return new PhpEngine();
|
|
||||||
});
|
|
||||||
$finder = new FileViewFinder($this->app['files'], [__DIR__ . '/../resources/views']);
|
|
||||||
$factory = new Factory($resolver, $finder, $this->app['events']);
|
|
||||||
$factory->addExtension('php', 'php');
|
|
||||||
|
|
||||||
return $factory;
|
// Is it possible to register the config?
|
||||||
|
if (method_exists($this->app['config'], 'package')) {
|
||||||
|
$this->app['config']->package($package, $path.'/config', $namespace);
|
||||||
|
} else {
|
||||||
|
// Load the config for now..
|
||||||
|
$config = $this->app['files']->getRequire($path .'/config/config.php');
|
||||||
|
foreach($config as $key => $value){
|
||||||
|
$this->app['config']->set($namespace.'::'.$key, $value);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Register view files
|
||||||
|
$appView = $this->app['path']."/views/packages/{$package}";
|
||||||
|
if ($this->app['files']->isDirectory($appView))
|
||||||
|
{
|
||||||
|
$this->app['view']->addNamespace($namespace, $appView);
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->app['view']->addNamespace($namespace, $path.'/views');
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,46 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper;
|
|
||||||
|
|
||||||
use Barryvdh\Reflection\DocBlock;
|
|
||||||
use Barryvdh\Reflection\DocBlock\Tag;
|
|
||||||
|
|
||||||
class Macro extends Method
|
|
||||||
{
|
|
||||||
/**
|
|
||||||
* Macro constructor.
|
|
||||||
*
|
|
||||||
* @param \ReflectionFunctionAbstract $method
|
|
||||||
* @param string $alias
|
|
||||||
* @param \ReflectionClass $class
|
|
||||||
* @param null $methodName
|
|
||||||
* @param array $interfaces
|
|
||||||
*/
|
|
||||||
public function __construct(
|
|
||||||
$method,
|
|
||||||
$alias,
|
|
||||||
$class,
|
|
||||||
$methodName = null,
|
|
||||||
$interfaces = array()
|
|
||||||
) {
|
|
||||||
parent::__construct($method, $alias, $class, $methodName, $interfaces);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param \ReflectionFunctionAbstract $method
|
|
||||||
*/
|
|
||||||
protected function initPhpDoc($method)
|
|
||||||
{
|
|
||||||
$this->phpdoc = new DocBlock($method);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param \ReflectionFunctionAbstract $method
|
|
||||||
* @param \ReflectionClass $class
|
|
||||||
*/
|
|
||||||
protected function initClassDefinedProperties($method, \ReflectionClass $class)
|
|
||||||
{
|
|
||||||
$this->namespace = $class->getNamespaceName();
|
|
||||||
$this->declaringClassName = '\\' . ltrim($class->name, '\\');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
+311
-344
@@ -1,344 +1,311 @@
|
|||||||
<?php
|
<?php
|
||||||
/**
|
/**
|
||||||
* Laravel IDE Helper Generator
|
* Laravel IDE Helper Generator
|
||||||
*
|
*
|
||||||
* @author Barry vd. Heuvel <barryvdh@gmail.com>
|
* @author Barry vd. Heuvel <barryvdh@gmail.com>
|
||||||
* @copyright 2014 Barry vd. Heuvel / Fruitcake Studio (http://www.fruitcakestudio.nl)
|
* @copyright 2014 Barry vd. Heuvel / Fruitcake Studio (http://www.fruitcakestudio.nl)
|
||||||
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
||||||
* @link https://github.com/barryvdh/laravel-ide-helper
|
* @link https://github.com/barryvdh/laravel-ide-helper
|
||||||
*/
|
*/
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper;
|
namespace Barryvdh\LaravelIdeHelper;
|
||||||
|
|
||||||
use 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 phpDocumentor\Reflection\DocBlock\Tag\ParamTag;
|
||||||
use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
|
use phpDocumentor\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 $output = '';
|
||||||
protected $declaringClassName;
|
protected $name;
|
||||||
protected $name;
|
protected $namespace;
|
||||||
protected $namespace;
|
protected $params = array();
|
||||||
protected $params = array();
|
protected $params_with_default = array();
|
||||||
protected $params_with_default = array();
|
protected $interfaces = array();
|
||||||
protected $interfaces = array();
|
protected $return = null;
|
||||||
protected $real_name;
|
|
||||||
protected $return = null;
|
/**
|
||||||
|
* @param \ReflectionMethod $method
|
||||||
/**
|
* @param string $alias
|
||||||
* @param \ReflectionMethod|\ReflectionFunctionAbstract $method
|
* @param string $class
|
||||||
* @param string $alias
|
* @param string|null $methodName
|
||||||
* @param \ReflectionClass $class
|
* @param array $interfaces
|
||||||
* @param string|null $methodName
|
*/
|
||||||
* @param array $interfaces
|
public function __construct(\ReflectionMethod $method, $alias, $class, $methodName = null, $interfaces = array())
|
||||||
*/
|
{
|
||||||
public function __construct($method, $alias, $class, $methodName = null, $interfaces = array())
|
$this->method = $method;
|
||||||
{
|
$this->interfaces = $interfaces;
|
||||||
$this->method = $method;
|
$this->name = $methodName ?: $method->name;
|
||||||
$this->interfaces = $interfaces;
|
$this->namespace = $method->getDeclaringClass()->getNamespaceName();
|
||||||
$this->name = $methodName ?: $method->name;
|
|
||||||
$this->real_name = $method->isClosure() ? $this->name : $method->name;
|
//Create a DocBlock and serializer instance
|
||||||
$this->initClassDefinedProperties($method, $class);
|
$this->phpdoc = new DocBlock($method, new Context($this->namespace));
|
||||||
|
|
||||||
//Create a DocBlock and serializer instance
|
//Normalize the description and inherit the docs from parents/interfaces
|
||||||
$this->initPhpDoc($method);
|
try {
|
||||||
|
$this->normalizeParams($this->phpdoc);
|
||||||
//Normalize the description and inherit the docs from parents/interfaces
|
$this->normalizeReturn($this->phpdoc);
|
||||||
try {
|
$this->normalizeDescription($this->phpdoc);
|
||||||
$this->normalizeParams($this->phpdoc);
|
} catch (\Exception $e) {}
|
||||||
$this->normalizeReturn($this->phpdoc);
|
|
||||||
$this->normalizeDescription($this->phpdoc);
|
//Get the parameters, including formatted default values
|
||||||
} catch (\Exception $e) {
|
$this->getParameters($method);
|
||||||
}
|
|
||||||
|
//Make the method static
|
||||||
//Get the parameters, including formatted default values
|
$this->phpdoc->appendTag(Tag::createInstance('@static', $this->phpdoc));
|
||||||
$this->getParameters($method);
|
|
||||||
|
//Reference the 'real' function in the declaringclass
|
||||||
//Make the method static
|
$declaringClass = $method->getDeclaringClass();
|
||||||
$this->phpdoc->appendTag(Tag::createInstance('@static', $this->phpdoc));
|
$this->declaringClassName = '\\' . ltrim($declaringClass->name, '\\');
|
||||||
|
$this->root = '\\' . ltrim($class->getName(), '\\');
|
||||||
//Reference the 'real' function in the declaring class
|
}
|
||||||
$this->root = '\\' . ltrim($class->getName(), '\\');
|
|
||||||
}
|
/**
|
||||||
|
* Get the class wherein the function resides
|
||||||
/**
|
*
|
||||||
* @param \ReflectionMethod $method
|
* @return string
|
||||||
*/
|
*/
|
||||||
protected function initPhpDoc($method)
|
public function getDeclaringClass()
|
||||||
{
|
{
|
||||||
$this->phpdoc = new DocBlock($method, new Context($this->namespace));
|
return $this->declaringClassName;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param \ReflectionMethod $method
|
* Return the class from which this function would be called
|
||||||
* @param \ReflectionClass $class
|
*
|
||||||
*/
|
* @return string
|
||||||
protected function initClassDefinedProperties($method, \ReflectionClass $class)
|
*/
|
||||||
{
|
public function getRoot()
|
||||||
$declaringClass = $method->getDeclaringClass();
|
{
|
||||||
$this->namespace = $declaringClass->getNamespaceName();
|
return $this->root;
|
||||||
$this->declaringClassName = '\\' . ltrim($declaringClass->name, '\\');
|
}
|
||||||
}
|
|
||||||
|
/**
|
||||||
/**
|
* Get the docblock for this method
|
||||||
* Get the class wherein the function resides
|
*
|
||||||
*
|
* @param string $prefix
|
||||||
* @return string
|
* @return mixed
|
||||||
*/
|
*/
|
||||||
public function getDeclaringClass()
|
public function getDocComment($prefix = "\t\t")
|
||||||
{
|
{
|
||||||
return $this->declaringClassName;
|
$serializer = new DocBlockSerializer(1, $prefix);
|
||||||
}
|
return $serializer->getDocComment($this->phpdoc);
|
||||||
|
}
|
||||||
/**
|
|
||||||
* Return the class from which this function would be called
|
/**
|
||||||
*
|
* Get the method name
|
||||||
* @return string
|
*
|
||||||
*/
|
* @return string
|
||||||
public function getRoot()
|
*/
|
||||||
{
|
public function getName()
|
||||||
return $this->root;
|
{
|
||||||
}
|
return $this->name;
|
||||||
|
}
|
||||||
/**
|
|
||||||
* Get the docblock for this method
|
/**
|
||||||
*
|
* Get the parameters for this method
|
||||||
* @param string $prefix
|
*
|
||||||
* @return mixed
|
* @param bool $implode Wether to implode the array or not
|
||||||
*/
|
* @return string
|
||||||
public function getDocComment($prefix = "\t\t")
|
*/
|
||||||
{
|
public function getParams($implode = true)
|
||||||
$serializer = new DocBlockSerializer(1, $prefix);
|
{
|
||||||
return $serializer->getDocComment($this->phpdoc);
|
return $implode ? implode(', ', $this->params) : $this->params;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the method name
|
* Get the parameters for this method including default values
|
||||||
*
|
*
|
||||||
* @return string
|
* @param bool $implode Wether to implode the array or not
|
||||||
*/
|
* @return string
|
||||||
public function getName()
|
*/
|
||||||
{
|
public function getParamsWithDefault($implode = true)
|
||||||
return $this->name;
|
{
|
||||||
}
|
return $implode ? implode(', ', $this->params_with_default) : $this->params_with_default;
|
||||||
|
}
|
||||||
/**
|
|
||||||
* Get the real method name
|
/**
|
||||||
*
|
* Get the description and get the inherited docs.
|
||||||
* @return string
|
*
|
||||||
*/
|
* @param DocBlock $phpdoc
|
||||||
public function getRealName()
|
*/
|
||||||
{
|
protected function normalizeDescription(DocBlock $phpdoc)
|
||||||
return $this->real_name;
|
{
|
||||||
}
|
//Get the short + long description from the DocBlock
|
||||||
|
$description = $phpdoc->getText();
|
||||||
/**
|
|
||||||
* Get the parameters for this method
|
//Loop through parents/interfaces, to fill in {@inheritdoc}
|
||||||
*
|
if (strpos($description, '{@inheritdoc}') !== false) {
|
||||||
* @param bool $implode Wether to implode the array or not
|
$inheritdoc = $this->getInheritDoc($this->method);
|
||||||
* @return string
|
$inheritDescription = $inheritdoc->getText();
|
||||||
*/
|
|
||||||
public function getParams($implode = true)
|
$description = str_replace('{@inheritdoc}', $inheritDescription, $description);
|
||||||
{
|
$phpdoc->setText($description);
|
||||||
return $implode ? implode(', ', $this->params) : $this->params;
|
|
||||||
}
|
$this->normalizeParams($inheritdoc);
|
||||||
|
$this->normalizeReturn($inheritdoc);
|
||||||
/**
|
|
||||||
* Get the parameters for this method including default values
|
//Add the tags that are inherited
|
||||||
*
|
$inheritTags = $inheritdoc->getTags();
|
||||||
* @param bool $implode Wether to implode the array or not
|
if ($inheritTags) {
|
||||||
* @return string
|
/** @var Tag $tag */
|
||||||
*/
|
foreach ($inheritTags as $tag) {
|
||||||
public function getParamsWithDefault($implode = true)
|
$tag->setDocBlock();
|
||||||
{
|
$phpdoc->appendTag($tag);
|
||||||
return $implode ? implode(', ', $this->params_with_default) : $this->params_with_default;
|
}
|
||||||
}
|
}
|
||||||
|
}
|
||||||
/**
|
}
|
||||||
* Get the description and get the inherited docs.
|
|
||||||
*
|
/**
|
||||||
* @param DocBlock $phpdoc
|
* Normalize the parameters
|
||||||
*/
|
*
|
||||||
protected function normalizeDescription(DocBlock $phpdoc)
|
* @param DocBlock $phpdoc
|
||||||
{
|
*/
|
||||||
//Get the short + long description from the DocBlock
|
protected function normalizeParams(DocBlock $phpdoc)
|
||||||
$description = $phpdoc->getText();
|
{
|
||||||
|
//Get the return type and adjust them for beter autocomplete
|
||||||
//Loop through parents/interfaces, to fill in {@inheritdoc}
|
$paramTags = $phpdoc->getTagsByName('param');
|
||||||
if (strpos($description, '{@inheritdoc}') !== false) {
|
if ($paramTags) {
|
||||||
$inheritdoc = $this->getInheritDoc($this->method);
|
/** @var ParamTag $tag */
|
||||||
$inheritDescription = $inheritdoc->getText();
|
foreach($paramTags as $tag){
|
||||||
|
// Convert the keywords
|
||||||
$description = str_replace('{@inheritdoc}', $inheritDescription, $description);
|
$content = $this->convertKeywords($tag->getContent());
|
||||||
$phpdoc->setText($description);
|
$tag->setContent($content);
|
||||||
|
|
||||||
$this->normalizeParams($inheritdoc);
|
// Get the expanded type and re-set the content
|
||||||
$this->normalizeReturn($inheritdoc);
|
$content = $tag->getType() . ' ' . $tag->getVariableName() . ' ' . $tag->getDescription();
|
||||||
|
$tag->setContent(trim($content));
|
||||||
//Add the tags that are inherited
|
}
|
||||||
$inheritTags = $inheritdoc->getTags();
|
}
|
||||||
if ($inheritTags) {
|
}
|
||||||
/** @var Tag $tag */
|
|
||||||
foreach ($inheritTags as $tag) {
|
/**
|
||||||
$tag->setDocBlock();
|
* Normalize the return tag (make full namespace, replace interfaces)
|
||||||
$phpdoc->appendTag($tag);
|
*
|
||||||
}
|
* @param DocBlock $phpdoc
|
||||||
}
|
*/
|
||||||
}
|
protected function normalizeReturn(DocBlock $phpdoc)
|
||||||
}
|
{
|
||||||
|
//Get the return type and adjust them for beter autocomplete
|
||||||
/**
|
$returnTags = $phpdoc->getTagsByName('return');
|
||||||
* Normalize the parameters
|
if ($returnTags) {
|
||||||
*
|
/** @var ReturnTag $tag */
|
||||||
* @param DocBlock $phpdoc
|
$tag = reset($returnTags);
|
||||||
*/
|
// Get the expanded type
|
||||||
protected function normalizeParams(DocBlock $phpdoc)
|
$returnValue = $tag->getType();
|
||||||
{
|
|
||||||
//Get the return type and adjust them for beter autocomplete
|
// Replace the interfaces
|
||||||
$paramTags = $phpdoc->getTagsByName('param');
|
foreach($this->interfaces as $interface => $real){
|
||||||
if ($paramTags) {
|
$returnValue = str_replace($interface, $real, $returnValue);
|
||||||
/** @var ParamTag $tag */
|
}
|
||||||
foreach ($paramTags as $tag) {
|
|
||||||
// Convert the keywords
|
// Set the changed content
|
||||||
$content = $this->convertKeywords($tag->getContent());
|
$tag->setContent($returnValue . ' ' . $tag->getDescription());
|
||||||
$tag->setContent($content);
|
$this->return = $returnValue;
|
||||||
|
}else{
|
||||||
// Get the expanded type and re-set the content
|
$this->return = null;
|
||||||
$content = $tag->getType() . ' ' . $tag->getVariableName() . ' ' . $tag->getDescription();
|
}
|
||||||
$tag->setContent(trim($content));
|
}
|
||||||
}
|
|
||||||
}
|
/**
|
||||||
}
|
* Convert keywwords that are incorrect.
|
||||||
|
*
|
||||||
/**
|
* @param string $string
|
||||||
* Normalize the return tag (make full namespace, replace interfaces)
|
* @return string
|
||||||
*
|
*/
|
||||||
* @param DocBlock $phpdoc
|
protected function convertKeywords($string)
|
||||||
*/
|
{
|
||||||
protected function normalizeReturn(DocBlock $phpdoc)
|
$string = str_replace('\Closure', 'Closure', $string);
|
||||||
{
|
$string = str_replace('Closure', '\Closure', $string);
|
||||||
//Get the return type and adjust them for beter autocomplete
|
$string = str_replace('dynamic', 'mixed', $string);
|
||||||
$returnTags = $phpdoc->getTagsByName('return');
|
|
||||||
if ($returnTags) {
|
return $string;
|
||||||
/** @var ReturnTag $tag */
|
}
|
||||||
$tag = reset($returnTags);
|
|
||||||
// Get the expanded type
|
/**
|
||||||
$returnValue = $tag->getType();
|
* Should the function return a value?
|
||||||
|
*
|
||||||
// Replace the interfaces
|
* @return bool
|
||||||
foreach ($this->interfaces as $interface => $real) {
|
*/
|
||||||
$returnValue = str_replace($interface, $real, $returnValue);
|
public function shouldReturn()
|
||||||
}
|
{
|
||||||
|
if($this->return !== "void" && $this->method->name !== "__construct"){
|
||||||
// Set the changed content
|
return true;
|
||||||
$tag->setContent($returnValue . ' ' . $tag->getDescription());
|
}
|
||||||
$this->return = $returnValue;
|
|
||||||
} else {
|
return false;
|
||||||
$this->return = null;
|
}
|
||||||
}
|
|
||||||
}
|
/**
|
||||||
|
* Get the parameters and format them correctly
|
||||||
/**
|
*
|
||||||
* Convert keywwords that are incorrect.
|
* @param $method
|
||||||
*
|
* @return array
|
||||||
* @param string $string
|
*/
|
||||||
* @return string
|
public function getParameters($method)
|
||||||
*/
|
{
|
||||||
protected function convertKeywords($string)
|
//Loop through the default values for paremeters, and make the correct output string
|
||||||
{
|
$params = array();
|
||||||
$string = str_replace('\Closure', 'Closure', $string);
|
$paramsWithDefault = array();
|
||||||
$string = str_replace('Closure', '\Closure', $string);
|
foreach ($method->getParameters() as $param) {
|
||||||
$string = str_replace('dynamic', 'mixed', $string);
|
$paramStr = '$' . $param->getName();
|
||||||
|
$params[] = $paramStr;
|
||||||
return $string;
|
if ($param->isOptional()) {
|
||||||
}
|
$default = $param->isDefaultValueAvailable() ? $param->getDefaultValue() : null;
|
||||||
|
if (is_bool($default)) {
|
||||||
/**
|
$default = $default ? 'true' : 'false';
|
||||||
* Should the function return a value?
|
} elseif (is_array($default)) {
|
||||||
*
|
$default = 'array()';
|
||||||
* @return bool
|
} elseif (is_null($default)) {
|
||||||
*/
|
$default = 'null';
|
||||||
public function shouldReturn()
|
} elseif (is_int($default)) {
|
||||||
{
|
//$default = $default;
|
||||||
if ($this->return !== "void" && $this->method->name !== "__construct") {
|
} else {
|
||||||
return true;
|
$default = "'" . trim($default) . "'";
|
||||||
}
|
}
|
||||||
|
$paramStr .= " = $default";
|
||||||
return false;
|
}
|
||||||
}
|
$paramsWithDefault[] = $paramStr;
|
||||||
|
}
|
||||||
/**
|
|
||||||
* Get the parameters and format them correctly
|
$this->params = $params;
|
||||||
*
|
$this->params_with_default = $paramsWithDefault;
|
||||||
* @param \ReflectionMethod $method
|
}
|
||||||
* @return array
|
|
||||||
*/
|
/**
|
||||||
public function getParameters($method)
|
* @param \ReflectionMethod $reflectionMethod
|
||||||
{
|
* @return DocBlock
|
||||||
//Loop through the default values for paremeters, and make the correct output string
|
*/
|
||||||
$params = array();
|
protected function getInheritDoc($reflectionMethod)
|
||||||
$paramsWithDefault = array();
|
{
|
||||||
foreach ($method->getParameters() as $param) {
|
$parentClass = $reflectionMethod->getDeclaringClass()->getParentClass();
|
||||||
$paramStr = '$' . $param->getName();
|
|
||||||
$params[] = $paramStr;
|
//Get either a parent or the interface
|
||||||
if ($param->isOptional()) {
|
if ($parentClass) {
|
||||||
$default = $param->isDefaultValueAvailable() ? $param->getDefaultValue() : null;
|
$method = $parentClass->getMethod($reflectionMethod->getName());
|
||||||
if (is_bool($default)) {
|
} else {
|
||||||
$default = $default ? 'true' : 'false';
|
$method = $reflectionMethod->getPrototype();
|
||||||
} elseif (is_array($default)) {
|
}
|
||||||
$default = 'array()';
|
if ($method) {
|
||||||
} elseif (is_null($default)) {
|
$namespace = $method->getDeclaringClass()->getNamespaceName();
|
||||||
$default = 'null';
|
$phpdoc = new DocBlock($method, new Context($namespace));
|
||||||
} elseif (is_int($default)) {
|
|
||||||
//$default = $default;
|
if (strpos($phpdoc->getText(), '{@inheritdoc}') !== false) {
|
||||||
} elseif (is_resource($default)) {
|
//Not at the end yet, try another parent/interface..
|
||||||
//skip to not fail
|
return $this->getInheritDoc($method);
|
||||||
} else {
|
} else {
|
||||||
$default = "'" . trim($default) . "'";
|
return $phpdoc;
|
||||||
}
|
}
|
||||||
$paramStr .= " = $default";
|
}
|
||||||
}
|
}
|
||||||
$paramsWithDefault[] = $paramStr;
|
}
|
||||||
}
|
|
||||||
|
|
||||||
$this->params = $params;
|
|
||||||
$this->params_with_default = $paramsWithDefault;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param \ReflectionMethod $reflectionMethod
|
|
||||||
* @return DocBlock
|
|
||||||
*/
|
|
||||||
protected function getInheritDoc($reflectionMethod)
|
|
||||||
{
|
|
||||||
$parentClass = $reflectionMethod->getDeclaringClass()->getParentClass();
|
|
||||||
|
|
||||||
//Get either a parent or the interface
|
|
||||||
if ($parentClass) {
|
|
||||||
$method = $parentClass->getMethod($reflectionMethod->getName());
|
|
||||||
} else {
|
|
||||||
$method = $reflectionMethod->getPrototype();
|
|
||||||
}
|
|
||||||
if ($method) {
|
|
||||||
$namespace = $method->getDeclaringClass()->getNamespaceName();
|
|
||||||
$phpdoc = new DocBlock($method, new Context($namespace));
|
|
||||||
|
|
||||||
if (strpos($phpdoc->getText(), '{@inheritdoc}') !== false) {
|
|
||||||
//Not at the end yet, try another parent/interface..
|
|
||||||
return $this->getInheritDoc($method);
|
|
||||||
} else {
|
|
||||||
return $phpdoc;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -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,39 @@
|
|||||||
|
<?= '<?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): ?>
|
||||||
|
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; ?>
|
||||||
@@ -0,0 +1,20 @@
|
|||||||
|
<?= '<?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 PhpUnusedLocalVariableInspection
|
||||||
|
* @noinspection PhpIllegalArrayKeyTypeInspection
|
||||||
|
*/
|
||||||
|
$STATIC_METHOD_TYPES = [
|
||||||
|
<?php foreach($methods as $method): ?>
|
||||||
|
<?= $method ?>('') => [
|
||||||
|
<?php foreach($bindings as $abstract => $class): ?>
|
||||||
|
'<?= $abstract ?>' instanceof \<?= $class ?>,
|
||||||
|
<?php endforeach ?> ],
|
||||||
|
<?php endforeach ?>
|
||||||
|
];
|
||||||
|
}
|
||||||
@@ -1,58 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper;
|
|
||||||
|
|
||||||
class ExampleTest extends \PHPUnit_Framework_TestCase
|
|
||||||
{
|
|
||||||
/**
|
|
||||||
* Test that we can actually instantiate the class
|
|
||||||
*/
|
|
||||||
public function testCanInstantiate()
|
|
||||||
{
|
|
||||||
$reflectionClass = new \ReflectionClass(ExampleClass::class);
|
|
||||||
$reflectionMethod = $reflectionClass->getMethod('setName');
|
|
||||||
|
|
||||||
$method = new Method($reflectionMethod, 'Example', $reflectionClass);
|
|
||||||
|
|
||||||
$this->assertInstanceOf(Method::class, $method);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Test the output of a class
|
|
||||||
*/
|
|
||||||
public function testOutput()
|
|
||||||
{
|
|
||||||
$reflectionClass = new \ReflectionClass(ExampleClass::class);
|
|
||||||
$reflectionMethod = $reflectionClass->getMethod('setName');
|
|
||||||
|
|
||||||
$method = new Method($reflectionMethod, 'Example', $reflectionClass);
|
|
||||||
|
|
||||||
$output = '/**
|
|
||||||
*
|
|
||||||
*
|
|
||||||
* @param string $last
|
|
||||||
* @param string $first
|
|
||||||
* @static
|
|
||||||
*/';
|
|
||||||
$this->assertEquals($output, $method->getDocComment(''));
|
|
||||||
$this->assertEquals('setName', $method->getName());
|
|
||||||
$this->assertEquals('\\'.ExampleClass::class, $method->getDeclaringClass());
|
|
||||||
$this->assertEquals('$last, $first', $method->getParams(true));
|
|
||||||
$this->assertEquals(['$last', '$first'], $method->getParams(false));
|
|
||||||
$this->assertEquals('$last, $first = \'Barry\'', $method->getParamsWithDefault(true));
|
|
||||||
$this->assertEquals(['$last', '$first = \'Barry\''], $method->getParamsWithDefault(false));
|
|
||||||
$this->assertEquals(true, $method->shouldReturn());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
class ExampleClass
|
|
||||||
{
|
|
||||||
/**
|
|
||||||
* @param string $last
|
|
||||||
* @param string $first
|
|
||||||
*/
|
|
||||||
public function setName($last, $first = 'Barry')
|
|
||||||
{
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Reference in New Issue
Block a user