mirror of
https://github.com/barryvdh/laravel-ide-helper.git
synced 2026-08-18 18:13:11 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
facba3a5e6 | ||
|
|
7d09f324fa | ||
|
|
af34b1cca2 | ||
|
|
463bfdd70a | ||
|
|
ff7d2a33b0 | ||
|
|
3ebfcd1c6c | ||
|
|
c3afd5f63c | ||
|
|
92abb112e9 | ||
|
|
7e1c64fb95 | ||
|
|
5e5cfce28c | ||
|
|
098090ed36 | ||
|
|
7f055cec7e | ||
|
|
5a0f8f1b64 | ||
|
|
92ec89bf87 | ||
|
|
afeaf2f28b | ||
|
|
865bd8d32b | ||
|
|
e368338ba7 | ||
|
|
7bd3e1cc0a | ||
|
|
28ce1492ad | ||
|
|
d9516325f0 | ||
|
|
d1e396f658 | ||
|
|
a916da0ce4 | ||
|
|
fc887b4431 | ||
|
|
7b08db2682 | ||
|
|
742aeb2f56 | ||
|
|
c1619fd6b3 | ||
|
|
1a593833a2 | ||
|
|
e9cbd7e732 | ||
|
|
ac6740f59f | ||
|
|
60ec740b15 | ||
|
|
aedd2ee127 | ||
|
|
007a96ef3f | ||
|
|
63b1026fc3 | ||
|
|
d042c6ea8e | ||
|
|
ae0dce2abd | ||
|
|
7f17da57b2 | ||
|
|
0f22941e51 | ||
|
|
f7f0e025f3 | ||
|
|
4790413752 | ||
|
|
4f31e98467 | ||
|
|
17ae13ce56 | ||
|
|
fedae6542b | ||
|
|
e8b1c367d0 | ||
|
|
66feb564e1 | ||
|
|
15bf867658 | ||
|
|
c4de6e80c9 | ||
|
|
6f03c4c5ff | ||
|
|
8db4443879 |
+6
-5
@@ -11,11 +11,12 @@
|
|||||||
],
|
],
|
||||||
"require": {
|
"require": {
|
||||||
"php": ">=5.3.0",
|
"php": ">=5.3.0",
|
||||||
"illuminate/support": "4.0.x",
|
"illuminate/support": "4.x",
|
||||||
"illuminate/console": "4.0.x",
|
"illuminate/console": "4.x",
|
||||||
"illuminate/filesystem": "4.0.x",
|
"illuminate/filesystem": "4.x",
|
||||||
"phpdocumentor/reflection-docblock": "dev-master#6d705c1a0f9e2a6d73d2e9ec0e538b9dfaf4315f",
|
"phpdocumentor/reflection-docblock": "2.0.0",
|
||||||
"symfony/class-loader": "2.3.*"
|
"symfony/class-loader": "~2.3",
|
||||||
|
"doctrine/dbal": "~2.3"
|
||||||
},
|
},
|
||||||
"autoload": {
|
"autoload": {
|
||||||
"psr-0": {
|
"psr-0": {
|
||||||
|
|||||||
@@ -1,4 +1,5 @@
|
|||||||
## Laravel IDE Helper Generator
|
## 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
|
### Complete phpDocs, directly from the source
|
||||||
|
|
||||||
@@ -7,7 +8,7 @@ If you don't want to generate it, you can add a pre-generated file to the root f
|
|||||||
|
|
||||||
* Generated version: https://gist.github.com/barryvdh/5227822
|
* Generated version: https://gist.github.com/barryvdh/5227822
|
||||||
|
|
||||||
Note: You do need CodeIntel for Sublime Text: https://github.com/Kronuz/SublimeCodeIntel
|
Note: You do need CodeIntel for Sublime Text: https://github.com/SublimeCodeIntel/SublimeCodeIntel
|
||||||
|
|
||||||
### Automatic phpDoc generation for Laravel Facades
|
### Automatic phpDoc generation for Laravel Facades
|
||||||
|
|
||||||
@@ -51,21 +52,40 @@ The Illuminate/Support/helpers.php is already set-up, but you can add/remove you
|
|||||||
|
|
||||||
If you don't want to write your properties yourself, you can use the 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.
|
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 `--write (-W)` option. By default, you are asked to overwrite or
|
||||||
|
write to a seperate file (_ide_helper_models.php) (You can force No with `--nowrite (-N)`).
|
||||||
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.
|
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.
|
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.
|
||||||
|
|
||||||
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
|
||||||
`php artisan ide-helper:models Post,User`
|
|
||||||
|
|
||||||
Note: With namespaces, uses \\ instead of \
|
/**
|
||||||
`php artisan ide-helper:models API\\User`
|
* 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
|
||||||
|
*/
|
||||||
|
|
||||||
This creates a file with the phpDocs for each Model. You should check and change them to be more accurate.
|
By default, models in app/models are scanned. The optional argument tells what models to use (also outside app/models).
|
||||||
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
|
||||||
|
|
||||||
|
You can also scan a different directory, using the --dir option (relative from the base path):
|
||||||
|
|
||||||
|
php artisan ide-helper:models --dir="app/workbench/name/package/models"
|
||||||
|
|
||||||
|
Models can be ignored using the --ignore (-I) option
|
||||||
|
|
||||||
|
php artisan ide-helper:models --ignore="Post,User"
|
||||||
|
|
||||||
|
Note: With namespaces, wrap your model name in " signs: `php artisan ide-helper:models "API\User"`, or escape the slashes (`Api\\User`)
|
||||||
|
|
||||||
### License
|
### License
|
||||||
|
|
||||||
|
|||||||
@@ -39,9 +39,9 @@ class GeneratorCommand extends Command {
|
|||||||
protected $description = 'Generate a new IDE Helper file.';
|
protected $description = 'Generate a new IDE Helper file.';
|
||||||
|
|
||||||
protected $extra;
|
protected $extra;
|
||||||
protected $nonstatic;
|
|
||||||
protected $onlyExtend;
|
protected $onlyExtend;
|
||||||
protected $helpers;
|
protected $helpers;
|
||||||
|
protected $magic;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -61,10 +61,9 @@ class GeneratorCommand extends Command {
|
|||||||
}
|
}
|
||||||
|
|
||||||
$this->extra = \Config::get('laravel-ide-helper::extra');
|
$this->extra = \Config::get('laravel-ide-helper::extra');
|
||||||
$this->nonstatic = \Config::get('laravel-ide-helper::nonstatic');
|
$this->magic = \Config::get('laravel-ide-helper::magic');
|
||||||
$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');
|
$this->helpers = \Config::get('laravel-ide-helper::helper_files');
|
||||||
}else{
|
}else{
|
||||||
$this->helpers = array();
|
$this->helpers = array();
|
||||||
@@ -133,13 +132,79 @@ class GeneratorCommand extends Command {
|
|||||||
*
|
*
|
||||||
* @author Barry vd. Heuvel <[email protected]>
|
* @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
|
//Get all aliases
|
||||||
$aliases = $aliasLoader->getAliases();
|
$aliases = $aliasLoader->getAliases();
|
||||||
|
|
||||||
foreach($aliases as $alias => $facade){
|
foreach($aliases as $alias => $facade){
|
||||||
|
|
||||||
|
$root = $this->getRoot($facade);
|
||||||
|
if(!$root){
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
try{
|
||||||
|
|
||||||
|
//Some classes extend the facade
|
||||||
|
if(interface_exists($facade)){
|
||||||
|
$output .= "interface $alias extends $facade{\n";
|
||||||
|
}elseif(class_exists($facade)){
|
||||||
|
$output .= "class $alias extends $facade{\n";
|
||||||
|
}else{
|
||||||
|
$output .= "class $alias{\n";
|
||||||
|
}
|
||||||
|
|
||||||
|
$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);
|
||||||
|
|
||||||
|
|
||||||
|
$driver = $this->getDriver($alias);
|
||||||
|
if($driver){
|
||||||
|
$output .= $this->getMethods($driver, $alias, $usedMethods);
|
||||||
|
}
|
||||||
|
|
||||||
|
//Add extra methods, from other classes (magic static calls)
|
||||||
|
if(array_key_exists($alias, $this->extra)){
|
||||||
|
$output .= $this->getMethods($this->extra[$alias], $alias, $usedMethods);
|
||||||
|
}
|
||||||
|
|
||||||
|
//Add extra methods, from other classes (magic static calls)
|
||||||
|
if(array_key_exists($alias, $this->magic)){
|
||||||
|
$output .= $this->addMagicMethods($this->magic[$alias], $alias, $usedMethods);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
$output .= "}\n\n";
|
||||||
|
|
||||||
|
}catch(\Exception $e){
|
||||||
|
$this->error("Exception: ".$e->getMessage()."\nCould not analyze $root.");
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
//Include the helper file, if requested
|
||||||
|
if(!empty($this->helpers)){
|
||||||
|
foreach($this->helpers as $helper){
|
||||||
|
if (file_exists($helper)){
|
||||||
|
$output .= str_replace(array('<?php', '?>'), '', \File::get($helper));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return $output;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the real root of a facade
|
||||||
|
*
|
||||||
|
* @param $facade
|
||||||
|
* @return bool|string
|
||||||
|
*/
|
||||||
|
protected function getRoot($facade){
|
||||||
try{
|
try{
|
||||||
//If possible, get the facade root
|
//If possible, get the facade root
|
||||||
if(method_exists($facade, 'getFacadeRoot')){
|
if(method_exists($facade, 'getFacadeRoot')){
|
||||||
@@ -151,76 +216,62 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
|
|||||||
//If it doesn't exist, skip it
|
//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;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
return $root;
|
||||||
|
|
||||||
//When the database connection is not set, some classes will be skipped
|
//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;
|
return false;
|
||||||
}catch(\Exception $e){
|
}catch(\Exception $e){
|
||||||
$this->error("Exception: ".$e->getMessage()."\nSkipping $facade.");
|
$this->error("Exception: ".$e->getMessage()."\nSkipping $facade.");
|
||||||
continue;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
//Get the namespace from the alias.
|
|
||||||
if(strpos($alias, '\\') !== false){
|
|
||||||
$parts = explode('\\', $alias);
|
|
||||||
$alias = array_pop($parts);
|
|
||||||
$namespace = implode($parts, '\\');
|
|
||||||
}else{
|
|
||||||
$namespace = '';
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function getDriver($alias){
|
||||||
try{
|
try{
|
||||||
//Reflect on the class
|
if($alias == "Auth"){
|
||||||
$reflection = new \ReflectionClass($root);
|
$driver = \Auth::driver();
|
||||||
|
}elseif($alias == "DB"){
|
||||||
$output .= "namespace $namespace {\n";
|
$driver = \DB::connection();
|
||||||
|
}elseif($alias == "Cache"){
|
||||||
//Some classes extend the facade
|
$driver = \Cache::driver();
|
||||||
if($root !== $facade or in_array($alias, $this->onlyExtend)){
|
}elseif($alias == "Queue"){
|
||||||
//If the root class is not the same as the facade extend it.
|
$driver = \Queue::connection();
|
||||||
$output .= " class $alias extends $facade{\n";
|
|
||||||
}else{
|
}else{
|
||||||
$output .= " class $alias{\n";
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
//If they extend, don't include them.
|
return get_class($driver);
|
||||||
if(!in_array($alias, $this->onlyExtend))
|
}catch(\Exception $e){
|
||||||
{
|
$this->error("Could not determine driver/connection for $alias.");
|
||||||
$usedMethods = array();
|
return false;
|
||||||
|
|
||||||
//Check if there are non-static methods for this alias
|
|
||||||
if(array_key_exists($alias, $this->nonstatic) ){
|
|
||||||
$nonstaticMethods = $this->nonstatic[$alias];
|
|
||||||
}else{
|
|
||||||
$nonstaticMethods = array();
|
|
||||||
}
|
|
||||||
|
|
||||||
//Get all public methods for this class
|
|
||||||
$methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
|
|
||||||
if($methods)
|
|
||||||
{
|
|
||||||
foreach ($methods as $method)
|
|
||||||
{
|
|
||||||
//Skip methods that are already used
|
|
||||||
if(!in_array($method->name, $usedMethods)){
|
|
||||||
$static = !in_array($method->name, $nonstaticMethods);
|
|
||||||
$declaringClass = $method->getDeclaringClass();
|
|
||||||
$output .= $this->parseMethod($method, $alias, $static);
|
|
||||||
$usedMethods[] = $method->name;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
//Add extra methods, from other classes (magic calls)
|
/**
|
||||||
if(array_key_exists($alias, $this->extra)){
|
* Get the methods for one or multiple classes.
|
||||||
foreach($this->extra[$alias] as $extraClass){
|
*
|
||||||
if(!class_exists($extraClass) && !interface_exists($extraClass)){
|
* @param $classes
|
||||||
|
* @param $alias
|
||||||
|
* @param $usedMethods
|
||||||
|
* @param bool $addOutput
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
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;
|
continue;
|
||||||
}
|
}
|
||||||
$reflection = new \ReflectionClass($extraClass);
|
$reflection = new \ReflectionClass($class);
|
||||||
|
|
||||||
$methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
|
$methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
|
||||||
if($methods)
|
if($methods)
|
||||||
@@ -228,52 +279,65 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\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);
|
if( $addOutput){
|
||||||
$output .= $this->parseMethod($method, $alias, $static);
|
$output .= $this->parseMethod($method, $alias, $reflection);
|
||||||
|
}
|
||||||
|
$usedMethods[] = $method->name;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return $output;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the methods for one or multiple magic methods.
|
||||||
|
*
|
||||||
|
* @param $methods
|
||||||
|
* @param $alias
|
||||||
|
* @param $usedMethods
|
||||||
|
* @param bool $addOutput
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
protected function addMagicMethods($methods, $alias, &$usedMethods, $addOutput = true){
|
||||||
|
$output = '';
|
||||||
|
foreach($methods as $magic => $real){
|
||||||
|
list($className, $name) = explode('::', $real);
|
||||||
|
if(!class_exists($className) && !interface_exists($className)){
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
$method = new \ReflectionMethod($className, $name);
|
||||||
|
$class = new \ReflectionClass($className);
|
||||||
|
|
||||||
|
if(!in_array($method->name, $usedMethods)){
|
||||||
|
if( $addOutput){
|
||||||
|
$output .= $this->parseMethod($method, $alias, $class, $magic);
|
||||||
|
}
|
||||||
$usedMethods[] = $method->name;
|
$usedMethods[] = $method->name;
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
|
||||||
}
|
$usedMethods[] = $magic;
|
||||||
|
|
||||||
}
|
}
|
||||||
}
|
|
||||||
}
|
|
||||||
$output .= " }\n}\n\n";
|
|
||||||
|
|
||||||
}catch(\Exception $e){
|
|
||||||
$this->error("Exception: ".$e->getMessage()."\nCould not analyze $root.");
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
//Include the helper file, if requested
|
|
||||||
if(!empty($helpers)){
|
|
||||||
foreach($helpers as $helper){
|
|
||||||
if (file_exists($helper)){
|
|
||||||
$output .= str_replace(array('<?php', '?>'), '', \File::get($helper));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return $output;
|
return $output;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param \ReflectionMethod $method
|
* @param \ReflectionMethod $method
|
||||||
* @param string $alias
|
* @param string $alias
|
||||||
* @param string $root
|
* @param $class
|
||||||
* @param bool $static
|
* @param null $methodName
|
||||||
* @param string $rootParam
|
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
protected function parseMethod($method, $alias, $static = true){
|
protected function parseMethod($method, $alias, $class, $methodName = null){
|
||||||
$output = '';
|
$output = '';
|
||||||
|
|
||||||
// Don't add the __clone() functions
|
// Don't add the __clone() functions
|
||||||
if($method->name === '__clone'){
|
if($method->name === '__clone'){
|
||||||
return $output;
|
return $output;
|
||||||
}
|
}
|
||||||
|
$methodName = $methodName ?: $method->name;
|
||||||
|
|
||||||
$namespace = $method->getDeclaringClass()->getNamespaceName();
|
$namespace = $method->getDeclaringClass()->getNamespaceName();
|
||||||
|
|
||||||
@@ -281,6 +345,51 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
|
|||||||
$phpdoc = new DocBlock($method, new Context($namespace));
|
$phpdoc = new DocBlock($method, new Context($namespace));
|
||||||
$serializer = new DocBlockSerializer(1, "\t");
|
$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->getReturn($phpdoc);
|
||||||
|
|
||||||
|
//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 ".$methodName."(";
|
||||||
|
|
||||||
|
$output .= implode($paramsWithDefault, ", ");
|
||||||
|
$output .= "){\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\n";
|
||||||
|
}
|
||||||
|
|
||||||
|
$output .= "\t\t$return $root::";
|
||||||
|
|
||||||
|
//Write the default parameters in the function call
|
||||||
|
$output .= $method->name."(".implode($params, ", ").");\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
|
//Get the short + long description from the DocBlock
|
||||||
$description = $phpdoc->getText();
|
$description = $phpdoc->getText();
|
||||||
|
|
||||||
@@ -301,52 +410,34 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
//Make the method static
|
|
||||||
$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
|
||||||
|
* @return string|null
|
||||||
|
*/
|
||||||
|
protected function getReturn($phpdoc){
|
||||||
//Get the return type and adjust them for beter autocomplete
|
//Get the return type and adjust them for beter autocomplete
|
||||||
$returnTags = $phpdoc->getTagsByName('return');
|
$returnTags = $phpdoc->getTagsByName('return');
|
||||||
if($returnTags){
|
if($returnTags){
|
||||||
/** @var $tag */
|
/** @var $tag */
|
||||||
$tag = reset($returnTags);
|
$tag = reset($returnTags);
|
||||||
$returnValue = $tag->getType();
|
$returnValue = $tag->getType();
|
||||||
|
|
||||||
if($method->name == "__construct"){
|
|
||||||
$returnValue = 'self';
|
|
||||||
}elseif($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($alias == 'Eloquent' and in_array($method->name, array('all', 'get'))){
|
|
||||||
$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());
|
|
||||||
}else{
|
}else{
|
||||||
$returnValue = null;
|
$returnValue = null;
|
||||||
}
|
}
|
||||||
|
return $returnValue;
|
||||||
|
}
|
||||||
|
|
||||||
//Write the output, using the DocBlock serializer
|
/**
|
||||||
$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
|
//Loop through the default values for paremeters, and make the correct output string
|
||||||
$params = array();
|
$params = array();
|
||||||
$paramsWithDefault = array();
|
$paramsWithDefault = array();
|
||||||
@@ -370,21 +461,7 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
|
|||||||
}
|
}
|
||||||
$paramsWithDefault[] = $paramStr;
|
$paramsWithDefault[] = $paramStr;
|
||||||
}
|
}
|
||||||
$output .= implode($paramsWithDefault, ", ");
|
return array($params, $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
|
|
||||||
$root = $method->getDeclaringClass()->getName();
|
|
||||||
$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;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ class IdeHelperServiceProvider extends ServiceProvider {
|
|||||||
*
|
*
|
||||||
* @var bool
|
* @var bool
|
||||||
*/
|
*/
|
||||||
protected $defer = false;
|
protected $defer = true;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Bootstrap the application events.
|
* Bootstrap the application events.
|
||||||
|
|||||||
@@ -30,6 +30,7 @@ class ModelsCommand extends Command {
|
|||||||
* @var string
|
* @var string
|
||||||
*/
|
*/
|
||||||
protected $name = 'ide-helper:models';
|
protected $name = 'ide-helper:models';
|
||||||
|
protected $filename = '_ide_helper_models.php';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The console command description.
|
* The console command description.
|
||||||
@@ -42,6 +43,7 @@ class ModelsCommand extends Command {
|
|||||||
protected $methods = array();
|
protected $methods = array();
|
||||||
protected $write = false;
|
protected $write = false;
|
||||||
protected $dir;
|
protected $dir;
|
||||||
|
protected $reset;
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -56,8 +58,17 @@ class ModelsCommand extends Command {
|
|||||||
$this->write = $this->option('write');
|
$this->write = $this->option('write');
|
||||||
$this->dir = $this->option('dir');
|
$this->dir = $this->option('dir');
|
||||||
$model = $this->argument('model');
|
$model = $this->argument('model');
|
||||||
|
$ignore = $this->option('ignore');
|
||||||
|
$this->reset = $this->option('reset');
|
||||||
|
|
||||||
$content = $this->generateDocs($model);
|
//If filename is default and Write is not specified, ask what to do
|
||||||
|
if(!$this->write && $filename === $this->filename && !$this->option('nowrite')){
|
||||||
|
if($this->confirm("Do you want to overwrite the existing model files for '$model'? Choose no to write to $filename instead? (Yes/No): ")){
|
||||||
|
$this->write = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$content = $this->generateDocs($model, $ignore);
|
||||||
|
|
||||||
if(!$this->write){
|
if(!$this->write){
|
||||||
$written = \File::put($filename, $content);
|
$written = \File::put($filename, $content);
|
||||||
@@ -67,7 +78,6 @@ class ModelsCommand extends Command {
|
|||||||
$this->error("Failed to write model information to $filename");
|
$this->error("Failed to write model information to $filename");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
@@ -80,7 +90,6 @@ class ModelsCommand extends Command {
|
|||||||
{
|
{
|
||||||
return array(
|
return array(
|
||||||
array('model', InputArgument::OPTIONAL, 'Which models to include', '*'),
|
array('model', InputArgument::OPTIONAL, 'Which models to include', '*'),
|
||||||
|
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -92,13 +101,16 @@ class ModelsCommand extends Command {
|
|||||||
protected function getOptions()
|
protected function getOptions()
|
||||||
{
|
{
|
||||||
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', $this->filename),
|
||||||
array('dir', 'D', InputOption::VALUE_OPTIONAL, 'The model dir','app/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'),
|
||||||
|
array('nowrite', 'N', InputOption::VALUE_NONE, 'Don\'t write to Model file'),
|
||||||
|
array('reset', 'R', InputOption::VALUE_NONE, 'Remove the original phpdocs instead of appending'),
|
||||||
|
array('ignore', 'I', InputOption::VALUE_OPTIONAL, 'Which models to ignore', ''),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
protected function generateDocs($model){
|
protected function generateDocs($model, $ignore = ''){
|
||||||
|
|
||||||
|
|
||||||
$output = "<?php
|
$output = "<?php
|
||||||
@@ -117,7 +129,15 @@ class ModelsCommand extends Command {
|
|||||||
$models = explode(',', $model);
|
$models = explode(',', $model);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
$ignore = explode(',', $ignore);
|
||||||
|
|
||||||
foreach($models as $name){
|
foreach($models as $name){
|
||||||
|
if(in_array($name, $ignore)){
|
||||||
|
$this->comment("Ignoring model '$name'");
|
||||||
|
continue;
|
||||||
|
}else{
|
||||||
|
$this->comment("Loading model '$name'");
|
||||||
|
}
|
||||||
$this->properties = array();
|
$this->properties = array();
|
||||||
$this->methods = array();
|
$this->methods = array();
|
||||||
if(class_exists($name)){
|
if(class_exists($name)){
|
||||||
@@ -222,9 +242,13 @@ class ModelsCommand extends Command {
|
|||||||
}
|
}
|
||||||
}elseif(\Str::startsWith($method, 'scope') && $method !== 'scopeQuery'){
|
}elseif(\Str::startsWith($method, 'scope') && $method !== 'scopeQuery'){
|
||||||
//Magic set<name>Attribute
|
//Magic set<name>Attribute
|
||||||
$name = \Str::snake(substr($method, 5));
|
$name = \Str::camel(substr($method, 5));
|
||||||
if(!empty($name)){
|
if(!empty($name)){
|
||||||
$this->setMethod($name, 'static');
|
$reflection = new \ReflectionMethod($model, $method);
|
||||||
|
$args = $this->getParameters($reflection);
|
||||||
|
//Remove the first ($query) argument
|
||||||
|
array_shift($args);
|
||||||
|
$this->setMethod($name, $reflection->class, $args);
|
||||||
}
|
}
|
||||||
}elseif(!method_exists('Eloquent', $method) && !\Str::startsWith($method, 'get')){
|
}elseif(!method_exists('Eloquent', $method) && !\Str::startsWith($method, 'get')){
|
||||||
|
|
||||||
@@ -290,13 +314,11 @@ class ModelsCommand extends Command {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
protected function setMethod($name, $type = null){
|
protected function setMethod($name, $type = '', $arguments=array()){
|
||||||
if(!isset($this->methods[$name])){
|
if(!isset($this->methods[$name])){
|
||||||
$this->methods[$name] = array();
|
$this->methods[$name] = array();
|
||||||
$this->methods[$name]['type'] = 'static';
|
|
||||||
}
|
|
||||||
if($type !== null){
|
|
||||||
$this->methods[$name]['type'] = $type;
|
$this->methods[$name]['type'] = $type;
|
||||||
|
$this->methods[$name]['arguments'] = $arguments;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -310,10 +332,15 @@ class ModelsCommand extends Command {
|
|||||||
$namespace = $reflection->getNamespaceName();
|
$namespace = $reflection->getNamespaceName();
|
||||||
$classname = $reflection->getShortName();
|
$classname = $reflection->getShortName();
|
||||||
$originalDoc = $reflection->getDocComment();
|
$originalDoc = $reflection->getDocComment();
|
||||||
|
|
||||||
|
if($this->reset){
|
||||||
|
$phpdoc = new DocBlock('', new Context($namespace));
|
||||||
|
}else{
|
||||||
$phpdoc = new DocBlock($reflection, new Context($namespace));
|
$phpdoc = new DocBlock($reflection, new Context($namespace));
|
||||||
|
}
|
||||||
|
|
||||||
if(!$phpdoc->getText()){
|
if(!$phpdoc->getText()){
|
||||||
$phpdoc->setText("Generated properties for $class");
|
$phpdoc->setText("An Eloquent Model: '$class'");
|
||||||
}
|
}
|
||||||
|
|
||||||
$properties = array();
|
$properties = array();
|
||||||
@@ -347,8 +374,8 @@ class ModelsCommand extends Command {
|
|||||||
if(in_array($name, $methods)){
|
if(in_array($name, $methods)){
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
$name = "$name()";
|
$arguments = implode(', ',$method['arguments']);
|
||||||
$tag = Tag::createInstance("@method {$method['type']} {$name}", $phpdoc);
|
$tag = Tag::createInstance("@method static {$method['type']} {$name}({$arguments}) ", $phpdoc);
|
||||||
$phpdoc->appendTag($tag);
|
$phpdoc->appendTag($tag);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -379,4 +406,37 @@ class ModelsCommand extends Command {
|
|||||||
return $output;
|
return $output;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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) {
|
||||||
|
$paramStr = '$'.$param->getName();
|
||||||
|
$params[] = $paramStr;
|
||||||
|
if ($param->isOptional()) {
|
||||||
|
$default = $param->getDefaultValue();
|
||||||
|
if(is_bool($default)){
|
||||||
|
$default = $default? 'true':'false';
|
||||||
|
}elseif(is_array($default)){
|
||||||
|
$default = 'array()';
|
||||||
|
}elseif(is_null($default)){
|
||||||
|
$default = 'null';
|
||||||
|
}elseif(is_int($default)){
|
||||||
|
//$default = $default;
|
||||||
|
}else{
|
||||||
|
$default = "'".trim($default)."'";
|
||||||
|
}
|
||||||
|
$paramStr .= " = $default";
|
||||||
|
}
|
||||||
|
$paramsWithDefault[] = $paramStr;
|
||||||
|
}
|
||||||
|
return $paramsWithDefault;
|
||||||
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|||||||
+14
-42
@@ -13,18 +13,6 @@ return array(
|
|||||||
|
|
||||||
'filename' => '_ide_helper.php',
|
'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
|
| Helper files to include
|
||||||
@@ -52,38 +40,22 @@ return array(
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
'extra' => array(
|
'extra' => array(
|
||||||
'Auth' => array('Illuminate\Auth\Guard'),
|
'Artisan' => array('Illuminate\Foundation\Artisan'),
|
||||||
'Cache' => array('Illuminate\Cache\StoreInterface', 'Illuminate\Cache\Repository'),
|
|
||||||
'DB' => array('Illuminate\Database\Connection'),
|
|
||||||
'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
|
'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
|
||||||
'Queue' => array('Illuminate\Queue\QueueInterface'),
|
'Session' => array('Illuminate\Session\Store'),
|
||||||
),
|
),
|
||||||
|
|
||||||
|
'magic' => array(
|
||||||
/*
|
'Log' => array(
|
||||||
|--------------------------------------------------------------------------
|
'debug' => 'Monolog\Logger::addDebug',
|
||||||
| Non-static methods
|
'info' => 'Monolog\Logger::addInfo',
|
||||||
|--------------------------------------------------------------------------
|
'notice' => 'Monolog\Logger::addNotice',
|
||||||
|
|
'warning' => 'Monolog\Logger::addWarning',
|
||||||
| These functions aren't actually facade calls, so don't make them static
|
'error' => 'Monolog\Logger::addError',
|
||||||
|
|
'critical' => 'Monolog\Logger::addCritical',
|
||||||
*/
|
'alert' => 'Monolog\Logger::addAlert',
|
||||||
|
'emergency' => 'Monolog\Logger::addEmergency',
|
||||||
'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',
|
|
||||||
),
|
|
||||||
|
|
||||||
);
|
);
|
||||||
|
|||||||
Reference in New Issue
Block a user