mirror of
https://github.com/barryvdh/laravel-ide-helper.git
synced 2026-08-18 10:07:12 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3afc4a3ade | ||
|
|
3ac68d5446 | ||
|
|
26f09bccbf |
@@ -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
|
||||
|
||||
### 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:
|
||||
|
||||
@@ -31,8 +36,8 @@ You can configure your composer.json to do this after each commit:
|
||||
|
||||
"scripts":{
|
||||
"post-update-cmd":[
|
||||
"php artisan optimize",
|
||||
"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
|
||||
|
||||
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()
|
||||
{
|
||||
$filename = $this->argument('filename');
|
||||
|
||||
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');
|
||||
if (file_exists($compiled = base_path().'/bootstrap/compiled.php')){
|
||||
$this->error('Error: first delete bootstrap/compiled.php (php artisan clear-compiled)');
|
||||
}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");
|
||||
}
|
||||
|
||||
$filename = $this->argument('filename');
|
||||
|
||||
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{
|
||||
$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(){
|
||||
|
||||
@@ -40,8 +40,8 @@ class ModelsCommand extends Command {
|
||||
|
||||
protected $properties = array();
|
||||
protected $methods = array();
|
||||
|
||||
protected $write = false;
|
||||
protected $dir;
|
||||
|
||||
|
||||
|
||||
@@ -54,6 +54,7 @@ class ModelsCommand extends Command {
|
||||
{
|
||||
$filename = $this->option('filename');
|
||||
$this->write = $this->option('write');
|
||||
$this->dir = $this->option('dir');
|
||||
$model = $this->argument('model');
|
||||
|
||||
$content = $this->generateDocs($model);
|
||||
@@ -67,8 +68,6 @@ class ModelsCommand extends Command {
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
}
|
||||
|
||||
|
||||
@@ -94,6 +93,7 @@ class ModelsCommand extends Command {
|
||||
{
|
||||
return array(
|
||||
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('write', 'W', InputOption::VALUE_NONE, 'Write to Model file'),
|
||||
);
|
||||
}
|
||||
@@ -141,8 +141,12 @@ class ModelsCommand extends Command {
|
||||
|
||||
|
||||
protected function loadModels(){
|
||||
$dir = $this->dir;
|
||||
if(!file_exists($dir)){
|
||||
$dir = base_path().'/'.$dir;
|
||||
}
|
||||
$models = array();
|
||||
foreach(ClassMapGenerator::createMap(app_path().'/models') as $model=> $path){
|
||||
foreach(ClassMapGenerator::createMap($dir) as $model=> $path){
|
||||
$models[] = $model;
|
||||
}
|
||||
return $models;
|
||||
@@ -305,6 +309,7 @@ class ModelsCommand extends Command {
|
||||
|
||||
$reflection = new \ReflectionClass($class);
|
||||
$namespace = $reflection->getNamespaceName();
|
||||
$classname = $reflection->getShortName();
|
||||
$originalDoc = $reflection->getDocComment();
|
||||
$phpdoc = new DocBlock($reflection, new Context($namespace));
|
||||
|
||||
@@ -359,8 +364,8 @@ class ModelsCommand extends Command {
|
||||
if($originalDoc){
|
||||
$contents = str_replace($originalDoc, $docComment, $contents);
|
||||
}else{
|
||||
$needle = "class {$class}";
|
||||
$replace = "{$docComment}\nclass {$class}";
|
||||
$needle = "class {$classname}";
|
||||
$replace = "{$docComment}\nclass {$classname}";
|
||||
$pos = strpos($contents,$needle);
|
||||
if ($pos !== false) {
|
||||
$contents = substr_replace($contents,$replace,$pos,strlen($needle));
|
||||
@@ -371,7 +376,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;
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user