mirror of
https://github.com/barryvdh/laravel-ide-helper.git
synced 2026-08-18 10:07:12 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3f9831c5cf | ||
|
|
2cc277440a | ||
|
|
14eab5ef84 |
+6
-6
@@ -10,11 +10,11 @@
|
||||
}
|
||||
],
|
||||
"require": {
|
||||
"php": ">=5.4.0",
|
||||
"illuminate/support": "5.0.x|5.1.x",
|
||||
"illuminate/console": "5.0.x|5.1.x",
|
||||
"illuminate/filesystem": "5.0.x|5.1.x",
|
||||
"phpdocumentor/reflection-docblock": "2.0.4",
|
||||
"php": ">=5.3.0",
|
||||
"illuminate/support": "4.x",
|
||||
"illuminate/console": "4.x",
|
||||
"illuminate/filesystem": "4.x",
|
||||
"phpdocumentor/reflection-docblock": "2.0.x",
|
||||
"symfony/class-loader": "~2.3"
|
||||
},
|
||||
"require-dev": {
|
||||
@@ -30,7 +30,7 @@
|
||||
},
|
||||
"extra": {
|
||||
"branch-alias": {
|
||||
"dev-master": "2.0-dev"
|
||||
"dev-master": "1.11-dev"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"providers": [
|
||||
"Barryvdh\\LaravelIdeHelper\\IdeHelperServiceProvider"
|
||||
]
|
||||
}
|
||||
@@ -1,83 +1,67 @@
|
||||
## Laravel 5 IDE Helper Generator
|
||||
## Laravel IDE Helper Generator
|
||||
[](https://packagist.org/packages/barryvdh/laravel-ide-helper) [](https://packagist.org/packages/barryvdh/laravel-ide-helper)
|
||||
|
||||
### For Laravel 4.x, check [version 1.11](https://github.com/barryvdh/laravel-ide-helper/tree/1.11)
|
||||
### For Laravel 5, check the [2.0 branch](https://github.com/barryvdh/laravel-ide-helper)
|
||||
|
||||
### 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!_
|
||||
|
||||
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).
|
||||
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)
|
||||
|
||||
* Generated version: https://gist.github.com/barryvdh/5227822
|
||||
|
||||
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();
|
||||
|
||||
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
|
||||
|
||||
Require this package with composer using the following command:
|
||||
|
||||
composer require barryvdh/laravel-ide-helper
|
||||
|
||||
After updating composer, add the service provider to the `providers` array in `config/app.php`
|
||||
After updating composer, add the ServiceProvider to the providers array in app/config/app.php
|
||||
|
||||
'Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider',
|
||||
|
||||
You can now re-generate the docs yourself (for future updates)
|
||||
You can now re-generate the docs yourself (for future updates) in artisan
|
||||
|
||||
php artisan ide-helper:generate
|
||||
|
||||
Note: `bootstrap/compiled.php` has to be cleared first, so run `php artisan clear-compiled` before generating (and `php artisan optimize` after).
|
||||
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:
|
||||
|
||||
"scripts":{
|
||||
"post-update-cmd": [
|
||||
"post-update-cmd":[
|
||||
"php artisan clear-compiled",
|
||||
"php artisan ide-helper:generate",
|
||||
"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 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.
|
||||
|
||||
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 an in-memory SQLite driver, using the -M option.
|
||||
Some classes need a working database connection. If you do not have a working default connection, some facades will not be included.
|
||||
You can use a in-memory sqlite driver, using the -M option.
|
||||
|
||||
You can choose to include helper files. This is not enabled by default, but you can override it with the `--helpers (-H)` option.
|
||||
The `Illuminate/Support/helpers.php` is already set-up, but you can add/remove your own files in the config file.
|
||||
You can choose to include helper files. This is not enabled by default, but you can override this with the --helpers (-H) option.
|
||||
The Illuminate/Support/helpers.php is already set-up, but you can add/remove your own files in the config file.
|
||||
|
||||
### Automatic phpDocs for models
|
||||
|
||||
> You need to require `doctrine/dbal: ~2.3` in your own composer.json to get database columns.
|
||||
### Automatic phpDocs for Models
|
||||
|
||||
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)`.
|
||||
> **Note:** Since v1.10 you need to require `doctrine/dbal: ~2.3` in your own composer.json.
|
||||
|
||||
If you don't want to write your properties yourself, you can use the command `ide-helper:models` to generate
|
||||
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.
|
||||
It should keep the existing comments and only append new properties/methods. The existing phpdoc is replaced, or added if not found.
|
||||
With the `--reset (-R)` option, the existing phpdocs are ignored, and only the newly found columns/relations are saved as phpdocs.
|
||||
With the `--reset (-R)` option, the existing phpdocs are ignored, only the newly found columns/relations are saved as phpdocs.
|
||||
|
||||
php artisan ide-helper:models Post
|
||||
|
||||
@@ -94,17 +78,17 @@ With the `--reset (-R)` option, the existing phpdocs are ignored, and only the n
|
||||
* @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
|
||||
|
||||
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="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
|
||||
|
||||
php artisan ide-helper:models --ignore="Post,User"
|
||||
|
||||
|
||||
@@ -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 */
|
||||
/** @noinspection PhpUnusedLocalVariableInspection */
|
||||
/** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */
|
||||
$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
|
||||
*/
|
||||
public function __construct(
|
||||
/*ConfigRepository */ $config,
|
||||
ConfigRepository $config,
|
||||
Filesystem $files, /* Illuminate\View\Factory */
|
||||
$view
|
||||
) {
|
||||
@@ -97,8 +97,8 @@ class GeneratorCommand extends Command
|
||||
|
||||
|
||||
$helpers = '';
|
||||
if ($this->option('helpers') || ($this->config->get('ide-helper.include_helpers'))) {
|
||||
foreach ($this->config->get('ide-helper.helper_files', array()) as $helper) {
|
||||
if ($this->option('helpers') || ($this->config->get('laravel-ide-helper::include_helpers'))) {
|
||||
foreach ($this->config->get('laravel-ide-helper::helper_files', array()) as $helper) {
|
||||
if (file_exists($helper)) {
|
||||
$helpers .= str_replace(array('<?php', '?>'), '', $this->files->get($helper));
|
||||
}
|
||||
@@ -139,7 +139,7 @@ class GeneratorCommand extends Command
|
||||
*/
|
||||
protected function getArguments()
|
||||
{
|
||||
$filename = $this->config->get('ide-helper.filename');
|
||||
$filename = $this->config->get('laravel-ide-helper::filename');
|
||||
|
||||
return array(
|
||||
array(
|
||||
@@ -155,7 +155,7 @@ class GeneratorCommand extends Command
|
||||
*/
|
||||
protected function getOptions()
|
||||
{
|
||||
$format = $this->config->get('ide-helper.format');
|
||||
$format = $this->config->get('laravel-ide-helper::format');
|
||||
|
||||
return array(
|
||||
array('format', "F", InputOption::VALUE_OPTIONAL, 'The format for the IDE Helper', $format),
|
||||
|
||||
@@ -1,134 +0,0 @@
|
||||
<?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;
|
||||
|
||||
/**
|
||||
* 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 = [
|
||||
'\Illuminate\Foundation\Application::make',
|
||||
'\Illuminate\Contracts\Foundation\Application::make',
|
||||
'\Illuminate\Contracts\Container\Container::make',
|
||||
'\Illuminate\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) {
|
||||
try {
|
||||
$concrete = $this->laravel->make($abstract);
|
||||
if (is_object($concrete)) {
|
||||
$bindings[$abstract] = get_class($concrete);
|
||||
}
|
||||
}catch (\Exception $e) {
|
||||
$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),
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -60,7 +60,7 @@ class ModelsCommand extends Command
|
||||
$filename = $this->option('filename');
|
||||
$this->write = $this->option('write');
|
||||
$this->dirs = array_merge(
|
||||
$this->laravel['config']->get('ide-helper.model_locations'),
|
||||
$this->laravel['config']->get('laravel-ide-helper::model_locations'),
|
||||
$this->option('dir')
|
||||
);
|
||||
$model = $this->argument('model');
|
||||
@@ -217,21 +217,9 @@ class ModelsCommand extends Command
|
||||
{
|
||||
$table = $model->getConnection()->getTablePrefix() . $model->getTable();
|
||||
$schema = $model->getConnection()->getDoctrineSchemaManager($table);
|
||||
$databasePlatform = $schema->getDatabasePlatform();
|
||||
$databasePlatform->registerDoctrineTypeMapping('enum', 'string');
|
||||
$schema->getDatabasePlatform()->registerDoctrineTypeMapping('enum', 'string');
|
||||
|
||||
$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);
|
||||
$columns = $schema->listTableColumns($table);
|
||||
|
||||
if ($columns) {
|
||||
foreach ($columns as $column) {
|
||||
@@ -315,7 +303,7 @@ class ModelsCommand extends Command
|
||||
$args = $this->getParameters($reflection);
|
||||
//Remove the first ($query) argument
|
||||
array_shift($args);
|
||||
$this->setMethod($name, '\Illuminate\Database\Query\Builder|\\' . $reflection->class, $args);
|
||||
$this->setMethod($name, '\\' . $reflection->class, $args);
|
||||
}
|
||||
} elseif (!method_exists('Eloquent', $method) && !Str::startsWith($method, 'get')) {
|
||||
|
||||
@@ -345,7 +333,7 @@ class ModelsCommand extends Command
|
||||
$search = '$this->' . $relation . '(';
|
||||
if ($pos = stripos($code, $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
|
||||
$returnModel = $this->getClassName($arguments[0], $model);
|
||||
if ($relation === "belongsToMany" or $relation === 'hasMany' or $relation === 'morphMany' or $relation === 'morphToMany') {
|
||||
|
||||
+7
-13
@@ -36,7 +36,7 @@ class Generator
|
||||
* @param \Symfony\Component\Console\Output\OutputInterface $output
|
||||
* @param string $helpers
|
||||
*/
|
||||
public function __construct(/*ConfigRepository */ $config,
|
||||
public function __construct(ConfigRepository $config,
|
||||
/* Illuminate\View\Factory */ $view,
|
||||
OutputInterface $output = null,
|
||||
$helpers = ''
|
||||
@@ -47,9 +47,9 @@ class Generator
|
||||
// Find the drivers to add to the extra/interfaces
|
||||
$this->detectDrivers();
|
||||
|
||||
$this->extra = array_merge($this->extra, $this->config->get('ide-helper.extra'));
|
||||
$this->magic = array_merge($this->magic, $this->config->get('ide-helper.magic'));
|
||||
$this->interfaces = array_merge($this->interfaces, $this->config->get('ide-helper.interfaces'));
|
||||
$this->extra = array_merge($this->extra, $this->config->get('laravel-ide-helper::extra'));
|
||||
$this->magic = array_merge($this->magic, $this->config->get('laravel-ide-helper::magic'));
|
||||
$this->interfaces = array_merge($this->interfaces, $this->config->get('laravel-ide-helper::interfaces'));
|
||||
// Make all interface classes absolute
|
||||
foreach ($this->interfaces as &$interface) {
|
||||
$interface = '\\' . ltrim($interface, '\\');
|
||||
@@ -77,7 +77,7 @@ class Generator
|
||||
public function generatePhpHelper()
|
||||
{
|
||||
$app = app();
|
||||
return $this->view->make('ide-helper::helper')
|
||||
return $this->view->make('laravel-ide-helper::ide-helper')
|
||||
->with('namespaces', $this->getNamespaces())
|
||||
->with('helpers', $this->helpers)
|
||||
->with('version', $app::VERSION)
|
||||
@@ -113,8 +113,8 @@ class Generator
|
||||
|
||||
protected function detectDrivers()
|
||||
{
|
||||
try{
|
||||
if (class_exists('Auth') && is_a('Auth', '\Illuminate\Support\Facades\Auth', true)) {
|
||||
try{
|
||||
if (class_exists('Auth') && is_a('Auth', '\Illuminate\Support\Facades\Auth', true)) {
|
||||
$class = get_class(\Auth::driver());
|
||||
$this->extra['Auth'] = array($class);
|
||||
$this->interfaces['\Illuminate\Auth\UserProviderInterface'] = $class;
|
||||
@@ -167,12 +167,6 @@ class Generator
|
||||
|
||||
// Get all aliases
|
||||
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();
|
||||
$alias = new Alias($name, $facade, $magicMethods, $this->interfaces);
|
||||
if ($alias->isValid()) {
|
||||
|
||||
@@ -11,9 +11,8 @@
|
||||
namespace Barryvdh\LaravelIdeHelper;
|
||||
|
||||
use Illuminate\Support\ServiceProvider;
|
||||
use Barryvdh\LaravelIdeHelper\Console\MetaCommand;
|
||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||
use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
|
||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||
|
||||
class IdeHelperServiceProvider extends ServiceProvider
|
||||
{
|
||||
@@ -32,11 +31,7 @@ class IdeHelperServiceProvider extends ServiceProvider
|
||||
*/
|
||||
public function boot()
|
||||
{
|
||||
$viewPath = __DIR__.'/../resources/views';
|
||||
$this->loadViewsFrom($viewPath, 'ide-helper');
|
||||
|
||||
$configPath = __DIR__ . '/../config/ide-helper.php';
|
||||
$this->publishes([$configPath => config_path('ide-helper.php')], 'config');
|
||||
$this->package('barryvdh/laravel-ide-helper', 'laravel-ide-helper', __DIR__);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -46,9 +41,6 @@ class IdeHelperServiceProvider extends ServiceProvider
|
||||
*/
|
||||
public function register()
|
||||
{
|
||||
$configPath = __DIR__ . '/../config/ide-helper.php';
|
||||
$this->mergeConfigFrom($configPath, 'ide-helper');
|
||||
|
||||
$this->app['command.ide-helper.generate'] = $this->app->share(
|
||||
function ($app) {
|
||||
return new GeneratorCommand($app['config'], $app['files'], $app['view']);
|
||||
@@ -60,14 +52,8 @@ class IdeHelperServiceProvider extends ServiceProvider
|
||||
return new ModelsCommand();
|
||||
}
|
||||
);
|
||||
|
||||
$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', 'command.ide-helper.meta');
|
||||
$this->commands('command.ide-helper.generate', 'command.ide-helper.models');
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -79,5 +65,37 @@ class IdeHelperServiceProvider extends ServiceProvider
|
||||
{
|
||||
return array('command.ide-helper.generate', 'command.ide-helper.models');
|
||||
}
|
||||
|
||||
/**
|
||||
* Register the package's component namespaces.
|
||||
*
|
||||
* @param string $package
|
||||
* @param string $namespace
|
||||
* @param string $path
|
||||
* @return void
|
||||
*/
|
||||
public function package($package, $namespace = null, $path = null)
|
||||
{
|
||||
|
||||
// Is it possible to register the config?
|
||||
if (method_exists($this->app['config'], 'package')) {
|
||||
$this->app['config']->package($package, $path.'/config', $namespace);
|
||||
} else {
|
||||
// Load the config for now..
|
||||
$config = $this->app['files']->getRequire($path .'/config/config.php');
|
||||
foreach($config as $key => $value){
|
||||
$this->app['config']->set($namespace.'::'.$key, $value);
|
||||
}
|
||||
}
|
||||
|
||||
// Register view files
|
||||
$appView = $this->app['path']."/views/packages/{$package}";
|
||||
if ($this->app['files']->isDirectory($appView))
|
||||
{
|
||||
$this->app['view']->addNamespace($namespace, $appView);
|
||||
}
|
||||
|
||||
$this->app['view']->addNamespace($namespace, $path.'/views');
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
<?php
|
||||
|
||||
use Illuminate\Support\Facades\Config;
|
||||
|
||||
return array(
|
||||
|
||||
/*
|
||||
@@ -41,7 +43,7 @@ return array(
|
||||
*/
|
||||
|
||||
'model_locations' => array(
|
||||
'app',
|
||||
'app/models',
|
||||
),
|
||||
|
||||
|
||||
@@ -55,6 +57,7 @@ return array(
|
||||
*/
|
||||
|
||||
'extra' => array(
|
||||
'Artisan' => array('Illuminate\Foundation\Artisan'),
|
||||
'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
|
||||
'Session' => array('Illuminate\Session\Store'),
|
||||
),
|
||||
@@ -83,37 +86,7 @@ return array(
|
||||
*/
|
||||
|
||||
'interfaces' => array(
|
||||
'\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(
|
||||
|
||||
),
|
||||
'\Illuminate\Auth\UserInterface' => Config::get('auth.model', 'User'),
|
||||
)
|
||||
|
||||
);
|
||||
@@ -1,39 +1,39 @@
|
||||
<?= '<?php' ?>
|
||||
|
||||
/**
|
||||
* A helper file for Laravel 5, to provide autocomplete information to your IDE
|
||||
* Generated for Laravel <?= $version ?> on <?= date("Y-m-d") ?>.
|
||||
*
|
||||
* @author Barry vd. Heuvel <barryvdh@gmail.com>
|
||||
* @see https://github.com/barryvdh/laravel-ide-helper
|
||||
*/
|
||||
|
||||
<?php foreach($namespaces as $namespace => $aliases): ?>
|
||||
namespace <?= $namespace == '__root' ? '' : $namespace ?>{
|
||||
<?php if($namespace == '__root'): ?>
|
||||
exit("This file should not be included, only analyzed by your IDE");
|
||||
<?= $helpers ?>
|
||||
<?php endif; ?>
|
||||
<?php foreach($aliases as $alias): ?>
|
||||
|
||||
<?= $alias->getClassType() ?> <?= $alias->getShortName() ?> <?= $alias->getExtends() ? 'extends ' . $alias->getExtends() : '' ?>{
|
||||
<?php foreach($alias->getMethods() as $method): ?>
|
||||
|
||||
<?= trim($method->getDocComment(' ')) ?>
|
||||
|
||||
public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>){<?php if($method->getDeclaringClass() !== $method->getRoot()): ?>
|
||||
|
||||
//Method inherited from <?= $method->getDeclaringClass() ?>
|
||||
<?php endif; ?>
|
||||
|
||||
<?= $method->shouldReturn() ? 'return ': '' ?><?= $method->getRoot() ?>::<?= $method->getName() ?>(<?= $method->getParams() ?>);
|
||||
}
|
||||
<?php endforeach; ?>
|
||||
|
||||
}
|
||||
|
||||
<?php endforeach; ?>
|
||||
|
||||
}
|
||||
|
||||
<?php endforeach; ?>
|
||||
<?= '<?php' ?>
|
||||
|
||||
/**
|
||||
* An helper file for Laravel 4, to provide autocomplete information to your IDE
|
||||
* Generated for Laravel <?= $version ?> on <?= date("Y-m-d") ?>.
|
||||
*
|
||||
* @author Barry vd. Heuvel <barryvdh@gmail.com>
|
||||
* @see https://github.com/barryvdh/laravel-ide-helper
|
||||
*/
|
||||
|
||||
<?php foreach($namespaces as $namespace => $aliases): ?>
|
||||
namespace <?= $namespace == '__root' ? '' : $namespace ?>{
|
||||
<?php if($namespace == '__root'): ?>
|
||||
exit("This file should not be included, only analyzed by your IDE");
|
||||
<?= $helpers ?>
|
||||
<?php endif; ?>
|
||||
<?php foreach($aliases as $alias): ?>
|
||||
|
||||
<?= $alias->getClassType() ?> <?= $alias->getShortName() ?> <?= $alias->getExtends() ? 'extends ' . $alias->getExtends() : '' ?>{
|
||||
<?php foreach($alias->getMethods() as $method): ?>
|
||||
|
||||
<?= trim($method->getDocComment(' ')) ?>
|
||||
|
||||
public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>){<?php if($method->getDeclaringClass() !== $method->getRoot()): ?>
|
||||
|
||||
//Method inherited from <?= $method->getDeclaringClass() ?>
|
||||
<?php endif; ?>
|
||||
|
||||
<?= $method->shouldReturn() ? 'return ': '' ?><?= $method->getRoot() ?>::<?= $method->getName() ?>(<?= $method->getParams() ?>);
|
||||
}
|
||||
<?php endforeach; ?>
|
||||
|
||||
}
|
||||
|
||||
<?php endforeach; ?>
|
||||
|
||||
}
|
||||
|
||||
<?php endforeach; ?>
|
||||
Reference in New Issue
Block a user