mirror of
https://github.com/barryvdh/laravel-ide-helper.git
synced 2026-08-18 01:57:13 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e9cbd7e732 | ||
|
|
ac6740f59f | ||
|
|
60ec740b15 | ||
|
|
aedd2ee127 | ||
|
|
007a96ef3f | ||
|
|
63b1026fc3 | ||
|
|
d042c6ea8e | ||
|
|
ae0dce2abd | ||
|
|
7f17da57b2 | ||
|
|
0f22941e51 | ||
|
|
f7f0e025f3 | ||
|
|
4790413752 | ||
|
|
4f31e98467 | ||
|
|
17ae13ce56 | ||
|
|
fedae6542b | ||
|
|
e8b1c367d0 | ||
|
|
66feb564e1 | ||
|
|
15bf867658 | ||
|
|
c4de6e80c9 | ||
|
|
6f03c4c5ff | ||
|
|
8db4443879 | ||
|
|
1d01f5b278 | ||
|
|
2466f5a5a4 | ||
|
|
bbbdd02708 | ||
|
|
d8a6bfbf21 | ||
|
|
ce4e9804ef | ||
|
|
12845b38f0 | ||
|
|
0b3b8b95cd | ||
|
|
2ee05260d5 | ||
|
|
ec302acc3f | ||
|
|
e0b47835f4 | ||
|
|
a0f6a370e1 |
+5
-5
@@ -11,11 +11,11 @@
|
||||
],
|
||||
"require": {
|
||||
"php": ">=5.3.0",
|
||||
"illuminate/support": "4.0.x",
|
||||
"illuminate/console": "4.0.x",
|
||||
"illuminate/filesystem": "4.0.x",
|
||||
"phpdocumentor/reflection-docblock": "dev-master#6d705c1a0f9e2a6d73d2e9ec0e538b9dfaf4315f",
|
||||
"symfony/class-loader": "2.3.*"
|
||||
"illuminate/support": "4.x",
|
||||
"illuminate/console": "4.x",
|
||||
"illuminate/filesystem": "4.x",
|
||||
"barryvdh/reflection-docblock": ">=2.0.1",
|
||||
"symfony/class-loader": "~2.3"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-0": {
|
||||
|
||||
@@ -1,24 +1,22 @@
|
||||
## Laravel IDE Helper Generator
|
||||
[](https://packagist.org/packages/barryvdh/laravel-ide-helper) [](https://packagist.org/packages/barryvdh/laravel-ide-helper)
|
||||
|
||||
### 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
|
||||
* SublimeText CodeIntel version: https://gist.github.com/barryvdh/5227814
|
||||
* Generated version: https://gist.github.com/barryvdh/5227822
|
||||
|
||||
Note: You do need CodeIntel for Sublime Text: https://github.com/SublimeCodeIntel/SublimeCodeIntel
|
||||
|
||||
### 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 and run composer update (or run `composer require barryvdh/laravel-ide-helper:1.*` directly):
|
||||
|
||||
"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',
|
||||
|
||||
@@ -26,18 +24,14 @@ You can now re-generate the docs yourself (for future updates) in artisan
|
||||
|
||||
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: bootstrap/compiled.php has to be cleared first, so run `php artisan clear-compiled` before generating (and `php artisan optimize` after..)
|
||||
|
||||
You can configure your composer.json to do this after each commit:
|
||||
|
||||
"scripts":{
|
||||
"post-update-cmd":[
|
||||
"php artisan ide-helper:generate",
|
||||
"php artisan optimize"
|
||||
"php artisan optimize",
|
||||
]
|
||||
},
|
||||
|
||||
@@ -54,25 +48,36 @@ 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.
|
||||
|
||||
|
||||
### 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. Still in beta, so please provide feedback if you want.
|
||||
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.
|
||||
|
||||
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.
|
||||
You can now also write the comments directly to your Model file, using the `--write (-W)` option. 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.
|
||||
With the `--reset (-R)` option, the existing phpdocs are ignored, only the newly found columns/relations are saved as phpdocs.
|
||||
|
||||
php artisan ide-helper:models Post
|
||||
|
||||
/**
|
||||
* An Eloquent Model: 'Post'
|
||||
*
|
||||
* @property integer $id
|
||||
* @property integer $author_id
|
||||
* @property string $title
|
||||
* @property string $text
|
||||
* @property \Carbon\Carbon $created_at
|
||||
* @property \Carbon\Carbon $updated_at
|
||||
* @property-read \User $author
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection|\Comment[] $comments
|
||||
*/
|
||||
|
||||
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`
|
||||
|
||||
Note: With namespaces, uses \\ instead of \
|
||||
`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.
|
||||
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.
|
||||
php artisan ide-helper:models Post,User
|
||||
|
||||
Note: With namespaces, uses `\\` instead of `\`: `php artisan ide-helper:models API\\User`
|
||||
|
||||
### License
|
||||
|
||||
|
||||
@@ -13,10 +13,10 @@ use Illuminate\Console\Command;
|
||||
use Symfony\Component\Console\Input\InputOption;
|
||||
use Symfony\Component\Console\Input\InputArgument;
|
||||
use Illuminate\Foundation\AliasLoader;
|
||||
use phpDocumentor\Reflection\DocBlock;
|
||||
use phpDocumentor\Reflection\DocBlock\Context;
|
||||
use phpDocumentor\Reflection\DocBlock\Tag;
|
||||
use phpDocumentor\Reflection\DocBlock\Serializer as DocBlockSerializer;
|
||||
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
|
||||
*
|
||||
@@ -39,10 +39,8 @@ class GeneratorCommand extends Command {
|
||||
protected $description = 'Generate a new IDE Helper file.';
|
||||
|
||||
protected $extra;
|
||||
protected $nonstatic;
|
||||
protected $onlyExtend;
|
||||
protected $helpers;
|
||||
protected $sublime;
|
||||
|
||||
|
||||
/**
|
||||
@@ -62,17 +60,13 @@ class GeneratorCommand extends Command {
|
||||
}
|
||||
|
||||
$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'))){
|
||||
|
||||
if( $this->option('helpers') || (\Config::get('laravel-ide-helper::include_helpers') )){
|
||||
$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);
|
||||
@@ -116,7 +110,7 @@ class GeneratorCommand extends Command {
|
||||
return array(
|
||||
array('helpers', "H", InputOption::VALUE_NONE, 'Include the helper files'),
|
||||
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'),
|
||||
);
|
||||
}
|
||||
|
||||
@@ -136,103 +130,46 @@ class GeneratorCommand extends Command {
|
||||
*
|
||||
* @author Barry vd. Heuvel <[email protected]>
|
||||
*/
|
||||
namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
|
||||
exit('Only to be used as an helper for your IDE');\n\n";
|
||||
|
||||
//Get all aliases
|
||||
$aliases = $aliasLoader->getAliases();
|
||||
|
||||
foreach($aliases as $alias => $facade){
|
||||
|
||||
try{
|
||||
if(method_exists($facade, 'getFacadeRoot')){
|
||||
$root = get_class($facade::getFacadeRoot());
|
||||
}else{
|
||||
$root = $facade;
|
||||
}
|
||||
|
||||
if(!class_exists($root) && !interface_exists($root)){
|
||||
$this->error("Class $root is not found.");
|
||||
continue;
|
||||
}
|
||||
}catch(\PDOException $e){
|
||||
$this->error("PDOException: ".$e->getMessage()."\nPlease configure your database connection correctly, or use the sqlite memory driver (-M). Skipping $facade.");
|
||||
continue;
|
||||
}catch(\Exception $e){
|
||||
$this->error("Exception: ".$e->getMessage()."\nSkipping $facade.");
|
||||
$root = $this->getRoot($facade);
|
||||
if(!$root){
|
||||
continue;
|
||||
}
|
||||
|
||||
if(strpos($alias, '\\') !== false){
|
||||
$parts = explode('\\', $alias);
|
||||
$alias = array_pop($parts);
|
||||
$namespace = implode($parts, '\\');
|
||||
}else{
|
||||
$namespace = '';
|
||||
}
|
||||
|
||||
try{
|
||||
$reflection = new \ReflectionClass($root);
|
||||
|
||||
$output .= "namespace $namespace {\n";
|
||||
|
||||
if($root !== $facade or in_array($alias, $this->onlyExtend)){
|
||||
//If the root class is not the same as the facade extend it.
|
||||
$output .= " class $alias extends $facade{\n";
|
||||
//Some classes extend the facade
|
||||
if(class_exists($facade)){
|
||||
$output .= "class $alias extends $facade{\n";
|
||||
}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))
|
||||
{
|
||||
$usedMethods = array();
|
||||
if(array_key_exists($alias, $this->nonstatic) ){
|
||||
$nonstaticMethods = $this->nonstatic[$alias];
|
||||
}else{
|
||||
$nonstaticMethods = array();
|
||||
}
|
||||
$usedMethods = array();
|
||||
|
||||
//Only add the methods to the output when the root is not the same as the facade.
|
||||
$addOutput = ($root !== $facade);
|
||||
$output .= $this->getMethods($root, $alias, $usedMethods, $addOutput);
|
||||
|
||||
|
||||
$methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
|
||||
if($methods)
|
||||
{
|
||||
foreach ($methods as $method)
|
||||
{
|
||||
if(!in_array($method->name, $usedMethods)){
|
||||
$static = !in_array($method->name, $nonstaticMethods);
|
||||
$output .= $this->parseMethod($method, $alias, $root, $static);
|
||||
$usedMethods[] = $method->name;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if(array_key_exists($alias, $this->extra)){
|
||||
$i = 2;
|
||||
foreach($this->extra[$alias] as $extraClass){
|
||||
if(!class_exists($extraClass) && !interface_exists($extraClass)){
|
||||
continue;
|
||||
}
|
||||
$reflection = new \ReflectionClass($extraClass);
|
||||
|
||||
$methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
|
||||
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)
|
||||
{
|
||||
if(!in_array($method->name, $usedMethods)){
|
||||
$static = !in_array($method->name, $nonstaticMethods);
|
||||
$output .= $this->parseMethod($method, $alias, $extraClass, $static, $rootParam);
|
||||
$usedMethods[] = $method->name;
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
$driver = $this->getDriver($alias);
|
||||
if($driver){
|
||||
$output .= $this->getMethods($driver, $alias, $usedMethods);
|
||||
}
|
||||
$output .= " }\n}\n\n";
|
||||
|
||||
//Add extra methods, from other classes (magic static calls)
|
||||
if(array_key_exists($alias, $this->extra)){
|
||||
$output .= $this->getMethods($this->extra[$alias], $alias, $usedMethods);
|
||||
}
|
||||
|
||||
|
||||
$output .= "}\n\n";
|
||||
|
||||
}catch(\Exception $e){
|
||||
$this->error("Exception: ".$e->getMessage()."\nCould not analyze $root.");
|
||||
@@ -240,6 +177,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)){
|
||||
foreach($helpers as $helper){
|
||||
if (file_exists($helper)){
|
||||
@@ -252,26 +190,160 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
|
||||
}
|
||||
|
||||
/**
|
||||
* @param \ReflectionMethod $method
|
||||
* @param string $alias
|
||||
* @param string $root
|
||||
* @param bool $static
|
||||
* @param string $rootParam
|
||||
* Get the real root of a facade
|
||||
*
|
||||
* @param $facade
|
||||
* @return bool|string
|
||||
*/
|
||||
protected function getRoot($facade){
|
||||
try{
|
||||
//If possible, get the facade root
|
||||
if(method_exists($facade, 'getFacadeRoot')){
|
||||
$root = get_class($facade::getFacadeRoot());
|
||||
}else{
|
||||
$root = $facade;
|
||||
}
|
||||
|
||||
//If it doesn't exist, skip it
|
||||
if(!class_exists($root) && !interface_exists($root)){
|
||||
$this->error("Class $root is not found.");
|
||||
return false;
|
||||
}
|
||||
|
||||
return $root;
|
||||
|
||||
//When the database connection is not set, some classes will be skipped
|
||||
}catch(\PDOException $e){
|
||||
$this->error("PDOException: ".$e->getMessage()."\nPlease configure your database connection correctly, or use the sqlite memory driver (-M). Skipping $facade.");
|
||||
return false;
|
||||
}catch(\Exception $e){
|
||||
$this->error("Exception: ".$e->getMessage()."\nSkipping $facade.");
|
||||
return false;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
public function getDriver($alias){
|
||||
if($alias == "Auth"){
|
||||
$driver = \Auth::driver();
|
||||
}elseif($alias == "DB"){
|
||||
$driver = \DB::connection();
|
||||
}elseif($alias == "Cache"){
|
||||
$driver = \Cache::driver();
|
||||
}elseif($alias == "Queue"){
|
||||
$driver = \Queue::connection();
|
||||
}else{
|
||||
return false;
|
||||
}
|
||||
|
||||
return get_class($driver);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the methods for one or multiple classes.
|
||||
*
|
||||
* @param $classes
|
||||
* @param $alias
|
||||
* @param $usedMethods
|
||||
* @param bool $addOutput
|
||||
* @return string
|
||||
*/
|
||||
protected function parseMethod($method, $alias, $root, $static = true, $rootParam = 'root'){
|
||||
protected function getMethods($classes, $alias, &$usedMethods, $addOutput = true){
|
||||
if(!is_array($classes)){
|
||||
$classes = array($classes);
|
||||
}
|
||||
$output = '';
|
||||
foreach($classes as $class){
|
||||
if(!class_exists($class) && !interface_exists($class)){
|
||||
continue;
|
||||
}
|
||||
$reflection = new \ReflectionClass($class);
|
||||
|
||||
$methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
|
||||
if($methods)
|
||||
{
|
||||
foreach ($methods as $method)
|
||||
{
|
||||
if(!in_array($method->name, $usedMethods)){
|
||||
if( $addOutput){
|
||||
$output .= $this->parseMethod($method, $alias, $reflection);
|
||||
}
|
||||
$usedMethods[] = $method->name;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
return $output;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param \ReflectionMethod $method
|
||||
* @param string $alias
|
||||
* @return string
|
||||
*/
|
||||
protected function parseMethod($method, $alias, $class){
|
||||
$output = '';
|
||||
|
||||
// Don't add the __clone() functions
|
||||
if($method->name === '__clone'){
|
||||
return $output;
|
||||
}
|
||||
|
||||
$namespace = $method->getDeclaringClass()->getNamespaceName();
|
||||
|
||||
//Create a DocBlock and serializer instance
|
||||
$phpdoc = new DocBlock($method, new Context($namespace));
|
||||
$serializer = new DocBlockSerializer(1, "\t");
|
||||
|
||||
//Normalize the description and inherit the docs from parents/interfaces
|
||||
$this->normalizeDescription($phpdoc, $method);
|
||||
|
||||
//Correct the return values
|
||||
$returnValue = $this->normalizeReturn($phpdoc, $method, $alias);
|
||||
|
||||
//Get the parameters, including formatted default values
|
||||
list($params, $paramsWithDefault) = $this->getParameters($method);
|
||||
|
||||
//Make the method static
|
||||
$phpdoc->appendTag(Tag::createInstance('@static', $phpdoc));
|
||||
|
||||
//Write the output, using the DocBlock serializer
|
||||
$output .= $serializer->getDocComment($phpdoc) ."\n\t public static function ".$method->name."(";
|
||||
|
||||
$output .= implode($paramsWithDefault, ", ");
|
||||
$output .= "){\r\n";
|
||||
|
||||
//Only return when not a constructor and not void.
|
||||
$return = ($returnValue && $returnValue !== "void" && $method->name !== "__construct") ? 'return' : '';
|
||||
|
||||
//Reference the 'real' function in the declaringclass
|
||||
$declaringClass = $method->getDeclaringClass();
|
||||
$root = $class->getName();
|
||||
|
||||
if($declaringClass->name != $root){
|
||||
$output .= "\t\t//Method inherited from $declaringClass->name\r\n";
|
||||
}
|
||||
|
||||
$output .= "\t\t$return $root::";
|
||||
|
||||
//Write the default parameters in the function call
|
||||
$output .= $method->name."(".implode($params, ", ").");\r\n";
|
||||
$output .= "\t }\n\n";
|
||||
|
||||
return $output;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the description and get the inherited docs.
|
||||
*
|
||||
* @param $phpdoc
|
||||
* @param $method
|
||||
*/
|
||||
protected function normalizeDescription(&$phpdoc, $method){
|
||||
//Get the short + long description from the DocBlock
|
||||
$description = $phpdoc->getText();
|
||||
|
||||
//Loop through parents/interfaces, to fill in {@inheritdoc}
|
||||
if(strpos($description, '{@inheritdoc}') !== false){
|
||||
$inheritdoc = $this->getInheritDoc($method);
|
||||
$inheritDescription = $inheritdoc->getText();
|
||||
@@ -279,6 +351,7 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
|
||||
$description = str_replace('{@inheritdoc}', $inheritDescription, $description);
|
||||
$phpdoc->setText($description);
|
||||
|
||||
//Add the tags that are inherited
|
||||
$inheritTags = $inheritdoc->getTags();
|
||||
if($inheritTags){
|
||||
foreach($inheritTags as $tag){
|
||||
@@ -287,47 +360,43 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$phpdoc->appendTag(Tag::createInstance('@static', $phpdoc));
|
||||
|
||||
//Looping through the parameters and re-setting the type, to get the expanded type (with namespace)
|
||||
//Should be fixed in a future version of ReflectionDocBlock I hope..
|
||||
$paramTags = $phpdoc->getTagsByName('param');
|
||||
if($paramTags){
|
||||
/** @var $tag */
|
||||
foreach($paramTags as $tag){
|
||||
$content = $tag->getContent();
|
||||
//Closure should be \Closure..
|
||||
$content = str_replace('\Closure', 'Closure', $content);
|
||||
$content = str_replace('Closure', '\Closure', $content);
|
||||
$tag->setContent($content);
|
||||
$tag->setContent($tag->getType() . ' ' . $tag->getVariableName() . ' ' . $tag->getDescription());
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Make some changes to the return types, if needed.
|
||||
*
|
||||
* @param $phpdoc
|
||||
* @param $method
|
||||
* @param $alias
|
||||
* @return null
|
||||
*/
|
||||
protected function normalizeReturn(&$phpdoc, $method, $alias){
|
||||
//Get the return type and adjust them for beter autocomplete
|
||||
$returnTags = $phpdoc->getTagsByName('return');
|
||||
if($returnTags){
|
||||
/** @var $tag */
|
||||
$tag = reset($returnTags);
|
||||
$returnValue = $tag->getType();
|
||||
|
||||
if(!$this->sublime and $alias == 'Eloquent' and
|
||||
(in_array($method->name, array('pluck', 'first', 'fill', 'newInstance', 'newFromBuilder', 'create', 'find', 'findOrFail'))
|
||||
or $returnValue === '\Illuminate\Database\Query\Builder')){
|
||||
//Reference the calling class, to provide more accurate auto-complete
|
||||
$returnValue = "static";
|
||||
}elseif(!$this->sublime and $alias == 'Eloquent' and in_array($method->name, array('all', 'get'))){
|
||||
$returnValue .= "|\Eloquent[]|static[]";
|
||||
if($method->name == "__construct"){
|
||||
$tag->setType('self');
|
||||
}elseif($alias == 'Eloquent' and in_array($method->name, array('hasOne', 'hasMany', 'belongsTo', 'belongsToMany', 'morphOne', 'morphTo', 'morphMany'))){
|
||||
$returnValue .= "|\Eloquent";
|
||||
$tag->addType('\Eloquent');
|
||||
}
|
||||
$tag->setContent($returnValue . " ". $tag->getDescription());
|
||||
}else{
|
||||
$returnValue = null;
|
||||
}
|
||||
return $returnValue;
|
||||
}
|
||||
|
||||
$output .= $serializer->getDocComment($phpdoc) ."\n\t public ".($static ? 'static' : '')." function ".$method->name."(";
|
||||
|
||||
/**
|
||||
* Get the parameters and format them correctly
|
||||
*
|
||||
* @param $method
|
||||
* @return array
|
||||
*/
|
||||
public function getParameters($method){
|
||||
//Loop through the default values for paremeters, and make the correct output string
|
||||
$params = array();
|
||||
$paramsWithDefault = array();
|
||||
foreach ($method->getParameters() as $param) {
|
||||
@@ -350,21 +419,7 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
|
||||
}
|
||||
$paramsWithDefault[] = $paramStr;
|
||||
}
|
||||
$output .= implode($paramsWithDefault, ", ");
|
||||
$output .= "){\r\n";
|
||||
|
||||
$return = ($returnValue && $returnValue !== "void") ? 'return' : '';
|
||||
|
||||
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 .= "\t }\n\n";
|
||||
|
||||
return $output;
|
||||
return array($params, $paramsWithDefault);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -374,6 +429,7 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
|
||||
protected function getInheritDoc($reflectionMethod){
|
||||
$parentClass = $reflectionMethod->getDeclaringClass()->getParentClass();
|
||||
|
||||
//Get either a parent or the interface
|
||||
if($parentClass){
|
||||
$method = $parentClass->getMethod($reflectionMethod->getName());
|
||||
}else{
|
||||
|
||||
@@ -13,10 +13,10 @@ use Illuminate\Console\Command;
|
||||
use Symfony\Component\Console\Input\InputOption;
|
||||
use Symfony\Component\Console\Input\InputArgument;
|
||||
use Symfony\Component\ClassLoader\ClassMapGenerator;
|
||||
use phpDocumentor\Reflection\DocBlock;
|
||||
use phpDocumentor\Reflection\DocBlock\Context;
|
||||
use phpDocumentor\Reflection\DocBlock\Tag;
|
||||
use phpDocumentor\Reflection\DocBlock\Serializer as DocBlockSerializer;
|
||||
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
|
||||
*
|
||||
@@ -42,6 +42,7 @@ class ModelsCommand extends Command {
|
||||
protected $methods = array();
|
||||
protected $write = false;
|
||||
protected $dir;
|
||||
protected $reset;
|
||||
|
||||
|
||||
|
||||
@@ -56,6 +57,7 @@ class ModelsCommand extends Command {
|
||||
$this->write = $this->option('write');
|
||||
$this->dir = $this->option('dir');
|
||||
$model = $this->argument('model');
|
||||
$this->reset = $this->option('reset');
|
||||
|
||||
$content = $this->generateDocs($model);
|
||||
|
||||
@@ -95,6 +97,7 @@ class ModelsCommand extends Command {
|
||||
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('reset', 'R', InputOption::VALUE_NONE, 'Remove the original phpdocs instead of appending'),
|
||||
);
|
||||
}
|
||||
|
||||
@@ -310,10 +313,15 @@ class ModelsCommand extends Command {
|
||||
$namespace = $reflection->getNamespaceName();
|
||||
$classname = $reflection->getShortName();
|
||||
$originalDoc = $reflection->getDocComment();
|
||||
$phpdoc = new DocBlock($reflection, new Context($namespace));
|
||||
|
||||
if($this->reset){
|
||||
$phpdoc = new DocBlock('', new Context($namespace));
|
||||
}else{
|
||||
$phpdoc = new DocBlock($reflection, new Context($namespace));
|
||||
}
|
||||
|
||||
if(!$phpdoc->getText()){
|
||||
$phpdoc->setText("Generated properties for $class");
|
||||
$phpdoc->setText("An Eloquent Model: '$class'");
|
||||
}
|
||||
|
||||
$properties = array();
|
||||
|
||||
+1
-44
@@ -13,18 +13,6 @@ return array(
|
||||
|
||||
'filename' => '_ide_helper.php',
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Sublime version
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| Use a different code format, better for SublimeText (instead of Netbeans/phpStorm)
|
||||
| Can also be used with the --sublime (-S) option.
|
||||
|
|
||||
*/
|
||||
|
||||
'sublime' => false,
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Helper files to include
|
||||
@@ -52,38 +40,7 @@ return array(
|
||||
*/
|
||||
|
||||
'extra' => array(
|
||||
'Auth' => array('Illuminate\Auth\Guard'),
|
||||
'Cache' => array('Illuminate\Cache\StoreInterface', 'Illuminate\Cache\Repository'),
|
||||
'DB' => array('Illuminate\Database\Connection'),
|
||||
'Eloquent' => array('Illuminate\Database\Query\Builder'),
|
||||
'Queue' => array('Illuminate\Queue\QueueInterface'),
|
||||
),
|
||||
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Non-static methods
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| These functions aren't actually facade calls, so don't make them static
|
||||
|
|
||||
*/
|
||||
|
||||
'nonstatic' => array(
|
||||
'Eloquent' => array('freshTimestamp', 'newCollection', 'toArray', 'toJson', 'toSql', 'delete'),
|
||||
),
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Only extend
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| These implementations aren't called static, so only extend them.
|
||||
|
|
||||
*/
|
||||
|
||||
'only_extend' => array(
|
||||
'Seeder',
|
||||
'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
|
||||
),
|
||||
|
||||
);
|
||||
|
||||
Reference in New Issue
Block a user