Compare commits

..
12 Commits
Author SHA1 Message Date
Barry vd. Heuvel 6eb797f5ff Remove contracts from L4 version 2015-03-16 14:28:03 +01:00
Barry vd. Heuvel 604d327277 More meta methods 2015-03-16 14:25:52 +01:00
Barry vd. Heuvel 6ed5367f6b Tweak meta methods 2015-03-16 14:16:41 +01:00
Barry vd. Heuvel 8c339bd6b0 Add actual command 2015-03-16 13:12:40 +01:00
Barry vd. Heuvel 52b9b52926 Add gist 2015-03-16 13:06:29 +01:00
Barry vd. Heuvel f909c82fcc Fix class imports 2015-03-16 12:52:26 +01:00
Barry vd. Heuvel e88c3669b7 Add note about meta file 2015-03-16 12:40:53 +01:00
Barry vd. Heuvel 5bd7eeda23 Add meta command for phpstorm 2015-03-16 12:13:15 +01:00
Barry vd. Heuvel dae0b55bef Update version
Fixes #164
2015-02-07 23:18:57 +01:00
Barry vd. Heuvel 3f9831c5cf Check for correct facades 2015-02-04 09:14:36 +01:00
Barry vd. Heuvel 2cc277440a Remove tree 2015-02-03 21:03:00 +01:00
Barry vd. Heuvel 14eab5ef84 Point to 2.0 branch 2015-01-28 09:36:05 +01:00
22 changed files with 1093 additions and 1529 deletions
-15
View File
@@ -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
-10
View File
@@ -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
View File
@@ -1,4 +1,3 @@
build /vendor
vendor
composer.lock composer.lock
.idea .idea
-23
View File
@@ -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
View File
@@ -1 +0,0 @@
preset: psr2
-31
View File
@@ -1,31 +0,0 @@
language: php
php:
- 5.5
- 5.6
- 7.0
- hhvm
# This triggers builds to run on the new TravisCI infrastructure.
# See: http://docs.travis-ci.com/user/workers/container-based-infrastructure/
sudo: false
## Cache composer
cache:
directories:
- $HOME/.composer/cache
matrix:
include:
- php: 5.5
env: 'COMPOSER_FLAGS="--prefer-stable --prefer-lowest"'
before_script:
- travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-dist
script:
- vendor/bin/phpcs --standard=psr2 src/
- vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover
after_script:
- if [[ $TRAVIS_PHP_VERSION != 'hhvm' && $TRAVIS_PHP_VERSION != '7.0' ]]; then php vendor/bin/ocular code-coverage:upload --format=php-clover coverage.clover; fi
-21
View File
@@ -1,21 +0,0 @@
# The MIT License (MIT)
Copyright (c) 2016 Barry vd. Heuvel <barryvdh@gmail.com>
> Permission is hereby granted, free of charge, to any person obtaining a copy
> of this software and associated documentation files (the "Software"), to deal
> in the Software without restriction, including without limitation the rights
> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
> copies of the Software, and to permit persons to whom the Software is
> furnished to do so, subject to the following conditions:
>
> The above copyright notice and this permission notice shall be included in
> all copies or substantial portions of the Software.
>
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
> THE SOFTWARE.
+7 -19
View File
@@ -10,17 +10,14 @@
} }
], ],
"require": { "require": {
"php": ">=5.4.0", "php": ">=5.3.0",
"illuminate/support": "^5.0,<5.4", "illuminate/support": "4.x",
"illuminate/console": "^5.0,<5.4", "illuminate/console": "4.x",
"illuminate/filesystem": "^5.0,<5.4", "illuminate/filesystem": "4.x",
"barryvdh/reflection-docblock": "^2.0.4", "phpdocumentor/reflection-docblock": "2.0.x",
"symfony/class-loader": "^2.3|^3.0" "symfony/class-loader": "~2.3"
}, },
"require-dev": { "require-dev": {
"phpunit/phpunit" : "4.*",
"scrutinizer/ocular": "~1.1",
"squizlabs/php_codesniffer": "~2.3",
"doctrine/dbal": "~2.3" "doctrine/dbal": "~2.3"
}, },
"suggest": { "suggest": {
@@ -31,18 +28,9 @@
"Barryvdh\\LaravelIdeHelper\\": "src" "Barryvdh\\LaravelIdeHelper\\": "src"
} }
}, },
"autoload-dev": {
"psr-4": {
":vendor\\:package_name\\": "tests"
}
},
"scripts": {
"test": "phpunit",
"cs": "phpcs --standard=psr2 src/"
},
"extra": { "extra": {
"branch-alias": { "branch-alias": {
"dev-master": "2.1-dev" "dev-master": "1.11-dev"
} }
} }
} }
-29
View File
@@ -1,29 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit bootstrap="vendor/autoload.php"
backupGlobals="false"
backupStaticAttributes="false"
colors="true"
verbose="true"
convertErrorsToExceptions="true"
convertNoticesToExceptions="true"
convertWarningsToExceptions="true"
processIsolation="false"
stopOnFailure="false">
<testsuites>
<testsuite name=":vendor Test Suite">
<directory>tests</directory>
</testsuite>
</testsuites>
<filter>
<whitelist>
<directory suffix=".php">src/</directory>
</whitelist>
</filter>
<logging>
<log type="tap" target="build/report.tap"/>
<log type="junit" target="build/report.junit.xml"/>
<log type="coverage-html" target="build/coverage" charset="UTF-8" yui="true" highlight="true"/>
<log type="coverage-text" target="build/coverage.txt"/>
<log type="coverage-clover" target="build/logs/clover.xml"/>
</logging>
</phpunit>
+5
View File
@@ -0,0 +1,5 @@
{
"providers": [
"Barryvdh\\LaravelIdeHelper\\IdeHelperServiceProvider"
]
}
+41 -106
View File
@@ -1,101 +1,83 @@
## Laravel 5 IDE Helper Generator ## Laravel IDE Helper Generator
[![Latest Stable Version](https://poser.pugx.org/barryvdh/laravel-ide-helper/version.png)](https://packagist.org/packages/barryvdh/laravel-ide-helper) [![Total Downloads](https://poser.pugx.org/barryvdh/laravel-ide-helper/d/total.png)](https://packagist.org/packages/barryvdh/laravel-ide-helper)
[![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
_Checkout [this Laracasts video](https://laracasts.com/series/how-to-be-awesome-in-phpstorm/episodes/15) for a quick introduction/explanation!_ _Checkout [this Laracasts video](https://laracasts.com/series/how-to-be-awesome-in-phpstorm/episodes/15) for a quick introduction/explanation!_
* [`php artisan ide-helper:generate` - phpDoc generation for Laravel Facades ](#automatic-phpdoc-generation-for-laravel-facades) 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
* Generated version for Lumen: https://gist.github.com/barryvdh/be17164b0ad51f832f20
* Generated Phpstorm Meta file: https://gist.github.com/barryvdh/bb6ffc5d11e0a75dba67
Note: You do need CodeIntel for Sublime Text: https://github.com/SublimeCodeIntel/SublimeCodeIntel Note: You do need CodeIntel for Sublime Text: https://github.com/SublimeCodeIntel/SublimeCodeIntel
### Install ### New: PhpStorm Meta for Container instances
Require this package with composer using the following command: It's possible to generate a PhpStorm meta file, to [add support for factory design pattern](https://confluence.jetbrains.com/display/PhpStorm/PhpStorm+Advanced+Metadata). For Laravel, this means we can make PhpStorm understand what kind of object we are resolving from the IoC Container. For example, `events` will return ann `Illuminate\Events\Dispatcher` object, so with the meta file you can call `app('events')` and it will autocomplete the Dispatcher methods.
```bash php artisan ide-helper:meta
composer require barryvdh/laravel-ide-helper
```
After updating composer, add the service provider to the `providers` array in `config/app.php` app('events')->fire();
\App::make('events')->..
```php Pre-generated example: https://gist.github.com/barryvdh/bb6ffc5d11e0a75dba67
Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class,
``` > Note: This is only available in the `@dev` stability, until a new release is tagged.
> Note: You might need to restart PhpStorm and make sure `.phpstorm.meta.php` is indexed.
### Automatic phpDoc generation for Laravel Facades ### Automatic phpDoc generation for Laravel Facades
Require this package with composer using the following command:
You can now re-generate the docs yourself (for future updates) composer require barryvdh/laravel-ide-helper ~1.11
After updating composer, add the ServiceProvider to the providers array in app/config/app.php
'Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider',
You can now re-generate the docs yourself (for future updates) in artisan
```bash
php artisan ide-helper:generate php artisan ide-helper:generate
```
Note: `bootstrap/compiled.php` has to be cleared first, so run `php artisan clear-compiled` before generating (and `php artisan optimize` after). Note: bootstrap/compiled.php has to be cleared first, so run `php artisan clear-compiled` before generating (and `php artisan optimize` after..)
You can configure your composer.json to do this after each commit: You can configure your composer.json to do this after each commit:
```js
"scripts":{ "scripts":{
"post-update-cmd":[ "post-update-cmd":[
"Illuminate\\Foundation\\ComposerScripts::postUpdate", "php artisan clear-compiled",
"php artisan ide-helper:generate", "php artisan ide-helper:generate",
"php artisan ide-helper:meta",
"php artisan optimize" "php artisan optimize"
] ]
}, },
```
You can also publish the config file to change implementations (ie. interface to specific class) or set defaults for `--helpers` or `--sublime`. You can also publish the config-file to change implementations (ie. interface to specific class) or set defaults for --helpers or --sublime.
```bash 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, using 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'
* *
@@ -108,70 +90,23 @@ php artisan ide-helper:models Post
* @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 vendor:publish`) and set the default directories. You can publish the config file (`php artisan config:publish barryvdh/laravel-ide-helper`) and set the default directories.
Models can be ignored using the `--ignore (-I)` option Models can be ignored using the --ignore (-I) option
```bash
php artisan ide-helper:models --ignore="Post,User" php artisan ide-helper:models --ignore="Post,User"
```
Note: With namespaces, wrap your model name in " signs: `php artisan ide-helper:models "API\User"`, or escape the slashes (`Api\\User`) Note: With namespaces, wrap your model name in " signs: `php artisan ide-helper:models "API\User"`, or escape the slashes (`Api\\User`)
## PhpStorm Meta for Container instances
It's possible to generate a PhpStorm meta file, to [add support for factory design pattern](https://confluence.jetbrains.com/display/PhpStorm/PhpStorm+Advanced+Metadata). For Laravel, this means we can make PhpStorm understand what kind of object we are resolving from the IoC Container. For example, `events` will return an `Illuminate\Events\Dispatcher` object, so with the meta file you can call `app('events')` and it will autocomplete the Dispatcher methods.
``` bash
php artisan ide-helper:meta
```
```php
app('events')->fire();
\App::make('events')->fire();
/** @var \Illuminate\Foundation\Application $app */
$app->make('events')->fire();
// When the key is not found, it uses the argument as class name
app('App\SomeClass');
```
Pre-generated example: https://gist.github.com/barryvdh/bb6ffc5d11e0a75dba67
> Note: You might need to restart PhpStorm and make sure `.phpstorm.meta.php` is indexed.
> Note: When you receive a FatalException about a class that is not found, check your config (for example, remove S3 as cloud driver when you don't have S3 configured. Remove Redis ServiceProvider when you don't use it).
### License ### License
The Laravel IDE Helper Generator is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT) The Laravel IDE Helper Generator is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)
[ico-version]: https://img.shields.io/packagist/v/barryvdh/laravel-ide-helper.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-travis]: https://img.shields.io/travis/barryvdh/laravel-ide-helper/master.svg?style=flat-square
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/barryvdh/laravel-ide-helper.svg?style=flat-square
[ico-code-quality]: https://img.shields.io/scrutinizer/g/barryvdh/laravel-ide-helper.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/barryvdh/laravel-ide-helper.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/barryvdh/laravel-ide-helper
[link-travis]: https://travis-ci.org/barryvdh/laravel-ide-helper
[link-scrutinizer]: https://scrutinizer-ci.com/g/barryvdh/laravel-ide-helper/code-structure
[link-code-quality]: https://scrutinizer-ci.com/g/barryvdh/laravel-ide-helper
[link-downloads]: https://packagist.org/packages/barryvdh/laravel-ide-helper
[link-author]: https://github.com/barryvdh
[link-contributors]: ../../contributors
+3 -12
View File
@@ -118,8 +118,7 @@ class Alias
/** /**
* Return the short name (without namespace) * Return the short name (without namespace)
*/ */
public function getShortName() public function getShortName(){
{
return $this->short; return $this->short;
} }
/** /**
@@ -202,9 +201,7 @@ class Alias
//When the database connection is not set, some classes will be skipped //When the database connection is not set, some classes will be skipped
} catch (\PDOException $e) { } catch (\PDOException $e) {
$this->error( $this->error(
"PDOException: " . $e->getMessage() . "PDOException: " . $e->getMessage() . "\nPlease configure your database connection correctly, or use the sqlite memory driver (-M). Skipping $facade."
"\nPlease configure your database connection correctly, or use the sqlite memory driver (-M)." .
" Skipping $facade."
); );
} catch (\Exception $e) { } catch (\Exception $e) {
$this->error("Exception: " . $e->getMessage() . "\nSkipping $facade."); $this->error("Exception: " . $e->getMessage() . "\nSkipping $facade.");
@@ -265,13 +262,7 @@ class Alias
// Only add the methods to the output when the root is not the same as the class. // Only add the methods to the output when the root is not the same as the class.
// And don't add the __*() methods // And don't add the __*() methods
if ($this->extends !== $class && substr($method->name, 0, 2) !== '__') { if ($this->extends !== $class && substr($method->name, 0, 2) !== '__') {
$this->methods[] = new Method( $this->methods[] = new Method($method, $this->alias, $reflection, $method->name, $this->interfaces);
$method,
$this->alias,
$reflection,
$method->name,
$this->interfaces
);
} }
$this->usedMethods[] = $method->name; $this->usedMethods[] = $method->name;
} }
+10 -11
View File
@@ -17,6 +17,7 @@ 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;
@@ -76,11 +76,9 @@ class GeneratorCommand extends Command
*/ */
public function fire() public function fire()
{ {
if (file_exists(base_path() . '/vendor/compiled.php') || if (file_exists($compiled = base_path() . '/bootstrap/compiled.php')) {
file_exists(base_path() . '/bootstrap/cache/compiled.php') ||
file_exists(base_path() . '/storage/framework/compiled.php')) {
$this->error( $this->error(
'Error generating IDE Helper: first delete your compiled file (php artisan clear-compiled)' 'Error generating IDE Helper: first delete bootstrap/compiled.php (php artisan clear-compiled)'
); );
} else { } else {
$filename = $this->argument('filename'); $filename = $this->argument('filename');
@@ -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));
} }
@@ -141,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(
@@ -157,7 +155,7 @@ 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');
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),
@@ -166,4 +164,5 @@ class GeneratorCommand extends Command
array('sublime', "S", InputOption::VALUE_NONE, 'DEPRECATED: Use different style for SublimeText CodeIntel'), array('sublime', "S", InputOption::VALUE_NONE, 'DEPRECATED: Use different style for SublimeText CodeIntel'),
); );
} }
} }
+14 -47
View File
@@ -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.
@@ -37,26 +35,25 @@ 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;
protected $methods = [ protected $methods = [
'new \Illuminate\Contracts\Container\Container', '\Illuminate\Foundation\Application::make',
'\Illuminate\Contracts\Container\Container::make(\'\')', '\Illuminate\Container\Container::make',
'\App::make(\'\')', '\App::make',
'app(\'\')', 'app',
]; ];
/** /**
* *
* @param \Illuminate\Contracts\Filesystem\Filesystem $files * @param \Illuminate\Filesystem\Filesystem $files
* @param \Illuminate\Contracts\View\Factory $view * @param \Illuminate\View\Factory $view
*/ */
public function __construct($files, $view) public function __construct($files, $view) {
{
$this->files = $files; $this->files = $files;
$this->view = $view; $this->view = $view;
parent::__construct(); parent::__construct();
@@ -69,33 +66,26 @@ class MetaCommand extends Command
*/ */
public function fire() 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('ide-helper::meta', [ $content = $this->view->make('laravel-ide-helper::meta', [
'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) {
@@ -105,29 +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
return array_keys($abstracts);
}
/**
* Register an autoloader the throws exceptions when a class is not found.
*/
protected function registerClassAutoloadExceptions()
{
spl_autoload_register(function ($class) {
throw new \Exception("Class '$class' not found.");
});
}
/** /**
* Get the console command options. * Get the console command options.
* *
+40 -95
View File
@@ -11,17 +11,14 @@
namespace Barryvdh\LaravelIdeHelper\Console; namespace Barryvdh\LaravelIdeHelper\Console;
use Illuminate\Console\Command; use Illuminate\Console\Command;
use Illuminate\Database\Eloquent\Relations\Relation;
use Illuminate\Support\Str; use Illuminate\Support\Str;
use Illuminate\Filesystem\Filesystem;
use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\ClassLoader\ClassMapGenerator; use Symfony\Component\ClassLoader\ClassMapGenerator;
use Barryvdh\Reflection\DocBlock; use phpDocumentor\Reflection\DocBlock;
use Barryvdh\Reflection\DocBlock\Context; use phpDocumentor\Reflection\DocBlock\Context;
use Barryvdh\Reflection\DocBlock\Tag; use phpDocumentor\Reflection\DocBlock\Tag;
use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer; 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
@@ -30,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.
@@ -56,14 +49,6 @@ class ModelsCommand extends Command
protected $dirs = array(); protected $dirs = array();
protected $reset; protected $reset;
/**
* @param Filesystem $files
*/
public function __construct(Filesystem $files)
{
parent::__construct();
$this->files = $files;
}
/** /**
* Execute the console command. * Execute the console command.
@@ -75,7 +60,7 @@ class ModelsCommand extends Command
$filename = $this->option('filename'); $filename = $this->option('filename');
$this->write = $this->option('write'); $this->write = $this->option('write');
$this->dirs = array_merge( $this->dirs = array_merge(
$this->laravel['config']->get('ide-helper.model_locations'), $this->laravel['config']->get('laravel-ide-helper::model_locations'),
$this->option('dir') $this->option('dir')
); );
$model = $this->argument('model'); $model = $this->argument('model');
@@ -95,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 {
@@ -163,9 +148,7 @@ class ModelsCommand extends Command
foreach ($models as $name) { foreach ($models as $name) {
if (in_array($name, $ignore)) { if (in_array($name, $ignore)) {
if ($this->output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
$this->comment("Ignoring model '$name'"); $this->comment("Ignoring model '$name'");
}
continue; continue;
} }
$this->properties = array(); $this->properties = array();
@@ -179,13 +162,10 @@ class ModelsCommand extends Command
continue; continue;
} }
if ($this->output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
$this->comment("Loading model '$name'"); $this->comment("Loading model '$name'");
}
if (!$reflectionClass->IsInstantiable()) { if (!$reflectionClass->IsInstantiable()) {
// ignore abstract class or interface throw new \Exception($name . ' is not instantiable.');
continue;
} }
$model = $this->laravel->make($name); $model = $this->laravel->make($name);
@@ -196,17 +176,16 @@ class ModelsCommand extends Command
$this->getPropertiesFromMethods($model); $this->getPropertiesFromMethods($model);
$output .= $this->createPhpDocs($name); $output .= $this->createPhpDocs($name);
$ignore[] = $name;
} catch (\Exception $e) { } catch (\Exception $e) {
$this->error("Exception: " . $e->getMessage() . "\nCould not analyze class $name."); $this->error("Exception: " . $e->getMessage() . "\nCould not analyze class $name.");
} }
} }
} }
if (!$hasDoctrine) { if (!$hasDoctrine) {
$this->error( $this->error(
'Warning: `"doctrine/dbal": "~2.3"` is required to load database information. '. 'Warning: `"doctrine/dbal": "~2.3"` is required to load database information. Please require that in your composer.json and run `composer update`.'
'Please require that in your composer.json and run `composer update`.'
); );
} }
@@ -238,21 +217,9 @@ class ModelsCommand extends Command
{ {
$table = $model->getConnection()->getTablePrefix() . $model->getTable(); $table = $model->getConnection()->getTablePrefix() . $model->getTable();
$schema = $model->getConnection()->getDoctrineSchemaManager($table); $schema = $model->getConnection()->getDoctrineSchemaManager($table);
$databasePlatform = $schema->getDatabasePlatform(); $schema->getDatabasePlatform()->registerDoctrineTypeMapping('enum', 'string');
$databasePlatform->registerDoctrineTypeMapping('enum', 'string');
$platformName = $databasePlatform->getName(); $columns = $schema->listTableColumns($table);
$customTypes = $this->laravel['config']->get("ide-helper.custom_db_types.{$platformName}", array());
foreach ($customTypes as $yourTypeName => $doctrineTypeName) {
$databasePlatform->registerDoctrineTypeMapping($yourTypeName, $doctrineTypeName);
}
$database = null;
if (strpos($table, '.')) {
list($database, $table) = explode('.', $table);
}
$columns = $schema->listTableColumns($table, $database);
if ($columns) { if ($columns) {
foreach ($columns as $column) { foreach ($columns as $column) {
@@ -336,11 +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\Query\Builder|\\' . $reflection->class, $args); $this->setMethod($name, '\\' . $reflection->class, $args);
} }
} elseif (!method_exists('Illuminate\Database\Eloquent\Model', $method) } elseif (!method_exists('Eloquent', $method) && !Str::startsWith($method, 'get')) {
&& !Str::startsWith($method, 'get')
) {
//Use reflection to inspect the code, based on Illuminate/Support/SerializableClosure.php //Use reflection to inspect the code, based on Illuminate/Support/SerializableClosure.php
$reflection = new \ReflectionMethod($model, $method); $reflection = new \ReflectionMethod($model, $method);
@@ -352,53 +318,39 @@ class ModelsCommand extends Command
$code .= $file->current(); $code .= $file->current();
$file->next(); $file->next();
} }
$code = trim(preg_replace('/\s\s+/', '', $code));
$begin = strpos($code, 'function('); $begin = strpos($code, 'function(');
$code = substr($code, $begin, strrpos($code, '}') - $begin + 1); $code = substr($code, $begin, strrpos($code, '}') - $begin + 1);
foreach (array( foreach (array(
'hasMany', 'hasMany',
'hasManyThrough',
'belongsToMany', 'belongsToMany',
'hasOne', 'hasOne',
'belongsTo', 'belongsTo',
'morphOne',
'morphTo', 'morphTo',
'morphMany', 'morphMany',
'morphToMany' 'morphToMany'
) as $relation) { ) as $relation) {
$search = '$this->' . $relation . '('; $search = '$this->' . $relation . '(';
if ($pos = stripos($code, $search)) { if ($pos = stripos($code, $search)) {
//Resolve the relation's model to a Relation object. $code = substr($code, $pos + strlen($search));
$relationObj = $model->$method(); $arguments = explode(',', substr($code, 0, strpos($code, ');')));
//Remove quotes, ensure 1 \ in front of the model
if ($relationObj instanceof Relation) { $returnModel = $this->getClassName($arguments[0], $model);
$relatedModel = '\\' . get_class($relationObj->getRelated()); if ($relation === "belongsToMany" or $relation === 'hasMany' or $relation === 'morphMany' or $relation === 'morphToMany') {
$relations = ['hasManyThrough', 'belongsToMany', 'hasMany', 'morphMany', 'morphToMany'];
if (in_array($relation, $relations)) {
//Collection or array of models (because Collection is Arrayable) //Collection or array of models (because Collection is Arrayable)
$this->setProperty( $this->setProperty(
$method, $method,
$this->getCollectionClass($relatedModel) . '|' . $relatedModel . '[]', '\Illuminate\Database\Eloquent\Collection|' . $returnModel . '[]',
true,
null
);
} elseif ($relation === "morphTo") {
// Model isn't specified because relation is polymorphic
$this->setProperty(
$method,
'\Illuminate\Database\Eloquent\Model|\Eloquent',
true, true,
null null
); );
} else { } else {
//Single model is returned //Single model is returned
$this->setProperty($method, $relatedModel, true, null); $this->setProperty($method, $returnModel, true, null);
}
} }
} }
} }
} }
} }
} }
@@ -433,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;
@@ -487,8 +437,7 @@ class ModelsCommand extends Command
} else { } else {
$attr = 'property-read'; $attr = 'property-read';
} }
$tagLine = trim("@{$attr} {$property['type']} {$name} {$property['comment']}"); $tag = Tag::createInstance("@{$attr} {$property['type']} {$name} {$property['comment']}", $phpdoc);
$tag = Tag::createInstance($tagLine, $phpdoc);
$phpdoc->appendTag($tag); $phpdoc->appendTag($tag);
} }
@@ -501,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);
@@ -512,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 {
@@ -523,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\tclass {$classname} extends \Eloquent {}\n}\n\n"; $output = "namespace {$namespace}{\n{$docComment}\n\tclass {$classname} {}\n}\n\n";
return $output; return $output;
} }
@@ -543,11 +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) {
$paramStr = '$' . $param->getName(); $paramStr = '$' . $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';
@@ -568,22 +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
* @param \Illuminate\Database\Eloquent\Model $model
* @return string * @return string
*/ */
private function getCollectionClass($className) private function getClassName($className, $model)
{ {
// Return something in the very very unlikely scenario the model doesn't // If the class name was resolved via get_class($this) or static::class
// have a newCollection() method. if (strpos($className, 'get_class($this)') !== false || strpos($className, 'static::class') !== false) {
if (!method_exists($className, 'newCollection')) { return get_class($model);
return '\Illuminate\Database\Eloquent\Collection';
} }
/** @var \Illuminate\Database\Eloquent\Model $model */ // If the class name was resolved via ::class (PHP 5.5+)
$model = new $className; if (strpos($className, '::class') !== false) {
return '\\' . get_class($model->newCollection()); $end = -1 * strlen('::class');
return substr($className, 0, $end);
}
return "\\" . ltrim(trim($className, " \"'"), "\\") ;
} }
} }
+15 -82
View File
@@ -10,10 +10,8 @@
namespace Barryvdh\LaravelIdeHelper; namespace Barryvdh\LaravelIdeHelper;
use Illuminate\Foundation\Application;
use Illuminate\Foundation\AliasLoader; use Illuminate\Foundation\AliasLoader;
use Illuminate\Config\Repository as ConfigRepository; use Illuminate\Config\Repository as ConfigRepository;
use ReflectionClass;
use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Console\Output\OutputInterface;
class Generator class Generator
@@ -38,8 +36,7 @@ class Generator
* @param \Symfony\Component\Console\Output\OutputInterface $output * @param \Symfony\Component\Console\Output\OutputInterface $output
* @param string $helpers * @param string $helpers
*/ */
public function __construct( public function __construct(ConfigRepository $config,
/*ConfigRepository */ $config,
/* Illuminate\View\Factory */ $view, /* Illuminate\View\Factory */ $view,
OutputInterface $output = null, OutputInterface $output = null,
$helpers = '' $helpers = ''
@@ -50,9 +47,9 @@ class Generator
// Find the drivers to add to the extra/interfaces // Find the drivers to add to the extra/interfaces
$this->detectDrivers(); $this->detectDrivers();
$this->extra = array_merge($this->extra, $this->config->get('ide-helper.extra')); $this->extra = array_merge($this->extra, $this->config->get('laravel-ide-helper::extra'));
$this->magic = array_merge($this->magic, $this->config->get('ide-helper.magic')); $this->magic = array_merge($this->magic, $this->config->get('laravel-ide-helper::magic'));
$this->interfaces = array_merge($this->interfaces, $this->config->get('ide-helper.interfaces')); $this->interfaces = array_merge($this->interfaces, $this->config->get('laravel-ide-helper::interfaces'));
// Make all interface classes absolute // Make all interface classes absolute
foreach ($this->interfaces as &$interface) { foreach ($this->interfaces as &$interface) {
$interface = '\\' . ltrim($interface, '\\'); $interface = '\\' . ltrim($interface, '\\');
@@ -80,10 +77,10 @@ class Generator
public function generatePhpHelper() public function generatePhpHelper()
{ {
$app = app(); $app = app();
return $this->view->make('ide-helper::helper') return $this->view->make('laravel-ide-helper::ide-helper')
->with('namespaces', $this->getNamespaces()) ->with('namespaces', $this->getNamespaces())
->with('helpers', $this->helpers) ->with('helpers', $this->helpers)
->with('version', $app->version()) ->with('version', $app::VERSION)
->render(); ->render();
} }
@@ -116,26 +113,13 @@ class Generator
protected function detectDrivers() protected function detectDrivers()
{ {
$defaultUserModel = config('auth.providers.users.model', config('auth.model', 'App\User'));
$this->interfaces['\Illuminate\Contracts\Auth\Authenticatable'] = $defaultUserModel;
try{ try{
if (class_exists('Auth') && is_a('Auth', '\Illuminate\Support\Facades\Auth', true)) { if (class_exists('Auth') && is_a('Auth', '\Illuminate\Support\Facades\Auth', true)) {
if (class_exists('\Illuminate\Foundation\Application')) { $class = get_class(\Auth::driver());
$authMethod = version_compare(Application::VERSION, '5.2', '>=') ? 'guard' : 'driver';
} else {
$refClass = new ReflectionClass('\Laravel\Lumen\Application');
$versionStr = $refClass->newInstanceWithoutConstructor()->version();
$authMethod = strpos($versionStr, 'Lumen (5.0') === 0 ?
'driver' :
(strpos($versionStr, 'Lumen (5.1') === 0 ? 'driver' : 'guard');
}
$class = get_class(\Auth::$authMethod());
$this->extra['Auth'] = array($class); $this->extra['Auth'] = array($class);
$this->interfaces['\Illuminate\Auth\UserProviderInterface'] = $class; $this->interfaces['\Illuminate\Auth\UserProviderInterface'] = $class;
} }
} catch (\Exception $e) { }catch (\Exception $e) {}
}
try{ try{
if (class_exists('DB') && is_a('DB', '\Illuminate\Support\Facades\DB', true)) { if (class_exists('DB') && is_a('DB', '\Illuminate\Support\Facades\DB', true)) {
@@ -143,8 +127,7 @@ class Generator
$this->extra['DB'] = array($class); $this->extra['DB'] = array($class);
$this->interfaces['\Illuminate\Database\ConnectionInterface'] = $class; $this->interfaces['\Illuminate\Database\ConnectionInterface'] = $class;
} }
} catch (\Exception $e) { }catch (\Exception $e) {}
}
try{ try{
if (class_exists('Cache') && is_a('Cache', '\Illuminate\Support\Facades\Cache', true)) { if (class_exists('Cache') && is_a('Cache', '\Illuminate\Support\Facades\Cache', true)) {
@@ -153,8 +136,7 @@ class Generator
$this->extra['Cache'] = array($driver, $store); $this->extra['Cache'] = array($driver, $store);
$this->interfaces['\Illuminate\Cache\StoreInterface'] = $store; $this->interfaces['\Illuminate\Cache\StoreInterface'] = $store;
} }
} catch (\Exception $e) { }catch (\Exception $e) {}
}
try{ try{
if (class_exists('Queue') && is_a('Queue', '\Illuminate\Support\Facades\Queue', true)) { if (class_exists('Queue') && is_a('Queue', '\Illuminate\Support\Facades\Queue', true)) {
@@ -162,8 +144,7 @@ class Generator
$this->extra['Queue'] = array($class); $this->extra['Queue'] = array($class);
$this->interfaces['\Illuminate\Queue\QueueInterface'] = $class; $this->interfaces['\Illuminate\Queue\QueueInterface'] = $class;
} }
} catch (\Exception $e) { }catch (\Exception $e) {}
}
try{ try{
if (class_exists('SSH') && is_a('SSH', '\Illuminate\Support\Facades\SSH', true)){ if (class_exists('SSH') && is_a('SSH', '\Illuminate\Support\Facades\SSH', true)){
@@ -171,17 +152,7 @@ class Generator
$this->extra['SSH'] = array($class); $this->extra['SSH'] = array($class);
$this->interfaces['\Illuminate\Remote\ConnectionInterface'] = $class; $this->interfaces['\Illuminate\Remote\ConnectionInterface'] = $class;
} }
} catch (\Exception $e) { }catch (\Exception $e) {}
}
try {
if (class_exists('Storage') && is_a('Storage', '\Illuminate\Support\Facades\Storage', true)) {
$class = get_class(\Storage::disk());
$this->extra['Storage'] = array($class);
$this->interfaces['\Illuminate\Contracts\Filesystem\Filesystem'] = $class;
}
} catch (\Exception $e) {
}
} }
@@ -195,15 +166,11 @@ class Generator
$namespaces = array(); $namespaces = array();
// Get all aliases // Get all aliases
foreach ($this->getAliases() as $name => $facade) { foreach (AliasLoader::getInstance()->getAliases() as $name => $facade) {
// Skip the Redis facade, if not available (otherwise Fatal PHP Error)
if ($facade == 'Illuminate\Support\Facades\Redis' && !class_exists('Predis\Client')) {
continue;
}
$magicMethods = array_key_exists($name, $this->magic) ? $this->magic[$name] : array(); $magicMethods = array_key_exists($name, $this->magic) ? $this->magic[$name] : array();
$alias = new Alias($name, $facade, $magicMethods, $this->interfaces); $alias = new Alias($name, $facade, $magicMethods, $this->interfaces);
if ($alias->isValid()) { if ($alias->isValid()) {
//Add extra methods, from other classes (magic static calls) //Add extra methods, from other classes (magic static calls)
if (array_key_exists($name, $this->extra)) { if (array_key_exists($name, $this->extra)) {
$alias->addClass($this->extra[$name]); $alias->addClass($this->extra[$name]);
@@ -215,46 +182,12 @@ class Generator
} }
$namespaces[$namespace][] = $alias; $namespaces[$namespace][] = $alias;
} }
} }
return $namespaces; return $namespaces;
} }
protected function getAliases()
{
// For Laravel, use the AliasLoader
if (class_exists('Illuminate\Foundation\AliasLoader')) {
return AliasLoader::getInstance()->getAliases();
}
$facades = [
'App' => 'Illuminate\Support\Facades\App',
'Auth' => 'Illuminate\Support\Facades\Auth',
'Bus' => 'Illuminate\Support\Facades\Bus',
'DB' => 'Illuminate\Support\Facades\DB',
'Cache' => 'Illuminate\Support\Facades\Cache',
'Cookie' => 'Illuminate\Support\Facades\Cookie',
'Crypt' => 'Illuminate\Support\Facades\Crypt',
'Event' => 'Illuminate\Support\Facades\Event',
'Hash' => 'Illuminate\Support\Facades\Hash',
'Log' => 'Illuminate\Support\Facades\Log',
'Mail' => 'Illuminate\Support\Facades\Mail',
'Queue' => 'Illuminate\Support\Facades\Queue',
'Request' => 'Illuminate\Support\Facades\Request',
'Schema' => 'Illuminate\Support\Facades\Schema',
'Session' => 'Illuminate\Support\Facades\Session',
'Storage' => 'Illuminate\Support\Facades\Storage',
//'Validator' => 'Illuminate\Support\Facades\Validator',
];
$facades = array_merge($facades, $this->config->get('app.aliases', []));
// Only return the ones that actually exist
return array_filter($facades, function ($alias) {
return class_exists($alias);
});
}
/** /**
* Get the driver/connection/store from the managers * Get the driver/connection/store from the managers
* *
+36 -15
View File
@@ -32,16 +32,7 @@ class IdeHelperServiceProvider extends ServiceProvider
*/ */
public function boot() public function boot()
{ {
$viewPath = __DIR__.'/../resources/views'; $this->package('barryvdh/laravel-ide-helper', 'laravel-ide-helper', __DIR__);
$this->loadViewsFrom($viewPath, 'ide-helper');
$configPath = __DIR__ . '/../config/ide-helper.php';
if (function_exists('config_path')) {
$publishPath = config_path('ide-helper.php');
} else {
$publishPath = base_path('config/ide-helper.php');
}
$this->publishes([$configPath => $publishPath], 'config');
} }
/** /**
@@ -51,9 +42,6 @@ class IdeHelperServiceProvider extends ServiceProvider
*/ */
public function register() public function register()
{ {
$configPath = __DIR__ . '/../config/ide-helper.php';
$this->mergeConfigFrom($configPath, 'ide-helper');
$this->app['command.ide-helper.generate'] = $this->app->share( $this->app['command.ide-helper.generate'] = $this->app->share(
function ($app) { function ($app) {
return new GeneratorCommand($app['config'], $app['files'], $app['view']); return new GeneratorCommand($app['config'], $app['files'], $app['view']);
@@ -61,8 +49,8 @@ class IdeHelperServiceProvider extends ServiceProvider
); );
$this->app['command.ide-helper.models'] = $this->app->share( $this->app['command.ide-helper.models'] = $this->app->share(
function ($app) { function () {
return new ModelsCommand($app['files']); return new ModelsCommand();
} }
); );
@@ -84,4 +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');
} }
/**
* Register the package's component namespaces.
*
* @param string $package
* @param string $namespace
* @param string $path
* @return void
*/
public function package($package, $namespace = null, $path = null)
{
// 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');
}
} }
+10 -13
View File
@@ -10,16 +10,16 @@
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 */
@@ -36,7 +36,7 @@ class Method
/** /**
* @param \ReflectionMethod $method * @param \ReflectionMethod $method
* @param string $alias * @param string $alias
* @param \ReflectionClass $class * @param string $class
* @param string|null $methodName * @param string|null $methodName
* @param array $interfaces * @param array $interfaces
*/ */
@@ -55,8 +55,7 @@ class Method
$this->normalizeParams($this->phpdoc); $this->normalizeParams($this->phpdoc);
$this->normalizeReturn($this->phpdoc); $this->normalizeReturn($this->phpdoc);
$this->normalizeDescription($this->phpdoc); $this->normalizeDescription($this->phpdoc);
} catch (\Exception $e) { } catch (\Exception $e) {}
}
//Get the parameters, including formatted default values //Get the parameters, including formatted default values
$this->getParameters($method); $this->getParameters($method);
@@ -250,7 +249,7 @@ class Method
/** /**
* Get the parameters and format them correctly * Get the parameters and format them correctly
* *
* @param \ReflectionMethod $method * @param $method
* @return array * @return array
*/ */
public function getParameters($method) public function getParameters($method)
@@ -271,8 +270,6 @@ class Method
$default = 'null'; $default = 'null';
} elseif (is_int($default)) { } elseif (is_int($default)) {
//$default = $default; //$default = $default;
} elseif (is_resource($default)) {
//skip to not fail
} else { } else {
$default = "'" . trim($default) . "'"; $default = "'" . trim($default) . "'";
} }
@@ -1,5 +1,7 @@
<?php <?php
use Illuminate\Support\Facades\Config;
return array( return array(
/* /*
@@ -41,7 +43,7 @@ return array(
*/ */
'model_locations' => array( 'model_locations' => array(
'app', 'app/models',
), ),
@@ -55,6 +57,7 @@ return array(
*/ */
'extra' => array( 'extra' => array(
'Artisan' => array('Illuminate\Foundation\Artisan'),
'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'), 'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
'Session' => array('Illuminate\Session\Store'), 'Session' => array('Illuminate\Session\Store'),
), ),
@@ -83,37 +86,7 @@ return array(
*/ */
'interfaces' => array( 'interfaces' => array(
'\Illuminate\Auth\UserInterface' => Config::get('auth.model', 'User'),
), )
/*
|--------------------------------------------------------------------------
| Support for custom DB types
|--------------------------------------------------------------------------
|
| This setting allow you to map any custom database type (that you may have
| created using CREATE TYPE statement or imported using database plugin
| / extension to a Doctrine type.
|
| Each key in this array is a name of the Doctrine2 DBAL Platform. Currently valid names are:
| 'postgresql', 'db2', 'drizzle', 'mysql', 'oracle', 'sqlanywhere', 'sqlite', 'mssql'
|
| This name is returned by getName() method of the specific Doctrine/DBAL/Platforms/AbstractPlatform descendant
|
| The value of the array is an array of type mappings. Key is the name of the custom type,
| (for example, "jsonb" from Postgres 9.4) and the value is the name of the corresponding Doctrine2 type (in
| our case it is 'json_array'. Doctrine types are listed here:
| http://doctrine-dbal.readthedocs.org/en/latest/reference/types.html
|
| So to support jsonb in your models when working with Postgres, just add the following entry to the array below:
|
| "postgresql" => array(
| "jsonb" => "json_array",
| ),
|
*/
'custom_db_types' => array(
),
); );
@@ -1,7 +1,7 @@
<?= '<?php' ?> <?= '<?php' ?>
/** /**
* A helper file for Laravel 5, to provide autocomplete information to your IDE * An helper file for Laravel 4, to provide autocomplete information to your IDE
* Generated for Laravel <?= $version ?> on <?= date("Y-m-d") ?>. * Generated for Laravel <?= $version ?> on <?= date("Y-m-d") ?>.
* *
* @author Barry vd. Heuvel <barryvdh@gmail.com> * @author Barry vd. Heuvel <barryvdh@gmail.com>
@@ -1,6 +1,4 @@
<?= '<?php' ?> <?= '<?php' ?> namespace PHPSTORM_META {
namespace PHPSTORM_META {
/** /**
* PhpStorm Meta file, to provide autocomplete information for PhpStorm * PhpStorm Meta file, to provide autocomplete information for PhpStorm
@@ -8,11 +6,12 @@ namespace PHPSTORM_META {
* *
* @author Barry vd. Heuvel <barryvdh@gmail.com> * @author Barry vd. Heuvel <barryvdh@gmail.com>
* @see https://github.com/barryvdh/laravel-ide-helper * @see https://github.com/barryvdh/laravel-ide-helper
* @noinspection PhpUnusedLocalVariableInspection
* @noinspection PhpIllegalArrayKeyTypeInspection
*/ */
$STATIC_METHOD_TYPES = [ $STATIC_METHOD_TYPES = [
<?php foreach($methods as $method): ?> <?php foreach($methods as $method): ?>
<?= $method ?> => [ <?= $method ?>('') => [
'' == '@',
<?php foreach($bindings as $abstract => $class): ?> <?php foreach($bindings as $abstract => $class): ?>
'<?= $abstract ?>' instanceof \<?= $class ?>, '<?= $abstract ?>' instanceof \<?= $class ?>,
<?php endforeach ?> ], <?php endforeach ?> ],
-58
View File
@@ -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;
}
}