From 9ea32753893fee58d4cd00fe114204ac48c53ab0 Mon Sep 17 00:00:00 2001 From: Vasil Rangelov Date: Sun, 4 Nov 2012 15:16:37 +0200 Subject: [PATCH] Tons of coding standard fixes. --- src/phpDocumentor/Reflection/DocBlock.php | 28 +++++++------- .../Reflection/DocBlock/LongDescription.php | 12 +++--- src/phpDocumentor/Reflection/DocBlock/Tag.php | 10 ++--- .../Reflection/DocBlock/Tag/AuthorTag.php | 10 ++--- .../Reflection/DocBlock/Tag/CoversTag.php | 8 ++-- .../Reflection/DocBlock/Tag/LinkTag.php | 8 ++-- .../Reflection/DocBlock/Tag/MethodTag.php | 15 ++++---- .../Reflection/DocBlock/Tag/ParamTag.php | 18 ++++++--- .../DocBlock/Tag/PropertyReadTag.php | 8 ++-- .../Reflection/DocBlock/Tag/PropertyTag.php | 8 ++-- .../DocBlock/Tag/PropertyWriteTag.php | 8 ++-- .../Reflection/DocBlock/Tag/ReturnTag.php | 8 ++-- .../Reflection/DocBlock/Tag/SeeTag.php | 8 ++-- .../Reflection/DocBlock/Tag/ThrowTag.php | 8 ++-- .../Reflection/DocBlock/Tag/ThrowsTag.php | 8 ++-- .../Reflection/DocBlock/Tag/UsesTag.php | 8 ++-- .../Reflection/DocBlock/Tag/VarTag.php | 8 ++-- .../Reflection/DocBlock/Type/Collection.php | 27 +++++++++++-- .../Reflection/DocBlock/Tag/CoversTagTest.php | 17 ++++++--- .../Reflection/DocBlock/Tag/LinkTagTest.php | 17 ++++++--- .../Reflection/DocBlock/Tag/MethodTagTest.php | 26 ++++++++----- .../Reflection/DocBlock/Tag/ParamTagTest.php | 12 ++++-- .../Reflection/DocBlock/Tag/ReturnTagTest.php | 12 ++++-- .../Reflection/DocBlock/Tag/SeeTagTest.php | 17 ++++++--- .../Reflection/DocBlock/Tag/UsesTagTest.php | 17 ++++++--- .../Reflection/DocBlock/Tag/VarTagTest.php | 17 ++++++--- .../DocBlock/Type/CollectionTest.php | 38 ++++++++++++++++++- .../phpDocumentor/Reflection/DocBlockTest.php | 14 ++++--- 28 files changed, 251 insertions(+), 144 deletions(-) diff --git a/src/phpDocumentor/Reflection/DocBlock.php b/src/phpDocumentor/Reflection/DocBlock.php index 60fda14..0f4b5ea 100644 --- a/src/phpDocumentor/Reflection/DocBlock.php +++ b/src/phpDocumentor/Reflection/DocBlock.php @@ -2,7 +2,7 @@ /** * phpDocumentor * - * PHP Version 5 + * PHP Version 5.3 * * @author Mike van Riel * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) @@ -15,9 +15,9 @@ namespace phpDocumentor\Reflection; /** * Parses the DocBlock for any structure. * - * @author Mike van Riel - * @license http://www.opensource.org/licenses/mit-license.php MIT - * @link http://phpdoc.org + * @author Mike van Riel + * @license http://www.opensource.org/licenses/mit-license.php MIT + * @link http://phpdoc.org */ class DocBlock implements \Reflector { @@ -31,8 +31,8 @@ class DocBlock implements \Reflector 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,16 +52,16 @@ 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. + * getDocComment method. */ public function __construct( $docblock, $namespace = '\\', $namespace_aliases = array() diff --git a/src/phpDocumentor/Reflection/DocBlock/LongDescription.php b/src/phpDocumentor/Reflection/DocBlock/LongDescription.php index 7fb8fa7..9ede73c 100644 --- a/src/phpDocumentor/Reflection/DocBlock/LongDescription.php +++ b/src/phpDocumentor/Reflection/DocBlock/LongDescription.php @@ -15,9 +15,9 @@ namespace phpDocumentor\Reflection\DocBlock; /** * Parses a Long Description of a DocBlock. * - * @author Mike van Riel - * @license http://www.opensource.org/licenses/mit-license.php MIT - * @link http://phpdoc.org + * @author Mike van Riel + * @license http://www.opensource.org/licenses/mit-license.php MIT + * @link http://phpdoc.org */ class LongDescription implements \Reflector { @@ -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 @@ -97,8 +97,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); diff --git a/src/phpDocumentor/Reflection/DocBlock/Tag.php b/src/phpDocumentor/Reflection/DocBlock/Tag.php index 4ad3620..89fc9e2 100644 --- a/src/phpDocumentor/Reflection/DocBlock/Tag.php +++ b/src/phpDocumentor/Reflection/DocBlock/Tag.php @@ -2,7 +2,7 @@ /** * phpDocumentor * - * PHP Version 5 + * PHP Version 5.3 * * @author Mike van Riel * @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. * - * @author Mike van Riel - * @license http://www.opensource.org/licenses/mit-license.php MIT - * @link http://phpdoc.org + * @author Mike van Riel + * @license http://www.opensource.org/licenses/mit-license.php MIT + * @link http://phpdoc.org */ class Tag implements \Reflector { @@ -112,7 +112,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 diff --git a/src/phpDocumentor/Reflection/DocBlock/Tag/AuthorTag.php b/src/phpDocumentor/Reflection/DocBlock/Tag/AuthorTag.php index 3eeda2f..ff5aab0 100644 --- a/src/phpDocumentor/Reflection/DocBlock/Tag/AuthorTag.php +++ b/src/phpDocumentor/Reflection/DocBlock/Tag/AuthorTag.php @@ -2,9 +2,9 @@ /** * phpDocumentor * - * PHP Version 5 + * PHP Version 5.3 * - * @author Mike van Riel + * @author Vasil Rangelov * @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 @@ -17,9 +17,9 @@ use phpDocumentor\Reflection\DocBlock\Tag; /** * Reflection class for an @author tag in a Docblock. * - * @author Mike van Riel - * @license http://www.opensource.org/licenses/mit-license.php MIT - * @link http://phpdoc.org + * @author Mike van Riel + * @license http://www.opensource.org/licenses/mit-license.php MIT + * @link http://phpdoc.org */ class AuthorTag extends Tag { diff --git a/src/phpDocumentor/Reflection/DocBlock/Tag/CoversTag.php b/src/phpDocumentor/Reflection/DocBlock/Tag/CoversTag.php index 49ae236..da136d9 100644 --- a/src/phpDocumentor/Reflection/DocBlock/Tag/CoversTag.php +++ b/src/phpDocumentor/Reflection/DocBlock/Tag/CoversTag.php @@ -2,7 +2,7 @@ /** * phpDocumentor * - * PHP Version 5 + * PHP Version 5.3 * * @author Mike van Riel * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) @@ -15,9 +15,9 @@ namespace phpDocumentor\Reflection\DocBlock\Tag; /** * Reflection class for a @covers tag in a Docblock. * - * @author Mike van Riel - * @license http://www.opensource.org/licenses/mit-license.php MIT - * @link http://phpdoc.org + * @author Mike van Riel + * @license http://www.opensource.org/licenses/mit-license.php MIT + * @link http://phpdoc.org */ class CoversTag extends SeeTag { diff --git a/src/phpDocumentor/Reflection/DocBlock/Tag/LinkTag.php b/src/phpDocumentor/Reflection/DocBlock/Tag/LinkTag.php index 3e89c73..0893fed 100644 --- a/src/phpDocumentor/Reflection/DocBlock/Tag/LinkTag.php +++ b/src/phpDocumentor/Reflection/DocBlock/Tag/LinkTag.php @@ -2,7 +2,7 @@ /** * phpDocumentor * - * PHP Version 5 + * PHP Version 5.3 * * @author Ben Selby * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) @@ -16,9 +16,9 @@ use phpDocumentor\Reflection\DocBlock\Tag; /** * Reflection class for a @link tag in a Docblock. * - * @author Ben Selby - * @license http://www.opensource.org/licenses/mit-license.php MIT - * @link http://phpdoc.org + * @author Ben Selby + * @license http://www.opensource.org/licenses/mit-license.php MIT + * @link http://phpdoc.org */ class LinkTag extends Tag { diff --git a/src/phpDocumentor/Reflection/DocBlock/Tag/MethodTag.php b/src/phpDocumentor/Reflection/DocBlock/Tag/MethodTag.php index 1c407b0..4c03243 100644 --- a/src/phpDocumentor/Reflection/DocBlock/Tag/MethodTag.php +++ b/src/phpDocumentor/Reflection/DocBlock/Tag/MethodTag.php @@ -2,7 +2,7 @@ /** * phpDocumentor * - * PHP Version 5 + * PHP Version 5.3 * * @author Mike van Riel * @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. * - * @author Mike van Riel - * @license http://www.opensource.org/licenses/mit-license.php MIT - * @link http://phpdoc.org + * @author Mike van Riel + * @license http://www.opensource.org/licenses/mit-license.php MIT + * @link http://phpdoc.org */ class MethodTag extends ParamTag { @@ -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 { diff --git a/src/phpDocumentor/Reflection/DocBlock/Tag/ParamTag.php b/src/phpDocumentor/Reflection/DocBlock/Tag/ParamTag.php index 2125566..71e16d1 100644 --- a/src/phpDocumentor/Reflection/DocBlock/Tag/ParamTag.php +++ b/src/phpDocumentor/Reflection/DocBlock/Tag/ParamTag.php @@ -2,7 +2,7 @@ /** * phpDocumentor * - * PHP Version 5 + * PHP Version 5.3 * * @author Mike van Riel * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) @@ -16,9 +16,9 @@ use phpDocumentor\Reflection\DocBlock\Tag; /** * Reflection class for a {@param} tag in a Docblock. * - * @author Mike van Riel - * @license http://www.opensource.org/licenses/mit-license.php MIT - * @link http://phpdoc.org + * @author Mike van Riel + * @license http://www.opensource.org/licenses/mit-license.php MIT + * @link http://phpdoc.org */ class ParamTag extends Tag { @@ -43,12 +43,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); } diff --git a/src/phpDocumentor/Reflection/DocBlock/Tag/PropertyReadTag.php b/src/phpDocumentor/Reflection/DocBlock/Tag/PropertyReadTag.php index e27c5d3..2675376 100644 --- a/src/phpDocumentor/Reflection/DocBlock/Tag/PropertyReadTag.php +++ b/src/phpDocumentor/Reflection/DocBlock/Tag/PropertyReadTag.php @@ -2,7 +2,7 @@ /** * phpDocumentor * - * PHP Version 5 + * PHP Version 5.3 * * @author Mike van Riel * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) @@ -15,9 +15,9 @@ namespace phpDocumentor\Reflection\DocBlock\Tag; /** * Reflection class for a {@property} tag in a Docblock. * - * @author Mike van Riel - * @license http://www.opensource.org/licenses/mit-license.php MIT - * @link http://phpdoc.org + * @author Mike van Riel + * @license http://www.opensource.org/licenses/mit-license.php MIT + * @link http://phpdoc.org */ class PropertyReadTag extends PropertyTag { diff --git a/src/phpDocumentor/Reflection/DocBlock/Tag/PropertyTag.php b/src/phpDocumentor/Reflection/DocBlock/Tag/PropertyTag.php index a19180a..08ca1b7 100644 --- a/src/phpDocumentor/Reflection/DocBlock/Tag/PropertyTag.php +++ b/src/phpDocumentor/Reflection/DocBlock/Tag/PropertyTag.php @@ -2,7 +2,7 @@ /** * phpDocumentor * - * PHP Version 5 + * PHP Version 5.3 * * @author Mike van Riel * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) @@ -15,9 +15,9 @@ namespace phpDocumentor\Reflection\DocBlock\Tag; /** * Reflection class for a {@property} tag in a Docblock. * - * @author Mike van Riel - * @license http://www.opensource.org/licenses/mit-license.php MIT - * @link http://phpdoc.org + * @author Mike van Riel + * @license http://www.opensource.org/licenses/mit-license.php MIT + * @link http://phpdoc.org */ class PropertyTag extends ParamTag { diff --git a/src/phpDocumentor/Reflection/DocBlock/Tag/PropertyWriteTag.php b/src/phpDocumentor/Reflection/DocBlock/Tag/PropertyWriteTag.php index 8fbde97..22e9cb4 100644 --- a/src/phpDocumentor/Reflection/DocBlock/Tag/PropertyWriteTag.php +++ b/src/phpDocumentor/Reflection/DocBlock/Tag/PropertyWriteTag.php @@ -2,7 +2,7 @@ /** * phpDocumentor * - * PHP Version 5 + * PHP Version 5.3 * * @author Mike van Riel * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) @@ -15,9 +15,9 @@ namespace phpDocumentor\Reflection\DocBlock\Tag; /** * Reflection class for a {@property} tag in a Docblock. * - * @author Mike van Riel - * @license http://www.opensource.org/licenses/mit-license.php MIT - * @link http://phpdoc.org + * @author Mike van Riel + * @license http://www.opensource.org/licenses/mit-license.php MIT + * @link http://phpdoc.org */ class PropertyWriteTag extends PropertyTag { diff --git a/src/phpDocumentor/Reflection/DocBlock/Tag/ReturnTag.php b/src/phpDocumentor/Reflection/DocBlock/Tag/ReturnTag.php index 3c7725f..63cea4f 100644 --- a/src/phpDocumentor/Reflection/DocBlock/Tag/ReturnTag.php +++ b/src/phpDocumentor/Reflection/DocBlock/Tag/ReturnTag.php @@ -2,7 +2,7 @@ /** * phpDocumentor * - * PHP Version 5 + * PHP Version 5.3 * * @author Mike van Riel * @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. * - * @author Mike van Riel - * @license http://www.opensource.org/licenses/mit-license.php MIT - * @link http://phpdoc.org + * @author Mike van Riel + * @license http://www.opensource.org/licenses/mit-license.php MIT + * @link http://phpdoc.org */ class ReturnTag extends ParamTag { diff --git a/src/phpDocumentor/Reflection/DocBlock/Tag/SeeTag.php b/src/phpDocumentor/Reflection/DocBlock/Tag/SeeTag.php index 57878f7..8e63d6c 100644 --- a/src/phpDocumentor/Reflection/DocBlock/Tag/SeeTag.php +++ b/src/phpDocumentor/Reflection/DocBlock/Tag/SeeTag.php @@ -2,7 +2,7 @@ /** * phpDocumentor * - * PHP Version 5 + * PHP Version 5.3 * * @author Mike van Riel * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) @@ -16,9 +16,9 @@ use phpDocumentor\Reflection\DocBlock\Tag; /** * Reflection class for a {@see} tag in a Docblock. * - * @author Mike van Riel - * @license http://www.opensource.org/licenses/mit-license.php MIT - * @link http://phpdoc.org + * @author Mike van Riel + * @license http://www.opensource.org/licenses/mit-license.php MIT + * @link http://phpdoc.org */ class SeeTag extends Tag { diff --git a/src/phpDocumentor/Reflection/DocBlock/Tag/ThrowTag.php b/src/phpDocumentor/Reflection/DocBlock/Tag/ThrowTag.php index fda4e6d..59d7d1d 100644 --- a/src/phpDocumentor/Reflection/DocBlock/Tag/ThrowTag.php +++ b/src/phpDocumentor/Reflection/DocBlock/Tag/ThrowTag.php @@ -2,7 +2,7 @@ /** * phpDocumentor * - * PHP Version 5 + * PHP Version 5.3 * * @author Mike van Riel * @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 * - * @author Mike van Riel - * @license http://www.opensource.org/licenses/mit-license.php MIT - * @link http://phpdoc.org + * @author Mike van Riel + * @license http://www.opensource.org/licenses/mit-license.php MIT + * @link http://phpdoc.org */ class ThrowTag extends ThrowsTag { diff --git a/src/phpDocumentor/Reflection/DocBlock/Tag/ThrowsTag.php b/src/phpDocumentor/Reflection/DocBlock/Tag/ThrowsTag.php index 9113214..e95b7cf 100644 --- a/src/phpDocumentor/Reflection/DocBlock/Tag/ThrowsTag.php +++ b/src/phpDocumentor/Reflection/DocBlock/Tag/ThrowsTag.php @@ -2,7 +2,7 @@ /** * phpDocumentor * - * PHP Version 5 + * PHP Version 5.3 * * @author Mike van Riel * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) @@ -15,9 +15,9 @@ namespace phpDocumentor\Reflection\DocBlock\Tag; /** * Reflection class for a {@throws} tag in a Docblock. * - * @author Mike van Riel - * @license http://www.opensource.org/licenses/mit-license.php MIT - * @link http://phpdoc.org + * @author Mike van Riel + * @license http://www.opensource.org/licenses/mit-license.php MIT + * @link http://phpdoc.org */ class ThrowsTag extends ReturnTag { diff --git a/src/phpDocumentor/Reflection/DocBlock/Tag/UsesTag.php b/src/phpDocumentor/Reflection/DocBlock/Tag/UsesTag.php index 679bb02..9c4e6b1 100644 --- a/src/phpDocumentor/Reflection/DocBlock/Tag/UsesTag.php +++ b/src/phpDocumentor/Reflection/DocBlock/Tag/UsesTag.php @@ -2,7 +2,7 @@ /** * phpDocumentor * - * PHP Version 5 + * PHP Version 5.3 * * @author Mike van Riel * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) @@ -15,9 +15,9 @@ namespace phpDocumentor\Reflection\DocBlock\Tag; /** * Reflection class for a {@uses} tag in a Docblock. * - * @author Mike van Riel - * @license http://www.opensource.org/licenses/mit-license.php MIT - * @link http://phpdoc.org + * @author Mike van Riel + * @license http://www.opensource.org/licenses/mit-license.php MIT + * @link http://phpdoc.org */ class UsesTag extends SeeTag { diff --git a/src/phpDocumentor/Reflection/DocBlock/Tag/VarTag.php b/src/phpDocumentor/Reflection/DocBlock/Tag/VarTag.php index 854e048..a9a8f61 100644 --- a/src/phpDocumentor/Reflection/DocBlock/Tag/VarTag.php +++ b/src/phpDocumentor/Reflection/DocBlock/Tag/VarTag.php @@ -2,7 +2,7 @@ /** * phpDocumentor * - * PHP Version 5 + * PHP Version 5.3 * * @author Mike van Riel * @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. * - * @author Mike van Riel - * @license http://www.opensource.org/licenses/mit-license.php MIT - * @link http://phpdoc.org + * @author Mike van Riel + * @license http://www.opensource.org/licenses/mit-license.php MIT + * @link http://phpdoc.org */ class VarTag extends ParamTag { diff --git a/src/phpDocumentor/Reflection/DocBlock/Type/Collection.php b/src/phpDocumentor/Reflection/DocBlock/Type/Collection.php index e72c051..0b21d41 100644 --- a/src/phpDocumentor/Reflection/DocBlock/Type/Collection.php +++ b/src/phpDocumentor/Reflection/DocBlock/Type/Collection.php @@ -1,6 +1,25 @@ + * @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 + * @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 */ @@ -58,7 +77,7 @@ class Collection extends \ArrayObject } $this->namespace_aliases = $namespace_aliases; - foreach($types as $type) { + foreach ($types as $type) { $this->add($type); } } @@ -150,7 +169,7 @@ class Collection extends \ArrayObject // separate the type by the OR operator $type_parts = explode(self::OPERATOR_OR, $type); - foreach($type_parts as $part) { + foreach ($type_parts as $part) { $expanded_type = $this->expand($part); if ($expanded_type) { $this[] = $expanded_type; @@ -168,12 +187,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) diff --git a/tests/phpDocumentor/Reflection/DocBlock/Tag/CoversTagTest.php b/tests/phpDocumentor/Reflection/DocBlock/Tag/CoversTagTest.php index dfcd353..771dafc 100644 --- a/tests/phpDocumentor/Reflection/DocBlock/Tag/CoversTagTest.php +++ b/tests/phpDocumentor/Reflection/DocBlock/Tag/CoversTagTest.php @@ -1,9 +1,13 @@ - * @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) + * @author Daniel O'Connor + * @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; @@ -11,8 +15,10 @@ namespace phpDocumentor\Reflection\DocBlock\Tag; /** * Test class for phpDocumentor_Reflection_DocBlock_Tag_Covers * - * @author Daniel O'Connor - * @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) + * @author Daniel O'Connor + * @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 { @@ -33,8 +39,7 @@ class CoversTagTest extends \PHPUnit_Framework_TestCase */ public function testConstructorParesInputsIntoCorrectFields( $type, $content, $exName, $exContent, $exDescription, $exReference - ) - { + ) { $tag = new CoversTag($type, $content); $actualName = $tag->getName(); diff --git a/tests/phpDocumentor/Reflection/DocBlock/Tag/LinkTagTest.php b/tests/phpDocumentor/Reflection/DocBlock/Tag/LinkTagTest.php index 99de821..49af279 100644 --- a/tests/phpDocumentor/Reflection/DocBlock/Tag/LinkTagTest.php +++ b/tests/phpDocumentor/Reflection/DocBlock/Tag/LinkTagTest.php @@ -1,9 +1,13 @@ - * @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) + * @author Ben Selby + * @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; @@ -11,8 +15,10 @@ namespace phpDocumentor\Reflection\DocBlock\Tag; /** * Test class for \phpDocumentor\Reflection\DocBlock\Tag\LinkTag * - * @author Ben Selby - * @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) + * @author Ben Selby + * @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 { @@ -34,8 +40,7 @@ class LinkTagTest extends \PHPUnit_Framework_TestCase */ public function testConstructorParesInputsIntoCorrectFields( $type, $content, $exName, $exContent, $exDescription, $exLink - ) - { + ) { $tag = new LinkTag($type, $content); $actualName = $tag->getName(); diff --git a/tests/phpDocumentor/Reflection/DocBlock/Tag/MethodTagTest.php b/tests/phpDocumentor/Reflection/DocBlock/Tag/MethodTagTest.php index c6ffdba..4901080 100644 --- a/tests/phpDocumentor/Reflection/DocBlock/Tag/MethodTagTest.php +++ b/tests/phpDocumentor/Reflection/DocBlock/Tag/MethodTagTest.php @@ -1,9 +1,13 @@ - * @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) + * @author Mike van Riel + * @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; @@ -11,14 +15,14 @@ namespace phpDocumentor\Reflection\DocBlock\Tag; /** * Test class for \phpDocumentor\Reflection\DocBlock\Tag\MethodTag * - * @author Mike van Riel - * @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) + * @author Mike van Riel + * @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. @@ -29,12 +33,14 @@ class MethodTagTest extends \PHPUnit_Framework_TestCase * @param bool $has_params whether this signature features parameters. * @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) - { + $expected_return, $has_params, $description + ) { ob_start(); $tag = new MethodTag('method', $signature); $stdout = ob_get_clean(); @@ -44,7 +50,9 @@ class MethodTagTest extends \PHPUnit_Framework_TestCase '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()); diff --git a/tests/phpDocumentor/Reflection/DocBlock/Tag/ParamTagTest.php b/tests/phpDocumentor/Reflection/DocBlock/Tag/ParamTagTest.php index fd5448a..5dd3441 100644 --- a/tests/phpDocumentor/Reflection/DocBlock/Tag/ParamTagTest.php +++ b/tests/phpDocumentor/Reflection/DocBlock/Tag/ParamTagTest.php @@ -1,9 +1,13 @@ - * @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; @@ -11,8 +15,10 @@ namespace phpDocumentor\Reflection\DocBlock\Tag; /** * Test class for phpDocumentor_Reflection_DocBlock_Param. * - * @author Mike van Riel - * @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) + * @author Mike van Riel + * @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 { diff --git a/tests/phpDocumentor/Reflection/DocBlock/Tag/ReturnTagTest.php b/tests/phpDocumentor/Reflection/DocBlock/Tag/ReturnTagTest.php index 4851579..8c2b136 100644 --- a/tests/phpDocumentor/Reflection/DocBlock/Tag/ReturnTagTest.php +++ b/tests/phpDocumentor/Reflection/DocBlock/Tag/ReturnTagTest.php @@ -1,9 +1,13 @@ - * @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; @@ -11,8 +15,10 @@ namespace phpDocumentor\Reflection\DocBlock\Tag; /** * Test class for phpDocumentor_Reflection_DocBlock_ReturnTag. * - * @author Mike van Riel - * @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) + * @author Mike van Riel + * @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 { diff --git a/tests/phpDocumentor/Reflection/DocBlock/Tag/SeeTagTest.php b/tests/phpDocumentor/Reflection/DocBlock/Tag/SeeTagTest.php index a1e9747..781f45f 100644 --- a/tests/phpDocumentor/Reflection/DocBlock/Tag/SeeTagTest.php +++ b/tests/phpDocumentor/Reflection/DocBlock/Tag/SeeTagTest.php @@ -1,9 +1,13 @@ - * @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) + * @author Daniel O'Connor + * @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; @@ -11,8 +15,10 @@ namespace phpDocumentor\Reflection\DocBlock\Tag; /** * Test class for phpDocumentor_Reflection_DocBlock_Tag_See * - * @author Daniel O'Connor - * @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) + * @author Daniel O'Connor + * @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 { @@ -33,8 +39,7 @@ class SeeTagTest extends \PHPUnit_Framework_TestCase */ public function testConstructorParesInputsIntoCorrectFields( $type, $content, $exName, $exContent, $exDescription, $exReference - ) - { + ) { $tag = new SeeTag($type, $content); $actualName = $tag->getName(); diff --git a/tests/phpDocumentor/Reflection/DocBlock/Tag/UsesTagTest.php b/tests/phpDocumentor/Reflection/DocBlock/Tag/UsesTagTest.php index 115b86e..84f0bd2 100644 --- a/tests/phpDocumentor/Reflection/DocBlock/Tag/UsesTagTest.php +++ b/tests/phpDocumentor/Reflection/DocBlock/Tag/UsesTagTest.php @@ -1,9 +1,13 @@ - * @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) + * @author Daniel O'Connor + * @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; @@ -11,8 +15,10 @@ namespace phpDocumentor\Reflection\DocBlock\Tag; /** * Test class for phpDocumentor_Reflection_DocBlock_Tag_Uses * - * @author Daniel O'Connor - * @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) + * @author Daniel O'Connor + * @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 { @@ -33,8 +39,7 @@ class UsesTagTest extends \PHPUnit_Framework_TestCase */ public function testConstructorParesInputsIntoCorrectFields( $type, $content, $exName, $exContent, $exDescription, $exReference - ) - { + ) { $tag = new UsesTag($type, $content); $actualName = $tag->getName(); diff --git a/tests/phpDocumentor/Reflection/DocBlock/Tag/VarTagTest.php b/tests/phpDocumentor/Reflection/DocBlock/Tag/VarTagTest.php index de4b2d2..6ede97d 100644 --- a/tests/phpDocumentor/Reflection/DocBlock/Tag/VarTagTest.php +++ b/tests/phpDocumentor/Reflection/DocBlock/Tag/VarTagTest.php @@ -1,9 +1,13 @@ - * @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) + * @author Daniel O'Connor + * @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; @@ -11,8 +15,10 @@ namespace phpDocumentor\Reflection\DocBlock\Tag; /** * Test class for phpDocumentor_Reflection_DocBlock_Tag_Link * - * @author Daniel O'Connor - * @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) + * @author Daniel O'Connor + * @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 { @@ -33,8 +39,7 @@ class VarTagTest extends \PHPUnit_Framework_TestCase */ public function testConstructorParesInputsIntoCorrectFields( $type, $content, $exType, $exVariable, $exDescription - ) - { + ) { $tag = new VarTag($type, $content); $this->assertEquals($exType, $tag->getType()); diff --git a/tests/phpDocumentor/Reflection/DocBlock/Type/CollectionTest.php b/tests/phpDocumentor/Reflection/DocBlock/Type/CollectionTest.php index 70c98ea..7288458 100644 --- a/tests/phpDocumentor/Reflection/DocBlock/Type/CollectionTest.php +++ b/tests/phpDocumentor/Reflection/DocBlock/Type/CollectionTest.php @@ -1,9 +1,26 @@ + * @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 + * * @covers phpDocumentor\Reflection\DocBlock\Type\Collection + * + * @author Mike van Riel + * @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() { @@ -135,7 +170,7 @@ class CollectionTest extends \PHPUnit_Framework_TestCase * Returns the types and their expected values to test the retrieval of * 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. * * @return string[] @@ -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[] */ diff --git a/tests/phpDocumentor/Reflection/DocBlockTest.php b/tests/phpDocumentor/Reflection/DocBlockTest.php index 328a2c7..c08447c 100644 --- a/tests/phpDocumentor/Reflection/DocBlockTest.php +++ b/tests/phpDocumentor/Reflection/DocBlockTest.php @@ -2,10 +2,12 @@ /** * phpDocumentor DocBlock Test * - * PHP Version 5 + * PHP Version 5.3 * - * @author Mike van Riel - * @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) + * @author Mike van Riel + * @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; @@ -13,8 +15,10 @@ namespace phpDocumentor\Reflection; /** * Test class for phpDocumentor_Reflection_DocBlock * - * @author Mike van Riel - * @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) + * @author Mike van Riel + * @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 {