mirror of
https://github.com/barryvdh/laravel-ide-helper.git
synced 2026-08-18 18:13:11 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
83999f8467 | ||
|
|
fab54d90dd | ||
|
|
5d4056fe87 | ||
|
|
3fbe330998 | ||
|
|
78d233fea7 | ||
|
|
0d13a51ff5 | ||
|
|
326e8ea25f | ||
|
|
e7ee934bb1 | ||
|
|
99953adb73 | ||
|
|
0d333c6228 | ||
|
|
0a717d1e79 | ||
|
|
dc62d35bed | ||
|
|
2b7733c6b9 | ||
|
|
76674be735 | ||
|
|
e34b7fb84b | ||
|
|
e77a7b5a9c | ||
|
|
19f7d75c10 | ||
|
|
0373861536 | ||
|
|
3a4671f3ea | ||
|
|
8515b7ac0b | ||
|
|
541b9508e2 | ||
|
|
afe1fe88ba | ||
|
|
a59a5e1ae1 | ||
|
|
bb3bba2c5b | ||
|
|
5aa0f55d2f | ||
|
|
89b585b242 | ||
|
|
f5b1248a37 | ||
|
|
8b190ac295 | ||
|
|
a861bcaf1b | ||
|
|
bb3bd2645d | ||
|
|
687a8c9b47 | ||
|
|
b1dedc3ee6 | ||
|
|
dac46a081d | ||
|
|
0c38360317 | ||
|
|
1d3a98f0e5 | ||
|
|
d9f79eb128 | ||
|
|
7ef2d2f398 | ||
|
|
5afcbdc7c8 | ||
|
|
d8d5517f2c | ||
|
|
f518de4ae1 | ||
|
|
a89273d7ad | ||
|
|
d9004f98cc | ||
|
|
765a274c05 | ||
|
|
b6a5262f3b | ||
|
|
d922d7e7ce | ||
|
|
89240e3ceb | ||
|
|
d9077b753c | ||
|
|
683ed695a5 | ||
|
|
f8c4d4e77a | ||
|
|
b1a4494b1c | ||
|
|
70c06f5b37 | ||
|
|
8378f1bd67 | ||
|
|
81b7febfc6 | ||
|
|
208043b56f | ||
|
|
4cd891eadc | ||
|
|
7917ba911f | ||
|
|
1f5e436d00 | ||
|
|
fb3280eaff | ||
|
|
800ac05377 | ||
|
|
50059faa6f | ||
|
|
bb8d0169ba | ||
|
|
fe692a4e77 | ||
|
|
c3a622fcc9 |
+5
-5
@@ -11,10 +11,10 @@
|
|||||||
],
|
],
|
||||||
"require": {
|
"require": {
|
||||||
"php": ">=5.4.0",
|
"php": ">=5.4.0",
|
||||||
"illuminate/support": "5.0.x",
|
"illuminate/support": "5.0.x|5.1.x",
|
||||||
"illuminate/console": "5.0.x",
|
"illuminate/console": "5.0.x|5.1.x",
|
||||||
"illuminate/filesystem": "5.0.x",
|
"illuminate/filesystem": "5.0.x|5.1.x",
|
||||||
"phpdocumentor/reflection-docblock": "2.0.x",
|
"phpdocumentor/reflection-docblock": "2.0.4",
|
||||||
"symfony/class-loader": "~2.3"
|
"symfony/class-loader": "~2.3"
|
||||||
},
|
},
|
||||||
"require-dev": {
|
"require-dev": {
|
||||||
@@ -30,7 +30,7 @@
|
|||||||
},
|
},
|
||||||
"extra": {
|
"extra": {
|
||||||
"branch-alias": {
|
"branch-alias": {
|
||||||
"dev-master": "2.0-dev"
|
"dev-master": "2.1-dev"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+32
-2
@@ -83,7 +83,37 @@ return array(
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
'interfaces' => array(
|
'interfaces' => array(
|
||||||
'\Illuminate\Auth\UserInterface' => config('auth.model', 'User'),
|
'\Illuminate\Contracts\Auth\Authenticatable' => config('auth.model', 'App\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,67 +1,88 @@
|
|||||||
## Laravel 5 IDE Helper Generator
|
## Laravel 5 IDE Helper Generator
|
||||||
[](https://packagist.org/packages/barryvdh/laravel-ide-helper) [](https://packagist.org/packages/barryvdh/laravel-ide-helper)
|
[](https://packagist.org/packages/barryvdh/laravel-ide-helper) [](https://packagist.org/packages/barryvdh/laravel-ide-helper)
|
||||||
|
|
||||||
### For Laravel 4.x, check [version 1.x](https://github.com/barryvdh/laravel-ide-helper/tree/v1.x)
|
### 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 alway up-to-date.
|
This package generates a file that your IDE understands, so it can provide accurate autocompletion. Generation is done based on the files in your project, so they are always up-to-date.
|
||||||
If you don't want to generate it, you can add a pre-generated file to the root folder of your laravel project. (But this isn't as up-to-date as self generated files)
|
If you don't want to generate it, you can add a pre-generated file to the root folder of your Laravel project (but this isn't as up-to-date as self generated files).
|
||||||
|
|
||||||
* Generated version: https://gist.github.com/barryvdh/5227822
|
* 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
|
||||||
|
|
||||||
|
### New: PhpStorm Meta for Container instances
|
||||||
|
|
||||||
|
It's possible to generate a PhpStorm meta file, to [add support for factory design pattern](https://confluence.jetbrains.com/display/PhpStorm/PhpStorm+Advanced+Metadata). For Laravel, this means we can make PhpStorm understand what kind of object we are resolving from the IoC Container. For example, `events` will return an `Illuminate\Events\Dispatcher` object, so with the meta file you can call `app('events')` and it will autocomplete the Dispatcher methods.
|
||||||
|
|
||||||
|
php artisan ide-helper:meta
|
||||||
|
|
||||||
|
app('events')->fire();
|
||||||
|
\App::make('events')->fire();
|
||||||
|
|
||||||
|
/** @var \Illuminate\Foundation\Application $app */
|
||||||
|
$app->make('events')->fire();
|
||||||
|
|
||||||
|
// When the key is not found, it uses the argument as class name
|
||||||
|
app('App\SomeClass');
|
||||||
|
|
||||||
|
Pre-generated example: https://gist.github.com/barryvdh/bb6ffc5d11e0a75dba67
|
||||||
|
|
||||||
|
> Note: You might need to restart PhpStorm and make sure `.phpstorm.meta.php` is indexed.
|
||||||
|
> Note: When you receive a FatalException about a class that is not found, check your config (for example, remove S3 as cloud driver when you don't have S3 configured. Remove Redis ServiceProvider when you don't use it).
|
||||||
|
|
||||||
### Automatic phpDoc generation for Laravel Facades
|
### Automatic phpDoc generation for Laravel Facades
|
||||||
|
|
||||||
Require this package with composer using the following command:
|
Require this package with composer using the following command:
|
||||||
|
|
||||||
composer require barryvdh/laravel-ide-helper
|
composer require barryvdh/laravel-ide-helper
|
||||||
|
|
||||||
After updating composer, add the ServiceProvider to the providers array in config/app.php
|
After updating composer, add the service provider to the `providers` array in `config/app.php`
|
||||||
|
|
||||||
'Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider',
|
Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class,
|
||||||
|
|
||||||
You can now re-generate the docs yourself (for future updates) in artisan
|
You can now re-generate the docs yourself (for future updates)
|
||||||
|
|
||||||
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:
|
||||||
|
|
||||||
"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`.
|
||||||
|
|
||||||
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 working default connection, some facades will not be included.
|
Some classes need a working database connection. If you do not have a default working connection, some facades will not be included.
|
||||||
You can use a in-memory sqlite driver, using the -M option.
|
You can use an 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 this with the --helpers (-H) option.
|
You can choose to include helper files. This is not enabled by default, but you can override it with the `--helpers (-H)` option.
|
||||||
The Illuminate/Support/helpers.php is already set-up, but you can add/remove your own files in the config file.
|
The `Illuminate/Support/helpers.php` is already set-up, but you can add/remove your own files in the config file.
|
||||||
|
|
||||||
|
### Automatic phpDocs for models
|
||||||
|
|
||||||
### Automatic phpDocs for Models
|
> You need to require `doctrine/dbal: ~2.3` in your own composer.json to get database columns.
|
||||||
|
|
||||||
> You need to require `doctrine/dbal: ~2.3` in your own composer.json to get database columns.
|
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)`.
|
||||||
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)`).
|
|
||||||
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, only the newly found columns/relations are saved as phpdocs.
|
With the `--reset (-R)` option, the existing phpdocs are ignored, and only the newly found columns/relations are saved as phpdocs.
|
||||||
|
|
||||||
php artisan ide-helper:models Post
|
php artisan ide-helper:models Post
|
||||||
|
|
||||||
@@ -78,17 +99,17 @@ With the `--reset (-R)` option, the existing phpdocs are ignored, only the newly
|
|||||||
* @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).
|
||||||
|
|
||||||
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):
|
||||||
|
|
||||||
php artisan ide-helper:models --dir="path/to/models" --dir="app/src/Model"
|
php artisan ide-helper:models --dir="path/to/models" --dir="app/src/Model"
|
||||||
|
|
||||||
You can publish the config file (`php artisan vendor:publish`) and set the default directories.
|
You can publish the config file (`php artisan vendor:publish`) and set the default directories.
|
||||||
|
|
||||||
Models can be ignored using the --ignore (-I) option
|
Models can be ignored using the `--ignore (-I)` option
|
||||||
|
|
||||||
php artisan ide-helper:models --ignore="Post,User"
|
php artisan ide-helper:models --ignore="Post,User"
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
<?= '<?php' ?>
|
<?= '<?php' ?>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* An helper file for Laravel 5, to provide autocomplete information to your IDE
|
* A helper file for Laravel 5, 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 <[email protected]>
|
* @author Barry vd. Heuvel <[email protected]>
|
||||||
|
|||||||
@@ -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
|
||||||
|
*/
|
||||||
|
$STATIC_METHOD_TYPES = [
|
||||||
|
<?php foreach($methods as $method): ?>
|
||||||
|
<?= $method ?> => [
|
||||||
|
'' == '@',
|
||||||
|
<?php foreach($bindings as $abstract => $class): ?>
|
||||||
|
'<?= $abstract ?>' instanceof \<?= $class ?>,
|
||||||
|
<?php endforeach ?> ],
|
||||||
|
<?php endforeach ?>
|
||||||
|
];
|
||||||
|
}
|
||||||
@@ -59,7 +59,7 @@ 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, /* Illuminate\View\Factory */
|
Filesystem $files, /* Illuminate\View\Factory */
|
||||||
$view
|
$view
|
||||||
) {
|
) {
|
||||||
@@ -76,9 +76,11 @@ class GeneratorCommand extends Command
|
|||||||
*/
|
*/
|
||||||
public function fire()
|
public function fire()
|
||||||
{
|
{
|
||||||
if (file_exists($compiled = base_path() . '/bootstrap/compiled.php')) {
|
if (file_exists(base_path() . '/vendor/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 bootstrap/compiled.php (php artisan clear-compiled)'
|
'Error generating IDE Helper: first delete your compiled file (php artisan clear-compiled)'
|
||||||
);
|
);
|
||||||
} else {
|
} else {
|
||||||
$filename = $this->argument('filename');
|
$filename = $this->argument('filename');
|
||||||
|
|||||||
@@ -0,0 +1,140 @@
|
|||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* Laravel IDE Helper Generator
|
||||||
|
*
|
||||||
|
* @author Barry vd. Heuvel <[email protected]>
|
||||||
|
* @copyright 2015 Barry vd. Heuvel / Fruitcake Studio (http://www.fruitcakestudio.nl)
|
||||||
|
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
||||||
|
* @link https://github.com/barryvdh/laravel-ide-helper
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Console;
|
||||||
|
|
||||||
|
use Illuminate\Console\Command;
|
||||||
|
use Symfony\Component\Console\Input\InputOption;
|
||||||
|
use Symfony\Component\Console\Output\OutputInterface;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A command to generate phpstorm meta data
|
||||||
|
*
|
||||||
|
* @author Barry vd. Heuvel <[email protected]>
|
||||||
|
*/
|
||||||
|
class MetaCommand extends Command {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The console command name.
|
||||||
|
*
|
||||||
|
* @var string
|
||||||
|
*/
|
||||||
|
protected $name = 'ide-helper:meta';
|
||||||
|
protected $filename = '.phpstorm.meta.php';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The console command description.
|
||||||
|
*
|
||||||
|
* @var string
|
||||||
|
*/
|
||||||
|
protected $description = 'Generate metadata for PhpStorm';
|
||||||
|
|
||||||
|
/** @var \Illuminate\Contracts\Filesystem\Filesystem */
|
||||||
|
protected $files;
|
||||||
|
|
||||||
|
/** @var \Illuminate\Contracts\View\Factory */
|
||||||
|
protected $view;
|
||||||
|
|
||||||
|
protected $methods = [
|
||||||
|
'new \Illuminate\Contracts\Container\Container',
|
||||||
|
'\Illuminate\Contracts\Container\Container::make(\'\')',
|
||||||
|
'\App::make(\'\')',
|
||||||
|
'app(\'\')',
|
||||||
|
];
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* @param \Illuminate\Contracts\Filesystem\Filesystem $files
|
||||||
|
* @param \Illuminate\Contracts\View\Factory $view
|
||||||
|
*/
|
||||||
|
public function __construct($files, $view) {
|
||||||
|
$this->files = $files;
|
||||||
|
$this->view = $view;
|
||||||
|
parent::__construct();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Execute the console command.
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function fire()
|
||||||
|
{
|
||||||
|
$this->registerClassAutoloadExceptions();
|
||||||
|
|
||||||
|
$bindings = array();
|
||||||
|
foreach ($this->getAbstracts() as $abstract) {
|
||||||
|
// Validator causes problems in Lumen
|
||||||
|
if ($abstract == 'validator') {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
$concrete = $this->laravel->make($abstract);
|
||||||
|
if (is_object($concrete)) {
|
||||||
|
$bindings[$abstract] = get_class($concrete);
|
||||||
|
}
|
||||||
|
}catch (\Exception $e) {
|
||||||
|
if ($this->output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
|
||||||
|
$this->comment("Cannot make '$abstract': ".$e->getMessage());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$content = $this->view->make('ide-helper::meta', [
|
||||||
|
'bindings' => $bindings,
|
||||||
|
'methods' => $this->methods,
|
||||||
|
])->render();
|
||||||
|
|
||||||
|
$filename = $this->option('filename');
|
||||||
|
$written = $this->files->put($filename, $content);
|
||||||
|
|
||||||
|
if ($written !== false) {
|
||||||
|
$this->info("A new meta file was written to $filename");
|
||||||
|
} else {
|
||||||
|
$this->error("The meta file could not be created at $filename");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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.
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
protected function getOptions()
|
||||||
|
{
|
||||||
|
return array(
|
||||||
|
array('filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the meta file', $this->filename),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -12,8 +12,10 @@ namespace Barryvdh\LaravelIdeHelper\Console;
|
|||||||
|
|
||||||
use Illuminate\Console\Command;
|
use Illuminate\Console\Command;
|
||||||
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 phpDocumentor\Reflection\DocBlock;
|
use phpDocumentor\Reflection\DocBlock;
|
||||||
use phpDocumentor\Reflection\DocBlock\Context;
|
use phpDocumentor\Reflection\DocBlock\Context;
|
||||||
@@ -27,6 +29,10 @@ use phpDocumentor\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.
|
||||||
@@ -49,6 +55,14 @@ 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.
|
||||||
@@ -80,7 +94,7 @@ class ModelsCommand extends Command
|
|||||||
$content = $this->generateDocs($model, $ignore);
|
$content = $this->generateDocs($model, $ignore);
|
||||||
|
|
||||||
if (!$this->write) {
|
if (!$this->write) {
|
||||||
$written = \File::put($filename, $content);
|
$written = $this->files->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 {
|
||||||
@@ -148,7 +162,9 @@ class ModelsCommand extends Command
|
|||||||
|
|
||||||
foreach ($models as $name) {
|
foreach ($models as $name) {
|
||||||
if (in_array($name, $ignore)) {
|
if (in_array($name, $ignore)) {
|
||||||
$this->comment("Ignoring model '$name'");
|
if ($this->output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
|
||||||
|
$this->comment("Ignoring model '$name'");
|
||||||
|
}
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
$this->properties = array();
|
$this->properties = array();
|
||||||
@@ -162,7 +178,9 @@ class ModelsCommand extends Command
|
|||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
$this->comment("Loading model '$name'");
|
if ($this->output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
|
||||||
|
$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.');
|
||||||
@@ -176,6 +194,7 @@ 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.");
|
||||||
}
|
}
|
||||||
@@ -217,9 +236,21 @@ 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);
|
||||||
$schema->getDatabasePlatform()->registerDoctrineTypeMapping('enum', 'string');
|
$databasePlatform = $schema->getDatabasePlatform();
|
||||||
|
$databasePlatform->registerDoctrineTypeMapping('enum', 'string');
|
||||||
|
|
||||||
$columns = $schema->listTableColumns($table);
|
$platformName = $databasePlatform->getName();
|
||||||
|
$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) {
|
||||||
@@ -303,7 +334,7 @@ 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, '\\' . $reflection->class, $args);
|
$this->setMethod($name, '\Illuminate\Database\Query\Builder|\\' . $reflection->class, $args);
|
||||||
}
|
}
|
||||||
} elseif (!method_exists('Eloquent', $method) && !Str::startsWith($method, 'get')) {
|
} elseif (!method_exists('Eloquent', $method) && !Str::startsWith($method, 'get')) {
|
||||||
|
|
||||||
@@ -318,6 +349,7 @@ 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);
|
||||||
|
|
||||||
@@ -333,24 +365,29 @@ class ModelsCommand extends Command
|
|||||||
$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, ');')));
|
$end = strpos($code, ')->') ?:strpos($code, ');');
|
||||||
//Remove quotes, ensure 1 \ in front of the model
|
if (false !== $end) {
|
||||||
$returnModel = $this->getClassName($arguments[0], $model);
|
$arguments = substr($code, 0, $end);
|
||||||
if ($relation === "belongsToMany" or $relation === 'hasMany' or $relation === 'morphMany' or $relation === 'morphToMany') {
|
$arguments = array_map(function($item) {
|
||||||
//Collection or array of models (because Collection is Arrayable)
|
return trim($item, ' \'\"');
|
||||||
$this->setProperty(
|
}, explode(',', $arguments));
|
||||||
$method,
|
//Remove quotes, ensure 1 \ in front of the model
|
||||||
'\Illuminate\Database\Eloquent\Collection|' . $returnModel . '[]',
|
$returnModel = $this->getClassName($arguments[0], $model);
|
||||||
true,
|
if ($relation === "belongsToMany" or $relation === 'hasMany' or $relation === 'morphMany' or $relation === 'morphToMany') {
|
||||||
null
|
//Collection or array of models (because Collection is Arrayable)
|
||||||
);
|
$this->setProperty(
|
||||||
} else {
|
$method,
|
||||||
//Single model is returned
|
'\Illuminate\Database\Eloquent\Collection|' . $returnModel . '[]',
|
||||||
$this->setProperty($method, $returnModel, true, null);
|
true,
|
||||||
|
null
|
||||||
|
);
|
||||||
|
} else {
|
||||||
|
//Single model is returned
|
||||||
|
$this->setProperty($method, $returnModel, true, null);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -437,7 +474,8 @@ class ModelsCommand extends Command
|
|||||||
} else {
|
} else {
|
||||||
$attr = 'property-read';
|
$attr = 'property-read';
|
||||||
}
|
}
|
||||||
$tag = Tag::createInstance("@{$attr} {$property['type']} {$name} {$property['comment']}", $phpdoc);
|
$tagLine = trim("@{$attr} {$property['type']} {$name} {$property['comment']}");
|
||||||
|
$tag = Tag::createInstance($tagLine, $phpdoc);
|
||||||
$phpdoc->appendTag($tag);
|
$phpdoc->appendTag($tag);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -457,7 +495,7 @@ class ModelsCommand extends Command
|
|||||||
|
|
||||||
if ($this->write) {
|
if ($this->write) {
|
||||||
$filename = $reflection->getFileName();
|
$filename = $reflection->getFileName();
|
||||||
$contents = \File::get($filename);
|
$contents = $this->files->get($filename);
|
||||||
if ($originalDoc) {
|
if ($originalDoc) {
|
||||||
$contents = str_replace($originalDoc, $docComment, $contents);
|
$contents = str_replace($originalDoc, $docComment, $contents);
|
||||||
} else {
|
} else {
|
||||||
@@ -468,7 +506,7 @@ class ModelsCommand extends Command
|
|||||||
$contents = substr_replace($contents, $replace, $pos, strlen($needle));
|
$contents = substr_replace($contents, $replace, $pos, strlen($needle));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if (\File::put($filename, $contents)) {
|
if ($this->files->put($filename, $contents)) {
|
||||||
$this->info('Written new phpDocBlock to ' . $filename);
|
$this->info('Written new phpDocBlock to ' . $filename);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -520,7 +558,7 @@ class ModelsCommand extends Command
|
|||||||
{
|
{
|
||||||
// If the class name was resolved via get_class($this) or static::class
|
// If the class name was resolved via get_class($this) or static::class
|
||||||
if (strpos($className, 'get_class($this)') !== false || strpos($className, 'static::class') !== false) {
|
if (strpos($className, 'get_class($this)') !== false || strpos($className, 'static::class') !== false) {
|
||||||
return get_class($model);
|
return "\\" . get_class($model);
|
||||||
}
|
}
|
||||||
|
|
||||||
// If the class name was resolved via ::class (PHP 5.5+)
|
// If the class name was resolved via ::class (PHP 5.5+)
|
||||||
|
|||||||
+36
-4
@@ -36,7 +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(ConfigRepository $config,
|
public function __construct(/*ConfigRepository */ $config,
|
||||||
/* Illuminate\View\Factory */ $view,
|
/* Illuminate\View\Factory */ $view,
|
||||||
OutputInterface $output = null,
|
OutputInterface $output = null,
|
||||||
$helpers = ''
|
$helpers = ''
|
||||||
@@ -80,7 +80,7 @@ class Generator
|
|||||||
return $this->view->make('ide-helper::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())
|
||||||
->render();
|
->render();
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -166,8 +166,7 @@ class Generator
|
|||||||
$namespaces = array();
|
$namespaces = array();
|
||||||
|
|
||||||
// Get all aliases
|
// Get all aliases
|
||||||
foreach (AliasLoader::getInstance()->getAliases() as $name => $facade) {
|
foreach ($this->getAliases() as $name => $facade) {
|
||||||
|
|
||||||
// Skip the Redis facade, if not available (otherwise Fatal PHP Error)
|
// Skip the Redis facade, if not available (otherwise Fatal PHP Error)
|
||||||
if ($facade == 'Illuminate\Support\Facades\Redis' && !class_exists('Predis\Client')) {
|
if ($facade == 'Illuminate\Support\Facades\Redis' && !class_exists('Predis\Client')) {
|
||||||
continue;
|
continue;
|
||||||
@@ -194,6 +193,39 @@ class Generator
|
|||||||
return $namespaces;
|
return $namespaces;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
protected function getAliases()
|
||||||
|
{
|
||||||
|
// For Laravel, use the AliasLoader
|
||||||
|
if (class_exists('Illuminate\Foundation\AliasLoader')) {
|
||||||
|
return AliasLoader::getInstance()->getAliases();
|
||||||
|
}
|
||||||
|
|
||||||
|
$facades = [
|
||||||
|
'Illuminate\Support\Facades\App' => 'App',
|
||||||
|
'Illuminate\Support\Facades\Auth' => 'Auth',
|
||||||
|
'Illuminate\Support\Facades\Bus' => 'Bus',
|
||||||
|
'Illuminate\Support\Facades\DB' => 'DB',
|
||||||
|
'Illuminate\Support\Facades\Cache' => 'Cache',
|
||||||
|
'Illuminate\Support\Facades\Cookie' => 'Cookie',
|
||||||
|
'Illuminate\Support\Facades\Crypt' => 'Crypt',
|
||||||
|
'Illuminate\Support\Facades\Event' => 'Event',
|
||||||
|
'Illuminate\Support\Facades\Hash' => 'Hash',
|
||||||
|
'Illuminate\Support\Facades\Log' => 'Log',
|
||||||
|
'Illuminate\Support\Facades\Mail' => 'Mail',
|
||||||
|
'Illuminate\Support\Facades\Queue' => 'Queue',
|
||||||
|
'Illuminate\Support\Facades\Request' => 'Request',
|
||||||
|
'Illuminate\Support\Facades\Schema' => 'Schema',
|
||||||
|
'Illuminate\Support\Facades\Session' => 'Session',
|
||||||
|
'Illuminate\Support\Facades\Storage' => 'Storage',
|
||||||
|
// 'Illuminate\Support\Facades\Validator' => 'Validator',
|
||||||
|
];
|
||||||
|
|
||||||
|
// 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
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -11,8 +11,9 @@
|
|||||||
namespace Barryvdh\LaravelIdeHelper;
|
namespace Barryvdh\LaravelIdeHelper;
|
||||||
|
|
||||||
use Illuminate\Support\ServiceProvider;
|
use Illuminate\Support\ServiceProvider;
|
||||||
use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
|
use Barryvdh\LaravelIdeHelper\Console\MetaCommand;
|
||||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
|
||||||
|
|
||||||
class IdeHelperServiceProvider extends ServiceProvider
|
class IdeHelperServiceProvider extends ServiceProvider
|
||||||
{
|
{
|
||||||
@@ -35,7 +36,12 @@ class IdeHelperServiceProvider extends ServiceProvider
|
|||||||
$this->loadViewsFrom($viewPath, 'ide-helper');
|
$this->loadViewsFrom($viewPath, 'ide-helper');
|
||||||
|
|
||||||
$configPath = __DIR__ . '/../config/ide-helper.php';
|
$configPath = __DIR__ . '/../config/ide-helper.php';
|
||||||
$this->publishes([$configPath => config_path('ide-helper.php')], 'config');
|
if (function_exists('config_path')) {
|
||||||
|
$publishPath = config_path('ide-helper.php');
|
||||||
|
} else {
|
||||||
|
$publishPath = base_path('config/ide-helper.php');
|
||||||
|
}
|
||||||
|
$this->publishes([$configPath => $publishPath], 'config');
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -55,12 +61,18 @@ class IdeHelperServiceProvider extends ServiceProvider
|
|||||||
);
|
);
|
||||||
|
|
||||||
$this->app['command.ide-helper.models'] = $this->app->share(
|
$this->app['command.ide-helper.models'] = $this->app->share(
|
||||||
function () {
|
function ($app) {
|
||||||
return new ModelsCommand();
|
return new ModelsCommand($app['files']);
|
||||||
}
|
}
|
||||||
);
|
);
|
||||||
|
|
||||||
|
$this->app['command.ide-helper.meta'] = $this->app->share(
|
||||||
|
function ($app) {
|
||||||
|
return new MetaCommand($app['files'], $app['view']);
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
$this->commands('command.ide-helper.generate', 'command.ide-helper.models');
|
$this->commands('command.ide-helper.generate', 'command.ide-helper.models', 'command.ide-helper.meta');
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
Reference in New Issue
Block a user