mirror of
https://github.com/barryvdh/laravel-ide-helper.git
synced 2026-08-18 10:07:12 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
eda37f3442 |
+1
-1
@@ -14,7 +14,7 @@
|
|||||||
"illuminate/support": "4.x",
|
"illuminate/support": "4.x",
|
||||||
"illuminate/console": "4.x",
|
"illuminate/console": "4.x",
|
||||||
"illuminate/filesystem": "4.x",
|
"illuminate/filesystem": "4.x",
|
||||||
"phpdocumentor/reflection-docblock": "2.0.0",
|
"barryvdh/reflection-docblock": ">=2.0.1",
|
||||||
"symfony/class-loader": "~2.3"
|
"symfony/class-loader": "~2.3"
|
||||||
},
|
},
|
||||||
"autoload": {
|
"autoload": {
|
||||||
|
|||||||
@@ -52,8 +52,9 @@ The Illuminate/Support/helpers.php is already set-up, but you can add/remove you
|
|||||||
|
|
||||||
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. Still in beta, so please provide feedback if you want.
|
phpDocs, based on table columns, relations and getters/setters. Still in beta, so please provide feedback if you want.
|
||||||
You can now also write the comments directly to your Model file, using the `--write (-W)` option. By default, you are asked to overwrite or
|
Docs are written to a phpfile (_ide_helper_models.php) in the root of the project, so you can move the docs to the real model.
|
||||||
write to a seperate file (_ide_helper_models.php) Please make sure to backup your models, before writing the info.
|
|
||||||
|
You can now also write the comments directly to your Model file, using the `--write (-W)` option. 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.
|
||||||
|
|
||||||
@@ -72,15 +73,11 @@ 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).
|
For now, only 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):
|
Note: With namespaces, uses `\\` instead of `\`: `php artisan ide-helper:models API\\User`
|
||||||
|
|
||||||
php artisan ide-helper:models --dir="app/workbench/name/package/models"
|
|
||||||
|
|
||||||
Note: With namespaces, wrap your model name in " signs: `php artisan ide-helper:models "API\User"`, or escape the slashes (`Api\\User`)
|
|
||||||
|
|
||||||
### License
|
### License
|
||||||
|
|
||||||
|
|||||||
@@ -13,10 +13,10 @@ use Illuminate\Console\Command;
|
|||||||
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 Illuminate\Foundation\AliasLoader;
|
use Illuminate\Foundation\AliasLoader;
|
||||||
use phpDocumentor\Reflection\DocBlock;
|
use Barryvdh\Reflection\DocBlock;
|
||||||
use phpDocumentor\Reflection\DocBlock\Context;
|
use Barryvdh\Reflection\DocBlock\Context;
|
||||||
use phpDocumentor\Reflection\DocBlock\Tag;
|
use Barryvdh\Reflection\DocBlock\Tag;
|
||||||
use phpDocumentor\Reflection\DocBlock\Serializer as DocBlockSerializer;
|
use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
|
||||||
/**
|
/**
|
||||||
* A command to generate autocomplete information for your IDE
|
* A command to generate autocomplete information for your IDE
|
||||||
*
|
*
|
||||||
@@ -41,7 +41,6 @@ class GeneratorCommand extends Command {
|
|||||||
protected $extra;
|
protected $extra;
|
||||||
protected $onlyExtend;
|
protected $onlyExtend;
|
||||||
protected $helpers;
|
protected $helpers;
|
||||||
protected $magic;
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -61,7 +60,6 @@ class GeneratorCommand extends Command {
|
|||||||
}
|
}
|
||||||
|
|
||||||
$this->extra = \Config::get('laravel-ide-helper::extra');
|
$this->extra = \Config::get('laravel-ide-helper::extra');
|
||||||
$this->magic = \Config::get('laravel-ide-helper::magic');
|
|
||||||
|
|
||||||
if( $this->option('helpers') || (\Config::get('laravel-ide-helper::include_helpers') )){
|
if( $this->option('helpers') || (\Config::get('laravel-ide-helper::include_helpers') )){
|
||||||
$this->helpers = \Config::get('laravel-ide-helper::helper_files');
|
$this->helpers = \Config::get('laravel-ide-helper::helper_files');
|
||||||
@@ -170,11 +168,6 @@ exit('Only to be used as an helper for your IDE');\n\n";
|
|||||||
$output .= $this->getMethods($this->extra[$alias], $alias, $usedMethods);
|
$output .= $this->getMethods($this->extra[$alias], $alias, $usedMethods);
|
||||||
}
|
}
|
||||||
|
|
||||||
//Add extra methods, from other classes (magic static calls)
|
|
||||||
if(array_key_exists($alias, $this->magic)){
|
|
||||||
$output .= $this->addMagicMethods($this->magic[$alias], $alias, $usedMethods);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
$output .= "}\n\n";
|
$output .= "}\n\n";
|
||||||
|
|
||||||
@@ -185,8 +178,8 @@ exit('Only to be used as an helper for your IDE');\n\n";
|
|||||||
}
|
}
|
||||||
|
|
||||||
//Include the helper file, if requested
|
//Include the helper file, if requested
|
||||||
if(!empty($this->helpers)){
|
if(!empty($helpers)){
|
||||||
foreach($this->helpers as $helper){
|
foreach($helpers as $helper){
|
||||||
if (file_exists($helper)){
|
if (file_exists($helper)){
|
||||||
$output .= str_replace(array('<?php', '?>'), '', \File::get($helper));
|
$output .= str_replace(array('<?php', '?>'), '', \File::get($helper));
|
||||||
}
|
}
|
||||||
@@ -288,54 +281,18 @@ exit('Only to be used as an helper for your IDE');\n\n";
|
|||||||
return $output;
|
return $output;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the methods for one or multiple magic methods.
|
|
||||||
*
|
|
||||||
* @param $methods
|
|
||||||
* @param $alias
|
|
||||||
* @param $usedMethods
|
|
||||||
* @param bool $addOutput
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
protected function addMagicMethods($methods, $alias, &$usedMethods, $addOutput = true){
|
|
||||||
$output = '';
|
|
||||||
foreach($methods as $magic => $real){
|
|
||||||
list($className, $name) = explode('::', $real);
|
|
||||||
if(!class_exists($className) && !interface_exists($className)){
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
$method = new \ReflectionMethod($className, $name);
|
|
||||||
$class = new \ReflectionClass($className);
|
|
||||||
|
|
||||||
if(!in_array($method->name, $usedMethods)){
|
|
||||||
if( $addOutput){
|
|
||||||
$output .= $this->parseMethod($method, $alias, $class, $magic);
|
|
||||||
}
|
|
||||||
$usedMethods[] = $method->name;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
$usedMethods[] = $magic;
|
|
||||||
|
|
||||||
}
|
|
||||||
return $output;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param \ReflectionMethod $method
|
* @param \ReflectionMethod $method
|
||||||
* @param string $alias
|
* @param string $alias
|
||||||
* @param $class
|
|
||||||
* @param null $methodName
|
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
protected function parseMethod($method, $alias, $class, $methodName = null){
|
protected function parseMethod($method, $alias, $class){
|
||||||
$output = '';
|
$output = '';
|
||||||
|
|
||||||
// Don't add the __clone() functions
|
// Don't add the __clone() functions
|
||||||
if($method->name === '__clone'){
|
if($method->name === '__clone'){
|
||||||
return $output;
|
return $output;
|
||||||
}
|
}
|
||||||
$methodName = $methodName ?: $method->name;
|
|
||||||
|
|
||||||
$namespace = $method->getDeclaringClass()->getNamespaceName();
|
$namespace = $method->getDeclaringClass()->getNamespaceName();
|
||||||
|
|
||||||
@@ -347,7 +304,7 @@ exit('Only to be used as an helper for your IDE');\n\n";
|
|||||||
$this->normalizeDescription($phpdoc, $method);
|
$this->normalizeDescription($phpdoc, $method);
|
||||||
|
|
||||||
//Correct the return values
|
//Correct the return values
|
||||||
$returnValue = $this->getReturn($phpdoc);
|
$returnValue = $this->normalizeReturn($phpdoc, $method, $alias);
|
||||||
|
|
||||||
//Get the parameters, including formatted default values
|
//Get the parameters, including formatted default values
|
||||||
list($params, $paramsWithDefault) = $this->getParameters($method);
|
list($params, $paramsWithDefault) = $this->getParameters($method);
|
||||||
@@ -356,7 +313,7 @@ exit('Only to be used as an helper for your IDE');\n\n";
|
|||||||
$phpdoc->appendTag(Tag::createInstance('@static', $phpdoc));
|
$phpdoc->appendTag(Tag::createInstance('@static', $phpdoc));
|
||||||
|
|
||||||
//Write the output, using the DocBlock serializer
|
//Write the output, using the DocBlock serializer
|
||||||
$output .= $serializer->getDocComment($phpdoc) ."\n\t public static function ".$methodName."(";
|
$output .= $serializer->getDocComment($phpdoc) ."\n\t public static function ".$method->name."(";
|
||||||
|
|
||||||
$output .= implode($paramsWithDefault, ", ");
|
$output .= implode($paramsWithDefault, ", ");
|
||||||
$output .= "){\r\n";
|
$output .= "){\r\n";
|
||||||
@@ -414,15 +371,23 @@ exit('Only to be used as an helper for your IDE');\n\n";
|
|||||||
* Make some changes to the return types, if needed.
|
* Make some changes to the return types, if needed.
|
||||||
*
|
*
|
||||||
* @param $phpdoc
|
* @param $phpdoc
|
||||||
* @return string|null
|
* @param $method
|
||||||
|
* @param $alias
|
||||||
|
* @return null
|
||||||
*/
|
*/
|
||||||
protected function getReturn($phpdoc){
|
protected function normalizeReturn(&$phpdoc, $method, $alias){
|
||||||
//Get the return type and adjust them for beter autocomplete
|
//Get the return type and adjust them for beter autocomplete
|
||||||
$returnTags = $phpdoc->getTagsByName('return');
|
$returnTags = $phpdoc->getTagsByName('return');
|
||||||
if($returnTags){
|
if($returnTags){
|
||||||
/** @var $tag */
|
/** @var $tag */
|
||||||
$tag = reset($returnTags);
|
$tag = reset($returnTags);
|
||||||
$returnValue = $tag->getType();
|
$returnValue = $tag->getType();
|
||||||
|
|
||||||
|
if($method->name == "__construct"){
|
||||||
|
$tag->setType('self');
|
||||||
|
}elseif($alias == 'Eloquent' and in_array($method->name, array('hasOne', 'hasMany', 'belongsTo', 'belongsToMany', 'morphOne', 'morphTo', 'morphMany'))){
|
||||||
|
$tag->addType('\Eloquent');
|
||||||
|
}
|
||||||
}else{
|
}else{
|
||||||
$returnValue = null;
|
$returnValue = null;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ class IdeHelperServiceProvider extends ServiceProvider {
|
|||||||
*
|
*
|
||||||
* @var bool
|
* @var bool
|
||||||
*/
|
*/
|
||||||
protected $defer = true;
|
protected $defer = false;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Bootstrap the application events.
|
* Bootstrap the application events.
|
||||||
|
|||||||
@@ -13,10 +13,10 @@ use Illuminate\Console\Command;
|
|||||||
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\ClassLoader\ClassMapGenerator;
|
use Symfony\Component\ClassLoader\ClassMapGenerator;
|
||||||
use phpDocumentor\Reflection\DocBlock;
|
use Barryvdh\Reflection\DocBlock;
|
||||||
use phpDocumentor\Reflection\DocBlock\Context;
|
use Barryvdh\Reflection\DocBlock\Context;
|
||||||
use phpDocumentor\Reflection\DocBlock\Tag;
|
use Barryvdh\Reflection\DocBlock\Tag;
|
||||||
use phpDocumentor\Reflection\DocBlock\Serializer as DocBlockSerializer;
|
use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
|
||||||
/**
|
/**
|
||||||
* A command to generate autocomplete information for your IDE
|
* A command to generate autocomplete information for your IDE
|
||||||
*
|
*
|
||||||
@@ -30,7 +30,6 @@ class ModelsCommand extends Command {
|
|||||||
* @var string
|
* @var string
|
||||||
*/
|
*/
|
||||||
protected $name = 'ide-helper:models';
|
protected $name = 'ide-helper:models';
|
||||||
protected $filename = '_ide_helper_models.php';
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The console command description.
|
* The console command description.
|
||||||
@@ -60,13 +59,6 @@ class ModelsCommand extends Command {
|
|||||||
$model = $this->argument('model');
|
$model = $this->argument('model');
|
||||||
$this->reset = $this->option('reset');
|
$this->reset = $this->option('reset');
|
||||||
|
|
||||||
//If filename is default and Write is not specified, ask what to do
|
|
||||||
if(!$this->write && $filename === $this->filename){
|
|
||||||
if($this->confirm("Do you want to overwrite the existing model files for '$model'? Choose no to write to $filename instead? (Yes/No): ")){
|
|
||||||
$this->write = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
$content = $this->generateDocs($model);
|
$content = $this->generateDocs($model);
|
||||||
|
|
||||||
if(!$this->write){
|
if(!$this->write){
|
||||||
@@ -77,6 +69,7 @@ class ModelsCommand extends Command {
|
|||||||
$this->error("Failed to write model information to $filename");
|
$this->error("Failed to write model information to $filename");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
@@ -101,7 +94,7 @@ class ModelsCommand extends Command {
|
|||||||
protected function getOptions()
|
protected function getOptions()
|
||||||
{
|
{
|
||||||
return array(
|
return array(
|
||||||
array('filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the helper file', $this->filename),
|
array('filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the helper file', '_ide_helper_models.php'),
|
||||||
array('dir', 'D', InputOption::VALUE_OPTIONAL, 'The model dir','app/models'),
|
array('dir', 'D', InputOption::VALUE_OPTIONAL, 'The model dir','app/models'),
|
||||||
array('write', 'W', InputOption::VALUE_NONE, 'Write to Model file'),
|
array('write', 'W', InputOption::VALUE_NONE, 'Write to Model file'),
|
||||||
array('reset', 'R', InputOption::VALUE_NONE, 'Remove the original phpdocs instead of appending'),
|
array('reset', 'R', InputOption::VALUE_NONE, 'Remove the original phpdocs instead of appending'),
|
||||||
@@ -232,13 +225,9 @@ class ModelsCommand extends Command {
|
|||||||
}
|
}
|
||||||
}elseif(\Str::startsWith($method, 'scope') && $method !== 'scopeQuery'){
|
}elseif(\Str::startsWith($method, 'scope') && $method !== 'scopeQuery'){
|
||||||
//Magic set<name>Attribute
|
//Magic set<name>Attribute
|
||||||
$name = \Str::camel(substr($method, 5));
|
$name = \Str::snake(substr($method, 5));
|
||||||
if(!empty($name)){
|
if(!empty($name)){
|
||||||
$reflection = new \ReflectionMethod($model, $method);
|
$this->setMethod($name, 'static');
|
||||||
$args = $this->getParameters($reflection);
|
|
||||||
//Remove the first ($query) argument
|
|
||||||
array_shift($args);
|
|
||||||
$this->setMethod($name, $reflection->class, $args);
|
|
||||||
}
|
}
|
||||||
}elseif(!method_exists('Eloquent', $method) && !\Str::startsWith($method, 'get')){
|
}elseif(!method_exists('Eloquent', $method) && !\Str::startsWith($method, 'get')){
|
||||||
|
|
||||||
@@ -304,11 +293,13 @@ class ModelsCommand extends Command {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
protected function setMethod($name, $type = '', $arguments=array()){
|
protected function setMethod($name, $type = null){
|
||||||
if(!isset($this->methods[$name])){
|
if(!isset($this->methods[$name])){
|
||||||
$this->methods[$name] = array();
|
$this->methods[$name] = array();
|
||||||
|
$this->methods[$name]['type'] = 'static';
|
||||||
|
}
|
||||||
|
if($type !== null){
|
||||||
$this->methods[$name]['type'] = $type;
|
$this->methods[$name]['type'] = $type;
|
||||||
$this->methods[$name]['arguments'] = $arguments;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -364,8 +355,8 @@ class ModelsCommand extends Command {
|
|||||||
if(in_array($name, $methods)){
|
if(in_array($name, $methods)){
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
$arguments = implode(', ',$method['arguments']);
|
$name = "$name()";
|
||||||
$tag = Tag::createInstance("@method static {$method['type']} {$name}({$arguments}) ", $phpdoc);
|
$tag = Tag::createInstance("@method {$method['type']} {$name}", $phpdoc);
|
||||||
$phpdoc->appendTag($tag);
|
$phpdoc->appendTag($tag);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -396,37 +387,4 @@ class ModelsCommand extends Command {
|
|||||||
return $output;
|
return $output;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the parameters and format them correctly
|
|
||||||
*
|
|
||||||
* @param $method
|
|
||||||
* @return array
|
|
||||||
*/
|
|
||||||
public function getParameters($method){
|
|
||||||
//Loop through the default values for paremeters, and make the correct output string
|
|
||||||
$params = array();
|
|
||||||
$paramsWithDefault = array();
|
|
||||||
foreach ($method->getParameters() as $param) {
|
|
||||||
$paramStr = '$'.$param->getName();
|
|
||||||
$params[] = $paramStr;
|
|
||||||
if ($param->isOptional()) {
|
|
||||||
$default = $param->getDefaultValue();
|
|
||||||
if(is_bool($default)){
|
|
||||||
$default = $default? 'true':'false';
|
|
||||||
}elseif(is_array($default)){
|
|
||||||
$default = 'array()';
|
|
||||||
}elseif(is_null($default)){
|
|
||||||
$default = 'null';
|
|
||||||
}elseif(is_int($default)){
|
|
||||||
//$default = $default;
|
|
||||||
}else{
|
|
||||||
$default = "'".trim($default)."'";
|
|
||||||
}
|
|
||||||
$paramStr .= " = $default";
|
|
||||||
}
|
|
||||||
$paramsWithDefault[] = $paramStr;
|
|
||||||
}
|
|
||||||
return $paramsWithDefault;
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -43,17 +43,4 @@ return array(
|
|||||||
'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
|
'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
|
||||||
),
|
),
|
||||||
|
|
||||||
'magic' => array(
|
|
||||||
'Log' => array(
|
|
||||||
'debug' => 'Monolog\Logger::addDebug',
|
|
||||||
'info' => 'Monolog\Logger::addInfo',
|
|
||||||
'notice' => 'Monolog\Logger::addNotice',
|
|
||||||
'warning' => 'Monolog\Logger::addWarning',
|
|
||||||
'error' => 'Monolog\Logger::addError',
|
|
||||||
'critical' => 'Monolog\Logger::addCritical',
|
|
||||||
'alert' => 'Monolog\Logger::addAlert',
|
|
||||||
'emergency' => 'Monolog\Logger::addEmergency',
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
);
|
);
|
||||||
|
|||||||
Reference in New Issue
Block a user