mirror of
https://github.com/barryvdh/laravel-ide-helper.git
synced 2026-08-19 10:33:11 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
facba3a5e6 | ||
|
|
7d09f324fa | ||
|
|
af34b1cca2 | ||
|
|
463bfdd70a | ||
|
|
ff7d2a33b0 | ||
|
|
3ebfcd1c6c | ||
|
|
c3afd5f63c | ||
|
|
92abb112e9 | ||
|
|
7e1c64fb95 |
+2
-1
@@ -15,7 +15,8 @@
|
|||||||
"illuminate/console": "4.x",
|
"illuminate/console": "4.x",
|
||||||
"illuminate/filesystem": "4.x",
|
"illuminate/filesystem": "4.x",
|
||||||
"phpdocumentor/reflection-docblock": "2.0.0",
|
"phpdocumentor/reflection-docblock": "2.0.0",
|
||||||
"symfony/class-loader": "~2.3"
|
"symfony/class-loader": "~2.3",
|
||||||
|
"doctrine/dbal": "~2.3"
|
||||||
},
|
},
|
||||||
"autoload": {
|
"autoload": {
|
||||||
"psr-0": {
|
"psr-0": {
|
||||||
|
|||||||
@@ -53,7 +53,8 @@ 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
|
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
|
||||||
write to a seperate file (_ide_helper_models.php) Please make sure to backup your models, before writing the info.
|
write to a seperate 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.
|
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.
|
||||||
|
|
||||||
@@ -80,6 +81,10 @@ You can also scan a different directory, using the --dir option (relative from t
|
|||||||
|
|
||||||
php artisan ide-helper:models --dir="app/workbench/name/package/models"
|
php artisan ide-helper:models --dir="app/workbench/name/package/models"
|
||||||
|
|
||||||
|
Models can be ignored using the --ignore (-I) option
|
||||||
|
|
||||||
|
php artisan ide-helper:models --ignore="Post,User"
|
||||||
|
|
||||||
Note: With namespaces, wrap your model name in " signs: `php artisan ide-helper:models "API\User"`, or escape the slashes (`Api\\User`)
|
Note: With namespaces, wrap your model name in " signs: `php artisan ide-helper:models "API\User"`, or escape the slashes (`Api\\User`)
|
||||||
|
|
||||||
### License
|
### License
|
||||||
|
|||||||
@@ -147,7 +147,9 @@ exit('Only to be used as an helper for your IDE');\n\n";
|
|||||||
try{
|
try{
|
||||||
|
|
||||||
//Some classes extend the facade
|
//Some classes extend the facade
|
||||||
if(class_exists($facade)){
|
if(interface_exists($facade)){
|
||||||
|
$output .= "interface $alias extends $facade{\n";
|
||||||
|
}elseif(class_exists($facade)){
|
||||||
$output .= "class $alias extends $facade{\n";
|
$output .= "class $alias extends $facade{\n";
|
||||||
}else{
|
}else{
|
||||||
$output .= "class $alias{\n";
|
$output .= "class $alias{\n";
|
||||||
@@ -359,7 +361,7 @@ exit('Only to be used as an helper for your IDE');\n\n";
|
|||||||
$output .= $serializer->getDocComment($phpdoc) ."\n\t public static function ".$methodName."(";
|
$output .= $serializer->getDocComment($phpdoc) ."\n\t public static function ".$methodName."(";
|
||||||
|
|
||||||
$output .= implode($paramsWithDefault, ", ");
|
$output .= implode($paramsWithDefault, ", ");
|
||||||
$output .= "){\r\n";
|
$output .= "){\n";
|
||||||
|
|
||||||
//Only return when not a constructor and not void.
|
//Only return when not a constructor and not void.
|
||||||
$return = ($returnValue && $returnValue !== "void" && $method->name !== "__construct") ? 'return' : '';
|
$return = ($returnValue && $returnValue !== "void" && $method->name !== "__construct") ? 'return' : '';
|
||||||
@@ -369,13 +371,13 @@ exit('Only to be used as an helper for your IDE');\n\n";
|
|||||||
$root = $class->getName();
|
$root = $class->getName();
|
||||||
|
|
||||||
if($declaringClass->name != $root){
|
if($declaringClass->name != $root){
|
||||||
$output .= "\t\t//Method inherited from $declaringClass->name\r\n";
|
$output .= "\t\t//Method inherited from $declaringClass->name\n";
|
||||||
}
|
}
|
||||||
|
|
||||||
$output .= "\t\t$return $root::";
|
$output .= "\t\t$return $root::";
|
||||||
|
|
||||||
//Write the default parameters in the function call
|
//Write the default parameters in the function call
|
||||||
$output .= $method->name."(".implode($params, ", ").");\r\n";
|
$output .= $method->name."(".implode($params, ", ").");\n";
|
||||||
$output .= "\t }\n\n";
|
$output .= "\t }\n\n";
|
||||||
|
|
||||||
return $output;
|
return $output;
|
||||||
|
|||||||
@@ -58,16 +58,17 @@ class ModelsCommand extends Command {
|
|||||||
$this->write = $this->option('write');
|
$this->write = $this->option('write');
|
||||||
$this->dir = $this->option('dir');
|
$this->dir = $this->option('dir');
|
||||||
$model = $this->argument('model');
|
$model = $this->argument('model');
|
||||||
|
$ignore = $this->option('ignore');
|
||||||
$this->reset = $this->option('reset');
|
$this->reset = $this->option('reset');
|
||||||
|
|
||||||
//If filename is default and Write is not specified, ask what to do
|
//If filename is default and Write is not specified, ask what to do
|
||||||
if(!$this->write && $filename === $this->filename){
|
if(!$this->write && $filename === $this->filename && !$this->option('nowrite')){
|
||||||
if($this->confirm("Do you want to overwrite the existing model files for '$model'? Choose no to write to $filename instead? (Yes/No): ")){
|
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;
|
$this->write = true;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
$content = $this->generateDocs($model);
|
$content = $this->generateDocs($model, $ignore);
|
||||||
|
|
||||||
if(!$this->write){
|
if(!$this->write){
|
||||||
$written = \File::put($filename, $content);
|
$written = \File::put($filename, $content);
|
||||||
@@ -89,7 +90,6 @@ class ModelsCommand extends Command {
|
|||||||
{
|
{
|
||||||
return array(
|
return array(
|
||||||
array('model', InputArgument::OPTIONAL, 'Which models to include', '*'),
|
array('model', InputArgument::OPTIONAL, 'Which models to include', '*'),
|
||||||
|
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -104,11 +104,13 @@ class ModelsCommand extends Command {
|
|||||||
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', $this->filename),
|
||||||
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('nowrite', 'N', InputOption::VALUE_NONE, 'Don\'t 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'),
|
||||||
|
array('ignore', 'I', InputOption::VALUE_OPTIONAL, 'Which models to ignore', ''),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
protected function generateDocs($model){
|
protected function generateDocs($model, $ignore = ''){
|
||||||
|
|
||||||
|
|
||||||
$output = "<?php
|
$output = "<?php
|
||||||
@@ -127,7 +129,15 @@ class ModelsCommand extends Command {
|
|||||||
$models = explode(',', $model);
|
$models = explode(',', $model);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
$ignore = explode(',', $ignore);
|
||||||
|
|
||||||
foreach($models as $name){
|
foreach($models as $name){
|
||||||
|
if(in_array($name, $ignore)){
|
||||||
|
$this->comment("Ignoring model '$name'");
|
||||||
|
continue;
|
||||||
|
}else{
|
||||||
|
$this->comment("Loading model '$name'");
|
||||||
|
}
|
||||||
$this->properties = array();
|
$this->properties = array();
|
||||||
$this->methods = array();
|
$this->methods = array();
|
||||||
if(class_exists($name)){
|
if(class_exists($name)){
|
||||||
|
|||||||
@@ -40,7 +40,9 @@ return array(
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
'extra' => array(
|
'extra' => array(
|
||||||
'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
|
'Artisan' => array('Illuminate\Foundation\Artisan'),
|
||||||
|
'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
|
||||||
|
'Session' => array('Illuminate\Session\Store'),
|
||||||
),
|
),
|
||||||
|
|
||||||
'magic' => array(
|
'magic' => array(
|
||||||
|
|||||||
Reference in New Issue
Block a user