Merge pull request #8 from boenrobot/CS

Coding standard fixes.
This commit is contained in:
Vasil Rangelov
2012-11-10 01:40:09 -08:00
28 changed files with 388 additions and 233 deletions
+33 -26
View File
@@ -2,7 +2,7 @@
/** /**
* phpDocumentor * phpDocumentor
* *
* PHP Version 5 * PHP Version 5.3
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
@@ -15,9 +15,9 @@ namespace phpDocumentor\Reflection;
/** /**
* Parses the DocBlock for any structure. * Parses the DocBlock for any structure.
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class DocBlock implements \Reflector class DocBlock implements \Reflector
{ {
@@ -25,14 +25,14 @@ class DocBlock implements \Reflector
protected $short_description = ''; protected $short_description = '';
/** /**
* @var \phpDocumentor\Reflection\DocBlock\LongDescription The actual description * @var \phpDocumentor\Reflection\DocBlock\LongDescription The actual
* for this docblock. * description for this docblock.
*/ */
protected $long_description = null; protected $long_description = null;
/** /**
* @var \phpDocumentor\Reflection\DocBlock\Tags[] An array containing all the tags * @var \phpDocumentor\Reflection\DocBlock\Tags[] An array containing all
* in this docblock; except inline. * the tags in this docblock; except inline.
*/ */
protected $tags = array(); protected $tags = array();
@@ -52,19 +52,21 @@ class DocBlock implements \Reflector
* For example the param and return tags use this to expand their type * For example the param and return tags use this to expand their type
* information. * information.
* *
* @param \Reflector|string $docblock A docblock comment (including asterisks) * @param \Reflector|string $docblock A docblock comment (including
* or reflector supporting the getDocComment method. * asterisks) or reflector supporting the getDocComment method.
* @param string $namespace The namespace where this DocBlock resides in; * @param string $namespace The namespace where this
* defaults to `\`. * DocBlock resides in; defaults to `\`.
* @param string[] $namespace_aliases a list of namespace aliases as * @param string[] $namespace_aliases A list of namespace aliases
* provided by the `use` keyword; the key of the array is the alias name * as provided by the `use` keyword; the key of the array is the alias
* or last part of the alias array if no alias name is provided. * name or last part of the alias array if no alias name is provided.
* *
* @throws \InvalidArgumentException if the given argument does not have the * @throws \InvalidArgumentException if the given argument does not have the
* getDocComment method. * getDocComment method.
*/ */
public function __construct( public function __construct(
$docblock, $namespace = '\\', $namespace_aliases = array() $docblock,
$namespace = '\\',
$namespace_aliases = array()
) { ) {
if (is_object($docblock)) { if (is_object($docblock)) {
if (!method_exists($docblock, 'getDocComment')) { if (!method_exists($docblock, 'getDocComment')) {
@@ -99,7 +101,9 @@ class DocBlock implements \Reflector
{ {
$comment = trim( $comment = trim(
preg_replace( preg_replace(
'#[ \t]*(?:\/\*\*|\*\/|\*)?[ \t]{0,1}(.*)?#u', '$1', $comment '#[ \t]*(?:\/\*\*|\*\/|\*)?[ \t]{0,1}(.*)?#u',
'$1',
$comment
) )
); );
@@ -121,7 +125,7 @@ class DocBlock implements \Reflector
* @param string $comment Comment to split into the sub-parts. * @param string $comment Comment to split into the sub-parts.
* *
* @author RichardJ Special thanks to RichardJ for the regex responsible * @author RichardJ Special thanks to RichardJ for the regex responsible
* for the split/ * for the split.
* *
* @return string[] containing the short-, long description and an element * @return string[] containing the short-, long description and an element
* containing the tags. * containing the tags.
@@ -173,7 +177,9 @@ class DocBlock implements \Reflector
) )
)? )?
(\s+ [\s\S]*)? # everything that follows (\s+ [\s\S]*)? # everything that follows
/u', $comment, $matches /u',
$comment,
$matches
); );
array_shift($matches); array_shift($matches);
} }
@@ -306,9 +312,10 @@ class DocBlock implements \Reflector
* @param string $type Type to expand into full namespaced * @param string $type Type to expand into full namespaced
* equivalent. * equivalent.
* @param string[] $ignore_keywords Whether to ignore given keywords, when * @param string[] $ignore_keywords Whether to ignore given keywords, when
* null it will use the default keywords: 'string', 'int', 'integer', * null it will use the default keywords:
* 'bool', 'boolean', 'float', 'double', 'object', 'mixed', 'array', * 'string', 'int', 'integer', 'bool', 'boolean', 'float', 'double',
* 'resource', 'void', 'null', 'callback', 'false', 'true'. * 'object', 'mixed', 'array', 'resource', 'void', 'null', 'callback',
* 'false', 'true', 'self', '$this', 'callable'.
* Default value for this parameter is null. * Default value for this parameter is null.
* *
* @return string * @return string
@@ -321,9 +328,9 @@ class DocBlock implements \Reflector
if ($ignore_keywords === null) { if ($ignore_keywords === null) {
$ignore_keywords = array( $ignore_keywords = array(
'string', 'int', 'integer', 'bool', 'boolean', 'float', 'double', 'string', 'int', 'integer', 'bool', 'boolean', 'float',
'object', 'mixed', 'array', 'resource', 'void', 'null', 'double', 'object', 'mixed', 'array', 'resource', 'void',
'callback', 'false', 'true', 'self', '$this', 'callable' 'null', 'callback', 'false', 'true', 'self', '$this', 'callable'
); );
} }
@@ -382,7 +389,7 @@ class DocBlock implements \Reflector
* *
* @return string * @return string
*/ */
static public function export() public static function export()
{ {
throw new \Exception('Not yet implemented'); throw new \Exception('Not yet implemented');
} }
@@ -15,9 +15,9 @@ namespace phpDocumentor\Reflection\DocBlock;
/** /**
* Parses a Long Description of a DocBlock. * Parses a Long Description of a DocBlock.
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class LongDescription implements \Reflector class LongDescription implements \Reflector
{ {
@@ -51,18 +51,20 @@ class LongDescription implements \Reflector
return $this->contents; return $this->contents;
} }
/* /**
* Returns the parsed text of this description. * Returns the parsed text of this description.
* *
* @return array An array of strings and tag objects, in the order they * @return array An array of strings and tag objects, in the order they
* occur within the description. * occur within the description.
*/ */
public function getParsedContents() public function getParsedContents()
{ {
if (null === $this->parsedContents) { if (null === $this->parsedContents) {
$this->parsedContents = preg_split( $this->parsedContents = preg_split(
'/\{(\@.*?)\}/uS', $this->contents, '/\{(\@.*?)\}/uS',
null, PREG_SPLIT_DELIM_CAPTURE $this->contents,
null,
PREG_SPLIT_DELIM_CAPTURE
); );
for ($i=1, $l = count($this->parsedContents); $i<$l; $i += 2) { for ($i=1, $l = count($this->parsedContents); $i<$l; $i += 2) {
$this->parsedContents[$i] = Tag::createInstance( $this->parsedContents[$i] = Tag::createInstance(
@@ -97,8 +99,8 @@ class LongDescription implements \Reflector
} }
if (class_exists('dflydev\markdown\MarkdownExtraParser')) { if (class_exists('dflydev\markdown\MarkdownExtraParser')) {
$md = new \dflydev\markdown\MarkdownExtraParser(); $markdown = new \dflydev\markdown\MarkdownExtraParser();
$result = $md->transformMarkdown($result); $result = $markdown->transformMarkdown($result);
} }
return trim($result); return trim($result);
@@ -107,11 +109,12 @@ class LongDescription implements \Reflector
/** /**
* Builds a string representation of this object. * Builds a string representation of this object.
* *
* @todo determine the exact format as used by PHP Reflection and implement it. * @todo determine the exact format as used by PHP Reflection
* and implement it.
* *
* @return void * @return void
*/ */
static public function export() public static function export()
{ {
throw new \Exception('Not yet implemented'); throw new \Exception('Not yet implemented');
} }
@@ -126,4 +129,4 @@ class LongDescription implements \Reflector
{ {
return 'Not yet implemented'; return 'Not yet implemented';
} }
} }
+15 -12
View File
@@ -2,7 +2,7 @@
/** /**
* phpDocumentor * phpDocumentor
* *
* PHP Version 5 * PHP Version 5.3
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
@@ -15,9 +15,9 @@ namespace phpDocumentor\Reflection\DocBlock;
/** /**
* Parses a tag definition for a DocBlock. * Parses a tag definition for a DocBlock.
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class Tag implements \Reflector class Tag implements \Reflector
{ {
@@ -29,7 +29,7 @@ class Tag implements \Reflector
/** @var string Description of the content of this tag */ /** @var string Description of the content of this tag */
protected $description = ''; protected $description = '';
/** @var array The description, as an array of strings and Tag objects. */ /** @var array The description, as an array of strings and Tag objects. */
protected $parsedDescription = null; protected $parsedDescription = null;
@@ -51,7 +51,9 @@ class Tag implements \Reflector
public static function createInstance($tag_line) public static function createInstance($tag_line)
{ {
if (!preg_match( if (!preg_match(
'/^@([\w\-\_\\\\]+)(?:\s*([^\s].*)|$)?/us', $tag_line, $matches '/^@([\w\-\_\\\\]+)(?:\s*([^\s].*)|$)?/us',
$tag_line,
$matches
)) { )) {
throw new \InvalidArgumentException( throw new \InvalidArgumentException(
'Invalid tag_line detected: ' . $tag_line 'Invalid tag_line detected: ' . $tag_line
@@ -60,7 +62,9 @@ class Tag implements \Reflector
// support hypphen separated tag names // support hypphen separated tag names
$tag_name = str_replace( $tag_name = str_replace(
' ', '', ucwords(str_replace('-', ' ', $matches[1])) ' ',
'',
ucwords(str_replace('-', ' ', $matches[1]))
).'Tag'; ).'Tag';
$class_name = 'phpDocumentor\\Reflection\\DocBlock\\Tag\\' . $tag_name; $class_name = 'phpDocumentor\\Reflection\\DocBlock\\Tag\\' . $tag_name;
@@ -111,12 +115,12 @@ class Tag implements \Reflector
{ {
return $this->description; return $this->description;
} }
/* /**
* Returns the parsed text of this description. * Returns the parsed text of this description.
* *
* @return array An array of strings and tag objects, in the order they * @return array An array of strings and tag objects, in the order they
* occur within the description. * occur within the description.
*/ */
public function getParsedDescription() public function getParsedDescription()
{ {
@@ -170,7 +174,7 @@ class Tag implements \Reflector
* *
* @return void * @return void
*/ */
static public function export() public static function export()
{ {
throw new \Exception('Not yet implemented'); throw new \Exception('Not yet implemented');
} }
@@ -185,5 +189,4 @@ class Tag implements \Reflector
{ {
return 'Not yet implemented'; return 'Not yet implemented';
} }
} }
@@ -2,9 +2,9 @@
/** /**
* phpDocumentor * phpDocumentor
* *
* PHP Version 5 * PHP Version 5.3
* *
* @author Mike van Riel <mike.vanriel@naenius.com> * @author Vasil Rangelov <boen.robot@gmail.com>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
@@ -17,18 +17,18 @@ use phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for an @author tag in a Docblock. * Reflection class for an @author tag in a Docblock.
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class AuthorTag extends Tag class AuthorTag extends Tag
{ {
/** @var string The name of the author */ /** @var string The name of the author */
protected $name = ''; protected $name = '';
/** @var string The email of the author */ /** @var string The email of the author */
protected $email = ''; protected $email = '';
/** /**
* Parses a tag and populates the member variables. * Parses a tag and populates the member variables.
* *
@@ -45,7 +45,7 @@ class AuthorTag extends Tag
} }
} }
} }
/** /**
* Gets the author's name. * Gets the author's name.
* *
@@ -55,7 +55,7 @@ class AuthorTag extends Tag
{ {
return $this->name; return $this->name;
} }
/** /**
* Gets the author's email. * Gets the author's email.
* *
@@ -2,7 +2,7 @@
/** /**
* phpDocumentor * phpDocumentor
* *
* PHP Version 5 * PHP Version 5.3
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
@@ -15,11 +15,10 @@ namespace phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for a @covers tag in a Docblock. * Reflection class for a @covers tag in a Docblock.
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class CoversTag extends SeeTag class CoversTag extends SeeTag
{ {
} }
@@ -2,7 +2,7 @@
/** /**
* phpDocumentor * phpDocumentor
* *
* PHP Version 5 * PHP Version 5.3
* *
* @author Ben Selby <[email protected]> * @author Ben Selby <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
@@ -11,14 +11,15 @@
*/ */
namespace phpDocumentor\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use phpDocumentor\Reflection\DocBlock\Tag; use phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for a @link tag in a Docblock. * Reflection class for a @link tag in a Docblock.
* *
* @author Ben Selby <[email protected]> * @author Ben Selby <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class LinkTag extends Tag class LinkTag extends Tag
{ {
@@ -2,7 +2,7 @@
/** /**
* phpDocumentor * phpDocumentor
* *
* PHP Version 5 * PHP Version 5.3
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
@@ -15,9 +15,9 @@ namespace phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for a {@method} in a Docblock. * Reflection class for a {@method} in a Docblock.
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class MethodTag extends ParamTag class MethodTag extends ParamTag
{ {
@@ -49,8 +49,8 @@ class MethodTag extends ParamTag
// until a ) and whitespace : as method name with signature // until a ) and whitespace : as method name with signature
// 5. any remaining text : as description // 5. any remaining text : as description
if (preg_match( if (preg_match(
'/^[\s]*(?:([\w\|_\\\\]+)[\s]+)?(?:[\w_]+\(\)[\s]+)?([\w\|_\\\\]+)\(([^\)]*)\)' '/^[\s]*(?:([\w\|_\\\\]+)[\s]+)?(?:[\w_]+\(\)[\s]+)?([\w\|_\\\\]+)'
.'[\s]*(.*)/u', .'\(([^\)]*)\)[\s]*(.*)/u',
$content, $content,
$matches $matches
)) { )) {
@@ -61,8 +61,7 @@ class MethodTag extends ParamTag
$this->arguments, $this->arguments,
$this->description $this->description
) = $matches; ) = $matches;
if (!$this->type) if (!$this->type) {
{
$this->type = 'void'; $this->type = 'void';
} }
} else { } else {
@@ -126,5 +125,4 @@ class MethodTag extends ParamTag
return $arguments; return $arguments;
} }
} }
@@ -2,7 +2,7 @@
/** /**
* phpDocumentor * phpDocumentor
* *
* PHP Version 5 * PHP Version 5.3
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
@@ -11,14 +11,15 @@
*/ */
namespace phpDocumentor\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use phpDocumentor\Reflection\DocBlock\Tag; use phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for a {@param} tag in a Docblock. * Reflection class for a {@param} tag in a Docblock.
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class ParamTag extends Tag class ParamTag extends Tag
{ {
@@ -43,12 +44,18 @@ class ParamTag extends Tag
$content = preg_split('/\s+/u', $content); $content = preg_split('/\s+/u', $content);
// if the first item that is encountered is not a variable; it is a type // if the first item that is encountered is not a variable; it is a type
if (isset($content[0]) && (strlen($content[0]) > 0) && ($content[0][0] !== '$')) { if (isset($content[0])
&& (strlen($content[0]) > 0)
&& ($content[0][0] !== '$')
) {
$this->type = array_shift($content); $this->type = array_shift($content);
} }
// if the next item starts with a $ it must be the variable name // if the next item starts with a $ it must be the variable name
if (isset($content[0]) && (strlen($content[0]) > 0) && ($content[0][0] == '$')) { if (isset($content[0])
&& (strlen($content[0]) > 0)
&& ($content[0][0] == '$')
) {
$this->variableName = array_shift($content); $this->variableName = array_shift($content);
} }
@@ -2,7 +2,7 @@
/** /**
* phpDocumentor * phpDocumentor
* *
* PHP Version 5 * PHP Version 5.3
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
@@ -15,11 +15,10 @@ namespace phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for a {@property} tag in a Docblock. * Reflection class for a {@property} tag in a Docblock.
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class PropertyReadTag extends PropertyTag class PropertyReadTag extends PropertyTag
{ {
} }
@@ -2,7 +2,7 @@
/** /**
* phpDocumentor * phpDocumentor
* *
* PHP Version 5 * PHP Version 5.3
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
@@ -15,11 +15,10 @@ namespace phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for a {@property} tag in a Docblock. * Reflection class for a {@property} tag in a Docblock.
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class PropertyTag extends ParamTag class PropertyTag extends ParamTag
{ {
} }
@@ -2,7 +2,7 @@
/** /**
* phpDocumentor * phpDocumentor
* *
* PHP Version 5 * PHP Version 5.3
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
@@ -15,11 +15,10 @@ namespace phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for a {@property} tag in a Docblock. * Reflection class for a {@property} tag in a Docblock.
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class PropertyWriteTag extends PropertyTag class PropertyWriteTag extends PropertyTag
{ {
} }
@@ -2,7 +2,7 @@
/** /**
* phpDocumentor * phpDocumentor
* *
* PHP Version 5 * PHP Version 5.3
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
@@ -15,9 +15,9 @@ namespace phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for a {@return} tag in a Docblock. * Reflection class for a {@return} tag in a Docblock.
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class ReturnTag extends ParamTag class ReturnTag extends ParamTag
{ {
@@ -42,5 +42,4 @@ class ReturnTag extends ParamTag
$this->description = implode(' ', $content); $this->description = implode(' ', $content);
} }
} }
@@ -2,7 +2,7 @@
/** /**
* phpDocumentor * phpDocumentor
* *
* PHP Version 5 * PHP Version 5.3
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
@@ -11,14 +11,15 @@
*/ */
namespace phpDocumentor\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use phpDocumentor\Reflection\DocBlock\Tag; use phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for a {@see} tag in a Docblock. * Reflection class for a {@see} tag in a Docblock.
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class SeeTag extends Tag class SeeTag extends Tag
{ {
@@ -52,5 +53,4 @@ class SeeTag extends Tag
{ {
return $this->refers; return $this->refers;
} }
} }
@@ -2,7 +2,7 @@
/** /**
* phpDocumentor * phpDocumentor
* *
* PHP Version 5 * PHP Version 5.3
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
@@ -17,9 +17,9 @@ namespace phpDocumentor\Reflection\DocBlock\Tag;
* *
* This is a very common error, so @throw is aliased to be @throws * This is a very common error, so @throw is aliased to be @throws
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class ThrowTag extends ThrowsTag class ThrowTag extends ThrowsTag
{ {
@@ -40,4 +40,4 @@ class ThrowTag extends ThrowsTag
parent::__construct('throws', $content); parent::__construct('throws', $content);
} }
} }
@@ -2,7 +2,7 @@
/** /**
* phpDocumentor * phpDocumentor
* *
* PHP Version 5 * PHP Version 5.3
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
@@ -15,11 +15,10 @@ namespace phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for a {@throws} tag in a Docblock. * Reflection class for a {@throws} tag in a Docblock.
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class ThrowsTag extends ReturnTag class ThrowsTag extends ReturnTag
{ {
}
}
@@ -2,7 +2,7 @@
/** /**
* phpDocumentor * phpDocumentor
* *
* PHP Version 5 * PHP Version 5.3
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
@@ -15,11 +15,10 @@ namespace phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for a {@uses} tag in a Docblock. * Reflection class for a {@uses} tag in a Docblock.
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class UsesTag extends SeeTag class UsesTag extends SeeTag
{ {
} }
@@ -2,7 +2,7 @@
/** /**
* phpDocumentor * phpDocumentor
* *
* PHP Version 5 * PHP Version 5.3
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
@@ -15,9 +15,9 @@ namespace phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for a {@var} tag in a Docblock. * Reflection class for a {@var} tag in a Docblock.
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class VarTag extends ParamTag class VarTag extends ParamTag
{ {
@@ -1,6 +1,25 @@
<?php <?php
/**
* phpDocumentor
*
* PHP Version 5.3
*
* @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/
namespace phpDocumentor\Reflection\DocBlock\Type; namespace phpDocumentor\Reflection\DocBlock\Type;
/**
* Collection
*
* @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/
class Collection extends \ArrayObject class Collection extends \ArrayObject
{ {
/** @var string Definition of the OR operator for types */ /** @var string Definition of the OR operator for types */
@@ -49,7 +68,8 @@ class Collection extends \ArrayObject
* pairs that are used in the resolving process. * pairs that are used in the resolving process.
*/ */
public function __construct( public function __construct(
array $types = array(), $namespace = null, array $types = array(),
$namespace = null,
array $namespace_aliases = array() array $namespace_aliases = array()
) { ) {
// only set the namespace if overridden // only set the namespace if overridden
@@ -58,7 +78,7 @@ class Collection extends \ArrayObject
} }
$this->namespace_aliases = $namespace_aliases; $this->namespace_aliases = $namespace_aliases;
foreach($types as $type) { foreach ($types as $type) {
$this->add($type); $this->add($type);
} }
} }
@@ -150,7 +170,7 @@ class Collection extends \ArrayObject
// separate the type by the OR operator // separate the type by the OR operator
$type_parts = explode(self::OPERATOR_OR, $type); $type_parts = explode(self::OPERATOR_OR, $type);
foreach($type_parts as $part) { foreach ($type_parts as $part) {
$expanded_type = $this->expand($part); $expanded_type = $this->expand($part);
if ($expanded_type) { if ($expanded_type) {
$this[] = $expanded_type; $this[] = $expanded_type;
@@ -168,12 +188,12 @@ class Collection extends \ArrayObject
* This method only works as expected if the namespace and aliases are set; * This method only works as expected if the namespace and aliases are set;
* no dynamic reflection is being performed here. * no dynamic reflection is being performed here.
* *
* @param string $type The relative or absolute type.
*
* @uses getNamespace to determine with what to prefix the type name. * @uses getNamespace to determine with what to prefix the type name.
* @uses getNamespaceAliases to check whether the first part of the relative * @uses getNamespaceAliases to check whether the first part of the relative
* type name should not be replaced with another namespace. * type name should not be replaced with another namespace.
* *
* @param string $type The relative or absolute type.
*
* @return string * @return string
*/ */
protected function expand($type) protected function expand($type)
@@ -245,4 +265,4 @@ class Collection extends \ArrayObject
return ($type[0] !== self::OPERATOR_NAMESPACE) return ($type[0] !== self::OPERATOR_NAMESPACE)
|| $this->isTypeAKeyword($type); || $this->isTypeAKeyword($type);
} }
} }
@@ -1,24 +1,30 @@
<?php <?php
/** /**
* phpDocumentor Covers Tag Test * phpDocumentor Covers Tag Test
*
* PHP version 5.3
* *
* @author Daniel O'Connor <[email protected]> * @author Daniel O'Connor <[email protected]>
* @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/ */
namespace phpDocumentor\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Test class for phpDocumentor_Reflection_DocBlock_Tag_Covers * Test class for \phpDocumentor\Reflection\DocBlock\Tag\CoversTag
* *
* @author Daniel O'Connor <[email protected]> * @author Daniel O'Connor <[email protected]>
* @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/ */
class CoversTagTest extends \PHPUnit_Framework_TestCase class CoversTagTest extends \PHPUnit_Framework_TestCase
{ {
/** /**
* Test that the \phpDocumentor\Reflection\DocBlock\Tag\Covers can create a link * Test that the \phpDocumentor\Reflection\DocBlock\Tag\CoversTag can create
* for the covers doc block * a link for the covers doc block.
* *
* @param string $type * @param string $type
* @param string $content * @param string $content
@@ -32,9 +38,13 @@ class CoversTagTest extends \PHPUnit_Framework_TestCase
* @return void * @return void
*/ */
public function testConstructorParesInputsIntoCorrectFields( public function testConstructorParesInputsIntoCorrectFields(
$type, $content, $exName, $exContent, $exDescription, $exReference $type,
) $content,
{ $exName,
$exContent,
$exDescription,
$exReference
) {
$tag = new CoversTag($type, $content); $tag = new CoversTag($type, $content);
$actualName = $tag->getName(); $actualName = $tag->getName();
@@ -1,9 +1,13 @@
<?php <?php
/** /**
* phpDocumentor Link Tag Test * phpDocumentor Link Tag Test
*
* PHP version 5.3
* *
* @author Ben Selby <[email protected]> * @author Ben Selby <[email protected]>
* @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/ */
namespace phpDocumentor\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
@@ -11,8 +15,10 @@ namespace phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Test class for \phpDocumentor\Reflection\DocBlock\Tag\LinkTag * Test class for \phpDocumentor\Reflection\DocBlock\Tag\LinkTag
* *
* @author Ben Selby <[email protected]> * @author Ben Selby <[email protected]>
* @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/ */
class LinkTagTest extends \PHPUnit_Framework_TestCase class LinkTagTest extends \PHPUnit_Framework_TestCase
{ {
@@ -33,9 +39,13 @@ class LinkTagTest extends \PHPUnit_Framework_TestCase
* @return void * @return void
*/ */
public function testConstructorParesInputsIntoCorrectFields( public function testConstructorParesInputsIntoCorrectFields(
$type, $content, $exName, $exContent, $exDescription, $exLink $type,
) $content,
{ $exName,
$exContent,
$exDescription,
$exLink
) {
$tag = new LinkTag($type, $content); $tag = new LinkTag($type, $content);
$actualName = $tag->getName(); $actualName = $tag->getName();
@@ -84,4 +94,4 @@ class LinkTagTest extends \PHPUnit_Framework_TestCase
), ),
); );
} }
} }
@@ -1,9 +1,13 @@
<?php <?php
/** /**
* phpDocumentor Method Tag Test * phpDocumentor Method Tag Test
*
* PHP version 5.3
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/ */
namespace phpDocumentor\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
@@ -11,14 +15,14 @@ namespace phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Test class for \phpDocumentor\Reflection\DocBlock\Tag\MethodTag * Test class for \phpDocumentor\Reflection\DocBlock\Tag\MethodTag
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/ */
class MethodTagTest extends \PHPUnit_Framework_TestCase class MethodTagTest extends \PHPUnit_Framework_TestCase
{ {
/** /**
* @dataProvider getTestSignatures
*
* @param string $signature The signature to test * @param string $signature The signature to test
* @param bool $valid Whether the given signature is expected to * @param bool $valid Whether the given signature is expected to
* be valid. * be valid.
@@ -29,28 +33,39 @@ class MethodTagTest extends \PHPUnit_Framework_TestCase
* @param bool $has_params whether this signature features parameters. * @param bool $has_params whether this signature features parameters.
* @param string $description The short description mentioned in the * @param string $description The short description mentioned in the
* signature. * signature.
*
* @dataProvider getTestSignatures
* *
* @return void * @return void
*/ */
public function testConstruct($signature, $valid, $expected_name, public function testConstruct(
$expected_return, $has_params, $description) $signature,
{ $valid,
$expected_name,
$expected_return,
$has_params,
$description
) {
ob_start(); ob_start();
$tag = new MethodTag('method', $signature); $tag = new MethodTag('method', $signature);
$stdout = ob_get_clean(); $stdout = ob_get_clean();
$this->assertSame( $this->assertSame(
$valid, empty($stdout), $valid,
empty($stdout),
'No error should have been output if the signature is valid' 'No error should have been output if the signature is valid'
); );
if (!$valid) return; if (!$valid) {
return;
}
$this->assertEquals($expected_name, $tag->getMethodName()); $this->assertEquals($expected_name, $tag->getMethodName());
$this->assertEquals($expected_return, $tag->getType()); $this->assertEquals($expected_return, $tag->getType());
$this->assertEquals($description, $tag->getDescription()); $this->assertEquals($description, $tag->getDescription());
$this->assertSame( $this->assertSame(
$has_params, (bool)(count($tag->getArguments()) > 0), $has_params,
(bool)(count($tag->getArguments()) > 0),
'Number of found arguments should exceed 0' 'Number of found arguments should exceed 0'
); );
} }
@@ -112,4 +127,4 @@ class MethodTagTest extends \PHPUnit_Framework_TestCase
), ),
); );
} }
} }
@@ -1,18 +1,24 @@
<?php <?php
/** /**
* phpDocumentor Param tag test. * phpDocumentor Param tag test.
*
* PHP version 5.3
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/ */
namespace phpDocumentor\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Test class for phpDocumentor_Reflection_DocBlock_Param. * Test class for \phpDocumentor\Reflection\DocBlock\ParamTag.
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/ */
class ParamTagTest extends \PHPUnit_Framework_TestCase class ParamTagTest extends \PHPUnit_Framework_TestCase
{ {
@@ -22,9 +28,9 @@ class ParamTagTest extends \PHPUnit_Framework_TestCase
* *
* @param string $type * @param string $type
* @param string $content * @param string $content
* @param string $extracted_type * @param string $extractedType
* @param string $extracted_variable_name * @param string $extractedVarName
* @param string $extracted_description * @param string $extractedDescription
* *
* @covers \phpDocumentor\Reflection\DocBlock\Tag\ParamTag::__construct * @covers \phpDocumentor\Reflection\DocBlock\Tag\ParamTag::__construct
* *
@@ -33,14 +39,17 @@ class ParamTagTest extends \PHPUnit_Framework_TestCase
* @return void * @return void
*/ */
public function testConstructorParsesInputsIntoCorrectFields( public function testConstructorParsesInputsIntoCorrectFields(
$type, $content, $extracted_type, $extracted_variable_name, $type,
$extracted_description $content,
$extractedType,
$extractedVarName,
$extractedDescription
) { ) {
$tag = new ParamTag($type, $content); $tag = new ParamTag($type, $content);
$this->assertEquals($extracted_type, $tag->getTypes()); $this->assertEquals($extractedType, $tag->getTypes());
$this->assertEquals($extracted_variable_name, $tag->getVariableName()); $this->assertEquals($extractedVarName, $tag->getVariableName());
$this->assertEquals($extracted_description, $tag->getDescription()); $this->assertEquals($extractedDescription, $tag->getDescription());
} }
/** /**
@@ -1,18 +1,24 @@
<?php <?php
/** /**
* phpDocumentor Return tag test. * phpDocumentor Return tag test.
*
* PHP version 5.3
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/ */
namespace phpDocumentor\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Test class for phpDocumentor_Reflection_DocBlock_ReturnTag. * Test class for \phpDocumentor\Reflection\DocBlock\ReturnTag.
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/ */
class ReturnTagTest extends ParamTagTest class ReturnTagTest extends ParamTagTest
{ {
@@ -21,8 +27,8 @@ class ReturnTagTest extends ParamTagTest
* understand the Return DocBlock. * understand the Return DocBlock.
* *
* @param string $content * @param string $content
* @param string $extracted_type * @param string $extractedType
* @param string $extracted_description * @param string $extractedDescription
* *
* @covers \phpDocumentor\Reflection\DocBlock\Tag\ReturnTag::__construct * @covers \phpDocumentor\Reflection\DocBlock\Tag\ReturnTag::__construct
* *
@@ -31,12 +37,14 @@ class ReturnTagTest extends ParamTagTest
* @return void * @return void
*/ */
public function testConstructorParsesInputsIntoCorrectFields( public function testConstructorParsesInputsIntoCorrectFields(
$content, $extracted_type, $extracted_description $content,
$extractedType,
$extractedDescription
) { ) {
$tag = new ReturnTag('return', $content); $tag = new ReturnTag('return', $content);
$this->assertEquals($extracted_type, $tag->getTypes()); $this->assertEquals($extractedType, $tag->getTypes());
$this->assertEquals($extracted_description, $tag->getDescription()); $this->assertEquals($extractedDescription, $tag->getDescription());
} }
/** /**
@@ -1,18 +1,24 @@
<?php <?php
/** /**
* phpDocumentor See Tag Test * phpDocumentor See Tag Test
*
* PHP version 5.3
* *
* @author Daniel O'Connor <[email protected]> * @author Daniel O'Connor <[email protected]>
* @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/ */
namespace phpDocumentor\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Test class for phpDocumentor_Reflection_DocBlock_Tag_See * Test class for \phpDocumentor\Reflection\DocBlock\Tag\SeeTag
* *
* @author Daniel O'Connor <[email protected]> * @author Daniel O'Connor <[email protected]>
* @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/ */
class SeeTagTest extends \PHPUnit_Framework_TestCase class SeeTagTest extends \PHPUnit_Framework_TestCase
{ {
@@ -32,9 +38,13 @@ class SeeTagTest extends \PHPUnit_Framework_TestCase
* @return void * @return void
*/ */
public function testConstructorParesInputsIntoCorrectFields( public function testConstructorParesInputsIntoCorrectFields(
$type, $content, $exName, $exContent, $exDescription, $exReference $type,
) $content,
{ $exName,
$exContent,
$exDescription,
$exReference
) {
$tag = new SeeTag($type, $content); $tag = new SeeTag($type, $content);
$actualName = $tag->getName(); $actualName = $tag->getName();
@@ -1,18 +1,24 @@
<?php <?php
/** /**
* phpDocumentor Uses Tag Test * phpDocumentor Uses Tag Test
*
* PHP version 5.3
* *
* @author Daniel O'Connor <[email protected]> * @author Daniel O'Connor <[email protected]>
* @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/ */
namespace phpDocumentor\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Test class for phpDocumentor_Reflection_DocBlock_Tag_Uses * Test class for \phpDocumentor\Reflection\DocBlock\Tag\UsesTag
* *
* @author Daniel O'Connor <[email protected]> * @author Daniel O'Connor <[email protected]>
* @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/ */
class UsesTagTest extends \PHPUnit_Framework_TestCase class UsesTagTest extends \PHPUnit_Framework_TestCase
{ {
@@ -32,9 +38,13 @@ class UsesTagTest extends \PHPUnit_Framework_TestCase
* @return void * @return void
*/ */
public function testConstructorParesInputsIntoCorrectFields( public function testConstructorParesInputsIntoCorrectFields(
$type, $content, $exName, $exContent, $exDescription, $exReference $type,
) $content,
{ $exName,
$exContent,
$exDescription,
$exReference
) {
$tag = new UsesTag($type, $content); $tag = new UsesTag($type, $content);
$actualName = $tag->getName(); $actualName = $tag->getName();
@@ -1,24 +1,30 @@
<?php <?php
/** /**
* phpDocumentor Var Tag Test * phpDocumentor Var Tag Test
*
* PHP version 5.3
* *
* @author Daniel O'Connor <[email protected]> * @author Daniel O'Connor <[email protected]>
* @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/ */
namespace phpDocumentor\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Test class for phpDocumentor_Reflection_DocBlock_Tag_Link * Test class for \phpDocumentor\Reflection\DocBlock\Tag\VarTag
* *
* @author Daniel O'Connor <[email protected]> * @author Daniel O'Connor <[email protected]>
* @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/ */
class VarTagTest extends \PHPUnit_Framework_TestCase class VarTagTest extends \PHPUnit_Framework_TestCase
{ {
/** /**
* Test that the \phpDocumentor\Reflection\DocBlock\Tag\VarTag can understand * Test that the \phpDocumentor\Reflection\DocBlock\Tag\VarTag can
* the @var doc block * understand the @var doc block
* *
* @param string $type * @param string $type
* @param string $content * @param string $content
@@ -32,14 +38,17 @@ class VarTagTest extends \PHPUnit_Framework_TestCase
* @return void * @return void
*/ */
public function testConstructorParesInputsIntoCorrectFields( public function testConstructorParesInputsIntoCorrectFields(
$type, $content, $exType, $exVariable, $exDescription $type,
) $content,
{ $exType,
$exVariable,
$exDescription
) {
$tag = new VarTag($type, $content); $tag = new VarTag($type, $content);
$this->assertEquals($exType, $tag->getType()); $this->assertEquals($exType, $tag->getType());
$this->assertEquals($exVariable, $tag->getVariableName()); $this->assertEquals($exVariable, $tag->getVariableName());
$this->assertEquals($exDescription, $tag->getDescription()); $this->assertEquals($exDescription, $tag->getDescription());
} }
/** /**
@@ -1,9 +1,26 @@
<?php <?php
/**
* phpDocumentor Collection Test
*
* PHP version 5.3
*
* @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/
namespace phpDocumentor\Reflection\DocBlock\Type; namespace phpDocumentor\Reflection\DocBlock\Type;
/** /**
* Test class for phpDocumentor_Reflection_DocBlock * Test class for \phpDocumentor\Reflection\DocBlock\Type\Collection
*
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection * @covers phpDocumentor\Reflection\DocBlock\Type\Collection
*
* @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/ */
class CollectionTest extends \PHPUnit_Framework_TestCase class CollectionTest extends \PHPUnit_Framework_TestCase
{ {
@@ -11,6 +28,8 @@ class CollectionTest extends \PHPUnit_Framework_TestCase
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection::__construct * @covers phpDocumentor\Reflection\DocBlock\Type\Collection::__construct
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection::getNamespace * @covers phpDocumentor\Reflection\DocBlock\Type\Collection::getNamespace
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection::getNamespaceAliases * @covers phpDocumentor\Reflection\DocBlock\Type\Collection::getNamespaceAliases
*
* @return void
*/ */
public function testConstruct() public function testConstruct()
{ {
@@ -22,6 +41,8 @@ class CollectionTest extends \PHPUnit_Framework_TestCase
/** /**
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection::__construct * @covers phpDocumentor\Reflection\DocBlock\Type\Collection::__construct
*
* @return void
*/ */
public function testConstructWithTypes() public function testConstructWithTypes()
{ {
@@ -32,6 +53,8 @@ class CollectionTest extends \PHPUnit_Framework_TestCase
/** /**
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection::__construct * @covers phpDocumentor\Reflection\DocBlock\Type\Collection::__construct
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection::getNamespace * @covers phpDocumentor\Reflection\DocBlock\Type\Collection::getNamespace
*
* @return void
*/ */
public function testConstructWithNamespace() public function testConstructWithNamespace()
{ {
@@ -48,6 +71,8 @@ class CollectionTest extends \PHPUnit_Framework_TestCase
/** /**
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection::__construct * @covers phpDocumentor\Reflection\DocBlock\Type\Collection::__construct
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection::getNamespaceAliases * @covers phpDocumentor\Reflection\DocBlock\Type\Collection::getNamespaceAliases
*
* @return void
*/ */
public function testConstructWithNamespaceAliases() public function testConstructWithNamespaceAliases()
{ {
@@ -59,6 +84,8 @@ class CollectionTest extends \PHPUnit_Framework_TestCase
/** /**
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection::setNamespace * @covers phpDocumentor\Reflection\DocBlock\Type\Collection::setNamespace
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection::getNamespace * @covers phpDocumentor\Reflection\DocBlock\Type\Collection::getNamespace
*
* @return void
*/ */
public function testSetAndGetNamespace() public function testSetAndGetNamespace()
{ {
@@ -78,6 +105,8 @@ class CollectionTest extends \PHPUnit_Framework_TestCase
/** /**
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection::setNamespaceAliases * @covers phpDocumentor\Reflection\DocBlock\Type\Collection::setNamespaceAliases
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection::getNamespaceAliases * @covers phpDocumentor\Reflection\DocBlock\Type\Collection::getNamespaceAliases
*
* @return void
*/ */
public function testSetAndGetNamespaceAliases() public function testSetAndGetNamespaceAliases()
{ {
@@ -94,6 +123,8 @@ class CollectionTest extends \PHPUnit_Framework_TestCase
* *
* @dataProvider provideTypesToExpand * @dataProvider provideTypesToExpand
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection::add * @covers phpDocumentor\Reflection\DocBlock\Type\Collection::add
*
* @return void
*/ */
public function testAdd($fixture, $expected) public function testAdd($fixture, $expected)
{ {
@@ -111,6 +142,8 @@ class CollectionTest extends \PHPUnit_Framework_TestCase
* *
* @dataProvider provideTypesToExpandWithoutNamespace * @dataProvider provideTypesToExpandWithoutNamespace
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection::add * @covers phpDocumentor\Reflection\DocBlock\Type\Collection::add
*
* @return void
*/ */
public function testAddWithoutNamespace($fixture, $expected) public function testAddWithoutNamespace($fixture, $expected)
{ {
@@ -124,6 +157,8 @@ class CollectionTest extends \PHPUnit_Framework_TestCase
/** /**
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection::add * @covers phpDocumentor\Reflection\DocBlock\Type\Collection::add
* @expectedException InvalidArgumentException * @expectedException InvalidArgumentException
*
* @return void
*/ */
public function testAddWithInvalidArgument() public function testAddWithInvalidArgument()
{ {
@@ -135,7 +170,7 @@ class CollectionTest extends \PHPUnit_Framework_TestCase
* Returns the types and their expected values to test the retrieval of * Returns the types and their expected values to test the retrieval of
* types. * types.
* *
* @param string $method Name of the method consuming this data provider. * @param string $method Name of the method consuming this data provider.
* @param string $namespace Name of the namespace to user as basis. * @param string $namespace Name of the namespace to user as basis.
* *
* @return string[] * @return string[]
@@ -181,7 +216,6 @@ class CollectionTest extends \PHPUnit_Framework_TestCase
* types when no namespace is available. * types when no namespace is available.
* *
* @param string $method Name of the method consuming this data provider. * @param string $method Name of the method consuming this data provider.
* @param string $namespace Name of the namespace to user as basis.
* *
* @return string[] * @return string[]
*/ */
@@ -189,6 +223,4 @@ class CollectionTest extends \PHPUnit_Framework_TestCase
{ {
return $this->provideTypesToExpand($method, '\\'); return $this->provideTypesToExpand($method, '\\');
} }
} }
+22 -12
View File
@@ -2,10 +2,12 @@
/** /**
* phpDocumentor DocBlock Test * phpDocumentor DocBlock Test
* *
* PHP Version 5 * PHP Version 5.3
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/ */
namespace phpDocumentor\Reflection; namespace phpDocumentor\Reflection;
@@ -13,8 +15,10 @@ namespace phpDocumentor\Reflection;
/** /**
* Test class for phpDocumentor_Reflection_DocBlock * Test class for phpDocumentor_Reflection_DocBlock
* *
* @author Mike van Riel <[email protected]> * @author Mike van Riel <[email protected]>
* @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/ */
class DocBlockTest extends \PHPUnit_Framework_TestCase class DocBlockTest extends \PHPUnit_Framework_TestCase
{ {
@@ -32,7 +36,8 @@ class DocBlockTest extends \PHPUnit_Framework_TestCase
DOCBLOCK; DOCBLOCK;
$object = new DocBlock($fixture); $object = new DocBlock($fixture);
$this->assertEquals( $this->assertEquals(
'This is a short description.', $object->getShortDescription() 'This is a short description.',
$object->getShortDescription()
); );
$this->assertEquals( $this->assertEquals(
'This is a long description.', 'This is a long description.',
@@ -53,11 +58,13 @@ DOCBLOCK;
DOCBLOCK; DOCBLOCK;
$object = new DocBlock($fixture); $object = new DocBlock($fixture);
$this->assertEquals( $this->assertEquals(
'This is a short description.', $object->getShortDescription() 'This is a short description.',
$object->getShortDescription()
); );
$this->assertEquals( $this->assertEquals(
"This is a long description.\nThis is a continuation of the long " "This is a long description.\nThis is a continuation of the long "
."description.", $object->getLongDescription()->getContents() ."description.",
$object->getLongDescription()->getContents()
); );
} }
@@ -99,17 +106,21 @@ DOCBLOCK;
public function testExpandTypeUsingNamespaceAlias() public function testExpandTypeUsingNamespaceAlias()
{ {
$docblock = new DocBlock( $docblock = new DocBlock(
'', '\My\Namespace', array('Alias' => '\My\Namespace\Alias') '',
'\My\Namespace',
array('Alias' => '\My\Namespace\Alias')
); );
// first try a normal resolution without alias // first try a normal resolution without alias
$this->assertEquals( $this->assertEquals(
'\My\Namespace\Al', $docblock->expandType('Al') '\My\Namespace\Al',
$docblock->expandType('Al')
); );
// try to use the alias // try to use the alias
$this->assertEquals( $this->assertEquals(
'\My\Namespace\Alias\Al', $docblock->expandType('Alias\Al') '\My\Namespace\Alias\Al',
$docblock->expandType('Alias\Al')
); );
} }
@@ -141,4 +152,3 @@ DOCBLOCK;
); );
} }
} }