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

Normalize return/params from inheritdocs before appending

Browse Source 
This normalizes return/param tags, before the tags are added to the docblock. This will preserve the correct context (and namespace).
Should fix #93
This commit is contained in:
Barry vd. Heuvel
2014-08-11 12:07:00 +02:00
parent cbfd53e0f9
commit 4cfcabb63d
1 changed files with 21 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/Method.php
+21 -12
View File
@@ -52,9 +52,9 @@ class Method
//Normalize the description and inherit the docs from parents/interfaces //Normalize the description and inherit the docs from parents/interfaces
try { try {
$this->normalizeDescription(); $this->normalizeParams($this->phpdoc);
$this->normalizeParams(); $this->normalizeReturn($this->phpdoc);
$this->normalizeReturn(); $this->normalizeDescription($this->phpdoc);
} catch (\Exception $e) {} } catch (\Exception $e) {}
//Get the parameters, including formatted default values //Get the parameters, including formatted default values
@@ -136,11 +136,12 @@ class Method
/** /**
* Get the description and get the inherited docs. * Get the description and get the inherited docs.
* *
* @param DocBlock $phpdoc
*/ */
protected function normalizeDescription() protected function normalizeDescription(DocBlock $phpdoc)
{ {
//Get the short + long description from the DocBlock //Get the short + long description from the DocBlock
$description = $this->phpdoc->getText(); $description = $phpdoc->getText();
//Loop through parents/interfaces, to fill in {@inheritdoc} //Loop through parents/interfaces, to fill in {@inheritdoc}
if (strpos($description, '{@inheritdoc}') !== false) { if (strpos($description, '{@inheritdoc}') !== false) {
@@ -148,14 +149,18 @@ class Method
$inheritDescription = $inheritdoc->getText(); $inheritDescription = $inheritdoc->getText();
$description = str_replace('{@inheritdoc}', $inheritDescription, $description); $description = str_replace('{@inheritdoc}', $inheritDescription, $description);
$this->phpdoc->setText($description); $phpdoc->setText($description);
$this->normalizeParams($inheritdoc);
$this->normalizeReturn($inheritdoc);
//Add the tags that are inherited //Add the tags that are inherited
$inheritTags = $inheritdoc->getTags(); $inheritTags = $inheritdoc->getTags();
if ($inheritTags) { if ($inheritTags) {
/** @var Tag $tag */
foreach ($inheritTags as $tag) { foreach ($inheritTags as $tag) {
$tag->setDocBlock(); $tag->setDocBlock();
$this->phpdoc->appendTag($tag); $phpdoc->appendTag($tag);
} }
} }
} }
@@ -163,11 +168,13 @@ class Method
/** /**
* Normalize the parameters * Normalize the parameters
*
* @param DocBlock $phpdoc
*/ */
protected function normalizeParams() protected function normalizeParams(DocBlock $phpdoc)
{ {
//Get the return type and adjust them for beter autocomplete //Get the return type and adjust them for beter autocomplete
$paramTags = $this->phpdoc->getTagsByName('param'); $paramTags = $phpdoc->getTagsByName('param');
if ($paramTags) { if ($paramTags) {
/** @var ParamTag $tag */ /** @var ParamTag $tag */
foreach($paramTags as $tag){ foreach($paramTags as $tag){
@@ -184,11 +191,13 @@ class Method
/** /**
* Normalize the return tag (make full namespace, replace interfaces) * Normalize the return tag (make full namespace, replace interfaces)
*
* @param DocBlock $phpdoc
*/ */
protected function normalizeReturn() protected function normalizeReturn(DocBlock $phpdoc)
{ {
//Get the return type and adjust them for beter autocomplete //Get the return type and adjust them for beter autocomplete
$returnTags = $this->phpdoc->getTagsByName('return'); $returnTags = $phpdoc->getTagsByName('return');
if ($returnTags) { if ($returnTags) {
/** @var ReturnTag $tag */ /** @var ReturnTag $tag */
$tag = reset($returnTags); $tag = reset($returnTags);
@@ -275,7 +284,7 @@ class Method
/** /**
* @param \ReflectionMethod $reflectionMethod * @param \ReflectionMethod $reflectionMethod
* @return string * @return DocBlock
*/ */
protected function getInheritDoc($reflectionMethod) protected function getInheritDoc($reflectionMethod)
{ {