mirror of
https://github.com/barryvdh/laravel-ide-helper.git
synced 2026-08-18 10:07:12 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ce4e9804ef | ||
|
|
12845b38f0 | ||
|
|
0b3b8b95cd | ||
|
|
2ee05260d5 | ||
|
|
ec302acc3f | ||
|
|
e0b47835f4 | ||
|
|
a0f6a370e1 | ||
|
|
77c8bfa05a | ||
|
|
62deba4171 | ||
|
|
32918908fc | ||
|
|
cca1b5896e | ||
|
|
3afc4a3ade | ||
|
|
3ac68d5446 | ||
|
|
26f09bccbf |
@@ -4,11 +4,16 @@
|
|||||||
|
|
||||||
Add the helper file to your laravel folder (not in a public folder). The file isn't used by Laravel, but it has to be indexed by your IDE.
|
Add the helper file to your laravel folder (not in a public folder). The file isn't used by Laravel, but it has to be indexed by your IDE.
|
||||||
|
|
||||||
* Netbeans and PHPStorm version: https://gist.github.com/barryvdh/5227822
|
* Generated version: https://gist.github.com/barryvdh/5227822
|
||||||
* SublimeText CodeIntel version: https://gist.github.com/barryvdh/5227814
|
|
||||||
|
|
||||||
### Automatic phpDoc generation for Laravel Facades
|
### Automatic phpDoc generation for Laravel Facades
|
||||||
|
|
||||||
|
#### NOTE: run before optimising. If bootstrap/compiled.php is loaded, it doesn't work.
|
||||||
|
|
||||||
|
php artisan clear-compiled
|
||||||
|
php artisan ide-helper:generate
|
||||||
|
php artisan optimize
|
||||||
|
|
||||||
Require this package in your composer.json:
|
Require this package in your composer.json:
|
||||||
|
|
||||||
"barryvdh/laravel-ide-helper": "1.*"
|
"barryvdh/laravel-ide-helper": "1.*"
|
||||||
@@ -21,18 +26,14 @@ You can now re-generate the docs yourself (for future updates) in artisan
|
|||||||
|
|
||||||
php artisan ide-helper:generate
|
php artisan ide-helper:generate
|
||||||
|
|
||||||
If you use SublimeText CodeIntel, the format is a bit different. So add --sublime (or -S) to your command
|
|
||||||
|
|
||||||
php artisan ide-helper:generate -S
|
|
||||||
|
|
||||||
Note: You do need CodeIntel for Sublime Text: https://github.com/Kronuz/SublimeCodeIntel
|
Note: You do need CodeIntel for Sublime Text: https://github.com/Kronuz/SublimeCodeIntel
|
||||||
|
|
||||||
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 optimize",
|
|
||||||
"php artisan ide-helper:generate",
|
"php artisan ide-helper:generate",
|
||||||
|
"php artisan optimize",
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
|
||||||
@@ -71,4 +72,4 @@ After copying the phpdocs to your model, you can clear the file, so your IDE onl
|
|||||||
|
|
||||||
### License
|
### License
|
||||||
|
|
||||||
The Laravel IDE Helper Generator is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)
|
The Laravel IDE Helper Generator is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)
|
||||||
|
|||||||
@@ -42,7 +42,6 @@ class GeneratorCommand extends Command {
|
|||||||
protected $nonstatic;
|
protected $nonstatic;
|
||||||
protected $onlyExtend;
|
protected $onlyExtend;
|
||||||
protected $helpers;
|
protected $helpers;
|
||||||
protected $sublime;
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -52,34 +51,35 @@ class GeneratorCommand extends Command {
|
|||||||
*/
|
*/
|
||||||
public function fire()
|
public function fire()
|
||||||
{
|
{
|
||||||
$filename = $this->argument('filename');
|
if (file_exists($compiled = base_path().'/bootstrap/compiled.php')){
|
||||||
|
$this->error('Error generating IDE Helper: first delete bootstrap/compiled.php (php artisan clear-compiled)');
|
||||||
if($this->option('memory')){
|
|
||||||
$this->useMemoryDriver();
|
|
||||||
}
|
|
||||||
|
|
||||||
$this->extra = \Config::get('laravel-ide-helper::extra');
|
|
||||||
$this->nonstatic = \Config::get('laravel-ide-helper::nonstatic');
|
|
||||||
$this->onlyExtend = \Config::get('laravel-ide-helper::only_extend');
|
|
||||||
|
|
||||||
if( $this->option('helpers') || (\Config::get('laravel-ide-helper::include_helpers') && ! $this->option('nohelpers'))){
|
|
||||||
$this->helpers = \Config::get('laravel-ide-helper::helper_files');
|
|
||||||
}else{
|
}else{
|
||||||
$this->helpers = array();
|
$filename = $this->argument('filename');
|
||||||
}
|
|
||||||
|
if($this->option('memory')){
|
||||||
$this->sublime = $this->option('sublime') || \Config::get('laravel-ide-helper::sublime');
|
$this->useMemoryDriver();
|
||||||
|
}
|
||||||
$content = $this->generateDocs();
|
|
||||||
|
$this->extra = \Config::get('laravel-ide-helper::extra');
|
||||||
$written = \File::put($filename, $content);
|
$this->nonstatic = \Config::get('laravel-ide-helper::nonstatic');
|
||||||
|
$this->onlyExtend = \Config::get('laravel-ide-helper::only_extend');
|
||||||
if($written !== false){
|
|
||||||
$this->info("A new helper file was written to $filename");
|
if( $this->option('helpers') || (\Config::get('laravel-ide-helper::include_helpers') && ! $this->option('nohelpers'))){
|
||||||
}else{
|
$this->helpers = \Config::get('laravel-ide-helper::helper_files');
|
||||||
$this->error("The helper file could not be created at $filename");
|
}else{
|
||||||
}
|
$this->helpers = array();
|
||||||
|
}
|
||||||
|
|
||||||
|
$content = $this->generateDocs();
|
||||||
|
|
||||||
|
$written = \File::put($filename, $content);
|
||||||
|
|
||||||
|
if($written !== false){
|
||||||
|
$this->info("A new helper file was written to $filename");
|
||||||
|
}else{
|
||||||
|
$this->error("The helper file could not be created at $filename");
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
protected function useMemoryDriver(){
|
protected function useMemoryDriver(){
|
||||||
@@ -113,7 +113,7 @@ class GeneratorCommand extends Command {
|
|||||||
return array(
|
return array(
|
||||||
array('helpers', "H", InputOption::VALUE_NONE, 'Include the helper files'),
|
array('helpers', "H", InputOption::VALUE_NONE, 'Include the helper files'),
|
||||||
array('memory', "M", InputOption::VALUE_NONE, 'Use sqlite memory driver'),
|
array('memory', "M", InputOption::VALUE_NONE, 'Use sqlite memory driver'),
|
||||||
array('sublime', "S", InputOption::VALUE_NONE, 'Use different style for SublimeText CodeIntel'),
|
array('sublime', "S", InputOption::VALUE_NONE, 'DEPRECATED: Use different style for SublimeText CodeIntel'),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -177,7 +177,6 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
|
|||||||
}else{
|
}else{
|
||||||
$output .= " class $alias{\n";
|
$output .= " class $alias{\n";
|
||||||
}
|
}
|
||||||
$output .= "\t/**\n\t * @var \\$root \$root\n\t */\n\t static private \$root;\n\n";
|
|
||||||
|
|
||||||
if(!in_array($alias, $this->onlyExtend))
|
if(!in_array($alias, $this->onlyExtend))
|
||||||
{
|
{
|
||||||
@@ -196,7 +195,8 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
|
|||||||
{
|
{
|
||||||
if(!in_array($method->name, $usedMethods)){
|
if(!in_array($method->name, $usedMethods)){
|
||||||
$static = !in_array($method->name, $nonstaticMethods);
|
$static = !in_array($method->name, $nonstaticMethods);
|
||||||
$output .= $this->parseMethod($method, $alias, $root, $static);
|
$declaringClass = $method->getDeclaringClass();
|
||||||
|
$output .= $this->parseMethod($method, $alias, "\\$declaringClass->name", $static);
|
||||||
$usedMethods[] = $method->name;
|
$usedMethods[] = $method->name;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -308,13 +308,17 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
|
|||||||
$tag = reset($returnTags);
|
$tag = reset($returnTags);
|
||||||
$returnValue = $tag->getType();
|
$returnValue = $tag->getType();
|
||||||
|
|
||||||
if(!$this->sublime and $alias == 'Eloquent' and
|
if($method->name == "__construct"){
|
||||||
|
$returnValue = 'self';
|
||||||
|
}elseif($alias == 'Eloquent' and
|
||||||
(in_array($method->name, array('pluck', 'first', 'fill', 'newInstance', 'newFromBuilder', 'create', 'find', 'findOrFail'))
|
(in_array($method->name, array('pluck', 'first', 'fill', 'newInstance', 'newFromBuilder', 'create', 'find', 'findOrFail'))
|
||||||
or $returnValue === '\Illuminate\Database\Query\Builder')){
|
or $returnValue === '\Illuminate\Database\Query\Builder')){
|
||||||
//Reference the calling class, to provide more accurate auto-complete
|
//Reference the calling class, to provide more accurate auto-complete
|
||||||
$returnValue = "static";
|
$returnValue .= "static";
|
||||||
}elseif(!$this->sublime and $alias == 'Eloquent' and in_array($method->name, array('all', 'get'))){
|
}elseif($alias == 'Eloquent' and in_array($method->name, array('all', 'get'))){
|
||||||
$returnValue .= "|\Eloquent[]|static[]";
|
$returnValue .= "|\Eloquent[]|static[]";
|
||||||
|
}elseif($alias == 'Eloquent' and in_array($method->name, array('hasOne', 'hasMany', 'belongsTo', 'belongsToMany', 'morphOne', 'morphTo', 'morphMany'))){
|
||||||
|
$returnValue .= "|\Eloquent";
|
||||||
}
|
}
|
||||||
$tag->setContent($returnValue . " ". $tag->getDescription());
|
$tag->setContent($returnValue . " ". $tag->getDescription());
|
||||||
}else{
|
}else{
|
||||||
@@ -348,14 +352,12 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
|
|||||||
$output .= implode($paramsWithDefault, ", ");
|
$output .= implode($paramsWithDefault, ", ");
|
||||||
$output .= "){\r\n";
|
$output .= "){\r\n";
|
||||||
|
|
||||||
$return = ($returnValue && $returnValue !== "void") ? 'return' : '';
|
$return = ($returnValue && $returnValue !== "void" && $method->name !== "__construct") ? 'return' : '';
|
||||||
|
|
||||||
|
|
||||||
|
$output .= "\t\t$return $root::";
|
||||||
|
|
||||||
|
|
||||||
if($this->sublime){
|
|
||||||
$output .= "\t\t\$$rootParam = new $root();\r\n";
|
|
||||||
$output .= "\t\t$return \$$rootParam->";
|
|
||||||
}else{
|
|
||||||
$output .= "\t\t$return static::\$$rootParam->";
|
|
||||||
}
|
|
||||||
$output .= $method->name."(".implode($params, ", ").");\r\n";
|
$output .= $method->name."(".implode($params, ", ").");\r\n";
|
||||||
$output .= "\t }\n\n";
|
$output .= "\t }\n\n";
|
||||||
|
|
||||||
|
|||||||
@@ -40,8 +40,8 @@ class ModelsCommand extends Command {
|
|||||||
|
|
||||||
protected $properties = array();
|
protected $properties = array();
|
||||||
protected $methods = array();
|
protected $methods = array();
|
||||||
|
|
||||||
protected $write = false;
|
protected $write = false;
|
||||||
|
protected $dir;
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -54,6 +54,7 @@ class ModelsCommand extends Command {
|
|||||||
{
|
{
|
||||||
$filename = $this->option('filename');
|
$filename = $this->option('filename');
|
||||||
$this->write = $this->option('write');
|
$this->write = $this->option('write');
|
||||||
|
$this->dir = $this->option('dir');
|
||||||
$model = $this->argument('model');
|
$model = $this->argument('model');
|
||||||
|
|
||||||
$content = $this->generateDocs($model);
|
$content = $this->generateDocs($model);
|
||||||
@@ -67,8 +68,6 @@ class ModelsCommand extends Command {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
@@ -94,6 +93,7 @@ class ModelsCommand extends Command {
|
|||||||
{
|
{
|
||||||
return array(
|
return array(
|
||||||
array('filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the helper file', '_ide_helper_models.php'),
|
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('write', 'W', InputOption::VALUE_NONE, 'Write to Model file'),
|
array('write', 'W', InputOption::VALUE_NONE, 'Write to Model file'),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
@@ -141,9 +141,12 @@ class ModelsCommand extends Command {
|
|||||||
|
|
||||||
|
|
||||||
protected function loadModels(){
|
protected function loadModels(){
|
||||||
|
$dir = base_path().'/'.$this->dir;
|
||||||
$models = array();
|
$models = array();
|
||||||
foreach(ClassMapGenerator::createMap(app_path().'/models') as $model=> $path){
|
if(file_exists($dir)){
|
||||||
$models[] = $model;
|
foreach(ClassMapGenerator::createMap($dir) as $model=> $path){
|
||||||
|
$models[] = $model;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
return $models;
|
return $models;
|
||||||
}
|
}
|
||||||
@@ -305,6 +308,7 @@ class ModelsCommand extends Command {
|
|||||||
|
|
||||||
$reflection = new \ReflectionClass($class);
|
$reflection = new \ReflectionClass($class);
|
||||||
$namespace = $reflection->getNamespaceName();
|
$namespace = $reflection->getNamespaceName();
|
||||||
|
$classname = $reflection->getShortName();
|
||||||
$originalDoc = $reflection->getDocComment();
|
$originalDoc = $reflection->getDocComment();
|
||||||
$phpdoc = new DocBlock($reflection, new Context($namespace));
|
$phpdoc = new DocBlock($reflection, new Context($namespace));
|
||||||
|
|
||||||
@@ -359,8 +363,8 @@ class ModelsCommand extends Command {
|
|||||||
if($originalDoc){
|
if($originalDoc){
|
||||||
$contents = str_replace($originalDoc, $docComment, $contents);
|
$contents = str_replace($originalDoc, $docComment, $contents);
|
||||||
}else{
|
}else{
|
||||||
$needle = "class {$class}";
|
$needle = "class {$classname}";
|
||||||
$replace = "{$docComment}\nclass {$class}";
|
$replace = "{$docComment}\nclass {$classname}";
|
||||||
$pos = strpos($contents,$needle);
|
$pos = strpos($contents,$needle);
|
||||||
if ($pos !== false) {
|
if ($pos !== false) {
|
||||||
$contents = substr_replace($contents,$replace,$pos,strlen($needle));
|
$contents = substr_replace($contents,$replace,$pos,strlen($needle));
|
||||||
@@ -371,7 +375,7 @@ class ModelsCommand extends Command {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
$output = "namespace {$namespace}{\n{$docComment}\n\tclass {$class} {}\n}\n\n";
|
$output = "namespace {$namespace}{\n{$docComment}\n\tclass {$classname} {}\n}\n\n";
|
||||||
return $output;
|
return $output;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -70,7 +70,7 @@ return array(
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
'nonstatic' => array(
|
'nonstatic' => array(
|
||||||
'Eloquent' => array('freshTimestamp', 'newCollection', 'toArray', 'toJson', 'toSql'),
|
'Eloquent' => array('freshTimestamp', 'newCollection', 'toArray', 'toJson', 'toSql', 'delete'),
|
||||||
),
|
),
|
||||||
|
|
||||||
/*
|
/*
|
||||||
|
|||||||
Reference in New Issue
Block a user