Compare commits

..
34 Commits
Author SHA1 Message Date
Barry vd. Heuvel d8d5517f2c Tweak @noinspection 2015-03-17 09:00:28 +01:00
Barry vd. Heuvel f518de4ae1 Filter abstracts for common errors
Fixes #184
2015-03-17 08:57:14 +01:00
Barry vd. Heuvel a89273d7ad Add non-static 2015-03-16 14:56:44 +01:00
Barry vd. Heuvel d9004f98cc Update readme 2015-03-16 14:55:13 +01:00
Barry vd. Heuvel 765a274c05 More methods 2015-03-16 14:26:28 +01:00
Barry vd. Heuvel b6a5262f3b TWeak meta methods 2015-03-16 14:14:57 +01:00
Barry vd. Heuvel d922d7e7ce Add actual command 2015-03-16 13:13:00 +01:00
Barry vd. Heuvel 89240e3ceb Add gist 2015-03-16 13:05:56 +01:00
Barry vd. Heuvel d9077b753c Note about missing classes. 2015-03-16 13:01:21 +01:00
Barry vd. Heuvel 683ed695a5 Fix views 2015-03-16 12:59:27 +01:00
Barry vd. Heuvel f8c4d4e77a Fix class imports 2015-03-16 12:52:48 +01:00
Barry vd. Heuvel b1a4494b1c Add note about meta file 2015-03-16 12:40:17 +01:00
Barry vd. Heuvel 70c06f5b37 Add meta command for phpstorm 2015-03-16 12:14:15 +01:00
Barry vd. Heuvel 81b7febfc6 Merge pull request #175 from robgeorgeuk/patch-1
New publish config syntax for Laravel 5
2015-02-23 16:55:54 +01:00
Rob George 208043b56f New publish config syntax for Laravel 5 2015-02-23 15:45:25 +00:00
Barry vd. Heuvel 4cd891eadc Merge pull request #169 from mattwells/master
Authenticatable Contract for User model
2015-02-17 13:55:39 +01:00
Matt Wells 7917ba911f Authenticatable Contract for User model 2015-02-17 10:54:52 +00:00
Barry vd. Heuvel 1f5e436d00 Merge pull request #167 from Flynsarmy/octoberConfig
Add support for October CMS config
2015-02-12 10:50:01 +01:00
flynsarmy fb3280eaff Add support for October CMS config 2015-02-12 19:03:29 +10:00
Barry vd. Heuvel 800ac05377 Revert
wrong branch
2015-02-07 23:18:26 +01:00
Barry vd. Heuvel 50059faa6f Add constraint
Fixes #164
2015-02-07 23:10:38 +01:00
Barry vd. Heuvel bb8d0169ba Merge pull request #162 from claar/patch-1
Bump L4 version number
2015-02-05 18:11:23 +01:00
Ben Claar fe692a4e77 Bump L4 version number 2015-02-05 11:03:19 -06:00
Barry vd. Heuvel c3a622fcc9 Rename 1.8 branch 2015-02-05 09:11:12 +01:00
Barry vd. Heuvel 317ef794a5 Check for correct facades 2015-02-04 09:12:01 +01:00
Barry vd. Heuvel 5c846ca16a Merge pull request #155 from Flynsarmy/authMethodExists
Check for driver method on Auth facade
2015-02-04 07:41:52 +01:00
Barry vd. Heuvel 1d4df779d8 Update branches 2015-02-03 21:01:58 +01:00
Barry vd. Heuvel 8f0d346eaa Tweak config 2015-02-03 20:57:49 +01:00
Barry vd. Heuvel 73003c0bea Swap resource arguments 2015-01-29 08:13:38 +01:00
Barry vd. Heuvel f12c785688 Skip Redis if not available 2015-01-28 10:04:48 +01:00
Barry vd. Heuvel c0aaabb6d7 Update config 2015-01-28 10:02:50 +01:00
Barry vd. Heuvel 1e6752a29f Update readme 2015-01-28 09:38:57 +01:00
Barry vd. Heuvel ab50c245d0 Update config/resources for L5 2015-01-28 09:34:45 +01:00
flynsarmy ab85ca4c5a Check for driver method on Auth facade 2015-01-28 14:31:20 +10:00
21 changed files with 1116 additions and 1488 deletions
+1 -1
View File
@@ -1,3 +1,3 @@
/vendor /vendor
composer.lock composer.lock
.idea/ .idea
-26
View File
@@ -1,26 +0,0 @@
language: php
php:
- 5.4
- 5.5
- 5.6
- hhvm
matrix:
include:
- php: 5.3
dist: precise
allow_failures:
- php: hhvm
fast_finish: true
cache:
directories:
- vendor
- $HOME/.composer/cache
before_script:
- travis_retry composer self-update
- travis_retry composer install --no-interaction --no-suggest --no-progress
script:
- vendor/bin/phpunit
+7 -11
View File
@@ -10,19 +10,15 @@
} }
], ],
"require": { "require": {
"php": ">=5.3.0", "php": ">=5.4.0",
"illuminate/config": "4.x", "illuminate/support": "5.0.x",
"illuminate/support": "4.x", "illuminate/console": "5.0.x",
"illuminate/console": "4.x", "illuminate/filesystem": "5.0.x",
"illuminate/filesystem": "4.x", "phpdocumentor/reflection-docblock": "2.0.x",
"illuminate/database": "4.x",
"illuminate/view": "4.x",
"phpdocumentor/reflection-docblock": "^2.0.4",
"symfony/class-loader": "~2.3" "symfony/class-loader": "~2.3"
}, },
"require-dev": { "require-dev": {
"doctrine/dbal": "~2.3", "doctrine/dbal": "~2.3"
"phpunit/phpunit": "~4.0"
}, },
"suggest": { "suggest": {
"doctrine/dbal": "Load information from the database about models for phpdocs (~2.3)" "doctrine/dbal": "Load information from the database about models for phpdocs (~2.3)"
@@ -34,7 +30,7 @@
}, },
"extra": { "extra": {
"branch-alias": { "branch-alias": {
"dev-master": "1.11-dev" "dev-master": "2.0-dev"
} }
} }
} }
@@ -1,7 +1,5 @@
<?php <?php
use Illuminate\Support\Facades\Config;
return array( return array(
/* /*
@@ -43,7 +41,7 @@ return array(
*/ */
'model_locations' => array( 'model_locations' => array(
'app/models', 'app',
), ),
@@ -57,7 +55,6 @@ return array(
*/ */
'extra' => array( 'extra' => array(
'Artisan' => array('Illuminate\Foundation\Artisan'),
'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'), 'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
'Session' => array('Illuminate\Session\Store'), 'Session' => array('Illuminate\Session\Store'),
), ),
@@ -86,7 +83,7 @@ return array(
*/ */
'interfaces' => array( 'interfaces' => array(
'\Illuminate\Auth\UserInterface' => Config::get('auth.model', 'User'), '\Illuminate\Contracts\Auth\Authenticatable' => config('auth.model', 'App\User'),
) )
); );
-18
View File
@@ -1,18 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/4.0/phpunit.xsd"
backupGlobals="false"
backupStaticAttributes="false"
bootstrap="vendor/autoload.php"
colors="true"
convertErrorsToExceptions="true"
convertNoticesToExceptions="true"
convertWarningsToExceptions="true"
processIsolation="false"
stopOnFailure="false">
<testsuites>
<testsuite name="Package Test Suite">
<directory suffix=".php">./tests/</directory>
</testsuite>
</testsuites>
</phpunit>
-5
View File
@@ -1,5 +0,0 @@
{
"providers": [
"Barryvdh\\LaravelIdeHelper\\IdeHelperServiceProvider"
]
}
+41 -62
View File
@@ -1,13 +1,13 @@
## Laravel IDE Helper Generator ## Laravel 5 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 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)
### For Laravel 5, check the [2.0 branch](https://github.com/barryvdh/laravel-ide-helper) ### For Laravel 4.x, check [version 1.11](https://github.com/barryvdh/laravel-ide-helper/tree/1.11)
### Complete phpDocs, directly from the source ### Complete phpDocs, directly from the source
_Checkout [this Laracasts video](https://laracasts.com/series/how-to-be-awesome-in-phpstorm/episodes/15) for a quick introduction/explanation!_ _Checkout [this Laracasts video](https://laracasts.com/series/how-to-be-awesome-in-phpstorm/episodes/15) for a quick introduction/explanation!_
This packages generates a file that your IDE can understand, so it can provide accurate autocompletion. Generation is done, based on the files in your project, so they are always up-to-date. 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.
If you don't want to generate it, you can add a pre-generated file to the root folder of your laravel project. (But this isn't as up-to-date as self generated files) If you don't want to generate it, you can add a pre-generated file to the root folder of your laravel project. (But this isn't as up-to-date as self generated files)
* Generated version: https://gist.github.com/barryvdh/5227822 * Generated version: https://gist.github.com/barryvdh/5227822
@@ -18,60 +18,48 @@ Note: You do need CodeIntel for Sublime Text: https://github.com/SublimeCodeInte
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. It's possible to generate a PhpStorm meta file, to [add support for factory design pattern](https://confluence.jetbrains.com/display/PhpStorm/PhpStorm+Advanced+Metadata). For Laravel, this means we can make PhpStorm understand what kind of object we are resolving from the IoC Container. For example, `events` will return ann `Illuminate\Events\Dispatcher` object, so with the meta file you can call `app('events')` and it will autocomplete the Dispatcher methods.
```bash php artisan ide-helper:meta
php artisan ide-helper:meta
```
```php
app('events')->fire();
\App::make('events')->fire();
/** @var \Illuminate\Foundation\Application $app */ app('events')->fire();
$app->make('events')->fire(); \App::make('events')->fire();
```
/** @var \Illuminate\Foundation\Application $app */
$app->make('events')->fire();
Pre-generated example: https://gist.github.com/barryvdh/bb6ffc5d11e0a75dba67 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: You might need to restart PhpStorm and make sure `.phpstorm.meta.php` is indexed.
> Note: When you receive a FatalException about a class that is not found, check your config (For example, remove S3 as cloud driver when you don't have S3 configured. Remove Redis ServiceProvider when you don't use it.)
### Automatic phpDoc generation for Laravel Facades ### Automatic phpDoc generation for Laravel Facades
Require this package with composer using the following command: Require this package with composer using the following command:
```bash composer require barryvdh/laravel-ide-helper
composer require barryvdh/laravel-ide-helper ~1.11
```
After updating composer, add the ServiceProvider to the providers array in `app/config/app.php` After updating composer, add the ServiceProvider to the providers array in config/app.php
```php 'Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider',
'Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider',
```
You can now re-generate the docs yourself (for future updates) in artisan 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:
```json "scripts":{
"scripts":{ "post-update-cmd":[
"post-update-cmd":[ "php artisan clear-compiled",
"php artisan clear-compiled", "php artisan ide-helper:generate",
"php artisan ide-helper:generate", "php artisan optimize"
"php artisan optimize" ]
] },
},
```
You can also publish the config-file to change implementations (ie. interface to specific class) or set defaults for --helpers or --sublime. You can also publish the config-file to change implementations (ie. interface to specific class) or set defaults for --helpers or --sublime.
```bash php artisan vendor:publish --provider=barryvdh/laravel-ide-helper --tag=config
php artisan config:publish barryvdh/laravel-ide-helper
```
The generator tries to identify the real class, but if it cannot be found, you can define it in the config file. The generator tries to identify the real class, but if it cannot be found, you can define it in the config file.
@@ -83,7 +71,7 @@ The Illuminate/Support/helpers.php is already set-up, but you can add/remove you
### Automatic phpDocs for Models ### Automatic phpDocs for Models
> **Note:** Since v1.10 you need to require `doctrine/dbal: ~2.3` in your own composer.json. > You need to require `doctrine/dbal: ~2.3` in your own composer.json to get database columns.
If you don't want to write your properties yourself, you can use the command `ide-helper:models` to generate If you don't want to write your properties yourself, you can use the command `ide-helper:models` to generate
phpDocs, based on table columns, relations and getters/setters. You can write the comments directly to your Model file, using the `--write (-W)` option. By default, you are asked to overwrite or write to a separate file (\_ide\_helper\_models.php) (You can force No with `--nowrite (-N)`). 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)`).
@@ -91,43 +79,34 @@ Please make sure to backup your models, before writing the info.
It should keep the existing comments and only append new properties/methods. The existing phpdoc is replaced, or added if not found. It should keep the existing comments and only append new properties/methods. The existing phpdoc is replaced, or added if not found.
With the `--reset (-R)` option, the existing phpdocs are ignored, only the newly found columns/relations are saved as phpdocs. With the `--reset (-R)` option, the existing phpdocs are ignored, 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 $author_id
* @property integer $id * @property string $title
* @property integer $author_id * @property string $text
* @property string $title * @property \Carbon\Carbon $created_at
* @property string $text * @property \Carbon\Carbon $updated_at
* @property \Carbon\Carbon $created_at * @property-read \User $author
* @property \Carbon\Carbon $updated_at * @property-read \Illuminate\Database\Eloquent\Collection|\Comment[] $comments
* @property-read \User $author */
* @property-read \Illuminate\Database\Eloquent\Collection|\Comment[] $comments
*/
```
By default, models in app/models are scanned. The optional argument tells what models to use (also outside app/models). By default, models in app/models are scanned. The optional argument tells what models to use (also outside app/models).
```bash php artisan ide-helper:models Post User
php artisan ide-helper:models Post User
```
You can also scan a different directory, using the --dir option (relative from the base path): You can also scan a different directory, using the --dir option (relative from the base path):
```bash php artisan ide-helper:models --dir="path/to/models" --dir="app/src/Model"
php artisan ide-helper:models --dir="app/workbench/name/package/models" --dir="app/src/Model"
```
You can publish the config file (`php artisan config:publish barryvdh/laravel-ide-helper`) and set the default directories. You can publish the config file (`php artisan vendor:publish`) and set the default directories.
Models can be ignored using the --ignore (-I) option Models can be ignored using the --ignore (-I) option
```bash php artisan ide-helper:models --ignore="Post,User"
php artisan ide-helper:models --ignore="Post,User"
```
Note: With namespaces, wrap your model name in " signs: `php artisan ide-helper:models "API\User"`, or escape the slashes (`Api\\User`) Note: With namespaces, wrap your model name in " signs: `php artisan ide-helper:models "API\User"`, or escape the slashes (`Api\\User`)
+39
View File
@@ -0,0 +1,39 @@
<?= '<?php' ?>
/**
* An helper file for Laravel 5, to provide autocomplete information to your IDE
* Generated for Laravel <?= $version ?> on <?= date("Y-m-d") ?>.
*
* @author Barry vd. Heuvel <[email protected]>
* @see https://github.com/barryvdh/laravel-ide-helper
*/
<?php foreach($namespaces as $namespace => $aliases): ?>
namespace <?= $namespace == '__root' ? '' : $namespace ?>{
<?php if($namespace == '__root'): ?>
exit("This file should not be included, only analyzed by your IDE");
<?= $helpers ?>
<?php endif; ?>
<?php foreach($aliases as $alias): ?>
<?= $alias->getClassType() ?> <?= $alias->getShortName() ?> <?= $alias->getExtends() ? 'extends ' . $alias->getExtends() : '' ?>{
<?php foreach($alias->getMethods() as $method): ?>
<?= trim($method->getDocComment(' ')) ?>
public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>){<?php if($method->getDeclaringClass() !== $method->getRoot()): ?>
//Method inherited from <?= $method->getDeclaringClass() ?>
<?php endif; ?>
<?= $method->shouldReturn() ? 'return ': '' ?><?= $method->getRoot() ?>::<?= $method->getName() ?>(<?= $method->getParams() ?>);
}
<?php endforeach; ?>
}
<?php endforeach; ?>
}
<?php endforeach; ?>
+21
View File
@@ -0,0 +1,21 @@
<?= '<?php' ?> namespace PHPSTORM_META {
/**
* PhpStorm Meta file, to provide autocomplete information for PhpStorm
* Generated on <?= date("Y-m-d") ?>.
*
* @author Barry vd. Heuvel <[email protected]>
* @see https://github.com/barryvdh/laravel-ide-helper
*/
/** @noinspection PhpIllegalArrayKeyTypeInspection */
/** @noinspection PhpUnusedLocalVariableInspection */
$STATIC_METHOD_TYPES = [
<?php foreach($methods as $method): ?>
<?= $method ?>('') => [
<?php foreach($bindings as $abstract => $class): ?>
'<?= $abstract ?>' instanceof \<?= $class ?>,
<?php endforeach ?> ],
<?php endforeach ?>
];
}
+16 -19
View File
@@ -54,7 +54,7 @@ class Alias
$this->detectNamespace(); $this->detectNamespace();
$this->detectClassType(); $this->detectClassType();
if ($facade === '\Illuminate\Database\Eloquent\Model') { if($facade === '\Illuminate\Database\Eloquent\Model'){
$this->usedMethods = array('decrement', 'increment'); $this->usedMethods = array('decrement', 'increment');
} }
} }
@@ -70,8 +70,8 @@ class Alias
foreach ($classes as $class) { foreach ($classes as $class) {
if (class_exists($class) || interface_exists($class)) { if (class_exists($class) || interface_exists($class)) {
$this->classes[] = $class; $this->classes[] = $class;
} else { }else{
$this->error('Class not exists: ' . $class); echo "Class not exists: $class\r\n";
} }
} }
} }
@@ -86,11 +86,11 @@ class Alias
} }
/** /**
* Get the classType, 'interface' or 'class' * Get the classtype, 'interface' or 'class'
* *
* @return string * @return string
*/ */
public function getClassType() public function getClasstype()
{ {
return $this->classType; return $this->classType;
} }
@@ -117,14 +117,10 @@ class Alias
/** /**
* Return the short name (without namespace) * Return the short name (without namespace)
*
* @return string
*/ */
public function getShortName() public function getShortName(){
{
return $this->short; return $this->short;
} }
/** /**
* Get the namespace from the alias * Get the namespace from the alias
* *
@@ -138,7 +134,7 @@ class Alias
/** /**
* Get the methods found by this Alias * Get the methods found by this Alias
* *
* @return array|Method[] * @return array
*/ */
public function getMethods() public function getMethods()
{ {
@@ -156,7 +152,7 @@ class Alias
$nsParts = explode('\\', $this->alias); $nsParts = explode('\\', $this->alias);
$this->short = array_pop($nsParts); $this->short = array_pop($nsParts);
$this->namespace = implode('\\', $nsParts); $this->namespace = implode('\\', $nsParts);
} else { }else{
$this->short = $this->alias; $this->short = $this->alias;
} }
} }
@@ -205,10 +201,10 @@ class Alias
//When the database connection is not set, some classes will be skipped //When the database connection is not set, some classes will be skipped
} catch (\PDOException $e) { } catch (\PDOException $e) {
$this->error( $this->error(
'PDOException: ' . $e->getMessage() . "\nPlease configure your database connection correctly, or use the sqlite memory driver (-M). Skipping $facade." "PDOException: " . $e->getMessage() . "\nPlease configure your database connection correctly, or use the sqlite memory driver (-M). Skipping $facade."
); );
} catch (\Exception $e) { } catch (\Exception $e) {
$this->error('Exception: ' . $e->getMessage() . "\nSkipping $facade."); $this->error("Exception: " . $e->getMessage() . "\nSkipping $facade.");
} }
} }
@@ -231,16 +227,16 @@ class Alias
*/ */
protected function addMagicMethods() protected function addMagicMethods()
{ {
foreach ($this->magicMethods as $magic => $real) { foreach($this->magicMethods as $magic => $real){
list($className, $name) = explode('::', $real); list($className, $name) = explode('::', $real);
if (!class_exists($className) && !interface_exists($className)) { if(!class_exists($className) && !interface_exists($className)){
continue; continue;
} }
$method = new \ReflectionMethod($className, $name); $method = new \ReflectionMethod($className, $name);
$class = new \ReflectionClass($className); $class = new \ReflectionClass($className);
if (!in_array($method->name, $this->usedMethods)) { if(!in_array($method->name, $this->usedMethods)){
if ($class !== $this->root) { if($class !== $this->root){
$this->methods[] = new Method($method, $this->alias, $class, $magic, $this->interfaces); $this->methods[] = new Method($method, $this->alias, $class, $magic, $this->interfaces);
} }
$this->usedMethods[] = $magic; $this->usedMethods[] = $magic;
@@ -255,6 +251,7 @@ class Alias
*/ */
protected function detectMethods() protected function detectMethods()
{ {
foreach ($this->classes as $class) { foreach ($this->classes as $class) {
$reflection = new \ReflectionClass($class); $reflection = new \ReflectionClass($class);
@@ -277,7 +274,7 @@ class Alias
/** /**
* Output an error. * Output an error.
* *
* @param string $string * @param string $string
* @return void * @return void
*/ */
protected function error($string) protected function error($string)
+28 -14
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
* *
@@ -26,12 +27,16 @@ class GeneratorCommand extends Command
{ {
/** /**
* {@inheritdoc} * The console command name.
*
* @var string
*/ */
protected $name = 'ide-helper:generate'; protected $name = 'ide-helper:generate';
/** /**
* {@inheritdoc} * The console command description.
*
* @var string
*/ */
protected $description = 'Generate a new IDE Helper file.'; protected $description = 'Generate a new IDE Helper file.';
@@ -46,14 +51,18 @@ class GeneratorCommand extends Command
protected $onlyExtend; protected $onlyExtend;
/** /**
* {@inheritdoc}
* *
* @param \Illuminate\Config\Repository $config * @param \Illuminate\Config\Repository $config
* @param \Illuminate\Filesystem\Filesystem $files * @param \Illuminate\Filesystem\Filesystem $files
* @param \Illuminate\View\Factory $view * @param \Illuminate\View\Factory $view
*/ */
public function __construct(ConfigRepository $config, Filesystem $files, $view) { public function __construct(
/*ConfigRepository */ $config,
Filesystem $files, /* Illuminate\View\Factory */
$view
) {
$this->config = $config; $this->config = $config;
$this->files = $files; $this->files = $files;
$this->view = $view; $this->view = $view;
@@ -86,9 +95,10 @@ class GeneratorCommand extends Command
$this->useMemoryDriver(); $this->useMemoryDriver();
} }
$helpers = ''; $helpers = '';
if ($this->option('helpers') || ($this->config->get('laravel-ide-helper::include_helpers'))) { if ($this->option('helpers') || ($this->config->get('ide-helper.include_helpers'))) {
foreach ($this->config->get('laravel-ide-helper::helper_files', array()) as $helper) { foreach ($this->config->get('ide-helper.helper_files', array()) as $helper) {
if (file_exists($helper)) { if (file_exists($helper)) {
$helpers .= str_replace(array('<?php', '?>'), '', $this->files->get($helper)); $helpers .= str_replace(array('<?php', '?>'), '', $this->files->get($helper));
} }
@@ -123,11 +133,13 @@ class GeneratorCommand extends Command
} }
/** /**
* {@inheritdoc} * Get the console command arguments.
*
* @return array
*/ */
protected function getArguments() protected function getArguments()
{ {
$filename = $this->config->get('laravel-ide-helper::filename'); $filename = $this->config->get('ide-helper.filename');
return array( return array(
array( array(
@@ -137,17 +149,19 @@ class GeneratorCommand extends Command
} }
/** /**
* {@inheritdoc} * Get the console command options.
*
* @return array
*/ */
protected function getOptions() protected function getOptions()
{ {
$format = $this->config->get('laravel-ide-helper::format'); $format = $this->config->get('ide-helper.format');
return array( return array(
array('format', 'F', InputOption::VALUE_OPTIONAL, 'The format for the IDE Helper', $format), array('format', "F", InputOption::VALUE_OPTIONAL, 'The format for the IDE Helper', $format),
array('helpers', 'H', InputOption::VALUE_NONE, 'Include the helper files'), array('helpers', "H", InputOption::VALUE_NONE, 'Include the helper files'),
array('memory', 'M', InputOption::VALUE_NONE, 'Use sqlite memory driver'), array('memory', "M", InputOption::VALUE_NONE, 'Use sqlite memory driver'),
array('sublime', 'S', InputOption::VALUE_NONE, 'DEPRECATED: Use different style for SublimeText CodeIntel'), array('sublime', "S", InputOption::VALUE_NONE, 'DEPRECATED: Use different style for SublimeText CodeIntel'),
); );
} }
+44 -52
View File
@@ -17,45 +17,47 @@ use Symfony\Component\Console\Input\InputOption;
* A command to generate phpstorm meta data * A command to generate phpstorm meta data
* *
* @author Barry vd. Heuvel <[email protected]> * @author Barry vd. Heuvel <[email protected]>
* @property \Illuminate\Container\Container $laravel
*/ */
class MetaCommand extends Command { class MetaCommand extends Command {
/** /**
* {@inheritdoc} * The console command name.
*
* @var string
*/ */
protected $name = 'ide-helper:meta'; protected $name = 'ide-helper:meta';
protected $filename = '.phpstorm.meta.php'; protected $filename = '.phpstorm.meta.php';
/** /**
* {@inheritdoc} * The console command description.
*
* @var string
*/ */
protected $description = 'Generate metadata for PhpStorm'; protected $description = 'Generate metadata for PhpStorm';
/** @var \Illuminate\Filesystem\Filesystem */ /** @var \Illuminate\Contracts\Filesystem\Filesystem */
protected $files; protected $files;
/** @var \Illuminate\View\Factory */ /** @var \Illuminate\Contracts\View\Factory */
protected $view; protected $view;
protected $methods = array( protected $methods = [
//'\Illuminate\Foundation\Application::make', '\Illuminate\Foundation\Application::make',
'new \Illuminate\Container\Container', '\Illuminate\Contracts\Foundation\Application::make',
'\Illuminate\Container\Container::make', '\Illuminate\Contracts\Container\Container::make',
'\App::make', '\Illuminate\Container\Container::make',
'app', '\App::make',
); 'app',
];
/** /**
* {@inheritdoc}
* *
* @param \Illuminate\Container\Container $app * @param \Illuminate\Contracts\Filesystem\Filesystem $files
* @param \Illuminate\Contracts\View\Factory $view
*/ */
public function __construct($app) public function __construct($files, $view) {
{ $this->files = $files;
$this->laravel = $app; $this->view = $view;
$this->files = $app['files'];
$this->view = $app['view'];
parent::__construct(); parent::__construct();
} }
@@ -66,31 +68,22 @@ class MetaCommand extends Command {
*/ */
public function fire() public function fire()
{ {
$bindings = array_flip($this->getAppAliases()); $bindings = array();
$exclude = $this->option('exclude');
if (!empty($exclude)) {
$exclude = '/' . str_replace('\|', '|', preg_quote($exclude, '/')) . '/';
}
foreach ($this->getAbstracts() as $abstract) { foreach ($this->getAbstracts() as $abstract) {
if (!empty($exclude) && preg_match($exclude, $abstract))
continue;
try { try {
$concrete = $this->laravel->make($abstract); $concrete = $this->laravel->make($abstract);
if (is_object($concrete)) { if (is_object($concrete)) {
$bindings[$abstract] = get_class($concrete); $bindings[$abstract] = get_class($concrete);
} }
} catch (\Exception $e) { }catch (\Exception $e) {
$this->error("Cannot make $abstract: " . $e->getMessage()); $this->error("Cannot make $abstract: ".$e->getMessage());
} }
} }
asort($bindings);
$content = $this->view->make('laravel-ide-helper::meta', array( $content = $this->view->make('ide-helper::meta', [
'bindings' => $bindings, 'bindings' => $bindings,
'methods' => $this->methods, 'methods' => $this->methods,
))->render(); ])->render();
$filename = $this->option('filename'); $filename = $this->option('filename');
$written = $this->files->put($filename, $content); $written = $this->files->put($filename, $content);
@@ -103,38 +96,37 @@ class MetaCommand extends Command {
} }
/** /**
* Get a list of abstracts from the Laravel Application. * Get a filtered list of abstracts from the Laravel Application.
* *
* @return array * @return array
*/ */
protected function getAbstracts() protected function getAbstracts()
{ {
return array_keys($this->laravel->getBindings()); $abstracts = $this->laravel->getBindings();
// Remove the S3 cloud driver when not available
if (config('filesystems.cloud') === 's3' && !class_exists('League\Flysystem\AwsS3v2\AwsS3Adapter')) {
unset($abstracts['filesystem.cloud']);
}
// Remove Redis when not available
if (isset($abstracts['redis']) && !class_exists('Predis\Client')) {
unset($abstracts['redis']);
}
// Return the abstract names only
return array_keys($abstracts);
} }
/** /**
* Get a list of aliases from the Laravel Application. * Get the console command options.
* *
* @return array * @return array
*/ */
protected function getAppAliases()
{
static $aliasProp;
if (!isset($aliasProp)) {
$aliasProp = new \ReflectionProperty('Illuminate\Container\Container', 'aliases');
$aliasProp->setAccessible(true);
}
return $aliasProp->getValue($this->laravel);
}
/**
* {@inheritdoc}
*/
protected function getOptions() protected function getOptions()
{ {
return array( return array(
array('filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the meta file', $this->filename), array('filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the meta file', $this->filename),
array('exclude', 'E', InputOption::VALUE_OPTIONAL, 'Laravel bindings to exclude (e.g. "bar.|.foo")'),
); );
} }
} }
+65 -47
View File
@@ -18,24 +18,28 @@ use Symfony\Component\ClassLoader\ClassMapGenerator;
use phpDocumentor\Reflection\DocBlock; use phpDocumentor\Reflection\DocBlock;
use phpDocumentor\Reflection\DocBlock\Context; use phpDocumentor\Reflection\DocBlock\Context;
use phpDocumentor\Reflection\DocBlock\Tag; use phpDocumentor\Reflection\DocBlock\Tag;
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
* *
* @author Barry vd. Heuvel <[email protected]> * @author Barry vd. Heuvel <[email protected]>
* @property \Illuminate\Container\Container $laravel
*/ */
class ModelsCommand extends Command class ModelsCommand extends Command
{ {
/** /**
* {@inheritdoc} * The console command name.
*
* @var string
*/ */
protected $name = 'ide-helper:models'; protected $name = 'ide-helper:models';
protected $filename = '_ide_helper_models.php'; protected $filename = '_ide_helper_models.php';
/** /**
* {@inheritdoc} * The console command description.
*
* @var string
*/ */
protected $description = 'Generate autocompletion for models'; protected $description = 'Generate autocompletion for models';
@@ -45,20 +49,6 @@ class ModelsCommand extends Command
protected $dirs = array(); protected $dirs = array();
protected $reset; protected $reset;
/** @var \Illuminate\Filesystem\Filesystem */
protected $files;
/**
* {@inheritdoc}
*
* @param \Illuminate\Container\Container $app
*/
public function __construct($app)
{
$this->laravel = $app;
$this->files = $app['files'];
parent::__construct();
}
/** /**
* Execute the console command. * Execute the console command.
@@ -70,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('laravel-ide-helper::model_locations'), $this->laravel['config']->get('ide-helper.model_locations'),
$this->option('dir') $this->option('dir')
); );
$model = $this->argument('model'); $model = $this->argument('model');
@@ -79,7 +69,10 @@ class ModelsCommand extends Command
//If filename is default and Write is not specified, ask what to do //If filename is default and Write is not specified, ask what to do
if (!$this->write && $filename === $this->filename && !$this->option('nowrite')) { if (!$this->write && $filename === $this->filename && !$this->option('nowrite')) {
if ($this->confirm("Do you want to overwrite the existing model files? Choose no to write to $filename instead? (Yes/No): ")) { if ($this->confirm(
"Do you want to overwrite the existing model files? Choose no to write to $filename instead? (Yes/No): "
)
) {
$this->write = true; $this->write = true;
} }
} }
@@ -87,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 {
@@ -96,8 +89,11 @@ class ModelsCommand extends Command
} }
} }
/** /**
* {@inheritdoc} * Get the console command arguments.
*
* @return array
*/ */
protected function getArguments() protected function getArguments()
{ {
@@ -107,7 +103,9 @@ class ModelsCommand extends Command
} }
/** /**
* {@inheritdoc} * Get the console command options.
*
* @return array
*/ */
protected function getOptions() protected function getOptions()
{ {
@@ -123,6 +121,8 @@ class ModelsCommand extends Command
protected function generateDocs($loadModels, $ignore = '') protected function generateDocs($loadModels, $ignore = '')
{ {
$output = "<?php $output = "<?php
/** /**
* An helper file for your Eloquent Models * An helper file for your Eloquent Models
@@ -164,7 +164,7 @@ class ModelsCommand extends Command
$this->comment("Loading model '$name'"); $this->comment("Loading model '$name'");
if (!$reflectionClass->isInstantiable()) { if (!$reflectionClass->IsInstantiable()) {
throw new \Exception($name . ' is not instantiable.'); throw new \Exception($name . ' is not instantiable.');
} }
@@ -177,7 +177,7 @@ class ModelsCommand extends Command
$this->getPropertiesFromMethods($model); $this->getPropertiesFromMethods($model);
$output .= $this->createPhpDocs($name); $output .= $this->createPhpDocs($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.");
} }
} }
@@ -190,8 +190,10 @@ class ModelsCommand extends Command
} }
return $output; return $output;
} }
protected function loadModels() protected function loadModels()
{ {
$models = array(); $models = array();
@@ -257,7 +259,7 @@ class ModelsCommand extends Command
$comment = $column->getComment(); $comment = $column->getComment();
$this->setProperty($name, $type, true, true, $comment); $this->setProperty($name, $type, true, true, $comment);
$this->setMethod( $this->setMethod(
Str::camel('where_' . $name), Str::camel("where_" . $name),
'\Illuminate\Database\Query\Builder|\\' . get_class($model), '\Illuminate\Database\Query\Builder|\\' . get_class($model),
array('$value') array('$value')
); );
@@ -273,13 +275,21 @@ class ModelsCommand extends Command
$methods = get_class_methods($model); $methods = get_class_methods($model);
if ($methods) { if ($methods) {
foreach ($methods as $method) { foreach ($methods as $method) {
if (Str::startsWith($method, 'get') && Str::endsWith($method, 'Attribute') && $method !== 'getAttribute') { if (Str::startsWith($method, 'get') && Str::endsWith(
$method,
'Attribute'
) && $method !== 'getAttribute'
) {
//Magic get<name>Attribute //Magic get<name>Attribute
$name = Str::snake(substr($method, 3, -9)); $name = Str::snake(substr($method, 3, -9));
if (!empty($name)) { if (!empty($name)) {
$this->setProperty($name, null, true, null); $this->setProperty($name, null, true, null);
} }
} elseif (Str::startsWith($method, 'set') && Str::endsWith($method, 'Attribute') && $method !== 'setAttribute') { } elseif (Str::startsWith($method, 'set') && Str::endsWith(
$method,
'Attribute'
) && $method !== 'setAttribute'
) {
//Magic set<name>Attribute //Magic set<name>Attribute
$name = Str::snake(substr($method, 3, -9)); $name = Str::snake(substr($method, 3, -9));
if (!empty($name)) { if (!empty($name)) {
@@ -311,14 +321,22 @@ class ModelsCommand extends Command
$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('hasMany', 'belongsToMany', 'hasOne', 'belongsTo', 'morphTo', 'morphMany', 'morphToMany') as $relation) { foreach (array(
'hasMany',
'belongsToMany',
'hasOne',
'belongsTo',
'morphTo',
'morphMany',
'morphToMany'
) as $relation) {
$search = '$this->' . $relation . '('; $search = '$this->' . $relation . '(';
if ($pos = stripos($code, $search)) { if ($pos = stripos($code, $search)) {
$code = substr($code, $pos + strlen($search)); $code = substr($code, $pos + strlen($search));
$arguments = explode(',', substr($code, 0, strpos($code, ');'))); $arguments = explode(',', substr($code, 0, strpos($code, ');')));
//Remove quotes, ensure 1 \ in front of the model //Remove quotes, ensure 1 \ in front of the model
$returnModel = $this->getClassName($arguments[0], $model); $returnModel = $this->getClassName($arguments[0], $model);
if ($relation === 'belongsToMany' or $relation === 'hasMany' or $relation === 'morphMany' or $relation === 'morphToMany') { if ($relation === "belongsToMany" or $relation === 'hasMany' or $relation === 'morphMany' or $relation === 'morphToMany') {
//Collection or array of models (because Collection is Arrayable) //Collection or array of models (because Collection is Arrayable)
$this->setProperty( $this->setProperty(
$method, $method,
@@ -345,14 +363,14 @@ class ModelsCommand extends Command
* @param bool|null $write * @param bool|null $write
* @param string|null $comment * @param string|null $comment
*/ */
protected function setProperty($name, $type = null, $read = null, $write = null, $comment = '') protected function setProperty($name, $type = null, $read = null, $write = null, $comment='')
{ {
if (!isset($this->properties[$name])) { if (!isset($this->properties[$name])) {
$this->properties[$name] = array(); $this->properties[$name] = array();
$this->properties[$name]['type'] = 'mixed'; $this->properties[$name]['type'] = 'mixed';
$this->properties[$name]['read'] = false; $this->properties[$name]['read'] = false;
$this->properties[$name]['write'] = false; $this->properties[$name]['write'] = false;
$this->properties[$name]['comment'] = (string)$comment; $this->properties[$name]['comment'] = (string) $comment;
} }
if ($type !== null) { if ($type !== null) {
$this->properties[$name]['type'] = $type; $this->properties[$name]['type'] = $type;
@@ -380,9 +398,10 @@ class ModelsCommand extends Command
*/ */
protected function createPhpDocs($class) protected function createPhpDocs($class)
{ {
$reflection = new \ReflectionClass($class); $reflection = new \ReflectionClass($class);
$namespace = $reflection->getNamespaceName(); $namespace = $reflection->getNamespaceName();
$className = $reflection->getShortName(); $classname = $reflection->getShortName();
$originalDoc = $reflection->getDocComment(); $originalDoc = $reflection->getDocComment();
if ($this->reset) { if ($this->reset) {
@@ -398,11 +417,10 @@ class ModelsCommand extends Command
$properties = array(); $properties = array();
$methods = array(); $methods = array();
foreach ($phpdoc->getTags() as $tag) { foreach ($phpdoc->getTags() as $tag) {
/* @var Tag|Tag\PropertyTag|Tag\MethodTag $tag */
$name = $tag->getName(); $name = $tag->getName();
if ($name == 'property' || $name == 'property-read' || $name == 'property-write') { if ($name == "property" || $name == "property-read" || $name == "property-write") {
$properties[] = $tag->getVariableName(); $properties[] = $tag->getVariableName();
} elseif ($name == 'method') { } elseif ($name == "method") {
$methods[] = $tag->getMethodName(); $methods[] = $tag->getMethodName();
} }
} }
@@ -432,46 +450,47 @@ class ModelsCommand extends Command
$phpdoc->appendTag($tag); $phpdoc->appendTag($tag);
} }
$serializer = new DocBlock\Serializer(); $serializer = new DocBlockSerializer();
$serializer->getDocComment($phpdoc); $serializer->getDocComment($phpdoc);
$docComment = $serializer->getDocComment($phpdoc); $docComment = $serializer->getDocComment($phpdoc);
if ($this->write) { if ($this->write) {
$filename = $reflection->getFileName(); $filename = $reflection->getFileName();
$contents = $this->files->get($filename); $contents = \File::get($filename);
if ($originalDoc) { if ($originalDoc) {
$contents = str_replace($originalDoc, $docComment, $contents); $contents = str_replace($originalDoc, $docComment, $contents);
} else { } else {
$needle = "class {$className}"; $needle = "class {$classname}";
$replace = "{$docComment}\nclass {$className}"; $replace = "{$docComment}\nclass {$classname}";
$pos = strpos($contents, $needle); $pos = strpos($contents, $needle);
if ($pos !== false) { if ($pos !== false) {
$contents = substr_replace($contents, $replace, $pos, strlen($needle)); $contents = substr_replace($contents, $replace, $pos, strlen($needle));
} }
} }
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} {}\n}\n\n"; $output = "namespace {$namespace}{\n{$docComment}\n\tclass {$classname} {}\n}\n\n";
return $output; return $output;
} }
/** /**
* Get the parameters and format them correctly * Get the parameters and format them correctly
* *
* @param \ReflectionMethod $method * @param $method
* @return array * @return array
*/ */
public function getParameters($method) public function getParameters($method)
{ {
//Loop through the default values for parameters, and make the correct output string //Loop through the default values for paremeters, and make the correct output string
$params = array();
$paramsWithDefault = array(); $paramsWithDefault = array();
foreach ($method->getParameters() as $param) { foreach ($method->getParameters() as $param) {
$paramStr = '$' . $param->getName(); $paramStr = '$' . $param->getName();
$params[] = $paramStr;
if ($param->isOptional()) { if ($param->isOptional()) {
$default = $param->getDefaultValue(); $default = $param->getDefaultValue();
if (is_bool($default)) { if (is_bool($default)) {
@@ -489,7 +508,6 @@ class ModelsCommand extends Command
} }
$paramsWithDefault[] = $paramStr; $paramsWithDefault[] = $paramStr;
} }
return $paramsWithDefault; return $paramsWithDefault;
} }
@@ -511,6 +529,6 @@ class ModelsCommand extends Command
return substr($className, 0, $end); return substr($className, 0, $end);
} }
return '\\' . ltrim(trim($className, ' "\''), '\\'); return "\\" . ltrim(trim($className, " \"'"), "\\") ;
} }
} }
+39 -43
View File
@@ -10,7 +10,7 @@
namespace Barryvdh\LaravelIdeHelper; namespace Barryvdh\LaravelIdeHelper;
use /** @noinspection PhpUndefinedNamespaceInspection,PhpUndefinedClassInspection */Illuminate\Foundation\AliasLoader; use Illuminate\Foundation\AliasLoader;
use Illuminate\Config\Repository as ConfigRepository; use Illuminate\Config\Repository as ConfigRepository;
use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Console\Output\OutputInterface;
@@ -36,18 +36,20 @@ class Generator
* @param \Symfony\Component\Console\Output\OutputInterface $output * @param \Symfony\Component\Console\Output\OutputInterface $output
* @param string $helpers * @param string $helpers
*/ */
public function __construct(ConfigRepository $config, $view, OutputInterface $output = null, $helpers = '') public function __construct(/*ConfigRepository */ $config,
{ /* Illuminate\View\Factory */ $view,
OutputInterface $output = null,
$helpers = ''
) {
$this->config = $config; $this->config = $config;
$this->view = $view; $this->view = $view;
// Find the drivers to add to the extra/interfaces // Find the drivers to add to the extra/interfaces
$this->detectDrivers(); $this->detectDrivers();
$this->extra = array_merge($this->extra, $this->config->get('laravel-ide-helper::extra')); $this->extra = array_merge($this->extra, $this->config->get('ide-helper.extra'));
$this->magic = array_merge($this->magic, $this->config->get('laravel-ide-helper::magic')); $this->magic = array_merge($this->magic, $this->config->get('ide-helper.magic'));
$this->interfaces = array_merge($this->interfaces, $this->config->get('laravel-ide-helper::interfaces')); $this->interfaces = array_merge($this->interfaces, $this->config->get('ide-helper.interfaces'));
// Make all interface classes absolute // Make all interface classes absolute
foreach ($this->interfaces as &$interface) { foreach ($this->interfaces as &$interface) {
$interface = '\\' . ltrim($interface, '\\'); $interface = '\\' . ltrim($interface, '\\');
@@ -58,13 +60,13 @@ class Generator
/** /**
* Generate the helper file contents; * Generate the helper file contents;
* *
* @param string $format The format to generate the helper in (php/json) * @param string $format The format to generate the helper in (php/json)
* @return string; * @return string;
*/ */
public function generate($format = 'php') public function generate($format = 'php')
{ {
// Check if the generator for this format exists // Check if the generator for this format exists
$method = 'generate' . ucfirst($format) . 'Helper'; $method = 'generate'.ucfirst($format).'Helper';
if (method_exists($this, $method)) { if (method_exists($this, $method)) {
return $this->$method(); return $this->$method();
} }
@@ -75,7 +77,7 @@ class Generator
public function generatePhpHelper() public function generatePhpHelper()
{ {
$app = app(); $app = app();
return $this->view->make('laravel-ide-helper::ide-helper') return $this->view->make('ide-helper::helper')
->with('namespaces', $this->getNamespaces()) ->with('namespaces', $this->getNamespaces())
->with('helpers', $this->helpers) ->with('helpers', $this->helpers)
->with('version', $app::VERSION) ->with('version', $app::VERSION)
@@ -86,10 +88,10 @@ class Generator
{ {
$classes = array(); $classes = array();
foreach ($this->getNamespaces() as $aliases) { foreach ($this->getNamespaces() as $aliases) {
foreach ($aliases as $alias) { foreach($aliases as $alias) {
$functions = array(); $functions = array();
foreach ($alias->getMethods() as $method) { foreach ($alias->getMethods() as $method) {
$functions[$method->getName()] = '(' . $method->getParamsWithDefault() . ')'; $functions[$method->getName()] = '('. $method->getParamsWithDefault().')';
} }
$classes[$alias->getAlias()] = array( $classes[$alias->getAlias()] = array(
'functions' => $functions, 'functions' => $functions,
@@ -111,67 +113,66 @@ class Generator
protected function detectDrivers() protected function detectDrivers()
{ {
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)) {
/** @noinspection PhpUndefinedClassInspection */
$class = get_class(\Auth::driver()); $class = get_class(\Auth::driver());
$this->extra['Auth'] = array($class); $this->extra['Auth'] = array($class);
$this->interfaces['\Illuminate\Auth\UserProviderInterface'] = $class; $this->interfaces['\Illuminate\Auth\UserProviderInterface'] = $class;
} }
} catch (\Exception $e) {} }catch (\Exception $e) {}
try { try{
if (class_exists('DB') && is_a('DB', '\Illuminate\Support\Facades\DB', true)) { if (class_exists('DB') && is_a('DB', '\Illuminate\Support\Facades\DB', true)) {
/** @noinspection PhpUndefinedClassInspection */
$class = get_class(\DB::connection()); $class = get_class(\DB::connection());
$this->extra['DB'] = array($class); $this->extra['DB'] = array($class);
$this->interfaces['\Illuminate\Database\ConnectionInterface'] = $class; $this->interfaces['\Illuminate\Database\ConnectionInterface'] = $class;
} }
} catch (\Exception $e) {} }catch (\Exception $e) {}
try { try{
if (class_exists('Cache') && is_a('Cache', '\Illuminate\Support\Facades\Cache', true)) { if (class_exists('Cache') && is_a('Cache', '\Illuminate\Support\Facades\Cache', true)) {
/** @noinspection PhpUndefinedClassInspection */
$driver = get_class(\Cache::driver()); $driver = get_class(\Cache::driver());
/** @noinspection PhpUndefinedClassInspection */
$store = get_class(\Cache::getStore()); $store = get_class(\Cache::getStore());
$this->extra['Cache'] = array($driver, $store); $this->extra['Cache'] = array($driver, $store);
$this->interfaces['\Illuminate\Cache\StoreInterface'] = $store; $this->interfaces['\Illuminate\Cache\StoreInterface'] = $store;
} }
} catch (\Exception $e) {} }catch (\Exception $e) {}
try { try{
if (class_exists('Queue') && is_a('Queue', '\Illuminate\Support\Facades\Queue', true)) { if (class_exists('Queue') && is_a('Queue', '\Illuminate\Support\Facades\Queue', true)) {
/** @noinspection PhpUndefinedClassInspection */
$class = get_class(\Queue::connection()); $class = get_class(\Queue::connection());
$this->extra['Queue'] = array($class); $this->extra['Queue'] = array($class);
$this->interfaces['\Illuminate\Queue\QueueInterface'] = $class; $this->interfaces['\Illuminate\Queue\QueueInterface'] = $class;
} }
} catch (\Exception $e) {} }catch (\Exception $e) {}
try { try{
if (class_exists('SSH') && is_a('SSH', '\Illuminate\Support\Facades\SSH', true)) { if (class_exists('SSH') && is_a('SSH', '\Illuminate\Support\Facades\SSH', true)){
/** @noinspection PhpUndefinedClassInspection */
$class = get_class(\SSH::connection()); $class = get_class(\SSH::connection());
$this->extra['SSH'] = array($class); $this->extra['SSH'] = array($class);
$this->interfaces['\Illuminate\Remote\ConnectionInterface'] = $class; $this->interfaces['\Illuminate\Remote\ConnectionInterface'] = $class;
} }
} catch (\Exception $e) {} }catch (\Exception $e) {}
} }
/** /**
* Find all namespaces/aliases that are valid for us to render * Find all namespaces/aliases that are valid for us to render
* *
* @return array|Alias[][] * @return array
*/ */
protected function getNamespaces() protected function getNamespaces()
{ {
$namespaces = array(); $namespaces = array();
// Get all aliases // Get all aliases
/** @noinspection PhpUndefinedClassInspection */
foreach (AliasLoader::getInstance()->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()) {
@@ -202,20 +203,15 @@ class Generator
public function getDriver($alias) public function getDriver($alias)
{ {
try { try {
if ($alias == 'Auth') { if ($alias == "Auth") {
/** @noinspection PhpUndefinedClassInspection */
$driver = \Auth::driver(); $driver = \Auth::driver();
} elseif ($alias == 'DB') { } elseif ($alias == "DB") {
/** @noinspection PhpUndefinedClassInspection */
$driver = \DB::connection(); $driver = \DB::connection();
} elseif ($alias == 'Cache') { } elseif ($alias == "Cache") {
/** @noinspection PhpUndefinedClassInspection */
$driver = get_class(\Cache::driver()); $driver = get_class(\Cache::driver());
/** @noinspection PhpUndefinedClassInspection */
$store = get_class(\Cache::getStore()); $store = get_class(\Cache::getStore());
return array($driver, $store); return array($driver, $store);
} elseif ($alias == 'Queue') { } elseif ($alias == "Queue") {
/** @noinspection PhpUndefinedClassInspection */
$driver = \Queue::connection(); $driver = \Queue::connection();
} else { } else {
return false; return false;
@@ -231,14 +227,14 @@ class Generator
/** /**
* Write a string as error output. * Write a string as error output.
* *
* @param string $string * @param string $string
* @return void * @return void
*/ */
protected function error($string) protected function error($string)
{ {
if ($this->output) { if($this->output){
$this->output->writeln("<error>$string</error>"); $this->output->writeln("<error>$string</error>");
} else { }else{
echo $string . "\r\n"; echo $string . "\r\n";
} }
} }
+26 -22
View File
@@ -15,30 +15,40 @@ use Barryvdh\LaravelIdeHelper\Console\MetaCommand;
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand; use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand; use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
/**
* @property \Illuminate\Container\Container $app
*/
class IdeHelperServiceProvider extends ServiceProvider class IdeHelperServiceProvider extends ServiceProvider
{ {
/** /**
* {@inheritdoc} * Indicates if loading of the provider is deferred.
*
* @var bool
*/ */
protected $defer = true; protected $defer = true;
/** /**
* {@inheritdoc} * Bootstrap the application events.
*
* @return void
*/ */
public function boot() public function boot()
{ {
$this->package('barryvdh/laravel-ide-helper', 'laravel-ide-helper', __DIR__); $viewPath = __DIR__.'/../resources/views';
$this->loadViewsFrom($viewPath, 'ide-helper');
$configPath = __DIR__ . '/../config/ide-helper.php';
$this->publishes([$configPath => config_path('ide-helper.php')], 'config');
} }
/** /**
* {@inheritdoc} * Register the service provider.
*
* @return void
*/ */
public function register() public function register()
{ {
$configPath = __DIR__ . '/../config/ide-helper.php';
$this->mergeConfigFrom($configPath, 'ide-helper');
$this->app['command.ide-helper.generate'] = $this->app->share( $this->app['command.ide-helper.generate'] = $this->app->share(
function ($app) { function ($app) {
return new GeneratorCommand($app['config'], $app['files'], $app['view']); return new GeneratorCommand($app['config'], $app['files'], $app['view']);
@@ -46,34 +56,28 @@ 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); return new ModelsCommand();
} }
); );
$this->app['command.ide-helper.meta'] = $this->app->share( $this->app['command.ide-helper.meta'] = $this->app->share(
function ($app) { function ($app) {
return new MetaCommand($app); return new MetaCommand($app['files'], $app['view']);
} }
); );
$this->commands('command.ide-helper.generate', 'command.ide-helper.models', 'command.ide-helper.meta'); $this->commands('command.ide-helper.generate', 'command.ide-helper.models', 'command.ide-helper.meta');
} }
/** /**
* {@inheritdoc} * Get the services provided by the provider.
*
* @return array
*/ */
public function provides() public function provides()
{ {
return array('command.ide-helper.generate', 'command.ide-helper.models', 'command.ide-helper.meta'); return array('command.ide-helper.generate', 'command.ide-helper.models');
}
/**
* {@inheritdoc}
*/
protected function getAppViewPath($package, $namespace = null)
{
return $this->app['path'] . "/views/packages/{$package}";
} }
} }
+89 -110
View File
@@ -14,15 +14,18 @@ use phpDocumentor\Reflection\DocBlock;
use phpDocumentor\Reflection\DocBlock\Context; use phpDocumentor\Reflection\DocBlock\Context;
use phpDocumentor\Reflection\DocBlock\Tag; use phpDocumentor\Reflection\DocBlock\Tag;
use phpDocumentor\Reflection\DocBlock\Tag\ReturnTag; use phpDocumentor\Reflection\DocBlock\Tag\ReturnTag;
use phpDocumentor\Reflection\DocBlock\Tag\ParamTag;
use phpDocumentor\Reflection\DocBlock\Serializer as DocBlockSerializer;
class Method class Method
{ {
/** @var \phpDocumentor\Reflection\DocBlock */ /** @var \phpDocumentor\Reflection\DocBlock */
protected $phpdoc; protected $phpdoc;
/** @var \ReflectionMethod */ /** @var \ReflectionMethod */
protected $method; protected $method;
protected $output = '';
protected $name; protected $name;
protected $namespace; protected $namespace;
protected $params = array(); protected $params = array();
@@ -33,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
*/ */
@@ -42,15 +45,15 @@ class Method
$this->method = $method; $this->method = $method;
$this->interfaces = $interfaces; $this->interfaces = $interfaces;
$this->name = $methodName ?: $method->name; $this->name = $methodName ?: $method->name;
$declaringClass = $method->getDeclaringClass(); $this->namespace = $method->getDeclaringClass()->getNamespaceName();
$this->namespace = $declaringClass->getNamespaceName();
//Create a DocBlock and serializer instance //Create a DocBlock and serializer instance
$this->phpdoc = new DocBlock($method, new Context($this->namespace, static::getUseStatements($declaringClass))); $this->phpdoc = new DocBlock($method, new Context($this->namespace));
//Normalize the description and inherit the docs from parents/interfaces //Normalize the description and inherit the docs from parents/interfaces
try { try {
$this->normalizeReturnTags($this->phpdoc); $this->normalizeParams($this->phpdoc);
$this->normalizeReturn($this->phpdoc);
$this->normalizeDescription($this->phpdoc); $this->normalizeDescription($this->phpdoc);
} catch (\Exception $e) {} } catch (\Exception $e) {}
@@ -58,9 +61,10 @@ class Method
$this->getParameters($method); $this->getParameters($method);
//Make the method static //Make the method static
//$this->phpdoc->appendTag(Tag::createInstance('@static', $this->phpdoc)); $this->phpdoc->appendTag(Tag::createInstance('@static', $this->phpdoc));
//Reference the 'real' function in the declaringClass //Reference the 'real' function in the declaringclass
$declaringClass = $method->getDeclaringClass();
$this->declaringClassName = '\\' . ltrim($declaringClass->name, '\\'); $this->declaringClassName = '\\' . ltrim($declaringClass->name, '\\');
$this->root = '\\' . ltrim($class->getName(), '\\'); $this->root = '\\' . ltrim($class->getName(), '\\');
} }
@@ -89,17 +93,12 @@ class Method
* Get the docblock for this method * Get the docblock for this method
* *
* @param string $prefix * @param string $prefix
* @param bool $trim * @return mixed
* @return string
*/ */
public function getDocComment($prefix = "\t\t", $trim = false) public function getDocComment($prefix = "\t\t")
{ {
$serializer = new DocBlock\Serializer(1, $prefix); $serializer = new DocBlockSerializer(1, $prefix);
$str = $serializer->getDocComment($this->phpdoc); return $serializer->getDocComment($this->phpdoc);
if ($trim) {
$str = preg_replace(array('/\s+$/m', '#^(\s*/\*\*[\r\n])(?:\s*\*[\r\n])+#u', '#(?:[\r\n]\s*\*)+([\r\n]\s*\*/)$#u'), array('', '$1', '$1'), $str);
}
return $str;
} }
/** /**
@@ -112,31 +111,11 @@ class Method
return $this->name; return $this->name;
} }
/**
* Checks whether the method is deprecated
*
* @return bool
*/
public function isDeprecated()
{
return $this->phpdoc->hasTag('deprecated');
}
/**
* Get the declared parameters for this method
*
* @return array
*/
public function getDocParams()
{
return $this->phpdoc->getTagsByName('param');
}
/** /**
* Get the parameters for this method * Get the parameters for this method
* *
* @param bool $implode Whether to implode the array or not * @param bool $implode Wether to implode the array or not
* @return string|array * @return string
*/ */
public function getParams($implode = true) public function getParams($implode = true)
{ {
@@ -146,8 +125,8 @@ class Method
/** /**
* Get the parameters for this method including default values * Get the parameters for this method including default values
* *
* @param bool $implode Whether to implode the array or not * @param bool $implode Wether to implode the array or not
* @return string|array * @return string
*/ */
public function getParamsWithDefault($implode = true) public function getParamsWithDefault($implode = true)
{ {
@@ -165,18 +144,47 @@ class Method
$description = $phpdoc->getText(); $description = $phpdoc->getText();
//Loop through parents/interfaces, to fill in {@inheritdoc} //Loop through parents/interfaces, to fill in {@inheritdoc}
if (stripos($description, '{@inheritdoc}') !== false && ($inheritdoc = $this->getInheritDoc($this->method))) { if (strpos($description, '{@inheritdoc}') !== false) {
$inheritdoc = $this->getInheritDoc($this->method);
$inheritDescription = $inheritdoc->getText(); $inheritDescription = $inheritdoc->getText();
$description = str_ireplace('{@inheritdoc}', $inheritDescription, $description); $description = str_replace('{@inheritdoc}', $inheritDescription, $description);
$phpdoc->setText($description); $phpdoc->setText($description);
$this->normalizeReturnTags($inheritdoc); $this->normalizeParams($inheritdoc);
$this->normalizeReturn($inheritdoc);
//Add the tags that are inherited //Add the tags that are inherited
foreach ($inheritdoc->getTags() as $tag) { $inheritTags = $inheritdoc->getTags();
$tag->setDocBlock(); if ($inheritTags) {
$phpdoc->appendTag($tag); /** @var Tag $tag */
foreach ($inheritTags as $tag) {
$tag->setDocBlock();
$phpdoc->appendTag($tag);
}
}
}
}
/**
* Normalize the parameters
*
* @param DocBlock $phpdoc
*/
protected function normalizeParams(DocBlock $phpdoc)
{
//Get the return type and adjust them for beter autocomplete
$paramTags = $phpdoc->getTagsByName('param');
if ($paramTags) {
/** @var ParamTag $tag */
foreach($paramTags as $tag){
// Convert the keywords
$content = $this->convertKeywords($tag->getContent());
$tag->setContent($content);
// Get the expanded type and re-set the content
$content = $tag->getType() . ' ' . $tag->getVariableName() . ' ' . $tag->getDescription();
$tag->setContent(trim($content));
} }
} }
} }
@@ -186,69 +194,53 @@ class Method
* *
* @param DocBlock $phpdoc * @param DocBlock $phpdoc
*/ */
protected function normalizeReturnTags(DocBlock $phpdoc) protected function normalizeReturn(DocBlock $phpdoc)
{ {
static $typeProp; //Get the return type and adjust them for beter autocomplete
if (!isset($typeProp)) { $returnTags = $phpdoc->getTagsByName('return');
$typeProp = new \ReflectionProperty('phpDocumentor\Reflection\DocBlock\Tag\ReturnTag', 'type'); if ($returnTags) {
$typeProp->setAccessible(true); /** @var ReturnTag $tag */
} $tag = reset($returnTags);
// Get the expanded type
$returnValue = $tag->getType();
$this->return = null; // Replace the interfaces
//Get the return type and adjust them for better autocomplete foreach($this->interfaces as $interface => $real){
foreach ($phpdoc->getTags() as $tag) { $returnValue = str_replace($interface, $real, $returnValue);
if ($tag instanceof ReturnTag) {
// Convert the keywords
$typeValue = static::convertKeywords($typeProp->getValue($tag));
$typeProp->setValue($tag, $typeValue);
// Get the expanded type
$typeValue = $tag->getType();
// Replace the interfaces
if (preg_match('/\bReturnTag$/', get_class($tag))) {
foreach ($this->interfaces as $interface => $real) {
$typeValue = preg_replace('/(^|\|)' . preg_quote($interface, '/') . '\b/', $real, $typeValue);
}
$this->return = $typeValue;
}
// Re-set the type
$typeProp->setValue($tag, $typeValue);
$tag->setDescription($tag->getDescription());
} }
// Set the changed content
$tag->setContent($returnValue . ' ' . $tag->getDescription());
$this->return = $returnValue;
}else{
$this->return = null;
} }
} }
/** /**
* Convert keywords that are incorrect. * Convert keywwords that are incorrect.
* *
* @param string $string * @param string $string
* @return string * @return string
*/ */
protected static function convertKeywords($string) protected function convertKeywords($string)
{ {
$types = explode('|', $string); $string = str_replace('\Closure', 'Closure', $string);
foreach ($types as &$type) { $string = str_replace('Closure', '\Closure', $string);
if ($type === 'Closure') $string = str_replace('dynamic', 'mixed', $string);
$type = '\Closure';
elseif ($type === 'dynamic') return $string;
$type = 'mixed';
elseif (strrpos($type, '\\') && $type[0] !== '\\' && (class_exists($type) || interface_exists($type)))
$type = '\\' . $type;
}
return implode('|', $types);
} }
/** /**
* Should the function return a value? * Should the function return a value?
* *
* @return bool|int * @return bool
*/ */
public function shouldReturn() public function shouldReturn()
{ {
if ($this->return !== 'void' && $this->method->name !== '__construct') { if($this->return !== "void" && $this->method->name !== "__construct"){
return isset($this->return) ? true : 1; return true;
} }
return false; return false;
@@ -257,19 +249,17 @@ class Method
/** /**
* Get the parameters and format them correctly * Get the parameters and format them correctly
* *
* @param \ReflectionMethod $method * @param $method
* @return void * @return array
*/ */
public function getParameters($method) public function getParameters($method)
{ {
//Loop through the default values for parameters, 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();
foreach ($method->getParameters() as $param) { foreach ($method->getParameters() as $param) {
$paramStr = '$' . $param->getName(); $paramStr = '$' . $param->getName();
$params[] = $paramStr; $params[] = $paramStr;
if ($param->isOptional()) { if ($param->isOptional()) {
$default = $param->isDefaultValueAvailable() ? $param->getDefaultValue() : null; $default = $param->isDefaultValueAvailable() ? $param->getDefaultValue() : null;
if (is_bool($default)) { if (is_bool($default)) {
@@ -285,7 +275,6 @@ class Method
} }
$paramStr .= " = $default"; $paramStr .= " = $default";
} }
$paramsWithDefault[] = $paramStr; $paramsWithDefault[] = $paramStr;
} }
@@ -295,7 +284,7 @@ class Method
/** /**
* @param \ReflectionMethod $reflectionMethod * @param \ReflectionMethod $reflectionMethod
* @return DocBlock|null * @return DocBlock
*/ */
protected function getInheritDoc($reflectionMethod) protected function getInheritDoc($reflectionMethod)
{ {
@@ -309,24 +298,14 @@ class Method
} }
if ($method) { if ($method) {
$namespace = $method->getDeclaringClass()->getNamespaceName(); $namespace = $method->getDeclaringClass()->getNamespaceName();
$phpdoc = new DocBlock($method, new Context($namespace, static::getUseStatements($method->getDeclaringClass()))); $phpdoc = new DocBlock($method, new Context($namespace));
if (stripos($phpdoc->getText(), '{@inheritdoc}') !== false) { if (strpos($phpdoc->getText(), '{@inheritdoc}') !== false) {
//Not at the end yet, try another parent/interface.. //Not at the end yet, try another parent/interface..
return $this->getInheritDoc($method); return $this->getInheritDoc($method);
} else { } else {
return $phpdoc; return $phpdoc;
} }
} }
return null;
}
protected static function getUseStatements(\ReflectionClass $class)
{
try {
return PhpReflection::getUseStatements($class);
} catch (\Exception $e) {
return array();
}
} }
} }
-166
View File
@@ -1,166 +0,0 @@
<?php namespace Barryvdh\LaravelIdeHelper;
/**
* PHP reflection helpers.
*
* This file is part of the Nette Framework (https://nette.org)
* Copyright (c) 2004 David Grudl (https://davidgrudl.com)
*
* @see https://github.com/nette/di/blob/v2.4/src/DI/PhpReflection.php
*/
class PhpReflection
{
/**
* Expands class name into full name.
*
* @param string $name
* @param \ReflectionClass $rc
* @return string full name
* @throws \InvalidArgumentException
*/
public static function expandClassName($name, \ReflectionClass $rc)
{
$lower = strtolower($name);
if (empty($name)) {
throw new \InvalidArgumentException('Class name must not be empty.');
} elseif (self::isBuiltinType($lower)) {
return $lower;
} elseif ($lower === 'self' || $lower === 'static' || $lower === '$this') {
return $rc->getName();
} elseif ($name[0] === '\\') { // fully qualified name
return ltrim($name, '\\');
}
$uses = self::getUseStatements($rc);
$parts = explode('\\', $name, 2);
if (isset($uses[$parts[0]])) {
$parts[0] = $uses[$parts[0]];
return implode('\\', $parts);
} elseif ($rc->inNamespace()) {
return $rc->getNamespaceName() . '\\' . $name;
} else {
return $name;
}
}
/**
* @param \ReflectionClass
* @return array of [alias => class]
*/
public static function getUseStatements(\ReflectionClass $class)
{
static $cache = array();
if (!isset($cache[$name = $class->getName()])) {
if ($class->isInternal() || !($code = @file_get_contents($class->getFileName()))) {
$cache[$name] = array();
} else {
$cache = self::parseUseStatements($code, $name) + $cache;
}
}
return $cache[$name];
}
/**
* @param string
* @return bool
*/
public static function isBuiltinType($type)
{
return in_array(strtolower($type), array('string', 'int', 'float', 'bool', 'array', 'callable'), true);
}
/**
* Parses PHP code.
*
* @param string $code
* @param string $forClass
* @return array of [class => [alias => class, ...]]
*/
public static function parseUseStatements($code, $forClass = null)
{
$tokens = token_get_all($code);
$namespace = $class = $classLevel = $level = null;
$res = $uses = array();
while ($token = current($tokens)) {
next($tokens);
switch (is_array($token) ? $token[0] : $token) {
case T_NAMESPACE:
$namespace = ltrim(self::fetch($tokens, array(T_STRING, T_NS_SEPARATOR)) . '\\', '\\');
$uses = array();
break;
case T_CLASS:
case T_INTERFACE:
case PHP_VERSION_ID < 50400 ? -1 : T_TRAIT:
if ($name = self::fetch($tokens, T_STRING)) {
$class = $namespace . $name;
$classLevel = $level + 1;
$res[$class] = $uses;
if ($class === $forClass) {
return $res;
}
}
break;
case T_USE:
while (!$class && ($name = self::fetch($tokens, array(T_STRING, T_NS_SEPARATOR)))) {
$name = ltrim($name, '\\');
if (self::fetch($tokens, '{')) {
while ($suffix = self::fetch($tokens, array(T_STRING, T_NS_SEPARATOR))) {
if (self::fetch($tokens, T_AS)) {
$uses[self::fetch($tokens, T_STRING)] = $name . $suffix;
} else {
$tmp = explode('\\', $suffix);
$uses[end($tmp)] = $name . $suffix;
}
if (!self::fetch($tokens, ',')) {
break;
}
}
} elseif (self::fetch($tokens, T_AS)) {
$uses[self::fetch($tokens, T_STRING)] = $name;
} else {
$tmp = explode('\\', $name);
$uses[end($tmp)] = $name;
}
if (!self::fetch($tokens, ',')) {
break;
}
}
break;
case T_CURLY_OPEN:
case T_DOLLAR_OPEN_CURLY_BRACES:
case '{':
$level++;
break;
case '}':
if ($level === $classLevel) {
$class = $classLevel = null;
}
$level--;
}
}
return $res;
}
private static function fetch(&$tokens, $take)
{
$res = null;
while ($token = current($tokens)) {
list($token, $s) = is_array($token) ? $token : array($token, $token);
if (in_array($token, (array)$take, true)) {
$res .= $s;
} elseif (!in_array($token, array(T_DOC_COMMENT, T_WHITESPACE, T_COMMENT), true)) {
break;
}
next($tokens);
}
return $res;
}
}
-46
View File
@@ -1,46 +0,0 @@
<?= '<?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 <[email protected]>
* @see https://github.com/barryvdh/laravel-ide-helper
*/
<?php foreach ($namespaces as $namespace => $aliases/* @var \Barryvdh\LaravelIdeHelper\Alias[] $aliases */): ?>
namespace <?= $namespace == '__root' ? '' : $namespace ?>{
<?php if ($namespace == '__root'): ?>
exit('This file should not be included, only analyzed by your IDE');
<?= $helpers ?>
<?php endif; ?>
<?php foreach ($aliases as $alias): ?>
<?php if (($cBase = class_basename($alias->getExtends())) != $alias->getExtends() && $cBase != $alias->getShortName()): ?>
/** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */
<?php endif; ?>
<?= $alias->getClassType() ?> <?= $alias->getShortName() ?> <?= $alias->getExtends() ? 'extends ' . $alias->getExtends() : '' ?>{
<?php foreach ($alias->getMethods() as $method): ?>
<?php if (($nParams = count($method->getDocParams())) > count($mParams = $method->getParamsWithDefault(false))): ?>
/** @noinspection PhpDocSignatureInspection */
<?php endif; ?>
<?php if ($docComment = str_replace("/**\n\t\t */", '', trim($method->getDocComment("\t\t", true)))): ?>
<?= $docComment ?>
<?php endif; ?>
public static function <?= $method->getName() ?>(<?= ($docComment && $nParams < count($mParams)) ? '/** @noinspection PhpDocSignatureInspection */' . implode(', /** @noinspection PhpDocSignatureInspection */', $mParams) : $method->getParamsWithDefault() ?>){
<?php if ($method->getDeclaringClass() !== $method->getRoot()): ?>
//Method inherited from <?= $method->getDeclaringClass() ?>
<?php endif; ?>
/** @noinspection PhpUnnecessaryFullyQualifiedNameInspection,PhpDynamicAsStaticMethodCallInspection<?= ($method->shouldReturn() === 1 ? ',PhpVoidFunctionResultUsedInspection' : '') . ($method->isDeprecated() ? ',PhpDeprecationInspection' : '') ?> */
<?= $method->shouldReturn() ? 'return ' : '' ?><?= $method->getRoot() ?>::<?= $method->getName() ?>(<?= $method->getParams() ?>);
}
<?php endforeach; ?>
}
<?php endforeach; ?>
}
<?php endforeach; ?>
-22
View File
@@ -1,22 +0,0 @@
<?= '<?php' ?> namespace PHPSTORM_META {
/**
* PhpStorm Meta file, to provide autocomplete information for PhpStorm
* Generated on <?= date('Y-m-d') ?>.
*
* @author Barry vd. Heuvel <[email protected]>
* @see https://github.com/barryvdh/laravel-ide-helper
*/
/** @noinspection PhpIllegalArrayKeyTypeInspection,PhpUnusedLocalVariableInspection,PhpUnnecessaryFullyQualifiedNameInspection */
$STATIC_METHOD_TYPES = array(
<?php foreach ($methods as $method): ?>
<?= strpos($method, 'new ') === 0 ? $method : $method . '(\'\')' ?> => array(
<?php foreach ($bindings as $abstract => $class): ?>
<?= var_export($abstract, true) ?> instanceof \<?= $class ?>,
<?php endforeach ?>
),
<?php endforeach ?>
);
}
-38
View File
@@ -1,38 +0,0 @@
<?php namespace Barryvdh\LaravelIdeHelper;
class MethodTest extends \PHPUnit_Framework_TestCase
{
/**
* @expectedException \PHPUnit_Framework_Error
* @expectedExceptionMessage Argument 1 passed to
*/
public function testConstructorWithoutMethod()
{
new Method(null, null, null);
}
public function testConstructor()
{
$method = new \ReflectionMethod('PHPUnit_Framework_TestCase', 'getMock');
$object = new Method($method, null, new \ReflectionClass(get_class($this)));
$this->assertSame('\PHPUnit_Framework_TestCase', $object->getDeclaringClass());
$this->assertSame('\\' . get_class($this), $object->getRoot());
$this->assertSame('getMock', $object->getName());
$prop = new \ReflectionProperty(get_class($object), 'namespace');
$prop->setAccessible(true);
$this->assertSame('', $prop->getValue($object));
$this->assertFalse($object->isDeprecated());
$this->assertCount($method->getNumberOfParameters(), $object->getDocParams());
$doc = $object->getDocComment('', true);
$this->assertContains("\n * " . '@param array|null $methods', $doc);
$this->assertContains("\n * " . '@return \PHPUnit_Framework_MockObject_MockObject', $doc);
$this->assertContains("\n * " . '@throws \PHPUnit_Framework_Exception', $doc);
$this->assertTrue($object->shouldReturn());
}
}
-83
View File
@@ -1,83 +0,0 @@
<?php namespace Barryvdh\LaravelIdeHelper;
class ServiceProviderTest extends \PHPUnit_Framework_TestCase
{
/** @var \PHPUnit_Framework_MockObject_MockObject|\Illuminate\Container\Container */
protected $app;
/** @var IdeHelperServiceProvider */
protected $provider;
static function makeAppMock(\PHPUnit_Framework_TestCase $testCase)
{
$app = $testCase->getMock('Illuminate\Container\Container', array('make', 'bind'));
$fs = $testCase->getMock('Illuminate\Filesystem\Filesystem', null);
$config = $testCase->getMock('Illuminate\Config\Repository', array('get', 'set', 'package'), array(), '', false);
$events = $testCase->getMock('Illuminate\Events\Dispatcher', array('listen'), array($app));
$view = $testCase->getMock('Illuminate\View\Factory', array('addNamespace'), array(), '', false);
$app->expects($testCase->any())->method('make')->willReturnMap(array(
array('files', array(), $fs),
array('config', array(), $config),
array('events', array(), $events),
array('view', array(), $view),
array('path', array(), __DIR__),
));
return $app;
}
/**
* {@inheritdoc}
*/
protected function setUp()
{
$this->app = static::makeAppMock($this);
/** @noinspection PhpParamsInspection */
$this->provider = new IdeHelperServiceProvider($this->app);
}
public function testDeferred()
{
$this->assertTrue($this->provider->isDeferred());
}
public function testProvides()
{
$this->assertEquals(array('command.ide-helper.generate', 'command.ide-helper.models', 'command.ide-helper.meta'), $this->provider->provides());
}
public function testRegister()
{
$this->app->expects($this->exactly(3))->method('bind')->withConsecutive(
array('command.ide-helper.generate', $this->isType(\PHPUnit_Framework_Constraint_IsType::TYPE_CALLABLE), $this->isFalse()),
array('command.ide-helper.models', $this->isType(\PHPUnit_Framework_Constraint_IsType::TYPE_CALLABLE), $this->isFalse()),
array('command.ide-helper.meta', $this->isType(\PHPUnit_Framework_Constraint_IsType::TYPE_CALLABLE), $this->isFalse())
);
/** @var \PHPUnit_Framework_MockObject_MockObject|\Illuminate\Events\Dispatcher $events */
$events = $this->app['events'];
$events->expects($this->once())->method('listen')->with('artisan.start', $this->callback(function ($listener) {
$params = print_r(array('commands' => array('command.ide-helper.generate', 'command.ide-helper.models', 'command.ide-helper.meta')), true);
return strpos(preg_replace('/^\s+/mu', '', print_r($listener, true)), preg_replace('/^\s+/mu', '', $params));
}), 0);
$this->provider->register();
}
public function testBoot()
{
$path = realpath(__DIR__ . '/../src');
/** @var \PHPUnit_Framework_MockObject_MockObject|\Illuminate\Config\Repository $config */
$config = $this->app['config'];
$config->expects($this->once())->method('package')->with('barryvdh/laravel-ide-helper', $path . '/config', 'laravel-ide-helper');
/** @var \PHPUnit_Framework_MockObject_MockObject|\Illuminate\View\Factory $view */
$view = $this->app['view'];
$view->expects($this->once())->method('addNamespace')->with('laravel-ide-helper', $path . '/views');
$this->provider->boot();
}
}