Compare commits

..
1 Commits
Author SHA1 Message Date
Barry vd. Heuvel eda37f3442 Catch PDO errors when getting drivers/connections 2013-07-12 14:39:12 +02:00
6 changed files with 156 additions and 333 deletions
+2 -3
View File
@@ -14,9 +14,8 @@
"illuminate/support": "4.x", "illuminate/support": "4.x",
"illuminate/console": "4.x", "illuminate/console": "4.x",
"illuminate/filesystem": "4.x", "illuminate/filesystem": "4.x",
"phpdocumentor/reflection-docblock": "2.0.0", "barryvdh/reflection-docblock": ">=2.0.1",
"symfony/class-loader": "~2.3", "symfony/class-loader": "~2.3"
"doctrine/dbal": "~2.3"
}, },
"autoload": { "autoload": {
"psr-0": { "psr-0": {
+6 -17
View File
@@ -30,7 +30,6 @@ You can configure your composer.json to do this after each commit:
"scripts":{ "scripts":{
"post-update-cmd":[ "post-update-cmd":[
"php artisan clear-compiled",
"php artisan ide-helper:generate", "php artisan ide-helper:generate",
"php artisan optimize", "php artisan optimize",
] ]
@@ -53,9 +52,9 @@ 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.
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 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.
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. You can now also write the comments directly to your Model file, using the `--write (-W)` option. Please make sure to backup your models, before writing the info.
It should keep the existing comments and only append new properties/methods. The existing phpdoc is replaced, or added if not found. 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. With the `--reset (-R)` option, the existing phpdocs are ignored, only the newly found columns/relations are saved as phpdocs.
@@ -74,21 +73,11 @@ With the `--reset (-R)` option, the existing phpdocs are ignored, only the newly
* @property-read \Illuminate\Database\Eloquent\Collection|\Comment[] $comments * @property-read \Illuminate\Database\Eloquent\Collection|\Comment[] $comments
*/ */
By default, models in app/models are scanned. The optional argument tells what models to use (also outside app/models). For now, only models in app/models are scanned. The optional argument tells what models to use (also outside app/models).
php artisan ide-helper:models Post User php artisan ide-helper:models Post,User
You can also scan a different directory, using the --dir option (relative from the base path): Note: With namespaces, uses `\\` instead of `\`: `php artisan ide-helper:models API\\User`
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 ### License
@@ -13,10 +13,10 @@ use Illuminate\Console\Command;
use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputArgument;
use Illuminate\Foundation\AliasLoader; use Illuminate\Foundation\AliasLoader;
use phpDocumentor\Reflection\DocBlock; use Barryvdh\Reflection\DocBlock;
use phpDocumentor\Reflection\DocBlock\Context; use Barryvdh\Reflection\DocBlock\Context;
use phpDocumentor\Reflection\DocBlock\Tag; use Barryvdh\Reflection\DocBlock\Tag;
use phpDocumentor\Reflection\DocBlock\Serializer as DocBlockSerializer; use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
/** /**
* A command to generate autocomplete information for your IDE * A command to generate autocomplete information for your IDE
* *
@@ -41,7 +41,6 @@ class GeneratorCommand extends Command {
protected $extra; protected $extra;
protected $onlyExtend; protected $onlyExtend;
protected $helpers; protected $helpers;
protected $magic;
/** /**
@@ -61,7 +60,6 @@ class GeneratorCommand extends Command {
} }
$this->extra = \Config::get('laravel-ide-helper::extra'); $this->extra = \Config::get('laravel-ide-helper::extra');
$this->magic = \Config::get('laravel-ide-helper::magic');
if( $this->option('helpers') || (\Config::get('laravel-ide-helper::include_helpers') )){ 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');
@@ -125,68 +123,53 @@ class GeneratorCommand extends Command {
$aliasLoader = AliasLoader::getInstance(); $aliasLoader = AliasLoader::getInstance();
$outputString = "<?php $output = "<?php
/** /**
* An helper file for Laravel 4, to provide autocomplete information to your IDE * An helper file for Laravel 4, to provide autocomplete information to your IDE
* Generated with https://github.com/barryvdh/laravel-ide-helper * Generated with https://github.com/barryvdh/laravel-ide-helper
* *
* @author Barry vd. Heuvel <[email protected]> * @author Barry vd. Heuvel <[email protected]>
*/\n\n"; */
$output['__root'] = "\texit('Only to be used as an helper for your IDE');\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){
$facade = '\\'.ltrim($facade, '\\');
$root = $this->getRoot($facade); $root = $this->getRoot($facade);
if(!$root){ if(!$root){
continue; continue;
} }
try{ try{
if (strpos($alias, '\\')){
$nsParts = explode('\\', $alias);
$alias = array_pop($nsParts);
$ns = implode('\\', $nsParts);
} else {
$ns = '__root';
}
if (!isset($output[$ns])) $output[$ns] = '';
//Some classes extend the facade //Some classes extend the facade
if(interface_exists($facade)){ if(class_exists($facade)){
$output[$ns] .= "\tinterface $alias extends $facade{\n"; $output .= "class $alias extends $facade{\n";
}elseif(class_exists($facade)){
$output[$ns] .= "\tclass $alias extends $facade{\n";
}else{ }else{
$output[$ns] .= "\tclass $alias{\n"; $output .= "class $alias{\n";
} }
$usedMethods = array(); $usedMethods = array();
//Only add the methods to the output when the root is not the same as the facade. //Only add the methods to the output when the root is not the same as the facade.
$addOutput = ($root !== $facade); $addOutput = ($root !== $facade);
$output[$ns] .= $this->getMethods($root, $alias, $usedMethods, $addOutput); $output .= $this->getMethods($root, $alias, $usedMethods, $addOutput);
$driver = $this->getDriver($alias); $driver = $this->getDriver($alias);
if($driver){ if($driver){
$output[$ns] .= $this->getMethods($driver, $alias, $usedMethods); $output .= $this->getMethods($driver, $alias, $usedMethods);
} }
//Add extra methods, from other classes (magic static calls) //Add extra methods, from other classes (magic static calls)
if(array_key_exists($alias, $this->extra)){ if(array_key_exists($alias, $this->extra)){
$output[$ns] .= $this->getMethods($this->extra[$alias], $alias, $usedMethods); $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[$ns] .= $this->addMagicMethods($this->magic[$alias], $alias, $usedMethods);
} }
$output[$ns] .= "\t}\n"; $output .= "}\n\n";
}catch(\Exception $e){ }catch(\Exception $e){
$this->error("Exception: ".$e->getMessage()."\nCould not analyze $root."); $this->error("Exception: ".$e->getMessage()."\nCould not analyze $root.");
@@ -194,23 +177,16 @@ class GeneratorCommand extends Command {
} }
foreach ($output as $ns => $body){
if ($ns == '__root') $ns = '';
$outputString .= "namespace $ns{\n";
$outputString .= $body;
$outputString .= "}\n\n";
}
//Include the helper file, if requested //Include the helper file, if requested
if(!empty($this->helpers)){ if(!empty($helpers)){
foreach($this->helpers as $helper){ foreach($helpers as $helper){
if (file_exists($helper)){ if (file_exists($helper)){
$output .= str_replace(array('<?php', '?>'), '', \File::get($helper)); $output .= str_replace(array('<?php', '?>'), '', \File::get($helper));
} }
} }
} }
return $outputString; return $output;
} }
/** /**
@@ -247,12 +223,6 @@ class GeneratorCommand extends Command {
} }
/**
* Get the driver/connection/store from the managers
*
* @param $alias
* @return array|bool|string
*/
public function getDriver($alias){ public function getDriver($alias){
try{ try{
if($alias == "Auth"){ if($alias == "Auth"){
@@ -260,9 +230,7 @@ class GeneratorCommand extends Command {
}elseif($alias == "DB"){ }elseif($alias == "DB"){
$driver = \DB::connection(); $driver = \DB::connection();
}elseif($alias == "Cache"){ }elseif($alias == "Cache"){
$driver = get_class(\Cache::driver()); $driver = \Cache::driver();
$store = get_class(\Cache::getStore());
return array($driver, $store);
}elseif($alias == "Queue"){ }elseif($alias == "Queue"){
$driver = \Queue::connection(); $driver = \Queue::connection();
}else{ }else{
@@ -313,70 +281,30 @@ class GeneratorCommand extends Command {
return $output; 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 \ReflectionMethod $method
* @param string $alias * @param string $alias
* @param $class
* @param null $methodName
* @return string * @return string
*/ */
protected function parseMethod($method, $alias, $class, $methodName = null){ protected function parseMethod($method, $alias, $class){
$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();
//Create a DocBlock and serializer instance //Create a DocBlock and serializer instance
$phpdoc = new DocBlock($method, new Context($namespace)); $phpdoc = new DocBlock($method, new Context($namespace));
$serializer = new DocBlockSerializer(1, "\t\t"); $serializer = new DocBlockSerializer(1, "\t");
//Normalize the description and inherit the docs from parents/interfaces //Normalize the description and inherit the docs from parents/interfaces
try{ $this->normalizeDescription($phpdoc, $method);
$this->normalizeDescription($phpdoc, $method);
}catch(\Exception $e){
$this->info("Cannot normalize method $alias::$methodName..");
}
//Correct the return values //Correct the return values
$returnValue = $this->getReturn($phpdoc); $returnValue = $this->normalizeReturn($phpdoc, $method, $alias);
//Get the parameters, including formatted default values //Get the parameters, including formatted default values
list($params, $paramsWithDefault) = $this->getParameters($method); list($params, $paramsWithDefault) = $this->getParameters($method);
@@ -385,28 +313,27 @@ class GeneratorCommand extends Command {
$phpdoc->appendTag(Tag::createInstance('@static', $phpdoc)); $phpdoc->appendTag(Tag::createInstance('@static', $phpdoc));
//Write the output, using the DocBlock serializer //Write the output, using the DocBlock serializer
$output .= $serializer->getDocComment($phpdoc) ."\n\t\t public static function ".$methodName."("; $output .= $serializer->getDocComment($phpdoc) ."\n\t public static function ".$method->name."(";
$output .= implode($paramsWithDefault, ", "); $output .= implode($paramsWithDefault, ", ");
$output .= "){\n"; $output .= "){\r\n";
//Only return when not a constructor and not void. //Only return when not a constructor and not void.
$return = ($returnValue && $returnValue !== "void" && $method->name !== "__construct") ? 'return' : ''; $return = ($returnValue && $returnValue !== "void" && $method->name !== "__construct") ? 'return' : '';
//Reference the 'real' function in the declaringclass //Reference the 'real' function in the declaringclass
$declaringClass = $method->getDeclaringClass(); $declaringClass = $method->getDeclaringClass();
$declaringClassName = '\\'.ltrim($declaringClass->name, '\\'); $root = $class->getName();
$root = '\\'.ltrim($class->getName(), '\\');
if($declaringClass->name != $root){ if($declaringClass->name != $root){
$output .= "\t\t\t//Method inherited from $declaringClassName\n"; $output .= "\t\t//Method inherited from $declaringClass->name\r\n";
} }
$output .= "\t\t\t$return $root::"; $output .= "\t\t$return $root::";
//Write the default parameters in the function call //Write the default parameters in the function call
$output .= $method->name."(".implode($params, ", ").");\n"; $output .= $method->name."(".implode($params, ", ").");\r\n";
$output .= "\t\t }\n\n"; $output .= "\t }\n\n";
return $output; return $output;
} }
@@ -444,15 +371,23 @@ class GeneratorCommand extends Command {
* Make some changes to the return types, if needed. * Make some changes to the return types, if needed.
* *
* @param $phpdoc * @param $phpdoc
* @return string|null * @param $method
* @param $alias
* @return null
*/ */
protected function getReturn($phpdoc){ protected function normalizeReturn(&$phpdoc, $method, $alias){
//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"){
$tag->setType('self');
}elseif($alias == 'Eloquent' and in_array($method->name, array('hasOne', 'hasMany', 'belongsTo', 'belongsToMany', 'morphOne', 'morphTo', 'morphMany'))){
$tag->addType('\Eloquent');
}
}else{ }else{
$returnValue = null; $returnValue = null;
} }
@@ -19,7 +19,7 @@ class IdeHelperServiceProvider extends ServiceProvider {
* *
* @var bool * @var bool
*/ */
protected $defer = true; protected $defer = false;
/** /**
* Bootstrap the application events. * Bootstrap the application events.
+106 -177
View File
@@ -3,23 +3,20 @@
* Laravel IDE Helper Generator * Laravel IDE Helper Generator
* *
* @author Barry vd. Heuvel <[email protected]> * @author Barry vd. Heuvel <[email protected]>
* @copyright 2014 Barry vd. Heuvel / Fruitcake Studio (http://www.fruitcakestudio.nl) * @copyright 2013 Barry vd. Heuvel / Fruitcake Studio (http://www.fruitcakestudio.nl)
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link https://github.com/barryvdh/laravel-ide-helper * @link https://github.com/barryvdh/laravel-ide-helper
*/ */
namespace Barryvdh\LaravelIdeHelper; namespace Barryvdh\LaravelIdeHelper;
use Illuminate\Console\Command; use Illuminate\Console\Command;
use Illuminate\Support\Str;
use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\ClassLoader\ClassMapGenerator; use Symfony\Component\ClassLoader\ClassMapGenerator;
use phpDocumentor\Reflection\DocBlock; use Barryvdh\Reflection\DocBlock;
use phpDocumentor\Reflection\DocBlock\Context; use Barryvdh\Reflection\DocBlock\Context;
use phpDocumentor\Reflection\DocBlock\Tag; use Barryvdh\Reflection\DocBlock\Tag;
use phpDocumentor\Reflection\DocBlock\Serializer as DocBlockSerializer; use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
/** /**
* A command to generate autocomplete information for your IDE * A command to generate autocomplete information for your IDE
* *
@@ -33,7 +30,6 @@ 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.
@@ -45,7 +41,7 @@ class ModelsCommand extends Command {
protected $properties = array(); protected $properties = array();
protected $methods = array(); protected $methods = array();
protected $write = false; protected $write = false;
protected $dirs = array(); protected $dir;
protected $reset; protected $reset;
@@ -59,19 +55,11 @@ class ModelsCommand extends Command {
{ {
$filename = $this->option('filename'); $filename = $this->option('filename');
$this->write = $this->option('write'); $this->write = $this->option('write');
$this->dirs = array_merge($this->laravel['config']->get('laravel-ide-helper::model_locations'), $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'); $this->reset = $this->option('reset');
//If filename is default and Write is not specified, ask what to do $content = $this->generateDocs($model);
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){ if(!$this->write){
$written = \File::put($filename, $content); $written = \File::put($filename, $content);
@@ -81,6 +69,7 @@ class ModelsCommand extends Command {
$this->error("Failed to write model information to $filename"); $this->error("Failed to write model information to $filename");
} }
} }
} }
@@ -92,7 +81,8 @@ class ModelsCommand extends Command {
protected function getArguments() protected function getArguments()
{ {
return array( return array(
array('model', InputArgument::OPTIONAL | InputArgument::IS_ARRAY, 'Which models to include', array()), array('model', InputArgument::OPTIONAL, 'Which models to include', '*'),
); );
} }
@@ -104,16 +94,14 @@ 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', $this->filename), array('filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the helper file', '_ide_helper_models.php'),
array('dir', 'D', InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY, 'The model dir', array()), 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('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($loadModels, $ignore = ''){ protected function generateDocs($model){
$output = "<?php $output = "<?php
@@ -126,37 +114,17 @@ class ModelsCommand extends Command {
*/ */
\n\n"; \n\n";
if(empty($loadModels)){ if($model === '*'){
$models = $this->loadModels(); $models = $this->loadModels();
}else{ }else{
$models = array(); $models = explode(',', $model);
foreach($loadModels as $model){
$models = array_merge($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)){
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(); $model = new $name();
$this->getPropertiesFromTable($model); $this->getPropertiesFromTable($model);
$this->getPropertiesFromMethods($model); $this->getPropertiesFromMethods($model);
@@ -176,13 +144,11 @@ class ModelsCommand extends Command {
protected function loadModels(){ protected function loadModels(){
$dir = base_path().'/'.$this->dir;
$models = array(); $models = array();
foreach($this->dirs as $dir){ if(file_exists($dir)){
$dir = base_path() . '/' . $dir; foreach(ClassMapGenerator::createMap($dir) as $model=> $path){
if(file_exists($dir)){ $models[] = $model;
foreach(ClassMapGenerator::createMap($dir) as $model=> $path){
$models[] = $model;
}
} }
} }
return $models; return $models;
@@ -194,7 +160,7 @@ class ModelsCommand extends Command {
* @param \Illuminate\Database\Eloquent\Model $model * @param \Illuminate\Database\Eloquent\Model $model
*/ */
protected function getPropertiesFromTable($model){ protected function getPropertiesFromTable($model){
$table = $model->getConnection()->getTablePrefix() . $model->getTable(); $table = $model->getTable();
$schema = $model->getConnection()->getDoctrineSchemaManager($table); $schema = $model->getConnection()->getDoctrineSchemaManager($table);
$schema->getDatabasePlatform()->registerDoctrineTypeMapping('enum', 'string'); $schema->getDatabasePlatform()->registerDoctrineTypeMapping('enum', 'string');
@@ -203,41 +169,37 @@ class ModelsCommand extends Command {
if($columns){ if($columns){
foreach ($columns as $column) { foreach ($columns as $column) {
$name = $column->getName(); $name = $column->getName();
if(in_array($name, $model->getDates())){ $type = $column->getType()->getName();
$type = '\Carbon\Carbon';
}else{ switch($type){
$type = $column->getType()->getName(); case 'string':
switch($type){ case 'text':
case 'string': case 'date':
case 'text': case 'time':
case 'date': case 'guid':
case 'time': $type = 'string';
case 'guid': break;
case 'datetimetz': case 'integer':
case 'datetime': case 'bigint':
$type = 'string'; case 'smallint':
break; $type = 'integer';
case 'integer': break;
case 'bigint': case 'decimal':
case 'smallint':
$type = 'integer';
break;
case 'decimal':
case 'float': case 'float':
$type = 'float'; $type = 'float';
break; break;
case 'boolean': case 'boolean':
$type = 'boolean'; $type = 'boolean';
break; break;
default: case 'datetimetz': //String or DateTime, depending on $dates
$type = 'mixed'; case 'datetime':
break; $type = '\Carbon\Carbon';
} break;
default:
$type = 'mixed';
break;
} }
$this->setProperty($name, $type, true, true); $this->setProperty($name, $type, true, true);
$this->setMethod(Str::camel("where_".$name), '\Illuminate\Database\Query\Builder|\\'.get_class($model), array('$value'));
} }
} }
} }
@@ -248,64 +210,62 @@ class ModelsCommand extends Command {
protected function getPropertiesFromMethods($model){ protected function getPropertiesFromMethods($model){
$methods = get_class_methods($model); $methods = get_class_methods($model);
if($methods){ if($methods){
foreach($methods as $method){ foreach($methods as $method){
if(Str::startsWith($method, 'get') && Str::endsWith($method, 'Attribute') && $method !== 'getAttribute'){ if(\Str::startsWith($method, 'get') && \Str::endsWith($method, 'Attribute') && $method !== 'setAttribute'){
//Magic get<name>Attribute //Magic get<name>Attribute
$name = Str::snake(substr($method, 3, -9)); $name = \Str::snake(substr($method, 3, -9));
if(!empty($name)){ if(!empty($name)){
$this->setProperty($name, null, true, null); $this->setProperty($name, null, true, null);
} }
}elseif(Str::startsWith($method, 'set') && Str::endsWith($method, 'Attribute') && $method !== 'setAttribute'){ }elseif(\Str::startsWith($method, 'set') && \Str::endsWith($method, 'Attribute') && $method !== 'setAttribute'){
//Magic set<name>Attribute //Magic set<name>Attribute
$name = Str::snake(substr($method, 3, -9)); $name = \Str::snake(substr($method, 3, -9));
if(!empty($name)){ if(!empty($name)){
$this->setProperty($name, null, null, true); $this->setProperty($name, null, null, true);
} }
}elseif(Str::startsWith($method, 'scope') && $method !== 'scopeQuery'){ }elseif(\Str::startsWith($method, 'scope') && $method !== 'scopeQuery'){
//Magic set<name>Attribute //Magic set<name>Attribute
$name = Str::camel(substr($method, 5)); $name = \Str::snake(substr($method, 5));
if(!empty($name)){ if(!empty($name)){
$reflection = new \ReflectionMethod($model, $method); $this->setMethod($name, 'static');
$args = $this->getParameters($reflection); }
//Remove the first ($query) argument }elseif(!method_exists('Eloquent', $method) && !\Str::startsWith($method, 'get')){
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 //Use reflection to inspect the code, based on Illuminate/Support/SerializableClosure.php
$reflection = new \ReflectionMethod($model, $method); $reflection = new \ReflectionMethod($model, $method);
$file = new \SplFileObject($reflection->getFileName()); $file = new \SplFileObject($reflection->getFileName());
$file->seek($reflection->getStartLine() - 1); $file->seek($reflection->getStartLine() - 1);
$code = ''; $code = '';
while ($file->key() < $reflection->getEndLine()) while ($file->key() < $reflection->getEndLine())
{ {
$code .= $file->current(); $file->next(); $code .= $file->current(); $file->next();
} }
$begin = strpos($code, 'function('); $begin = strpos($code, 'function(');
$code = substr($code, $begin, strrpos($code, '}') - $begin + 1); $code = substr($code, $begin, strrpos($code, '}') - $begin + 1);
foreach(array('hasMany', 'belongsToMany', 'hasOne', 'belongsTo') as $relation){ $begin = stripos($code, 'return $this->');
$search = '$this->'.$relation.'('; $parts = explode("'", substr($code, $begin+14),3); //"return $this->" is 14 chars
if($pos = stripos($code, $search)){ if (isset($parts[2]))
$code = substr($code, $pos + strlen($search)); {
$arguments = explode(',', substr($code, 0, stripos($code, ')'))); list($relation, $returnModel, $rest) = $parts;
//Remove quotes, ensure 1 \ in front of the model $returnModel = "\\".ltrim($returnModel, "\\");
$returnModel = "\\".ltrim(trim($arguments[0], " \"'"), "\\"); $relation = trim($relation, ' (');
if($relation === "belongsToMany" or $relation === 'hasMany'){
//Collection or array of models (because Collection is Arrayable) if($relation === "belongsTo" or $relation === 'hasOne'){
$this->setProperty($method, '\Illuminate\Database\Eloquent\Collection|'.$returnModel.'[]', true, null); //Single model is returned
}else{ $this->setProperty($method, $returnModel, true, null);
//Single model is returned }elseif($relation === "belongsToMany" or $relation === 'hasMany'){
$this->setProperty($method, $returnModel, true, null); //Collection or array of models (because Collection is Arrayable)
} $this->setProperty($method, '\Illuminate\Database\Eloquent\Collection|'.$returnModel.'[]', true, null);
} }
} }else{
//Not a relation
}
} }
} }
} }
} }
@@ -333,11 +293,13 @@ class ModelsCommand extends Command {
} }
} }
protected function setMethod($name, $type = '', $arguments=array()){ protected function setMethod($name, $type = null){
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;
} }
} }
@@ -359,7 +321,7 @@ class ModelsCommand extends Command {
} }
if(!$phpdoc->getText()){ if(!$phpdoc->getText()){
$phpdoc->setText($class); $phpdoc->setText("An Eloquent Model: '$class'");
} }
$properties = array(); $properties = array();
@@ -393,8 +355,8 @@ class ModelsCommand extends Command {
if(in_array($name, $methods)){ if(in_array($name, $methods)){
continue; continue;
} }
$arguments = implode(', ',$method['arguments']); $name = "$name()";
$tag = Tag::createInstance("@method static {$method['type']} {$name}({$arguments}) ", $phpdoc); $tag = Tag::createInstance("@method {$method['type']} {$name}", $phpdoc);
$phpdoc->appendTag($tag); $phpdoc->appendTag($tag);
} }
@@ -425,37 +387,4 @@ 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;
}
} }
+1 -30
View File
@@ -29,20 +29,6 @@ return array(
base_path().'/vendor/laravel/framework/src/Illuminate/Support/helpers.php', 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',
),
/* /*
|-------------------------------------------------------------------------- |--------------------------------------------------------------------------
@@ -54,22 +40,7 @@ return array(
*/ */
'extra' => array( 'extra' => array(
'Artisan' => array('Illuminate\Foundation\Artisan'), 'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
'Session' => array('Illuminate\Session\Store'),
), ),
'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',
)
)
); );