Compare commits

...
7 Commits
4 changed files with 52 additions and 38 deletions
+7 -2
View File
@@ -8,6 +8,11 @@ Add the helper file to your laravel folder (not in a public folder). The file is
* SublimeText CodeIntel version: https://gist.github.com/barryvdh/5227814 * 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:
@@ -31,8 +36,8 @@ 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 +76,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)
@@ -52,34 +52,37 @@ 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();
}
$this->sublime = $this->option('sublime') || \Config::get('laravel-ide-helper::sublime');
$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(){
@@ -315,6 +318,8 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
$returnValue = "static"; $returnValue = "static";
}elseif(!$this->sublime and $alias == 'Eloquent' and in_array($method->name, array('all', 'get'))){ }elseif(!$this->sublime and $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{
@@ -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;
} }
+1 -1
View File
@@ -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'),
), ),
/* /*