mirror of
https://github.com/barryvdh/laravel-ide-helper.git
synced 2026-08-18 10:07:12 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a9dae91e4d | ||
|
|
645926fd37 | ||
|
|
0b70167182 | ||
|
|
138b3deeb1 | ||
|
|
9f265f0178 | ||
|
|
26e02d295f | ||
|
|
bfe955ce1f | ||
|
|
50e760bac1 | ||
|
|
e882cdf84d | ||
|
|
c1286d5a9e | ||
|
|
b92d24429d | ||
|
|
f77f5ae770 | ||
|
|
82ffa52d79 | ||
|
|
d8ed55be7a | ||
|
|
16f77638f1 | ||
|
|
348ecb361c | ||
|
|
df8852e8dd | ||
|
|
95ab3676dc | ||
|
|
bf6ca64a08 | ||
|
|
4e36c08168 | ||
|
|
0577429e4e | ||
|
|
77fbef112d | ||
|
|
bb92081dde | ||
|
|
23b41db33d | ||
|
|
7b47af171d | ||
|
|
512574de9a | ||
|
|
46558e9060 | ||
|
|
f79776d06f | ||
|
|
6a1f7d61cf | ||
|
|
14cd044103 | ||
|
|
b6a9d8e4f9 | ||
|
|
e6493fd9e8 | ||
|
|
caeb0227b6 | ||
|
|
948eb369a6 | ||
|
|
107fda3c20 | ||
|
|
0166a1bc9b | ||
|
|
cae77c279d | ||
|
|
2c3c1e96d5 | ||
|
|
874cd4c1a2 | ||
|
|
0dc098a7ba | ||
|
|
7ee52d7e61 | ||
|
|
430c5d7db4 | ||
|
|
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 | ||
|
|
1d01f5b278 | ||
|
|
2466f5a5a4 | ||
|
|
bbbdd02708 | ||
|
|
d8a6bfbf21 | ||
|
|
ce4e9804ef | ||
|
|
12845b38f0 | ||
|
|
0b3b8b95cd | ||
|
|
2ee05260d5 | ||
|
|
ec302acc3f | ||
|
|
e0b47835f4 | ||
|
|
a0f6a370e1 | ||
|
|
77c8bfa05a | ||
|
|
62deba4171 | ||
|
|
32918908fc | ||
|
|
cca1b5896e |
+16
-5
@@ -11,16 +11,27 @@
|
||||
],
|
||||
"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",
|
||||
"phpdocumentor/reflection-docblock": "2.0.x",
|
||||
"symfony/class-loader": "~2.3"
|
||||
},
|
||||
"require-dev": {
|
||||
"doctrine/dbal": "~2.3"
|
||||
},
|
||||
"suggest": {
|
||||
"doctrine/dbal": "Load information from the database about models for phpdocs (~2.3)"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-0": {
|
||||
"Barryvdh\\LaravelIdeHelper": "src/"
|
||||
}
|
||||
},
|
||||
"extra": {
|
||||
"branch-alias": {
|
||||
"dev-master": "1.x-dev"
|
||||
}
|
||||
},
|
||||
"minimum-stability": "dev"
|
||||
}
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"providers": [
|
||||
"Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider"
|
||||
]
|
||||
}
|
||||
@@ -1,24 +1,24 @@
|
||||
## 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.
|
||||
_Checkout [this Laracasts video](https://laracasts.com/series/how-to-be-awesome-in-phpstorm/episodes/15) for a quick introduction/explanation!_
|
||||
|
||||
* Netbeans and PHPStorm version: https://gist.github.com/barryvdh/5227822
|
||||
* SublimeText CodeIntel version: https://gist.github.com/barryvdh/5227814
|
||||
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)
|
||||
|
||||
* 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 +26,15 @@ 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 clear-compiled",
|
||||
"php artisan ide-helper:generate",
|
||||
"php artisan optimize"
|
||||
"php artisan optimize",
|
||||
]
|
||||
},
|
||||
|
||||
@@ -54,25 +51,46 @@ 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
|
||||
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.
|
||||
> **Note:** Since v1.10 you need to require `doctrine/dbal: ~2.3` in your own composer.json.
|
||||
|
||||
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.
|
||||
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. You can write the comments directly to your Model file, using the `--write (-W)` option. By default, you are asked to overwrite or write to a separate file (\_ide\_helper\_models.php) (You can force No with `--nowrite (-N)`).
|
||||
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.
|
||||
|
||||
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
|
||||
|
||||
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.
|
||||
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.
|
||||
By default, 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
|
||||
|
||||
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" --dir="app/src/Model"
|
||||
|
||||
You can publish the config file (`php artisan config:publish barryvdh/laravel-ide-helper`) and set the default directories.
|
||||
|
||||
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
|
||||
|
||||
|
||||
@@ -39,10 +39,9 @@ class GeneratorCommand extends Command {
|
||||
protected $description = 'Generate a new IDE Helper file.';
|
||||
|
||||
protected $extra;
|
||||
protected $nonstatic;
|
||||
protected $onlyExtend;
|
||||
protected $helpers;
|
||||
protected $sublime;
|
||||
protected $magic;
|
||||
|
||||
|
||||
/**
|
||||
@@ -53,7 +52,7 @@ class GeneratorCommand extends Command {
|
||||
public function fire()
|
||||
{
|
||||
if (file_exists($compiled = base_path().'/bootstrap/compiled.php')){
|
||||
$this->error('Error: first delete bootstrap/compiled.php (php artisan clear-compiled)');
|
||||
$this->error('Error generating IDE Helper: first delete bootstrap/compiled.php (php artisan clear-compiled)');
|
||||
}else{
|
||||
$filename = $this->argument('filename');
|
||||
|
||||
@@ -62,17 +61,14 @@ 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'))){
|
||||
$this->magic = \Config::get('laravel-ide-helper::magic');
|
||||
|
||||
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 +112,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'),
|
||||
);
|
||||
}
|
||||
|
||||
@@ -129,149 +125,309 @@ class GeneratorCommand extends Command {
|
||||
|
||||
$aliasLoader = AliasLoader::getInstance();
|
||||
|
||||
$output = "<?php
|
||||
$outputString = "<?php
|
||||
/**
|
||||
* An helper file for Laravel 4, to provide autocomplete information to your IDE
|
||||
* Generated with https://github.com/barryvdh/laravel-ide-helper
|
||||
*
|
||||
* @author Barry vd. Heuvel <[email protected]>
|
||||
*/
|
||||
namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
|
||||
*/\n\n";
|
||||
$output['__root'] = "\texit('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.");
|
||||
//Check if the facade is not a Trait
|
||||
if(function_exists('trait_exists') && trait_exists($facade)){
|
||||
continue;
|
||||
}catch(\Exception $e){
|
||||
$this->error("Exception: ".$e->getMessage()."\nSkipping $facade.");
|
||||
}
|
||||
$facade = '\\'.ltrim($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);
|
||||
if (strpos($alias, '\\')){
|
||||
$nsParts = explode('\\', $alias);
|
||||
$alias = array_pop($nsParts);
|
||||
$ns = implode('\\', $nsParts);
|
||||
} else {
|
||||
$ns = '__root';
|
||||
}
|
||||
if (!isset($output[$ns])) $output[$ns] = '';
|
||||
|
||||
$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(interface_exists($facade)){
|
||||
$output[$ns] .= "\tinterface $alias extends $facade{\n";
|
||||
}elseif(class_exists($facade)){
|
||||
$output[$ns] .= "\tclass $alias extends $facade{\n";
|
||||
}else{
|
||||
$output .= " class $alias{\n";
|
||||
$output[$ns] .= "\tclass $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[$ns] .= $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[$ns] .= $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[$ns] .= $this->getMethods($this->extra[$alias], $alias, $usedMethods);
|
||||
}
|
||||
|
||||
//Add extra methods, from other classes (magic static calls)
|
||||
if(array_key_exists($alias, $this->magic)){
|
||||
$output[$ns] .= $this->addMagicMethods($this->magic[$alias], $alias, $usedMethods);
|
||||
}
|
||||
|
||||
|
||||
$output[$ns] .= "\t}\n";
|
||||
|
||||
}catch(\Exception $e){
|
||||
$this->error("Exception: ".$e->getMessage()."\nCould not analyze $root.");
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
if(!empty($helpers)){
|
||||
foreach($helpers as $helper){
|
||||
|
||||
//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));
|
||||
$output['__root'] .= str_replace(array('<?php', '?>'), '', \File::get($helper));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
foreach ($output as $ns => $body){
|
||||
if ($ns == '__root'){
|
||||
$ns = '';
|
||||
}
|
||||
$outputString .= "namespace $ns{\n";
|
||||
$outputString .= $body;
|
||||
$outputString .= "}\n\n";
|
||||
}
|
||||
|
||||
return $outputString;
|
||||
}
|
||||
|
||||
/**
|
||||
* 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;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the driver/connection/store from the managers
|
||||
*
|
||||
* @param $alias
|
||||
* @return array|bool|string
|
||||
*/
|
||||
public function getDriver($alias){
|
||||
try{
|
||||
if($alias == "Auth"){
|
||||
$driver = \Auth::driver();
|
||||
}elseif($alias == "DB"){
|
||||
$driver = \DB::connection();
|
||||
}elseif($alias == "Cache"){
|
||||
$driver = get_class(\Cache::driver());
|
||||
$store = get_class(\Cache::getStore());
|
||||
return array($driver, $store);
|
||||
}elseif($alias == "Queue"){
|
||||
$driver = \Queue::connection();
|
||||
}else{
|
||||
return false;
|
||||
}
|
||||
|
||||
return get_class($driver);
|
||||
}catch(\Exception $e){
|
||||
$this->error("Could not determine driver/connection for $alias.");
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the methods for one or multiple classes.
|
||||
*
|
||||
* @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;
|
||||
}
|
||||
$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;
|
||||
}
|
||||
|
||||
/**
|
||||
* 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[] = $magic;
|
||||
|
||||
}
|
||||
return $output;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param \ReflectionMethod $method
|
||||
* @param string $alias
|
||||
* @param string $root
|
||||
* @param bool $static
|
||||
* @param string $rootParam
|
||||
* @param $class
|
||||
* @param null $methodName
|
||||
* @return string
|
||||
*/
|
||||
protected function parseMethod($method, $alias, $root, $static = true, $rootParam = 'root'){
|
||||
protected function parseMethod($method, $alias, $class, $methodName = null){
|
||||
$output = '';
|
||||
|
||||
// Don't add the __clone() functions
|
||||
if($method->name === '__clone'){
|
||||
return $output;
|
||||
}
|
||||
$methodName = $methodName ?: $method->name;
|
||||
|
||||
$namespace = $method->getDeclaringClass()->getNamespaceName();
|
||||
|
||||
//Create a DocBlock and serializer instance
|
||||
$phpdoc = new DocBlock($method, new Context($namespace));
|
||||
$serializer = new DocBlockSerializer(1, "\t");
|
||||
$serializer = new DocBlockSerializer(1, "\t\t");
|
||||
|
||||
//Normalize the description and inherit the docs from parents/interfaces
|
||||
try{
|
||||
$this->normalizeDescription($phpdoc, $method);
|
||||
}catch(\Exception $e){
|
||||
$this->info("Cannot normalize method $alias::$methodName..");
|
||||
}
|
||||
|
||||
//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\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();
|
||||
$declaringClassName = '\\'.ltrim($declaringClass->name, '\\');
|
||||
$root = '\\'.ltrim($class->getName(), '\\');
|
||||
|
||||
if($declaringClass->name != $root){
|
||||
$output .= "\t\t\t//Method inherited from $declaringClassName\n";
|
||||
}
|
||||
|
||||
$output .= "\t\t\t$return $root::";
|
||||
|
||||
//Write the default parameters in the function call
|
||||
$output .= $method->name."(".implode($params, ", ").");\n";
|
||||
$output .= "\t\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 +435,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,45 +444,35 @@ 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
|
||||
* @return string|null
|
||||
*/
|
||||
protected function getReturn($phpdoc){
|
||||
//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[]";
|
||||
}
|
||||
$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) {
|
||||
@@ -348,21 +495,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);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -372,6 +505,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{
|
||||
|
||||
@@ -19,7 +19,7 @@ class IdeHelperServiceProvider extends ServiceProvider {
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
protected $defer = false;
|
||||
protected $defer = true;
|
||||
|
||||
/**
|
||||
* Bootstrap the application events.
|
||||
|
||||
@@ -3,13 +3,15 @@
|
||||
* Laravel IDE Helper Generator
|
||||
*
|
||||
* @author Barry vd. Heuvel <[email protected]>
|
||||
* @copyright 2013 Barry vd. Heuvel / Fruitcake Studio (http://www.fruitcakestudio.nl)
|
||||
* @copyright 2014 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\Support\Str;
|
||||
use Symfony\Component\Console\Input\InputOption;
|
||||
use Symfony\Component\Console\Input\InputArgument;
|
||||
use Symfony\Component\ClassLoader\ClassMapGenerator;
|
||||
@@ -17,6 +19,7 @@ use phpDocumentor\Reflection\DocBlock;
|
||||
use phpDocumentor\Reflection\DocBlock\Context;
|
||||
use phpDocumentor\Reflection\DocBlock\Tag;
|
||||
use phpDocumentor\Reflection\DocBlock\Serializer as DocBlockSerializer;
|
||||
|
||||
/**
|
||||
* A command to generate autocomplete information for your IDE
|
||||
*
|
||||
@@ -30,6 +33,7 @@ class ModelsCommand extends Command {
|
||||
* @var string
|
||||
*/
|
||||
protected $name = 'ide-helper:models';
|
||||
protected $filename = '_ide_helper_models.php';
|
||||
|
||||
/**
|
||||
* The console command description.
|
||||
@@ -41,7 +45,8 @@ class ModelsCommand extends Command {
|
||||
protected $properties = array();
|
||||
protected $methods = array();
|
||||
protected $write = false;
|
||||
protected $dir;
|
||||
protected $dirs = array();
|
||||
protected $reset;
|
||||
|
||||
|
||||
|
||||
@@ -54,10 +59,19 @@ class ModelsCommand extends Command {
|
||||
{
|
||||
$filename = $this->option('filename');
|
||||
$this->write = $this->option('write');
|
||||
$this->dir = $this->option('dir');
|
||||
$this->dirs = array_merge($this->laravel['config']->get('laravel-ide-helper::model_locations'), $this->option('dir'));
|
||||
$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? Choose no to write to $filename instead? (Yes/No): ")){
|
||||
$this->write = true;
|
||||
}
|
||||
}
|
||||
|
||||
$content = $this->generateDocs($model, $ignore);
|
||||
|
||||
if(!$this->write){
|
||||
$written = \File::put($filename, $content);
|
||||
@@ -67,7 +81,6 @@ class ModelsCommand extends Command {
|
||||
$this->error("Failed to write model information to $filename");
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
|
||||
@@ -79,8 +92,7 @@ class ModelsCommand extends Command {
|
||||
protected function getArguments()
|
||||
{
|
||||
return array(
|
||||
array('model', InputArgument::OPTIONAL, 'Which models to include', '*'),
|
||||
|
||||
array('model', InputArgument::OPTIONAL | InputArgument::IS_ARRAY, 'Which models to include', array()),
|
||||
);
|
||||
}
|
||||
|
||||
@@ -92,13 +104,16 @@ class ModelsCommand extends Command {
|
||||
protected function getOptions()
|
||||
{
|
||||
return array(
|
||||
array('filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the helper file', '_ide_helper_models.php'),
|
||||
array('dir', 'D', InputOption::VALUE_OPTIONAL, 'The model dir', app_path().'/models'),
|
||||
array('filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the helper file', $this->filename),
|
||||
array('dir', 'D', InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY, 'The model dir', array()),
|
||||
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($loadModels, $ignore = ''){
|
||||
|
||||
|
||||
$output = "<?php
|
||||
@@ -111,19 +126,43 @@ class ModelsCommand extends Command {
|
||||
*/
|
||||
\n\n";
|
||||
|
||||
if($model === '*'){
|
||||
$hasDoctrine = interface_exists('Doctrine\DBAL\Driver');
|
||||
|
||||
if(empty($loadModels)){
|
||||
$models = $this->loadModels();
|
||||
}else{
|
||||
$models = explode(',', $model);
|
||||
$models = array();
|
||||
foreach($loadModels as $model){
|
||||
$models = array_merge($models, explode(',', $model));
|
||||
}
|
||||
}
|
||||
|
||||
$ignore = explode(',', $ignore);
|
||||
|
||||
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->methods = array();
|
||||
if(class_exists($name)){
|
||||
try{
|
||||
try {
|
||||
// handle abstract classes, interfaces, ...
|
||||
$reflectionClass = new \ReflectionClass($name);
|
||||
if (!$reflectionClass->IsInstantiable()) {
|
||||
throw new \Exception($name . ' is not instanciable.');
|
||||
}elseif(!$reflectionClass->isSubclassOf('Illuminate\Database\Eloquent\Model')){
|
||||
$this->comment("Class '$name' is not a model");
|
||||
continue;
|
||||
}
|
||||
|
||||
$model = new $name();
|
||||
$this->getPropertiesFromTable($model);
|
||||
if($hasDoctrine){
|
||||
$this->getPropertiesFromTable($model);
|
||||
}
|
||||
$this->getPropertiesFromMethods($model);
|
||||
$output .= $this->createPhpDocs($name);
|
||||
}catch(\Exception $e){
|
||||
@@ -134,6 +173,10 @@ class ModelsCommand extends Command {
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
if(!$hasDoctrine){
|
||||
$this->error("Warning: 'doctrine/dbal: ~2.3' is required to load database information. Please require that in your composer.json and run 'composer update'.");
|
||||
}
|
||||
|
||||
return $output;
|
||||
|
||||
@@ -141,13 +184,14 @@ class ModelsCommand extends Command {
|
||||
|
||||
|
||||
protected function loadModels(){
|
||||
$dir = $this->dir;
|
||||
if(!file_exists($dir)){
|
||||
$dir = base_path().'/'.$dir;
|
||||
}
|
||||
$models = array();
|
||||
foreach(ClassMapGenerator::createMap($dir) as $model=> $path){
|
||||
$models[] = $model;
|
||||
foreach($this->dirs as $dir){
|
||||
$dir = base_path() . '/' . $dir;
|
||||
if(file_exists($dir)){
|
||||
foreach(ClassMapGenerator::createMap($dir) as $model=> $path){
|
||||
$models[] = $model;
|
||||
}
|
||||
}
|
||||
}
|
||||
return $models;
|
||||
}
|
||||
@@ -158,7 +202,7 @@ class ModelsCommand extends Command {
|
||||
* @param \Illuminate\Database\Eloquent\Model $model
|
||||
*/
|
||||
protected function getPropertiesFromTable($model){
|
||||
$table = $model->getTable();
|
||||
$table = $model->getConnection()->getTablePrefix() . $model->getTable();
|
||||
$schema = $model->getConnection()->getDoctrineSchemaManager($table);
|
||||
$schema->getDatabasePlatform()->registerDoctrineTypeMapping('enum', 'string');
|
||||
|
||||
@@ -167,37 +211,41 @@ class ModelsCommand extends Command {
|
||||
if($columns){
|
||||
foreach ($columns as $column) {
|
||||
$name = $column->getName();
|
||||
$type = $column->getType()->getName();
|
||||
|
||||
switch($type){
|
||||
case 'string':
|
||||
case 'text':
|
||||
case 'date':
|
||||
case 'time':
|
||||
case 'guid':
|
||||
$type = 'string';
|
||||
break;
|
||||
case 'integer':
|
||||
case 'bigint':
|
||||
case 'smallint':
|
||||
$type = 'integer';
|
||||
break;
|
||||
case 'decimal':
|
||||
if(in_array($name, $model->getDates())){
|
||||
$type = '\Carbon\Carbon';
|
||||
}else{
|
||||
$type = $column->getType()->getName();
|
||||
switch($type){
|
||||
case 'string':
|
||||
case 'text':
|
||||
case 'date':
|
||||
case 'time':
|
||||
case 'guid':
|
||||
case 'datetimetz':
|
||||
case 'datetime':
|
||||
$type = 'string';
|
||||
break;
|
||||
case 'integer':
|
||||
case 'bigint':
|
||||
case 'smallint':
|
||||
$type = 'integer';
|
||||
break;
|
||||
case 'decimal':
|
||||
case 'float':
|
||||
$type = 'float';
|
||||
break;
|
||||
case 'boolean':
|
||||
$type = 'boolean';
|
||||
break;
|
||||
case 'datetimetz': //String or DateTime, depending on $dates
|
||||
case 'datetime':
|
||||
$type = '\Carbon\Carbon';
|
||||
break;
|
||||
default:
|
||||
$type = 'mixed';
|
||||
break;
|
||||
$type = 'float';
|
||||
break;
|
||||
case 'boolean':
|
||||
$type = 'boolean';
|
||||
break;
|
||||
default:
|
||||
$type = 'mixed';
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
$this->setProperty($name, $type, true, true);
|
||||
$this->setMethod(Str::camel("where_".$name), '\Illuminate\Database\Query\Builder|\\'.get_class($model), array('$value'));
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -208,62 +256,64 @@ class ModelsCommand extends Command {
|
||||
protected function getPropertiesFromMethods($model){
|
||||
$methods = get_class_methods($model);
|
||||
if($methods){
|
||||
foreach($methods as $method){
|
||||
if(\Str::startsWith($method, 'get') && \Str::endsWith($method, 'Attribute') && $method !== 'setAttribute'){
|
||||
//Magic get<name>Attribute
|
||||
$name = \Str::snake(substr($method, 3, -9));
|
||||
if(!empty($name)){
|
||||
foreach($methods as $method){
|
||||
if(Str::startsWith($method, 'get') && Str::endsWith($method, 'Attribute') && $method !== 'getAttribute'){
|
||||
//Magic get<name>Attribute
|
||||
$name = Str::snake(substr($method, 3, -9));
|
||||
if(!empty($name)){
|
||||
$this->setProperty($name, null, true, null);
|
||||
}
|
||||
}elseif(\Str::startsWith($method, 'set') && \Str::endsWith($method, 'Attribute') && $method !== 'setAttribute'){
|
||||
//Magic set<name>Attribute
|
||||
$name = \Str::snake(substr($method, 3, -9));
|
||||
if(!empty($name)){
|
||||
}
|
||||
}elseif(Str::startsWith($method, 'set') && Str::endsWith($method, 'Attribute') && $method !== 'setAttribute'){
|
||||
//Magic set<name>Attribute
|
||||
$name = Str::snake(substr($method, 3, -9));
|
||||
if(!empty($name)){
|
||||
$this->setProperty($name, null, null, true);
|
||||
}
|
||||
}elseif(\Str::startsWith($method, 'scope') && $method !== 'scopeQuery'){
|
||||
//Magic set<name>Attribute
|
||||
$name = \Str::snake(substr($method, 5));
|
||||
if(!empty($name)){
|
||||
$this->setMethod($name, 'static');
|
||||
}
|
||||
}elseif(!method_exists('Eloquent', $method) && !\Str::startsWith($method, 'get')){
|
||||
}
|
||||
}elseif(Str::startsWith($method, 'scope') && $method !== 'scopeQuery'){
|
||||
//Magic set<name>Attribute
|
||||
$name = Str::camel(substr($method, 5));
|
||||
if(!empty($name)){
|
||||
$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')){
|
||||
|
||||
//Use reflection to inspect the code, based on Illuminate/Support/SerializableClosure.php
|
||||
$reflection = new \ReflectionMethod($model, $method);
|
||||
//Use reflection to inspect the code, based on Illuminate/Support/SerializableClosure.php
|
||||
$reflection = new \ReflectionMethod($model, $method);
|
||||
|
||||
$file = new \SplFileObject($reflection->getFileName());
|
||||
$file->seek($reflection->getStartLine() - 1);
|
||||
$file = new \SplFileObject($reflection->getFileName());
|
||||
$file->seek($reflection->getStartLine() - 1);
|
||||
|
||||
$code = '';
|
||||
while ($file->key() < $reflection->getEndLine())
|
||||
{
|
||||
$code .= $file->current(); $file->next();
|
||||
}
|
||||
$begin = strpos($code, 'function(');
|
||||
$code = substr($code, $begin, strrpos($code, '}') - $begin + 1);
|
||||
$code = '';
|
||||
while ($file->key() < $reflection->getEndLine())
|
||||
{
|
||||
$code .= $file->current(); $file->next();
|
||||
}
|
||||
$begin = strpos($code, 'function(');
|
||||
$code = substr($code, $begin, strrpos($code, '}') - $begin + 1);
|
||||
|
||||
$begin = stripos($code, 'return $this->');
|
||||
$parts = explode("'", substr($code, $begin+14),3); //"return $this->" is 14 chars
|
||||
if (isset($parts[2]))
|
||||
{
|
||||
list($relation, $returnModel, $rest) = $parts;
|
||||
$returnModel = "\\".ltrim($returnModel, "\\");
|
||||
$relation = trim($relation, ' (');
|
||||
|
||||
if($relation === "belongsTo" or $relation === 'hasOne'){
|
||||
//Single model is returned
|
||||
$this->setProperty($method, $returnModel, true, null);
|
||||
}elseif($relation === "belongsToMany" or $relation === 'hasMany'){
|
||||
//Collection or array of models (because Collection is Arrayable)
|
||||
$this->setProperty($method, '\Illuminate\Database\Eloquent\Collection|'.$returnModel.'[]', true, null);
|
||||
}
|
||||
}else{
|
||||
//Not a relation
|
||||
}
|
||||
foreach(array('hasMany', 'belongsToMany', 'hasOne', 'belongsTo', 'morphTo', 'morphMany', 'morphToMany') as $relation){
|
||||
$search = '$this->'.$relation.'(';
|
||||
if($pos = stripos($code, $search)){
|
||||
$code = substr($code, $pos + strlen($search));
|
||||
$arguments = explode(',', substr($code, 0, stripos($code, ')')));
|
||||
//Remove quotes, ensure 1 \ in front of the model
|
||||
$returnModel = "\\".ltrim(trim($arguments[0], " \"'"), "\\");
|
||||
if($relation === "belongsToMany" or $relation === 'hasMany' or $relation === 'morphMany' or $relation === 'morphToMany'){
|
||||
//Collection or array of models (because Collection is Arrayable)
|
||||
$this->setProperty($method, '\Illuminate\Database\Eloquent\Collection|'.$returnModel.'[]', true, null);
|
||||
}else{
|
||||
//Single model is returned
|
||||
$this->setProperty($method, $returnModel, true, null);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -291,13 +341,11 @@ class ModelsCommand extends Command {
|
||||
}
|
||||
}
|
||||
|
||||
protected function setMethod($name, $type = null){
|
||||
protected function setMethod($name, $type = '', $arguments=array()){
|
||||
if(!isset($this->methods[$name])){
|
||||
$this->methods[$name] = array();
|
||||
$this->methods[$name]['type'] = 'static';
|
||||
}
|
||||
if($type !== null){
|
||||
$this->methods[$name]['type'] = $type;
|
||||
$this->methods[$name]['arguments'] = $arguments;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -311,10 +359,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($class);
|
||||
}
|
||||
|
||||
$properties = array();
|
||||
@@ -348,8 +401,8 @@ class ModelsCommand extends Command {
|
||||
if(in_array($name, $methods)){
|
||||
continue;
|
||||
}
|
||||
$name = "$name()";
|
||||
$tag = Tag::createInstance("@method {$method['type']} {$name}", $phpdoc);
|
||||
$arguments = implode(', ',$method['arguments']);
|
||||
$tag = Tag::createInstance("@method static {$method['type']} {$name}({$arguments}) ", $phpdoc);
|
||||
$phpdoc->appendTag($tag);
|
||||
}
|
||||
|
||||
@@ -380,4 +433,37 @@ class ModelsCommand extends Command {
|
||||
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;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
+29
-43
@@ -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
|
||||
@@ -41,6 +29,20 @@ return array(
|
||||
base_path().'/vendor/laravel/framework/src/Illuminate/Support/helpers.php',
|
||||
),
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Model locations to include
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| Define in which directories the ide-helper:models command should look
|
||||
| for models.
|
||||
|
|
||||
*/
|
||||
|
||||
'model_locations' => array(
|
||||
'app/models',
|
||||
),
|
||||
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
@@ -52,38 +54,22 @@ 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'),
|
||||
'Artisan' => array('Illuminate\Foundation\Artisan'),
|
||||
'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
|
||||
'Session' => array('Illuminate\Session\Store'),
|
||||
),
|
||||
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| 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'),
|
||||
),
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Only extend
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| These implementations aren't called static, so only extend them.
|
||||
|
|
||||
*/
|
||||
|
||||
'only_extend' => array(
|
||||
'Seeder',
|
||||
),
|
||||
'magic' => array(
|
||||
'Log' => array(
|
||||
'debug' => 'Monolog\Logger::addDebug',
|
||||
'info' => 'Monolog\Logger::addInfo',
|
||||
'notice' => 'Monolog\Logger::addNotice',
|
||||
'warning' => 'Monolog\Logger::addWarning',
|
||||
'error' => 'Monolog\Logger::addError',
|
||||
'critical' => 'Monolog\Logger::addCritical',
|
||||
'alert' => 'Monolog\Logger::addAlert',
|
||||
'emergency' => 'Monolog\Logger::addEmergency',
|
||||
)
|
||||
)
|
||||
|
||||
);
|
||||
|
||||
Reference in New Issue
Block a user