mirrors/barryvdh_laravel-ide-helper
1
0
Fork 0
mirror of https://github.com/barryvdh/laravel-ide-helper.git synced 2026-08-17 17:47:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add test config, CS rules and fix CS

Browse Source
This commit is contained in:
Barry vd. Heuvel
2016-06-08 21:36:25 +02:00
parent d734ecabcc
commit bae462604e
17 changed files with 1095 additions and 919 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.editorconfig
+15
View File
@@ -0,0 +1,15 @@
; This file is for unifying the coding style for different editors and IDEs.
; More information at http://editorconfig.org
root = true
[*]
charset = utf-8
indent_size = 4
indent_style = space
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
[*.md]
trim_trailing_whitespace = false
.gitattributes
+10
View File
@@ -0,0 +1,10 @@
# Path-based git attributes
# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
# Ignore all test and documentation with "export-ignore".
/.gitattributes export-ignore
/.gitignore export-ignore
/.travis.yml export-ignore
/phpunit.xml.dist export-ignore
/.scrutinizer.yml export-ignore
/tests export-ignore
.scrutinizer.yml
+23
View File
@@ -0,0 +1,23 @@
filter:
excluded_paths: [tests/*]
checks:
php:
remove_extra_empty_lines: true
remove_php_closing_tag: true
remove_trailing_whitespace: true
fix_use_statements:
remove_unused: true
preserve_multiple: false
preserve_blanklines: true
order_alphabetically: true
fix_php_opening_tag: true
fix_linefeed: true
fix_line_ending: true
fix_identation_4spaces: true
fix_doc_comments: true
tools:
external_code_coverage:
timeout: 600
runs: 3
.styleci.yml
+1
View File
@@ -0,0 +1 @@
preset: psr2
.travis.yml
+27
View File
@@ -0,0 +1,27 @@
language: php
php:
- 5.5
- 5.6
- 7.0
- hhvm
# This triggers builds to run on the new TravisCI infrastructure.
# See: http://docs.travis-ci.com/user/workers/container-based-infrastructure/
sudo: false
matrix:
include:
- php: 5.5
env: 'COMPOSER_FLAGS="--prefer-stable --prefer-lowest"'
before_script:
- travis_retry composer self-update
- travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-source
script:
- vendor/bin/phpcs --standard=psr2 src/
- vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover
after_script:
- if [[ $TRAVIS_PHP_VERSION != 'hhvm' && $TRAVIS_PHP_VERSION != '7.0' ]]; then php vendor/bin/ocular code-coverage:upload --format=php-clover coverage.clover; fi
build/report.junit.xml
+8
View File
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<testsuites>
<testsuite name=":vendor Test Suite" tests="1" assertions="1" failures="0" errors="0" time="0.008358">
<testsuite name="Barryvdh\LaravelIdeHelper\ExampleTest" file="/Users/barry/Code/laravel-ide-helper/tests/MethodTest.php" tests="1" assertions="1" failures="0" errors="0" time="0.008358">
<testcase name="testCanInstantiate" class="Barryvdh\LaravelIdeHelper\ExampleTest" file="/Users/barry/Code/laravel-ide-helper/tests/MethodTest.php" line="10" assertions="1" time="0.008358"/>
</testsuite>
</testsuite>
</testsuites>
build/report.tap
+3
View File
@@ -0,0 +1,3 @@
TAP version 13
ok 1 - Barryvdh\LaravelIdeHelper\ExampleTest::testCanInstantiate
1..1
composer.json
+12
View File
@@ -18,6 +18,9 @@
"symfony/class-loader": "~2.3|~3.0" "symfony/class-loader": "~2.3|~3.0"
}, },
"require-dev": { "require-dev": {
"phpunit/phpunit" : "4.*",
"scrutinizer/ocular": "~1.1",
"squizlabs/php_codesniffer": "~2.3",
"doctrine/dbal": "~2.3" "doctrine/dbal": "~2.3"
}, },
"suggest": { "suggest": {
@@ -28,6 +31,15 @@
"Barryvdh\\LaravelIdeHelper\\": "src" "Barryvdh\\LaravelIdeHelper\\": "src"
} }
}, },
"autoload-dev": {
"psr-4": {
":vendor\\:package_name\\": "tests"
}
},
"scripts": {
"test": "phpunit",
"cs": "phpcs --standard=psr2 src/"
},
"extra": { "extra": {
"branch-alias": { "branch-alias": {
"dev-master": "2.1-dev" "dev-master": "2.1-dev"
phpunit.xml.dist
+29
View File
@@ -0,0 +1,29 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit bootstrap="vendor/autoload.php"
backupGlobals="false"
backupStaticAttributes="false"
colors="true"
verbose="true"
convertErrorsToExceptions="true"
convertNoticesToExceptions="true"
convertWarningsToExceptions="true"
processIsolation="false"
stopOnFailure="false">
<testsuites>
<testsuite name=":vendor Test Suite">
<directory>tests</directory>
</testsuite>
</testsuites>
<filter>
<whitelist>
<directory suffix=".php">src/</directory>
</whitelist>
</filter>
<logging>
<log type="tap" target="build/report.tap"/>
<log type="junit" target="build/report.junit.xml"/>
<log type="coverage-html" target="build/coverage" charset="UTF-8" yui="true" highlight="true"/>
<log type="coverage-text" target="build/coverage.txt"/>
<log type="coverage-clover" target="build/logs/clover.xml"/>
</logging>
</phpunit>
src/Alias.php
+293 -284
View File
@@ -1,284 +1,293 @@
<?php <?php
/** /**
* 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 2014 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;
class Alias class Alias
{ {
protected $alias; protected $alias;
protected $facade; protected $facade;
protected $extends = null; protected $extends = null;
protected $classType = 'class'; protected $classType = 'class';
protected $short; protected $short;
protected $namespace = '__root'; protected $namespace = '__root';
protected $root = null; protected $root = null;
protected $classes = array(); protected $classes = array();
protected $methods = array(); protected $methods = array();
protected $usedMethods = array(); protected $usedMethods = array();
protected $valid = false; protected $valid = false;
protected $magicMethods = array(); protected $magicMethods = array();
protected $interfaces = array(); protected $interfaces = array();
/** /**
* @param string $alias * @param string $alias
* @param string $facade * @param string $facade
* @param array $magicMethods * @param array $magicMethods
* @param array $interfaces * @param array $interfaces
*/ */
public function __construct($alias, $facade, $magicMethods = array(), $interfaces = array()) public function __construct($alias, $facade, $magicMethods = array(), $interfaces = array())
{ {
$this->alias = $alias; $this->alias = $alias;
$this->magicMethods = $magicMethods; $this->magicMethods = $magicMethods;
$this->interfaces = $interfaces; $this->interfaces = $interfaces;
// Make the class absolute // Make the class absolute
$facade = '\\' . ltrim($facade, '\\'); $facade = '\\' . ltrim($facade, '\\');
$this->facade = $facade; $this->facade = $facade;
$this->detectRoot(); $this->detectRoot();
if ((!$this->isTrait() && $this->root)) { if ((!$this->isTrait() && $this->root)) {
$this->valid = true; $this->valid = true;
} else { } else {
return; return;
} }
$this->addClass($this->root); $this->addClass($this->root);
$this->detectNamespace(); $this->detectNamespace();
$this->detectClassType(); $this->detectClassType();
if($facade === '\Illuminate\Database\Eloquent\Model'){ if ($facade === '\Illuminate\Database\Eloquent\Model') {
$this->usedMethods = array('decrement', 'increment'); $this->usedMethods = array('decrement', 'increment');
} }
} }
/** /**
* Add one or more classes to analyze * Add one or more classes to analyze
* *
* @param array|string $classes * @param array|string $classes
*/ */
public function addClass($classes) public function addClass($classes)
{ {
$classes = (array)$classes; $classes = (array)$classes;
foreach ($classes as $class) { foreach ($classes as $class) {
if (class_exists($class) || interface_exists($class)) { if (class_exists($class) || interface_exists($class)) {
$this->classes[] = $class; $this->classes[] = $class;
}else{ } else {
echo "Class not exists: $class\r\n"; echo "Class not exists: $class\r\n";
} }
} }
} }
/** /**
* Check if this class is valid to process. * Check if this class is valid to process.
* @return bool * @return bool
*/ */
public function isValid() public function isValid()
{ {
return $this->valid; return $this->valid;
} }
/** /**
* Get the classtype, 'interface' or 'class' * Get the classtype, 'interface' or 'class'
* *
* @return string * @return string
*/ */
public function getClasstype() public function getClasstype()
{ {
return $this->classType; return $this->classType;
} }
/** /**
* Get the class which this alias extends * Get the class which this alias extends
* *
* @return null|string * @return null|string
*/ */
public function getExtends() public function getExtends()
{ {
return $this->extends; return $this->extends;
} }
/** /**
* Get the Alias by which this class is called * Get the Alias by which this class is called
* *
* @return string * @return string
*/ */
public function getAlias() public function getAlias()
{ {
return $this->alias; return $this->alias;
} }
/** /**
* Return the short name (without namespace) * Return the short name (without namespace)
*/ */
public function getShortName(){ public function getShortName()
return $this->short; {
} return $this->short;
/** }
* Get the namespace from the alias /**
* * Get the namespace from the alias
* @return string *
*/ * @return string
public function getNamespace() */
{ public function getNamespace()
return $this->namespace; {
} return $this->namespace;
}
/**
* Get the methods found by this Alias /**
* * Get the methods found by this Alias
* @return array *
*/ * @return array
public function getMethods() */
{ public function getMethods()
$this->addMagicMethods(); {
$this->detectMethods(); $this->addMagicMethods();
return $this->methods; $this->detectMethods();
} return $this->methods;
}
/**
* Detect the namespace /**
*/ * Detect the namespace
protected function detectNamespace() */
{ protected function detectNamespace()
if (strpos($this->alias, '\\')) { {
$nsParts = explode('\\', $this->alias); if (strpos($this->alias, '\\')) {
$this->short = array_pop($nsParts); $nsParts = explode('\\', $this->alias);
$this->namespace = implode('\\', $nsParts); $this->short = array_pop($nsParts);
}else{ $this->namespace = implode('\\', $nsParts);
$this->short = $this->alias; } else {
} $this->short = $this->alias;
} }
}
/**
* Detect the class type /**
*/ * Detect the class type
protected function detectClassType() */
{ protected function detectClassType()
//Some classes extend the facade {
if (interface_exists($this->facade)) { //Some classes extend the facade
$this->classType = 'interface'; if (interface_exists($this->facade)) {
$this->extends = $this->facade; $this->classType = 'interface';
} else { $this->extends = $this->facade;
$this->classType = 'class'; } else {
if (class_exists($this->facade)) { $this->classType = 'class';
$this->extends = $this->facade; if (class_exists($this->facade)) {
} $this->extends = $this->facade;
} }
} }
}
/**
* Get the real root of a facade /**
* * Get the real root of a facade
* @return bool|string *
*/ * @return bool|string
protected function detectRoot() */
{ protected function detectRoot()
$facade = $this->facade; {
$facade = $this->facade;
try {
//If possible, get the facade root try {
if (method_exists($facade, 'getFacadeRoot')) { //If possible, get the facade root
$root = get_class($facade::getFacadeRoot()); if (method_exists($facade, 'getFacadeRoot')) {
} else { $root = get_class($facade::getFacadeRoot());
$root = $facade; } else {
} $root = $facade;
}
//If it doesn't exist, skip it
if (!class_exists($root) && !interface_exists($root)) { //If it doesn't exist, skip it
return; if (!class_exists($root) && !interface_exists($root)) {
} return;
}
$this->root = $root;
$this->root = $root;
//When the database connection is not set, some classes will be skipped
} catch (\PDOException $e) { //When the database connection is not set, some classes will be skipped
$this->error( } catch (\PDOException $e) {
"PDOException: " . $e->getMessage() . "\nPlease configure your database connection correctly, or use the sqlite memory driver (-M). Skipping $facade." $this->error(
); "PDOException: " . $e->getMessage() .
} catch (\Exception $e) { "\nPlease configure your database connection correctly, or use the sqlite memory driver (-M)." .
$this->error("Exception: " . $e->getMessage() . "\nSkipping $facade."); " Skipping $facade."
} );
} } catch (\Exception $e) {
$this->error("Exception: " . $e->getMessage() . "\nSkipping $facade.");
/** }
* Detect if this class is a trait or not. }
*
* @return bool /**
*/ * Detect if this class is a trait or not.
protected function isTrait() *
{ * @return bool
// Check if the facade is not a Trait */
if (function_exists('trait_exists') && trait_exists($this->facade)) { protected function isTrait()
return true; {
} // Check if the facade is not a Trait
return false; if (function_exists('trait_exists') && trait_exists($this->facade)) {
} return true;
}
/** return false;
* Add magic methods, as defined in the configuration files }
*/
protected function addMagicMethods() /**
{ * Add magic methods, as defined in the configuration files
foreach($this->magicMethods as $magic => $real){ */
list($className, $name) = explode('::', $real); protected function addMagicMethods()
if(!class_exists($className) && !interface_exists($className)){ {
continue; foreach ($this->magicMethods as $magic => $real) {
} list($className, $name) = explode('::', $real);
$method = new \ReflectionMethod($className, $name); if (!class_exists($className) && !interface_exists($className)) {
$class = new \ReflectionClass($className); continue;
}
if(!in_array($method->name, $this->usedMethods)){ $method = new \ReflectionMethod($className, $name);
if($class !== $this->root){ $class = new \ReflectionClass($className);
$this->methods[] = new Method($method, $this->alias, $class, $magic, $this->interfaces);
} if (!in_array($method->name, $this->usedMethods)) {
$this->usedMethods[] = $magic; if ($class !== $this->root) {
} $this->methods[] = new Method($method, $this->alias, $class, $magic, $this->interfaces);
} }
} $this->usedMethods[] = $magic;
}
/** }
* Get the methods for one or multiple classes. }
*
* @return string /**
*/ * Get the methods for one or multiple classes.
protected function detectMethods() *
{ * @return string
*/
foreach ($this->classes as $class) { protected function detectMethods()
$reflection = new \ReflectionClass($class); {
$methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC); foreach ($this->classes as $class) {
if ($methods) { $reflection = new \ReflectionClass($class);
foreach ($methods as $method) {
if (!in_array($method->name, $this->usedMethods)) { $methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
// Only add the methods to the output when the root is not the same as the class. if ($methods) {
// And don't add the __*() methods foreach ($methods as $method) {
if ($this->extends !== $class && substr($method->name, 0, 2) !== '__') { if (!in_array($method->name, $this->usedMethods)) {
$this->methods[] = new Method($method, $this->alias, $reflection, $method->name, $this->interfaces); // Only add the methods to the output when the root is not the same as the class.
} // And don't add the __*() methods
$this->usedMethods[] = $method->name; if ($this->extends !== $class && substr($method->name, 0, 2) !== '__') {
} $this->methods[] = new Method(
} $method,
} $this->alias,
} $reflection,
} $method->name,
$this->interfaces
/** );
* Output an error. }
* $this->usedMethods[] = $method->name;
* @param string $string }
* @return void }
*/ }
protected function error($string) }
{ }
echo $string . "\r\n";
} /**
} * Output an error.
*
* @param string $string
* @return void
*/
protected function error($string)
{
echo $string . "\r\n";
}
}
src/Console/GeneratorCommand.php
+2 -3
View File
@@ -17,7 +17,6 @@ use Illuminate\Filesystem\Filesystem;
use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputArgument;
/** /**
* A command to generate autocomplete information for your IDE * A command to generate autocomplete information for your IDE
* *
@@ -60,7 +59,8 @@ class GeneratorCommand extends Command
*/ */
public function __construct( public function __construct(
/*ConfigRepository */ $config, /*ConfigRepository */ $config,
Filesystem $files, /* Illuminate\View\Factory */ Filesystem $files,
/* Illuminate\View\Factory */
$view $view
) { ) {
$this->config = $config; $this->config = $config;
@@ -166,5 +166,4 @@ class GeneratorCommand extends Command
array('sublime', "S", InputOption::VALUE_NONE, 'DEPRECATED: Use different style for SublimeText CodeIntel'), array('sublime', "S", InputOption::VALUE_NONE, 'DEPRECATED: Use different style for SublimeText CodeIntel'),
); );
} }
} }
src/Console/MetaCommand.php
+6 -4
View File
@@ -19,7 +19,8 @@ use Symfony\Component\Console\Output\OutputInterface;
* *
* @author Barry vd. Heuvel <[email protected]> * @author Barry vd. Heuvel <[email protected]>
*/ */
class MetaCommand extends Command { class MetaCommand extends Command
{
/** /**
* The console command name. * The console command name.
@@ -54,7 +55,8 @@ class MetaCommand extends Command {
* @param \Illuminate\Contracts\Filesystem\Filesystem $files * @param \Illuminate\Contracts\Filesystem\Filesystem $files
* @param \Illuminate\Contracts\View\Factory $view * @param \Illuminate\Contracts\View\Factory $view
*/ */
public function __construct($files, $view) { public function __construct($files, $view)
{
$this->files = $files; $this->files = $files;
$this->view = $view; $this->view = $view;
parent::__construct(); parent::__construct();
@@ -81,7 +83,7 @@ class MetaCommand extends Command {
if (is_object($concrete)) { if (is_object($concrete)) {
$bindings[$abstract] = get_class($concrete); $bindings[$abstract] = get_class($concrete);
} }
}catch (\Exception $e) { } catch (\Exception $e) {
if ($this->output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) { if ($this->output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
$this->comment("Cannot make '$abstract': ".$e->getMessage()); $this->comment("Cannot make '$abstract': ".$e->getMessage());
} }
@@ -105,7 +107,7 @@ class MetaCommand extends Command {
/** /**
* Get a list of abstracts from the Laravel Application. * Get a list of abstracts from the Laravel Application.
* *
* @return array * @return array
*/ */
protected function getAbstracts() protected function getAbstracts()
src/Console/ModelsCommand.php
+28 -18
View File
@@ -75,8 +75,8 @@ 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->dirs = array_merge(
$this->laravel['config']->get('ide-helper.model_locations'), $this->laravel['config']->get('ide-helper.model_locations'),
$this->option('dir') $this->option('dir')
); );
$model = $this->argument('model'); $model = $this->argument('model');
$ignore = $this->option('ignore'); $ignore = $this->option('ignore');
@@ -85,7 +85,7 @@ class ModelsCommand extends Command
//If filename is default and Write is not specified, ask what to do //If filename is default and Write is not specified, ask what to do
if (!$this->write && $filename === $this->filename && !$this->option('nowrite')) { if (!$this->write && $filename === $this->filename && !$this->option('nowrite')) {
if ($this->confirm( if ($this->confirm(
"Do you want to overwrite the existing model files? Choose no to write to $filename instead? (Yes/No): " "Do you want to overwrite the existing model files? Choose no to write to $filename instead? (Yes/No): "
) )
) { ) {
$this->write = true; $this->write = true;
@@ -201,12 +201,12 @@ class ModelsCommand extends Command
$this->error("Exception: " . $e->getMessage() . "\nCould not analyze class $name."); $this->error("Exception: " . $e->getMessage() . "\nCould not analyze class $name.");
} }
} }
} }
if (!$hasDoctrine) { if (!$hasDoctrine) {
$this->error( $this->error(
'Warning: `"doctrine/dbal": "~2.3"` is required to load database information. Please require that in your composer.json and run `composer update`.' 'Warning: `"doctrine/dbal": "~2.3"` is required to load database information. '.
'Please require that in your composer.json and run `composer update`.'
); );
} }
@@ -291,7 +291,11 @@ class ModelsCommand extends Command
$comment = $column->getComment(); $comment = $column->getComment();
$this->setProperty($name, $type, true, true, $comment); $this->setProperty($name, $type, true, true, $comment);
$this->setMethod(Str::camel("where_" . $name), '\Illuminate\Database\Query\Builder|\\' . get_class($model), array('$value')); $this->setMethod(
Str::camel("where_" . $name),
'\Illuminate\Database\Query\Builder|\\' . get_class($model),
array('$value')
);
} }
} }
} }
@@ -307,7 +311,7 @@ class ModelsCommand extends Command
if (Str::startsWith($method, 'get') && Str::endsWith( if (Str::startsWith($method, 'get') && Str::endsWith(
$method, $method,
'Attribute' 'Attribute'
) && $method !== 'getAttribute' ) && $method !== 'getAttribute'
) { ) {
//Magic get<name>Attribute //Magic get<name>Attribute
$name = Str::snake(substr($method, 3, -9)); $name = Str::snake(substr($method, 3, -9));
@@ -317,7 +321,7 @@ class ModelsCommand extends Command
} elseif (Str::startsWith($method, 'set') && Str::endsWith( } elseif (Str::startsWith($method, 'set') && Str::endsWith(
$method, $method,
'Attribute' 'Attribute'
) && $method !== 'setAttribute' ) && $method !== 'setAttribute'
) { ) {
//Magic set<name>Attribute //Magic set<name>Attribute
$name = Str::snake(substr($method, 3, -9)); $name = Str::snake(substr($method, 3, -9));
@@ -334,8 +338,9 @@ class ModelsCommand extends Command
array_shift($args); array_shift($args);
$this->setMethod($name, '\Illuminate\Database\Query\Builder|\\' . $reflection->class, $args); $this->setMethod($name, '\Illuminate\Database\Query\Builder|\\' . $reflection->class, $args);
} }
} elseif (!method_exists('Illuminate\Database\Eloquent\Model', $method) && !Str::startsWith($method, 'get')) { } elseif (!method_exists('Illuminate\Database\Eloquent\Model', $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);
@@ -364,24 +369,29 @@ class ModelsCommand extends Command
) as $relation) { ) as $relation) {
$search = '$this->' . $relation . '('; $search = '$this->' . $relation . '(';
if ($pos = stripos($code, $search)) { if ($pos = stripos($code, $search)) {
//Resolve the relation's model to a Relation object. //Resolve the relation's model to a Relation object.
$relationObj = $model->$method(); $relationObj = $model->$method();
if ($relationObj instanceof Relation) { if ($relationObj instanceof Relation) {
$relatedModel = '\\' . get_class($relationObj->getRelated()); $relatedModel = '\\' . get_class($relationObj->getRelated());
if (in_array($relation, ['hasManyThrough', 'belongsToMany', 'hasMany', 'morphMany', 'morphToMany'])) { $relations = ['hasManyThrough', 'belongsToMany', 'hasMany', 'morphMany', 'morphToMany'];
if (in_array($relation, $relations)) {
//Collection or array of models (because Collection is Arrayable) //Collection or array of models (because Collection is Arrayable)
$this->setProperty( $this->setProperty(
$method, $method,
$this->getCollectionClass($relatedModel) . '|' . $relatedModel . '[]', $this->getCollectionClass($relatedModel) . '|' . $relatedModel . '[]',
true, true,
null null
); );
} elseif ($relation === "morphTo") { } elseif ($relation === "morphTo") {
// Model isn't specified because relation is polymorphic // Model isn't specified because relation is polymorphic
$this->setProperty($method, '\Illuminate\Database\Eloquent\Model|\Eloquent', true, null); $this->setProperty(
$method,
'\Illuminate\Database\Eloquent\Model|\Eloquent',
true,
null
);
} else { } else {
//Single model is returned //Single model is returned
$this->setProperty($method, $relatedModel, true, null); $this->setProperty($method, $relatedModel, true, null);
@@ -401,7 +411,7 @@ class ModelsCommand extends Command
* @param bool|null $write * @param bool|null $write
* @param string|null $comment * @param string|null $comment
*/ */
protected function setProperty($name, $type = null, $read = null, $write = null, $comment='') protected function setProperty($name, $type = null, $read = null, $write = null, $comment = '')
{ {
if (!isset($this->properties[$name])) { if (!isset($this->properties[$name])) {
$this->properties[$name] = array(); $this->properties[$name] = array();
src/Generator.php
+302 -293
View File
@@ -1,293 +1,302 @@
<?php <?php
/** /**
* 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 2014 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\Foundation\AliasLoader; use Illuminate\Foundation\Application;
use Illuminate\Config\Repository as ConfigRepository; use Illuminate\Foundation\AliasLoader;
use ReflectionClass; use Illuminate\Config\Repository as ConfigRepository;
use Symfony\Component\Console\Output\OutputInterface; use ReflectionClass;
use Symfony\Component\Console\Output\OutputInterface;
class Generator
{ class Generator
/** @var \Illuminate\Config\Repository */ {
protected $config; /** @var \Illuminate\Config\Repository */
protected $config;
/** @var \Illuminate\View\Factory */
protected $view; /** @var \Illuminate\View\Factory */
protected $view;
/** @var \Symfony\Component\Console\Output\OutputInterface */
protected $output; /** @var \Symfony\Component\Console\Output\OutputInterface */
protected $output;
protected $extra = array();
protected $magic = array(); protected $extra = array();
protected $interfaces = array(); protected $magic = array();
protected $helpers; protected $interfaces = array();
protected $helpers;
/**
* @param \Illuminate\Config\Repository $config /**
* @param \Illuminate\View\Factory $view * @param \Illuminate\Config\Repository $config
* @param \Symfony\Component\Console\Output\OutputInterface $output * @param \Illuminate\View\Factory $view
* @param string $helpers * @param \Symfony\Component\Console\Output\OutputInterface $output
*/ * @param string $helpers
public function __construct(/*ConfigRepository */ $config, */
/* Illuminate\View\Factory */ $view, public function __construct(
OutputInterface $output = null, /*ConfigRepository */ $config,
$helpers = '' /* Illuminate\View\Factory */ $view,
) { OutputInterface $output = null,
$this->config = $config; $helpers = ''
$this->view = $view; ) {
$this->config = $config;
// Find the drivers to add to the extra/interfaces $this->view = $view;
$this->detectDrivers();
// Find the drivers to add to the extra/interfaces
$this->extra = array_merge($this->extra, $this->config->get('ide-helper.extra')); $this->detectDrivers();
$this->magic = array_merge($this->magic, $this->config->get('ide-helper.magic'));
$this->interfaces = array_merge($this->interfaces, $this->config->get('ide-helper.interfaces')); $this->extra = array_merge($this->extra, $this->config->get('ide-helper.extra'));
// Make all interface classes absolute $this->magic = array_merge($this->magic, $this->config->get('ide-helper.magic'));
foreach ($this->interfaces as &$interface) { $this->interfaces = array_merge($this->interfaces, $this->config->get('ide-helper.interfaces'));
$interface = '\\' . ltrim($interface, '\\'); // Make all interface classes absolute
} foreach ($this->interfaces as &$interface) {
$this->helpers = $helpers; $interface = '\\' . ltrim($interface, '\\');
} }
$this->helpers = $helpers;
/** }
* Generate the helper file contents;
* /**
* @param string $format The format to generate the helper in (php/json) * Generate the helper file contents;
* @return string; *
*/ * @param string $format The format to generate the helper in (php/json)
public function generate($format = 'php') * @return string;
{ */
// Check if the generator for this format exists public function generate($format = 'php')
$method = 'generate'.ucfirst($format).'Helper'; {
if (method_exists($this, $method)) { // Check if the generator for this format exists
return $this->$method(); $method = 'generate'.ucfirst($format).'Helper';
} if (method_exists($this, $method)) {
return $this->$method();
return $this->generatePhpHelper(); }
}
return $this->generatePhpHelper();
public function generatePhpHelper() }
{
$app = app(); public function generatePhpHelper()
return $this->view->make('ide-helper::helper') {
->with('namespaces', $this->getNamespaces()) $app = app();
->with('helpers', $this->helpers) return $this->view->make('ide-helper::helper')
->with('version', $app->version()) ->with('namespaces', $this->getNamespaces())
->render(); ->with('helpers', $this->helpers)
} ->with('version', $app->version())
->render();
public function generateJsonHelper() }
{
$classes = array(); public function generateJsonHelper()
foreach ($this->getNamespaces() as $aliases) { {
foreach($aliases as $alias) { $classes = array();
$functions = array(); foreach ($this->getNamespaces() as $aliases) {
foreach ($alias->getMethods() as $method) { foreach ($aliases as $alias) {
$functions[$method->getName()] = '('. $method->getParamsWithDefault().')'; $functions = array();
} foreach ($alias->getMethods() as $method) {
$classes[$alias->getAlias()] = array( $functions[$method->getName()] = '('. $method->getParamsWithDefault().')';
'functions' => $functions, }
); $classes[$alias->getAlias()] = array(
} 'functions' => $functions,
} );
}
$flags = JSON_FORCE_OBJECT; }
if (defined('JSON_PRETTY_PRINT')) {
$flags |= JSON_PRETTY_PRINT; $flags = JSON_FORCE_OBJECT;
} if (defined('JSON_PRETTY_PRINT')) {
$flags |= JSON_PRETTY_PRINT;
return json_encode(array( }
'php' => array(
'classes' => $classes, return json_encode(array(
), 'php' => array(
), $flags); 'classes' => $classes,
} ),
), $flags);
protected function detectDrivers() }
{
$this->interfaces['\Illuminate\Contracts\Auth\Authenticatable'] = config('auth.providers.users.model', config('auth.model', 'App\User')); protected function detectDrivers()
{
try{ $defaultUserModel = config('auth.providers.users.model', config('auth.model', 'App\User'));
if (class_exists('Auth') && is_a('Auth', '\Illuminate\Support\Facades\Auth', true)) { $this->interfaces['\Illuminate\Contracts\Auth\Authenticatable'] = $defaultUserModel;
if (class_exists('\Illuminate\Foundation\Application')) {
$authMethod = version_compare(\Illuminate\Foundation\Application::VERSION, '5.2', '>=') ? 'guard' : 'driver'; try {
} else { if (class_exists('Auth') && is_a('Auth', '\Illuminate\Support\Facades\Auth', true)) {
$refClass = new ReflectionClass('\Laravel\Lumen\Application'); if (class_exists('\Illuminate\Foundation\Application')) {
$versionStr = $refClass->newInstanceWithoutConstructor()->version(); $authMethod = version_compare(Application::VERSION, '5.2', '>=') ? 'guard' : 'driver';
$authMethod = strpos($versionStr, 'Lumen (5.0') === 0 ? 'driver' : (strpos($versionStr, 'Lumen (5.1') === 0 ? 'driver' : 'guard'); } else {
} $refClass = new ReflectionClass('\Laravel\Lumen\Application');
$class = get_class(\Auth::$authMethod()); $versionStr = $refClass->newInstanceWithoutConstructor()->version();
$this->extra['Auth'] = array($class); $authMethod = strpos($versionStr, 'Lumen (5.0') === 0 ?
$this->interfaces['\Illuminate\Auth\UserProviderInterface'] = $class; 'driver' :
} (strpos($versionStr, 'Lumen (5.1') === 0 ? 'driver' : 'guard');
}catch (\Exception $e) {} }
$class = get_class(\Auth::$authMethod());
try{ $this->extra['Auth'] = array($class);
if (class_exists('DB') && is_a('DB', '\Illuminate\Support\Facades\DB', true)) { $this->interfaces['\Illuminate\Auth\UserProviderInterface'] = $class;
$class = get_class(\DB::connection()); }
$this->extra['DB'] = array($class); } catch (\Exception $e) {
$this->interfaces['\Illuminate\Database\ConnectionInterface'] = $class; }
}
}catch (\Exception $e) {} try {
if (class_exists('DB') && is_a('DB', '\Illuminate\Support\Facades\DB', true)) {
try{ $class = get_class(\DB::connection());
if (class_exists('Cache') && is_a('Cache', '\Illuminate\Support\Facades\Cache', true)) { $this->extra['DB'] = array($class);
$driver = get_class(\Cache::driver()); $this->interfaces['\Illuminate\Database\ConnectionInterface'] = $class;
$store = get_class(\Cache::getStore()); }
$this->extra['Cache'] = array($driver, $store); } catch (\Exception $e) {
$this->interfaces['\Illuminate\Cache\StoreInterface'] = $store; }
}
}catch (\Exception $e) {} try {
if (class_exists('Cache') && is_a('Cache', '\Illuminate\Support\Facades\Cache', true)) {
try{ $driver = get_class(\Cache::driver());
if (class_exists('Queue') && is_a('Queue', '\Illuminate\Support\Facades\Queue', true)) { $store = get_class(\Cache::getStore());
$class = get_class(\Queue::connection()); $this->extra['Cache'] = array($driver, $store);
$this->extra['Queue'] = array($class); $this->interfaces['\Illuminate\Cache\StoreInterface'] = $store;
$this->interfaces['\Illuminate\Queue\QueueInterface'] = $class; }
} } catch (\Exception $e) {
}catch (\Exception $e) {} }
try{ try {
if (class_exists('SSH') && is_a('SSH', '\Illuminate\Support\Facades\SSH', true)){ if (class_exists('Queue') && is_a('Queue', '\Illuminate\Support\Facades\Queue', true)) {
$class = get_class(\SSH::connection()); $class = get_class(\Queue::connection());
$this->extra['SSH'] = array($class); $this->extra['Queue'] = array($class);
$this->interfaces['\Illuminate\Remote\ConnectionInterface'] = $class; $this->interfaces['\Illuminate\Queue\QueueInterface'] = $class;
} }
}catch (\Exception $e) {} } catch (\Exception $e) {
}
try{
if (class_exists('Storage') && is_a('Storage', '\Illuminate\Support\Facades\Storage', true)){ try {
$class = get_class(\Storage::disk()); if (class_exists('SSH') && is_a('SSH', '\Illuminate\Support\Facades\SSH', true)) {
$this->extra['Storage'] = array($class); $class = get_class(\SSH::connection());
$this->interfaces['\Illuminate\Contracts\Filesystem\Filesystem'] = $class; $this->extra['SSH'] = array($class);
} $this->interfaces['\Illuminate\Remote\ConnectionInterface'] = $class;
}catch (\Exception $e) {} }
} catch (\Exception $e) {
} }
/** try {
* Find all namespaces/aliases that are valid for us to render if (class_exists('Storage') && is_a('Storage', '\Illuminate\Support\Facades\Storage', true)) {
* $class = get_class(\Storage::disk());
* @return array $this->extra['Storage'] = array($class);
*/ $this->interfaces['\Illuminate\Contracts\Filesystem\Filesystem'] = $class;
protected function getNamespaces() }
{ } catch (\Exception $e) {
$namespaces = array(); }
// Get all aliases }
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')) { * Find all namespaces/aliases that are valid for us to render
continue; *
} * @return array
*/
$magicMethods = array_key_exists($name, $this->magic) ? $this->magic[$name] : array(); protected function getNamespaces()
$alias = new Alias($name, $facade, $magicMethods, $this->interfaces); {
if ($alias->isValid()) { $namespaces = array();
//Add extra methods, from other classes (magic static calls) // Get all aliases
if (array_key_exists($name, $this->extra)) { foreach ($this->getAliases() as $name => $facade) {
$alias->addClass($this->extra[$name]); // Skip the Redis facade, if not available (otherwise Fatal PHP Error)
} if ($facade == 'Illuminate\Support\Facades\Redis' && !class_exists('Predis\Client')) {
continue;
$namespace = $alias->getNamespace(); }
if (!isset($namespaces[$namespace])) {
$namespaces[$namespace] = array(); $magicMethods = array_key_exists($name, $this->magic) ? $this->magic[$name] : array();
} $alias = new Alias($name, $facade, $magicMethods, $this->interfaces);
$namespaces[$namespace][] = $alias; if ($alias->isValid()) {
} //Add extra methods, from other classes (magic static calls)
if (array_key_exists($name, $this->extra)) {
} $alias->addClass($this->extra[$name]);
}
return $namespaces;
} $namespace = $alias->getNamespace();
if (!isset($namespaces[$namespace])) {
protected function getAliases() $namespaces[$namespace] = array();
{ }
// For Laravel, use the AliasLoader $namespaces[$namespace][] = $alias;
if (class_exists('Illuminate\Foundation\AliasLoader')) { }
return AliasLoader::getInstance()->getAliases(); }
}
return $namespaces;
$facades = [ }
'App' => 'Illuminate\Support\Facades\App',
'Auth' => 'Illuminate\Support\Facades\Auth', protected function getAliases()
'Bus' => 'Illuminate\Support\Facades\Bus', {
'DB' => 'Illuminate\Support\Facades\DB', // For Laravel, use the AliasLoader
'Cache' => 'Illuminate\Support\Facades\Cache', if (class_exists('Illuminate\Foundation\AliasLoader')) {
'Cookie' => 'Illuminate\Support\Facades\Cookie', return AliasLoader::getInstance()->getAliases();
'Crypt' => 'Illuminate\Support\Facades\Crypt', }
'Event' => 'Illuminate\Support\Facades\Event',
'Hash' => 'Illuminate\Support\Facades\Hash', $facades = [
'Log' => 'Illuminate\Support\Facades\Log', 'App' => 'Illuminate\Support\Facades\App',
'Mail' => 'Illuminate\Support\Facades\Mail', 'Auth' => 'Illuminate\Support\Facades\Auth',
'Queue' => 'Illuminate\Support\Facades\Queue', 'Bus' => 'Illuminate\Support\Facades\Bus',
'Request' => 'Illuminate\Support\Facades\Request', 'DB' => 'Illuminate\Support\Facades\DB',
'Schema' => 'Illuminate\Support\Facades\Schema', 'Cache' => 'Illuminate\Support\Facades\Cache',
'Session' => 'Illuminate\Support\Facades\Session', 'Cookie' => 'Illuminate\Support\Facades\Cookie',
'Storage' => 'Illuminate\Support\Facades\Storage', 'Crypt' => 'Illuminate\Support\Facades\Crypt',
//'Validator' => 'Illuminate\Support\Facades\Validator', 'Event' => 'Illuminate\Support\Facades\Event',
]; 'Hash' => 'Illuminate\Support\Facades\Hash',
'Log' => 'Illuminate\Support\Facades\Log',
$facades = array_merge($facades, $this->config->get('app.aliases', [])); 'Mail' => 'Illuminate\Support\Facades\Mail',
'Queue' => 'Illuminate\Support\Facades\Queue',
// Only return the ones that actually exist 'Request' => 'Illuminate\Support\Facades\Request',
return array_filter($facades, function($alias){ 'Schema' => 'Illuminate\Support\Facades\Schema',
return class_exists($alias); 'Session' => 'Illuminate\Support\Facades\Session',
}); 'Storage' => 'Illuminate\Support\Facades\Storage',
} //'Validator' => 'Illuminate\Support\Facades\Validator',
];
/**
* Get the driver/connection/store from the managers $facades = array_merge($facades, $this->config->get('app.aliases', []));
*
* @param $alias // Only return the ones that actually exist
* @return array|bool|string return array_filter($facades, function ($alias) {
*/ return class_exists($alias);
public function getDriver($alias) });
{ }
try {
if ($alias == "Auth") { /**
$driver = \Auth::driver(); * Get the driver/connection/store from the managers
} elseif ($alias == "DB") { *
$driver = \DB::connection(); * @param $alias
} elseif ($alias == "Cache") { * @return array|bool|string
$driver = get_class(\Cache::driver()); */
$store = get_class(\Cache::getStore()); public function getDriver($alias)
return array($driver, $store); {
} elseif ($alias == "Queue") { try {
$driver = \Queue::connection(); if ($alias == "Auth") {
} else { $driver = \Auth::driver();
return false; } elseif ($alias == "DB") {
} $driver = \DB::connection();
} elseif ($alias == "Cache") {
return get_class($driver); $driver = get_class(\Cache::driver());
} catch (\Exception $e) { $store = get_class(\Cache::getStore());
$this->error("Could not determine driver/connection for $alias."); return array($driver, $store);
return false; } elseif ($alias == "Queue") {
} $driver = \Queue::connection();
} } else {
return false;
/** }
* Write a string as error output.
* return get_class($driver);
* @param string $string } catch (\Exception $e) {
* @return void $this->error("Could not determine driver/connection for $alias.");
*/ return false;
protected function error($string) }
{ }
if($this->output){
$this->output->writeln("<error>$string</error>"); /**
}else{ * Write a string as error output.
echo $string . "\r\n"; *
} * @param string $string
} * @return void
} */
protected function error($string)
{
if ($this->output) {
$this->output->writeln("<error>$string</error>");
} else {
echo $string . "\r\n";
}
}
}
src/IdeHelperServiceProvider.php
+3 -4
View File
@@ -67,9 +67,9 @@ class IdeHelperServiceProvider extends ServiceProvider
); );
$this->app['command.ide-helper.meta'] = $this->app->share( $this->app['command.ide-helper.meta'] = $this->app->share(
function ($app) { function ($app) {
return new MetaCommand($app['files'], $app['view']); return new MetaCommand($app['files'], $app['view']);
} }
); );
$this->commands('command.ide-helper.generate', 'command.ide-helper.models', 'command.ide-helper.meta'); $this->commands('command.ide-helper.generate', 'command.ide-helper.models', 'command.ide-helper.meta');
@@ -84,5 +84,4 @@ class IdeHelperServiceProvider extends ServiceProvider
{ {
return array('command.ide-helper.generate', 'command.ide-helper.models'); return array('command.ide-helper.generate', 'command.ide-helper.models');
} }
} }
src/Method.php
+314 -313
View File
@@ -1,313 +1,314 @@
<?php <?php
/** /**
* 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 2014 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 phpDocumentor\Reflection\DocBlock; use phpDocumentor\Reflection\DocBlock;
use phpDocumentor\Reflection\DocBlock\Context; use phpDocumentor\Reflection\DocBlock\Context;
use phpDocumentor\Reflection\DocBlock\Tag; use phpDocumentor\Reflection\DocBlock\Tag;
use phpDocumentor\Reflection\DocBlock\Tag\ReturnTag; use phpDocumentor\Reflection\DocBlock\Tag\ReturnTag;
use phpDocumentor\Reflection\DocBlock\Tag\ParamTag; use phpDocumentor\Reflection\DocBlock\Tag\ParamTag;
use phpDocumentor\Reflection\DocBlock\Serializer as DocBlockSerializer; use phpDocumentor\Reflection\DocBlock\Serializer as DocBlockSerializer;
class Method class Method
{ {
/** @var \phpDocumentor\Reflection\DocBlock */ /** @var \phpDocumentor\Reflection\DocBlock */
protected $phpdoc; protected $phpdoc;
/** @var \ReflectionMethod */ /** @var \ReflectionMethod */
protected $method; protected $method;
protected $output = ''; protected $output = '';
protected $name; protected $name;
protected $namespace; protected $namespace;
protected $params = array(); protected $params = array();
protected $params_with_default = array(); protected $params_with_default = array();
protected $interfaces = array(); protected $interfaces = array();
protected $return = null; protected $return = null;
/** /**
* @param \ReflectionMethod $method * @param \ReflectionMethod $method
* @param string $alias * @param string $alias
* @param string $class * @param \ReflectionClass $class
* @param string|null $methodName * @param string|null $methodName
* @param array $interfaces * @param array $interfaces
*/ */
public function __construct(\ReflectionMethod $method, $alias, $class, $methodName = null, $interfaces = array()) public function __construct(\ReflectionMethod $method, $alias, $class, $methodName = null, $interfaces = array())
{ {
$this->method = $method; $this->method = $method;
$this->interfaces = $interfaces; $this->interfaces = $interfaces;
$this->name = $methodName ?: $method->name; $this->name = $methodName ?: $method->name;
$this->namespace = $method->getDeclaringClass()->getNamespaceName(); $this->namespace = $method->getDeclaringClass()->getNamespaceName();
//Create a DocBlock and serializer instance //Create a DocBlock and serializer instance
$this->phpdoc = new DocBlock($method, new Context($this->namespace)); $this->phpdoc = new DocBlock($method, new Context($this->namespace));
//Normalize the description and inherit the docs from parents/interfaces //Normalize the description and inherit the docs from parents/interfaces
try { try {
$this->normalizeParams($this->phpdoc); $this->normalizeParams($this->phpdoc);
$this->normalizeReturn($this->phpdoc); $this->normalizeReturn($this->phpdoc);
$this->normalizeDescription($this->phpdoc); $this->normalizeDescription($this->phpdoc);
} catch (\Exception $e) {} } catch (\Exception $e) {
}
//Get the parameters, including formatted default values
$this->getParameters($method); //Get the parameters, including formatted default values
$this->getParameters($method);
//Make the method static
$this->phpdoc->appendTag(Tag::createInstance('@static', $this->phpdoc)); //Make the method static
$this->phpdoc->appendTag(Tag::createInstance('@static', $this->phpdoc));
//Reference the 'real' function in the declaringclass
$declaringClass = $method->getDeclaringClass(); //Reference the 'real' function in the declaringclass
$this->declaringClassName = '\\' . ltrim($declaringClass->name, '\\'); $declaringClass = $method->getDeclaringClass();
$this->root = '\\' . ltrim($class->getName(), '\\'); $this->declaringClassName = '\\' . ltrim($declaringClass->name, '\\');
} $this->root = '\\' . ltrim($class->getName(), '\\');
}
/**
* Get the class wherein the function resides /**
* * Get the class wherein the function resides
* @return string *
*/ * @return string
public function getDeclaringClass() */
{ public function getDeclaringClass()
return $this->declaringClassName; {
} return $this->declaringClassName;
}
/**
* Return the class from which this function would be called /**
* * Return the class from which this function would be called
* @return string *
*/ * @return string
public function getRoot() */
{ public function getRoot()
return $this->root; {
} return $this->root;
}
/**
* Get the docblock for this method /**
* * Get the docblock for this method
* @param string $prefix *
* @return mixed * @param string $prefix
*/ * @return mixed
public function getDocComment($prefix = "\t\t") */
{ public function getDocComment($prefix = "\t\t")
$serializer = new DocBlockSerializer(1, $prefix); {
return $serializer->getDocComment($this->phpdoc); $serializer = new DocBlockSerializer(1, $prefix);
} return $serializer->getDocComment($this->phpdoc);
}
/**
* Get the method name /**
* * Get the method name
* @return string *
*/ * @return string
public function getName() */
{ public function getName()
return $this->name; {
} return $this->name;
}
/**
* Get the parameters for this method /**
* * Get the parameters for this method
* @param bool $implode Wether to implode the array or not *
* @return string * @param bool $implode Wether to implode the array or not
*/ * @return string
public function getParams($implode = true) */
{ public function getParams($implode = true)
return $implode ? implode(', ', $this->params) : $this->params; {
} return $implode ? implode(', ', $this->params) : $this->params;
}
/**
* Get the parameters for this method including default values /**
* * Get the parameters for this method including default values
* @param bool $implode Wether to implode the array or not *
* @return string * @param bool $implode Wether to implode the array or not
*/ * @return string
public function getParamsWithDefault($implode = true) */
{ public function getParamsWithDefault($implode = true)
return $implode ? implode(', ', $this->params_with_default) : $this->params_with_default; {
} return $implode ? implode(', ', $this->params_with_default) : $this->params_with_default;
}
/**
* Get the description and get the inherited docs. /**
* * Get the description and get the inherited docs.
* @param DocBlock $phpdoc *
*/ * @param DocBlock $phpdoc
protected function normalizeDescription(DocBlock $phpdoc) */
{ protected function normalizeDescription(DocBlock $phpdoc)
//Get the short + long description from the DocBlock {
$description = $phpdoc->getText(); //Get the short + long description from the DocBlock
$description = $phpdoc->getText();
//Loop through parents/interfaces, to fill in {@inheritdoc}
if (strpos($description, '{@inheritdoc}') !== false) { //Loop through parents/interfaces, to fill in {@inheritdoc}
$inheritdoc = $this->getInheritDoc($this->method); if (strpos($description, '{@inheritdoc}') !== false) {
$inheritDescription = $inheritdoc->getText(); $inheritdoc = $this->getInheritDoc($this->method);
$inheritDescription = $inheritdoc->getText();
$description = str_replace('{@inheritdoc}', $inheritDescription, $description);
$phpdoc->setText($description); $description = str_replace('{@inheritdoc}', $inheritDescription, $description);
$phpdoc->setText($description);
$this->normalizeParams($inheritdoc);
$this->normalizeReturn($inheritdoc); $this->normalizeParams($inheritdoc);
$this->normalizeReturn($inheritdoc);
//Add the tags that are inherited
$inheritTags = $inheritdoc->getTags(); //Add the tags that are inherited
if ($inheritTags) { $inheritTags = $inheritdoc->getTags();
/** @var Tag $tag */ if ($inheritTags) {
foreach ($inheritTags as $tag) { /** @var Tag $tag */
$tag->setDocBlock(); foreach ($inheritTags as $tag) {
$phpdoc->appendTag($tag); $tag->setDocBlock();
} $phpdoc->appendTag($tag);
} }
} }
} }
}
/**
* Normalize the parameters /**
* * Normalize the parameters
* @param DocBlock $phpdoc *
*/ * @param DocBlock $phpdoc
protected function normalizeParams(DocBlock $phpdoc) */
{ protected function normalizeParams(DocBlock $phpdoc)
//Get the return type and adjust them for beter autocomplete {
$paramTags = $phpdoc->getTagsByName('param'); //Get the return type and adjust them for beter autocomplete
if ($paramTags) { $paramTags = $phpdoc->getTagsByName('param');
/** @var ParamTag $tag */ if ($paramTags) {
foreach($paramTags as $tag){ /** @var ParamTag $tag */
// Convert the keywords foreach ($paramTags as $tag) {
$content = $this->convertKeywords($tag->getContent()); // Convert the keywords
$tag->setContent($content); $content = $this->convertKeywords($tag->getContent());
$tag->setContent($content);
// Get the expanded type and re-set the content
$content = $tag->getType() . ' ' . $tag->getVariableName() . ' ' . $tag->getDescription(); // Get the expanded type and re-set the content
$tag->setContent(trim($content)); $content = $tag->getType() . ' ' . $tag->getVariableName() . ' ' . $tag->getDescription();
} $tag->setContent(trim($content));
} }
} }
}
/**
* Normalize the return tag (make full namespace, replace interfaces) /**
* * Normalize the return tag (make full namespace, replace interfaces)
* @param DocBlock $phpdoc *
*/ * @param DocBlock $phpdoc
protected function normalizeReturn(DocBlock $phpdoc) */
{ protected function normalizeReturn(DocBlock $phpdoc)
//Get the return type and adjust them for beter autocomplete {
$returnTags = $phpdoc->getTagsByName('return'); //Get the return type and adjust them for beter autocomplete
if ($returnTags) { $returnTags = $phpdoc->getTagsByName('return');
/** @var ReturnTag $tag */ if ($returnTags) {
$tag = reset($returnTags); /** @var ReturnTag $tag */
// Get the expanded type $tag = reset($returnTags);
$returnValue = $tag->getType(); // Get the expanded type
$returnValue = $tag->getType();
// Replace the interfaces
foreach($this->interfaces as $interface => $real){ // Replace the interfaces
$returnValue = str_replace($interface, $real, $returnValue); foreach ($this->interfaces as $interface => $real) {
} $returnValue = str_replace($interface, $real, $returnValue);
}
// Set the changed content
$tag->setContent($returnValue . ' ' . $tag->getDescription()); // Set the changed content
$this->return = $returnValue; $tag->setContent($returnValue . ' ' . $tag->getDescription());
}else{ $this->return = $returnValue;
$this->return = null; } else {
} $this->return = null;
} }
}
/**
* Convert keywwords that are incorrect. /**
* * Convert keywwords that are incorrect.
* @param string $string *
* @return string * @param string $string
*/ * @return string
protected function convertKeywords($string) */
{ protected function convertKeywords($string)
$string = str_replace('\Closure', 'Closure', $string); {
$string = str_replace('Closure', '\Closure', $string); $string = str_replace('\Closure', 'Closure', $string);
$string = str_replace('dynamic', 'mixed', $string); $string = str_replace('Closure', '\Closure', $string);
$string = str_replace('dynamic', 'mixed', $string);
return $string;
} return $string;
}
/**
* Should the function return a value? /**
* * Should the function return a value?
* @return bool *
*/ * @return bool
public function shouldReturn() */
{ public function shouldReturn()
if($this->return !== "void" && $this->method->name !== "__construct"){ {
return true; if ($this->return !== "void" && $this->method->name !== "__construct") {
} return true;
}
return false;
} return false;
}
/**
* Get the parameters and format them correctly /**
* * Get the parameters and format them correctly
* @param $method *
* @return array * @param $method
*/ * @return array
public function getParameters($method) */
{ public function getParameters($method)
//Loop through the default values for paremeters, and make the correct output string {
$params = array(); //Loop through the default values for paremeters, and make the correct output string
$paramsWithDefault = array(); $params = array();
foreach ($method->getParameters() as $param) { $paramsWithDefault = array();
$paramStr = '$' . $param->getName(); foreach ($method->getParameters() as $param) {
$params[] = $paramStr; $paramStr = '$' . $param->getName();
if ($param->isOptional()) { $params[] = $paramStr;
$default = $param->isDefaultValueAvailable() ? $param->getDefaultValue() : null; if ($param->isOptional()) {
if (is_bool($default)) { $default = $param->isDefaultValueAvailable() ? $param->getDefaultValue() : null;
$default = $default ? 'true' : 'false'; if (is_bool($default)) {
} elseif (is_array($default)) { $default = $default ? 'true' : 'false';
$default = 'array()'; } elseif (is_array($default)) {
} elseif (is_null($default)) { $default = 'array()';
$default = 'null'; } elseif (is_null($default)) {
} elseif (is_int($default)) { $default = 'null';
//$default = $default; } elseif (is_int($default)) {
} elseif (is_resource($default)) { //$default = $default;
//skip to not fail } elseif (is_resource($default)) {
} else { //skip to not fail
$default = "'" . trim($default) . "'"; } else {
} $default = "'" . trim($default) . "'";
$paramStr .= " = $default"; }
} $paramStr .= " = $default";
$paramsWithDefault[] = $paramStr; }
} $paramsWithDefault[] = $paramStr;
}
$this->params = $params;
$this->params_with_default = $paramsWithDefault; $this->params = $params;
} $this->params_with_default = $paramsWithDefault;
}
/**
* @param \ReflectionMethod $reflectionMethod /**
* @return DocBlock * @param \ReflectionMethod $reflectionMethod
*/ * @return DocBlock
protected function getInheritDoc($reflectionMethod) */
{ protected function getInheritDoc($reflectionMethod)
$parentClass = $reflectionMethod->getDeclaringClass()->getParentClass(); {
$parentClass = $reflectionMethod->getDeclaringClass()->getParentClass();
//Get either a parent or the interface
if ($parentClass) { //Get either a parent or the interface
$method = $parentClass->getMethod($reflectionMethod->getName()); if ($parentClass) {
} else { $method = $parentClass->getMethod($reflectionMethod->getName());
$method = $reflectionMethod->getPrototype(); } else {
} $method = $reflectionMethod->getPrototype();
if ($method) { }
$namespace = $method->getDeclaringClass()->getNamespaceName(); if ($method) {
$phpdoc = new DocBlock($method, new Context($namespace)); $namespace = $method->getDeclaringClass()->getNamespaceName();
$phpdoc = new DocBlock($method, new Context($namespace));
if (strpos($phpdoc->getText(), '{@inheritdoc}') !== false) {
//Not at the end yet, try another parent/interface.. if (strpos($phpdoc->getText(), '{@inheritdoc}') !== false) {
return $this->getInheritDoc($method); //Not at the end yet, try another parent/interface..
} else { return $this->getInheritDoc($method);
return $phpdoc; } else {
} return $phpdoc;
} }
} }
} }
}
tests/MethodTest.php
+19
View File
@@ -0,0 +1,19 @@
<?php
namespace Barryvdh\LaravelIdeHelper;
class ExampleTest extends \PHPUnit_Framework_TestCase
{
/**
* Test that we can actually instantiate the class
*/
public function testCanInstantiate()
{
$class = new \ReflectionClass(Method::class);
$method = new \ReflectionMethod(Method::class, 'getDocComment');
$obj = new Method($method, 'Method', $class);
$this->assertInstanceOf(Method::class, $obj);
}
}