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

Made all tag handlers call Tag::__construct() rather than "manually" duplicating it;

Browse Source 
Tag::__construct() trims the description (as is common for most tag handlers), while the original contents is still in the $content property;
Added the DocBlock argument to all tag handlers.
This commit is contained in:
Vasil Rangelov
2012-11-13 19:00:49 +02:00
parent 1352ef56a6
commit 1ac9106c48
8 changed files with 59 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/phpDocumentor/Reflection/DocBlock/Tag.php
+1 -1
View File
@@ -159,7 +159,7 @@ class Tag implements \Reflector
{ {
$this->tag = $type; $this->tag = $type;
$this->content = $content; $this->content = $content;
$this->description = $content; $this->description = trim($content);
$this->docblock = $docblock; $this->docblock = $docblock;
} }
src/phpDocumentor/Reflection/DocBlock/Tag/AuthorTag.php
+11 -5
View File
@@ -12,6 +12,7 @@
namespace phpDocumentor\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use phpDocumentor\Reflection\DocBlock;
use phpDocumentor\Reflection\DocBlock\Tag; use phpDocumentor\Reflection\DocBlock\Tag;
/** /**
@@ -32,13 +33,18 @@ class AuthorTag extends Tag
/** /**
* Parses a tag and populates the member variables. * Parses a tag and populates the member variables.
* *
* @param string $type Tag identifier for this tag (should be 'author'). * @param string $type Tag identifier for this tag (should be 'author').
* @param string $content The contents of the given tag. * @param string $content Contents for this tag.
* @param DocBlock $docblock The DocBlock which this tag belongs to.
*/ */
public function __construct($type, $content) public function __construct($type, $content, DocBlock $docblock = null)
{ {
parent::__construct($type, $content); parent::__construct($type, $content, $docblock);
if (preg_match('/^([^\<]*)(\<([^\>]*)\>)?$/', $content, $matches)) { if (preg_match(
'/^([^\<]*)(\<([^\>]*)\>)?$/',
$this->description,
$matches
)) {
$this->name = trim($matches[1]); $this->name = trim($matches[1]);
if (isset($matches[3])) { if (isset($matches[3])) {
$this->email = trim($matches[3]); $this->email = trim($matches[3]);
src/phpDocumentor/Reflection/DocBlock/Tag/LinkTag.php
+7 -5
View File
@@ -12,6 +12,7 @@
namespace phpDocumentor\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use phpDocumentor\Reflection\DocBlock;
use phpDocumentor\Reflection\DocBlock\Tag; use phpDocumentor\Reflection\DocBlock\Tag;
/** /**
@@ -29,13 +30,14 @@ class LinkTag extends Tag
/** /**
* Parses a tag and populates the member variables. * Parses a tag and populates the member variables.
* *
* @param string $type Tag identifier for this tag (should be 'link'). * @param string $type Tag identifier for this tag (should be 'link').
* @param string $content The contents of the given tag. * @param string $content Contents for this tag.
* @param DocBlock $docblock The DocBlock which this tag belongs to.
*/ */
public function __construct($type, $content) public function __construct($type, $content, DocBlock $docblock = null)
{ {
$this->tag = $type; parent::__construct($type, $content, $docblock);
$pieces = explode(' ', $content); $pieces = explode(' ', $this->description);
if (count($pieces) > 1) { if (count($pieces) > 1) {
$this->link = array_shift($pieces); $this->link = array_shift($pieces);
src/phpDocumentor/Reflection/DocBlock/Tag/MethodTag.php
+9 -6
View File
@@ -12,6 +12,9 @@
namespace phpDocumentor\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use phpDocumentor\Reflection\DocBlock;
use phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for a @method in a Docblock. * Reflection class for a @method in a Docblock.
* *
@@ -31,13 +34,13 @@ class MethodTag extends ReturnTag
/** /**
* Parses a tag and populates the member variables. * Parses a tag and populates the member variables.
* *
* @param string $type Tag identifier for this tag (should be 'method'). * @param string $type Tag identifier for this tag (should be 'method').
* @param string $content The contents of the given tag. * @param string $content Contents for this tag.
* @param DocBlock $docblock The DocBlock which this tag belongs to.
*/ */
public function __construct($type, $content) public function __construct($type, $content, DocBlock $docblock = null)
{ {
$this->tag = $type; Tag::__construct($type, $content, $docblock);
$this->content = $content;
$matches = array(); $matches = array();
// 1. none or more whitespace // 1. none or more whitespace
@@ -51,7 +54,7 @@ class MethodTag extends ReturnTag
if (preg_match( if (preg_match(
'/^[\s]*(?:([\w\|_\\\\]+)[\s]+)?(?:[\w_]+\(\)[\s]+)?([\w\|_\\\\]+)' '/^[\s]*(?:([\w\|_\\\\]+)[\s]+)?(?:[\w_]+\(\)[\s]+)?([\w\|_\\\\]+)'
.'\(([^\)]*)\)[\s]*(.*)/u', .'\(([^\)]*)\)[\s]*(.*)/u',
$content, $this->description,
$matches $matches
)) { )) {
list( list(
src/phpDocumentor/Reflection/DocBlock/Tag/ParamTag.php
+9 -6
View File
@@ -12,6 +12,9 @@
namespace phpDocumentor\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use phpDocumentor\Reflection\DocBlock;
use phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for a @param tag in a Docblock. * Reflection class for a @param tag in a Docblock.
* *
@@ -29,16 +32,16 @@ class ParamTag extends ReturnTag
/** /**
* Parses a tag and populates the member variables. * Parses a tag and populates the member variables.
* *
* @param string $type Tag identifier for this tag (should be 'param'). * @param string $type Tag identifier for this tag (should be 'param').
* @param string $content Contents for this tag. * @param string $content Contents for this tag.
* @param DocBlock $docblock The DocBlock which this tag belongs to.
*/ */
public function __construct($type, $content) public function __construct($type, $content, DocBlock $docblock = null)
{ {
$this->tag = $type; Tag::__construct($type, $content, $docblock);
$this->content = $content;
$content = preg_split( $content = preg_split(
'/(\s+)/u', '/(\s+)/u',
trim($content), $this->description,
3, 3,
PREG_SPLIT_DELIM_CAPTURE PREG_SPLIT_DELIM_CAPTURE
); );
src/phpDocumentor/Reflection/DocBlock/Tag/ReturnTag.php
+7 -7
View File
@@ -12,6 +12,7 @@
namespace phpDocumentor\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use phpDocumentor\Reflection\DocBlock;
use phpDocumentor\Reflection\DocBlock\Tag; use phpDocumentor\Reflection\DocBlock\Tag;
/** /**
@@ -29,15 +30,14 @@ class ReturnTag extends Tag
/** /**
* Parses a tag and populates the member variables. * Parses a tag and populates the member variables.
* *
* @param string $type Tag identifier for this tag (should be 'return'). * @param string $type Tag identifier for this tag (should be 'return').
* @param string $content Contents for this tag. * @param string $content Contents for this tag.
* @param DocBlock $docblock The DocBlock which this tag belongs to.
*/ */
public function __construct($type, $content) public function __construct($type, $content, DocBlock $docblock = null)
{ {
$this->tag = $type; parent::__construct($type, $content, $docblock);
$this->content = $content; $content = preg_split('/[\ \t]+/u', $this->description, 2);
$content = preg_split('/[\ \t]+/u', trim($content), 2);
// any output is considered a type // any output is considered a type
$this->type = array_shift($content); $this->type = array_shift($content);
src/phpDocumentor/Reflection/DocBlock/Tag/SeeTag.php
+6 -5
View File
@@ -12,6 +12,7 @@
namespace phpDocumentor\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use phpDocumentor\Reflection\DocBlock;
use phpDocumentor\Reflection\DocBlock\Tag; use phpDocumentor\Reflection\DocBlock\Tag;
/** /**
@@ -29,13 +30,13 @@ class SeeTag extends Tag
/** /**
* Parses a tag and populates the member variables. * Parses a tag and populates the member variables.
* *
* @param string $type Tag identifier for this tag (should be 'see'). * @param string $type Tag identifier for this tag (should be 'see').
* @param string $content Contents for this tag. * @param string $content Contents for this tag.
* @param DocBlock $docblock The DocBlock which this tag belongs to.
*/ */
public function __construct($type, $content) public function __construct($type, $content, DocBlock $docblock = null)
{ {
$this->tag = $type; parent::__construct($type, $content, $docblock);
$this->content = $content;
$content = preg_split('/\s+/u', $content); $content = preg_split('/\s+/u', $content);
// any output is considered a type // any output is considered a type
src/phpDocumentor/Reflection/DocBlock/Tag/VarTag.php
+9 -6
View File
@@ -12,6 +12,9 @@
namespace phpDocumentor\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use phpDocumentor\Reflection\DocBlock;
use phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for a @var tag in a Docblock. * Reflection class for a @var tag in a Docblock.
* *
@@ -24,14 +27,14 @@ class VarTag extends ParamTag
/** /**
* Parses a tag and populates the member variables. * Parses a tag and populates the member variables.
* *
* @param string $type Tag identifier for this tag (should be 'var'). * @param string $type Tag identifier for this tag (should be 'var').
* @param string $content Contents for this tag. * @param string $content Contents for this tag.
* @param DocBlock $docblock The DocBlock which this tag belongs to.
*/ */
public function __construct($type, $content) public function __construct($type, $content, DocBlock $docblock = null)
{ {
$this->tag = $type; Tag::__construct($type, $content, $docblock);
$this->content = $content; $content = preg_split('/\s+/u', $this->description);
$content = preg_split('/\s+/u', $content);
if (count($content) == 0) { if (count($content) == 0) {
return; return;