Compare commits

...
Author SHA1 Message Date
Barry vd. Heuvel a9484c67d1 Merge branch 'master' of github.com:barryvdh/laravel-ide-helper 2016-06-13 21:36:24 +02:00
Barry vd. Heuvel 3064296216 Use fork of reflection docblock 2016-06-13 21:35:48 +02:00
Barry vd. Heuvel f057a4f820 Merge pull request #351 from ferdiunal/patch-1
Laravel 5.2.* composer.json file
2016-06-08 22:28:01 +02:00
Barry vd. Heuvel 091f78508c Add cache 2016-06-08 22:23:10 +02:00
Barry vd. Heuvel cf4fcd810c Prefest dist installs 2016-06-08 22:20:46 +02:00
Barry vd. Heuvel d3203de671 Remove other badges 2016-06-08 22:12:12 +02:00
Barry vd. Heuvel 093171e01f Update badges/licence 2016-06-08 22:11:14 +02:00
Barry vd. Heuvel 2d82419167 Test method output 2016-06-08 22:06:05 +02:00
Barry vd. Heuvel 0e84805e37 Update gitignore 2016-06-08 21:39:39 +02:00
Barry vd. Heuvel 7a07515149 Remove build dir 2016-06-08 21:39:24 +02:00
Barry vd. Heuvel bae462604e Add test config, CS rules and fix CS 2016-06-08 21:36:25 +02:00
Ferdi ÜNAL b28c8cbae1 Laravel 5.2.* composer.json file 2016-05-26 14:43:33 +03:00
Barry vd. Heuvel d734ecabcc Merge pull request #350 from Kurre/hasManyThrough-relationship
Add hasManyThrough relationship
2016-05-25 11:51:22 +02:00
Tommi Finnilä 4f227d5c57 Add hasManyThrough relationship 2016-05-25 09:28:34 +01:00
Barry vd. Heuvel 35ebf3a2ba Merge pull request #338 from cnanney/patch-1
Look for additional facade aliases in app config array
2016-05-12 07:32:54 +02:00
Barry vd. Heuvel f7b31bdbdc Merge pull request #345 from alexbowers/patch-1
Support Laravel 5.3.x (beta)
2016-05-01 09:29:05 +02:00
Alex Bowers 8de1673535 Update composer.json 2016-05-01 00:08:49 +01:00
Chris Nanney d818b72f82 Look for additional facade aliases in app config array
In my Lumen app, I load my providers and aliases from a `config/app.php` file like in Laravel. Maybe that is uncommon, but this simple PR will include those aliases as well if any are present.
2016-03-29 14:56:12 -05:00
Barry vd. Heuvel e97ed532f0 Merge pull request #327 from vedmant/master
Added support for default storage driver shortcuts, eg. Storage::exists('file.jpg');
2016-03-03 15:38:04 +01:00
Vedmant 606183ea12 Added support for default storage driver shortcuts, eg. Storage::exists('file.jpg'); 2016-03-03 16:33:28 +02:00
Barry vd. Heuvel f1ebd847aa Check on actual model, not facade
Fixes #311
2016-03-03 09:45:00 +01:00
Barry vd. Heuvel 83597196f9 Prevent double mixin tags 2016-03-03 09:43:49 +01:00
Barry vd. Heuvel 19553f63e4 Update composer.json 2016-03-02 11:03:09 +01:00
Barry vd. Heuvel f50470ba49 Add morphOne, fix morphTo
Fixes #236 thanks to @boxfrommars
2016-03-02 10:54:41 +01:00
Barry vd. Heuvel 7762e07f0a Use new provider config
Fixes #274, #324
2016-03-02 10:47:25 +01:00
Barry vd. Heuvel 467b5f5b5f Always add whereColumn
Fixes #300, #325
2016-03-02 10:42:37 +01:00
Barry vd. Heuvel c213be3d3c Merge pull request #305 from matiaspub/patch-1
Add extend \Eloquent for ide-helper:models command
2016-03-02 10:39:21 +01:00
Barry vd. Heuvel 4b8ba85b34 Merge pull request #315 from icedfish/ignore_exception
Ignore abstract class or interface, not throw exception
2016-01-28 09:19:58 +01:00
Barry vd. Heuvel d4c0ae5851 Merge pull request #314 from icedfish/recover-helper-function
recover model's whereXXX() helper function
2016-01-28 07:21:05 +01:00
Yu Bing 3a01e351de Ignore abstract class or interface, not throw exception 2016-01-28 11:37:08 +08:00
Yu Bing add34665a8 fix typo 2016-01-28 11:20:48 +08:00
Yu Bing c77752bb58 recover model's whereXXX() helper function 2016-01-28 11:18:42 +08:00
Barry vd. Heuvel aa8f772a46 Merge pull request #310 from naerymdan/master
Add support for Lumen 5.0, 5.1 and 5.2+
2016-01-22 14:33:15 +01:00
Vincent Labreche 0c4c55f349 Add support for Lumen 5.0, 5.1 and 5.2+ 2016-01-22 08:30:36 -05:00
Barry vd. Heuvel ed972acf19 Merge pull request #308 from barryvdh/revert-303-master
Revert "Don't use force aliases loading"
2016-01-21 15:55:37 +01:00
Sergius 4069863d0c Add extend \Eloquent for ide-helper:models command
It's help author to close many issues! )
Like: #269, #259, #248, #209, #191, #74, 
and https://github.com/laravel/framework/issues/7558 )))
etc. maybe
2016-01-12 15:33:05 +02:00
18 changed files with 1193 additions and 915 deletions
+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
+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
+2 -1
View File
@@ -1,3 +1,4 @@
/vendor build
vendor
composer.lock composer.lock
.idea .idea
+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
+1
View File
@@ -0,0 +1 @@
preset: psr2
+31
View File
@@ -0,0 +1,31 @@
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
## Cache composer
cache:
directories:
- $HOME/.composer/cache
matrix:
include:
- php: 5.5
env: 'COMPOSER_FLAGS="--prefer-stable --prefer-lowest"'
before_script:
- travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-dist
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
+21
View File
@@ -0,0 +1,21 @@
# The MIT License (MIT)
Copyright (c) 2016 Barry vd. Heuvel <barryvdh@gmail.com>
> Permission is hereby granted, free of charge, to any person obtaining a copy
> of this software and associated documentation files (the "Software"), to deal
> in the Software without restriction, including without limitation the rights
> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
> copies of the Software, and to permit persons to whom the Software is
> furnished to do so, subject to the following conditions:
>
> The above copyright notice and this permission notice shall be included in
> all copies or substantial portions of the Software.
>
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
> THE SOFTWARE.
+17 -5
View File
@@ -11,13 +11,16 @@
], ],
"require": { "require": {
"php": ">=5.4.0", "php": ">=5.4.0",
"illuminate/support": "5.0.x|5.1.x|5.2.x", "illuminate/support": "^5.0,<5.4",
"illuminate/console": "5.0.x|5.1.x|5.2.x", "illuminate/console": "^5.0,<5.4",
"illuminate/filesystem": "5.0.x|5.1.x|5.2.x", "illuminate/filesystem": "^5.0,<5.4",
"phpdocumentor/reflection-docblock": "2.0.4", "barryvdh/reflection-docblock": "^2.0.4",
"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"
+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>
+23 -2
View File
@@ -1,5 +1,9 @@
## Laravel 5 IDE Helper Generator ## Laravel 5 IDE Helper Generator
[![Latest Stable Version](https://poser.pugx.org/barryvdh/laravel-ide-helper/version.png)](https://packagist.org/packages/barryvdh/laravel-ide-helper) [![Total Downloads](https://poser.pugx.org/barryvdh/laravel-ide-helper/d/total.png)](https://packagist.org/packages/barryvdh/laravel-ide-helper)
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Software License][ico-license]](LICENSE.md)
[![Build Status][ico-travis]][link-travis]
[![Total Downloads][ico-downloads]][link-downloads]
__For Laravel 4.x, check [version 1.11](https://github.com/barryvdh/laravel-ide-helper/tree/1.11)__ __For Laravel 4.x, check [version 1.11](https://github.com/barryvdh/laravel-ide-helper/tree/1.11)__
@@ -50,8 +54,9 @@ You can configure your composer.json to do this after each commit:
```js ```js
"scripts":{ "scripts":{
"post-update-cmd": [ "post-update-cmd": [
"php artisan clear-compiled", "Illuminate\\Foundation\\ComposerScripts::postUpdate",
"php artisan ide-helper:generate", "php artisan ide-helper:generate",
"php artisan ide-helper:meta",
"php artisan optimize" "php artisan optimize"
] ]
}, },
@@ -154,3 +159,19 @@ Pre-generated example: https://gist.github.com/barryvdh/bb6ffc5d11e0a75dba67
### License ### License
The Laravel IDE Helper Generator is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT) The Laravel IDE Helper Generator is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)
[ico-version]: https://img.shields.io/packagist/v/barryvdh/laravel-ide-helper.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-travis]: https://img.shields.io/travis/barryvdh/laravel-ide-helper/master.svg?style=flat-square
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/barryvdh/laravel-ide-helper.svg?style=flat-square
[ico-code-quality]: https://img.shields.io/scrutinizer/g/barryvdh/laravel-ide-helper.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/barryvdh/laravel-ide-helper.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/barryvdh/laravel-ide-helper
[link-travis]: https://travis-ci.org/barryvdh/laravel-ide-helper
[link-scrutinizer]: https://scrutinizer-ci.com/g/barryvdh/laravel-ide-helper/code-structure
[link-code-quality]: https://scrutinizer-ci.com/g/barryvdh/laravel-ide-helper
[link-downloads]: https://packagist.org/packages/barryvdh/laravel-ide-helper
[link-author]: https://github.com/barryvdh
[link-contributors]: ../../contributors
+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";
}
}
+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'),
); );
} }
} }
+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()
+43 -22
View File
@@ -18,10 +18,10 @@ use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Console\Output\OutputInterface;
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
@@ -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;
@@ -184,7 +184,8 @@ class ModelsCommand extends Command
} }
if (!$reflectionClass->IsInstantiable()) { if (!$reflectionClass->IsInstantiable()) {
throw new \Exception($name . ' is not instantiable.'); // ignore abstract class or interface
continue;
} }
$model = $this->laravel->make($name); $model = $this->laravel->make($name);
@@ -200,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`.'
); );
} }
@@ -290,6 +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')
);
} }
} }
} }
@@ -305,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));
@@ -315,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));
@@ -332,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('Eloquent', $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);
@@ -351,29 +358,39 @@ class ModelsCommand extends Command
foreach (array( foreach (array(
'hasMany', 'hasMany',
'hasManyThrough',
'belongsToMany', 'belongsToMany',
'hasOne', 'hasOne',
'belongsTo', 'belongsTo',
'morphOne',
'morphTo', 'morphTo',
'morphMany', 'morphMany',
'morphToMany' 'morphToMany'
) 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, ['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") {
// Model isn't specified because relation is polymorphic
$this->setProperty(
$method,
'\Illuminate\Database\Eloquent\Model|\Eloquent',
true,
null
); );
} else { } else {
//Single model is returned //Single model is returned
@@ -394,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();
@@ -484,6 +501,10 @@ class ModelsCommand extends Command
$phpdoc->appendTag($tag); $phpdoc->appendTag($tag);
} }
if ($this->write && ! $phpdoc->getTagsByName('mixin')) {
$phpdoc->appendTag(Tag::createInstance("@mixin \\Eloquent", $phpdoc));
}
$serializer = new DocBlockSerializer(); $serializer = new DocBlockSerializer();
$serializer->getDocComment($phpdoc); $serializer->getDocComment($phpdoc);
$docComment = $serializer->getDocComment($phpdoc); $docComment = $serializer->getDocComment($phpdoc);
@@ -507,7 +528,7 @@ class ModelsCommand extends Command
} }
} }
$output = "namespace {$namespace}{\n{$docComment}\n\tclass {$classname} {}\n}\n\n"; $output = "namespace {$namespace}{\n{$docComment}\n\tclass {$classname} extends \Eloquent {}\n}\n\n";
return $output; return $output;
} }
+302 -277
View File
@@ -1,277 +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\Foundation\Application; use Illuminate\Foundation\AliasLoader;
use Illuminate\Config\Repository as ConfigRepository; 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.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;
$authMethod = version_compare(Application::VERSION, '5.2', '>=') ? 'guard' : 'driver';
$class = get_class(\Auth::$authMethod()); try {
$this->extra['Auth'] = array($class); if (class_exists('Auth') && is_a('Auth', '\Illuminate\Support\Facades\Auth', true)) {
$this->interfaces['\Illuminate\Auth\UserProviderInterface'] = $class; if (class_exists('\Illuminate\Foundation\Application')) {
} $authMethod = version_compare(Application::VERSION, '5.2', '>=') ? 'guard' : 'driver';
}catch (\Exception $e) {} } else {
$refClass = new ReflectionClass('\Laravel\Lumen\Application');
try{ $versionStr = $refClass->newInstanceWithoutConstructor()->version();
if (class_exists('DB') && is_a('DB', '\Illuminate\Support\Facades\DB', true)) { $authMethod = strpos($versionStr, 'Lumen (5.0') === 0 ?
$class = get_class(\DB::connection()); 'driver' :
$this->extra['DB'] = array($class); (strpos($versionStr, 'Lumen (5.1') === 0 ? 'driver' : 'guard');
$this->interfaces['\Illuminate\Database\ConnectionInterface'] = $class; }
} $class = get_class(\Auth::$authMethod());
}catch (\Exception $e) {} $this->extra['Auth'] = array($class);
$this->interfaces['\Illuminate\Auth\UserProviderInterface'] = $class;
try{ }
if (class_exists('Cache') && is_a('Cache', '\Illuminate\Support\Facades\Cache', true)) { } catch (\Exception $e) {
$driver = get_class(\Cache::driver()); }
$store = get_class(\Cache::getStore());
$this->extra['Cache'] = array($driver, $store); try {
$this->interfaces['\Illuminate\Cache\StoreInterface'] = $store; if (class_exists('DB') && is_a('DB', '\Illuminate\Support\Facades\DB', true)) {
} $class = get_class(\DB::connection());
}catch (\Exception $e) {} $this->extra['DB'] = array($class);
$this->interfaces['\Illuminate\Database\ConnectionInterface'] = $class;
try{ }
if (class_exists('Queue') && is_a('Queue', '\Illuminate\Support\Facades\Queue', true)) { } catch (\Exception $e) {
$class = get_class(\Queue::connection()); }
$this->extra['Queue'] = array($class);
$this->interfaces['\Illuminate\Queue\QueueInterface'] = $class; try {
} if (class_exists('Cache') && is_a('Cache', '\Illuminate\Support\Facades\Cache', true)) {
}catch (\Exception $e) {} $driver = get_class(\Cache::driver());
$store = get_class(\Cache::getStore());
try{ $this->extra['Cache'] = array($driver, $store);
if (class_exists('SSH') && is_a('SSH', '\Illuminate\Support\Facades\SSH', true)){ $this->interfaces['\Illuminate\Cache\StoreInterface'] = $store;
$class = get_class(\SSH::connection()); }
$this->extra['SSH'] = array($class); } catch (\Exception $e) {
$this->interfaces['\Illuminate\Remote\ConnectionInterface'] = $class; }
}
}catch (\Exception $e) {} try {
if (class_exists('Queue') && is_a('Queue', '\Illuminate\Support\Facades\Queue', true)) {
} $class = get_class(\Queue::connection());
$this->extra['Queue'] = array($class);
/** $this->interfaces['\Illuminate\Queue\QueueInterface'] = $class;
* Find all namespaces/aliases that are valid for us to render }
* } catch (\Exception $e) {
* @return array }
*/
protected function getNamespaces() try {
{ if (class_exists('SSH') && is_a('SSH', '\Illuminate\Support\Facades\SSH', true)) {
$namespaces = array(); $class = get_class(\SSH::connection());
$this->extra['SSH'] = array($class);
// Get all aliases $this->interfaces['\Illuminate\Remote\ConnectionInterface'] = $class;
foreach ($this->getAliases() as $name => $facade) { }
// Skip the Redis facade, if not available (otherwise Fatal PHP Error) } catch (\Exception $e) {
if ($facade == 'Illuminate\Support\Facades\Redis' && !class_exists('Predis\Client')) { }
continue;
} try {
if (class_exists('Storage') && is_a('Storage', '\Illuminate\Support\Facades\Storage', true)) {
$magicMethods = array_key_exists($name, $this->magic) ? $this->magic[$name] : array(); $class = get_class(\Storage::disk());
$alias = new Alias($name, $facade, $magicMethods, $this->interfaces); $this->extra['Storage'] = array($class);
if ($alias->isValid()) { $this->interfaces['\Illuminate\Contracts\Filesystem\Filesystem'] = $class;
}
//Add extra methods, from other classes (magic static calls) } catch (\Exception $e) {
if (array_key_exists($name, $this->extra)) { }
$alias->addClass($this->extra[$name]);
} }
$namespace = $alias->getNamespace(); /**
if (!isset($namespaces[$namespace])) { * Find all namespaces/aliases that are valid for us to render
$namespaces[$namespace] = array(); *
} * @return array
$namespaces[$namespace][] = $alias; */
} protected function getNamespaces()
{
} $namespaces = array();
return $namespaces; // Get all aliases
} foreach ($this->getAliases() as $name => $facade) {
// Skip the Redis facade, if not available (otherwise Fatal PHP Error)
protected function getAliases() if ($facade == 'Illuminate\Support\Facades\Redis' && !class_exists('Predis\Client')) {
{ continue;
// For Laravel, use the AliasLoader }
if (class_exists('Illuminate\Foundation\AliasLoader')) {
return AliasLoader::getInstance()->getAliases(); $magicMethods = array_key_exists($name, $this->magic) ? $this->magic[$name] : array();
} $alias = new Alias($name, $facade, $magicMethods, $this->interfaces);
if ($alias->isValid()) {
$facades = [ //Add extra methods, from other classes (magic static calls)
'App' => 'Illuminate\Support\Facades\App', if (array_key_exists($name, $this->extra)) {
'Auth' => 'Illuminate\Support\Facades\Auth', $alias->addClass($this->extra[$name]);
'Bus' => 'Illuminate\Support\Facades\Bus', }
'DB' => 'Illuminate\Support\Facades\DB',
'Cache' => 'Illuminate\Support\Facades\Cache', $namespace = $alias->getNamespace();
'Cookie' => 'Illuminate\Support\Facades\Cookie', if (!isset($namespaces[$namespace])) {
'Crypt' => 'Illuminate\Support\Facades\Crypt', $namespaces[$namespace] = array();
'Event' => 'Illuminate\Support\Facades\Event', }
'Hash' => 'Illuminate\Support\Facades\Hash', $namespaces[$namespace][] = $alias;
'Log' => 'Illuminate\Support\Facades\Log', }
'Mail' => 'Illuminate\Support\Facades\Mail', }
'Queue' => 'Illuminate\Support\Facades\Queue',
'Request' => 'Illuminate\Support\Facades\Request', return $namespaces;
'Schema' => 'Illuminate\Support\Facades\Schema', }
'Session' => 'Illuminate\Support\Facades\Session',
'Storage' => 'Illuminate\Support\Facades\Storage', protected function getAliases()
//'Validator' => 'Illuminate\Support\Facades\Validator', {
]; // For Laravel, use the AliasLoader
if (class_exists('Illuminate\Foundation\AliasLoader')) {
// Only return the ones that actually exist return AliasLoader::getInstance()->getAliases();
return array_filter($facades, function($alias){ }
return class_exists($alias);
}); $facades = [
} 'App' => 'Illuminate\Support\Facades\App',
'Auth' => 'Illuminate\Support\Facades\Auth',
/** 'Bus' => 'Illuminate\Support\Facades\Bus',
* Get the driver/connection/store from the managers 'DB' => 'Illuminate\Support\Facades\DB',
* 'Cache' => 'Illuminate\Support\Facades\Cache',
* @param $alias 'Cookie' => 'Illuminate\Support\Facades\Cookie',
* @return array|bool|string 'Crypt' => 'Illuminate\Support\Facades\Crypt',
*/ 'Event' => 'Illuminate\Support\Facades\Event',
public function getDriver($alias) 'Hash' => 'Illuminate\Support\Facades\Hash',
{ 'Log' => 'Illuminate\Support\Facades\Log',
try { 'Mail' => 'Illuminate\Support\Facades\Mail',
if ($alias == "Auth") { 'Queue' => 'Illuminate\Support\Facades\Queue',
$driver = \Auth::driver(); 'Request' => 'Illuminate\Support\Facades\Request',
} elseif ($alias == "DB") { 'Schema' => 'Illuminate\Support\Facades\Schema',
$driver = \DB::connection(); 'Session' => 'Illuminate\Support\Facades\Session',
} elseif ($alias == "Cache") { 'Storage' => 'Illuminate\Support\Facades\Storage',
$driver = get_class(\Cache::driver()); //'Validator' => 'Illuminate\Support\Facades\Validator',
$store = get_class(\Cache::getStore()); ];
return array($driver, $store);
} elseif ($alias == "Queue") { $facades = array_merge($facades, $this->config->get('app.aliases', []));
$driver = \Queue::connection();
} else { // Only return the ones that actually exist
return false; return array_filter($facades, function ($alias) {
} return class_exists($alias);
});
return get_class($driver); }
} catch (\Exception $e) {
$this->error("Could not determine driver/connection for $alias."); /**
return false; * Get the driver/connection/store from the managers
} *
} * @param $alias
* @return array|bool|string
/** */
* Write a string as error output. public function getDriver($alias)
* {
* @param string $string try {
* @return void if ($alias == "Auth") {
*/ $driver = \Auth::driver();
protected function error($string) } elseif ($alias == "DB") {
{ $driver = \DB::connection();
if($this->output){ } elseif ($alias == "Cache") {
$this->output->writeln("<error>$string</error>"); $driver = get_class(\Cache::driver());
}else{ $store = get_class(\Cache::getStore());
echo $string . "\r\n"; return array($driver, $store);
} } elseif ($alias == "Queue") {
} $driver = \Queue::connection();
} } else {
return false;
}
return get_class($driver);
} catch (\Exception $e) {
$this->error("Could not determine driver/connection for $alias.");
return false;
}
}
/**
* Write a string as error output.
*
* @param string $string
* @return void
*/
protected function error($string)
{
if ($this->output) {
$this->output->writeln("<error>$string</error>");
} else {
echo $string . "\r\n";
}
}
}
+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');
} }
} }
+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 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\Tag\ReturnTag; use Barryvdh\Reflection\DocBlock\Tag\ReturnTag;
use phpDocumentor\Reflection\DocBlock\Tag\ParamTag; use Barryvdh\Reflection\DocBlock\Tag\ParamTag;
use phpDocumentor\Reflection\DocBlock\Serializer as DocBlockSerializer; use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
class Method class Method
{ {
/** @var \phpDocumentor\Reflection\DocBlock */ /** @var \Barryvdh\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 \ReflectionMethod $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;
} }
} }
} }
}
+58
View File
@@ -0,0 +1,58 @@
<?php
namespace Barryvdh\LaravelIdeHelper;
class ExampleTest extends \PHPUnit_Framework_TestCase
{
/**
* Test that we can actually instantiate the class
*/
public function testCanInstantiate()
{
$reflectionClass = new \ReflectionClass(ExampleClass::class);
$reflectionMethod = $reflectionClass->getMethod('setName');
$method = new Method($reflectionMethod, 'Example', $reflectionClass);
$this->assertInstanceOf(Method::class, $method);
}
/**
* Test the output of a class
*/
public function testOutput()
{
$reflectionClass = new \ReflectionClass(ExampleClass::class);
$reflectionMethod = $reflectionClass->getMethod('setName');
$method = new Method($reflectionMethod, 'Example', $reflectionClass);
$output = '/**
*
*
* @param string $last
* @param string $first
* @static
*/';
$this->assertEquals($output, $method->getDocComment(''));
$this->assertEquals('setName', $method->getName());
$this->assertEquals('\\'.ExampleClass::class, $method->getDeclaringClass());
$this->assertEquals('$last, $first', $method->getParams(true));
$this->assertEquals(['$last', '$first'], $method->getParams(false));
$this->assertEquals('$last, $first = \'Barry\'', $method->getParamsWithDefault(true));
$this->assertEquals(['$last', '$first = \'Barry\''], $method->getParamsWithDefault(false));
$this->assertEquals(true, $method->shouldReturn());
}
}
class ExampleClass
{
/**
* @param string $last
* @param string $first
*/
public function setName($last, $first = 'Barry')
{
return;
}
}