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 | ||
|
|
c94012232f | ||
|
|
b9685a1f83 | ||
|
|
7bc74b1844 | ||
|
|
cfa0333446 | ||
|
|
5c6fa1d43f | ||
|
|
23db0e06ca | ||
|
|
52b3accd70 | ||
|
|
cc07cd3b2c | ||
|
|
3113f58f45 | ||
|
|
d00dc62ed6 | ||
|
|
073d90b791 | ||
|
|
5d4af73c29 | ||
|
|
39ffaa62f4 | ||
|
|
231e125821 | ||
|
|
f446326967 | ||
|
|
57dc033061 | ||
|
|
e2b59c6cb5 | ||
|
|
736f2f387e | ||
|
|
486d9d9c4d | ||
|
|
ac8b868261 | ||
|
|
c0eb7e2d7e | ||
|
|
89a17fc7b9 | ||
|
|
ec43d4e65b | ||
|
|
03cc70759b | ||
|
|
f94743fda5 | ||
|
|
3eabba3e5d | ||
|
|
f2de8d3c65 | ||
|
|
10e16a0bdc | ||
|
|
f135845100 | ||
|
|
3c54b17760 |
+2
-2
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"providers": [
|
||||
"Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider"
|
||||
"Barryvdh\\LaravelIdeHelper\\IdeHelperServiceProvider"
|
||||
]
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
## Laravel IDE Helper Generator
|
||||
[](https://packagist.org/packages/barryvdh/laravel-ide-helper) [](https://packagist.org/packages/barryvdh/laravel-ide-helper)
|
||||
|
||||
### 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!_
|
||||
@@ -14,9 +16,9 @@ Note: You do need CodeIntel for Sublime Text: https://github.com/SublimeCodeInte
|
||||
|
||||
### Automatic phpDoc generation for Laravel Facades
|
||||
|
||||
Require this package in your composer.json and run composer update (or run `composer require barryvdh/laravel-ide-helper:1.*` directly):
|
||||
Require this package with composer using the following command:
|
||||
|
||||
"barryvdh/laravel-ide-helper": "1.*"
|
||||
composer require barryvdh/laravel-ide-helper
|
||||
|
||||
After updating composer, add the ServiceProvider to the providers array in app/config/app.php
|
||||
|
||||
@@ -34,7 +36,7 @@ You can configure your composer.json to do this after each commit:
|
||||
"post-update-cmd":[
|
||||
"php artisan clear-compiled",
|
||||
"php artisan ide-helper:generate",
|
||||
"php artisan optimize",
|
||||
"php artisan optimize"
|
||||
]
|
||||
},
|
||||
|
||||
|
||||
@@ -150,8 +150,6 @@ class ModelsCommand extends Command
|
||||
if (in_array($name, $ignore)) {
|
||||
$this->comment("Ignoring model '$name'");
|
||||
continue;
|
||||
} else {
|
||||
$this->comment("Loading model '$name'");
|
||||
}
|
||||
$this->properties = array();
|
||||
$this->methods = array();
|
||||
@@ -159,33 +157,35 @@ class ModelsCommand extends Command
|
||||
try {
|
||||
// handle abstract classes, interfaces, ...
|
||||
$reflectionClass = new \ReflectionClass($name);
|
||||
if (!$reflectionClass->IsInstantiable()) {
|
||||
throw new \Exception($name . ' is not instanciable.');
|
||||
} elseif (!$reflectionClass->isSubclassOf('Illuminate\Database\Eloquent\Model')) {
|
||||
$this->comment("Class '$name' is not a model");
|
||||
|
||||
if (!$reflectionClass->isSubclassOf('Illuminate\Database\Eloquent\Model')) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$model = new $name();
|
||||
$this->comment("Loading model '$name'");
|
||||
|
||||
if (!$reflectionClass->IsInstantiable()) {
|
||||
throw new \Exception($name . ' is not instantiable.');
|
||||
}
|
||||
|
||||
$model = $this->laravel->make($name);
|
||||
|
||||
if ($hasDoctrine) {
|
||||
$this->getPropertiesFromTable($model);
|
||||
}
|
||||
|
||||
$this->getPropertiesFromMethods($model);
|
||||
$output .= $this->createPhpDocs($name);
|
||||
} catch (\Exception $e) {
|
||||
$this->error("Exception: " . $e->getMessage() . "\nCould not analyze class $name.");
|
||||
}
|
||||
} elseif (interface_exists($name) || (function_exists('trait_exists') && trait_exists($name))) {
|
||||
$this->info("Skipping interface/trait $name");
|
||||
} else {
|
||||
$this->error("Class $name does not exist");
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
if (!$hasDoctrine) {
|
||||
$this->error(
|
||||
"Warning: 'doctrine/dbal: ~2.3' is required to load database information. Please require that in your composer.json and run 'composer update'."
|
||||
'Warning: `"doctrine/dbal": "~2.3"` is required to load database information. Please require that in your composer.json and run `composer update`.'
|
||||
);
|
||||
}
|
||||
|
||||
@@ -256,8 +256,8 @@ class ModelsCommand extends Command
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
$this->setProperty($name, $type, true, true);
|
||||
$comment = $column->getComment();
|
||||
$this->setProperty($name, $type, true, true, $comment);
|
||||
$this->setMethod(
|
||||
Str::camel("where_" . $name),
|
||||
'\Illuminate\Database\Query\Builder|\\' . get_class($model),
|
||||
@@ -333,9 +333,9 @@ class ModelsCommand extends Command
|
||||
$search = '$this->' . $relation . '(';
|
||||
if ($pos = stripos($code, $search)) {
|
||||
$code = substr($code, $pos + strlen($search));
|
||||
$arguments = explode(',', substr($code, 0, stripos($code, ')')));
|
||||
$arguments = explode(',', substr($code, 0, strpos($code, ');')));
|
||||
//Remove quotes, ensure 1 \ in front of the model
|
||||
$returnModel = "\\" . ltrim(trim($arguments[0], " \"'"), "\\");
|
||||
$returnModel = $this->getClassName($arguments[0], $model);
|
||||
if ($relation === "belongsToMany" or $relation === 'hasMany' or $relation === 'morphMany' or $relation === 'morphToMany') {
|
||||
//Collection or array of models (because Collection is Arrayable)
|
||||
$this->setProperty(
|
||||
@@ -361,14 +361,16 @@ class ModelsCommand extends Command
|
||||
* @param string|null $type
|
||||
* @param bool|null $read
|
||||
* @param bool|null $write
|
||||
* @param string|null $comment
|
||||
*/
|
||||
protected function setProperty($name, $type = null, $read = null, $write = null)
|
||||
protected function setProperty($name, $type = null, $read = null, $write = null, $comment='')
|
||||
{
|
||||
if (!isset($this->properties[$name])) {
|
||||
$this->properties[$name] = array();
|
||||
$this->properties[$name]['type'] = 'mixed';
|
||||
$this->properties[$name]['read'] = false;
|
||||
$this->properties[$name]['write'] = false;
|
||||
$this->properties[$name]['comment'] = (string) $comment;
|
||||
}
|
||||
if ($type !== null) {
|
||||
$this->properties[$name]['type'] = $type;
|
||||
@@ -435,7 +437,7 @@ class ModelsCommand extends Command
|
||||
} else {
|
||||
$attr = 'property-read';
|
||||
}
|
||||
$tag = Tag::createInstance("@{$attr} {$property['type']} {$name}", $phpdoc);
|
||||
$tag = Tag::createInstance("@{$attr} {$property['type']} {$name} {$property['comment']}", $phpdoc);
|
||||
$phpdoc->appendTag($tag);
|
||||
}
|
||||
|
||||
@@ -444,7 +446,7 @@ class ModelsCommand extends Command
|
||||
continue;
|
||||
}
|
||||
$arguments = implode(', ', $method['arguments']);
|
||||
$tag = Tag::createInstance("@method static {$method['type']} {$name}({$arguments}) ", $phpdoc);
|
||||
$tag = Tag::createInstance("@method static {$method['type']} {$name}({$arguments})", $phpdoc);
|
||||
$phpdoc->appendTag($tag);
|
||||
}
|
||||
|
||||
@@ -509,4 +511,24 @@ class ModelsCommand extends Command
|
||||
return $paramsWithDefault;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $className
|
||||
* @param \Illuminate\Database\Eloquent\Model $model
|
||||
* @return string
|
||||
*/
|
||||
private function getClassName($className, $model)
|
||||
{
|
||||
// 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) {
|
||||
return get_class($model);
|
||||
}
|
||||
|
||||
// If the class name was resolved via ::class (PHP 5.5+)
|
||||
if (strpos($className, '::class') !== false) {
|
||||
$end = -1 * strlen('::class');
|
||||
return substr($className, 0, $end);
|
||||
}
|
||||
|
||||
return "\\" . ltrim(trim($className, " \"'"), "\\") ;
|
||||
}
|
||||
}
|
||||
|
||||
+10
-10
@@ -50,6 +50,10 @@ class Generator
|
||||
$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, '\\');
|
||||
}
|
||||
$this->helpers = $helpers;
|
||||
}
|
||||
|
||||
@@ -109,8 +113,8 @@ class Generator
|
||||
|
||||
protected function detectDrivers()
|
||||
{
|
||||
try{
|
||||
if (class_exists('Auth')) {
|
||||
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;
|
||||
@@ -118,7 +122,7 @@ class Generator
|
||||
}catch (\Exception $e) {}
|
||||
|
||||
try{
|
||||
if (class_exists('DB')) {
|
||||
if (class_exists('DB') && is_a('DB', '\Illuminate\Support\Facades\DB', true)) {
|
||||
$class = get_class(\DB::connection());
|
||||
$this->extra['DB'] = array($class);
|
||||
$this->interfaces['\Illuminate\Database\ConnectionInterface'] = $class;
|
||||
@@ -126,7 +130,7 @@ class Generator
|
||||
}catch (\Exception $e) {}
|
||||
|
||||
try{
|
||||
if (class_exists('Cache')) {
|
||||
if (class_exists('Cache') && is_a('Cache', '\Illuminate\Support\Facades\Cache', true)) {
|
||||
$driver = get_class(\Cache::driver());
|
||||
$store = get_class(\Cache::getStore());
|
||||
$this->extra['Cache'] = array($driver, $store);
|
||||
@@ -135,7 +139,7 @@ class Generator
|
||||
}catch (\Exception $e) {}
|
||||
|
||||
try{
|
||||
if (class_exists('Queue')) {
|
||||
if (class_exists('Queue') && is_a('Queue', '\Illuminate\Support\Facades\Queue', true)) {
|
||||
$class = get_class(\Queue::connection());
|
||||
$this->extra['Queue'] = array($class);
|
||||
$this->interfaces['\Illuminate\Queue\QueueInterface'] = $class;
|
||||
@@ -143,17 +147,13 @@ class Generator
|
||||
}catch (\Exception $e) {}
|
||||
|
||||
try{
|
||||
if (class_exists('SSH')){
|
||||
if (class_exists('SSH') && is_a('SSH', '\Illuminate\Support\Facades\SSH', true)){
|
||||
$class = get_class(\SSH::connection());
|
||||
$this->extra['SSH'] = array($class);
|
||||
$this->interfaces['\Illuminate\Remote\ConnectionInterface'] = $class;
|
||||
}
|
||||
}catch (\Exception $e) {}
|
||||
|
||||
// Make all interface classes absolute
|
||||
foreach ($this->interfaces as &$interface) {
|
||||
$interface = '\\' . ltrim($interface, '\\');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -12,8 +12,7 @@ namespace Barryvdh\LaravelIdeHelper;
|
||||
|
||||
use Illuminate\Support\ServiceProvider;
|
||||
use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
|
||||
use Barryvdh\LaravelIdeHelper\Console\Generator2Command;
|
||||
Use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||
|
||||
class IdeHelperServiceProvider extends ServiceProvider
|
||||
{
|
||||
@@ -66,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
-1
@@ -261,7 +261,7 @@ class Method
|
||||
$paramStr = '$' . $param->getName();
|
||||
$params[] = $paramStr;
|
||||
if ($param->isOptional()) {
|
||||
$default = $param->getDefaultValue();
|
||||
$default = $param->isDefaultValueAvailable() ? $param->getDefaultValue() : null;
|
||||
if (is_bool($default)) {
|
||||
$default = $default ? 'true' : 'false';
|
||||
} elseif (is_array($default)) {
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
<?php
|
||||
<?php
|
||||
|
||||
use Illuminate\Support\Facades\Config;
|
||||
|
||||
return array(
|
||||
|
||||
@@ -84,7 +86,7 @@ return array(
|
||||
*/
|
||||
|
||||
'interfaces' => array(
|
||||
'\Illuminate\Auth\UserInterface' => '\User',
|
||||
'\Illuminate\Auth\UserInterface' => Config::get('auth.model', 'User'),
|
||||
)
|
||||
|
||||
);
|
||||
|
||||
Reference in New Issue
Block a user