Compare commits

..
20 Commits
Author SHA1 Message Date
Barry vd. Heuvel 83999f8467 Bump version 2015-08-13 13:40:00 +02:00
Barry vd. Heuvel fab54d90dd Merge pull request #252 from mahmutbayri/master
Trim tag text.…
2015-08-13 13:12:39 +02:00
Mahmut Bayri 5d4056fe87 Trim tag text. If tag doesn't have comment or the comment has any space at the end of line, phpcs (with --standard=PSR2) dedects an error. 2015-08-13 13:42:10 +03:00
Barry vd. Heuvel 3fbe330998 Update readme.md 2015-08-10 21:05:06 +02:00
Barry vd. Heuvel 78d233fea7 Skip validator 2015-08-10 21:01:41 +02:00
Barry vd. Heuvel 0d13a51ff5 Use preset list of aliases in Lumen 2015-08-10 21:00:31 +02:00
Barry vd. Heuvel 326e8ea25f Bring back changes
Missed them from previous commit
2015-08-10 20:38:57 +02:00
Barry vd. Heuvel e7ee934bb1 Inject filesystem 2015-08-10 20:36:00 +02:00
Barry vd. Heuvel 99953adb73 Inject filesystem instance 2015-08-10 20:35:04 +02:00
Barry vd. Heuvel 0d333c6228 Check for config_path (Lumen)
For #202
2015-08-10 20:23:56 +02:00
Barry vd. Heuvel 0a717d1e79 Merge pull request #243 from bebnev/master
fix get_class($this) in relationship functions
2015-08-09 15:04:14 +02:00
bebnev dc62d35bed fix parsing relations arguments 2015-08-09 15:28:04 +03:00
Barry vd. Heuvel 2b7733c6b9 Merge pull request #242 from bebnev/master
fix model docBlocks duplicates
2015-08-01 16:59:45 +02:00
bebnev 76674be735 fix model docBlocks duplicates
Add each parsed model to ignore list, so if it exists more than once it will not be parsed twice.
2015-08-01 17:13:43 +04:00
Barry vd. Heuvel e34b7fb84b Merge pull request #232 from konomae/patch-1
Fix vendor:publish provider name
2015-07-14 11:09:59 +02:00
konomae e77a7b5a9c Fix vendor:publish provider name 2015-07-14 17:54:07 +09:00
Barry vd. Heuvel 19f7d75c10 Update readme.md 2015-06-25 13:32:53 +02:00
Barry vd. Heuvel 0373861536 Add generic factory 2015-06-25 10:58:59 +02:00
Barry vd. Heuvel 3a4671f3ea Update meta file 2015-06-18 14:58:06 +02:00
Barry vd. Heuvel 8515b7ac0b Use verbosity to hide some errors 2015-06-18 09:11:05 +02:00
7 changed files with 117 additions and 44 deletions
+1 -1
View File
@@ -30,7 +30,7 @@
},
"extra": {
"branch-alias": {
"dev-master": "2.0-dev"
"dev-master": "2.1-dev"
}
}
}
+7 -2
View File
@@ -10,7 +10,9 @@ _Checkout [this Laracasts video](https://laracasts.com/series/how-to-be-awesome-
This package generates a file that your IDE understands, so it can provide accurate autocompletion. Generation is done based on the files in your project, so they are always 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
* Generated version for L5: https://gist.github.com/barryvdh/5227822
* Generated version for Lumen: https://gist.github.com/barryvdh/be17164b0ad51f832f20
* Generated Phpstorm Meta file: https://gist.github.com/barryvdh/bb6ffc5d11e0a75dba67
Note: You do need CodeIntel for Sublime Text: https://github.com/SublimeCodeIntel/SublimeCodeIntel
@@ -25,6 +27,9 @@ It's possible to generate a PhpStorm meta file, to [add support for factory desi
/** @var \Illuminate\Foundation\Application $app */
$app->make('events')->fire();
// When the key is not found, it uses the argument as class name
app('App\SomeClass');
Pre-generated example: https://gist.github.com/barryvdh/bb6ffc5d11e0a75dba67
@@ -59,7 +64,7 @@ You can configure your composer.json to do this after each commit:
You can also publish the config file to change implementations (ie. interface to specific class) or set defaults for `--helpers` or `--sublime`.
php artisan vendor:publish --provider=barryvdh/laravel-ide-helper --tag=config
php artisan vendor:publish --provider="Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider" --tag=config
The generator tries to identify the real class, but if it cannot be found, you can define it in the config file.
+5 -6
View File
@@ -1,4 +1,6 @@
<?= '<?php' ?> namespace PHPSTORM_META {
<?= '<?php' ?>
namespace PHPSTORM_META {
/**
* PhpStorm Meta file, to provide autocomplete information for PhpStorm
@@ -7,13 +9,10 @@
* @author Barry vd. Heuvel <[email protected]>
* @see https://github.com/barryvdh/laravel-ide-helper
*/
/** @noinspection PhpIllegalArrayKeyTypeInspection */
/** @noinspection PhpUnusedLocalVariableInspection */
/** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */
$STATIC_METHOD_TYPES = [
<?php foreach($methods as $method): ?>
<?= $method ?>('') => [
<?= $method ?> => [
'' == '@',
<?php foreach($bindings as $abstract => $class): ?>
'<?= $abstract ?>' instanceof \<?= $class ?>,
<?php endforeach ?> ],
+13 -7
View File
@@ -12,6 +12,7 @@ namespace Barryvdh\LaravelIdeHelper\Console;
use Illuminate\Console\Command;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
/**
* A command to generate phpstorm meta data
@@ -42,12 +43,10 @@ class MetaCommand extends Command {
protected $view;
protected $methods = [
'\Illuminate\Foundation\Application::make',
'\Illuminate\Contracts\Foundation\Application::make',
'\Illuminate\Contracts\Container\Container::make',
'\Illuminate\Container\Container::make',
'\App::make',
'app',
'new \Illuminate\Contracts\Container\Container',
'\Illuminate\Contracts\Container\Container::make(\'\')',
'\App::make(\'\')',
'app(\'\')',
];
/**
@@ -72,13 +71,20 @@ class MetaCommand extends Command {
$bindings = array();
foreach ($this->getAbstracts() as $abstract) {
// Validator causes problems in Lumen
if ($abstract == 'validator') {
continue;
}
try {
$concrete = $this->laravel->make($abstract);
if (is_object($concrete)) {
$bindings[$abstract] = get_class($concrete);
}
}catch (\Exception $e) {
$this->comment("Cannot make '$abstract': ".$e->getMessage());
if ($this->output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
$this->comment("Cannot make '$abstract': ".$e->getMessage());
}
}
}
+48 -22
View File
@@ -12,8 +12,10 @@ namespace Barryvdh\LaravelIdeHelper\Console;
use Illuminate\Console\Command;
use Illuminate\Support\Str;
use Illuminate\Filesystem\Filesystem;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\ClassLoader\ClassMapGenerator;
use phpDocumentor\Reflection\DocBlock;
use phpDocumentor\Reflection\DocBlock\Context;
@@ -27,6 +29,10 @@ use phpDocumentor\Reflection\DocBlock\Serializer as DocBlockSerializer;
*/
class ModelsCommand extends Command
{
/**
* @var Filesystem $files
*/
protected $files;
/**
* The console command name.
@@ -49,6 +55,14 @@ class ModelsCommand extends Command
protected $dirs = array();
protected $reset;
/**
* @param Filesystem $files
*/
public function __construct(Filesystem $files)
{
parent::__construct();
$this->files = $files;
}
/**
* Execute the console command.
@@ -80,7 +94,7 @@ class ModelsCommand extends Command
$content = $this->generateDocs($model, $ignore);
if (!$this->write) {
$written = \File::put($filename, $content);
$written = $this->files->put($filename, $content);
if ($written !== false) {
$this->info("Model information was written to $filename");
} else {
@@ -148,7 +162,9 @@ class ModelsCommand extends Command
foreach ($models as $name) {
if (in_array($name, $ignore)) {
$this->comment("Ignoring model '$name'");
if ($this->output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
$this->comment("Ignoring model '$name'");
}
continue;
}
$this->properties = array();
@@ -162,7 +178,9 @@ class ModelsCommand extends Command
continue;
}
$this->comment("Loading model '$name'");
if ($this->output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
$this->comment("Loading model '$name'");
}
if (!$reflectionClass->IsInstantiable()) {
throw new \Exception($name . ' is not instantiable.');
@@ -176,6 +194,7 @@ class ModelsCommand extends Command
$this->getPropertiesFromMethods($model);
$output .= $this->createPhpDocs($name);
$ignore[] = $name;
} catch (\Exception $e) {
$this->error("Exception: " . $e->getMessage() . "\nCould not analyze class $name.");
}
@@ -330,6 +349,7 @@ class ModelsCommand extends Command
$code .= $file->current();
$file->next();
}
$code = trim(preg_replace('/\s\s+/', '', $code));
$begin = strpos($code, 'function(');
$code = substr($code, $begin, strrpos($code, '}') - $begin + 1);
@@ -345,24 +365,29 @@ class ModelsCommand extends Command
$search = '$this->' . $relation . '(';
if ($pos = stripos($code, $search)) {
$code = substr($code, $pos + strlen($search));
$arguments = explode(',', substr($code, 0, strpos($code, ')')));
//Remove quotes, ensure 1 \ in front of the model
$returnModel = $this->getClassName($arguments[0], $model);
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);
$end = strpos($code, ')->') ?:strpos($code, ');');
if (false !== $end) {
$arguments = substr($code, 0, $end);
$arguments = array_map(function($item) {
return trim($item, ' \'\"');
}, explode(',', $arguments));
//Remove quotes, ensure 1 \ in front of the model
$returnModel = $this->getClassName($arguments[0], $model);
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);
}
}
}
}
}
}
}
@@ -449,7 +474,8 @@ class ModelsCommand extends Command
} else {
$attr = 'property-read';
}
$tag = Tag::createInstance("@{$attr} {$property['type']} {$name} {$property['comment']}", $phpdoc);
$tagLine = trim("@{$attr} {$property['type']} {$name} {$property['comment']}");
$tag = Tag::createInstance($tagLine, $phpdoc);
$phpdoc->appendTag($tag);
}
@@ -469,7 +495,7 @@ class ModelsCommand extends Command
if ($this->write) {
$filename = $reflection->getFileName();
$contents = \File::get($filename);
$contents = $this->files->get($filename);
if ($originalDoc) {
$contents = str_replace($originalDoc, $docComment, $contents);
} else {
@@ -480,7 +506,7 @@ class ModelsCommand extends Command
$contents = substr_replace($contents, $replace, $pos, strlen($needle));
}
}
if (\File::put($filename, $contents)) {
if ($this->files->put($filename, $contents)) {
$this->info('Written new phpDocBlock to ' . $filename);
}
}
@@ -532,7 +558,7 @@ class ModelsCommand extends Command
{
// If the class name was resolved via get_class($this) or static::class
if (strpos($className, 'get_class($this)') !== false || strpos($className, 'static::class') !== false) {
return get_class($model);
return "\\" . get_class($model);
}
// If the class name was resolved via ::class (PHP 5.5+)
+35 -3
View File
@@ -80,7 +80,7 @@ class Generator
return $this->view->make('ide-helper::helper')
->with('namespaces', $this->getNamespaces())
->with('helpers', $this->helpers)
->with('version', $app::VERSION)
->with('version', $app->version())
->render();
}
@@ -166,8 +166,7 @@ class Generator
$namespaces = array();
// Get all aliases
foreach (AliasLoader::getInstance()->getAliases() as $name => $facade) {
foreach ($this->getAliases() as $name => $facade) {
// Skip the Redis facade, if not available (otherwise Fatal PHP Error)
if ($facade == 'Illuminate\Support\Facades\Redis' && !class_exists('Predis\Client')) {
continue;
@@ -194,6 +193,39 @@ class Generator
return $namespaces;
}
protected function getAliases()
{
// For Laravel, use the AliasLoader
if (class_exists('Illuminate\Foundation\AliasLoader')) {
return AliasLoader::getInstance()->getAliases();
}
$facades = [
'Illuminate\Support\Facades\App' => 'App',
'Illuminate\Support\Facades\Auth' => 'Auth',
'Illuminate\Support\Facades\Bus' => 'Bus',
'Illuminate\Support\Facades\DB' => 'DB',
'Illuminate\Support\Facades\Cache' => 'Cache',
'Illuminate\Support\Facades\Cookie' => 'Cookie',
'Illuminate\Support\Facades\Crypt' => 'Crypt',
'Illuminate\Support\Facades\Event' => 'Event',
'Illuminate\Support\Facades\Hash' => 'Hash',
'Illuminate\Support\Facades\Log' => 'Log',
'Illuminate\Support\Facades\Mail' => 'Mail',
'Illuminate\Support\Facades\Queue' => 'Queue',
'Illuminate\Support\Facades\Request' => 'Request',
'Illuminate\Support\Facades\Schema' => 'Schema',
'Illuminate\Support\Facades\Session' => 'Session',
'Illuminate\Support\Facades\Storage' => 'Storage',
// 'Illuminate\Support\Facades\Validator' => 'Validator',
];
// Only return the ones that actually exist
return array_filter($facades, function($alias){
return class_exists($alias);
});
}
/**
* Get the driver/connection/store from the managers
*
+8 -3
View File
@@ -36,7 +36,12 @@ class IdeHelperServiceProvider extends ServiceProvider
$this->loadViewsFrom($viewPath, 'ide-helper');
$configPath = __DIR__ . '/../config/ide-helper.php';
$this->publishes([$configPath => config_path('ide-helper.php')], 'config');
if (function_exists('config_path')) {
$publishPath = config_path('ide-helper.php');
} else {
$publishPath = base_path('config/ide-helper.php');
}
$this->publishes([$configPath => $publishPath], 'config');
}
/**
@@ -56,8 +61,8 @@ class IdeHelperServiceProvider extends ServiceProvider
);
$this->app['command.ide-helper.models'] = $this->app->share(
function () {
return new ModelsCommand();
function ($app) {
return new ModelsCommand($app['files']);
}
);