mirror of
https://github.com/barryvdh/laravel-ide-helper.git
synced 2026-08-18 01:57:13 +00:00
Extend instead of redefining functions
For methods that are not a facade (like Eloquent/Controller), avoids duplicate code and better autocomplete (also variables etc). No more need for extra config settings, only the magic calls still.
This commit is contained in:
Barry vd. Heuvel
@@ -39,7 +39,7 @@ class GeneratorCommand extends Command {
|
||||
protected $description = 'Generate a new IDE Helper file.';
|
||||
|
||||
protected $extra;
|
||||
protected $nonstatic;
|
||||
protected $extra_nonstatic;
|
||||
protected $onlyExtend;
|
||||
protected $helpers;
|
||||
|
||||
@@ -61,9 +61,8 @@ 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');
|
||||
|
||||
$this->extra_nonstatic = \Config::get('laravel-ide-helper::extra_nonstatic');
|
||||
|
||||
if( $this->option('helpers') || (\Config::get('laravel-ide-helper::include_helpers') )){
|
||||
$this->helpers = \Config::get('laravel-ide-helper::helper_files');
|
||||
}else{
|
||||
@@ -179,66 +178,70 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
|
||||
$output .= "namespace $namespace {\n";
|
||||
|
||||
//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.
|
||||
$output .= " class $alias extends $facade{\n";
|
||||
}else{
|
||||
$output .= " class $alias{\n";
|
||||
}
|
||||
$output .= " class $alias extends $facade{\n";
|
||||
|
||||
//If they extend, don't include them.
|
||||
if(!in_array($alias, $this->onlyExtend))
|
||||
$usedMethods = array();
|
||||
|
||||
//Get all public methods for this class
|
||||
$methods = $reflection->getMethods();
|
||||
if($methods)
|
||||
{
|
||||
$usedMethods = array();
|
||||
|
||||
//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)
|
||||
{
|
||||
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;
|
||||
//Skip methods that are already used
|
||||
if(!in_array($method->name, $usedMethods)){
|
||||
if($method->isPublic() && $root !== $facade){
|
||||
$output .= $this->parseMethod($method, $alias);
|
||||
}
|
||||
$usedMethods[] = $method->name;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
//Add extra methods, from other classes (magic calls)
|
||||
if(array_key_exists($alias, $this->extra)){
|
||||
foreach($this->extra[$alias] as $extraClass){
|
||||
if(!class_exists($extraClass) && !interface_exists($extraClass)){
|
||||
continue;
|
||||
}
|
||||
$reflection = new \ReflectionClass($extraClass);
|
||||
//Add extra methods, from other classes (magic static calls)
|
||||
if(array_key_exists($alias, $this->extra)){
|
||||
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)
|
||||
$methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
|
||||
if($methods)
|
||||
{
|
||||
foreach ($methods as $method)
|
||||
{
|
||||
foreach ($methods as $method)
|
||||
{
|
||||
if(!in_array($method->name, $usedMethods)){
|
||||
$static = !in_array($method->name, $nonstaticMethods);
|
||||
$output .= $this->parseMethod($method, $alias, $static);
|
||||
$usedMethods[] = $method->name;
|
||||
}
|
||||
|
||||
if(!in_array($method->name, $usedMethods)){
|
||||
$output .= $this->parseMethod($method, $alias);
|
||||
$usedMethods[] = $method->name;
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
//Add extra methods, from other classes (magic calls)
|
||||
if(array_key_exists($alias, $this->extra_nonstatic)){
|
||||
foreach($this->extra_nonstatic[$alias] as $extraClass){
|
||||
if(!class_exists($extraClass) && !interface_exists($extraClass)){
|
||||
continue;
|
||||
}
|
||||
$reflection = new \ReflectionClass($extraClass);
|
||||
|
||||
$methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
|
||||
if($methods)
|
||||
{
|
||||
foreach ($methods as $method)
|
||||
{
|
||||
if(!in_array($method->name, $usedMethods)){
|
||||
$output .= $this->parseMethod($method, $alias, false);
|
||||
$usedMethods[] = $method->name;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$output .= " }\n}\n\n";
|
||||
|
||||
}catch(\Exception $e){
|
||||
@@ -331,7 +334,7 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
|
||||
}
|
||||
|
||||
//Write the output, using the DocBlock serializer
|
||||
$output .= $serializer->getDocComment($phpdoc) ."\n\t public ".($static ? 'static' : '')." function ".$method->name."(";
|
||||
$output .= $serializer->getDocComment($phpdoc) ."\n\t public ".($static ? 'static ' : '')."function ".$method->name."(";
|
||||
|
||||
//Loop through the default values for paremeters, and make the correct output string
|
||||
$params = array();
|
||||
|
||||
+2
-39
@@ -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
|
||||
@@ -55,35 +43,10 @@ return array(
|
||||
'Auth' => array('Illuminate\Auth\Guard'),
|
||||
'Cache' => array('Illuminate\Cache\StoreInterface', 'Illuminate\Cache\Repository'),
|
||||
'DB' => array('Illuminate\Database\Connection'),
|
||||
'Eloquent' => array('Illuminate\Database\Eloquent\Builder', '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',
|
||||
'extra_nonstatic' => array(
|
||||
'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
|
||||
),
|
||||
|
||||
);
|
||||
|
||||
Reference in New Issue
Block a user