mirror of
https://github.com/barryvdh/laravel-ide-helper.git
synced 2026-08-18 01:57:13 +00:00
Compare commits
35
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6f03c4c5ff | ||
|
|
8db4443879 | ||
|
|
1d01f5b278 | ||
|
|
2466f5a5a4 | ||
|
|
bbbdd02708 | ||
|
|
d8a6bfbf21 | ||
|
|
ce4e9804ef | ||
|
|
12845b38f0 | ||
|
|
0b3b8b95cd | ||
|
|
2ee05260d5 | ||
|
|
ec302acc3f | ||
|
|
e0b47835f4 | ||
|
|
a0f6a370e1 | ||
|
|
77c8bfa05a | ||
|
|
62deba4171 | ||
|
|
32918908fc | ||
|
|
cca1b5896e | ||
|
|
3afc4a3ade | ||
|
|
3ac68d5446 | ||
|
|
26f09bccbf | ||
|
|
a4ab0a5969 | ||
|
|
b0b324b8cc | ||
|
|
dab594804b | ||
|
|
83d5fe048d | ||
|
|
77b1bc923e | ||
|
|
9090aeb766 | ||
|
|
a5c16b0751 | ||
|
|
16b3b872a3 | ||
|
|
507775fda6 | ||
|
|
83ab04be40 | ||
|
|
8e0eace591 | ||
|
|
9dbcaa15b1 | ||
|
|
edf418f9ac | ||
|
|
eb3c3a7fe3 | ||
|
|
fde71b0ee8 |
+3
-1
@@ -1,6 +1,8 @@
|
|||||||
{
|
{
|
||||||
"name": "barryvdh/laravel-ide-helper",
|
"name": "barryvdh/laravel-ide-helper",
|
||||||
"description": "Laravel IDE Helper, generates correct PHPDocs for all Facade classes, to improve auto-completion.",
|
"description": "Laravel IDE Helper, generates correct PHPDocs for all Facade classes, to improve auto-completion.",
|
||||||
|
"keywords": ["laravel", "autocomplete", "phpstorm", "netbeans", "sublime", "codeintel", "phpdoc"],
|
||||||
|
"license": "MIT",
|
||||||
"authors": [
|
"authors": [
|
||||||
{
|
{
|
||||||
"name": "Barry vd. Heuvel",
|
"name": "Barry vd. Heuvel",
|
||||||
@@ -12,7 +14,7 @@
|
|||||||
"illuminate/support": "4.0.x",
|
"illuminate/support": "4.0.x",
|
||||||
"illuminate/console": "4.0.x",
|
"illuminate/console": "4.0.x",
|
||||||
"illuminate/filesystem": "4.0.x",
|
"illuminate/filesystem": "4.0.x",
|
||||||
"phpdocumentor/reflection-docblock": "2.0.*",
|
"barryvdh/reflection-docblock": ">=2.0.1",
|
||||||
"symfony/class-loader": "2.3.*"
|
"symfony/class-loader": "2.3.*"
|
||||||
},
|
},
|
||||||
"autoload": {
|
"autoload": {
|
||||||
|
|||||||
@@ -1,19 +1,21 @@
|
|||||||
## Laravel IDE Helper & Generator
|
## Laravel IDE Helper Generator
|
||||||
|
|
||||||
### Complete phpDocs, directly from the source
|
### Complete phpDocs, directly from the source
|
||||||
|
|
||||||
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.
|
This packages generates a file that your IDE can understand, so it can provide accurate autocompletion. Generation is done, based on the files in your project, so they are alway up-to-date.
|
||||||
|
If you don't want to generate it, you can add a pre-generated file to the root folder of your laravel project. (But this isn't as up-to-date as self generated files)
|
||||||
|
|
||||||
* 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
|
|
||||||
|
Note: You do need CodeIntel for Sublime Text: https://github.com/Kronuz/SublimeCodeIntel
|
||||||
|
|
||||||
### Automatic phpDoc generation for Laravel Facades
|
### Automatic phpDoc generation for Laravel Facades
|
||||||
|
|
||||||
Require this package in your composer.json:
|
Require this package in your composer.json and run composer update (or run `composer require barryvdh/laravel-ide-helper:1.*` directly):
|
||||||
|
|
||||||
"barryvdh/laravel-ide-helper": "dev-master"
|
"barryvdh/laravel-ide-helper": "1.*"
|
||||||
|
|
||||||
And add the ServiceProvider to the providers array in app/config/app.php
|
After updating composer, add the ServiceProvider to the providers array in app/config/app.php
|
||||||
|
|
||||||
'Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider',
|
'Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider',
|
||||||
|
|
||||||
@@ -21,18 +23,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
|
Note: bootstrap/compiled.php has to be cleared first, so run `php artisan clear-compiled` before generating (and `php artisan optimize` after..)
|
||||||
|
|
||||||
php artisan ide-helper:generate -S
|
|
||||||
|
|
||||||
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",
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
|
||||||
@@ -49,21 +47,26 @@ You can choose to include helper files. This is not enabled by default, but you
|
|||||||
The Illuminate/Support/helpers.php is already set-up, but you can add/remove your own files in the config file.
|
The Illuminate/Support/helpers.php is already set-up, but you can add/remove your own files in the config file.
|
||||||
|
|
||||||
|
|
||||||
### Work in progress: Model docs
|
### Automatic phpDocs for Models
|
||||||
|
|
||||||
If you don't want to write your properties yourself, you can use the (experimental) 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. Very alpha, 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.
|
||||||
Docs are written to a phpfile in the root of the project, so you can move the docs to the real model.
|
Docs are written to a phpfile (_ide_helper_models.php) in the root of the project, so you can move the docs to the real model.
|
||||||
|
|
||||||
For now, only models in app/models are scanned. The optional argument tells what models to use.
|
You can now also write the comments directly to your Model file, using the -W argument. 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.
|
||||||
|
|
||||||
|
For now, only models in app/models are scanned. The optional argument tells what models to use (also outside app/models).
|
||||||
`php artisan ide-helper:models Post,User`
|
`php artisan ide-helper:models Post,User`
|
||||||
|
|
||||||
Note: With namespaces, uses \\ instead of \
|
Note: With namespaces, uses \\ instead of \
|
||||||
`php artisan ide-helper:models API\\User`
|
`php artisan ide-helper:models API\\User`
|
||||||
|
|
||||||
This creates a file with the phpDocs for each Model. You should check and change them to be more accurate.
|
This creates a file with the phpDocs for each Model. You should check and change them to be more accurate.
|
||||||
It doesn't know if datetimes are returned as string or DateTime/Carbon, but I assume they are.
|
|
||||||
Also, all relations are Eloquent|Eloquent[] by default, you can change them to the actual Model.
|
Also, all relations are Eloquent|Eloquent[] by default, you can change them to the actual Model.
|
||||||
After copying the phpdocs to your model, you can clear the file, so your IDE only uses the real source.
|
After copying the phpdocs to your model, you can clear the file, so your IDE only uses the real source.
|
||||||
|
|
||||||
|
|
||||||
|
### License
|
||||||
|
|
||||||
|
The Laravel IDE Helper Generator is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)
|
||||||
|
|||||||
@@ -1,9 +1,22 @@
|
|||||||
<?php namespace Barryvdh\LaravelIdeHelper;
|
<?php
|
||||||
|
/**
|
||||||
|
* Laravel IDE Helper Generator
|
||||||
|
*
|
||||||
|
* @author Barry vd. Heuvel <[email protected]>
|
||||||
|
* @copyright 2013 Barry vd. Heuvel / Fruitcake Studio (http://www.fruitcakestudio.nl)
|
||||||
|
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
||||||
|
* @link https://github.com/barryvdh/laravel-ide-helper
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper;
|
||||||
use Illuminate\Console\Command;
|
use Illuminate\Console\Command;
|
||||||
use Symfony\Component\Console\Input\InputOption;
|
use Symfony\Component\Console\Input\InputOption;
|
||||||
use Symfony\Component\Console\Input\InputArgument;
|
use Symfony\Component\Console\Input\InputArgument;
|
||||||
use DocBlock\Parser;
|
|
||||||
use Illuminate\Foundation\AliasLoader;
|
use Illuminate\Foundation\AliasLoader;
|
||||||
|
use Barryvdh\Reflection\DocBlock;
|
||||||
|
use Barryvdh\Reflection\DocBlock\Context;
|
||||||
|
use Barryvdh\Reflection\DocBlock\Tag;
|
||||||
|
use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
|
||||||
/**
|
/**
|
||||||
* A command to generate autocomplete information for your IDE
|
* A command to generate autocomplete information for your IDE
|
||||||
*
|
*
|
||||||
@@ -25,6 +38,11 @@ class GeneratorCommand extends Command {
|
|||||||
*/
|
*/
|
||||||
protected $description = 'Generate a new IDE Helper file.';
|
protected $description = 'Generate a new IDE Helper file.';
|
||||||
|
|
||||||
|
protected $extra;
|
||||||
|
protected $nonstatic;
|
||||||
|
protected $onlyExtend;
|
||||||
|
protected $helpers;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Execute the console command.
|
* Execute the console command.
|
||||||
@@ -33,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();
|
|
||||||
}
|
|
||||||
|
|
||||||
$extra = \Config::get('laravel-ide-helper::extra');
|
|
||||||
$nonstatic = \Config::get('laravel-ide-helper::nonstatic');
|
|
||||||
$onlyExtend = \Config::get('laravel-ide-helper::only_extend');
|
|
||||||
|
|
||||||
if( $this->option('helpers') || (\Config::get('laravel-ide-helper::include_helpers') && ! $this->option('nohelpers'))){
|
|
||||||
$helpers = \Config::get('laravel-ide-helper::helper_files');
|
|
||||||
}else{
|
}else{
|
||||||
$helpers = array();
|
$filename = $this->argument('filename');
|
||||||
}
|
|
||||||
|
if($this->option('memory')){
|
||||||
$sublime = $this->option('sublime') || \Config::get('laravel-ide-helper::sublime');
|
$this->useMemoryDriver();
|
||||||
|
}
|
||||||
$content = $this->generateDocs($extra, $nonstatic, $onlyExtend, $helpers, $sublime);
|
|
||||||
|
$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(){
|
||||||
@@ -94,19 +113,16 @@ 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'),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param array $extra
|
* Generate the docs for all facades in the AliasLoader
|
||||||
* @param array $nonstatic
|
*
|
||||||
* @param array $onlyExtend
|
|
||||||
* @param array $helpers
|
|
||||||
* @param bool $sublime
|
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
protected function generateDocs($extra = array(), $nonstatic = array(), $onlyExtend = array(), $helpers = array(), $sublime = false){
|
protected function generateDocs(){
|
||||||
|
|
||||||
$aliasLoader = AliasLoader::getInstance();
|
$aliasLoader = AliasLoader::getInstance();
|
||||||
|
|
||||||
@@ -119,21 +135,26 @@ class GeneratorCommand extends Command {
|
|||||||
*/
|
*/
|
||||||
namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
|
namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
|
||||||
|
|
||||||
|
//Get all aliases
|
||||||
$aliases = $aliasLoader->getAliases();
|
$aliases = $aliasLoader->getAliases();
|
||||||
|
|
||||||
foreach($aliases as $alias => $facade){
|
foreach($aliases as $alias => $facade){
|
||||||
|
|
||||||
try{
|
try{
|
||||||
|
//If possible, get the facade root
|
||||||
if(method_exists($facade, 'getFacadeRoot')){
|
if(method_exists($facade, 'getFacadeRoot')){
|
||||||
$root = get_class($facade::getFacadeRoot());
|
$root = get_class($facade::getFacadeRoot());
|
||||||
}else{
|
}else{
|
||||||
$root = $facade;
|
$root = $facade;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
//If it doesn't exist, skip it
|
||||||
if(!class_exists($root) && !interface_exists($root)){
|
if(!class_exists($root) && !interface_exists($root)){
|
||||||
$this->error("Class $root is not found.");
|
$this->error("Class $root is not found.");
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
//When the database connection is not set, some classes will be skipped
|
||||||
}catch(\PDOException $e){
|
}catch(\PDOException $e){
|
||||||
$this->error("PDOException: ".$e->getMessage()."\nPlease configure your database connection correctly, or use the sqlite memory driver (-M). Skipping $facade.");
|
$this->error("PDOException: ".$e->getMessage()."\nPlease configure your database connection correctly, or use the sqlite memory driver (-M). Skipping $facade.");
|
||||||
continue;
|
continue;
|
||||||
@@ -142,6 +163,7 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
|
|||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
//Get the namespace from the alias.
|
||||||
if(strpos($alias, '\\') !== false){
|
if(strpos($alias, '\\') !== false){
|
||||||
$parts = explode('\\', $alias);
|
$parts = explode('\\', $alias);
|
||||||
$alias = array_pop($parts);
|
$alias = array_pop($parts);
|
||||||
@@ -151,44 +173,50 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
|
|||||||
}
|
}
|
||||||
|
|
||||||
try{
|
try{
|
||||||
|
//Reflect on the class
|
||||||
$reflection = new \ReflectionClass($root);
|
$reflection = new \ReflectionClass($root);
|
||||||
|
|
||||||
$output .= "namespace $namespace {\n";
|
$output .= "namespace $namespace {\n";
|
||||||
|
|
||||||
if($root !== $facade or in_array($alias, $onlyExtend)){
|
//Some classes extend the facade
|
||||||
|
if($root !== $facade or in_array($alias, $this->onlyExtend)){
|
||||||
//If the root class is not the same as the facade extend it.
|
//If the root class is not the same as the facade extend it.
|
||||||
$output .= " class $alias extends $facade{\n";
|
$output .= " class $alias extends $facade{\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, $onlyExtend))
|
//If they extend, don't include them.
|
||||||
|
if(!in_array($alias, $this->onlyExtend))
|
||||||
{
|
{
|
||||||
$usedMethods = array();
|
$usedMethods = array();
|
||||||
if(array_key_exists($alias, $nonstatic) ){
|
|
||||||
$nonstaticMethods = $nonstatic[$alias];
|
//Check if there are non-static methods for this alias
|
||||||
|
if(array_key_exists($alias, $this->nonstatic) ){
|
||||||
|
$nonstaticMethods = $this->nonstatic[$alias];
|
||||||
}else{
|
}else{
|
||||||
$nonstaticMethods = array();
|
$nonstaticMethods = array();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
//Get all public methods for this class
|
||||||
$methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
|
$methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
|
||||||
if($methods)
|
if($methods)
|
||||||
{
|
{
|
||||||
foreach ($methods as $method)
|
foreach ($methods as $method)
|
||||||
{
|
{
|
||||||
|
//Skip methods that are already used
|
||||||
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, $sublime, $static);
|
$declaringClass = $method->getDeclaringClass();
|
||||||
|
$output .= $this->parseMethod($method, $alias, $static);
|
||||||
$usedMethods[] = $method->name;
|
$usedMethods[] = $method->name;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if(array_key_exists($alias, $extra)){
|
//Add extra methods, from other classes (magic calls)
|
||||||
$i = 2;
|
if(array_key_exists($alias, $this->extra)){
|
||||||
foreach($extra[$alias] as $extraClass){
|
foreach($this->extra[$alias] as $extraClass){
|
||||||
if(!class_exists($extraClass) && !interface_exists($extraClass)){
|
if(!class_exists($extraClass) && !interface_exists($extraClass)){
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
@@ -197,13 +225,11 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
|
|||||||
$methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
|
$methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
|
||||||
if($methods)
|
if($methods)
|
||||||
{
|
{
|
||||||
$rootParam = "root".$i++;
|
|
||||||
$output .= "\t/**\n\t * @var \\$extraClass \$$rootParam\n\t */\n\t static private \$$rootParam;\n\n";
|
|
||||||
foreach ($methods as $method)
|
foreach ($methods as $method)
|
||||||
{
|
{
|
||||||
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, $extraClass, $sublime, $static, $rootParam);
|
$output .= $this->parseMethod($method, $alias, $static);
|
||||||
$usedMethods[] = $method->name;
|
$usedMethods[] = $method->name;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -221,6 +247,7 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
|
|||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
//Include the helper file, if requested
|
||||||
if(!empty($helpers)){
|
if(!empty($helpers)){
|
||||||
foreach($helpers as $helper){
|
foreach($helpers as $helper){
|
||||||
if (file_exists($helper)){
|
if (file_exists($helper)){
|
||||||
@@ -236,33 +263,36 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
|
|||||||
* @param \ReflectionMethod $method
|
* @param \ReflectionMethod $method
|
||||||
* @param string $alias
|
* @param string $alias
|
||||||
* @param string $root
|
* @param string $root
|
||||||
* @param bool $sublime
|
|
||||||
* @param bool $static
|
* @param bool $static
|
||||||
* @param string $rootParam
|
* @param string $rootParam
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
protected function parseMethod($method, $alias, $root, $sublime, $static = true, $rootParam = 'root'){
|
protected function parseMethod($method, $alias, $static = true){
|
||||||
$output = '';
|
$output = '';
|
||||||
|
|
||||||
|
// Don't add the __clone() functions
|
||||||
if($method->name === '__clone'){
|
if($method->name === '__clone'){
|
||||||
return $output;
|
return $output;
|
||||||
}
|
}
|
||||||
|
|
||||||
$phpdoc = new \phpDocumentor\Reflection\DocBlock($method);
|
$namespace = $method->getDeclaringClass()->getNamespaceName();
|
||||||
|
|
||||||
$description = $phpdoc->getShortDescription();
|
//Create a DocBlock and serializer instance
|
||||||
$longDescription = $phpdoc->getLongDescription()->getContents();
|
$phpdoc = new DocBlock($method, new Context($namespace));
|
||||||
if($longDescription){
|
$serializer = new DocBlockSerializer(1, "\t");
|
||||||
$description .= "\n".$longDescription;
|
|
||||||
}
|
//Get the short + long description from the DocBlock
|
||||||
|
$description = $phpdoc->getText();
|
||||||
|
|
||||||
|
//Loop through parents/interfaces, to fill in {@inheritdoc}
|
||||||
if(strpos($description, '{@inheritdoc}') !== false){
|
if(strpos($description, '{@inheritdoc}') !== false){
|
||||||
$inheritdoc = $this->getInheritDoc($method);
|
$inheritdoc = $this->getInheritDoc($method);
|
||||||
$inheritDescription = $inheritdoc->getShortDescription();
|
$inheritDescription = $inheritdoc->getText();
|
||||||
|
|
||||||
$inheritLongDescription = $inheritdoc->getLongDescription()->getContents();
|
|
||||||
if($inheritLongDescription){
|
|
||||||
$inheritDescription .= "\n".$inheritLongDescription;
|
|
||||||
}
|
|
||||||
$description = str_replace('{@inheritdoc}', $inheritDescription, $description);
|
$description = str_replace('{@inheritdoc}', $inheritDescription, $description);
|
||||||
|
$phpdoc->setText($description);
|
||||||
|
|
||||||
|
//Add the tags that are inherited
|
||||||
$inheritTags = $inheritdoc->getTags();
|
$inheritTags = $inheritdoc->getTags();
|
||||||
if($inheritTags){
|
if($inheritTags){
|
||||||
foreach($inheritTags as $tag){
|
foreach($inheritTags as $tag){
|
||||||
@@ -271,47 +301,39 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
$description = str_replace("\n", "\n\t * ", $description);
|
|
||||||
$output .= "\t/**\n\t * ".$description."\n";
|
|
||||||
$output .= "\t *\n\t * @static\n";
|
|
||||||
|
|
||||||
$paramTags = $phpdoc->getTagsByName('param');
|
//Make the method static
|
||||||
if(!empty($paramTags)){
|
$phpdoc->appendTag(Tag::createInstance('@static', $phpdoc));
|
||||||
foreach ($paramTags as $tag)
|
|
||||||
{
|
|
||||||
$output .="\t * @param\t".$tag->getType()."\t".$tag->getVariableName()."\t".$tag->getDescription()."\n";
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
|
//Get the return type and adjust them for beter autocomplete
|
||||||
$returnTags = $phpdoc->getTagsByName('return');
|
$returnTags = $phpdoc->getTagsByName('return');
|
||||||
if($returnTags){
|
if($returnTags){
|
||||||
|
/** @var $tag */
|
||||||
$tag = reset($returnTags);
|
$tag = reset($returnTags);
|
||||||
$returnValue = $tag->getType();
|
$returnValue = $tag->getType();
|
||||||
|
|
||||||
if(!$sublime and $alias == 'Eloquent' and
|
if($method->name == "__construct"){
|
||||||
|
$tag->setType('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";
|
$tag->addType('static');
|
||||||
}elseif(!$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[]";
|
$tag->addType('\Eloquent[]');
|
||||||
|
$tag->addType('static[]');
|
||||||
|
}elseif($alias == 'Eloquent' and in_array($method->name, array('hasOne', 'hasMany', 'belongsTo', 'belongsToMany', 'morphOne', 'morphTo', 'morphMany'))){
|
||||||
|
$tag->addType('\Eloquent');
|
||||||
}
|
}
|
||||||
$output .= "\t * @return\t".$returnValue."\t".$tag->getDescription()."\n";
|
|
||||||
}else{
|
}else{
|
||||||
$returnValue = null;
|
$returnValue = null;
|
||||||
}
|
}
|
||||||
|
|
||||||
$allTags = $phpdoc->getTags();
|
//Write the output, using the DocBlock serializer
|
||||||
if($allTags){
|
$output .= $serializer->getDocComment($phpdoc) ."\n\t public ".($static ? 'static' : '')." function ".$method->name."(";
|
||||||
foreach($allTags as $tag){
|
|
||||||
if(!in_array($tag->getName(), array('return', 'param'))){
|
|
||||||
$output .= "\t * @".$tag->getName() ." ". $tag->getContent()."\n";
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
$output .= "\t */\n\t public ".($static ? 'static' : '')." function ".$method->name."(";
|
|
||||||
|
|
||||||
|
//Loop through the default values for paremeters, and make the correct output string
|
||||||
$params = array();
|
$params = array();
|
||||||
$paramsWithDefault = array();
|
$paramsWithDefault = array();
|
||||||
foreach ($method->getParameters() as $param) {
|
foreach ($method->getParameters() as $param) {
|
||||||
@@ -337,14 +359,14 @@ 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 !== "void" ? 'return' : '';
|
//Only return when not a constructor and not void.
|
||||||
|
$return = ($returnValue && $returnValue !== "void" && $method->name !== "__construct") ? 'return' : '';
|
||||||
|
|
||||||
if($sublime){
|
//Reference the 'real' function in the declaringclass
|
||||||
$output .= "\t\t\$$rootParam = new $root();\r\n";
|
$root = $method->getDeclaringClass()->getName();
|
||||||
$output .= "\t\t$return \$$rootParam->";
|
$output .= "\t\t$return \\$root::";
|
||||||
}else{
|
|
||||||
$output .= "\t\t$return static::\$$rootParam->";
|
//Write the default parameters in the function call
|
||||||
}
|
|
||||||
$output .= $method->name."(".implode($params, ", ").");\r\n";
|
$output .= $method->name."(".implode($params, ", ").");\r\n";
|
||||||
$output .= "\t }\n\n";
|
$output .= "\t }\n\n";
|
||||||
|
|
||||||
@@ -358,14 +380,15 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
|
|||||||
protected function getInheritDoc($reflectionMethod){
|
protected function getInheritDoc($reflectionMethod){
|
||||||
$parentClass = $reflectionMethod->getDeclaringClass()->getParentClass();
|
$parentClass = $reflectionMethod->getDeclaringClass()->getParentClass();
|
||||||
|
|
||||||
|
//Get either a parent or the interface
|
||||||
if($parentClass){
|
if($parentClass){
|
||||||
$method = $parentClass->getMethod($reflectionMethod->getName());
|
$method = $parentClass->getMethod($reflectionMethod->getName());
|
||||||
}else{
|
}else{
|
||||||
$method = $reflectionMethod->getPrototype();
|
$method = $reflectionMethod->getPrototype();
|
||||||
}
|
}
|
||||||
if($method){
|
if($method){
|
||||||
$phpdoc = new \phpDocumentor\Reflection\DocBlock($method);
|
$phpdoc = new DocBlock($method);
|
||||||
if(strpos($phpdoc->getShortDescription(), '{@inheritdoc}') !== false || strpos($phpdoc->getLongDescription(), '{@inheritdoc}') !== false ){
|
if(strpos($phpdoc->getText(), '{@inheritdoc}') !== false ){
|
||||||
//Not at the end yet, try another parent/interface..
|
//Not at the end yet, try another parent/interface..
|
||||||
return $this->getInheritDoc($method);
|
return $this->getInheritDoc($method);
|
||||||
}else{
|
}else{
|
||||||
|
|||||||
@@ -1,4 +1,14 @@
|
|||||||
<?php namespace Barryvdh\LaravelIdeHelper;
|
<?php
|
||||||
|
/**
|
||||||
|
* Laravel IDE Helper Generator
|
||||||
|
*
|
||||||
|
* @author Barry vd. Heuvel <[email protected]>
|
||||||
|
* @copyright 2013 Barry vd. Heuvel / Fruitcake Studio (http://www.fruitcakestudio.nl)
|
||||||
|
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
||||||
|
* @link https://github.com/barryvdh/laravel-ide-helper
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper;
|
||||||
|
|
||||||
use Illuminate\Support\ServiceProvider;
|
use Illuminate\Support\ServiceProvider;
|
||||||
|
|
||||||
|
|||||||
@@ -1,8 +1,22 @@
|
|||||||
<?php namespace Barryvdh\LaravelIdeHelper;
|
<?php
|
||||||
|
/**
|
||||||
|
* Laravel IDE Helper Generator
|
||||||
|
*
|
||||||
|
* @author Barry vd. Heuvel <[email protected]>
|
||||||
|
* @copyright 2013 Barry vd. Heuvel / Fruitcake Studio (http://www.fruitcakestudio.nl)
|
||||||
|
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
||||||
|
* @link https://github.com/barryvdh/laravel-ide-helper
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper;
|
||||||
use Illuminate\Console\Command;
|
use Illuminate\Console\Command;
|
||||||
use Symfony\Component\Console\Input\InputOption;
|
use Symfony\Component\Console\Input\InputOption;
|
||||||
use Symfony\Component\Console\Input\InputArgument;
|
use Symfony\Component\Console\Input\InputArgument;
|
||||||
use Symfony\Component\ClassLoader\ClassMapGenerator;
|
use Symfony\Component\ClassLoader\ClassMapGenerator;
|
||||||
|
use Barryvdh\Reflection\DocBlock;
|
||||||
|
use Barryvdh\Reflection\DocBlock\Context;
|
||||||
|
use Barryvdh\Reflection\DocBlock\Tag;
|
||||||
|
use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
|
||||||
/**
|
/**
|
||||||
* A command to generate autocomplete information for your IDE
|
* A command to generate autocomplete information for your IDE
|
||||||
*
|
*
|
||||||
@@ -26,6 +40,9 @@ class ModelsCommand extends Command {
|
|||||||
|
|
||||||
protected $properties = array();
|
protected $properties = array();
|
||||||
protected $methods = array();
|
protected $methods = array();
|
||||||
|
protected $write = false;
|
||||||
|
protected $dir;
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -36,16 +53,19 @@ class ModelsCommand extends Command {
|
|||||||
public function fire()
|
public function fire()
|
||||||
{
|
{
|
||||||
$filename = $this->option('filename');
|
$filename = $this->option('filename');
|
||||||
|
$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);
|
||||||
|
|
||||||
$written = \File::put($filename, $content);
|
if(!$this->write){
|
||||||
|
$written = \File::put($filename, $content);
|
||||||
if($written !== false){
|
if($written !== false){
|
||||||
$this->info("Model information was written to $filename");
|
$this->info("Model information was written to $filename");
|
||||||
}else{
|
}else{
|
||||||
$this->error("Failed to write model information to $filename");
|
$this->error("Failed to write model information to $filename");
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
@@ -73,6 +93,8 @@ 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'),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -119,24 +141,33 @@ 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;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Load the properties from the database table.
|
||||||
|
*
|
||||||
|
* @param \Illuminate\Database\Eloquent\Model $model
|
||||||
|
*/
|
||||||
protected function getPropertiesFromTable($model){
|
protected function getPropertiesFromTable($model){
|
||||||
$table = $model->getTable();
|
$table = $model->getTable();
|
||||||
$schema = $model->getConnection()->getDoctrineSchemaManager($table);
|
$schema = $model->getConnection()->getDoctrineSchemaManager($table);
|
||||||
|
$schema->getDatabasePlatform()->registerDoctrineTypeMapping('enum', 'string');
|
||||||
|
|
||||||
$columns = $schema->listTableColumns($table);
|
$columns = $schema->listTableColumns($table);
|
||||||
|
|
||||||
$properties = array();
|
|
||||||
if($columns){
|
if($columns){
|
||||||
foreach ($columns as $column) {
|
foreach ($columns as $column) {
|
||||||
$name = $column->getName();
|
$name = $column->getName();
|
||||||
$type = $column->getType()->getName();
|
$type = $column->getType()->getName();
|
||||||
|
|
||||||
switch($type){
|
switch($type){
|
||||||
case 'string':
|
case 'string':
|
||||||
case 'text':
|
case 'text':
|
||||||
@@ -170,6 +201,9 @@ class ModelsCommand extends Command {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param \Illuminate\Database\Eloquent\Model $model
|
||||||
|
*/
|
||||||
protected function getPropertiesFromMethods($model){
|
protected function getPropertiesFromMethods($model){
|
||||||
$methods = get_class_methods($model);
|
$methods = get_class_methods($model);
|
||||||
if($methods){
|
if($methods){
|
||||||
@@ -232,6 +266,12 @@ class ModelsCommand extends Command {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $name
|
||||||
|
* @param string|null $type
|
||||||
|
* @param bool|null $read
|
||||||
|
* @param bool|null $write
|
||||||
|
*/
|
||||||
protected function setProperty($name, $type = null, $read = null, $write = null){
|
protected function setProperty($name, $type = null, $read = null, $write = null){
|
||||||
if(!isset($this->properties[$name])){
|
if(!isset($this->properties[$name])){
|
||||||
$this->properties[$name] = array();
|
$this->properties[$name] = array();
|
||||||
@@ -260,18 +300,38 @@ class ModelsCommand extends Command {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $class
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
protected function createPhpDocs($class){
|
protected function createPhpDocs($class){
|
||||||
|
|
||||||
if(strpos($class, '\\') !== false){
|
$reflection = new \ReflectionClass($class);
|
||||||
$parts = explode('\\', $class);
|
$namespace = $reflection->getNamespaceName();
|
||||||
$class = array_pop($parts);
|
$classname = $reflection->getShortName();
|
||||||
$namespace = implode($parts, '\\');
|
$originalDoc = $reflection->getDocComment();
|
||||||
}else{
|
$phpdoc = new DocBlock($reflection, new Context($namespace));
|
||||||
$namespace = '';
|
|
||||||
|
if(!$phpdoc->getText()){
|
||||||
|
$phpdoc->setText("Generated properties for $class");
|
||||||
}
|
}
|
||||||
$output = "namespace $namespace{\n";
|
|
||||||
$output .= "\t/**\n\t *\n\t * Generated properties for $class\n\t *\n";
|
$properties = array();
|
||||||
|
$methods = array();
|
||||||
|
foreach($phpdoc->getTags() as $tag){
|
||||||
|
$name = $tag->getName();
|
||||||
|
if($name == "property" || $name == "property-read" || $name == "property-write"){
|
||||||
|
$properties[] =$tag->getVariableName();
|
||||||
|
}elseif($name == "method"){
|
||||||
|
$methods[] = $tag->getMethodName();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
foreach($this->properties as $name => $property){
|
foreach($this->properties as $name => $property){
|
||||||
|
$name = "\$$name";
|
||||||
|
if(in_array($name, $properties)){
|
||||||
|
continue;
|
||||||
|
}
|
||||||
if($property['read'] && $property['write']){
|
if($property['read'] && $property['write']){
|
||||||
$attr = 'property';
|
$attr = 'property';
|
||||||
}elseif($property['write']){
|
}elseif($property['write']){
|
||||||
@@ -279,16 +339,43 @@ class ModelsCommand extends Command {
|
|||||||
}else{
|
}else{
|
||||||
$attr = 'property-read';
|
$attr = 'property-read';
|
||||||
}
|
}
|
||||||
$type = $property['type'];
|
$tag = Tag::createInstance("@{$attr} {$property['type']} {$name}", $phpdoc);
|
||||||
$output .= "\t * @$attr $type \$$name \n";
|
$phpdoc->appendTag($tag);
|
||||||
}
|
}
|
||||||
|
|
||||||
foreach($this->methods as $name => $method){
|
foreach($this->methods as $name => $method){
|
||||||
$type = $method['type'];
|
if(in_array($name, $methods)){
|
||||||
$output .= "\t * @method $type $name() \n";
|
continue;
|
||||||
|
}
|
||||||
|
$name = "$name()";
|
||||||
|
$tag = Tag::createInstance("@method {$method['type']} {$name}", $phpdoc);
|
||||||
|
$phpdoc->appendTag($tag);
|
||||||
}
|
}
|
||||||
|
|
||||||
$output .= "\t *\n\t */\n\tclass $class {}\n}\n\n";
|
$serializer = new DocBlockSerializer();
|
||||||
|
$serializer->getDocComment($phpdoc);
|
||||||
|
$docComment = $serializer->getDocComment($phpdoc);
|
||||||
|
|
||||||
|
|
||||||
|
if($this->write){
|
||||||
|
$filename = $reflection->getFileName();
|
||||||
|
$contents = \File::get($filename);
|
||||||
|
if($originalDoc){
|
||||||
|
$contents = str_replace($originalDoc, $docComment, $contents);
|
||||||
|
}else{
|
||||||
|
$needle = "class {$classname}";
|
||||||
|
$replace = "{$docComment}\nclass {$classname}";
|
||||||
|
$pos = strpos($contents,$needle);
|
||||||
|
if ($pos !== false) {
|
||||||
|
$contents = substr_replace($contents,$replace,$pos,strlen($needle));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if(\File::put($filename, $contents)){
|
||||||
|
$this->info('Written new phpDocBlock to '.$filename);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$output = "namespace {$namespace}{\n{$docComment}\n\tclass {$classname} {}\n}\n\n";
|
||||||
return $output;
|
return $output;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -55,7 +55,7 @@ return array(
|
|||||||
'Auth' => array('Illuminate\Auth\Guard'),
|
'Auth' => array('Illuminate\Auth\Guard'),
|
||||||
'Cache' => array('Illuminate\Cache\StoreInterface', 'Illuminate\Cache\Repository'),
|
'Cache' => array('Illuminate\Cache\StoreInterface', 'Illuminate\Cache\Repository'),
|
||||||
'DB' => array('Illuminate\Database\Connection'),
|
'DB' => array('Illuminate\Database\Connection'),
|
||||||
'Eloquent' => array('Illuminate\Database\Query\Builder'),
|
'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
|
||||||
'Queue' => array('Illuminate\Queue\QueueInterface'),
|
'Queue' => array('Illuminate\Queue\QueueInterface'),
|
||||||
),
|
),
|
||||||
|
|
||||||
@@ -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