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

Merge pull request #8 from boenrobot/CS

Browse Source 
Coding standard fixes.
This commit is contained in:
Vasil Rangelov
2012-11-10 01:40:09 -08:00
parent 0701e60839 df67eaf0be
commit 36b46b9769
28 changed files with 388 additions and 233 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/phpDocumentor/Reflection/DocBlock.php
+30 -23
View File
@@ -2,7 +2,7 @@
/**
* phpDocumentor
*
* PHP Version 5
* PHP Version 5.3
*
* @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
@@ -25,14 +25,14 @@ class DocBlock implements \Reflector
protected $short_description = '';
/**
* @var \phpDocumentor\Reflection\DocBlock\LongDescription The actual description
* for this docblock.
* @var \phpDocumentor\Reflection\DocBlock\LongDescription The actual
* description for this docblock.
*/
protected $long_description = null;
/**
* @var \phpDocumentor\Reflection\DocBlock\Tags[] An array containing all the tags
* in this docblock; except inline.
* @var \phpDocumentor\Reflection\DocBlock\Tags[] An array containing all
* the tags in this docblock; except inline.
*/
protected $tags = array();
@@ -52,19 +52,21 @@ class DocBlock implements \Reflector
* For example the param and return tags use this to expand their type
* information.
*
* @param \Reflector|string $docblock A docblock comment (including asterisks)
* or reflector supporting the getDocComment method.
* @param string $namespace The namespace where this DocBlock resides in;
* defaults to `\`.
* @param string[] $namespace_aliases a list of namespace aliases as
* provided by the `use` keyword; the key of the array is the alias name
* or last part of the alias array if no alias name is provided.
* @param \Reflector|string $docblock A docblock comment (including
* asterisks) or reflector supporting the getDocComment method.
* @param string $namespace The namespace where this
* DocBlock resides in; defaults to `\`.
* @param string[] $namespace_aliases A list of namespace aliases
* as provided by the `use` keyword; the key of the array is the alias
* name or last part of the alias array if no alias name is provided.
*
* @throws \InvalidArgumentException if the given argument does not have the
* getDocComment method.
*/
public function __construct(
$docblock, $namespace = '\\', $namespace_aliases = array()
$docblock,
$namespace = '\\',
$namespace_aliases = array()
) {
if (is_object($docblock)) {
if (!method_exists($docblock, 'getDocComment')) {
@@ -99,7 +101,9 @@ class DocBlock implements \Reflector
{
$comment = trim(
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.
*
* @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
* containing the tags.
@@ -173,7 +177,9 @@ class DocBlock implements \Reflector
)
)?
(\s+ [\s\S]*)? # everything that follows
/u', $comment, $matches
/u',
$comment,
$matches
);
array_shift($matches);
}
@@ -306,9 +312,10 @@ class DocBlock implements \Reflector
* @param string $type Type to expand into full namespaced
* equivalent.
* @param string[] $ignore_keywords Whether to ignore given keywords, when
* null it will use the default keywords: 'string', 'int', 'integer',
* 'bool', 'boolean', 'float', 'double', 'object', 'mixed', 'array',
* 'resource', 'void', 'null', 'callback', 'false', 'true'.
* null it will use the default keywords:
* 'string', 'int', 'integer', 'bool', 'boolean', 'float', 'double',
* 'object', 'mixed', 'array', 'resource', 'void', 'null', 'callback',
* 'false', 'true', 'self', '$this', 'callable'.
* Default value for this parameter is null.
*
* @return string
@@ -321,9 +328,9 @@ class DocBlock implements \Reflector
if ($ignore_keywords === null) {
$ignore_keywords = array(
'string', 'int', 'integer', 'bool', 'boolean', 'float', 'double',
'object', 'mixed', 'array', 'resource', 'void', 'null',
'callback', 'false', 'true', 'self', '$this', 'callable'
'string', 'int', 'integer', 'bool', 'boolean', 'float',
'double', 'object', 'mixed', 'array', 'resource', 'void',
'null', 'callback', 'false', 'true', 'self', '$this', 'callable'
);
}
@@ -382,7 +389,7 @@ class DocBlock implements \Reflector
*
* @return string
*/
static public function export()
public static function export()
{
throw new \Exception('Not yet implemented');
}
src/phpDocumentor/Reflection/DocBlock/LongDescription.php
+10 -7
View File
@@ -51,7 +51,7 @@ class LongDescription implements \Reflector
return $this->contents;
}
/*
/**
* Returns the parsed text of this description.
*
* @return array An array of strings and tag objects, in the order they
@@ -61,8 +61,10 @@ class LongDescription implements \Reflector
{
if (null === $this->parsedContents) {
$this->parsedContents = preg_split(
'/\{(\@.*?)\}/uS', $this->contents,
null, PREG_SPLIT_DELIM_CAPTURE
'/\{(\@.*?)\}/uS',
$this->contents,
null,
PREG_SPLIT_DELIM_CAPTURE
);
for ($i=1, $l = count($this->parsedContents); $i<$l; $i += 2) {
$this->parsedContents[$i] = Tag::createInstance(
@@ -97,8 +99,8 @@ class LongDescription implements \Reflector
}
if (class_exists('dflydev\markdown\MarkdownExtraParser')) {
$md = new \dflydev\markdown\MarkdownExtraParser();
$result = $md->transformMarkdown($result);
$markdown = new \dflydev\markdown\MarkdownExtraParser();
$result = $markdown->transformMarkdown($result);
}
return trim($result);
@@ -107,11 +109,12 @@ class LongDescription implements \Reflector
/**
* 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
*/
static public function export()
public static function export()
{
throw new \Exception('Not yet implemented');
}
src/phpDocumentor/Reflection/DocBlock/Tag.php
+9 -6
View File
@@ -2,7 +2,7 @@
/**
* phpDocumentor
*
* PHP Version 5
* PHP Version 5.3
*
* @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
@@ -51,7 +51,9 @@ class Tag implements \Reflector
public static function createInstance($tag_line)
{
if (!preg_match(
'/^@([\w\-\_\\\\]+)(?:\s*([^\s].*)|$)?/us', $tag_line, $matches
'/^@([\w\-\_\\\\]+)(?:\s*([^\s].*)|$)?/us',
$tag_line,
$matches
)) {
throw new \InvalidArgumentException(
'Invalid tag_line detected: ' . $tag_line
@@ -60,7 +62,9 @@ class Tag implements \Reflector
// support hypphen separated tag names
$tag_name = str_replace(
' ', '', ucwords(str_replace('-', ' ', $matches[1]))
' ',
'',
ucwords(str_replace('-', ' ', $matches[1]))
).'Tag';
$class_name = 'phpDocumentor\\Reflection\\DocBlock\\Tag\\' . $tag_name;
@@ -112,7 +116,7 @@ class Tag implements \Reflector
return $this->description;
}
/*
/**
* Returns the parsed text of this description.
*
* @return array An array of strings and tag objects, in the order they
@@ -170,7 +174,7 @@ class Tag implements \Reflector
*
* @return void
*/
static public function export()
public static function export()
{
throw new \Exception('Not yet implemented');
}
@@ -185,5 +189,4 @@ class Tag implements \Reflector
{
return 'Not yet implemented';
}
}
src/phpDocumentor/Reflection/DocBlock/Tag/AuthorTag.php
+2 -2
View File
@@ -2,9 +2,9 @@
/**
* 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)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
src/phpDocumentor/Reflection/DocBlock/Tag/CoversTag.php
+1 -2
View File
@@ -2,7 +2,7 @@
/**
* phpDocumentor
*
* PHP Version 5
* PHP Version 5.3
*
* @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
@@ -21,5 +21,4 @@ namespace phpDocumentor\Reflection\DocBlock\Tag;
*/
class CoversTag extends SeeTag
{
}
src/phpDocumentor/Reflection/DocBlock/Tag/LinkTag.php
+2 -1
View File
@@ -2,7 +2,7 @@
/**
* phpDocumentor
*
* PHP Version 5
* PHP Version 5.3
*
* @author Ben Selby <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
@@ -11,6 +11,7 @@
*/
namespace phpDocumentor\Reflection\DocBlock\Tag;
use phpDocumentor\Reflection\DocBlock\Tag;
/**
src/phpDocumentor/Reflection/DocBlock/Tag/MethodTag.php
+4 -6
View File
@@ -2,7 +2,7 @@
/**
* phpDocumentor
*
* PHP Version 5
* PHP Version 5.3
*
* @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
@@ -49,8 +49,8 @@ class MethodTag extends ParamTag
// until a ) and whitespace : as method name with signature
// 5. any remaining text : as description
if (preg_match(
'/^[\s]*(?:([\w\|_\\\\]+)[\s]+)?(?:[\w_]+\(\)[\s]+)?([\w\|_\\\\]+)\(([^\)]*)\)'
.'[\s]*(.*)/u',
'/^[\s]*(?:([\w\|_\\\\]+)[\s]+)?(?:[\w_]+\(\)[\s]+)?([\w\|_\\\\]+)'
.'\(([^\)]*)\)[\s]*(.*)/u',
$content,
$matches
)) {
@@ -61,8 +61,7 @@ class MethodTag extends ParamTag
$this->arguments,
$this->description
) = $matches;
if (!$this->type)
{
if (!$this->type) {
$this->type = 'void';
}
} else {
@@ -126,5 +125,4 @@ class MethodTag extends ParamTag
return $arguments;
}
}
src/phpDocumentor/Reflection/DocBlock/Tag/ParamTag.php
+10 -3
View File
@@ -2,7 +2,7 @@
/**
* phpDocumentor
*
* PHP Version 5
* PHP Version 5.3
*
* @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
@@ -11,6 +11,7 @@
*/
namespace phpDocumentor\Reflection\DocBlock\Tag;
use phpDocumentor\Reflection\DocBlock\Tag;
/**
@@ -43,12 +44,18 @@ class ParamTag extends Tag
$content = preg_split('/\s+/u', $content);
// 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);
}
// 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);
}
src/phpDocumentor/Reflection/DocBlock/Tag/PropertyReadTag.php
+1 -2
View File
@@ -2,7 +2,7 @@
/**
* phpDocumentor
*
* PHP Version 5
* PHP Version 5.3
*
* @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
@@ -21,5 +21,4 @@ namespace phpDocumentor\Reflection\DocBlock\Tag;
*/
class PropertyReadTag extends PropertyTag
{
}
src/phpDocumentor/Reflection/DocBlock/Tag/PropertyTag.php
+1 -2
View File
@@ -2,7 +2,7 @@
/**
* phpDocumentor
*
* PHP Version 5
* PHP Version 5.3
*
* @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
@@ -21,5 +21,4 @@ namespace phpDocumentor\Reflection\DocBlock\Tag;
*/
class PropertyTag extends ParamTag
{
}
src/phpDocumentor/Reflection/DocBlock/Tag/PropertyWriteTag.php
+1 -2
View File
@@ -2,7 +2,7 @@
/**
* phpDocumentor
*
* PHP Version 5
* PHP Version 5.3
*
* @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
@@ -21,5 +21,4 @@ namespace phpDocumentor\Reflection\DocBlock\Tag;
*/
class PropertyWriteTag extends PropertyTag
{
}
src/phpDocumentor/Reflection/DocBlock/Tag/ReturnTag.php
+1 -2
View File
@@ -2,7 +2,7 @@
/**
* phpDocumentor
*
* PHP Version 5
* PHP Version 5.3
*
* @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
@@ -42,5 +42,4 @@ class ReturnTag extends ParamTag
$this->description = implode(' ', $content);
}
}
src/phpDocumentor/Reflection/DocBlock/Tag/SeeTag.php
+2 -2
View File
@@ -2,7 +2,7 @@
/**
* phpDocumentor
*
* PHP Version 5
* PHP Version 5.3
*
* @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
@@ -11,6 +11,7 @@
*/
namespace phpDocumentor\Reflection\DocBlock\Tag;
use phpDocumentor\Reflection\DocBlock\Tag;
/**
@@ -52,5 +53,4 @@ class SeeTag extends Tag
{
return $this->refers;
}
}
src/phpDocumentor/Reflection/DocBlock/Tag/ThrowTag.php
+1 -1
View File
@@ -2,7 +2,7 @@
/**
* phpDocumentor
*
* PHP Version 5
* PHP Version 5.3
*
* @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
src/phpDocumentor/Reflection/DocBlock/Tag/ThrowsTag.php
+1 -2
View File
@@ -2,7 +2,7 @@
/**
* phpDocumentor
*
* PHP Version 5
* PHP Version 5.3
*
* @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
@@ -21,5 +21,4 @@ namespace phpDocumentor\Reflection\DocBlock\Tag;
*/
class ThrowsTag extends ReturnTag
{
}
src/phpDocumentor/Reflection/DocBlock/Tag/UsesTag.php
+1 -2
View File
@@ -2,7 +2,7 @@
/**
* phpDocumentor
*
* PHP Version 5
* PHP Version 5.3
*
* @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
@@ -21,5 +21,4 @@ namespace phpDocumentor\Reflection\DocBlock\Tag;
*/
class UsesTag extends SeeTag
{
}
src/phpDocumentor/Reflection/DocBlock/Tag/VarTag.php
+1 -1
View File
@@ -2,7 +2,7 @@
/**
* phpDocumentor
*
* PHP Version 5
* PHP Version 5.3
*
* @author Mike van Riel <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
src/phpDocumentor/Reflection/DocBlock/Type/Collection.php
+23 -3
View File
@@ -1,6 +1,25 @@
<?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;
/**
* 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
{
/** @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.
*/
public function __construct(
array $types = array(), $namespace = null,
array $types = array(),
$namespace = null,
array $namespace_aliases = array()
) {
// only set the namespace if overridden
@@ -168,12 +188,12 @@ class Collection extends \ArrayObject
* This method only works as expected if the namespace and aliases are set;
* 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 getNamespaceAliases to check whether the first part of the relative
* type name should not be replaced with another namespace.
*
* @param string $type The relative or absolute type.
*
* @return string
*/
protected function expand($type)
tests/phpDocumentor/Reflection/DocBlock/Tag/CoversTagTest.php
+18 -8
View File
@@ -2,23 +2,29 @@
/**
* phpDocumentor Covers Tag Test
*
* PHP version 5.3
*
* @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;
/**
* Test class for phpDocumentor_Reflection_DocBlock_Tag_Covers
* Test class for \phpDocumentor\Reflection\DocBlock\Tag\CoversTag
*
* @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
{
/**
* Test that the \phpDocumentor\Reflection\DocBlock\Tag\Covers can create a link
* for the covers doc block
* Test that the \phpDocumentor\Reflection\DocBlock\Tag\CoversTag can create
* a link for the covers doc block.
*
* @param string $type
* @param string $content
@@ -32,9 +38,13 @@ class CoversTagTest extends \PHPUnit_Framework_TestCase
* @return void
*/
public function testConstructorParesInputsIntoCorrectFields(
$type, $content, $exName, $exContent, $exDescription, $exReference
)
{
$type,
$content,
$exName,
$exContent,
$exDescription,
$exReference
) {
$tag = new CoversTag($type, $content);
$actualName = $tag->getName();
tests/phpDocumentor/Reflection/DocBlock/Tag/LinkTagTest.php
+15 -5
View File
@@ -2,8 +2,12 @@
/**
* phpDocumentor Link Tag Test
*
* PHP version 5.3
*
* @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;
@@ -12,7 +16,9 @@ namespace phpDocumentor\Reflection\DocBlock\Tag;
* Test class for \phpDocumentor\Reflection\DocBlock\Tag\LinkTag
*
* @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
{
@@ -33,9 +39,13 @@ class LinkTagTest extends \PHPUnit_Framework_TestCase
* @return void
*/
public function testConstructorParesInputsIntoCorrectFields(
$type, $content, $exName, $exContent, $exDescription, $exLink
)
{
$type,
$content,
$exName,
$exContent,
$exDescription,
$exLink
) {
$tag = new LinkTag($type, $content);
$actualName = $tag->getName();
tests/phpDocumentor/Reflection/DocBlock/Tag/MethodTagTest.php
+25 -10
View File
@@ -2,8 +2,12 @@
/**
* phpDocumentor Method Tag Test
*
* PHP version 5.3
*
* @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;
@@ -12,13 +16,13 @@ namespace phpDocumentor\Reflection\DocBlock\Tag;
* Test class for \phpDocumentor\Reflection\DocBlock\Tag\MethodTag
*
* @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
{
/**
* @dataProvider getTestSignatures
*
* @param string $signature The signature to test
* @param bool $valid Whether the given signature is expected to
* be valid.
@@ -30,27 +34,38 @@ class MethodTagTest extends \PHPUnit_Framework_TestCase
* @param string $description The short description mentioned in the
* signature.
*
* @dataProvider getTestSignatures
*
* @return void
*/
public function testConstruct($signature, $valid, $expected_name,
$expected_return, $has_params, $description)
{
public function testConstruct(
$signature,
$valid,
$expected_name,
$expected_return,
$has_params,
$description
) {
ob_start();
$tag = new MethodTag('method', $signature);
$stdout = ob_get_clean();
$this->assertSame(
$valid, empty($stdout),
$valid,
empty($stdout),
'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_return, $tag->getType());
$this->assertEquals($description, $tag->getDescription());
$this->assertSame(
$has_params, (bool)(count($tag->getArguments()) > 0),
$has_params,
(bool)(count($tag->getArguments()) > 0),
'Number of found arguments should exceed 0'
);
}
tests/phpDocumentor/Reflection/DocBlock/Tag/ParamTagTest.php
+20 -11
View File
@@ -2,17 +2,23 @@
/**
* phpDocumentor Param tag test.
*
* PHP version 5.3
*
* @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;
/**
* Test class for phpDocumentor_Reflection_DocBlock_Param.
* Test class for \phpDocumentor\Reflection\DocBlock\ParamTag.
*
* @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
{
@@ -22,9 +28,9 @@ class ParamTagTest extends \PHPUnit_Framework_TestCase
*
* @param string $type
* @param string $content
* @param string $extracted_type
* @param string $extracted_variable_name
* @param string $extracted_description
* @param string $extractedType
* @param string $extractedVarName
* @param string $extractedDescription
*
* @covers \phpDocumentor\Reflection\DocBlock\Tag\ParamTag::__construct
*
@@ -33,14 +39,17 @@ class ParamTagTest extends \PHPUnit_Framework_TestCase
* @return void
*/
public function testConstructorParsesInputsIntoCorrectFields(
$type, $content, $extracted_type, $extracted_variable_name,
$extracted_description
$type,
$content,
$extractedType,
$extractedVarName,
$extractedDescription
) {
$tag = new ParamTag($type, $content);
$this->assertEquals($extracted_type, $tag->getTypes());
$this->assertEquals($extracted_variable_name, $tag->getVariableName());
$this->assertEquals($extracted_description, $tag->getDescription());
$this->assertEquals($extractedType, $tag->getTypes());
$this->assertEquals($extractedVarName, $tag->getVariableName());
$this->assertEquals($extractedDescription, $tag->getDescription());
}
/**
tests/phpDocumentor/Reflection/DocBlock/Tag/ReturnTagTest.php
+16 -8
View File
@@ -2,17 +2,23 @@
/**
* phpDocumentor Return tag test.
*
* PHP version 5.3
*
* @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;
/**
* Test class for phpDocumentor_Reflection_DocBlock_ReturnTag.
* Test class for \phpDocumentor\Reflection\DocBlock\ReturnTag.
*
* @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
{
@@ -21,8 +27,8 @@ class ReturnTagTest extends ParamTagTest
* understand the Return DocBlock.
*
* @param string $content
* @param string $extracted_type
* @param string $extracted_description
* @param string $extractedType
* @param string $extractedDescription
*
* @covers \phpDocumentor\Reflection\DocBlock\Tag\ReturnTag::__construct
*
@@ -31,12 +37,14 @@ class ReturnTagTest extends ParamTagTest
* @return void
*/
public function testConstructorParsesInputsIntoCorrectFields(
$content, $extracted_type, $extracted_description
$content,
$extractedType,
$extractedDescription
) {
$tag = new ReturnTag('return', $content);
$this->assertEquals($extracted_type, $tag->getTypes());
$this->assertEquals($extracted_description, $tag->getDescription());
$this->assertEquals($extractedType, $tag->getTypes());
$this->assertEquals($extractedDescription, $tag->getDescription());
}
/**
tests/phpDocumentor/Reflection/DocBlock/Tag/SeeTagTest.php
+16 -6
View File
@@ -2,17 +2,23 @@
/**
* phpDocumentor See Tag Test
*
* PHP version 5.3
*
* @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;
/**
* Test class for phpDocumentor_Reflection_DocBlock_Tag_See
* Test class for \phpDocumentor\Reflection\DocBlock\Tag\SeeTag
*
* @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
{
@@ -32,9 +38,13 @@ class SeeTagTest extends \PHPUnit_Framework_TestCase
* @return void
*/
public function testConstructorParesInputsIntoCorrectFields(
$type, $content, $exName, $exContent, $exDescription, $exReference
)
{
$type,
$content,
$exName,
$exContent,
$exDescription,
$exReference
) {
$tag = new SeeTag($type, $content);
$actualName = $tag->getName();
tests/phpDocumentor/Reflection/DocBlock/Tag/UsesTagTest.php
+16 -6
View File
@@ -2,17 +2,23 @@
/**
* phpDocumentor Uses Tag Test
*
* PHP version 5.3
*
* @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;
/**
* Test class for phpDocumentor_Reflection_DocBlock_Tag_Uses
* Test class for \phpDocumentor\Reflection\DocBlock\Tag\UsesTag
*
* @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
{
@@ -32,9 +38,13 @@ class UsesTagTest extends \PHPUnit_Framework_TestCase
* @return void
*/
public function testConstructorParesInputsIntoCorrectFields(
$type, $content, $exName, $exContent, $exDescription, $exReference
)
{
$type,
$content,
$exName,
$exContent,
$exDescription,
$exReference
) {
$tag = new UsesTag($type, $content);
$actualName = $tag->getName();
tests/phpDocumentor/Reflection/DocBlock/Tag/VarTagTest.php
+17 -8
View File
@@ -2,23 +2,29 @@
/**
* phpDocumentor Var Tag Test
*
* PHP version 5.3
*
* @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;
/**
* Test class for phpDocumentor_Reflection_DocBlock_Tag_Link
* Test class for \phpDocumentor\Reflection\DocBlock\Tag\VarTag
*
* @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
{
/**
* Test that the \phpDocumentor\Reflection\DocBlock\Tag\VarTag can understand
* the @var doc block
* Test that the \phpDocumentor\Reflection\DocBlock\Tag\VarTag can
* understand the @var doc block
*
* @param string $type
* @param string $content
@@ -32,9 +38,12 @@ class VarTagTest extends \PHPUnit_Framework_TestCase
* @return void
*/
public function testConstructorParesInputsIntoCorrectFields(
$type, $content, $exType, $exVariable, $exDescription
)
{
$type,
$content,
$exType,
$exVariable,
$exDescription
) {
$tag = new VarTag($type, $content);
$this->assertEquals($exType, $tag->getType());
tests/phpDocumentor/Reflection/DocBlock/Type/CollectionTest.php
+36 -4
View File
@@ -1,9 +1,26 @@
<?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;
/**
* Test class for phpDocumentor_Reflection_DocBlock
* Test class for \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
{
@@ -11,6 +28,8 @@ class CollectionTest extends \PHPUnit_Framework_TestCase
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection::__construct
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection::getNamespace
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection::getNamespaceAliases
*
* @return void
*/
public function testConstruct()
{
@@ -22,6 +41,8 @@ class CollectionTest extends \PHPUnit_Framework_TestCase
/**
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection::__construct
*
* @return void
*/
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::getNamespace
*
* @return void
*/
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::getNamespaceAliases
*
* @return void
*/
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::getNamespace
*
* @return void
*/
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::getNamespaceAliases
*
* @return void
*/
public function testSetAndGetNamespaceAliases()
{
@@ -94,6 +123,8 @@ class CollectionTest extends \PHPUnit_Framework_TestCase
*
* @dataProvider provideTypesToExpand
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection::add
*
* @return void
*/
public function testAdd($fixture, $expected)
{
@@ -111,6 +142,8 @@ class CollectionTest extends \PHPUnit_Framework_TestCase
*
* @dataProvider provideTypesToExpandWithoutNamespace
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection::add
*
* @return void
*/
public function testAddWithoutNamespace($fixture, $expected)
{
@@ -124,6 +157,8 @@ class CollectionTest extends \PHPUnit_Framework_TestCase
/**
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection::add
* @expectedException InvalidArgumentException
*
* @return void
*/
public function testAddWithInvalidArgument()
{
@@ -181,7 +216,6 @@ class CollectionTest extends \PHPUnit_Framework_TestCase
* types when no namespace is available.
*
* @param string $method Name of the method consuming this data provider.
* @param string $namespace Name of the namespace to user as basis.
*
* @return string[]
*/
@@ -189,6 +223,4 @@ class CollectionTest extends \PHPUnit_Framework_TestCase
{
return $this->provideTypesToExpand($method, '\\');
}
}
tests/phpDocumentor/Reflection/DocBlockTest.php
+20 -10
View File
@@ -2,10 +2,12 @@
/**
* phpDocumentor DocBlock Test
*
* PHP Version 5
* PHP Version 5.3
*
* @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;
@@ -14,7 +16,9 @@ namespace phpDocumentor\Reflection;
* Test class for phpDocumentor_Reflection_DocBlock
*
* @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
{
@@ -32,7 +36,8 @@ class DocBlockTest extends \PHPUnit_Framework_TestCase
DOCBLOCK;
$object = new DocBlock($fixture);
$this->assertEquals(
'This is a short description.', $object->getShortDescription()
'This is a short description.',
$object->getShortDescription()
);
$this->assertEquals(
'This is a long description.',
@@ -53,11 +58,13 @@ DOCBLOCK;
DOCBLOCK;
$object = new DocBlock($fixture);
$this->assertEquals(
'This is a short description.', $object->getShortDescription()
'This is a short description.',
$object->getShortDescription()
);
$this->assertEquals(
"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()
{
$docblock = new DocBlock(
'', '\My\Namespace', array('Alias' => '\My\Namespace\Alias')
'',
'\My\Namespace',
array('Alias' => '\My\Namespace\Alias')
);
// first try a normal resolution without alias
$this->assertEquals(
'\My\Namespace\Al', $docblock->expandType('Al')
'\My\Namespace\Al',
$docblock->expandType('Al')
);
// try to use the alias
$this->assertEquals(
'\My\Namespace\Alias\Al', $docblock->expandType('Alias\Al')
'\My\Namespace\Alias\Al',
$docblock->expandType('Alias\Al')
);
}
@@ -141,4 +152,3 @@ DOCBLOCK;
);
}
}