mirror of
https://github.com/barryvdh/laravel-ide-helper.git
synced 2026-08-18 18:13:11 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ce4e9804ef | ||
|
|
12845b38f0 | ||
|
|
0b3b8b95cd | ||
|
|
2ee05260d5 | ||
|
|
ec302acc3f | ||
|
|
e0b47835f4 | ||
|
|
a0f6a370e1 | ||
|
|
77c8bfa05a | ||
|
|
62deba4171 | ||
|
|
32918908fc | ||
|
|
cca1b5896e |
@@ -4,10 +4,10 @@
|
|||||||
|
|
||||||
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.
|
#### NOTE: run before optimising. If bootstrap/compiled.php is loaded, it doesn't work.
|
||||||
|
|
||||||
php artisan clear-compiled
|
php artisan clear-compiled
|
||||||
@@ -26,10 +26,6 @@ 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:
|
||||||
@@ -37,7 +33,7 @@ You can configure your composer.json to do this after each commit:
|
|||||||
"scripts":{
|
"scripts":{
|
||||||
"post-update-cmd":[
|
"post-update-cmd":[
|
||||||
"php artisan ide-helper:generate",
|
"php artisan ide-helper:generate",
|
||||||
"php artisan optimize"
|
"php artisan optimize",
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
|
||||||
|
|||||||
@@ -42,7 +42,6 @@ class GeneratorCommand extends Command {
|
|||||||
protected $nonstatic;
|
protected $nonstatic;
|
||||||
protected $onlyExtend;
|
protected $onlyExtend;
|
||||||
protected $helpers;
|
protected $helpers;
|
||||||
protected $sublime;
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -53,7 +52,7 @@ class GeneratorCommand extends Command {
|
|||||||
public function fire()
|
public function fire()
|
||||||
{
|
{
|
||||||
if (file_exists($compiled = base_path().'/bootstrap/compiled.php')){
|
if (file_exists($compiled = base_path().'/bootstrap/compiled.php')){
|
||||||
$this->error('Error: first delete bootstrap/compiled.php (php artisan clear-compiled)');
|
$this->error('Error generating IDE Helper: first delete bootstrap/compiled.php (php artisan clear-compiled)');
|
||||||
}else{
|
}else{
|
||||||
$filename = $this->argument('filename');
|
$filename = $this->argument('filename');
|
||||||
|
|
||||||
@@ -70,9 +69,7 @@ class GeneratorCommand extends Command {
|
|||||||
}else{
|
}else{
|
||||||
$this->helpers = array();
|
$this->helpers = array();
|
||||||
}
|
}
|
||||||
|
|
||||||
$this->sublime = $this->option('sublime') || \Config::get('laravel-ide-helper::sublime');
|
|
||||||
|
|
||||||
$content = $this->generateDocs();
|
$content = $this->generateDocs();
|
||||||
|
|
||||||
$written = \File::put($filename, $content);
|
$written = \File::put($filename, $content);
|
||||||
@@ -116,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'),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -180,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))
|
||||||
{
|
{
|
||||||
@@ -199,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;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -311,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{
|
||||||
@@ -351,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";
|
||||||
|
|
||||||
|
|||||||
@@ -93,7 +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_path().'/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'),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
@@ -141,13 +141,12 @@ class ModelsCommand extends Command {
|
|||||||
|
|
||||||
|
|
||||||
protected function loadModels(){
|
protected function loadModels(){
|
||||||
$dir = $this->dir;
|
$dir = base_path().'/'.$this->dir;
|
||||||
if(!file_exists($dir)){
|
|
||||||
$dir = base_path().'/'.$dir;
|
|
||||||
}
|
|
||||||
$models = array();
|
$models = array();
|
||||||
foreach(ClassMapGenerator::createMap($dir) as $model=> $path){
|
if(file_exists($dir)){
|
||||||
$models[] = $model;
|
foreach(ClassMapGenerator::createMap($dir) as $model=> $path){
|
||||||
|
$models[] = $model;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
return $models;
|
return $models;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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