Compare commits

..
6 Commits
Author SHA1 Message Date
Barry vd. Heuvel 83ab04be40 Update composer 2013-05-28 17:00:09 +02:00
Barry vd. Heuvel 8e0eace591 Specify version for new beta2 2013-05-27 22:22:23 +02:00
Barry vd. Heuvel 9dbcaa15b1 More fixes 2013-05-27 21:23:52 +02:00
Barry vd. Heuvel edf418f9ac Refactor variables and better namespace support 2013-05-27 21:02:46 +02:00
Barry vd. Heuvel eb3c3a7fe3 Add namespace DocBlock context
So they can be expanded correctly
2013-05-27 20:45:04 +02:00
Barry vd. Heuvel fde71b0ee8 Use DocBlock Serializer
Instead of doing it here.
2013-05-26 23:10:09 +02:00
2 changed files with 64 additions and 61 deletions
+3 -1
View File
@@ -1,6 +1,8 @@
{
"name": "barryvdh/laravel-ide-helper",
"description": "Laravel IDE Helper, generates correct PHPDocs for all Facade classes, to improve auto-completion.",
"keywords": ["laravel", "autocomplete", "phpstorm", "netbeans", "sublime", "codeintel", "phpdoc"],
"license": "MIT",
"authors": [
{
"name": "Barry vd. Heuvel",
@@ -12,7 +14,7 @@
"illuminate/support": "4.0.x",
"illuminate/console": "4.0.x",
"illuminate/filesystem": "4.0.x",
"phpdocumentor/reflection-docblock": "2.0.*",
"phpdocumentor/reflection-docblock": "dev-master#6d705c1a0f9e2a6d73d2e9ec0e538b9dfaf4315f",
"symfony/class-loader": "2.3.*"
},
"autoload": {
@@ -2,8 +2,11 @@
use Illuminate\Console\Command;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputArgument;
use DocBlock\Parser;
use Illuminate\Foundation\AliasLoader;
use phpDocumentor\Reflection\DocBlock;
use phpDocumentor\Reflection\DocBlock\Context;
use phpDocumentor\Reflection\DocBlock\Tag;
use phpDocumentor\Reflection\DocBlock\Serializer as DocBlockSerializer;
/**
* A command to generate autocomplete information for your IDE
*
@@ -25,6 +28,12 @@ class GeneratorCommand extends Command {
*/
protected $description = 'Generate a new IDE Helper file.';
protected $extra;
protected $nonstatic;
protected $onlyExtend;
protected $helpers;
protected $sublime;
/**
* Execute the console command.
@@ -39,19 +48,19 @@ class GeneratorCommand extends Command {
$this->useMemoryDriver();
}
$extra = \Config::get('laravel-ide-helper::extra');
$nonstatic = \Config::get('laravel-ide-helper::nonstatic');
$onlyExtend = \Config::get('laravel-ide-helper::only_extend');
$this->extra = \Config::get('laravel-ide-helper::extra');
$this->nonstatic = \Config::get('laravel-ide-helper::nonstatic');
$this->onlyExtend = \Config::get('laravel-ide-helper::only_extend');
if( $this->option('helpers') || (\Config::get('laravel-ide-helper::include_helpers') && ! $this->option('nohelpers'))){
$helpers = \Config::get('laravel-ide-helper::helper_files');
$this->helpers = \Config::get('laravel-ide-helper::helper_files');
}else{
$helpers = array();
$this->helpers = array();
}
$sublime = $this->option('sublime') || \Config::get('laravel-ide-helper::sublime');
$this->sublime = $this->option('sublime') || \Config::get('laravel-ide-helper::sublime');
$content = $this->generateDocs($extra, $nonstatic, $onlyExtend, $helpers, $sublime);
$content = $this->generateDocs();
$written = \File::put($filename, $content);
@@ -99,14 +108,11 @@ class GeneratorCommand extends Command {
}
/**
* @param array $extra
* @param array $nonstatic
* @param array $onlyExtend
* @param array $helpers
* @param bool $sublime
* Generate the docs for all facades in the AliasLoader
*
* @return string
*/
protected function generateDocs($extra = array(), $nonstatic = array(), $onlyExtend = array(), $helpers = array(), $sublime = false){
protected function generateDocs(){
$aliasLoader = AliasLoader::getInstance();
@@ -155,7 +161,7 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
$output .= "namespace $namespace {\n";
if($root !== $facade or in_array($alias, $onlyExtend)){
if($root !== $facade or in_array($alias, $this->onlyExtend)){
//If the root class is not the same as the facade extend it.
$output .= " class $alias extends $facade{\n";
}else{
@@ -163,11 +169,11 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
}
$output .= "\t/**\n\t * @var \\$root \$root\n\t */\n\t static private \$root;\n\n";
if(!in_array($alias, $onlyExtend))
if(!in_array($alias, $this->onlyExtend))
{
$usedMethods = array();
if(array_key_exists($alias, $nonstatic) ){
$nonstaticMethods = $nonstatic[$alias];
if(array_key_exists($alias, $this->nonstatic) ){
$nonstaticMethods = $this->nonstatic[$alias];
}else{
$nonstaticMethods = array();
}
@@ -180,15 +186,15 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
{
if(!in_array($method->name, $usedMethods)){
$static = !in_array($method->name, $nonstaticMethods);
$output .= $this->parseMethod($method, $alias, $root, $sublime, $static);
$output .= $this->parseMethod($method, $alias, $root, $static);
$usedMethods[] = $method->name;
}
}
}
if(array_key_exists($alias, $extra)){
if(array_key_exists($alias, $this->extra)){
$i = 2;
foreach($extra[$alias] as $extraClass){
foreach($this->extra[$alias] as $extraClass){
if(!class_exists($extraClass) && !interface_exists($extraClass)){
continue;
}
@@ -203,7 +209,7 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
{
if(!in_array($method->name, $usedMethods)){
$static = !in_array($method->name, $nonstaticMethods);
$output .= $this->parseMethod($method, $alias, $extraClass, $sublime, $static, $rootParam);
$output .= $this->parseMethod($method, $alias, $extraClass, $static, $rootParam);
$usedMethods[] = $method->name;
}
@@ -236,33 +242,30 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
* @param \ReflectionMethod $method
* @param string $alias
* @param string $root
* @param bool $sublime
* @param bool $static
* @param string $rootParam
* @return string
*/
protected function parseMethod($method, $alias, $root, $sublime, $static = true, $rootParam = 'root'){
protected function parseMethod($method, $alias, $root, $static = true, $rootParam = 'root'){
$output = '';
if($method->name === '__clone'){
return $output;
}
$phpdoc = new \phpDocumentor\Reflection\DocBlock($method);
$namespace = $method->getDeclaringClass()->getNamespaceName();
$phpdoc = new DocBlock($method, new Context($namespace));
$serializer = new DocBlockSerializer(1, "\t");
$description = $phpdoc->getText();
$description = $phpdoc->getShortDescription();
$longDescription = $phpdoc->getLongDescription()->getContents();
if($longDescription){
$description .= "\n".$longDescription;
}
if(strpos($description, '{@inheritdoc}') !== false){
$inheritdoc = $this->getInheritDoc($method);
$inheritDescription = $inheritdoc->getShortDescription();
$inheritDescription = $inheritdoc->getText();
$inheritLongDescription = $inheritdoc->getLongDescription()->getContents();
if($inheritLongDescription){
$inheritDescription .= "\n".$inheritLongDescription;
}
$description = str_replace('{@inheritdoc}', $inheritDescription, $description);
$phpdoc->setText($description);
$inheritTags = $inheritdoc->getTags();
if($inheritTags){
foreach($inheritTags as $tag){
@@ -271,46 +274,44 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
}
}
}
$description = str_replace("\n", "\n\t * ", $description);
$output .= "\t/**\n\t * ".$description."\n";
$output .= "\t *\n\t * @static\n";
$phpdoc->appendTag(Tag::createInstance('@static', $phpdoc));
//Looping through the parameters and re-setting the type, to get the expanded type (with namespace)
//Should be fixed in a future version of ReflectionDocBlock I hope..
$paramTags = $phpdoc->getTagsByName('param');
if(!empty($paramTags)){
foreach ($paramTags as $tag)
{
$output .="\t * @param\t".$tag->getType()."\t".$tag->getVariableName()."\t".$tag->getDescription()."\n";
if($paramTags){
/** @var $tag */
foreach($paramTags as $tag){
$content = $tag->getContent();
//Closure should be \Closure..
$content = str_replace('\Closure', 'Closure', $content);
$content = str_replace('Closure', '\Closure', $content);
$tag->setContent($content);
$tag->setContent($tag->getType() . ' ' . $tag->getVariableName() . ' ' . $tag->getDescription());
}
}
$returnTags = $phpdoc->getTagsByName('return');
if($returnTags){
/** @var $tag */
$tag = reset($returnTags);
$returnValue = $tag->getType();
if(!$sublime and $alias == 'Eloquent' and
if(!$this->sublime and $alias == 'Eloquent' and
(in_array($method->name, array('pluck', 'first', 'fill', 'newInstance', 'newFromBuilder', 'create', 'find', 'findOrFail'))
or $returnValue === '\Illuminate\Database\Query\Builder')){
//Reference the calling class, to provide more accurate auto-complete
$returnValue = "static";
}elseif(!$sublime and $alias == 'Eloquent' and in_array($method->name, array('all', 'get'))){
$returnValue .= "|Eloquent[]|static[]";
}elseif(!$this->sublime and $alias == 'Eloquent' and in_array($method->name, array('all', 'get'))){
$returnValue .= "|\Eloquent[]|static[]";
}
$output .= "\t * @return\t".$returnValue."\t".$tag->getDescription()."\n";
$tag->setContent($returnValue . " ". $tag->getDescription());
}else{
$returnValue = null;
}
$allTags = $phpdoc->getTags();
if($allTags){
foreach($allTags as $tag){
if(!in_array($tag->getName(), array('return', 'param'))){
$output .= "\t * @".$tag->getName() ." ". $tag->getContent()."\n";
}
}
}
$output .= "\t */\n\t public ".($static ? 'static' : '')." function ".$method->name."(";
$output .= $serializer->getDocComment($phpdoc) ."\n\t public ".($static ? 'static' : '')." function ".$method->name."(";
$params = array();
$paramsWithDefault = array();
@@ -337,9 +338,9 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
$output .= implode($paramsWithDefault, ", ");
$output .= "){\r\n";
$return = $returnValue !== "void" ? 'return' : '';
$return = ($returnValue && $returnValue !== "void") ? 'return' : '';
if($sublime){
if($this->sublime){
$output .= "\t\t\$$rootParam = new $root();\r\n";
$output .= "\t\t$return \$$rootParam->";
}else{
@@ -364,8 +365,8 @@ namespace {\n\tdie('Only to be used as an helper for your IDE');\n}\n\n";
$method = $reflectionMethod->getPrototype();
}
if($method){
$phpdoc = new \phpDocumentor\Reflection\DocBlock($method);
if(strpos($phpdoc->getShortDescription(), '{@inheritdoc}') !== false || strpos($phpdoc->getLongDescription(), '{@inheritdoc}') !== false ){
$phpdoc = new DocBlock($method);
if(strpos($phpdoc->getText(), '{@inheritdoc}') !== false ){
//Not at the end yet, try another parent/interface..
return $this->getInheritDoc($method);
}else{