mirror of
https://github.com/barryvdh/ReflectionDocBlock.git
synced 2026-08-18 18:13:13 +00:00
Compare commits
146
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
494d594733 | ||
|
|
afd2520734 | ||
|
|
ef39243160 | ||
|
|
ae15da2ce2 | ||
|
|
d1da796ba5 | ||
|
|
868311451b | ||
|
|
5a87e6edaa | ||
|
|
b79f9f311d | ||
|
|
702c5682ae | ||
|
|
0d324618be | ||
|
|
ff902a0beb | ||
|
|
a8ebd67e2a | ||
|
|
09352d3406 | ||
|
|
7b8092e37f | ||
|
|
f8bb8d74ae | ||
|
|
d68dbdc53d | ||
|
|
fb5dfa51d4 | ||
|
|
ae02953010 | ||
|
|
fd0ac20074 | ||
|
|
21feb61eb5 | ||
|
|
280a3ce56d | ||
|
|
0604d62704 | ||
|
|
a66d783afd | ||
|
|
84de81c009 | ||
|
|
38743b6779 | ||
|
|
0d52cb6389 | ||
|
|
2281569ebc | ||
|
|
e0faa7f04f | ||
|
|
39a08094f1 | ||
|
|
07b195e1ee | ||
|
|
0bca477a34 | ||
|
|
66a7d3bf31 | ||
|
|
2331fc92f6 | ||
|
|
b1922e00de | ||
|
|
53ba484043 | ||
|
|
cfb3ebea55 | ||
|
|
c33820b04b | ||
|
|
280c4a1d44 | ||
|
|
66ae84e9d7 | ||
|
|
3023fb2220 | ||
|
|
a9b6edf3ce | ||
|
|
f3d1a28bf7 | ||
|
|
6d705c1a0f | ||
|
|
ab0bcb8d31 | ||
|
|
ac6e37af97 | ||
|
|
4a7affe15b | ||
|
|
b7797b4e1a | ||
|
|
8b529636bf | ||
|
|
2e9fd6a2e8 | ||
|
|
cbb14bab1e | ||
|
|
d57128e65c | ||
|
|
d9c0928243 | ||
|
|
63c9de4e8b | ||
|
|
76619d4a16 | ||
|
|
47d3f86c53 | ||
|
|
cfb104b8c8 | ||
|
|
5c51ccf185 | ||
|
|
5d93f42598 | ||
|
|
eb83d810de | ||
|
|
6f0fc03c49 | ||
|
|
b09525332f | ||
|
|
c2796044a6 | ||
|
|
8418970624 | ||
|
|
0d38c84407 | ||
|
|
bfc443b40c | ||
|
|
4a9ddd15fe | ||
|
|
87ed522579 | ||
|
|
f01f8ea41d | ||
|
|
620b932272 | ||
|
|
beb96a487b | ||
|
|
7a03741e0b | ||
|
|
a79e4c174c | ||
|
|
be61012d74 | ||
|
|
99de44e96f | ||
|
|
b20c7da00b | ||
|
|
99054d341f | ||
|
|
9da4a65065 | ||
|
|
39faeec91d | ||
|
|
0c15eb99f5 | ||
|
|
21c36677ab | ||
|
|
ffcaa03337 | ||
|
|
37810ef836 | ||
|
|
587406073d | ||
|
|
aed654aa85 | ||
|
|
2812eac046 | ||
|
|
db20ae39fb | ||
|
|
cdaa97eb31 | ||
|
|
27bdc08a1e | ||
|
|
a18985a888 | ||
|
|
747e6d7cdf | ||
|
|
c2f692140f | ||
|
|
8eb596c1cc | ||
|
|
26e2eade91 | ||
|
|
1ac9106c48 | ||
|
|
1352ef56a6 | ||
|
|
6df31db139 | ||
|
|
829a92e5aa | ||
|
|
04936a7b39 | ||
|
|
ae82b8488f | ||
|
|
bae65d2afe | ||
|
|
28df2a4cd6 | ||
|
|
fedcd8cf49 | ||
|
|
a868c60f8e | ||
|
|
e6d2ec7c54 | ||
|
|
f19dac185a | ||
|
|
0ba0ad6b42 | ||
|
|
8b9591a7c5 | ||
|
|
082c9354d0 | ||
|
|
233e4b3ff7 | ||
|
|
d788b51755 | ||
|
|
bbd5775f1f | ||
|
|
044ebd68c9 | ||
|
|
e0a5a75364 | ||
|
|
607aa79601 | ||
|
|
a4107acb6d | ||
|
|
34eabb7d11 | ||
|
|
f07ab7eda0 | ||
|
|
d6119709ba | ||
|
|
21ec090933 | ||
|
|
ba1395e42d | ||
|
|
9a3c6f50ef | ||
|
|
009237bad2 | ||
|
|
6b707f7166 | ||
|
|
5236694595 | ||
|
|
ce57e5445f | ||
|
|
37f5090d90 | ||
|
|
5941846e99 | ||
|
|
95ad95d3be | ||
|
|
aa61de9761 | ||
|
|
a935cbfff9 | ||
|
|
ee412932f1 | ||
|
|
c8fe0e4e40 | ||
|
|
ad4e358fb0 | ||
|
|
1b3acdce18 | ||
|
|
4235beebfa | ||
|
|
60ba10fad1 | ||
|
|
f3cca4b7c7 | ||
|
|
e0d8988490 | ||
|
|
91ef535ae3 | ||
|
|
c999e7d32a | ||
|
|
2b05ea3221 | ||
|
|
33a2e55cbc | ||
|
|
3d97a72bac | ||
|
|
51210b581e | ||
|
|
cee3c0bc21 | ||
|
|
731e797dd8 |
@@ -1 +1,3 @@
|
|||||||
.idea
|
.idea
|
||||||
|
composer.lock
|
||||||
|
vendor
|
||||||
|
|||||||
@@ -0,0 +1,45 @@
|
|||||||
|
before_commands:
|
||||||
|
- "composer install --no-dev --prefer-source"
|
||||||
|
|
||||||
|
tools:
|
||||||
|
external_code_coverage:
|
||||||
|
enabled: false
|
||||||
|
timeout: 300
|
||||||
|
filter:
|
||||||
|
excluded_paths: ["tests", "vendor"]
|
||||||
|
php_code_coverage:
|
||||||
|
enabled: false
|
||||||
|
test_command: phpunit -c phpunit.xml.dist
|
||||||
|
php_code_sniffer:
|
||||||
|
enabled: true
|
||||||
|
config:
|
||||||
|
standard: PSR2
|
||||||
|
filter:
|
||||||
|
paths: ["src/*", "tests/*"]
|
||||||
|
php_cpd:
|
||||||
|
enabled: true
|
||||||
|
excluded_dirs: ["tests", "vendor"]
|
||||||
|
php_cs_fixer:
|
||||||
|
enabled: true
|
||||||
|
config:
|
||||||
|
level: all
|
||||||
|
filter:
|
||||||
|
paths: ["src/*", "tests/*"]
|
||||||
|
php_loc:
|
||||||
|
enabled: true
|
||||||
|
excluded_dirs: ["tests", "vendor"]
|
||||||
|
php_mess_detector:
|
||||||
|
enabled: true
|
||||||
|
config:
|
||||||
|
ruleset: phpmd.xml.dist
|
||||||
|
design_rules: { eval_expression: false }
|
||||||
|
filter:
|
||||||
|
paths: ["src/*"]
|
||||||
|
php_pdepend:
|
||||||
|
enabled: true
|
||||||
|
excluded_dirs: ["tests", "vendor"]
|
||||||
|
php_analyzer:
|
||||||
|
enabled: true
|
||||||
|
filter:
|
||||||
|
paths: ["src/*", "tests/*"]
|
||||||
|
sensiolabs_security_checker: true
|
||||||
+33
@@ -0,0 +1,33 @@
|
|||||||
|
language: php
|
||||||
|
php:
|
||||||
|
- 5.3.3
|
||||||
|
- 5.3
|
||||||
|
- 5.4
|
||||||
|
- 5.5
|
||||||
|
- 5.6
|
||||||
|
- 7.0
|
||||||
|
- hhvm
|
||||||
|
- hhvm-nightly
|
||||||
|
|
||||||
|
matrix:
|
||||||
|
allow_failures:
|
||||||
|
- php: hhvm
|
||||||
|
- php: hhvm-nightly
|
||||||
|
|
||||||
|
script:
|
||||||
|
- vendor/bin/phpunit
|
||||||
|
|
||||||
|
before_script:
|
||||||
|
- sudo apt-get -qq update > /dev/null
|
||||||
|
- phpenv rehash > /dev/null
|
||||||
|
- composer selfupdate --quiet
|
||||||
|
- composer install --no-interaction --prefer-source --dev
|
||||||
|
- vendor/bin/phpunit
|
||||||
|
- composer update --no-interaction --prefer-source --dev
|
||||||
|
|
||||||
|
notifications:
|
||||||
|
irc: "irc.freenode.org#phpdocumentor"
|
||||||
|
email:
|
||||||
|
- [email protected]
|
||||||
|
- [email protected]
|
||||||
|
- [email protected]
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
The MIT License (MIT)
|
||||||
|
|
||||||
|
Copyright (c) 2010 Mike van Riel
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in
|
||||||
|
all copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||||
|
THE SOFTWARE.
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
The ReflectionDocBlock Component
|
The ReflectionDocBlock Component [](https://travis-ci.org/phpDocumentor/ReflectionDocBlock)
|
||||||
================================
|
================================
|
||||||
|
|
||||||
Introduction
|
Introduction
|
||||||
@@ -7,7 +7,7 @@ Introduction
|
|||||||
The ReflectionDocBlock component of phpDocumentor provides a DocBlock parser
|
The ReflectionDocBlock component of phpDocumentor provides a DocBlock parser
|
||||||
that is 100% compatible with the [PHPDoc standard](http://phpdoc.org/docs/latest).
|
that is 100% compatible with the [PHPDoc standard](http://phpdoc.org/docs/latest).
|
||||||
|
|
||||||
With this component can a library provide support for annotations via DocBlocks
|
With this component, a library can provide support for annotations via DocBlocks
|
||||||
or otherwise retrieve information that is embedded in a DocBlock.
|
or otherwise retrieve information that is embedded in a DocBlock.
|
||||||
|
|
||||||
> **Note**: *this is a core component of phpDocumentor and is constantly being
|
> **Note**: *this is a core component of phpDocumentor and is constantly being
|
||||||
|
|||||||
+14
-3
@@ -6,10 +6,21 @@
|
|||||||
{"name": "Mike van Riel", "email": "[email protected]"}
|
{"name": "Mike van Riel", "email": "[email protected]"}
|
||||||
],
|
],
|
||||||
"require": {
|
"require": {
|
||||||
"php": ">=5.3.2",
|
"php": ">=5.3.3"
|
||||||
"dflydev/markdown": "1.0.*"
|
|
||||||
},
|
},
|
||||||
"autoload": {
|
"autoload": {
|
||||||
"psr-0": {"phpDocumentor\\Reflection": "src/"}
|
"psr-0": {"phpDocumentor": ["src/"]}
|
||||||
|
},
|
||||||
|
"require-dev": {
|
||||||
|
"phpunit/phpunit": "~4.0"
|
||||||
|
},
|
||||||
|
"suggest": {
|
||||||
|
"erusev/parsedown": "~1.0",
|
||||||
|
"league/commonmark": "*"
|
||||||
|
},
|
||||||
|
"extra": {
|
||||||
|
"branch-alias": {
|
||||||
|
"dev-master": "2.0.x-dev"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8" ?>
|
||||||
|
<ruleset
|
||||||
|
name="ProxyManager rules"
|
||||||
|
xmlns="http://pmd.sf.net/ruleset/1.0.0"
|
||||||
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||||
|
xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd"
|
||||||
|
xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd"
|
||||||
|
>
|
||||||
|
<rule ref="rulesets/codesize.xml"/>
|
||||||
|
<rule ref="rulesets/unusedcode.xml"/>
|
||||||
|
<rule ref="rulesets/design.xml">
|
||||||
|
<!-- eval is needed to generate runtime classes -->
|
||||||
|
<exclude name="EvalExpression"/>
|
||||||
|
</rule>
|
||||||
|
<rule ref="rulesets/naming.xml">
|
||||||
|
<exclude name="LongVariable"/>
|
||||||
|
</rule>
|
||||||
|
<rule ref="rulesets/naming.xml/LongVariable">
|
||||||
|
<properties>
|
||||||
|
<property name="minimum">40</property>
|
||||||
|
</properties>
|
||||||
|
</rule>
|
||||||
|
</ruleset>
|
||||||
+6
-1
@@ -1,9 +1,14 @@
|
|||||||
<?xml version="1.0" encoding="utf-8"?>
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
|
|
||||||
<phpunit colors="true" strict="true">
|
<phpunit colors="true" strict="true" bootstrap="vendor/autoload.php">
|
||||||
<testsuites>
|
<testsuites>
|
||||||
<testsuite name="phpDocumentor\Reflection\DocBlock">
|
<testsuite name="phpDocumentor\Reflection\DocBlock">
|
||||||
<directory>./tests/</directory>
|
<directory>./tests/</directory>
|
||||||
</testsuite>
|
</testsuite>
|
||||||
</testsuites>
|
</testsuites>
|
||||||
|
<filter>
|
||||||
|
<whitelist>
|
||||||
|
<directory suffix=".php">./src/</directory>
|
||||||
|
</whitelist>
|
||||||
|
</filter>
|
||||||
</phpunit>
|
</phpunit>
|
||||||
|
|||||||
@@ -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)
|
||||||
@@ -12,12 +12,16 @@
|
|||||||
|
|
||||||
namespace phpDocumentor\Reflection;
|
namespace phpDocumentor\Reflection;
|
||||||
|
|
||||||
|
use phpDocumentor\Reflection\DocBlock\Tag;
|
||||||
|
use phpDocumentor\Reflection\DocBlock\Context;
|
||||||
|
use phpDocumentor\Reflection\DocBlock\Location;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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,52 +29,52 @@ class DocBlock implements \Reflector
|
|||||||
protected $short_description = '';
|
protected $short_description = '';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @var \phpDocumentor\Reflection\DocBlock\LongDescription The actual description
|
* @var DocBlock\Description 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 Tag[] An array containing all
|
||||||
* in this docblock; except inline.
|
* the tags in this docblock; except inline.
|
||||||
*/
|
*/
|
||||||
protected $tags = array();
|
protected $tags = array();
|
||||||
|
|
||||||
/** @var string the current namespace */
|
/** @var Context Information about the context of this DocBlock. */
|
||||||
protected $namespace = '\\';
|
protected $context = null;
|
||||||
|
|
||||||
/** @var string[] List of namespace aliases => Fully Qualified Namespace */
|
/** @var Location Information about the location of this DocBlock. */
|
||||||
protected $namespace_aliases = array();
|
protected $location = null;
|
||||||
|
|
||||||
|
/** @var bool Is this DocBlock (the start of) a template? */
|
||||||
|
protected $isTemplateStart = false;
|
||||||
|
|
||||||
|
/** @var bool Does this DocBlock signify the end of a DocBlock template? */
|
||||||
|
protected $isTemplateEnd = false;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Parses the given docblock and populates the member fields.
|
* Parses the given docblock and populates the member fields.
|
||||||
*
|
*
|
||||||
* The constructor may also receive namespace information such as the
|
* The constructor may also receive namespace information such as the
|
||||||
* current namespace and aliases. This information is used in the
|
* current namespace and aliases. This information is used by some tags
|
||||||
* {@link expandType()} method to transform a relative Type into a FQCN.
|
* (e.g. return, param, etc.) to turn a relative Type into a FQCN.
|
||||||
*
|
*
|
||||||
* For example the param and return tags use this to expand their type
|
* @param \Reflector|string $docblock A docblock comment (including asterisks) or reflector supporting the
|
||||||
* 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.
|
|
||||||
*
|
|
||||||
* @throws \InvalidArgumentException if the given argument does not have the
|
|
||||||
* getDocComment method.
|
* getDocComment method.
|
||||||
|
* @param Context $context The context in which the DocBlock occurs.
|
||||||
|
* @param Location $location The location within the file that this DocBlock occurs in.
|
||||||
|
*
|
||||||
|
* @throws \InvalidArgumentException if the given argument does not have the getDocComment method.
|
||||||
*/
|
*/
|
||||||
public function __construct(
|
public function __construct(
|
||||||
$docblock, $namespace = '\\', $namespace_aliases = array()
|
$docblock,
|
||||||
|
Context $context = null,
|
||||||
|
Location $location = null
|
||||||
) {
|
) {
|
||||||
if (is_object($docblock)) {
|
if (is_object($docblock)) {
|
||||||
if (!method_exists($docblock, 'getDocComment')) {
|
if (!method_exists($docblock, 'getDocComment')) {
|
||||||
throw new \InvalidArgumentException(
|
throw new \InvalidArgumentException(
|
||||||
'Invalid object passed; the given reflector must support '
|
'Invalid object passed; the given reflector must support the getDocComment method'
|
||||||
. 'the getDocComment method'
|
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -79,13 +83,15 @@ class DocBlock implements \Reflector
|
|||||||
|
|
||||||
$docblock = $this->cleanInput($docblock);
|
$docblock = $this->cleanInput($docblock);
|
||||||
|
|
||||||
list($short, $long, $tags) = $this->splitDocBlock($docblock);
|
list($templateMarker, $short, $long, $tags) = $this->splitDocBlock($docblock);
|
||||||
|
$this->isTemplateStart = $templateMarker === '#@+';
|
||||||
|
$this->isTemplateEnd = $templateMarker === '#@-';
|
||||||
$this->short_description = $short;
|
$this->short_description = $short;
|
||||||
$this->long_description = new DocBlock\LongDescription($long);
|
$this->long_description = new DocBlock\Description($long, $this);
|
||||||
$this->parseTags($tags);
|
$this->parseTags($tags);
|
||||||
|
|
||||||
$this->namespace = $namespace;
|
$this->context = $context;
|
||||||
$this->namespace_aliases = $namespace_aliases;
|
$this->location = $location;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -99,7 +105,9 @@ class DocBlock implements \Reflector
|
|||||||
{
|
{
|
||||||
$comment = trim(
|
$comment = trim(
|
||||||
preg_replace(
|
preg_replace(
|
||||||
'#[ \t]*(?:\/\*\*|\*\/|\*)?[ \t]{0,1}(.*)?#', '$1', $comment
|
'#[ \t]*(?:\/\*\*|\*\/|\*)?[ \t]{0,1}(.*)?#u',
|
||||||
|
'$1',
|
||||||
|
$comment
|
||||||
)
|
)
|
||||||
);
|
);
|
||||||
|
|
||||||
@@ -115,72 +123,86 @@ class DocBlock implements \Reflector
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Splits the DocBlock into a short description, long description and
|
* Splits the DocBlock into a template marker, summary, description and block of tags.
|
||||||
* block of tags.
|
|
||||||
*
|
*
|
||||||
* @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 Richard van Velzen (@_richardJ) Special thanks to Richard for the regex responsible for the split.
|
||||||
* for the split/
|
* @author Mike van Riel <[email protected]> for extending the regex with template marker support.
|
||||||
*
|
*
|
||||||
* @return string[] containing the short-, long description and an element
|
* @return string[] containing the template marker (if any), summary, description and a string containing the tags.
|
||||||
* containing the tags.
|
|
||||||
*/
|
*/
|
||||||
protected function splitDocBlock($comment)
|
protected function splitDocBlock($comment)
|
||||||
{
|
{
|
||||||
|
// Performance improvement cheat: if the first character is an @ then only tags are in this DocBlock. This
|
||||||
|
// method does not split tags so we return this verbatim as the fourth result (tags). This saves us the
|
||||||
|
// performance impact of running a regular expression
|
||||||
if (strpos($comment, '@') === 0) {
|
if (strpos($comment, '@') === 0) {
|
||||||
$matches = array('', '', $comment);
|
return array('', '', '', $comment);
|
||||||
} else {
|
|
||||||
// clears all extra horizontal whitespace from the line endings
|
|
||||||
// to prevent parsing issues
|
|
||||||
$comment = preg_replace('~(?m)\h*$~', '', $comment);
|
|
||||||
|
|
||||||
/*
|
|
||||||
* Splits the docblock into a short description, long description and
|
|
||||||
* tags section
|
|
||||||
* - The short description is started from the first character until
|
|
||||||
* a dot is encountered followed by a whitespace OR
|
|
||||||
* two consecutive newlines (horizontal whitespace is taken into
|
|
||||||
* account to consider spacing errors)
|
|
||||||
* - The long description, any character until a new line is
|
|
||||||
* encountered followed by an @ and word characters (a tag).
|
|
||||||
* This is optional.
|
|
||||||
* - Tags; the remaining characters
|
|
||||||
*
|
|
||||||
* Big thanks to RichardJ for contributing this Regular Expression
|
|
||||||
*/
|
|
||||||
preg_match(
|
|
||||||
'/(?x)
|
|
||||||
\A (
|
|
||||||
[^\n.]+
|
|
||||||
(?:
|
|
||||||
(?! \. \s | \n{2} ) # disallow the first seperator here
|
|
||||||
[\n.] (?! [ \t]* @\pL ) # disallow second seperator
|
|
||||||
[^\n.]+
|
|
||||||
)*
|
|
||||||
\.?
|
|
||||||
)
|
|
||||||
(?:
|
|
||||||
\s* # first seperator (actually newlines but it\'s all whitespace)
|
|
||||||
(?! @\pL ) # disallow the rest, to make sure this one doesn\'t match,
|
|
||||||
#if it doesn\'t exist
|
|
||||||
(
|
|
||||||
[^\n]+
|
|
||||||
(?: \n+
|
|
||||||
(?! [ \t]* @\pL ) # disallow second seperator (@param)
|
|
||||||
[^\n]+
|
|
||||||
)*
|
|
||||||
)
|
|
||||||
)?
|
|
||||||
(\s+ [\s\S]*)? # everything that follows
|
|
||||||
/', $comment, $matches
|
|
||||||
);
|
|
||||||
array_shift($matches);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
while (count($matches) < 3) {
|
// clears all extra horizontal whitespace from the line endings to prevent parsing issues
|
||||||
|
$comment = preg_replace('/\h*$/Sum', '', $comment);
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Splits the docblock into a template marker, short description, long description and tags section
|
||||||
|
*
|
||||||
|
* - The template marker is empty, #@+ or #@- if the DocBlock starts with either of those (a newline may
|
||||||
|
* occur after it and will be stripped).
|
||||||
|
* - The short description is started from the first character until a dot is encountered followed by a
|
||||||
|
* newline OR two consecutive newlines (horizontal whitespace is taken into account to consider spacing
|
||||||
|
* errors). This is optional.
|
||||||
|
* - The long description, any character until a new line is encountered followed by an @ and word
|
||||||
|
* characters (a tag). This is optional.
|
||||||
|
* - Tags; the remaining characters
|
||||||
|
*
|
||||||
|
* Big thanks to RichardJ for contributing this Regular Expression
|
||||||
|
*/
|
||||||
|
preg_match(
|
||||||
|
'/
|
||||||
|
\A
|
||||||
|
# 1. Extract the template marker
|
||||||
|
(?:(\#\@\+|\#\@\-)\n?)?
|
||||||
|
|
||||||
|
# 2. Extract the summary
|
||||||
|
(?:
|
||||||
|
(?! @\pL ) # The summary may not start with an @
|
||||||
|
(
|
||||||
|
[^\n.]+
|
||||||
|
(?:
|
||||||
|
(?! \. \n | \n{2} ) # End summary upon a dot followed by newline or two newlines
|
||||||
|
[\n.] (?! [ \t]* @\pL ) # End summary when an @ is found as first character on a new line
|
||||||
|
[^\n.]+ # Include anything else
|
||||||
|
)*
|
||||||
|
\.?
|
||||||
|
)?
|
||||||
|
)
|
||||||
|
|
||||||
|
# 3. Extract the description
|
||||||
|
(?:
|
||||||
|
\s* # Some form of whitespace _must_ precede a description because a summary must be there
|
||||||
|
(?! @\pL ) # The description may not start with an @
|
||||||
|
(
|
||||||
|
[^\n]+
|
||||||
|
(?: \n+
|
||||||
|
(?! [ \t]* @\pL ) # End description when an @ is found as first character on a new line
|
||||||
|
[^\n]+ # Include anything else
|
||||||
|
)*
|
||||||
|
)
|
||||||
|
)?
|
||||||
|
|
||||||
|
# 4. Extract the tags (anything that follows)
|
||||||
|
(\s+ [\s\S]*)? # everything that follows
|
||||||
|
/ux',
|
||||||
|
$comment,
|
||||||
|
$matches
|
||||||
|
);
|
||||||
|
array_shift($matches);
|
||||||
|
|
||||||
|
while (count($matches) < 4) {
|
||||||
$matches[] = '';
|
$matches[] = '';
|
||||||
}
|
}
|
||||||
|
|
||||||
return $matches;
|
return $matches;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -194,37 +216,67 @@ class DocBlock implements \Reflector
|
|||||||
protected function parseTags($tags)
|
protected function parseTags($tags)
|
||||||
{
|
{
|
||||||
$result = array();
|
$result = array();
|
||||||
foreach (explode("\n", trim($tags)) as $tag_line) {
|
$tags = trim($tags);
|
||||||
if (trim($tag_line) === '') {
|
if ('' !== $tags) {
|
||||||
continue;
|
if ('@' !== $tags[0]) {
|
||||||
|
throw new \LogicException(
|
||||||
|
'A tag block started with text instead of an actual tag,'
|
||||||
|
. ' this makes the tag block invalid: ' . $tags
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
foreach (explode("\n", $tags) as $tag_line) {
|
||||||
$tag_line = ltrim($tag_line);
|
if (isset($tag_line[0]) && ($tag_line[0] === '@')) {
|
||||||
|
$result[] = $tag_line;
|
||||||
if (isset($tag_line[0]) && ($tag_line[0] === '@')) {
|
} else {
|
||||||
$result[] = $tag_line;
|
$result[count($result) - 1] .= "\n" . $tag_line;
|
||||||
} else {
|
|
||||||
if (count($result) == 0) {
|
|
||||||
throw new \LogicException(
|
|
||||||
'A tag block started with text instead of an actual tag,'
|
|
||||||
. ' this makes the tag block invalid: ' . $tags
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
$result[count($result) - 1] .= PHP_EOL . $tag_line;
|
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
// create proper Tag objects
|
// create proper Tag objects
|
||||||
foreach ($result as $key => $tag_line) {
|
foreach ($result as $key => $tag_line) {
|
||||||
$tag = DocBlock\Tag::createInstance($tag_line);
|
$result[$key] = Tag::createInstance(trim($tag_line), $this);
|
||||||
$tag->setDocBlock($this);
|
}
|
||||||
$result[$key] = $tag;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
$this->tags = $result;
|
$this->tags = $result;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the text portion of the doc block.
|
||||||
|
*
|
||||||
|
* Gets the text portion (short and long description combined) of the doc
|
||||||
|
* block.
|
||||||
|
*
|
||||||
|
* @return string The text portion of the doc block.
|
||||||
|
*/
|
||||||
|
public function getText()
|
||||||
|
{
|
||||||
|
$short = $this->getShortDescription();
|
||||||
|
$long = $this->getLongDescription()->getContents();
|
||||||
|
|
||||||
|
if ($long) {
|
||||||
|
return "{$short}\n\n{$long}";
|
||||||
|
} else {
|
||||||
|
return $short;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set the text portion of the DocBlock.
|
||||||
|
*
|
||||||
|
* Sets the text portion (short and long description combined) of the DocBlock.
|
||||||
|
*
|
||||||
|
* @param string $comment The new text portion of the DocBlock.
|
||||||
|
*
|
||||||
|
* @return $this
|
||||||
|
*/
|
||||||
|
public function setText($comment)
|
||||||
|
{
|
||||||
|
list(,$short, $long) = $this->splitDocBlock($comment);
|
||||||
|
$this->short_description = $short;
|
||||||
|
$this->long_description = new DocBlock\Description($long, $this);
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
/**
|
/**
|
||||||
* Returns the opening line or also known as short description.
|
* Returns the opening line or also known as short description.
|
||||||
*
|
*
|
||||||
@@ -238,17 +290,75 @@ class DocBlock implements \Reflector
|
|||||||
/**
|
/**
|
||||||
* Returns the full description or also known as long description.
|
* Returns the full description or also known as long description.
|
||||||
*
|
*
|
||||||
* @return \phpDocumentor\Reflection\DocBlock\LongDescription
|
* @return DocBlock\Description
|
||||||
*/
|
*/
|
||||||
public function getLongDescription()
|
public function getLongDescription()
|
||||||
{
|
{
|
||||||
return $this->long_description;
|
return $this->long_description;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns whether this DocBlock is the start of a Template section.
|
||||||
|
*
|
||||||
|
* A Docblock may serve as template for a series of subsequent DocBlocks. This is indicated by a special marker
|
||||||
|
* (`#@+`) that is appended directly after the opening `/**` of a DocBlock.
|
||||||
|
*
|
||||||
|
* An example of such an opening is:
|
||||||
|
*
|
||||||
|
* ```
|
||||||
|
* /**#@+
|
||||||
|
* * My DocBlock
|
||||||
|
* * /
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* The description and tags (not the summary!) are copied onto all subsequent DocBlocks and also applied to all
|
||||||
|
* elements that follow until another DocBlock is found that contains the closing marker (`#@-`).
|
||||||
|
*
|
||||||
|
* @see self::isTemplateEnd() for the check whether a closing marker was provided.
|
||||||
|
*
|
||||||
|
* @return boolean
|
||||||
|
*/
|
||||||
|
public function isTemplateStart()
|
||||||
|
{
|
||||||
|
return $this->isTemplateStart;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns whether this DocBlock is the end of a Template section.
|
||||||
|
*
|
||||||
|
* @see self::isTemplateStart() for a more complete description of the Docblock Template functionality.
|
||||||
|
*
|
||||||
|
* @return boolean
|
||||||
|
*/
|
||||||
|
public function isTemplateEnd()
|
||||||
|
{
|
||||||
|
return $this->isTemplateEnd;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the current context.
|
||||||
|
*
|
||||||
|
* @return Context
|
||||||
|
*/
|
||||||
|
public function getContext()
|
||||||
|
{
|
||||||
|
return $this->context;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the current location.
|
||||||
|
*
|
||||||
|
* @return Location
|
||||||
|
*/
|
||||||
|
public function getLocation()
|
||||||
|
{
|
||||||
|
return $this->location;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the tags for this DocBlock.
|
* Returns the tags for this DocBlock.
|
||||||
*
|
*
|
||||||
* @return \phpDocumentor\Reflection\DocBlock\Tag[]
|
* @return Tag[]
|
||||||
*/
|
*/
|
||||||
public function getTags()
|
public function getTags()
|
||||||
{
|
{
|
||||||
@@ -256,18 +366,18 @@ class DocBlock implements \Reflector
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns an array of tags matching the given name; if no tags are found
|
* Returns an array of tags matching the given name. If no tags are found
|
||||||
* an empty array is returned.
|
* an empty array is returned.
|
||||||
*
|
*
|
||||||
* @param string $name String to search by.
|
* @param string $name String to search by.
|
||||||
*
|
*
|
||||||
* @return \phpDocumentor\Reflection\DocBlock_Tag[]
|
* @return Tag[]
|
||||||
*/
|
*/
|
||||||
public function getTagsByName($name)
|
public function getTagsByName($name)
|
||||||
{
|
{
|
||||||
$result = array();
|
$result = array();
|
||||||
|
|
||||||
/** @var \phpDocumentor\Reflection\DocBlock\Tag $tag */
|
/** @var Tag $tag */
|
||||||
foreach ($this->getTags() as $tag) {
|
foreach ($this->getTags() as $tag) {
|
||||||
if ($tag->getName() != $name) {
|
if ($tag->getName() != $name) {
|
||||||
continue;
|
continue;
|
||||||
@@ -288,7 +398,7 @@ class DocBlock implements \Reflector
|
|||||||
*/
|
*/
|
||||||
public function hasTag($name)
|
public function hasTag($name)
|
||||||
{
|
{
|
||||||
/** @var \phpDocumentor\Reflection\DocBlock\Tag $tag */
|
/** @var Tag $tag */
|
||||||
foreach ($this->getTags() as $tag) {
|
foreach ($this->getTags() as $tag) {
|
||||||
if ($tag->getName() == $name) {
|
if ($tag->getName() == $name) {
|
||||||
return true;
|
return true;
|
||||||
@@ -299,92 +409,32 @@ class DocBlock implements \Reflector
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Tries to expand a type to it's full namespaced equivalent (FQCN).
|
* Appends a tag at the end of the list of tags.
|
||||||
*
|
*
|
||||||
* This method will take the given type and examine the current namespace
|
* @param Tag $tag The tag to add.
|
||||||
* and namespace aliases to see whether it should expand it into a FQCN
|
|
||||||
* as defined by the rules in PHP.
|
|
||||||
*
|
*
|
||||||
* @param string $type Type to expand into full namespaced
|
* @return Tag The newly added tag.
|
||||||
* 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'.
|
|
||||||
* Default value for this parameter is null.
|
|
||||||
*
|
*
|
||||||
* @return string
|
* @throws \LogicException When the tag belongs to a different DocBlock.
|
||||||
*/
|
*/
|
||||||
public function expandType($type, $ignore_keywords = null)
|
public function appendTag(Tag $tag)
|
||||||
{
|
{
|
||||||
if ($type === null) {
|
if (null === $tag->getDocBlock()) {
|
||||||
return null;
|
$tag->setDocBlock($this);
|
||||||
}
|
}
|
||||||
|
|
||||||
if ($ignore_keywords === null) {
|
if ($tag->getDocBlock() === $this) {
|
||||||
$ignore_keywords = array(
|
$this->tags[] = $tag;
|
||||||
'string', 'int', 'integer', 'bool', 'boolean', 'float', 'double',
|
} else {
|
||||||
'object', 'mixed', 'array', 'resource', 'void', 'null',
|
throw new \LogicException(
|
||||||
'callback', 'false', 'true'
|
'This tag belongs to a different DocBlock object.'
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
$namespace = '';
|
return $tag;
|
||||||
if ($this->namespace != 'default') {
|
|
||||||
$namespace = rtrim($this->namespace, '\\') . '\\';
|
|
||||||
}
|
|
||||||
|
|
||||||
$type = explode('|', $type);
|
|
||||||
foreach ($type as &$item) {
|
|
||||||
$item = trim($item);
|
|
||||||
|
|
||||||
// add support for array notation
|
|
||||||
$is_array = false;
|
|
||||||
if (substr($item, -2) == '[]') {
|
|
||||||
$item = substr($item, 0, -2);
|
|
||||||
$is_array = true;
|
|
||||||
}
|
|
||||||
|
|
||||||
if ((substr($item, 0, 1) != '\\')
|
|
||||||
&& (!in_array(strtolower($item), $ignore_keywords))
|
|
||||||
) {
|
|
||||||
$type_parts = explode('\\', $item);
|
|
||||||
|
|
||||||
// if the first part is the keyword 'namespace', replace it
|
|
||||||
// with the current namespace
|
|
||||||
if ($type_parts[0] == 'namespace') {
|
|
||||||
$type_parts[0] = $this->getNamespace();
|
|
||||||
$item = implode('\\', $type_parts);
|
|
||||||
}
|
|
||||||
|
|
||||||
// if the first segment is an alias; replace with full name
|
|
||||||
if (isset($this->namespace_aliases[$type_parts[0]])) {
|
|
||||||
$type_parts[0] = $this->namespace_aliases[$type_parts[0]];
|
|
||||||
|
|
||||||
$item = implode('\\', $type_parts);
|
|
||||||
} elseif (count($type_parts) == 1) {
|
|
||||||
// prefix the item with the namespace if there is only one
|
|
||||||
// part and no alias
|
|
||||||
$item = $namespace . $item;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// full paths always start with a slash
|
|
||||||
if (isset($item[0]) && ($item[0] !== '\\')
|
|
||||||
&& (!in_array(strtolower($item), $ignore_keywords))
|
|
||||||
) {
|
|
||||||
$item = '\\' . $item;
|
|
||||||
}
|
|
||||||
|
|
||||||
// re-add the array notation markers
|
|
||||||
if ($is_array) {
|
|
||||||
$item .= '[]';
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return implode('|', $type);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Builds a string representation of this object.
|
* Builds a string representation of this object.
|
||||||
*
|
*
|
||||||
@@ -392,8 +442,9 @@ class DocBlock implements \Reflector
|
|||||||
* implement it.
|
* implement it.
|
||||||
*
|
*
|
||||||
* @return string
|
* @return string
|
||||||
|
* @codeCoverageIgnore Not yet implemented
|
||||||
*/
|
*/
|
||||||
static public function export()
|
public static function export()
|
||||||
{
|
{
|
||||||
throw new \Exception('Not yet implemented');
|
throw new \Exception('Not yet implemented');
|
||||||
}
|
}
|
||||||
@@ -403,10 +454,10 @@ class DocBlock implements \Reflector
|
|||||||
* BUT this throws an exception at this point).
|
* BUT this throws an exception at this point).
|
||||||
*
|
*
|
||||||
* @return string
|
* @return string
|
||||||
|
* @codeCoverageIgnore Not yet implemented
|
||||||
*/
|
*/
|
||||||
public function __toString()
|
public function __toString()
|
||||||
{
|
{
|
||||||
return 'Not yet implemented';
|
return 'Not yet implemented';
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,75 @@
|
|||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* This file is part of phpDocumentor.
|
||||||
|
*
|
||||||
|
* For the full copyright and license information, please view the LICENSE
|
||||||
|
* file that was distributed with this source code.
|
||||||
|
*
|
||||||
|
* @copyright 2010-2015 Mike van Riel<[email protected]>
|
||||||
|
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
||||||
|
* @link http://phpdoc.org
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace phpDocumentor\Reflection\DocBlock;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Provides information about the Context in which the DocBlock occurs that receives this context.
|
||||||
|
*
|
||||||
|
* A DocBlock does not know of its own accord in which namespace it occurs and which namespace aliases are applicable
|
||||||
|
* for the block of code in which it is in. This information is however necessary to resolve Class names in tags since
|
||||||
|
* you can provide a short form or make use of namespace aliases.
|
||||||
|
*
|
||||||
|
* The phpDocumentor Reflection component knows how to create this class but if you use the DocBlock parser from your
|
||||||
|
* own application it is possible to generate a Context class using the ContextFactory; this will analyze the file in
|
||||||
|
* which an associated class resides for its namespace and imports.
|
||||||
|
*
|
||||||
|
* @see ContextFactory::createFromClassReflector()
|
||||||
|
* @see ContextFactory::createForNamespace()
|
||||||
|
*/
|
||||||
|
final class Context
|
||||||
|
{
|
||||||
|
/** @var string The current namespace. */
|
||||||
|
private $namespace = '';
|
||||||
|
|
||||||
|
/** @var array List of namespace aliases => Fully Qualified Namespace. */
|
||||||
|
private $namespaceAliases = [];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Initializes the new context and normalizes all passed namespaces to be in Qualified Namespace Name (QNN)
|
||||||
|
* format (without a preceding `\`).
|
||||||
|
*
|
||||||
|
* @param string $namespace The namespace where this DocBlock resides in.
|
||||||
|
* @param array $namespaceAliases List of namespace aliases => Fully Qualified Namespace.
|
||||||
|
*/
|
||||||
|
public function __construct($namespace, array $namespaceAliases = [])
|
||||||
|
{
|
||||||
|
$this->namespace = ('global' !== $namespace && 'default' !== $namespace)
|
||||||
|
? trim((string)$namespace, '\\')
|
||||||
|
: '';
|
||||||
|
|
||||||
|
foreach ($namespaceAliases as $alias => $fqnn) {
|
||||||
|
$this->namespaceAliases[$alias] = trim((string)$fqnn, '\\');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the Qualified Namespace Name (thus without `\` in front) where the associated element is in.
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getNamespace()
|
||||||
|
{
|
||||||
|
return $this->namespace;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns a list of Qualified Namespace Names (thus without `\` in front) that are imported, the keys represent
|
||||||
|
* the alias for the imported Namespace.
|
||||||
|
*
|
||||||
|
* @return string[]
|
||||||
|
*/
|
||||||
|
public function getNamespaceAliases()
|
||||||
|
{
|
||||||
|
return $this->namespaceAliases;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,174 @@
|
|||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* This file is part of phpDocumentor.
|
||||||
|
*
|
||||||
|
* For the full copyright and license information, please view the LICENSE
|
||||||
|
* file that was distributed with this source code.
|
||||||
|
*
|
||||||
|
* @copyright 2010-2015 Mike van Riel<[email protected]>
|
||||||
|
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
||||||
|
* @link http://phpdoc.org
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace phpDocumentor\Reflection\DocBlock;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Convenience class to create a Context for DocBlocks when not using the Reflection Component of phpDocumentor.
|
||||||
|
*
|
||||||
|
* For a DocBlock to be able to resolve types that use partial namespace names or rely on namespace imports we need to
|
||||||
|
* provide a bit of context so that the DocBlock can read that and based on it decide how to resolve the types to
|
||||||
|
* Fully Qualified names.
|
||||||
|
*
|
||||||
|
* @see Context for more information.
|
||||||
|
*/
|
||||||
|
final class ContextFactory
|
||||||
|
{
|
||||||
|
/** The literal used at the end of a use statement. */
|
||||||
|
const T_LITERAL_END_OF_USE = ';';
|
||||||
|
|
||||||
|
/** The literal used between sets of use statements */
|
||||||
|
const T_LITERAL_USE_SEPARATOR = ',';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Build a Context given a Class Reflection.
|
||||||
|
*
|
||||||
|
* @param \ReflectionClass $class
|
||||||
|
*
|
||||||
|
* @see Context for more information on Contexts.
|
||||||
|
*
|
||||||
|
* @return Context
|
||||||
|
*/
|
||||||
|
public function createFromClassReflector(\ReflectionClass $class)
|
||||||
|
{
|
||||||
|
return $this->createForNamespace(
|
||||||
|
$class->getNamespaceName(),
|
||||||
|
file_get_contents($class->getFileName())
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Build a Context for a namespace in the provided file contents.
|
||||||
|
*
|
||||||
|
* @param string $namespace It does not matter if a `\` precedes the namespace name, this method first normalizes.
|
||||||
|
* @param string $fileContents the file's contents to retrieve the aliases from with the given namespace.
|
||||||
|
*
|
||||||
|
* @see Context for more information on Contexts.
|
||||||
|
*
|
||||||
|
* @return Context
|
||||||
|
*/
|
||||||
|
public function createForNamespace($namespace, $fileContents)
|
||||||
|
{
|
||||||
|
$namespace = trim($namespace, '\\');
|
||||||
|
$useStatements = [];
|
||||||
|
$currentNamespace = '';
|
||||||
|
$tokens = new \ArrayIterator(token_get_all($fileContents));
|
||||||
|
|
||||||
|
while ($tokens->valid()) {
|
||||||
|
switch ($tokens->current()[0]) {
|
||||||
|
case T_NAMESPACE:
|
||||||
|
$currentNamespace = $this->parseNamespace($tokens);
|
||||||
|
break;
|
||||||
|
case T_USE:
|
||||||
|
if ($currentNamespace === $namespace) {
|
||||||
|
$useStatements = array_merge($useStatements, $this->parseUseStatement($tokens));
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
$tokens->next();
|
||||||
|
}
|
||||||
|
|
||||||
|
return new Context($namespace, $useStatements);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Deduce the name from tokens when we are at the T_NAMESPACE token.
|
||||||
|
*
|
||||||
|
* @param \ArrayIterator $tokens
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
private function parseNamespace(\ArrayIterator $tokens)
|
||||||
|
{
|
||||||
|
// skip to the first string or namespace separator
|
||||||
|
$this->skipToNextStringOrNamespaceSeparator($tokens);
|
||||||
|
|
||||||
|
$name = '';
|
||||||
|
while ($tokens->valid() && ($tokens->current()[0] === T_STRING || $tokens->current()[0] === T_NS_SEPARATOR)
|
||||||
|
) {
|
||||||
|
$name .= $tokens->current()[1];
|
||||||
|
$tokens->next();
|
||||||
|
}
|
||||||
|
|
||||||
|
return $name;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Deduce the names of all imports when we are at the T_USE token.
|
||||||
|
*
|
||||||
|
* @param \ArrayIterator $tokens
|
||||||
|
*
|
||||||
|
* @return string[]
|
||||||
|
*/
|
||||||
|
private function parseUseStatement(\ArrayIterator $tokens)
|
||||||
|
{
|
||||||
|
$uses = [];
|
||||||
|
$continue = true;
|
||||||
|
|
||||||
|
while ($continue) {
|
||||||
|
$this->skipToNextStringOrNamespaceSeparator($tokens);
|
||||||
|
|
||||||
|
list($alias, $fqnn) = $this->extractUseStatement($tokens);
|
||||||
|
$uses[$alias] = $fqnn;
|
||||||
|
if ($tokens->current()[0] === self::T_LITERAL_END_OF_USE) {
|
||||||
|
$continue = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return $uses;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fast-forwards the iterator as longs as we don't encounter a T_STRING or T_NS_SEPARATOR token.
|
||||||
|
*
|
||||||
|
* @param \ArrayIterator $tokens
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
private function skipToNextStringOrNamespaceSeparator(\ArrayIterator $tokens)
|
||||||
|
{
|
||||||
|
while ($tokens->valid() && ($tokens->current()[0] !== T_STRING) && ($tokens->current()[0] !== T_NS_SEPARATOR)) {
|
||||||
|
$tokens->next();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Deduce the namespace name and alias of an import when we are at the T_USE token or have not reached the end of
|
||||||
|
* a USE statement yet.
|
||||||
|
*
|
||||||
|
* @param \ArrayIterator $tokens
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
private function extractUseStatement(\ArrayIterator $tokens)
|
||||||
|
{
|
||||||
|
$result = [''];
|
||||||
|
while ($tokens->valid()
|
||||||
|
&& ($tokens->current()[0] !== self::T_LITERAL_USE_SEPARATOR)
|
||||||
|
&& ($tokens->current()[0] !== self::T_LITERAL_END_OF_USE)
|
||||||
|
) {
|
||||||
|
if ($tokens->current()[0] === T_AS) {
|
||||||
|
$result[] = '';
|
||||||
|
}
|
||||||
|
if ($tokens->current()[0] === T_STRING || $tokens->current()[0] === T_NS_SEPARATOR) {
|
||||||
|
$result[count($result) - 1] .= $tokens->current()[1];
|
||||||
|
}
|
||||||
|
$tokens->next();
|
||||||
|
}
|
||||||
|
|
||||||
|
if (count($result) == 1) {
|
||||||
|
$result[] = substr($result[0], strrpos($result[0], '\\') + 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
return array_reverse($result);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,226 @@
|
|||||||
|
<?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;
|
||||||
|
|
||||||
|
use phpDocumentor\Reflection\DocBlock;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Parses a Description of a DocBlock or tag.
|
||||||
|
*
|
||||||
|
* @author Mike van Riel <[email protected]>
|
||||||
|
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
||||||
|
* @link http://phpdoc.org
|
||||||
|
*/
|
||||||
|
class Description implements \Reflector
|
||||||
|
{
|
||||||
|
/** @var string */
|
||||||
|
protected $contents = '';
|
||||||
|
|
||||||
|
/** @var array|null The contents, as an array of strings and Tag objects or null if it is not parsed yet. */
|
||||||
|
protected $parsedContents = null;
|
||||||
|
|
||||||
|
/** @var DocBlock The DocBlock which this description belongs to. */
|
||||||
|
protected $docblock = null;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Populates the fields of a description.
|
||||||
|
*
|
||||||
|
* @param string $content The description's content.
|
||||||
|
* @param DocBlock $docblock The DocBlock which this description belongs to.
|
||||||
|
*/
|
||||||
|
public function __construct($content, DocBlock $docblock = null)
|
||||||
|
{
|
||||||
|
$this->setContent($content)->setDocBlock($docblock);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the text of this description.
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getContents()
|
||||||
|
{
|
||||||
|
return $this->contents;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the text of this description.
|
||||||
|
*
|
||||||
|
* @param string $content The new text of this description.
|
||||||
|
*
|
||||||
|
* @return $this
|
||||||
|
*/
|
||||||
|
public function setContent($content)
|
||||||
|
{
|
||||||
|
$this->contents = trim($content);
|
||||||
|
|
||||||
|
$this->parsedContents = null;
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the parsed text of this description.
|
||||||
|
*
|
||||||
|
* @return array An array of strings and tag objects, in the order they
|
||||||
|
* occur within the description.
|
||||||
|
*/
|
||||||
|
public function getParsedContents()
|
||||||
|
{
|
||||||
|
if (null === $this->parsedContents) {
|
||||||
|
$this->parsedContents = preg_split(
|
||||||
|
'/\{
|
||||||
|
# "{@}" is not a valid inline tag. This ensures that
|
||||||
|
# we do not treat it as one, but treat it literally.
|
||||||
|
(?!@\})
|
||||||
|
# We want to capture the whole tag line, but without the
|
||||||
|
# inline tag delimiters.
|
||||||
|
(\@
|
||||||
|
# Match everything up to the next delimiter.
|
||||||
|
[^{}]*
|
||||||
|
# Nested inline tag content should not be captured, or
|
||||||
|
# it will appear in the result separately.
|
||||||
|
(?:
|
||||||
|
# Match nested inline tags.
|
||||||
|
(?:
|
||||||
|
# Because we did not catch the tag delimiters
|
||||||
|
# earlier, we must be explicit with them here.
|
||||||
|
# Notice that this also matches "{}", as a way
|
||||||
|
# to later introduce it as an escape sequence.
|
||||||
|
\{(?1)?\}
|
||||||
|
|
|
||||||
|
# Make sure we match hanging "{".
|
||||||
|
\{
|
||||||
|
)
|
||||||
|
# Match content after the nested inline tag.
|
||||||
|
[^{}]*
|
||||||
|
)* # If there are more inline tags, match them as well.
|
||||||
|
# We use "*" since there may not be any nested inline
|
||||||
|
# tags.
|
||||||
|
)
|
||||||
|
\}/Sux',
|
||||||
|
$this->contents,
|
||||||
|
null,
|
||||||
|
PREG_SPLIT_DELIM_CAPTURE
|
||||||
|
);
|
||||||
|
|
||||||
|
$count = count($this->parsedContents);
|
||||||
|
for ($i=1; $i<$count; $i += 2) {
|
||||||
|
$this->parsedContents[$i] = Tag::createInstance(
|
||||||
|
$this->parsedContents[$i],
|
||||||
|
$this->docblock
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
//In order to allow "literal" inline tags, the otherwise invalid
|
||||||
|
//sequence "{@}" is changed to "@", and "{}" is changed to "}".
|
||||||
|
//See unit tests for examples.
|
||||||
|
for ($i=0; $i<$count; $i += 2) {
|
||||||
|
$this->parsedContents[$i] = str_replace(
|
||||||
|
array('{@}', '{}'),
|
||||||
|
array('@', '}'),
|
||||||
|
$this->parsedContents[$i]
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return $this->parsedContents;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return a formatted variant of the Long Description using MarkDown.
|
||||||
|
*
|
||||||
|
* @todo this should become a more intelligent piece of code where the
|
||||||
|
* configuration contains a setting what format long descriptions are.
|
||||||
|
*
|
||||||
|
* @codeCoverageIgnore Will be removed soon, in favor of adapters at
|
||||||
|
* PhpDocumentor itself that will process text in various formats.
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getFormattedContents()
|
||||||
|
{
|
||||||
|
$result = $this->contents;
|
||||||
|
|
||||||
|
// if the long description contains a plain HTML <code> element, surround
|
||||||
|
// it with a pre element. Please note that we explicitly used str_replace
|
||||||
|
// and not preg_replace to gain performance
|
||||||
|
if (strpos($result, '<code>') !== false) {
|
||||||
|
$result = str_replace(
|
||||||
|
array('<code>', "<code>\r\n", "<code>\n", "<code>\r", '</code>'),
|
||||||
|
array('<pre><code>', '<code>', '<code>', '<code>', '</code></pre>'),
|
||||||
|
$result
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (class_exists('Parsedown')) {
|
||||||
|
$markdown = \Parsedown::instance();
|
||||||
|
$result = $markdown->parse($result);
|
||||||
|
} elseif (class_exists('dflydev\markdown\MarkdownExtraParser')) {
|
||||||
|
$markdown = new \dflydev\markdown\MarkdownExtraParser();
|
||||||
|
$result = $markdown->transformMarkdown($result);
|
||||||
|
} elseif (class_exists('League\CommonMark\CommonMarkConverter')) {
|
||||||
|
$markdown = new \League\CommonMark\CommonMarkConverter();
|
||||||
|
$result = $markdown->convertToHtml($result);
|
||||||
|
}
|
||||||
|
|
||||||
|
return trim($result);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the docblock this tag belongs to.
|
||||||
|
*
|
||||||
|
* @return DocBlock The docblock this description belongs to.
|
||||||
|
*/
|
||||||
|
public function getDocBlock()
|
||||||
|
{
|
||||||
|
return $this->docblock;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the docblock this tag belongs to.
|
||||||
|
*
|
||||||
|
* @param DocBlock $docblock The new docblock this description belongs to.
|
||||||
|
* Setting NULL removes any association.
|
||||||
|
*
|
||||||
|
* @return $this
|
||||||
|
*/
|
||||||
|
public function setDocBlock(DocBlock $docblock = null)
|
||||||
|
{
|
||||||
|
$this->docblock = $docblock;
|
||||||
|
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Builds a string representation of this object.
|
||||||
|
*
|
||||||
|
* @todo determine the exact format as used by PHP Reflection
|
||||||
|
* and implement it.
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
* @codeCoverageIgnore Not yet implemented
|
||||||
|
*/
|
||||||
|
public static function export()
|
||||||
|
{
|
||||||
|
throw new \Exception('Not yet implemented');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the long description as a string.
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function __toString()
|
||||||
|
{
|
||||||
|
return $this->getContents();
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,82 @@
|
|||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* phpDocumentor
|
||||||
|
*
|
||||||
|
* PHP Version 5.3
|
||||||
|
*
|
||||||
|
* @author Vasil Rangelov <[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;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The location a DocBlock occurs within a file.
|
||||||
|
*
|
||||||
|
* @author Vasil Rangelov <[email protected]>
|
||||||
|
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
||||||
|
* @link http://phpdoc.org
|
||||||
|
*/
|
||||||
|
class Location
|
||||||
|
{
|
||||||
|
/** @var int Line where the DocBlock text starts. */
|
||||||
|
protected $lineNumber = 0;
|
||||||
|
|
||||||
|
/** @var int Column where the DocBlock text starts. */
|
||||||
|
protected $columnNumber = 0;
|
||||||
|
|
||||||
|
public function __construct($lineNumber = 0, $columnNumber = 0)
|
||||||
|
{
|
||||||
|
$this->setLineNumber($lineNumber)->setColumnNumber($columnNumber);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the line number that is covered by this location.
|
||||||
|
*
|
||||||
|
* @return integer
|
||||||
|
*/
|
||||||
|
public function getLineNumber()
|
||||||
|
{
|
||||||
|
return $this->lineNumber;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers which line number is covered by this location object.
|
||||||
|
*
|
||||||
|
* @param integer $lineNumber
|
||||||
|
*
|
||||||
|
* @return $this
|
||||||
|
*/
|
||||||
|
public function setLineNumber($lineNumber)
|
||||||
|
{
|
||||||
|
$this->lineNumber = (int)$lineNumber;
|
||||||
|
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the column number (character position on a line) for this location object.
|
||||||
|
*
|
||||||
|
* @return integer
|
||||||
|
*/
|
||||||
|
public function getColumnNumber()
|
||||||
|
{
|
||||||
|
return $this->columnNumber;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers the column number (character position on a line) for this location object.
|
||||||
|
*
|
||||||
|
* @param integer $columnNumber
|
||||||
|
*
|
||||||
|
* @return $this
|
||||||
|
*/
|
||||||
|
public function setColumnNumber($columnNumber)
|
||||||
|
{
|
||||||
|
$this->columnNumber = (int)$columnNumber;
|
||||||
|
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,121 +0,0 @@
|
|||||||
<?php
|
|
||||||
/**
|
|
||||||
* phpDocumentor
|
|
||||||
*
|
|
||||||
* PHP Version 5
|
|
||||||
*
|
|
||||||
* @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;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Parses a Long Description of a DocBlock.
|
|
||||||
*
|
|
||||||
* @author Mike van Riel <[email protected]>
|
|
||||||
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
|
||||||
* @link http://phpdoc.org
|
|
||||||
*/
|
|
||||||
class LongDescription implements \Reflector
|
|
||||||
{
|
|
||||||
/** @var string */
|
|
||||||
protected $contents = '';
|
|
||||||
|
|
||||||
/** @var \phpDocumentor\Reflection\DocBlock\Tags[] */
|
|
||||||
protected $tags = array();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Parses the string for inline tags and if the Markdown class is included;
|
|
||||||
* format the found text.
|
|
||||||
*
|
|
||||||
* @param string $content the DocBlock contents without asterisks.
|
|
||||||
*/
|
|
||||||
public function __construct($content)
|
|
||||||
{
|
|
||||||
if (preg_match('/\{\@(.+?)\}/', $content, $matches)) {
|
|
||||||
array_shift($matches);
|
|
||||||
foreach ($matches as $tag) {
|
|
||||||
$this->tags[] = Tag::createInstance('@' . $tag);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
$this->contents = trim($content);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the text of this description.
|
|
||||||
*
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
public function getContents()
|
|
||||||
{
|
|
||||||
return $this->contents;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Return a formatted variant of the Long Description using MarkDown.
|
|
||||||
*
|
|
||||||
* @todo this should become a more intelligent piece of code where the
|
|
||||||
* configuration contains a setting what format long descriptions are.
|
|
||||||
*
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
public function getFormattedContents()
|
|
||||||
{
|
|
||||||
$result = $this->contents;
|
|
||||||
|
|
||||||
// if the long description contains a plain HTML <code> element, surround
|
|
||||||
// it with a pre element. Please note that we explicitly used str_replace
|
|
||||||
// and not preg_replace to gain performance
|
|
||||||
if (strpos($result, '<code>') !== false) {
|
|
||||||
$result = str_replace(
|
|
||||||
array('<code>', "<code>\r\n", "<code>\n", "<code>\r", '</code>'),
|
|
||||||
array('<pre><code>', '<code>', '<code>', '<code>', '</code></pre>'),
|
|
||||||
$result
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (class_exists('\dflydev\markdown\MarkdownExtraParser')) {
|
|
||||||
$md = new \dflydev\markdown\MarkdownExtraParser();
|
|
||||||
$result = $md->transformMarkdown($result);
|
|
||||||
}
|
|
||||||
|
|
||||||
return trim($result);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns a list of tags mentioned in the text.
|
|
||||||
*
|
|
||||||
* @return \phpDocumentor\Reflection\DocBlock\Tags[]
|
|
||||||
*/
|
|
||||||
public function getTags()
|
|
||||||
{
|
|
||||||
return $this->tags;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Builds a string representation of this object.
|
|
||||||
*
|
|
||||||
* @todo determine the exact format as used by PHP Reflection and implement it.
|
|
||||||
*
|
|
||||||
* @return void
|
|
||||||
*/
|
|
||||||
static public function export()
|
|
||||||
{
|
|
||||||
throw new \Exception('Not yet implemented');
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the exported information (we should use the export static method
|
|
||||||
* BUT this throws an exception at this point).
|
|
||||||
*
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
public function __toString()
|
|
||||||
{
|
|
||||||
return 'Not yet implemented';
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,199 @@
|
|||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* phpDocumentor
|
||||||
|
*
|
||||||
|
* PHP Version 5.3
|
||||||
|
*
|
||||||
|
* @author Barry vd. Heuvel <[email protected]>
|
||||||
|
* @copyright 2013 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;
|
||||||
|
|
||||||
|
use phpDocumentor\Reflection\DocBlock;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Serializes a DocBlock instance.
|
||||||
|
*
|
||||||
|
* @author Barry vd. Heuvel <[email protected]>
|
||||||
|
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
||||||
|
* @link http://phpdoc.org
|
||||||
|
*/
|
||||||
|
class Serializer
|
||||||
|
{
|
||||||
|
/** @var string The string to indent the comment with. */
|
||||||
|
protected $indentString = ' ';
|
||||||
|
|
||||||
|
/** @var int The number of times the indent string is repeated. */
|
||||||
|
protected $indent = 0;
|
||||||
|
|
||||||
|
/** @var bool Whether to indent the first line. */
|
||||||
|
protected $isFirstLineIndented = true;
|
||||||
|
|
||||||
|
/** @var int|null The max length of a line. */
|
||||||
|
protected $lineLength = null;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a Serializer instance.
|
||||||
|
*
|
||||||
|
* @param int $indent The number of times the indent string is
|
||||||
|
* repeated.
|
||||||
|
* @param string $indentString The string to indent the comment with.
|
||||||
|
* @param bool $indentFirstLine Whether to indent the first line.
|
||||||
|
* @param int|null $lineLength The max length of a line or NULL to
|
||||||
|
* disable line wrapping.
|
||||||
|
*/
|
||||||
|
public function __construct(
|
||||||
|
$indent = 0,
|
||||||
|
$indentString = ' ',
|
||||||
|
$indentFirstLine = true,
|
||||||
|
$lineLength = null
|
||||||
|
) {
|
||||||
|
$this->setIndentationString($indentString);
|
||||||
|
$this->setIndent($indent);
|
||||||
|
$this->setIsFirstLineIndented($indentFirstLine);
|
||||||
|
$this->setLineLength($lineLength);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the string to indent comments with.
|
||||||
|
*
|
||||||
|
* @param string $indentString The string to indent comments with.
|
||||||
|
*
|
||||||
|
* @return $this This serializer object.
|
||||||
|
*/
|
||||||
|
public function setIndentationString($indentString)
|
||||||
|
{
|
||||||
|
$this->indentString = (string)$indentString;
|
||||||
|
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the string to indent comments with.
|
||||||
|
*
|
||||||
|
* @return string The indent string.
|
||||||
|
*/
|
||||||
|
public function getIndentationString()
|
||||||
|
{
|
||||||
|
return $this->indentString;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the number of indents.
|
||||||
|
*
|
||||||
|
* @param int $indent The number of times the indent string is repeated.
|
||||||
|
*
|
||||||
|
* @return $this This serializer object.
|
||||||
|
*/
|
||||||
|
public function setIndent($indent)
|
||||||
|
{
|
||||||
|
$this->indent = (int)$indent;
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the number of indents.
|
||||||
|
*
|
||||||
|
* @return int The number of times the indent string is repeated.
|
||||||
|
*/
|
||||||
|
public function getIndent()
|
||||||
|
{
|
||||||
|
return $this->indent;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets whether or not the first line should be indented.
|
||||||
|
*
|
||||||
|
* Sets whether or not the first line (the one with the "/**") should be
|
||||||
|
* indented.
|
||||||
|
*
|
||||||
|
* @param bool $indentFirstLine The new value for this setting.
|
||||||
|
*
|
||||||
|
* @return $this This serializer object.
|
||||||
|
*/
|
||||||
|
public function setIsFirstLineIndented($indentFirstLine)
|
||||||
|
{
|
||||||
|
$this->isFirstLineIndented = (bool)$indentFirstLine;
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets whether or not the first line should be indented.
|
||||||
|
*
|
||||||
|
* @return bool Whether or not the first line should be indented.
|
||||||
|
*/
|
||||||
|
public function isFirstLineIndented()
|
||||||
|
{
|
||||||
|
return $this->isFirstLineIndented;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the line length.
|
||||||
|
*
|
||||||
|
* Sets the length of each line in the serialization. Content will be
|
||||||
|
* wrapped within this limit.
|
||||||
|
*
|
||||||
|
* @param int|null $lineLength The length of each line. NULL to disable line
|
||||||
|
* wrapping altogether.
|
||||||
|
*
|
||||||
|
* @return $this This serializer object.
|
||||||
|
*/
|
||||||
|
public function setLineLength($lineLength)
|
||||||
|
{
|
||||||
|
$this->lineLength = null === $lineLength ? null : (int)$lineLength;
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the line length.
|
||||||
|
*
|
||||||
|
* @return int|null The length of each line or NULL if line wrapping is
|
||||||
|
* disabled.
|
||||||
|
*/
|
||||||
|
public function getLineLength()
|
||||||
|
{
|
||||||
|
return $this->lineLength;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Generate a DocBlock comment.
|
||||||
|
*
|
||||||
|
* @param DocBlock The DocBlock to serialize.
|
||||||
|
*
|
||||||
|
* @return string The serialized doc block.
|
||||||
|
*/
|
||||||
|
public function getDocComment(DocBlock $docblock)
|
||||||
|
{
|
||||||
|
$indent = str_repeat($this->indentString, $this->indent);
|
||||||
|
$firstIndent = $this->isFirstLineIndented ? $indent : '';
|
||||||
|
|
||||||
|
$wrapLength = 80;
|
||||||
|
$text = $docblock->getText();
|
||||||
|
if ($this->lineLength) {
|
||||||
|
//3 === strlen(' * ')
|
||||||
|
$wrapLength = $this->lineLength - strlen($indent) - 3;
|
||||||
|
$text = wordwrap($text, $wrapLength);
|
||||||
|
}
|
||||||
|
$text = str_replace("\n", "\n{$indent} * ", $text);
|
||||||
|
|
||||||
|
$comment = "{$firstIndent}/**\n{$indent} * {$text}\n{$indent} *\n";
|
||||||
|
|
||||||
|
/** @var Tag $tag */
|
||||||
|
foreach ($docblock->getTags() as $tag) {
|
||||||
|
$tagText = (string) $tag;
|
||||||
|
if ($this->lineLength) {
|
||||||
|
$tagText = wordwrap($tagText, $wrapLength);
|
||||||
|
}
|
||||||
|
$tagText = str_replace("\n", "\n{$indent} * ", $tagText);
|
||||||
|
|
||||||
|
$comment .= "{$indent} * {$tagText}\n";
|
||||||
|
}
|
||||||
|
|
||||||
|
$comment .= $indent . ' */';
|
||||||
|
|
||||||
|
return $comment;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -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)
|
||||||
@@ -12,77 +12,192 @@
|
|||||||
|
|
||||||
namespace phpDocumentor\Reflection\DocBlock;
|
namespace phpDocumentor\Reflection\DocBlock;
|
||||||
|
|
||||||
|
use 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
|
||||||
{
|
{
|
||||||
|
/**
|
||||||
|
* PCRE regular expression matching a tag name.
|
||||||
|
*/
|
||||||
|
const REGEX_TAGNAME = '[\w\-\_\\\\]+';
|
||||||
|
|
||||||
/** @var string Name of the tag */
|
/** @var string Name of the tag */
|
||||||
protected $tag = '';
|
protected $tag = '';
|
||||||
|
|
||||||
/** @var string content of the tag */
|
/**
|
||||||
|
* @var string|null Content of the tag.
|
||||||
|
* When set to NULL, it means it needs to be regenerated.
|
||||||
|
*/
|
||||||
protected $content = '';
|
protected $content = '';
|
||||||
|
|
||||||
/** @var string description of the content of this tag */
|
/** @var string Description of the content of this tag */
|
||||||
protected $description = '';
|
protected $description = '';
|
||||||
|
|
||||||
/** @var int line number of the tag */
|
/**
|
||||||
protected $line_number = 0;
|
* @var array|null The description, as an array of strings and Tag objects.
|
||||||
|
* When set to NULL, it means it needs to be regenerated.
|
||||||
|
*/
|
||||||
|
protected $parsedDescription = null;
|
||||||
|
|
||||||
/** @var \phpDocumentor\Reflection\DocBlock docblock class */
|
/** @var Location Location of the tag. */
|
||||||
protected $docblock;
|
protected $location = null;
|
||||||
|
|
||||||
|
/** @var DocBlock The DocBlock which this tag belongs to. */
|
||||||
|
protected $docblock = null;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @var array An array with a tag as a key, and an FQCN to a class that
|
||||||
|
* handles it as an array value. The class is expected to inherit this
|
||||||
|
* class.
|
||||||
|
*/
|
||||||
|
private static $tagHandlerMappings = array(
|
||||||
|
'author'
|
||||||
|
=> '\phpDocumentor\Reflection\DocBlock\Tag\AuthorTag',
|
||||||
|
'covers'
|
||||||
|
=> '\phpDocumentor\Reflection\DocBlock\Tag\CoversTag',
|
||||||
|
'deprecated'
|
||||||
|
=> '\phpDocumentor\Reflection\DocBlock\Tag\DeprecatedTag',
|
||||||
|
'example'
|
||||||
|
=> '\phpDocumentor\Reflection\DocBlock\Tag\ExampleTag',
|
||||||
|
'link'
|
||||||
|
=> '\phpDocumentor\Reflection\DocBlock\Tag\LinkTag',
|
||||||
|
'method'
|
||||||
|
=> '\phpDocumentor\Reflection\DocBlock\Tag\MethodTag',
|
||||||
|
'param'
|
||||||
|
=> '\phpDocumentor\Reflection\DocBlock\Tag\ParamTag',
|
||||||
|
'property-read'
|
||||||
|
=> '\phpDocumentor\Reflection\DocBlock\Tag\PropertyReadTag',
|
||||||
|
'property'
|
||||||
|
=> '\phpDocumentor\Reflection\DocBlock\Tag\PropertyTag',
|
||||||
|
'property-write'
|
||||||
|
=> '\phpDocumentor\Reflection\DocBlock\Tag\PropertyWriteTag',
|
||||||
|
'return'
|
||||||
|
=> '\phpDocumentor\Reflection\DocBlock\Tag\ReturnTag',
|
||||||
|
'see'
|
||||||
|
=> '\phpDocumentor\Reflection\DocBlock\Tag\SeeTag',
|
||||||
|
'since'
|
||||||
|
=> '\phpDocumentor\Reflection\DocBlock\Tag\SinceTag',
|
||||||
|
'source'
|
||||||
|
=> '\phpDocumentor\Reflection\DocBlock\Tag\SourceTag',
|
||||||
|
'throw'
|
||||||
|
=> '\phpDocumentor\Reflection\DocBlock\Tag\ThrowsTag',
|
||||||
|
'throws'
|
||||||
|
=> '\phpDocumentor\Reflection\DocBlock\Tag\ThrowsTag',
|
||||||
|
'uses'
|
||||||
|
=> '\phpDocumentor\Reflection\DocBlock\Tag\UsesTag',
|
||||||
|
'var'
|
||||||
|
=> '\phpDocumentor\Reflection\DocBlock\Tag\VarTag',
|
||||||
|
'version'
|
||||||
|
=> '\phpDocumentor\Reflection\DocBlock\Tag\VersionTag'
|
||||||
|
);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Factory method responsible for instantiating the correct sub type.
|
* Factory method responsible for instantiating the correct sub type.
|
||||||
*
|
*
|
||||||
* @param string $tag_line The text for this tag, including description.
|
* @param string $tag_line The text for this tag, including description.
|
||||||
|
* @param DocBlock $docblock The DocBlock which this tag belongs to.
|
||||||
|
* @param Location $location Location of the tag.
|
||||||
*
|
*
|
||||||
* @throws \InvalidArgumentException if an invalid tag line was presented.
|
* @throws \InvalidArgumentException if an invalid tag line was presented.
|
||||||
*
|
*
|
||||||
* @return \phpDocumentor\Reflection\DocBlock\Tag
|
* @return static A new tag object.
|
||||||
*/
|
*/
|
||||||
public static function createInstance($tag_line)
|
final public static function createInstance(
|
||||||
{
|
$tag_line,
|
||||||
if (!preg_match(
|
DocBlock $docblock = null,
|
||||||
'/^@([\w\-\_\\\\]+)(?:\s*([^\s].*)|$)?/us', $tag_line, $matches
|
Location $location = null
|
||||||
)) {
|
) {
|
||||||
throw new \InvalidArgumentException(
|
$matches = self::extractTagParts($tag_line);
|
||||||
'Invalid tag_line detected: ' . $tag_line
|
|
||||||
|
$handler = __CLASS__;
|
||||||
|
if (isset(self::$tagHandlerMappings[$matches[1]])) {
|
||||||
|
$handler = self::$tagHandlerMappings[$matches[1]];
|
||||||
|
} elseif (isset($docblock)) {
|
||||||
|
$tagName = (string)new Type\Collection(
|
||||||
|
array($matches[1]),
|
||||||
|
$docblock->getContext()
|
||||||
);
|
);
|
||||||
|
|
||||||
|
if (isset(self::$tagHandlerMappings[$tagName])) {
|
||||||
|
$handler = self::$tagHandlerMappings[$tagName];
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// support hypphen separated tag names
|
return new $handler(
|
||||||
$tag_name = str_replace(
|
$matches[1],
|
||||||
' ', '', ucwords(str_replace('-', ' ', $matches[1]))
|
isset($matches[2]) ? $matches[2] : '',
|
||||||
).'Tag';
|
$docblock,
|
||||||
$class_name = 'phpDocumentor\\Reflection\\DocBlock\\Tag\\' . $tag_name;
|
$location
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
return (@class_exists($class_name))
|
/**
|
||||||
? new $class_name($matches[1], isset($matches[2]) ? $matches[2] : '')
|
* Registers a handler for tags.
|
||||||
: new self($matches[1], isset($matches[2]) ? $matches[2] : '');
|
*
|
||||||
|
* Registers a handler for tags. The class specified is autoloaded if it's
|
||||||
|
* not available. It must inherit from this class.
|
||||||
|
*
|
||||||
|
* @param string $tag Name of tag to regiser a handler for. When
|
||||||
|
* registering a namespaced tag, the full name, along with a prefixing
|
||||||
|
* slash MUST be provided.
|
||||||
|
* @param string|null $handler FQCN of handler. Specifing NULL removes the
|
||||||
|
* handler for the specified tag, if any.
|
||||||
|
*
|
||||||
|
* @return bool TRUE on success, FALSE on failure.
|
||||||
|
*/
|
||||||
|
final public static function registerTagHandler($tag, $handler)
|
||||||
|
{
|
||||||
|
$tag = trim((string)$tag);
|
||||||
|
|
||||||
|
if (null === $handler) {
|
||||||
|
unset(self::$tagHandlerMappings[$tag]);
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
if ('' !== $tag
|
||||||
|
&& class_exists($handler, true)
|
||||||
|
&& is_subclass_of($handler, __CLASS__)
|
||||||
|
&& !strpos($tag, '\\') //Accept no slash, and 1st slash at offset 0.
|
||||||
|
) {
|
||||||
|
self::$tagHandlerMappings[$tag] = $handler;
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Parses a tag and populates the member variables.
|
* Parses a tag and populates the member variables.
|
||||||
*
|
*
|
||||||
* @param string $type Name of the tag.
|
* @param string $name Name of the tag.
|
||||||
* @param string $content The contents of the given tag.
|
* @param string $content The contents of the given tag.
|
||||||
|
* @param DocBlock $docblock The DocBlock which this tag belongs to.
|
||||||
|
* @param Location $location Location of the tag.
|
||||||
*/
|
*/
|
||||||
public function __construct($type, $content)
|
public function __construct(
|
||||||
{
|
$name,
|
||||||
$this->tag = $type;
|
$content,
|
||||||
$this->content = $content;
|
DocBlock $docblock = null,
|
||||||
$this->description = $content;
|
Location $location = null
|
||||||
|
) {
|
||||||
|
$this
|
||||||
|
->setName($name)
|
||||||
|
->setContent($content)
|
||||||
|
->setDocBlock($docblock)
|
||||||
|
->setLocation($location);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the name of this tag.
|
* Gets the name of this tag.
|
||||||
*
|
*
|
||||||
* @return string
|
* @return string The name of this tag.
|
||||||
*/
|
*/
|
||||||
public function getName()
|
public function getName()
|
||||||
{
|
{
|
||||||
@@ -90,17 +205,54 @@ class Tag implements \Reflector
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the content of this tag.
|
* Sets the name of this tag.
|
||||||
|
*
|
||||||
|
* @param string $name The new name of this tag.
|
||||||
|
*
|
||||||
|
* @throws \InvalidArgumentException When an invalid tag name is provided.
|
||||||
|
*
|
||||||
|
* @return $this
|
||||||
|
*/
|
||||||
|
public function setName($name)
|
||||||
|
{
|
||||||
|
$this->validateTagName($name);
|
||||||
|
|
||||||
|
$this->tag = $name;
|
||||||
|
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the content of this tag.
|
||||||
*
|
*
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
public function getContent()
|
public function getContent()
|
||||||
{
|
{
|
||||||
|
if (null === $this->content) {
|
||||||
|
$this->content = $this->description;
|
||||||
|
}
|
||||||
|
|
||||||
return $this->content;
|
return $this->content;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the description component of this tag.
|
* Sets the content of this tag.
|
||||||
|
*
|
||||||
|
* @param string $content The new content of this tag.
|
||||||
|
*
|
||||||
|
* @return $this
|
||||||
|
*/
|
||||||
|
public function setContent($content)
|
||||||
|
{
|
||||||
|
$this->setDescription($content);
|
||||||
|
$this->content = $content;
|
||||||
|
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the description component of this tag.
|
||||||
*
|
*
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
@@ -110,39 +262,83 @@ class Tag implements \Reflector
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the tag line number
|
* Sets the description component of this tag.
|
||||||
*
|
*
|
||||||
* @param int $number the line number of the tag
|
* @param string $description The new description component of this tag.
|
||||||
*
|
*
|
||||||
* @return void
|
* @return $this
|
||||||
*/
|
*/
|
||||||
public function setLineNumber($number)
|
public function setDescription($description)
|
||||||
{
|
{
|
||||||
$this->line_number = (int)$number;
|
$this->content = null;
|
||||||
|
$this->parsedDescription = null;
|
||||||
|
$this->description = trim($description);
|
||||||
|
|
||||||
|
return $this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the line number of the tag
|
* Gets the parsed text of this description.
|
||||||
*
|
*
|
||||||
* @return int tag line number
|
* @return array An array of strings and tag objects, in the order they
|
||||||
|
* occur within the description.
|
||||||
*/
|
*/
|
||||||
public function getLineNumber()
|
public function getParsedDescription()
|
||||||
{
|
{
|
||||||
return $this->line_number;
|
if (null === $this->parsedDescription) {
|
||||||
|
$description = new Description($this->description, $this->docblock);
|
||||||
|
$this->parsedDescription = $description->getParsedContents();
|
||||||
|
}
|
||||||
|
return $this->parsedDescription;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Inject the docblock class
|
* Gets the docblock this tag belongs to.
|
||||||
*
|
*
|
||||||
* This exposes some common functionality contained in the docblock abstract.
|
* @return DocBlock The docblock this tag belongs to.
|
||||||
*
|
|
||||||
* @param object $docblock Object containing the DocBlock.
|
|
||||||
*
|
|
||||||
* @return void
|
|
||||||
*/
|
*/
|
||||||
public function setDocBlock($docblock)
|
public function getDocBlock()
|
||||||
|
{
|
||||||
|
return $this->docblock;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the docblock this tag belongs to.
|
||||||
|
*
|
||||||
|
* @param DocBlock $docblock The new docblock this tag belongs to. Setting
|
||||||
|
* NULL removes any association.
|
||||||
|
*
|
||||||
|
* @return $this
|
||||||
|
*/
|
||||||
|
public function setDocBlock(DocBlock $docblock = null)
|
||||||
{
|
{
|
||||||
$this->docblock = $docblock;
|
$this->docblock = $docblock;
|
||||||
|
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the location of the tag.
|
||||||
|
*
|
||||||
|
* @return Location The tag's location.
|
||||||
|
*/
|
||||||
|
public function getLocation()
|
||||||
|
{
|
||||||
|
return $this->location;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the location of the tag.
|
||||||
|
*
|
||||||
|
* @param Location $location The new location of the tag.
|
||||||
|
*
|
||||||
|
* @return $this
|
||||||
|
*/
|
||||||
|
public function setLocation(Location $location = null)
|
||||||
|
{
|
||||||
|
$this->location = $location;
|
||||||
|
|
||||||
|
return $this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -151,21 +347,56 @@ class Tag implements \Reflector
|
|||||||
* @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
|
||||||
|
* @codeCoverageIgnore Not yet implemented
|
||||||
*/
|
*/
|
||||||
static public function export()
|
public static function export()
|
||||||
{
|
{
|
||||||
throw new \Exception('Not yet implemented');
|
throw new \Exception('Not yet implemented');
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the exported information (we should use the export static method
|
* Returns the tag as a serialized string
|
||||||
* BUT this throws an exception at this point).
|
|
||||||
*
|
*
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
public function __toString()
|
public function __toString()
|
||||||
{
|
{
|
||||||
return 'Not yet implemented';
|
return "@{$this->getName()} {$this->getContent()}";
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Extracts all components for a tag.
|
||||||
|
*
|
||||||
|
* @param string $tagLine
|
||||||
|
*
|
||||||
|
* @return string[]
|
||||||
|
*/
|
||||||
|
private static function extractTagParts($tagLine)
|
||||||
|
{
|
||||||
|
$matches = array();
|
||||||
|
if (! preg_match('/^@(' . self::REGEX_TAGNAME . ')(?:\s*([^\s].*)|$)?/us', $tagLine, $matches)) {
|
||||||
|
throw new \InvalidArgumentException(
|
||||||
|
'The tag "' . $tagLine . '" does not seem to be wellformed, please check it for errors'
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
return $matches;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Validates if the tag name matches the expected format, otherwise throws an exception.
|
||||||
|
*
|
||||||
|
* @param string $name
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
private function validateTagName($name)
|
||||||
|
{
|
||||||
|
if (!preg_match('/^' . self::REGEX_TAGNAME . '$/u', $name)) {
|
||||||
|
throw new \InvalidArgumentException(
|
||||||
|
'The tag name "' . $name . '" is not wellformed. Tags may only consist of letters, underscores, '
|
||||||
|
. 'hyphens and backslashes.'
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,131 @@
|
|||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* phpDocumentor
|
||||||
|
*
|
||||||
|
* PHP Version 5.3
|
||||||
|
*
|
||||||
|
* @author Vasil Rangelov <[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\Tag;
|
||||||
|
|
||||||
|
use phpDocumentor\Reflection\DocBlock\Tag;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reflection class for an @author tag in a Docblock.
|
||||||
|
*
|
||||||
|
* @author Mike van Riel <[email protected]>
|
||||||
|
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
||||||
|
* @link http://phpdoc.org
|
||||||
|
*/
|
||||||
|
class AuthorTag extends Tag
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* PCRE regular expression matching any valid value for the name component.
|
||||||
|
*/
|
||||||
|
const REGEX_AUTHOR_NAME = '[^\<]*';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* PCRE regular expression matching any valid value for the email component.
|
||||||
|
*/
|
||||||
|
const REGEX_AUTHOR_EMAIL = '[^\>]*';
|
||||||
|
|
||||||
|
/** @var string The name of the author */
|
||||||
|
protected $authorName = '';
|
||||||
|
|
||||||
|
/** @var string The email of the author */
|
||||||
|
protected $authorEmail = '';
|
||||||
|
|
||||||
|
public function getContent()
|
||||||
|
{
|
||||||
|
if (null === $this->content) {
|
||||||
|
$this->content = $this->authorName;
|
||||||
|
if ('' != $this->authorEmail) {
|
||||||
|
$this->content .= "<{$this->authorEmail}>";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return $this->content;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* {@inheritdoc}
|
||||||
|
*/
|
||||||
|
public function setContent($content)
|
||||||
|
{
|
||||||
|
parent::setContent($content);
|
||||||
|
if (preg_match(
|
||||||
|
'/^(' . self::REGEX_AUTHOR_NAME .
|
||||||
|
')(\<(' . self::REGEX_AUTHOR_EMAIL .
|
||||||
|
')\>)?$/u',
|
||||||
|
$this->description,
|
||||||
|
$matches
|
||||||
|
)) {
|
||||||
|
$this->authorName = trim($matches[1]);
|
||||||
|
if (isset($matches[3])) {
|
||||||
|
$this->authorEmail = trim($matches[3]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the author's name.
|
||||||
|
*
|
||||||
|
* @return string The author's name.
|
||||||
|
*/
|
||||||
|
public function getAuthorName()
|
||||||
|
{
|
||||||
|
return $this->authorName;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the author's name.
|
||||||
|
*
|
||||||
|
* @param string $authorName The new author name.
|
||||||
|
* An invalid value will set an empty string.
|
||||||
|
*
|
||||||
|
* @return $this
|
||||||
|
*/
|
||||||
|
public function setAuthorName($authorName)
|
||||||
|
{
|
||||||
|
$this->content = null;
|
||||||
|
$this->authorName
|
||||||
|
= preg_match('/^' . self::REGEX_AUTHOR_NAME . '$/u', $authorName)
|
||||||
|
? $authorName : '';
|
||||||
|
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the author's email.
|
||||||
|
*
|
||||||
|
* @return string The author's email.
|
||||||
|
*/
|
||||||
|
public function getAuthorEmail()
|
||||||
|
{
|
||||||
|
return $this->authorEmail;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the author's email.
|
||||||
|
*
|
||||||
|
* @param string $authorEmail The new author email.
|
||||||
|
* An invalid value will set an empty string.
|
||||||
|
*
|
||||||
|
* @return $this
|
||||||
|
*/
|
||||||
|
public function setAuthorEmail($authorEmail)
|
||||||
|
{
|
||||||
|
$this->authorEmail
|
||||||
|
= preg_match('/^' . self::REGEX_AUTHOR_EMAIL . '$/u', $authorEmail)
|
||||||
|
? $authorEmail : '';
|
||||||
|
|
||||||
|
$this->content = null;
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -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
|
||||||
{
|
{
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,26 @@
|
|||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* phpDocumentor
|
||||||
|
*
|
||||||
|
* PHP Version 5.3
|
||||||
|
*
|
||||||
|
* @author Vasil Rangelov <[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\Tag;
|
||||||
|
|
||||||
|
use phpDocumentor\Reflection\DocBlock\Tag\VersionTag;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reflection class for a @deprecated tag in a Docblock.
|
||||||
|
*
|
||||||
|
* @author Vasil Rangelov <[email protected]>
|
||||||
|
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
||||||
|
* @link http://phpdoc.org
|
||||||
|
*/
|
||||||
|
class DeprecatedTag extends VersionTag
|
||||||
|
{
|
||||||
|
}
|
||||||
@@ -0,0 +1,158 @@
|
|||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* phpDocumentor
|
||||||
|
*
|
||||||
|
* PHP Version 5.3
|
||||||
|
*
|
||||||
|
* @author Vasil Rangelov <[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\Tag;
|
||||||
|
|
||||||
|
use phpDocumentor\Reflection\DocBlock\Tag;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reflection class for a @example tag in a Docblock.
|
||||||
|
*
|
||||||
|
* @author Vasil Rangelov <[email protected]>
|
||||||
|
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
||||||
|
* @link http://phpdoc.org
|
||||||
|
*/
|
||||||
|
class ExampleTag extends SourceTag
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @var string Path to a file to use as an example.
|
||||||
|
* May also be an absolute URI.
|
||||||
|
*/
|
||||||
|
protected $filePath = '';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @var bool Whether the file path component represents an URI.
|
||||||
|
* This determines how the file portion appears at {@link getContent()}.
|
||||||
|
*/
|
||||||
|
protected $isURI = false;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* {@inheritdoc}
|
||||||
|
*/
|
||||||
|
public function getContent()
|
||||||
|
{
|
||||||
|
if (null === $this->content) {
|
||||||
|
$filePath = '"' . $this->filePath . '"';
|
||||||
|
if ($this->isURI) {
|
||||||
|
$filePath = $this->isUriRelative($this->filePath)
|
||||||
|
? str_replace('%2F', '/', rawurlencode($this->filePath))
|
||||||
|
:$this->filePath;
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->content = $filePath . ' ' . parent::getContent();
|
||||||
|
}
|
||||||
|
|
||||||
|
return $this->content;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* {@inheritdoc}
|
||||||
|
*/
|
||||||
|
public function setContent($content)
|
||||||
|
{
|
||||||
|
Tag::setContent($content);
|
||||||
|
if (preg_match(
|
||||||
|
'/^
|
||||||
|
# File component
|
||||||
|
(?:
|
||||||
|
# File path in quotes
|
||||||
|
\"([^\"]+)\"
|
||||||
|
|
|
||||||
|
# File URI
|
||||||
|
(\S+)
|
||||||
|
)
|
||||||
|
# Remaining content (parsed by SourceTag)
|
||||||
|
(?:\s+(.*))?
|
||||||
|
$/sux',
|
||||||
|
$this->description,
|
||||||
|
$matches
|
||||||
|
)) {
|
||||||
|
if ('' !== $matches[1]) {
|
||||||
|
$this->setFilePath($matches[1]);
|
||||||
|
} else {
|
||||||
|
$this->setFileURI($matches[2]);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (isset($matches[3])) {
|
||||||
|
parent::setContent($matches[3]);
|
||||||
|
} else {
|
||||||
|
$this->setDescription('');
|
||||||
|
}
|
||||||
|
$this->content = $content;
|
||||||
|
}
|
||||||
|
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the file path.
|
||||||
|
*
|
||||||
|
* @return string Path to a file to use as an example.
|
||||||
|
* May also be an absolute URI.
|
||||||
|
*/
|
||||||
|
public function getFilePath()
|
||||||
|
{
|
||||||
|
return $this->filePath;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the file path.
|
||||||
|
*
|
||||||
|
* @param string $filePath The new file path to use for the example.
|
||||||
|
*
|
||||||
|
* @return $this
|
||||||
|
*/
|
||||||
|
public function setFilePath($filePath)
|
||||||
|
{
|
||||||
|
$this->isURI = false;
|
||||||
|
$this->filePath = trim($filePath);
|
||||||
|
|
||||||
|
$this->content = null;
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the file path as an URI.
|
||||||
|
*
|
||||||
|
* This function is equivalent to {@link setFilePath()}, except that it
|
||||||
|
* converts an URI to a file path before that.
|
||||||
|
*
|
||||||
|
* There is no getFileURI(), as {@link getFilePath()} is compatible.
|
||||||
|
*
|
||||||
|
* @param string $uri The new file URI to use as an example.
|
||||||
|
*
|
||||||
|
* @return $this
|
||||||
|
*/
|
||||||
|
public function setFileURI($uri)
|
||||||
|
{
|
||||||
|
$this->isURI = true;
|
||||||
|
$this->content = null;
|
||||||
|
|
||||||
|
$this->filePath = $this->isUriRelative($uri)
|
||||||
|
? rawurldecode(str_replace(array('/', '\\'), '%2F', $uri))
|
||||||
|
: $this->filePath = $uri;
|
||||||
|
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns true if the provided URI is relative or contains a complete scheme (and thus is absolute).
|
||||||
|
*
|
||||||
|
* @param string $uri
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
private function isUriRelative($uri)
|
||||||
|
{
|
||||||
|
return false === strpos($uri, ':');
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -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
|
||||||
{
|
{
|
||||||
@@ -26,29 +27,35 @@ class LinkTag extends Tag
|
|||||||
protected $link = '';
|
protected $link = '';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Parses a tag and populates the member variables.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @param string $type Tag type
|
|
||||||
* @param string $content Content of the tag
|
|
||||||
*/
|
*/
|
||||||
public function __construct($type, $content)
|
public function getContent()
|
||||||
{
|
{
|
||||||
$this->tag = $type;
|
if (null === $this->content) {
|
||||||
$pieces = explode(' ', $content);
|
$this->content = "{$this->link} {$this->description}";
|
||||||
|
|
||||||
if (count($pieces) > 1) {
|
|
||||||
$this->link = array_shift($pieces);
|
|
||||||
$this->description = implode(' ', $pieces);
|
|
||||||
} else {
|
|
||||||
$this->link = $content;
|
|
||||||
$this->description = $content;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
$this->content = $content;
|
return $this->content;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the link
|
* {@inheritdoc}
|
||||||
|
*/
|
||||||
|
public function setContent($content)
|
||||||
|
{
|
||||||
|
parent::setContent($content);
|
||||||
|
$parts = preg_split('/\s+/Su', $this->description, 2);
|
||||||
|
|
||||||
|
$this->link = $parts[0];
|
||||||
|
|
||||||
|
$this->setDescription(isset($parts[1]) ? $parts[1] : $parts[0]);
|
||||||
|
|
||||||
|
$this->content = $content;
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the link
|
||||||
*
|
*
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
@@ -62,10 +69,13 @@ class LinkTag extends Tag
|
|||||||
*
|
*
|
||||||
* @param string $link The link
|
* @param string $link The link
|
||||||
*
|
*
|
||||||
* @return void
|
* @return $this
|
||||||
*/
|
*/
|
||||||
public function setLink($link)
|
public function setLink($link)
|
||||||
{
|
{
|
||||||
$this->link = $link;
|
$this->link = $link;
|
||||||
|
|
||||||
|
$this->content = null;
|
||||||
|
return $this;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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)
|
||||||
@@ -12,14 +12,16 @@
|
|||||||
|
|
||||||
namespace phpDocumentor\Reflection\DocBlock\Tag;
|
namespace phpDocumentor\Reflection\DocBlock\Tag;
|
||||||
|
|
||||||
|
use 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 ReturnTag
|
||||||
{
|
{
|
||||||
|
|
||||||
/** @var string */
|
/** @var string */
|
||||||
@@ -28,47 +30,93 @@ class MethodTag extends ParamTag
|
|||||||
/** @var string */
|
/** @var string */
|
||||||
protected $arguments = '';
|
protected $arguments = '';
|
||||||
|
|
||||||
/**
|
/** @var bool */
|
||||||
* Parses a tag and populates the member variables.
|
protected $isStatic = false;
|
||||||
*
|
|
||||||
* @param string $type Tag identifier for this tag (should be 'return')
|
|
||||||
* @param string $content Contents for this tag.
|
|
||||||
*/
|
|
||||||
public function __construct($type, $content)
|
|
||||||
{
|
|
||||||
$this->tag = $type;
|
|
||||||
$this->content = $content;
|
|
||||||
|
|
||||||
$matches = array();
|
/**
|
||||||
|
* {@inheritdoc}
|
||||||
|
*/
|
||||||
|
public function getContent()
|
||||||
|
{
|
||||||
|
if (null === $this->content) {
|
||||||
|
$this->content = '';
|
||||||
|
if ($this->isStatic) {
|
||||||
|
$this->content .= 'static ';
|
||||||
|
}
|
||||||
|
$this->content .= $this->type .
|
||||||
|
" {$this->method_name}({$this->arguments}) " .
|
||||||
|
$this->description;
|
||||||
|
}
|
||||||
|
|
||||||
|
return $this->content;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* {@inheritdoc}
|
||||||
|
*/
|
||||||
|
public function setContent($content)
|
||||||
|
{
|
||||||
|
Tag::setContent($content);
|
||||||
// 1. none or more whitespace
|
// 1. none or more whitespace
|
||||||
// 2. optionally a word with underscores followed by whitespace : as
|
// 2. optionally the keyword "static" followed by whitespace
|
||||||
|
// 3. optionally a word with underscores followed by whitespace : as
|
||||||
// type for the return value
|
// type for the return value
|
||||||
// 3. then optionally a word with underscores followed by () and
|
// 4. then optionally a word with underscores followed by () and
|
||||||
// whitespace : as method name as used by phpDocumentor
|
// whitespace : as method name as used by phpDocumentor
|
||||||
// 4. then a word with underscores, followed by ( and any character
|
// 5. then a word with underscores, followed by ( and any character
|
||||||
// until a ) and whitespace : as method name with signature
|
// until a ) and whitespace : as method name with signature
|
||||||
// 5. any remaining text : as description
|
// 6. any remaining text : as description
|
||||||
if (preg_match(
|
if (preg_match(
|
||||||
'/^[\s]*(?:([\w\|_\\\\]+)[\s]+)?(?:[\w_]+\(\)[\s]+)?([\w\|_\\\\]+)\(([^\)]*)\)'
|
'/^
|
||||||
.'[\s]*(.*)/u',
|
# Static keyword
|
||||||
$content,
|
# Declates a static method ONLY if type is also present
|
||||||
|
(?:
|
||||||
|
(static)
|
||||||
|
\s+
|
||||||
|
)?
|
||||||
|
# Return type
|
||||||
|
(?:
|
||||||
|
([\w\|_\\\\]+)
|
||||||
|
\s+
|
||||||
|
)?
|
||||||
|
# Legacy method name (not captured)
|
||||||
|
(?:
|
||||||
|
[\w_]+\(\)\s+
|
||||||
|
)?
|
||||||
|
# Method name
|
||||||
|
([\w\|_\\\\]+)
|
||||||
|
# Arguments
|
||||||
|
\(([^\)]*)\)
|
||||||
|
\s*
|
||||||
|
# Description
|
||||||
|
(.*)
|
||||||
|
$/sux',
|
||||||
|
$this->description,
|
||||||
$matches
|
$matches
|
||||||
)) {
|
)) {
|
||||||
list(
|
list(
|
||||||
,
|
,
|
||||||
|
$static,
|
||||||
$this->type,
|
$this->type,
|
||||||
$this->method_name,
|
$this->method_name,
|
||||||
$this->arguments,
|
$this->arguments,
|
||||||
$this->description
|
$this->description
|
||||||
) = $matches;
|
) = $matches;
|
||||||
if (!$this->type)
|
if ($static) {
|
||||||
{
|
if (!$this->type) {
|
||||||
$this->type = 'void';
|
$this->type = 'static';
|
||||||
|
} else {
|
||||||
|
$this->isStatic = true;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
if (!$this->type) {
|
||||||
|
$this->type = 'void';
|
||||||
|
}
|
||||||
}
|
}
|
||||||
} else {
|
$this->parsedDescription = null;
|
||||||
echo date('c') . ' ERR (3): @method contained invalid contents: '
|
|
||||||
. $this->content . PHP_EOL;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
return $this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -76,11 +124,14 @@ class MethodTag extends ParamTag
|
|||||||
*
|
*
|
||||||
* @param string $method_name The name of the method.
|
* @param string $method_name The name of the method.
|
||||||
*
|
*
|
||||||
* @return void
|
* @return $this
|
||||||
*/
|
*/
|
||||||
public function setMethodName($method_name)
|
public function setMethodName($method_name)
|
||||||
{
|
{
|
||||||
$this->method_name = $method_name;
|
$this->method_name = $method_name;
|
||||||
|
|
||||||
|
$this->content = null;
|
||||||
|
return $this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -103,6 +154,9 @@ class MethodTag extends ParamTag
|
|||||||
public function setArguments($arguments)
|
public function setArguments($arguments)
|
||||||
{
|
{
|
||||||
$this->arguments = $arguments;
|
$this->arguments = $arguments;
|
||||||
|
|
||||||
|
$this->content = null;
|
||||||
|
return $this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -127,4 +181,29 @@ class MethodTag extends ParamTag
|
|||||||
return $arguments;
|
return $arguments;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Checks whether the method tag describes a static method or not.
|
||||||
|
*
|
||||||
|
* @return bool TRUE if the method declaration is for a static method, FALSE
|
||||||
|
* otherwise.
|
||||||
|
*/
|
||||||
|
public function isStatic()
|
||||||
|
{
|
||||||
|
return $this->isStatic;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets a new value for whether the method is static or not.
|
||||||
|
*
|
||||||
|
* @param bool $isStatic The new value to set.
|
||||||
|
*
|
||||||
|
* @return $this
|
||||||
|
*/
|
||||||
|
public function setIsStatic($isStatic)
|
||||||
|
{
|
||||||
|
$this->isStatic = $isStatic;
|
||||||
|
|
||||||
|
$this->content = null;
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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,75 +11,75 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
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 ReturnTag
|
||||||
{
|
{
|
||||||
/** @var string */
|
/** @var string */
|
||||||
protected $type = null;
|
protected $variableName = '';
|
||||||
|
|
||||||
|
/** @var bool determines whether this is a variadic argument */
|
||||||
|
protected $isVariadic = false;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @var string
|
* {@inheritdoc}
|
||||||
*/
|
*/
|
||||||
protected $variableName = null;
|
public function getContent()
|
||||||
|
|
||||||
/**
|
|
||||||
* Parses a tag and populates the member variables.
|
|
||||||
*
|
|
||||||
* @param string $type Tag identifier for this tag (should be 'return')
|
|
||||||
* @param string $content Contents for this tag.
|
|
||||||
*/
|
|
||||||
public function __construct($type, $content)
|
|
||||||
{
|
{
|
||||||
$this->tag = $type;
|
if (null === $this->content) {
|
||||||
|
$this->content
|
||||||
|
= "{$this->type} {$this->variableName} {$this->description}";
|
||||||
|
}
|
||||||
|
return $this->content;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* {@inheritdoc}
|
||||||
|
*/
|
||||||
|
public function setContent($content)
|
||||||
|
{
|
||||||
|
Tag::setContent($content);
|
||||||
|
$parts = preg_split(
|
||||||
|
'/(\s+)/Su',
|
||||||
|
$this->description,
|
||||||
|
3,
|
||||||
|
PREG_SPLIT_DELIM_CAPTURE
|
||||||
|
);
|
||||||
|
|
||||||
|
// if the first item that is encountered is not a variable; it is a type
|
||||||
|
if (isset($parts[0])
|
||||||
|
&& (strlen($parts[0]) > 0)
|
||||||
|
&& ($parts[0][0] !== '$')
|
||||||
|
) {
|
||||||
|
$this->type = array_shift($parts);
|
||||||
|
array_shift($parts);
|
||||||
|
}
|
||||||
|
|
||||||
|
// if the next item starts with a $ or ...$ it must be the variable name
|
||||||
|
if (isset($parts[0])
|
||||||
|
&& (strlen($parts[0]) > 0)
|
||||||
|
&& ($parts[0][0] == '$' || substr($parts[0], 0, 4) === '...$')
|
||||||
|
) {
|
||||||
|
$this->variableName = array_shift($parts);
|
||||||
|
array_shift($parts);
|
||||||
|
|
||||||
|
if (substr($this->variableName, 0, 3) === '...') {
|
||||||
|
$this->isVariadic = true;
|
||||||
|
$this->variableName = substr($this->variableName, 3);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->setDescription(implode('', $parts));
|
||||||
|
|
||||||
$this->content = $content;
|
$this->content = $content;
|
||||||
$content = preg_split('/\s+/u', $content);
|
return $this;
|
||||||
|
|
||||||
// if there is only 1, it is either a piece of content or a variable name
|
|
||||||
if (count($content) > 1) {
|
|
||||||
$this->type = array_shift($content);
|
|
||||||
}
|
|
||||||
|
|
||||||
// if the next item starts with a $ it must be the variable name
|
|
||||||
if ((strlen($content[0]) > 0) && ($content[0][0] == '$')) {
|
|
||||||
$this->variableName = array_shift($content);
|
|
||||||
}
|
|
||||||
|
|
||||||
$this->description = implode(' ', $content);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the unique types of the variable.
|
|
||||||
*
|
|
||||||
* @return string[]
|
|
||||||
*/
|
|
||||||
public function getTypes()
|
|
||||||
{
|
|
||||||
$types = explode('|', $this->type);
|
|
||||||
foreach ($types as &$type) {
|
|
||||||
$type = !empty($type) && $this->docblock
|
|
||||||
? $this->docblock->expandType($type)
|
|
||||||
: trim($type);
|
|
||||||
}
|
|
||||||
|
|
||||||
return $types;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the type section of the variable.
|
|
||||||
*
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
public function getType()
|
|
||||||
{
|
|
||||||
return $this->type;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -97,10 +97,23 @@ class ParamTag extends Tag
|
|||||||
*
|
*
|
||||||
* @param string $name The new name for this variable.
|
* @param string $name The new name for this variable.
|
||||||
*
|
*
|
||||||
* @return void
|
* @return $this
|
||||||
*/
|
*/
|
||||||
public function setVariableName($name)
|
public function setVariableName($name)
|
||||||
{
|
{
|
||||||
$this->variableName = $name;
|
$this->variableName = $name;
|
||||||
|
|
||||||
|
$this->content = null;
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns whether this tag is variadic.
|
||||||
|
*
|
||||||
|
* @return boolean
|
||||||
|
*/
|
||||||
|
public function isVariadic()
|
||||||
|
{
|
||||||
|
return $this->isVariadic;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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)
|
||||||
@@ -13,13 +13,12 @@
|
|||||||
namespace phpDocumentor\Reflection\DocBlock\Tag;
|
namespace phpDocumentor\Reflection\DocBlock\Tag;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Reflection class for a {@property} tag in a Docblock.
|
* Reflection class for a @property-read 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)
|
||||||
@@ -13,13 +13,12 @@
|
|||||||
namespace phpDocumentor\Reflection\DocBlock\Tag;
|
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)
|
||||||
@@ -13,13 +13,12 @@
|
|||||||
namespace phpDocumentor\Reflection\DocBlock\Tag;
|
namespace phpDocumentor\Reflection\DocBlock\Tag;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Reflection class for a {@property} tag in a Docblock.
|
* Reflection class for a @property-write 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)
|
||||||
@@ -12,34 +12,88 @@
|
|||||||
|
|
||||||
namespace phpDocumentor\Reflection\DocBlock\Tag;
|
namespace phpDocumentor\Reflection\DocBlock\Tag;
|
||||||
|
|
||||||
|
use phpDocumentor\Reflection\DocBlock\Tag;
|
||||||
|
use phpDocumentor\Reflection\DocBlock\Type\Collection;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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 Tag
|
||||||
{
|
{
|
||||||
/** @var string */
|
/** @var string The raw type component. */
|
||||||
protected $type = null;
|
protected $type = '';
|
||||||
|
|
||||||
|
/** @var Collection The parsed type component. */
|
||||||
|
protected $types = null;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Parses a tag and populates the member variables.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @param string $type Tag identifier for this tag (should be 'return')
|
|
||||||
* @param string $content Contents for this tag.
|
|
||||||
*/
|
*/
|
||||||
public function __construct($type, $content)
|
public function getContent()
|
||||||
{
|
{
|
||||||
$this->tag = $type;
|
if (null === $this->content) {
|
||||||
$this->content = $content;
|
$this->content = "{$this->type} {$this->description}";
|
||||||
$content = preg_split('/\s+/u', $content);
|
}
|
||||||
|
|
||||||
// any output is considered a type
|
return $this->content;
|
||||||
$this->type = array_shift($content);
|
|
||||||
|
|
||||||
$this->description = implode(' ', $content);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* {@inheritdoc}
|
||||||
|
*/
|
||||||
|
public function setContent($content)
|
||||||
|
{
|
||||||
|
parent::setContent($content);
|
||||||
|
|
||||||
|
$parts = preg_split('/\s+/Su', $this->description, 2);
|
||||||
|
|
||||||
|
// any output is considered a type
|
||||||
|
$this->type = $parts[0];
|
||||||
|
$this->types = null;
|
||||||
|
|
||||||
|
$this->setDescription(isset($parts[1]) ? $parts[1] : '');
|
||||||
|
|
||||||
|
$this->content = $content;
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the unique types of the variable.
|
||||||
|
*
|
||||||
|
* @return string[]
|
||||||
|
*/
|
||||||
|
public function getTypes()
|
||||||
|
{
|
||||||
|
return $this->getTypesCollection()->getArrayCopy();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the type section of the variable.
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getType()
|
||||||
|
{
|
||||||
|
return (string) $this->getTypesCollection();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the type collection.
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
protected function getTypesCollection()
|
||||||
|
{
|
||||||
|
if (null === $this->types) {
|
||||||
|
$this->types = new Collection(
|
||||||
|
array($this->type),
|
||||||
|
$this->docblock ? $this->docblock->getContext() : null
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return $this->types;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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
|
||||||
{
|
{
|
||||||
@@ -26,25 +27,35 @@ class SeeTag extends Tag
|
|||||||
protected $refers = null;
|
protected $refers = null;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Parses a tag and populates the member variables.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @param string $type Tag identifier for this tag (should be 'return')
|
|
||||||
* @param string $content Contents for this tag.
|
|
||||||
*/
|
*/
|
||||||
public function __construct($type, $content)
|
public function getContent()
|
||||||
{
|
{
|
||||||
$this->tag = $type;
|
if (null === $this->content) {
|
||||||
$this->content = $content;
|
$this->content = "{$this->refers} {$this->description}";
|
||||||
$content = preg_split('/\s+/u', $content);
|
}
|
||||||
|
return $this->content;
|
||||||
// any output is considered a type
|
|
||||||
$this->refers = array_shift($content);
|
|
||||||
|
|
||||||
$this->description = implode(' ', $content);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the type of the variable.
|
* {@inheritdoc}
|
||||||
|
*/
|
||||||
|
public function setContent($content)
|
||||||
|
{
|
||||||
|
parent::setContent($content);
|
||||||
|
$parts = preg_split('/\s+/Su', $this->description, 2);
|
||||||
|
|
||||||
|
// any output is considered a type
|
||||||
|
$this->refers = $parts[0];
|
||||||
|
|
||||||
|
$this->setDescription(isset($parts[1]) ? $parts[1] : '');
|
||||||
|
|
||||||
|
$this->content = $content;
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the structural element this tag refers to.
|
||||||
*
|
*
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
@@ -53,4 +64,18 @@ class SeeTag extends Tag
|
|||||||
return $this->refers;
|
return $this->refers;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the structural element this tag refers to.
|
||||||
|
*
|
||||||
|
* @param string $refers The new type this tag refers to.
|
||||||
|
*
|
||||||
|
* @return $this
|
||||||
|
*/
|
||||||
|
public function setReference($refers)
|
||||||
|
{
|
||||||
|
$this->refers = $refers;
|
||||||
|
|
||||||
|
$this->content = null;
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,26 @@
|
|||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* phpDocumentor
|
||||||
|
*
|
||||||
|
* PHP Version 5.3
|
||||||
|
*
|
||||||
|
* @author Vasil Rangelov <[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\Tag;
|
||||||
|
|
||||||
|
use phpDocumentor\Reflection\DocBlock\Tag\VersionTag;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reflection class for a @since tag in a Docblock.
|
||||||
|
*
|
||||||
|
* @author Vasil Rangelov <[email protected]>
|
||||||
|
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
||||||
|
* @link http://phpdoc.org
|
||||||
|
*/
|
||||||
|
class SinceTag extends VersionTag
|
||||||
|
{
|
||||||
|
}
|
||||||
@@ -0,0 +1,137 @@
|
|||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* phpDocumentor
|
||||||
|
*
|
||||||
|
* PHP Version 5.3
|
||||||
|
*
|
||||||
|
* @author Vasil Rangelov <[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\Tag;
|
||||||
|
|
||||||
|
use phpDocumentor\Reflection\DocBlock\Tag;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reflection class for a @source tag in a Docblock.
|
||||||
|
*
|
||||||
|
* @author Vasil Rangelov <[email protected]>
|
||||||
|
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
||||||
|
* @link http://phpdoc.org
|
||||||
|
*/
|
||||||
|
class SourceTag extends Tag
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @var int The starting line, relative to the structural element's
|
||||||
|
* location.
|
||||||
|
*/
|
||||||
|
protected $startingLine = 1;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @var int|null The number of lines, relative to the starting line. NULL
|
||||||
|
* means "to the end".
|
||||||
|
*/
|
||||||
|
protected $lineCount = null;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* {@inheritdoc}
|
||||||
|
*/
|
||||||
|
public function getContent()
|
||||||
|
{
|
||||||
|
if (null === $this->content) {
|
||||||
|
$this->content
|
||||||
|
= "{$this->startingLine} {$this->lineCount} {$this->description}";
|
||||||
|
}
|
||||||
|
|
||||||
|
return $this->content;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* {@inheritdoc}
|
||||||
|
*/
|
||||||
|
public function setContent($content)
|
||||||
|
{
|
||||||
|
parent::setContent($content);
|
||||||
|
if (preg_match(
|
||||||
|
'/^
|
||||||
|
# Starting line
|
||||||
|
([1-9]\d*)
|
||||||
|
\s*
|
||||||
|
# Number of lines
|
||||||
|
(?:
|
||||||
|
((?1))
|
||||||
|
\s+
|
||||||
|
)?
|
||||||
|
# Description
|
||||||
|
(.*)
|
||||||
|
$/sux',
|
||||||
|
$this->description,
|
||||||
|
$matches
|
||||||
|
)) {
|
||||||
|
$this->startingLine = (int)$matches[1];
|
||||||
|
if (isset($matches[2]) && '' !== $matches[2]) {
|
||||||
|
$this->lineCount = (int)$matches[2];
|
||||||
|
}
|
||||||
|
$this->setDescription($matches[3]);
|
||||||
|
$this->content = $content;
|
||||||
|
}
|
||||||
|
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the starting line.
|
||||||
|
*
|
||||||
|
* @return int The starting line, relative to the structural element's
|
||||||
|
* location.
|
||||||
|
*/
|
||||||
|
public function getStartingLine()
|
||||||
|
{
|
||||||
|
return $this->startingLine;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the starting line.
|
||||||
|
*
|
||||||
|
* @param int $startingLine The new starting line, relative to the
|
||||||
|
* structural element's location.
|
||||||
|
*
|
||||||
|
* @return $this
|
||||||
|
*/
|
||||||
|
public function setStartingLine($startingLine)
|
||||||
|
{
|
||||||
|
$this->startingLine = $startingLine;
|
||||||
|
|
||||||
|
$this->content = null;
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the number of lines.
|
||||||
|
*
|
||||||
|
* @return int|null The number of lines, relative to the starting line. NULL
|
||||||
|
* means "to the end".
|
||||||
|
*/
|
||||||
|
public function getLineCount()
|
||||||
|
{
|
||||||
|
return $this->lineCount;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the number of lines.
|
||||||
|
*
|
||||||
|
* @param int|null $lineCount The new number of lines, relative to the
|
||||||
|
* starting line. NULL means "to the end".
|
||||||
|
*
|
||||||
|
* @return $this
|
||||||
|
*/
|
||||||
|
public function setLineCount($lineCount)
|
||||||
|
{
|
||||||
|
$this->lineCount = $lineCount;
|
||||||
|
|
||||||
|
$this->content = null;
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
<?php
|
|
||||||
/**
|
|
||||||
* phpDocumentor
|
|
||||||
*
|
|
||||||
* PHP Version 5
|
|
||||||
*
|
|
||||||
* @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\Tag;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Reflection class for a mistyped @throws tag called @throw in a Docblock.
|
|
||||||
*
|
|
||||||
* This is a very common error, so @throw is aliased to be @throws
|
|
||||||
*
|
|
||||||
* @author Mike van Riel <[email protected]>
|
|
||||||
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
|
||||||
* @link http://phpdoc.org
|
|
||||||
*/
|
|
||||||
class ThrowTag extends ThrowsTag
|
|
||||||
{
|
|
||||||
/**
|
|
||||||
* Sets the type to {@throws} and lets parent parse the tag and populates the
|
|
||||||
* member variables.
|
|
||||||
*
|
|
||||||
* @param string $type Tag identifier for this tag (should be 'return')
|
|
||||||
* @param string $content Contents for this tag.
|
|
||||||
*/
|
|
||||||
public function __construct($type, $content)
|
|
||||||
{
|
|
||||||
if ('throw' !== $type) {
|
|
||||||
throw new \InvalidArgumentException(
|
|
||||||
'Internal error, ' . __CLASS__ . ' was called with ' . $type
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
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)
|
||||||
@@ -13,13 +13,12 @@
|
|||||||
namespace phpDocumentor\Reflection\DocBlock\Tag;
|
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)
|
||||||
@@ -13,13 +13,12 @@
|
|||||||
namespace phpDocumentor\Reflection\DocBlock\Tag;
|
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)
|
||||||
@@ -13,41 +13,12 @@
|
|||||||
namespace phpDocumentor\Reflection\DocBlock\Tag;
|
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
|
||||||
{
|
{
|
||||||
/**
|
|
||||||
* Parses a tag and populates the member variables.
|
|
||||||
*
|
|
||||||
* @param string $type Tag identifier for this tag (should be 'return')
|
|
||||||
* @param string $content Contents for this tag.
|
|
||||||
*/
|
|
||||||
public function __construct($type, $content)
|
|
||||||
{
|
|
||||||
$this->tag = $type;
|
|
||||||
$this->content = $content;
|
|
||||||
$content = preg_split('/\s+/u', $content);
|
|
||||||
|
|
||||||
if (count($content) == 0) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// var always starts with the variable name
|
|
||||||
$this->type = array_shift($content);
|
|
||||||
|
|
||||||
// if the next item starts with a $ it must be the variable name
|
|
||||||
if ((count($content) > 0)
|
|
||||||
&& (strlen($content[0]) > 0)
|
|
||||||
&& ($content[0][0] == '$')
|
|
||||||
) {
|
|
||||||
$this->variableName = array_shift($content);
|
|
||||||
}
|
|
||||||
|
|
||||||
$this->description = implode(' ', $content);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,108 @@
|
|||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* phpDocumentor
|
||||||
|
*
|
||||||
|
* PHP Version 5.3
|
||||||
|
*
|
||||||
|
* @author Vasil Rangelov <[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\Tag;
|
||||||
|
|
||||||
|
use phpDocumentor\Reflection\DocBlock\Tag;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reflection class for a @version tag in a Docblock.
|
||||||
|
*
|
||||||
|
* @author Vasil Rangelov <[email protected]>
|
||||||
|
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
||||||
|
* @link http://phpdoc.org
|
||||||
|
*/
|
||||||
|
class VersionTag extends Tag
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* PCRE regular expression matching a version vector.
|
||||||
|
* Assumes the "x" modifier.
|
||||||
|
*/
|
||||||
|
const REGEX_VECTOR = '(?:
|
||||||
|
# Normal release vectors.
|
||||||
|
\d\S*
|
||||||
|
|
|
||||||
|
# VCS version vectors. Per PHPCS, they are expected to
|
||||||
|
# follow the form of the VCS name, followed by ":", followed
|
||||||
|
# by the version vector itself.
|
||||||
|
# By convention, popular VCSes like CVS, SVN and GIT use "$"
|
||||||
|
# around the actual version vector.
|
||||||
|
[^\s\:]+\:\s*\$[^\$]+\$
|
||||||
|
)';
|
||||||
|
|
||||||
|
/** @var string The version vector. */
|
||||||
|
protected $version = '';
|
||||||
|
|
||||||
|
public function getContent()
|
||||||
|
{
|
||||||
|
if (null === $this->content) {
|
||||||
|
$this->content = "{$this->version} {$this->description}";
|
||||||
|
}
|
||||||
|
|
||||||
|
return $this->content;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* {@inheritdoc}
|
||||||
|
*/
|
||||||
|
public function setContent($content)
|
||||||
|
{
|
||||||
|
parent::setContent($content);
|
||||||
|
|
||||||
|
if (preg_match(
|
||||||
|
'/^
|
||||||
|
# The version vector
|
||||||
|
(' . self::REGEX_VECTOR . ')
|
||||||
|
\s*
|
||||||
|
# The description
|
||||||
|
(.+)?
|
||||||
|
$/sux',
|
||||||
|
$this->description,
|
||||||
|
$matches
|
||||||
|
)) {
|
||||||
|
$this->version = $matches[1];
|
||||||
|
$this->setDescription(isset($matches[2]) ? $matches[2] : '');
|
||||||
|
$this->content = $content;
|
||||||
|
}
|
||||||
|
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the version section of the tag.
|
||||||
|
*
|
||||||
|
* @return string The version section of the tag.
|
||||||
|
*/
|
||||||
|
public function getVersion()
|
||||||
|
{
|
||||||
|
return $this->version;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the version section of the tag.
|
||||||
|
*
|
||||||
|
* @param string $version The new version section of the tag.
|
||||||
|
* An invalid value will set an empty string.
|
||||||
|
*
|
||||||
|
* @return $this
|
||||||
|
*/
|
||||||
|
public function setVersion($version)
|
||||||
|
{
|
||||||
|
$this->version
|
||||||
|
= preg_match('/^' . self::REGEX_VECTOR . '$/ux', $version)
|
||||||
|
? $version
|
||||||
|
: '';
|
||||||
|
|
||||||
|
$this->content = null;
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,221 @@
|
|||||||
|
<?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;
|
||||||
|
|
||||||
|
use phpDocumentor\Reflection\DocBlock\Context;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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 */
|
||||||
|
const OPERATOR_OR = '|';
|
||||||
|
|
||||||
|
/** @var string Definition of the ARRAY operator for types */
|
||||||
|
const OPERATOR_ARRAY = '[]';
|
||||||
|
|
||||||
|
/** @var string Definition of the NAMESPACE operator in PHP */
|
||||||
|
const OPERATOR_NAMESPACE = '\\';
|
||||||
|
|
||||||
|
/** @var string[] List of recognized keywords */
|
||||||
|
protected static $keywords = array(
|
||||||
|
'string', 'int', 'integer', 'bool', 'boolean', 'float', 'double',
|
||||||
|
'object', 'mixed', 'array', 'resource', 'void', 'null', 'scalar',
|
||||||
|
'callback', 'callable', 'false', 'true', 'self', '$this', 'static'
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Current invoking location.
|
||||||
|
*
|
||||||
|
* This is used to prepend to type with a relative location.
|
||||||
|
* May also be 'default' or 'global', in which case they are ignored.
|
||||||
|
*
|
||||||
|
* @var Context
|
||||||
|
*/
|
||||||
|
protected $context = null;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers the namespace and aliases; uses that to add and expand the
|
||||||
|
* given types.
|
||||||
|
*
|
||||||
|
* @param string[] $types Array containing a list of types to add to this
|
||||||
|
* container.
|
||||||
|
* @param Context $location The current invoking location.
|
||||||
|
*/
|
||||||
|
public function __construct(
|
||||||
|
array $types = array(),
|
||||||
|
Context $context = null
|
||||||
|
) {
|
||||||
|
$this->context = null === $context ? new Context() : $context;
|
||||||
|
|
||||||
|
foreach ($types as $type) {
|
||||||
|
$this->add($type);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the current invoking location.
|
||||||
|
*
|
||||||
|
* @return Context
|
||||||
|
*/
|
||||||
|
public function getContext()
|
||||||
|
{
|
||||||
|
return $this->context;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adds a new type to the collection and expands it if it contains a
|
||||||
|
* relative namespace.
|
||||||
|
*
|
||||||
|
* If a class in the type contains a relative namespace than this collection
|
||||||
|
* will try to expand that into a FQCN.
|
||||||
|
*
|
||||||
|
* @param string $type A 'Type' as defined in the phpDocumentor
|
||||||
|
* documentation.
|
||||||
|
*
|
||||||
|
* @throws \InvalidArgumentException if a non-string argument is passed.
|
||||||
|
*
|
||||||
|
* @see http://phpdoc.org/docs/latest/for-users/types.html for the
|
||||||
|
* definition of a type.
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function add($type)
|
||||||
|
{
|
||||||
|
if (!is_string($type)) {
|
||||||
|
throw new \InvalidArgumentException(
|
||||||
|
'A type should be represented by a string, received: '
|
||||||
|
.var_export($type, true)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// separate the type by the OR operator
|
||||||
|
$type_parts = explode(self::OPERATOR_OR, $type);
|
||||||
|
foreach ($type_parts as $part) {
|
||||||
|
$expanded_type = $this->expand($part);
|
||||||
|
if ($expanded_type) {
|
||||||
|
$this[] = $expanded_type;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns a string representation of the collection.
|
||||||
|
*
|
||||||
|
* @return string The resolved types across the collection, separated with
|
||||||
|
* {@link self::OPERATOR_OR}.
|
||||||
|
*/
|
||||||
|
public function __toString()
|
||||||
|
{
|
||||||
|
return implode(self::OPERATOR_OR, $this->getArrayCopy());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Analyzes the given type and returns the FQCN variant.
|
||||||
|
*
|
||||||
|
* When a type is provided this method checks whether it is not a keyword or
|
||||||
|
* Fully Qualified Class Name. If so it will use the given namespace and
|
||||||
|
* aliases to expand the type to a FQCN representation.
|
||||||
|
*
|
||||||
|
* 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.
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
protected function expand($type)
|
||||||
|
{
|
||||||
|
$type = trim($type);
|
||||||
|
if (!$type) {
|
||||||
|
return '';
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($this->isTypeAnArray($type)) {
|
||||||
|
return $this->expand(substr($type, 0, -2)) . self::OPERATOR_ARRAY;
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($this->isRelativeType($type) && !$this->isTypeAKeyword($type)) {
|
||||||
|
$type_parts = explode(self::OPERATOR_NAMESPACE, $type, 2);
|
||||||
|
|
||||||
|
$namespace_aliases = $this->context->getNamespaceAliases();
|
||||||
|
// if the first segment is not an alias; prepend namespace name and
|
||||||
|
// return
|
||||||
|
if (!isset($namespace_aliases[$type_parts[0]])) {
|
||||||
|
$namespace = $this->context->getNamespace();
|
||||||
|
if ('' !== $namespace) {
|
||||||
|
$namespace .= self::OPERATOR_NAMESPACE;
|
||||||
|
}
|
||||||
|
return self::OPERATOR_NAMESPACE . $namespace . $type;
|
||||||
|
}
|
||||||
|
|
||||||
|
$type_parts[0] = $namespace_aliases[$type_parts[0]];
|
||||||
|
$type = implode(self::OPERATOR_NAMESPACE, $type_parts);
|
||||||
|
}
|
||||||
|
|
||||||
|
return $type;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Detects whether the given type represents an array.
|
||||||
|
*
|
||||||
|
* @param string $type A relative or absolute type as defined in the
|
||||||
|
* phpDocumentor documentation.
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
protected function isTypeAnArray($type)
|
||||||
|
{
|
||||||
|
return substr($type, -2) === self::OPERATOR_ARRAY;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Detects whether the given type represents a PHPDoc keyword.
|
||||||
|
*
|
||||||
|
* @param string $type A relative or absolute type as defined in the
|
||||||
|
* phpDocumentor documentation.
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
protected function isTypeAKeyword($type)
|
||||||
|
{
|
||||||
|
return in_array(strtolower($type), static::$keywords, true);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Detects whether the given type represents a relative or absolute path.
|
||||||
|
*
|
||||||
|
* This method will detect keywords as being absolute; even though they are
|
||||||
|
* not preceeded by a namespace separator.
|
||||||
|
*
|
||||||
|
* @param string $type A relative or absolute type as defined in the
|
||||||
|
* phpDocumentor documentation.
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
protected function isRelativeType($type)
|
||||||
|
{
|
||||||
|
return ($type[0] !== self::OPERATOR_NAMESPACE)
|
||||||
|
|| $this->isTypeAKeyword($type);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,94 @@
|
|||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* This file is part of phpDocumentor.
|
||||||
|
*
|
||||||
|
* For the full copyright and license information, please view the LICENSE
|
||||||
|
* file that was distributed with this source code.
|
||||||
|
*
|
||||||
|
* @copyright 2010-2015 Mike van Riel<[email protected]>
|
||||||
|
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
||||||
|
* @link http://phpdoc.org
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace phpDocumentor\Reflection\DocBlock {
|
||||||
|
|
||||||
|
// Added imports on purpose as mock for the unit tests, please do not remove.
|
||||||
|
use Mockery as m;
|
||||||
|
use phpDocumentor\Reflection\DocBlock,
|
||||||
|
phpDocumentor\Reflection\DocBlock\Tag;
|
||||||
|
use \ReflectionClass; // yes, the slash is part of the test
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @coversDefaultClass \phpDocumentor\Reflection\DocBlock\ContextFactory
|
||||||
|
* @covers ::<private>
|
||||||
|
*/
|
||||||
|
class ContextFactoryTest extends \PHPUnit_Framework_TestCase
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @covers ::createFromClassReflector
|
||||||
|
* @covers ::createForNamespace
|
||||||
|
* @uses phpDocumentor\Reflection\DocBlock\Context
|
||||||
|
*/
|
||||||
|
public function testReadsNamespaceFromClassReflection()
|
||||||
|
{
|
||||||
|
$fixture = new ContextFactory();
|
||||||
|
$context = $fixture->createFromClassReflector(new ReflectionClass($this));
|
||||||
|
|
||||||
|
$this->assertSame(__NAMESPACE__, $context->getNamespace());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers ::createFromClassReflector
|
||||||
|
* @covers ::createForNamespace
|
||||||
|
* @uses phpDocumentor\Reflection\DocBlock\Context
|
||||||
|
*/
|
||||||
|
public function testReadsAliasesFromClassReflection()
|
||||||
|
{
|
||||||
|
$fixture = new ContextFactory();
|
||||||
|
$expected = [
|
||||||
|
'm' => 'Mockery',
|
||||||
|
'DocBlock' => 'phpDocumentor\Reflection\DocBlock',
|
||||||
|
'Tag' => 'phpDocumentor\Reflection\DocBlock\Tag',
|
||||||
|
'ReflectionClass' => 'ReflectionClass'
|
||||||
|
];
|
||||||
|
$context = $fixture->createFromClassReflector(new ReflectionClass($this));
|
||||||
|
|
||||||
|
$this->assertSame($expected, $context->getNamespaceAliases());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers ::createForNamespace
|
||||||
|
* @uses phpDocumentor\Reflection\DocBlock\Context
|
||||||
|
*/
|
||||||
|
public function testReadsNamespaceFromProvidedNamespaceAndContent()
|
||||||
|
{
|
||||||
|
$fixture = new ContextFactory();
|
||||||
|
$context = $fixture->createForNamespace(__NAMESPACE__, file_get_contents(__FILE__));
|
||||||
|
|
||||||
|
$this->assertSame(__NAMESPACE__, $context->getNamespace());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers ::createForNamespace
|
||||||
|
* @uses phpDocumentor\Reflection\DocBlock\Context
|
||||||
|
*/
|
||||||
|
public function testReadsAliasesFromProvidedNamespaceAndContent()
|
||||||
|
{
|
||||||
|
$fixture = new ContextFactory();
|
||||||
|
$expected = [
|
||||||
|
'm' => 'Mockery',
|
||||||
|
'DocBlock' => 'phpDocumentor\Reflection\DocBlock',
|
||||||
|
'Tag' => 'phpDocumentor\Reflection\DocBlock\Tag',
|
||||||
|
'ReflectionClass' => 'ReflectionClass'
|
||||||
|
];
|
||||||
|
$context = $fixture->createForNamespace(__NAMESPACE__, file_get_contents(__FILE__));
|
||||||
|
|
||||||
|
$this->assertSame($expected, $context->getNamespaceAliases());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
namespace phpDocumentor\Reflection\DocBlock\Mock {
|
||||||
|
// the following import should not show in the tests above
|
||||||
|
use phpDocumentor\Reflection\DocBlock\Description;
|
||||||
|
}
|
||||||
@@ -0,0 +1,61 @@
|
|||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* This file is part of phpDocumentor.
|
||||||
|
*
|
||||||
|
* For the full copyright and license information, please view the LICENSE
|
||||||
|
* file that was distributed with this source code.
|
||||||
|
*
|
||||||
|
* @copyright 2010-2015 Mike van Riel<[email protected]>
|
||||||
|
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
||||||
|
* @link http://phpdoc.org
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace phpDocumentor\Reflection\DocBlock;
|
||||||
|
|
||||||
|
use Mockery as m;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @coversDefaultClass \phpDocumentor\Reflection\DocBlock\Context
|
||||||
|
*/
|
||||||
|
class ContextTest extends \PHPUnit_Framework_TestCase
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @covers ::__construct
|
||||||
|
* @covers ::getNamespace
|
||||||
|
*/
|
||||||
|
public function testProvidesANormalizedNamespace()
|
||||||
|
{
|
||||||
|
$fixture = new Context('\My\Space');
|
||||||
|
$this->assertSame('My\Space', $fixture->getNamespace());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers ::__construct
|
||||||
|
* @covers ::getNamespace
|
||||||
|
*/
|
||||||
|
public function testInterpretsNamespaceNamedGlobalAsRootNamespace()
|
||||||
|
{
|
||||||
|
$fixture = new Context('global');
|
||||||
|
$this->assertSame('', $fixture->getNamespace());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers ::__construct
|
||||||
|
* @covers ::getNamespace
|
||||||
|
*/
|
||||||
|
public function testInterpretsNamespaceNamedDefaultAsRootNamespace()
|
||||||
|
{
|
||||||
|
$fixture = new Context('default');
|
||||||
|
$this->assertSame('', $fixture->getNamespace());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers ::__construct
|
||||||
|
* @covers ::getNamespaceAliases
|
||||||
|
*/
|
||||||
|
public function testProvidesNormalizedNamespaceAliases()
|
||||||
|
{
|
||||||
|
$fixture = new Context('', ['Space' => '\My\Space']);
|
||||||
|
$this->assertSame(['Space' => 'My\Space'], $fixture->getNamespaceAliases());
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,245 @@
|
|||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* phpDocumentor Description Test
|
||||||
|
*
|
||||||
|
* PHP Version 5.3
|
||||||
|
*
|
||||||
|
* @author Vasil Rangelov <[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;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Test class for \phpDocumentor\Reflection\DocBlock\Description
|
||||||
|
*
|
||||||
|
* @author Vasil Rangelov <[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 DescriptionTest extends \PHPUnit_Framework_TestCase
|
||||||
|
{
|
||||||
|
public function testConstruct()
|
||||||
|
{
|
||||||
|
$fixture = <<<LONGDESC
|
||||||
|
This is text for a description.
|
||||||
|
LONGDESC;
|
||||||
|
$object = new Description($fixture);
|
||||||
|
$this->assertSame($fixture, $object->getContents());
|
||||||
|
|
||||||
|
$parsedContents = $object->getParsedContents();
|
||||||
|
$this->assertCount(1, $parsedContents);
|
||||||
|
$this->assertSame($fixture, $parsedContents[0]);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testInlineTagParsing()
|
||||||
|
{
|
||||||
|
$fixture = <<<LONGDESC
|
||||||
|
This is text for a {@link http://phpdoc.org/ description} that uses inline
|
||||||
|
tags.
|
||||||
|
LONGDESC;
|
||||||
|
$object = new Description($fixture);
|
||||||
|
$this->assertSame($fixture, $object->getContents());
|
||||||
|
|
||||||
|
$parsedContents = $object->getParsedContents();
|
||||||
|
$this->assertCount(3, $parsedContents);
|
||||||
|
$this->assertSame('This is text for a ', $parsedContents[0]);
|
||||||
|
$this->assertInstanceOf(
|
||||||
|
__NAMESPACE__ . '\Tag\LinkTag',
|
||||||
|
$parsedContents[1]
|
||||||
|
);
|
||||||
|
$this->assertSame(
|
||||||
|
' that uses inline
|
||||||
|
tags.',
|
||||||
|
$parsedContents[2]
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testInlineTagAtStartParsing()
|
||||||
|
{
|
||||||
|
$fixture = <<<LONGDESC
|
||||||
|
{@link http://phpdoc.org/ This} is text for a description that uses inline
|
||||||
|
tags.
|
||||||
|
LONGDESC;
|
||||||
|
$object = new Description($fixture);
|
||||||
|
$this->assertSame($fixture, $object->getContents());
|
||||||
|
|
||||||
|
$parsedContents = $object->getParsedContents();
|
||||||
|
$this->assertCount(3, $parsedContents);
|
||||||
|
|
||||||
|
$this->assertSame('', $parsedContents[0]);
|
||||||
|
$this->assertInstanceOf(
|
||||||
|
__NAMESPACE__ . '\Tag\LinkTag',
|
||||||
|
$parsedContents[1]
|
||||||
|
);
|
||||||
|
$this->assertSame(
|
||||||
|
' is text for a description that uses inline
|
||||||
|
tags.',
|
||||||
|
$parsedContents[2]
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testNestedInlineTagParsing()
|
||||||
|
{
|
||||||
|
$fixture = <<<LONGDESC
|
||||||
|
This is text for a description with {@internal inline tag with
|
||||||
|
{@link http://phpdoc.org another inline tag} in it}.
|
||||||
|
LONGDESC;
|
||||||
|
$object = new Description($fixture);
|
||||||
|
$this->assertSame($fixture, $object->getContents());
|
||||||
|
|
||||||
|
$parsedContents = $object->getParsedContents();
|
||||||
|
$this->assertCount(3, $parsedContents);
|
||||||
|
|
||||||
|
$this->assertSame(
|
||||||
|
'This is text for a description with ',
|
||||||
|
$parsedContents[0]
|
||||||
|
);
|
||||||
|
$this->assertInstanceOf(
|
||||||
|
__NAMESPACE__ . '\Tag',
|
||||||
|
$parsedContents[1]
|
||||||
|
);
|
||||||
|
$this->assertSame('.', $parsedContents[2]);
|
||||||
|
|
||||||
|
$parsedDescription = $parsedContents[1]->getParsedDescription();
|
||||||
|
$this->assertCount(3, $parsedDescription);
|
||||||
|
$this->assertSame("inline tag with\n", $parsedDescription[0]);
|
||||||
|
$this->assertInstanceOf(
|
||||||
|
__NAMESPACE__ . '\Tag\LinkTag',
|
||||||
|
$parsedDescription[1]
|
||||||
|
);
|
||||||
|
$this->assertSame(' in it', $parsedDescription[2]);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testLiteralOpeningDelimiter()
|
||||||
|
{
|
||||||
|
$fixture = <<<LONGDESC
|
||||||
|
This is text for a description containing { that is literal.
|
||||||
|
LONGDESC;
|
||||||
|
$object = new Description($fixture);
|
||||||
|
$this->assertSame($fixture, $object->getContents());
|
||||||
|
|
||||||
|
$parsedContents = $object->getParsedContents();
|
||||||
|
$this->assertCount(1, $parsedContents);
|
||||||
|
$this->assertSame($fixture, $parsedContents[0]);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testNestedLiteralOpeningDelimiter()
|
||||||
|
{
|
||||||
|
$fixture = <<<LONGDESC
|
||||||
|
This is text for a description containing {@internal inline tag that has { that
|
||||||
|
is literal}.
|
||||||
|
LONGDESC;
|
||||||
|
$object = new Description($fixture);
|
||||||
|
$this->assertSame($fixture, $object->getContents());
|
||||||
|
|
||||||
|
$parsedContents = $object->getParsedContents();
|
||||||
|
$this->assertCount(3, $parsedContents);
|
||||||
|
$this->assertSame(
|
||||||
|
'This is text for a description containing ',
|
||||||
|
$parsedContents[0]
|
||||||
|
);
|
||||||
|
$this->assertInstanceOf(
|
||||||
|
__NAMESPACE__ . '\Tag',
|
||||||
|
$parsedContents[1]
|
||||||
|
);
|
||||||
|
$this->assertSame('.', $parsedContents[2]);
|
||||||
|
|
||||||
|
$this->assertSame(
|
||||||
|
array('inline tag that has { that
|
||||||
|
is literal'),
|
||||||
|
$parsedContents[1]->getParsedDescription()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testLiteralClosingDelimiter()
|
||||||
|
{
|
||||||
|
$fixture = <<<LONGDESC
|
||||||
|
This is text for a description with {} that is not a tag.
|
||||||
|
LONGDESC;
|
||||||
|
$object = new Description($fixture);
|
||||||
|
$this->assertSame($fixture, $object->getContents());
|
||||||
|
|
||||||
|
$parsedContents = $object->getParsedContents();
|
||||||
|
$this->assertCount(1, $parsedContents);
|
||||||
|
$this->assertSame(
|
||||||
|
'This is text for a description with } that is not a tag.',
|
||||||
|
$parsedContents[0]
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testNestedLiteralClosingDelimiter()
|
||||||
|
{
|
||||||
|
$fixture = <<<LONGDESC
|
||||||
|
This is text for a description with {@internal inline tag with {} that is not an
|
||||||
|
inline tag}.
|
||||||
|
LONGDESC;
|
||||||
|
$object = new Description($fixture);
|
||||||
|
$this->assertSame($fixture, $object->getContents());
|
||||||
|
|
||||||
|
$parsedContents = $object->getParsedContents();
|
||||||
|
$this->assertCount(3, $parsedContents);
|
||||||
|
$this->assertSame(
|
||||||
|
'This is text for a description with ',
|
||||||
|
$parsedContents[0]
|
||||||
|
);
|
||||||
|
$this->assertInstanceOf(
|
||||||
|
__NAMESPACE__ . '\Tag',
|
||||||
|
$parsedContents[1]
|
||||||
|
);
|
||||||
|
$this->assertSame('.', $parsedContents[2]);
|
||||||
|
|
||||||
|
$this->assertSame(
|
||||||
|
array('inline tag with } that is not an
|
||||||
|
inline tag'),
|
||||||
|
$parsedContents[1]->getParsedDescription()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testInlineTagEscapingSequence()
|
||||||
|
{
|
||||||
|
$fixture = <<<LONGDESC
|
||||||
|
This is text for a description with literal {{@}link}.
|
||||||
|
LONGDESC;
|
||||||
|
$object = new Description($fixture);
|
||||||
|
$this->assertSame($fixture, $object->getContents());
|
||||||
|
|
||||||
|
$parsedContents = $object->getParsedContents();
|
||||||
|
$this->assertCount(1, $parsedContents);
|
||||||
|
$this->assertSame(
|
||||||
|
'This is text for a description with literal {@link}.',
|
||||||
|
$parsedContents[0]
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testNestedInlineTagEscapingSequence()
|
||||||
|
{
|
||||||
|
$fixture = <<<LONGDESC
|
||||||
|
This is text for a description with an {@internal inline tag with literal
|
||||||
|
{{@}link{} in it}.
|
||||||
|
LONGDESC;
|
||||||
|
$object = new Description($fixture);
|
||||||
|
$this->assertSame($fixture, $object->getContents());
|
||||||
|
|
||||||
|
$parsedContents = $object->getParsedContents();
|
||||||
|
$this->assertCount(3, $parsedContents);
|
||||||
|
$this->assertSame(
|
||||||
|
'This is text for a description with an ',
|
||||||
|
$parsedContents[0]
|
||||||
|
);
|
||||||
|
$this->assertInstanceOf(
|
||||||
|
__NAMESPACE__ . '\Tag',
|
||||||
|
$parsedContents[1]
|
||||||
|
);
|
||||||
|
$this->assertSame('.', $parsedContents[2]);
|
||||||
|
|
||||||
|
$this->assertSame(
|
||||||
|
array('inline tag with literal
|
||||||
|
{@link} in it'),
|
||||||
|
$parsedContents[1]->getParsedDescription()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -2,54 +2,53 @@
|
|||||||
/**
|
/**
|
||||||
* phpDocumentor Covers Tag Test
|
* phpDocumentor Covers Tag Test
|
||||||
*
|
*
|
||||||
* @author Daniel O'Connor <[email protected]>
|
* PHP version 5.3
|
||||||
* @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
|
*
|
||||||
|
* @author Daniel O'Connor <[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\Tag;
|
namespace phpDocumentor\Reflection\DocBlock\Tag;
|
||||||
|
|
||||||
require_once __DIR__.'/../../../../../src/phpDocumentor/Reflection/DocBlock/Tag.php';
|
|
||||||
require_once __DIR__.'/../../../../../src/phpDocumentor/Reflection/DocBlock/Tag/SeeTag.php';
|
|
||||||
require_once __DIR__.'/../../../../../src/phpDocumentor/Reflection/DocBlock/Tag/CoversTag.php';
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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
|
||||||
* @param string $exName
|
|
||||||
* @param string $exContent
|
* @param string $exContent
|
||||||
* @param string $exReference
|
* @param string $exReference
|
||||||
*
|
*
|
||||||
* @covers \phpDocumentor\Reflection\DocBlock\Tag\Covers::__construct
|
* @covers \phpDocumentor\Reflection\DocBlock\Tag\CoversTag
|
||||||
* @dataProvider provideDataForConstuctor
|
* @dataProvider provideDataForConstuctor
|
||||||
*
|
*
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function testConstructorParesInputsIntoCorrectFields(
|
public function testConstructorParesInputsIntoCorrectFields(
|
||||||
$type, $content, $exName, $exContent, $exDescription, $exReference
|
$type,
|
||||||
)
|
$content,
|
||||||
{
|
$exContent,
|
||||||
|
$exDescription,
|
||||||
|
$exReference
|
||||||
|
) {
|
||||||
$tag = new CoversTag($type, $content);
|
$tag = new CoversTag($type, $content);
|
||||||
|
|
||||||
$actualName = $tag->getName();
|
$this->assertEquals($type, $tag->getName());
|
||||||
$actualContent = $tag->getContent();
|
$this->assertEquals($exContent, $tag->getContent());
|
||||||
$actualDescription = $tag->getDescription();
|
$this->assertEquals($exDescription, $tag->getDescription());
|
||||||
$actualReference = $tag->getReference();
|
$this->assertEquals($exReference, $tag->getReference());
|
||||||
|
|
||||||
$this->assertEquals($exName, $actualName);
|
|
||||||
$this->assertEquals($exContent, $actualContent);
|
|
||||||
$this->assertEquals($exDescription, $actualDescription);
|
|
||||||
$this->assertEquals($exReference, $actualReference);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -59,28 +58,25 @@ class CoversTagTest extends \PHPUnit_Framework_TestCase
|
|||||||
*/
|
*/
|
||||||
public function provideDataForConstuctor()
|
public function provideDataForConstuctor()
|
||||||
{
|
{
|
||||||
// $type, $content, $exName, $exContent, $exDescription, $exReference
|
// $type, $content, $exContent, $exDescription, $exReference
|
||||||
return array(
|
return array(
|
||||||
array(
|
array(
|
||||||
'uses',
|
'covers',
|
||||||
'Foo::bar()',
|
'Foo::bar()',
|
||||||
'uses',
|
|
||||||
'Foo::bar()',
|
'Foo::bar()',
|
||||||
'',
|
'',
|
||||||
'Foo::bar()'
|
'Foo::bar()'
|
||||||
),
|
),
|
||||||
array(
|
array(
|
||||||
'uses',
|
'covers',
|
||||||
'Foo::bar() Testing',
|
'Foo::bar() Testing',
|
||||||
'uses',
|
|
||||||
'Foo::bar() Testing',
|
'Foo::bar() Testing',
|
||||||
'Testing',
|
'Testing',
|
||||||
'Foo::bar()',
|
'Foo::bar()',
|
||||||
),
|
),
|
||||||
array(
|
array(
|
||||||
'uses',
|
'covers',
|
||||||
'Foo::bar() Testing comments',
|
'Foo::bar() Testing comments',
|
||||||
'uses',
|
|
||||||
'Foo::bar() Testing comments',
|
'Foo::bar() Testing comments',
|
||||||
'Testing comments',
|
'Testing comments',
|
||||||
'Foo::bar()',
|
'Foo::bar()',
|
||||||
|
|||||||
@@ -0,0 +1,115 @@
|
|||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* phpDocumentor Deprecated Tag Test
|
||||||
|
*
|
||||||
|
* PHP version 5.3
|
||||||
|
*
|
||||||
|
* @author Vasil Rangelov <[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\Tag;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Test class for \phpDocumentor\Reflection\DocBlock\Tag\DeprecatedTag
|
||||||
|
*
|
||||||
|
* @author Vasil Rangelov <[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 DeprecatedTagTest extends \PHPUnit_Framework_TestCase
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Test that the \phpDocumentor\Reflection\DocBlock\Tag\LinkTag can create
|
||||||
|
* a link for the @deprecated doc block.
|
||||||
|
*
|
||||||
|
* @param string $type
|
||||||
|
* @param string $content
|
||||||
|
* @param string $exContent
|
||||||
|
* @param string $exDescription
|
||||||
|
* @param string $exVersion
|
||||||
|
*
|
||||||
|
* @covers \phpDocumentor\Reflection\DocBlock\Tag\DeprecatedTag
|
||||||
|
* @dataProvider provideDataForConstuctor
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testConstructorParesInputsIntoCorrectFields(
|
||||||
|
$type,
|
||||||
|
$content,
|
||||||
|
$exContent,
|
||||||
|
$exDescription,
|
||||||
|
$exVersion
|
||||||
|
) {
|
||||||
|
$tag = new DeprecatedTag($type, $content);
|
||||||
|
|
||||||
|
$this->assertEquals($type, $tag->getName());
|
||||||
|
$this->assertEquals($exContent, $tag->getContent());
|
||||||
|
$this->assertEquals($exDescription, $tag->getDescription());
|
||||||
|
$this->assertEquals($exVersion, $tag->getVersion());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Data provider for testConstructorParesInputsIntoCorrectFields
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
public function provideDataForConstuctor()
|
||||||
|
{
|
||||||
|
// $type, $content, $exContent, $exDescription, $exVersion
|
||||||
|
return array(
|
||||||
|
array(
|
||||||
|
'deprecated',
|
||||||
|
'1.0 First release.',
|
||||||
|
'1.0 First release.',
|
||||||
|
'First release.',
|
||||||
|
'1.0'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'deprecated',
|
||||||
|
"1.0\nFirst release.",
|
||||||
|
"1.0\nFirst release.",
|
||||||
|
'First release.',
|
||||||
|
'1.0'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'deprecated',
|
||||||
|
"1.0\nFirst\nrelease.",
|
||||||
|
"1.0\nFirst\nrelease.",
|
||||||
|
"First\nrelease.",
|
||||||
|
'1.0'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'deprecated',
|
||||||
|
'Unfinished release',
|
||||||
|
'Unfinished release',
|
||||||
|
'Unfinished release',
|
||||||
|
''
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'deprecated',
|
||||||
|
'1.0',
|
||||||
|
'1.0',
|
||||||
|
'',
|
||||||
|
'1.0'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'deprecated',
|
||||||
|
'GIT: $Id$',
|
||||||
|
'GIT: $Id$',
|
||||||
|
'',
|
||||||
|
'GIT: $Id$'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'deprecated',
|
||||||
|
'GIT: $Id$ Dev build',
|
||||||
|
'GIT: $Id$ Dev build',
|
||||||
|
'Dev build',
|
||||||
|
'GIT: $Id$'
|
||||||
|
)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,203 @@
|
|||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* phpDocumentor Example Tag Test
|
||||||
|
*
|
||||||
|
* PHP version 5.3
|
||||||
|
*
|
||||||
|
* @author Vasil Rangelov <[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\Tag;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Test class for \phpDocumentor\Reflection\DocBlock\Tag\ExampleTag
|
||||||
|
*
|
||||||
|
* @author Vasil Rangelov <[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 ExampleTagTest extends \PHPUnit_Framework_TestCase
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Test that the \phpDocumentor\Reflection\DocBlock\Tag\SourceTag can
|
||||||
|
* understand the @source DocBlock.
|
||||||
|
*
|
||||||
|
* @param string $type
|
||||||
|
* @param string $content
|
||||||
|
* @param string $exContent
|
||||||
|
* @param string $exStartingLine
|
||||||
|
* @param string $exLineCount
|
||||||
|
* @param string $exFilepath
|
||||||
|
*
|
||||||
|
* @covers \phpDocumentor\Reflection\DocBlock\Tag\ExampleTag
|
||||||
|
* @dataProvider provideDataForConstuctor
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testConstructorParesInputsIntoCorrectFields(
|
||||||
|
$type,
|
||||||
|
$content,
|
||||||
|
$exContent,
|
||||||
|
$exDescription,
|
||||||
|
$exStartingLine,
|
||||||
|
$exLineCount,
|
||||||
|
$exFilePath
|
||||||
|
) {
|
||||||
|
$tag = new ExampleTag($type, $content);
|
||||||
|
|
||||||
|
$this->assertEquals($type, $tag->getName());
|
||||||
|
$this->assertEquals($exContent, $tag->getContent());
|
||||||
|
$this->assertEquals($exDescription, $tag->getDescription());
|
||||||
|
$this->assertEquals($exStartingLine, $tag->getStartingLine());
|
||||||
|
$this->assertEquals($exLineCount, $tag->getLineCount());
|
||||||
|
$this->assertEquals($exFilePath, $tag->getFilePath());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Data provider for testConstructorParesInputsIntoCorrectFields
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
public function provideDataForConstuctor()
|
||||||
|
{
|
||||||
|
// $type,
|
||||||
|
// $content,
|
||||||
|
// $exContent,
|
||||||
|
// $exDescription,
|
||||||
|
// $exStartingLine,
|
||||||
|
// $exLineCount,
|
||||||
|
// $exFilePath
|
||||||
|
return array(
|
||||||
|
array(
|
||||||
|
'example',
|
||||||
|
'file.php',
|
||||||
|
'file.php',
|
||||||
|
'',
|
||||||
|
1,
|
||||||
|
null,
|
||||||
|
'file.php'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'example',
|
||||||
|
'Testing comments',
|
||||||
|
'Testing comments',
|
||||||
|
'comments',
|
||||||
|
1,
|
||||||
|
null,
|
||||||
|
'Testing'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'example',
|
||||||
|
'file.php 2 Testing',
|
||||||
|
'file.php 2 Testing',
|
||||||
|
'Testing',
|
||||||
|
2,
|
||||||
|
null,
|
||||||
|
'file.php'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'example',
|
||||||
|
'file.php 2 3 Testing comments',
|
||||||
|
'file.php 2 3 Testing comments',
|
||||||
|
'Testing comments',
|
||||||
|
2,
|
||||||
|
3,
|
||||||
|
'file.php'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'example',
|
||||||
|
'file.php 2 -1 Testing comments',
|
||||||
|
'file.php 2 -1 Testing comments',
|
||||||
|
'-1 Testing comments',
|
||||||
|
2,
|
||||||
|
null,
|
||||||
|
'file.php'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'example',
|
||||||
|
'file.php -1 1 Testing comments',
|
||||||
|
'file.php -1 1 Testing comments',
|
||||||
|
'-1 1 Testing comments',
|
||||||
|
1,
|
||||||
|
null,
|
||||||
|
'file.php'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'example',
|
||||||
|
'"file with spaces.php" Testing comments',
|
||||||
|
'"file with spaces.php" Testing comments',
|
||||||
|
'Testing comments',
|
||||||
|
1,
|
||||||
|
null,
|
||||||
|
'file with spaces.php'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'example',
|
||||||
|
'"file with spaces.php" 2 Testing comments',
|
||||||
|
'"file with spaces.php" 2 Testing comments',
|
||||||
|
'Testing comments',
|
||||||
|
2,
|
||||||
|
null,
|
||||||
|
'file with spaces.php'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'example',
|
||||||
|
'"file with spaces.php" 2 3 Testing comments',
|
||||||
|
'"file with spaces.php" 2 3 Testing comments',
|
||||||
|
'Testing comments',
|
||||||
|
2,
|
||||||
|
3,
|
||||||
|
'file with spaces.php'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'example',
|
||||||
|
'"file with spaces.php" 2 -3 Testing comments',
|
||||||
|
'"file with spaces.php" 2 -3 Testing comments',
|
||||||
|
'-3 Testing comments',
|
||||||
|
2,
|
||||||
|
null,
|
||||||
|
'file with spaces.php'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'example',
|
||||||
|
'"file with spaces.php" -2 3 Testing comments',
|
||||||
|
'"file with spaces.php" -2 3 Testing comments',
|
||||||
|
'-2 3 Testing comments',
|
||||||
|
1,
|
||||||
|
null,
|
||||||
|
'file with spaces.php'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'example',
|
||||||
|
'file%20with%20spaces.php Testing comments',
|
||||||
|
'file%20with%20spaces.php Testing comments',
|
||||||
|
'Testing comments',
|
||||||
|
1,
|
||||||
|
null,
|
||||||
|
'file with spaces.php'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'example',
|
||||||
|
'folder/file%20with%20spaces.php Testing comments',
|
||||||
|
'folder/file%20with%20spaces.php Testing comments',
|
||||||
|
'Testing comments',
|
||||||
|
1,
|
||||||
|
null,
|
||||||
|
'folder/file with spaces.php'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'example',
|
||||||
|
'http://example.com/file%20with%20spaces.php Testing comments',
|
||||||
|
'http://example.com/file%20with%20spaces.php Testing comments',
|
||||||
|
'Testing comments',
|
||||||
|
1,
|
||||||
|
null,
|
||||||
|
'http://example.com/file%20with%20spaces.php'
|
||||||
|
)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -2,53 +2,54 @@
|
|||||||
/**
|
/**
|
||||||
* phpDocumentor Link Tag Test
|
* phpDocumentor Link Tag Test
|
||||||
*
|
*
|
||||||
* @author Ben Selby <[email protected]>
|
* PHP version 5.3
|
||||||
* @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
|
*
|
||||||
|
* @author Ben Selby <[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\Tag;
|
namespace phpDocumentor\Reflection\DocBlock\Tag;
|
||||||
|
|
||||||
require_once __DIR__ . '/../../../../../src/phpDocumentor/Reflection/DocBlock/Tag/LinkTag.php';
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* Test that the \phpDocumentor\Reflection\DocBlock\Tag\LinkTag can create
|
* Test that the \phpDocumentor\Reflection\DocBlock\Tag\LinkTag can create
|
||||||
* a link for the @link doc block
|
* a link for the @link doc block.
|
||||||
*
|
*
|
||||||
* @param string $type
|
* @param string $type
|
||||||
* @param string $content
|
* @param string $content
|
||||||
* @param string $exName
|
|
||||||
* @param string $exContent
|
* @param string $exContent
|
||||||
* @param string $exDescription
|
* @param string $exDescription
|
||||||
* @param string $exLink
|
* @param string $exLink
|
||||||
*
|
*
|
||||||
* @covers \phpDocumentor\Reflection\DocBlock\Tag\LinkTag::__construct
|
* @covers \phpDocumentor\Reflection\DocBlock\Tag\LinkTag
|
||||||
* @dataProvider provideDataForConstuctor
|
* @dataProvider provideDataForConstuctor
|
||||||
*
|
*
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function testConstructorParesInputsIntoCorrectFields(
|
public function testConstructorParesInputsIntoCorrectFields(
|
||||||
$type, $content, $exName, $exContent, $exDescription, $exLink
|
$type,
|
||||||
)
|
$content,
|
||||||
{
|
$exContent,
|
||||||
|
$exDescription,
|
||||||
|
$exLink
|
||||||
|
) {
|
||||||
$tag = new LinkTag($type, $content);
|
$tag = new LinkTag($type, $content);
|
||||||
|
|
||||||
$actualName = $tag->getName();
|
$this->assertEquals($type, $tag->getName());
|
||||||
$actualContent = $tag->getContent();
|
$this->assertEquals($exContent, $tag->getContent());
|
||||||
$actualDescription = $tag->getDescription();
|
$this->assertEquals($exDescription, $tag->getDescription());
|
||||||
$actualLink = $tag->getLink();
|
$this->assertEquals($exLink, $tag->getLink());
|
||||||
|
|
||||||
$this->assertEquals($exName, $actualName);
|
|
||||||
$this->assertEquals($exContent, $actualContent);
|
|
||||||
$this->assertEquals($exDescription, $actualDescription);
|
|
||||||
$this->assertEquals($exLink, $actualLink);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -58,12 +59,11 @@ class LinkTagTest extends \PHPUnit_Framework_TestCase
|
|||||||
*/
|
*/
|
||||||
public function provideDataForConstuctor()
|
public function provideDataForConstuctor()
|
||||||
{
|
{
|
||||||
// $type, $content, $exName, $exContent, $exDescription, $exLink
|
// $type, $content, $exContent, $exDescription, $exLink
|
||||||
return array(
|
return array(
|
||||||
array(
|
array(
|
||||||
'link',
|
'link',
|
||||||
'http://www.phpdoc.org/',
|
'http://www.phpdoc.org/',
|
||||||
'link',
|
|
||||||
'http://www.phpdoc.org/',
|
'http://www.phpdoc.org/',
|
||||||
'http://www.phpdoc.org/',
|
'http://www.phpdoc.org/',
|
||||||
'http://www.phpdoc.org/'
|
'http://www.phpdoc.org/'
|
||||||
@@ -71,7 +71,6 @@ class LinkTagTest extends \PHPUnit_Framework_TestCase
|
|||||||
array(
|
array(
|
||||||
'link',
|
'link',
|
||||||
'http://www.phpdoc.org/ Testing',
|
'http://www.phpdoc.org/ Testing',
|
||||||
'link',
|
|
||||||
'http://www.phpdoc.org/ Testing',
|
'http://www.phpdoc.org/ Testing',
|
||||||
'Testing',
|
'Testing',
|
||||||
'http://www.phpdoc.org/'
|
'http://www.phpdoc.org/'
|
||||||
@@ -79,7 +78,6 @@ class LinkTagTest extends \PHPUnit_Framework_TestCase
|
|||||||
array(
|
array(
|
||||||
'link',
|
'link',
|
||||||
'http://www.phpdoc.org/ Testing comments',
|
'http://www.phpdoc.org/ Testing comments',
|
||||||
'link',
|
|
||||||
'http://www.phpdoc.org/ Testing comments',
|
'http://www.phpdoc.org/ Testing comments',
|
||||||
'Testing comments',
|
'Testing comments',
|
||||||
'http://www.phpdoc.org/'
|
'http://www.phpdoc.org/'
|
||||||
|
|||||||
@@ -2,117 +2,145 @@
|
|||||||
/**
|
/**
|
||||||
* phpDocumentor Method Tag Test
|
* phpDocumentor Method Tag Test
|
||||||
*
|
*
|
||||||
* @author Mike van Riel <[email protected]>
|
* PHP version 5.3
|
||||||
* @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
|
*
|
||||||
|
* @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\Tag;
|
namespace phpDocumentor\Reflection\DocBlock\Tag;
|
||||||
|
|
||||||
require_once __DIR__ . '/../../../../../src/phpDocumentor/Reflection/DocBlock/Tag/ParamTag.php';
|
|
||||||
require_once __DIR__ . '/../../../../../src/phpDocumentor/Reflection/DocBlock/Tag/MethodTag.php';
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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.
|
||||||
* @param string $expected_name The method name that is expected from this
|
* @param string $expected_name The method name that is expected from this
|
||||||
* signature
|
* signature.
|
||||||
* @param string $expected_return The return type that is expected from this
|
* @param string $expected_return The return type that is expected from this
|
||||||
* signature
|
* signature.
|
||||||
* @param bool $has_params whether this signature features parameters.
|
* @param bool $paramCount Number of parameters in the signature.
|
||||||
* @param string $description The short description mentioned in the
|
* @param string $description The short description mentioned in the
|
||||||
* signature.
|
* signature.
|
||||||
*
|
*
|
||||||
|
* @covers \phpDocumentor\Reflection\DocBlock\Tag\MethodTag
|
||||||
|
* @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,
|
||||||
|
$expected_isStatic,
|
||||||
|
$paramCount,
|
||||||
|
$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->assertEquals($expected_isStatic, $tag->isStatic());
|
||||||
$has_params, (bool)(count($tag->getArguments()) > 0),
|
$this->assertCount($paramCount, $tag->getArguments());
|
||||||
'Number of found arguments should exceed 0'
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
public function getTestSignatures()
|
public function getTestSignatures()
|
||||||
{
|
{
|
||||||
return array(
|
return array(
|
||||||
array(
|
// TODO: Verify this case
|
||||||
'foo',
|
// array(
|
||||||
false, 'foo', '', false, ''
|
// 'foo',
|
||||||
),
|
// false, 'foo', '', false, 0, ''
|
||||||
|
// ),
|
||||||
array(
|
array(
|
||||||
'foo()',
|
'foo()',
|
||||||
true, 'foo', 'void', false, ''
|
true, 'foo', 'void', false, 0, ''
|
||||||
),
|
),
|
||||||
array(
|
array(
|
||||||
'foo() description',
|
'foo() description',
|
||||||
true, 'foo', 'void', false, 'description'
|
true, 'foo', 'void', false, 0, 'description'
|
||||||
),
|
),
|
||||||
array(
|
array(
|
||||||
'int foo()',
|
'int foo()',
|
||||||
true, 'foo', 'int', false, ''
|
true, 'foo', 'int', false, 0, ''
|
||||||
),
|
),
|
||||||
array(
|
array(
|
||||||
'int foo() description',
|
'int foo() description',
|
||||||
true, 'foo', 'int', false, 'description'
|
true, 'foo', 'int', false, 0, 'description'
|
||||||
),
|
),
|
||||||
array(
|
array(
|
||||||
'int foo($a, $b)',
|
'int foo($a, $b)',
|
||||||
true, 'foo', 'int', true, ''
|
true, 'foo', 'int', false, 2, ''
|
||||||
),
|
),
|
||||||
array(
|
array(
|
||||||
'int foo() foo(int $a, int $b)',
|
'int foo() foo(int $a, int $b)',
|
||||||
true, 'foo', 'int', true, ''
|
true, 'foo', 'int', false, 2, ''
|
||||||
),
|
),
|
||||||
array(
|
array(
|
||||||
'int foo(int $a, int $b)',
|
'int foo(int $a, int $b)',
|
||||||
true, 'foo', 'int', true, ''
|
true, 'foo', 'int', false, 2, ''
|
||||||
),
|
),
|
||||||
array(
|
array(
|
||||||
'null|int foo(int $a, int $b)',
|
'null|int foo(int $a, int $b)',
|
||||||
true, 'foo', 'null|int', true, ''
|
true, 'foo', 'null|int', false, 2, ''
|
||||||
),
|
),
|
||||||
array(
|
array(
|
||||||
'int foo(null|int $a, int $b)',
|
'int foo(null|int $a, int $b)',
|
||||||
true, 'foo', 'int', true, ''
|
true, 'foo', 'int', false, 2, ''
|
||||||
),
|
),
|
||||||
array(
|
array(
|
||||||
'\Exception foo() foo(Exception $a, Exception $b)',
|
'\Exception foo() foo(Exception $a, Exception $b)',
|
||||||
true, 'foo', '\Exception', true, ''
|
true, 'foo', '\Exception', false, 2, ''
|
||||||
),
|
),
|
||||||
array(
|
array(
|
||||||
'int foo() foo(Exception $a, Exception $b) description',
|
'int foo() foo(Exception $a, Exception $b) description',
|
||||||
true, 'foo', 'int', true, 'description'
|
true, 'foo', 'int', false, 2, 'description'
|
||||||
),
|
),
|
||||||
array(
|
array(
|
||||||
'int foo() foo(\Exception $a, \Exception $b) description',
|
'int foo() foo(\Exception $a, \Exception $b) description',
|
||||||
true, 'foo', 'int', true, 'description'
|
true, 'foo', 'int', false, 2, 'description'
|
||||||
),
|
),
|
||||||
|
array(
|
||||||
|
'void()',
|
||||||
|
true, 'void', 'void', false, 0, ''
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'static foo()',
|
||||||
|
true, 'foo', 'static', false, 0, ''
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'static void foo()',
|
||||||
|
true, 'foo', 'void', true, 0, ''
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'static static foo()',
|
||||||
|
true, 'foo', 'static', true, 0, ''
|
||||||
|
)
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -2,68 +2,57 @@
|
|||||||
/**
|
/**
|
||||||
* 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;
|
||||||
|
|
||||||
require_once __DIR__ . '/../../../../../src/phpDocumentor/Reflection/DocBlock/Tag/ParamTag.php';
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* Test that the \phpDocumentor\Reflection\DocBlock\Tag\ParamTag can
|
* Test that the \phpDocumentor\Reflection\DocBlock\Tag\ParamTag can
|
||||||
* understand the param DocBlock.
|
* understand the @param DocBlock.
|
||||||
*
|
*
|
||||||
* @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 $extractedTypes
|
||||||
* @param string $extracted_description
|
* @param string $extractedVarName
|
||||||
*
|
* @param string $extractedDescription
|
||||||
* @covers \phpDocumentor\Reflection\DocBlock\Tag\ParamTag::__construct
|
|
||||||
*
|
*
|
||||||
|
* @covers \phpDocumentor\Reflection\DocBlock\Tag\ParamTag
|
||||||
* @dataProvider provideDataForConstructor
|
* @dataProvider provideDataForConstructor
|
||||||
*
|
*
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function testConstructorParsesInputsIntoCorrectFields(
|
public function testConstructorParsesInputsIntoCorrectFields(
|
||||||
$type, $content, $extracted_type, $extracted_variable_name,
|
$type,
|
||||||
$extracted_description
|
$content,
|
||||||
|
$extractedType,
|
||||||
|
$extractedTypes,
|
||||||
|
$extractedVarName,
|
||||||
|
$extractedDescription
|
||||||
) {
|
) {
|
||||||
$tag = new ParamTag($type, $content);
|
$tag = new ParamTag($type, $content);
|
||||||
|
|
||||||
$this->assertEquals($extracted_type, $tag->getTypes());
|
$this->assertEquals($type, $tag->getName());
|
||||||
$this->assertEquals($extracted_variable_name, $tag->getVariableName());
|
$this->assertEquals($extractedType, $tag->getType());
|
||||||
$this->assertEquals($extracted_description, $tag->getDescription());
|
$this->assertEquals($extractedTypes, $tag->getTypes());
|
||||||
}
|
$this->assertEquals($extractedVarName, $tag->getVariableName());
|
||||||
|
$this->assertEquals($extractedDescription, $tag->getDescription());
|
||||||
/**
|
|
||||||
* Tests whether the getTypes method correctly converts the given tags.
|
|
||||||
*
|
|
||||||
* @param string $type Type string to test
|
|
||||||
* @param string[] $expected Array of expected types
|
|
||||||
*
|
|
||||||
* @covers \phpDocumentor\Reflection\DocBlock\Tag\ParamTag::getTypes()
|
|
||||||
*
|
|
||||||
* @dataProvider provideTypesToExpand
|
|
||||||
*/
|
|
||||||
public function testExpandTypeIntoCorrectFcqn($type, $expected)
|
|
||||||
{
|
|
||||||
$docblock = new \phpDocumentor\Reflection\DocBlock(
|
|
||||||
'', '\My\Namespace', array('Alias' => '\My\Namespace\Aliasing')
|
|
||||||
);
|
|
||||||
|
|
||||||
$tag = new ParamTag('param', $type.' $my_type');
|
|
||||||
$tag->setDocBlock($docblock);
|
|
||||||
$this->assertEquals($expected, $tag->getTypes());
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -74,45 +63,56 @@ class ParamTagTest extends \PHPUnit_Framework_TestCase
|
|||||||
public function provideDataForConstructor()
|
public function provideDataForConstructor()
|
||||||
{
|
{
|
||||||
return array(
|
return array(
|
||||||
array('param', 'int', array(''), '', 'int'),
|
array('param', 'int', 'int', array('int'), '', ''),
|
||||||
array('param', '$bob', array(''), '$bob', ''),
|
array('param', '$bob', '', array(), '$bob', ''),
|
||||||
array(
|
array(
|
||||||
'param', 'int Number of bobs', array('int'), '',
|
'param',
|
||||||
|
'int Number of bobs',
|
||||||
|
'int',
|
||||||
|
array('int'),
|
||||||
|
'',
|
||||||
'Number of bobs'
|
'Number of bobs'
|
||||||
),
|
),
|
||||||
array('param', 'int $bob', array('int'), '$bob', ''),
|
|
||||||
array(
|
array(
|
||||||
'param', 'int $bob Number of bobs', array('int'), '$bob',
|
'param',
|
||||||
|
'int $bob',
|
||||||
|
'int',
|
||||||
|
array('int'),
|
||||||
|
'$bob',
|
||||||
|
''
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'param',
|
||||||
|
'int $bob Number of bobs',
|
||||||
|
'int',
|
||||||
|
array('int'),
|
||||||
|
'$bob',
|
||||||
'Number of bobs'
|
'Number of bobs'
|
||||||
),
|
),
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the types and their expected values to test the retrieval of
|
|
||||||
* types.
|
|
||||||
*
|
|
||||||
* @return string[]
|
|
||||||
*/
|
|
||||||
public function provideTypesToExpand()
|
|
||||||
{
|
|
||||||
return array(
|
|
||||||
array('', array('')),
|
|
||||||
array(' ', array('')),
|
|
||||||
array('int', array('int')),
|
|
||||||
array('int ', array('int')),
|
|
||||||
array('string', array('string')),
|
|
||||||
array('DocBlock', array('\My\Namespace\DocBlock')),
|
|
||||||
// array(' DocBlock ', array('\My\Namespace\DocBlock')), FIXME
|
|
||||||
array('Alias\DocBlock', array('\My\Namespace\Aliasing\DocBlock')),
|
|
||||||
array(
|
array(
|
||||||
'DocBlock|Tag',
|
'param',
|
||||||
array('\My\Namespace\DocBlock', '\My\Namespace\Tag')
|
"int Description \n on multiple lines",
|
||||||
|
'int',
|
||||||
|
array('int'),
|
||||||
|
'',
|
||||||
|
"Description \n on multiple lines"
|
||||||
),
|
),
|
||||||
array(
|
array(
|
||||||
'DocBlock|null',
|
'param',
|
||||||
array('\My\Namespace\DocBlock', 'null')
|
"int \n\$bob Variable name on a new line",
|
||||||
|
'int',
|
||||||
|
array('int'),
|
||||||
|
'$bob',
|
||||||
|
"Variable name on a new line"
|
||||||
),
|
),
|
||||||
|
array(
|
||||||
|
'param',
|
||||||
|
"\nint \$bob Type on a new line",
|
||||||
|
'int',
|
||||||
|
array('int'),
|
||||||
|
'$bob',
|
||||||
|
"Type on a new line"
|
||||||
|
)
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,67 +2,54 @@
|
|||||||
/**
|
/**
|
||||||
* 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;
|
||||||
|
|
||||||
require_once __DIR__
|
|
||||||
. '/../../../../../src/phpDocumentor/Reflection/DocBlock/Tag/ReturnTag.php';
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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 \PHPUnit_Framework_TestCase
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* Test that the \phpDocumentor\Reflection\DocBlock\Tag\ReturnTag can
|
* Test that the \phpDocumentor\Reflection\DocBlock\Tag\ReturnTag can
|
||||||
* understand the Return DocBlock.
|
* understand the @return DocBlock.
|
||||||
*
|
*
|
||||||
|
* @param string $type
|
||||||
* @param string $content
|
* @param string $content
|
||||||
* @param string $extracted_type
|
* @param string $extractedType
|
||||||
* @param string $extracted_description
|
* @param string $extractedTypes
|
||||||
*
|
* @param string $extractedDescription
|
||||||
* @covers \phpDocumentor\Reflection\DocBlock\Tag\ReturnTag::__construct
|
|
||||||
*
|
*
|
||||||
|
* @covers \phpDocumentor\Reflection\DocBlock\Tag\ReturnTag
|
||||||
* @dataProvider provideDataForConstructor
|
* @dataProvider provideDataForConstructor
|
||||||
*
|
*
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function testConstructorParsesInputsIntoCorrectFields(
|
public function testConstructorParsesInputsIntoCorrectFields(
|
||||||
$content, $extracted_type, $extracted_description
|
$type,
|
||||||
|
$content,
|
||||||
|
$extractedType,
|
||||||
|
$extractedTypes,
|
||||||
|
$extractedDescription
|
||||||
) {
|
) {
|
||||||
$tag = new ReturnTag('return', $content);
|
$tag = new ReturnTag($type, $content);
|
||||||
|
|
||||||
$this->assertEquals($extracted_type, $tag->getTypes());
|
$this->assertEquals($type, $tag->getName());
|
||||||
$this->assertEquals($extracted_description, $tag->getDescription());
|
$this->assertEquals($extractedType, $tag->getType());
|
||||||
}
|
$this->assertEquals($extractedTypes, $tag->getTypes());
|
||||||
|
$this->assertEquals($extractedDescription, $tag->getDescription());
|
||||||
/**
|
|
||||||
* Tests whether the getTypes method correctly converts the given tags.
|
|
||||||
*
|
|
||||||
* @param string $type Type string to test
|
|
||||||
* @param string[] $expected Array of expected types
|
|
||||||
*
|
|
||||||
* @covers \phpDocumentor\Reflection\DocBlock\Tag\ReturnTag::getTypes()
|
|
||||||
*
|
|
||||||
* @dataProvider provideTypesToExpand
|
|
||||||
*
|
|
||||||
* @return void
|
|
||||||
*/
|
|
||||||
public function testExpandTypeIntoCorrectFcqn($type, $expected)
|
|
||||||
{
|
|
||||||
$docblock = new \phpDocumentor\Reflection\DocBlock(
|
|
||||||
'', '\My\Namespace', array('Alias' => '\My\Namespace\Aliasing')
|
|
||||||
);
|
|
||||||
|
|
||||||
$tag = new ReturnTag('return', $type);
|
|
||||||
$tag->setDocBlock($docblock);
|
|
||||||
$this->assertEquals($expected, $tag->getTypes());
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -73,9 +60,43 @@ class ReturnTagTest extends ParamTagTest
|
|||||||
public function provideDataForConstructor()
|
public function provideDataForConstructor()
|
||||||
{
|
{
|
||||||
return array(
|
return array(
|
||||||
array('', array(''), ''),
|
array('return', '', '', array(), ''),
|
||||||
array('int', array('int'), ''),
|
array('return', 'int', 'int', array('int'), ''),
|
||||||
array('int Number of Bobs', array('int'), 'Number of Bobs'),
|
array(
|
||||||
|
'return',
|
||||||
|
'int Number of Bobs',
|
||||||
|
'int',
|
||||||
|
array('int'),
|
||||||
|
'Number of Bobs'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'return',
|
||||||
|
'int|double Number of Bobs',
|
||||||
|
'int|double',
|
||||||
|
array('int', 'double'),
|
||||||
|
'Number of Bobs'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'return',
|
||||||
|
"int Number of \n Bobs",
|
||||||
|
'int',
|
||||||
|
array('int'),
|
||||||
|
"Number of \n Bobs"
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'return',
|
||||||
|
" int Number of Bobs",
|
||||||
|
'int',
|
||||||
|
array('int'),
|
||||||
|
"Number of Bobs"
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'return',
|
||||||
|
"int\nNumber of Bobs",
|
||||||
|
'int',
|
||||||
|
array('int'),
|
||||||
|
"Number of Bobs"
|
||||||
|
)
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,52 +2,53 @@
|
|||||||
/**
|
/**
|
||||||
* phpDocumentor See Tag Test
|
* phpDocumentor See Tag Test
|
||||||
*
|
*
|
||||||
* @author Daniel O'Connor <[email protected]>
|
* PHP version 5.3
|
||||||
* @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
|
*
|
||||||
|
* @author Daniel O'Connor <[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\Tag;
|
namespace phpDocumentor\Reflection\DocBlock\Tag;
|
||||||
|
|
||||||
require_once __DIR__ . '/../../../../../src/phpDocumentor/Reflection/DocBlock/Tag/SeeTag.php';
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* Test that the phpDocumentor_Reflection_DocBlock_Tag_See can create a link
|
* Test that the phpDocumentor_Reflection_DocBlock_Tag_See can create a link
|
||||||
* for the @see doc block
|
* for the @see doc block.
|
||||||
*
|
*
|
||||||
* @param string $type
|
* @param string $type
|
||||||
* @param string $content
|
* @param string $content
|
||||||
* @param string $exName
|
|
||||||
* @param string $exContent
|
* @param string $exContent
|
||||||
* @param string $exReference
|
* @param string $exReference
|
||||||
*
|
*
|
||||||
* @covers \phpDocumentor\Reflection\DocBlock\Tag\SeeTag::__construct
|
* @covers \phpDocumentor\Reflection\DocBlock\Tag\SeeTag
|
||||||
* @dataProvider provideDataForConstuctor
|
* @dataProvider provideDataForConstuctor
|
||||||
*
|
*
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function testConstructorParesInputsIntoCorrectFields(
|
public function testConstructorParesInputsIntoCorrectFields(
|
||||||
$type, $content, $exName, $exContent, $exDescription, $exReference
|
$type,
|
||||||
)
|
$content,
|
||||||
{
|
$exContent,
|
||||||
|
$exDescription,
|
||||||
|
$exReference
|
||||||
|
) {
|
||||||
$tag = new SeeTag($type, $content);
|
$tag = new SeeTag($type, $content);
|
||||||
|
|
||||||
$actualName = $tag->getName();
|
$this->assertEquals($type, $tag->getName());
|
||||||
$actualContent = $tag->getContent();
|
$this->assertEquals($exContent, $tag->getContent());
|
||||||
$actualDescription = $tag->getDescription();
|
$this->assertEquals($exDescription, $tag->getDescription());
|
||||||
$actualReference = $tag->getReference();
|
$this->assertEquals($exReference, $tag->getReference());
|
||||||
|
|
||||||
$this->assertEquals($exName, $actualName);
|
|
||||||
$this->assertEquals($exContent, $actualContent);
|
|
||||||
$this->assertEquals($exDescription, $actualDescription);
|
|
||||||
$this->assertEquals($exReference, $actualReference);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -57,28 +58,25 @@ class SeeTagTest extends \PHPUnit_Framework_TestCase
|
|||||||
*/
|
*/
|
||||||
public function provideDataForConstuctor()
|
public function provideDataForConstuctor()
|
||||||
{
|
{
|
||||||
// $type, $content, $exName, $exContent, $exDescription, $exReference
|
// $type, $content, $exContent, $exDescription, $exReference
|
||||||
return array(
|
return array(
|
||||||
array(
|
array(
|
||||||
'uses',
|
'see',
|
||||||
'Foo::bar()',
|
'Foo::bar()',
|
||||||
'uses',
|
|
||||||
'Foo::bar()',
|
'Foo::bar()',
|
||||||
'',
|
'',
|
||||||
'Foo::bar()'
|
'Foo::bar()'
|
||||||
),
|
),
|
||||||
array(
|
array(
|
||||||
'uses',
|
'see',
|
||||||
'Foo::bar() Testing',
|
'Foo::bar() Testing',
|
||||||
'uses',
|
|
||||||
'Foo::bar() Testing',
|
'Foo::bar() Testing',
|
||||||
'Testing',
|
'Testing',
|
||||||
'Foo::bar()',
|
'Foo::bar()',
|
||||||
),
|
),
|
||||||
array(
|
array(
|
||||||
'uses',
|
'see',
|
||||||
'Foo::bar() Testing comments',
|
'Foo::bar() Testing comments',
|
||||||
'uses',
|
|
||||||
'Foo::bar() Testing comments',
|
'Foo::bar() Testing comments',
|
||||||
'Testing comments',
|
'Testing comments',
|
||||||
'Foo::bar()',
|
'Foo::bar()',
|
||||||
|
|||||||
@@ -0,0 +1,115 @@
|
|||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* phpDocumentor Since Tag Test
|
||||||
|
*
|
||||||
|
* PHP version 5.3
|
||||||
|
*
|
||||||
|
* @author Vasil Rangelov <[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\Tag;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Test class for \phpDocumentor\Reflection\DocBlock\Tag\SinceTag
|
||||||
|
*
|
||||||
|
* @author Vasil Rangelov <[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 SinceTagTest extends \PHPUnit_Framework_TestCase
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Test that the \phpDocumentor\Reflection\DocBlock\Tag\LinkTag can create
|
||||||
|
* a link for the @since doc block.
|
||||||
|
*
|
||||||
|
* @param string $type
|
||||||
|
* @param string $content
|
||||||
|
* @param string $exContent
|
||||||
|
* @param string $exDescription
|
||||||
|
* @param string $exVersion
|
||||||
|
*
|
||||||
|
* @covers \phpDocumentor\Reflection\DocBlock\Tag\SinceTag
|
||||||
|
* @dataProvider provideDataForConstuctor
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testConstructorParesInputsIntoCorrectFields(
|
||||||
|
$type,
|
||||||
|
$content,
|
||||||
|
$exContent,
|
||||||
|
$exDescription,
|
||||||
|
$exVersion
|
||||||
|
) {
|
||||||
|
$tag = new SinceTag($type, $content);
|
||||||
|
|
||||||
|
$this->assertEquals($type, $tag->getName());
|
||||||
|
$this->assertEquals($exContent, $tag->getContent());
|
||||||
|
$this->assertEquals($exDescription, $tag->getDescription());
|
||||||
|
$this->assertEquals($exVersion, $tag->getVersion());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Data provider for testConstructorParesInputsIntoCorrectFields
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
public function provideDataForConstuctor()
|
||||||
|
{
|
||||||
|
// $type, $content, $exContent, $exDescription, $exVersion
|
||||||
|
return array(
|
||||||
|
array(
|
||||||
|
'since',
|
||||||
|
'1.0 First release.',
|
||||||
|
'1.0 First release.',
|
||||||
|
'First release.',
|
||||||
|
'1.0'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'since',
|
||||||
|
"1.0\nFirst release.",
|
||||||
|
"1.0\nFirst release.",
|
||||||
|
'First release.',
|
||||||
|
'1.0'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'since',
|
||||||
|
"1.0\nFirst\nrelease.",
|
||||||
|
"1.0\nFirst\nrelease.",
|
||||||
|
"First\nrelease.",
|
||||||
|
'1.0'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'since',
|
||||||
|
'Unfinished release',
|
||||||
|
'Unfinished release',
|
||||||
|
'Unfinished release',
|
||||||
|
''
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'since',
|
||||||
|
'1.0',
|
||||||
|
'1.0',
|
||||||
|
'',
|
||||||
|
'1.0'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'since',
|
||||||
|
'GIT: $Id$',
|
||||||
|
'GIT: $Id$',
|
||||||
|
'',
|
||||||
|
'GIT: $Id$'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'since',
|
||||||
|
'GIT: $Id$ Dev build',
|
||||||
|
'GIT: $Id$ Dev build',
|
||||||
|
'Dev build',
|
||||||
|
'GIT: $Id$'
|
||||||
|
)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,116 @@
|
|||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* phpDocumentor Source Tag Test
|
||||||
|
*
|
||||||
|
* PHP version 5.3
|
||||||
|
*
|
||||||
|
* @author Vasil Rangelov <[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\Tag;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Test class for \phpDocumentor\Reflection\DocBlock\Tag\SourceTag
|
||||||
|
*
|
||||||
|
* @author Vasil Rangelov <[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 SourceTagTest extends \PHPUnit_Framework_TestCase
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Test that the \phpDocumentor\Reflection\DocBlock\Tag\SourceTag can
|
||||||
|
* understand the @source DocBlock.
|
||||||
|
*
|
||||||
|
* @param string $type
|
||||||
|
* @param string $content
|
||||||
|
* @param string $exContent
|
||||||
|
* @param string $exStartingLine
|
||||||
|
* @param string $exLineCount
|
||||||
|
*
|
||||||
|
* @covers \phpDocumentor\Reflection\DocBlock\Tag\SourceTag
|
||||||
|
* @dataProvider provideDataForConstuctor
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testConstructorParesInputsIntoCorrectFields(
|
||||||
|
$type,
|
||||||
|
$content,
|
||||||
|
$exContent,
|
||||||
|
$exDescription,
|
||||||
|
$exStartingLine,
|
||||||
|
$exLineCount
|
||||||
|
) {
|
||||||
|
$tag = new SourceTag($type, $content);
|
||||||
|
|
||||||
|
$this->assertEquals($type, $tag->getName());
|
||||||
|
$this->assertEquals($exContent, $tag->getContent());
|
||||||
|
$this->assertEquals($exDescription, $tag->getDescription());
|
||||||
|
$this->assertEquals($exStartingLine, $tag->getStartingLine());
|
||||||
|
$this->assertEquals($exLineCount, $tag->getLineCount());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Data provider for testConstructorParesInputsIntoCorrectFields
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
public function provideDataForConstuctor()
|
||||||
|
{
|
||||||
|
// $type, $content, $exContent, $exDescription, $exStartingLine, $exLineCount
|
||||||
|
return array(
|
||||||
|
array(
|
||||||
|
'source',
|
||||||
|
'2',
|
||||||
|
'2',
|
||||||
|
'',
|
||||||
|
2,
|
||||||
|
null
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'source',
|
||||||
|
'Testing',
|
||||||
|
'Testing',
|
||||||
|
'Testing',
|
||||||
|
1,
|
||||||
|
null
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'source',
|
||||||
|
'2 Testing',
|
||||||
|
'2 Testing',
|
||||||
|
'Testing',
|
||||||
|
2,
|
||||||
|
null
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'source',
|
||||||
|
'2 3 Testing comments',
|
||||||
|
'2 3 Testing comments',
|
||||||
|
'Testing comments',
|
||||||
|
2,
|
||||||
|
3
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'source',
|
||||||
|
'2 -1 Testing comments',
|
||||||
|
'2 -1 Testing comments',
|
||||||
|
'-1 Testing comments',
|
||||||
|
2,
|
||||||
|
null
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'source',
|
||||||
|
'-1 1 Testing comments',
|
||||||
|
'-1 1 Testing comments',
|
||||||
|
'-1 1 Testing comments',
|
||||||
|
1,
|
||||||
|
null
|
||||||
|
)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,102 @@
|
|||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* phpDocumentor Throws tag 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\Tag;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Test class for \phpDocumentor\Reflection\DocBlock\ThrowsTag
|
||||||
|
*
|
||||||
|
* @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 ThrowsTagTest extends \PHPUnit_Framework_TestCase
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Test that the \phpDocumentor\Reflection\DocBlock\Tag\ThrowsTag can
|
||||||
|
* understand the @throws DocBlock.
|
||||||
|
*
|
||||||
|
* @param string $type
|
||||||
|
* @param string $content
|
||||||
|
* @param string $extractedType
|
||||||
|
* @param string $extractedTypes
|
||||||
|
* @param string $extractedDescription
|
||||||
|
*
|
||||||
|
* @covers \phpDocumentor\Reflection\DocBlock\Tag\ThrowsTag
|
||||||
|
* @dataProvider provideDataForConstructor
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testConstructorParsesInputsIntoCorrectFields(
|
||||||
|
$type,
|
||||||
|
$content,
|
||||||
|
$extractedType,
|
||||||
|
$extractedTypes,
|
||||||
|
$extractedDescription
|
||||||
|
) {
|
||||||
|
$tag = new ThrowsTag($type, $content);
|
||||||
|
|
||||||
|
$this->assertEquals($type, $tag->getName());
|
||||||
|
$this->assertEquals($extractedType, $tag->getType());
|
||||||
|
$this->assertEquals($extractedTypes, $tag->getTypes());
|
||||||
|
$this->assertEquals($extractedDescription, $tag->getDescription());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Data provider for testConstructorParsesInputsIntoCorrectFields()
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
public function provideDataForConstructor()
|
||||||
|
{
|
||||||
|
return array(
|
||||||
|
array('throws', '', '', array(), ''),
|
||||||
|
array('throws', 'int', 'int', array('int'), ''),
|
||||||
|
array(
|
||||||
|
'throws',
|
||||||
|
'int Number of Bobs',
|
||||||
|
'int',
|
||||||
|
array('int'),
|
||||||
|
'Number of Bobs'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'throws',
|
||||||
|
'int|double Number of Bobs',
|
||||||
|
'int|double',
|
||||||
|
array('int', 'double'),
|
||||||
|
'Number of Bobs'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'throws',
|
||||||
|
"int Number of \n Bobs",
|
||||||
|
'int',
|
||||||
|
array('int'),
|
||||||
|
"Number of \n Bobs"
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'throws',
|
||||||
|
" int Number of Bobs",
|
||||||
|
'int',
|
||||||
|
array('int'),
|
||||||
|
"Number of Bobs"
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'throws',
|
||||||
|
"int\nNumber of Bobs",
|
||||||
|
'int',
|
||||||
|
array('int'),
|
||||||
|
"Number of Bobs"
|
||||||
|
)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -2,52 +2,53 @@
|
|||||||
/**
|
/**
|
||||||
* phpDocumentor Uses Tag Test
|
* phpDocumentor Uses Tag Test
|
||||||
*
|
*
|
||||||
* @author Daniel O'Connor <[email protected]>
|
* PHP version 5.3
|
||||||
* @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
|
*
|
||||||
|
* @author Daniel O'Connor <[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\Tag;
|
namespace phpDocumentor\Reflection\DocBlock\Tag;
|
||||||
|
|
||||||
require_once __DIR__ . '/../../../../../src/phpDocumentor/Reflection/DocBlock/Tag/UsesTag.php';
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* Test that the \phpDocumentor\Reflection\DocBlock\Tag\UsesTag can create
|
* Test that the \phpDocumentor\Reflection\DocBlock\Tag\UsesTag can create
|
||||||
* a link for the @uses doc block
|
* a link for the @uses doc block.
|
||||||
*
|
*
|
||||||
* @param string $type
|
* @param string $type
|
||||||
* @param string $content
|
* @param string $content
|
||||||
* @param string $exName
|
|
||||||
* @param string $exContent
|
* @param string $exContent
|
||||||
* @param string $exReference
|
* @param string $exReference
|
||||||
*
|
*
|
||||||
* @covers \phpDocumentor\Reflection\DocBlock\Tag\UsesTag::__construct
|
* @covers \phpDocumentor\Reflection\DocBlock\Tag\UsesTag
|
||||||
* @dataProvider provideDataForConstuctor
|
* @dataProvider provideDataForConstuctor
|
||||||
*
|
*
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function testConstructorParesInputsIntoCorrectFields(
|
public function testConstructorParesInputsIntoCorrectFields(
|
||||||
$type, $content, $exName, $exContent, $exDescription, $exReference
|
$type,
|
||||||
)
|
$content,
|
||||||
{
|
$exContent,
|
||||||
|
$exDescription,
|
||||||
|
$exReference
|
||||||
|
) {
|
||||||
$tag = new UsesTag($type, $content);
|
$tag = new UsesTag($type, $content);
|
||||||
|
|
||||||
$actualName = $tag->getName();
|
$this->assertEquals($type, $tag->getName());
|
||||||
$actualContent = $tag->getContent();
|
$this->assertEquals($exContent, $tag->getContent());
|
||||||
$actualDescription = $tag->getDescription();
|
$this->assertEquals($exDescription, $tag->getDescription());
|
||||||
$actualReference = $tag->getReference();
|
$this->assertEquals($exReference, $tag->getReference());
|
||||||
|
|
||||||
$this->assertEquals($exName, $actualName);
|
|
||||||
$this->assertEquals($exContent, $actualContent);
|
|
||||||
$this->assertEquals($exDescription, $actualDescription);
|
|
||||||
$this->assertEquals($exReference, $actualReference);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -57,12 +58,11 @@ class UsesTagTest extends \PHPUnit_Framework_TestCase
|
|||||||
*/
|
*/
|
||||||
public function provideDataForConstuctor()
|
public function provideDataForConstuctor()
|
||||||
{
|
{
|
||||||
// $type, $content, $exName, $exContent, $exDescription, $exReference
|
// $type, $content, $exContent, $exDescription, $exReference
|
||||||
return array(
|
return array(
|
||||||
array(
|
array(
|
||||||
'uses',
|
'uses',
|
||||||
'Foo::bar()',
|
'Foo::bar()',
|
||||||
'uses',
|
|
||||||
'Foo::bar()',
|
'Foo::bar()',
|
||||||
'',
|
'',
|
||||||
'Foo::bar()'
|
'Foo::bar()'
|
||||||
@@ -70,7 +70,6 @@ class UsesTagTest extends \PHPUnit_Framework_TestCase
|
|||||||
array(
|
array(
|
||||||
'uses',
|
'uses',
|
||||||
'Foo::bar() Testing',
|
'Foo::bar() Testing',
|
||||||
'uses',
|
|
||||||
'Foo::bar() Testing',
|
'Foo::bar() Testing',
|
||||||
'Testing',
|
'Testing',
|
||||||
'Foo::bar()',
|
'Foo::bar()',
|
||||||
@@ -78,7 +77,6 @@ class UsesTagTest extends \PHPUnit_Framework_TestCase
|
|||||||
array(
|
array(
|
||||||
'uses',
|
'uses',
|
||||||
'Foo::bar() Testing comments',
|
'Foo::bar() Testing comments',
|
||||||
'uses',
|
|
||||||
'Foo::bar() Testing comments',
|
'Foo::bar() Testing comments',
|
||||||
'Testing comments',
|
'Testing comments',
|
||||||
'Foo::bar()',
|
'Foo::bar()',
|
||||||
|
|||||||
@@ -2,25 +2,29 @@
|
|||||||
/**
|
/**
|
||||||
* phpDocumentor Var Tag Test
|
* phpDocumentor Var Tag Test
|
||||||
*
|
*
|
||||||
* @author Daniel O'Connor <[email protected]>
|
* PHP version 5.3
|
||||||
* @copyright Copyright (c) 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
|
*
|
||||||
|
* @author Daniel O'Connor <[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\Tag;
|
namespace phpDocumentor\Reflection\DocBlock\Tag;
|
||||||
|
|
||||||
require_once __DIR__ . '/../../../../../src/phpDocumentor/Reflection/DocBlock/Tag/VarTag.php';
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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
|
||||||
@@ -28,20 +32,24 @@ class VarTagTest extends \PHPUnit_Framework_TestCase
|
|||||||
* @param string $exVariable
|
* @param string $exVariable
|
||||||
* @param string $exDescription
|
* @param string $exDescription
|
||||||
*
|
*
|
||||||
* @covers \phpDocumentor\Reflection\DocBlock\Tag\VarTag::__construct
|
* @covers \phpDocumentor\Reflection\DocBlock\Tag\VarTag
|
||||||
* @dataProvider provideDataForConstuctor
|
* @dataProvider provideDataForConstuctor
|
||||||
*
|
*
|
||||||
* @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($type, $tag->getName());
|
||||||
$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());
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -51,7 +59,7 @@ class VarTagTest extends \PHPUnit_Framework_TestCase
|
|||||||
*/
|
*/
|
||||||
public function provideDataForConstuctor()
|
public function provideDataForConstuctor()
|
||||||
{
|
{
|
||||||
// $type, $content
|
// $type, $content, $exType, $exVariable, $exDescription
|
||||||
return array(
|
return array(
|
||||||
array(
|
array(
|
||||||
'var',
|
'var',
|
||||||
@@ -74,6 +82,13 @@ class VarTagTest extends \PHPUnit_Framework_TestCase
|
|||||||
'$bob',
|
'$bob',
|
||||||
'Number of bobs'
|
'Number of bobs'
|
||||||
),
|
),
|
||||||
|
array(
|
||||||
|
'var',
|
||||||
|
'',
|
||||||
|
'',
|
||||||
|
'',
|
||||||
|
''
|
||||||
|
),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,115 @@
|
|||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* phpDocumentor Version Tag Test
|
||||||
|
*
|
||||||
|
* PHP version 5.3
|
||||||
|
*
|
||||||
|
* @author Vasil Rangelov <[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\Tag;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Test class for \phpDocumentor\Reflection\DocBlock\Tag\VersionTag
|
||||||
|
*
|
||||||
|
* @author Vasil Rangelov <[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 VersionTagTest extends \PHPUnit_Framework_TestCase
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Test that the \phpDocumentor\Reflection\DocBlock\Tag\LinkTag can create
|
||||||
|
* a link for the @version doc block.
|
||||||
|
*
|
||||||
|
* @param string $type
|
||||||
|
* @param string $content
|
||||||
|
* @param string $exContent
|
||||||
|
* @param string $exDescription
|
||||||
|
* @param string $exVersion
|
||||||
|
*
|
||||||
|
* @covers \phpDocumentor\Reflection\DocBlock\Tag\VersionTag
|
||||||
|
* @dataProvider provideDataForConstuctor
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testConstructorParesInputsIntoCorrectFields(
|
||||||
|
$type,
|
||||||
|
$content,
|
||||||
|
$exContent,
|
||||||
|
$exDescription,
|
||||||
|
$exVersion
|
||||||
|
) {
|
||||||
|
$tag = new VersionTag($type, $content);
|
||||||
|
|
||||||
|
$this->assertEquals($type, $tag->getName());
|
||||||
|
$this->assertEquals($exContent, $tag->getContent());
|
||||||
|
$this->assertEquals($exDescription, $tag->getDescription());
|
||||||
|
$this->assertEquals($exVersion, $tag->getVersion());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Data provider for testConstructorParesInputsIntoCorrectFields
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
public function provideDataForConstuctor()
|
||||||
|
{
|
||||||
|
// $type, $content, $exContent, $exDescription, $exVersion
|
||||||
|
return array(
|
||||||
|
array(
|
||||||
|
'version',
|
||||||
|
'1.0 First release.',
|
||||||
|
'1.0 First release.',
|
||||||
|
'First release.',
|
||||||
|
'1.0'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'version',
|
||||||
|
"1.0\nFirst release.",
|
||||||
|
"1.0\nFirst release.",
|
||||||
|
'First release.',
|
||||||
|
'1.0'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'version',
|
||||||
|
"1.0\nFirst\nrelease.",
|
||||||
|
"1.0\nFirst\nrelease.",
|
||||||
|
"First\nrelease.",
|
||||||
|
'1.0'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'version',
|
||||||
|
'Unfinished release',
|
||||||
|
'Unfinished release',
|
||||||
|
'Unfinished release',
|
||||||
|
''
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'version',
|
||||||
|
'1.0',
|
||||||
|
'1.0',
|
||||||
|
'',
|
||||||
|
'1.0'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'version',
|
||||||
|
'GIT: $Id$',
|
||||||
|
'GIT: $Id$',
|
||||||
|
'',
|
||||||
|
'GIT: $Id$'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'version',
|
||||||
|
'GIT: $Id$ Dev build',
|
||||||
|
'GIT: $Id$ Dev build',
|
||||||
|
'Dev build',
|
||||||
|
'GIT: $Id$'
|
||||||
|
)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,313 @@
|
|||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* phpDocumentor Var Tag Test
|
||||||
|
*
|
||||||
|
* PHP version 5.3
|
||||||
|
*
|
||||||
|
* @author Daniel O'Connor <[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;
|
||||||
|
|
||||||
|
use phpDocumentor\Reflection\DocBlock;
|
||||||
|
use phpDocumentor\Reflection\DocBlock\Context;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Test class for \phpDocumentor\Reflection\DocBlock\Tag\VarTag
|
||||||
|
*
|
||||||
|
* @author Daniel O'Connor <[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 TagTest extends \PHPUnit_Framework_TestCase
|
||||||
|
{
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @expectedException \InvalidArgumentException
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testInvalidTagLine()
|
||||||
|
{
|
||||||
|
Tag::createInstance('Invalid tag line');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers \phpDocumentor\Reflection\DocBlock\Tag::registerTagHandler
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testTagHandlerUnregistration()
|
||||||
|
{
|
||||||
|
$currentHandler = __NAMESPACE__ . '\Tag\VarTag';
|
||||||
|
$tagPreUnreg = Tag::createInstance('@var mixed');
|
||||||
|
$this->assertInstanceOf(
|
||||||
|
$currentHandler,
|
||||||
|
$tagPreUnreg
|
||||||
|
);
|
||||||
|
$this->assertInstanceOf(
|
||||||
|
__NAMESPACE__ . '\Tag',
|
||||||
|
$tagPreUnreg
|
||||||
|
);
|
||||||
|
|
||||||
|
Tag::registerTagHandler('var', null);
|
||||||
|
|
||||||
|
$tagPostUnreg = Tag::createInstance('@var mixed');
|
||||||
|
$this->assertNotInstanceOf(
|
||||||
|
$currentHandler,
|
||||||
|
$tagPostUnreg
|
||||||
|
);
|
||||||
|
$this->assertInstanceOf(
|
||||||
|
__NAMESPACE__ . '\Tag',
|
||||||
|
$tagPostUnreg
|
||||||
|
);
|
||||||
|
|
||||||
|
Tag::registerTagHandler('var', $currentHandler);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers \phpDocumentor\Reflection\DocBlock\Tag::registerTagHandler
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testTagHandlerCorrectRegistration()
|
||||||
|
{
|
||||||
|
if (0 == ini_get('allow_url_include')) {
|
||||||
|
$this->markTestSkipped('"data" URIs for includes are required.');
|
||||||
|
}
|
||||||
|
$currentHandler = __NAMESPACE__ . '\Tag\VarTag';
|
||||||
|
$tagPreReg = Tag::createInstance('@var mixed');
|
||||||
|
$this->assertInstanceOf(
|
||||||
|
$currentHandler,
|
||||||
|
$tagPreReg
|
||||||
|
);
|
||||||
|
$this->assertInstanceOf(
|
||||||
|
__NAMESPACE__ . '\Tag',
|
||||||
|
$tagPreReg
|
||||||
|
);
|
||||||
|
|
||||||
|
include 'data:text/plain;base64,'. base64_encode(
|
||||||
|
<<<TAG_HANDLER
|
||||||
|
<?php
|
||||||
|
class MyTagHandler extends \phpDocumentor\Reflection\DocBlock\Tag {}
|
||||||
|
TAG_HANDLER
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->assertTrue(Tag::registerTagHandler('var', '\MyTagHandler'));
|
||||||
|
|
||||||
|
$tagPostReg = Tag::createInstance('@var mixed');
|
||||||
|
$this->assertNotInstanceOf(
|
||||||
|
$currentHandler,
|
||||||
|
$tagPostReg
|
||||||
|
);
|
||||||
|
$this->assertInstanceOf(
|
||||||
|
__NAMESPACE__ . '\Tag',
|
||||||
|
$tagPostReg
|
||||||
|
);
|
||||||
|
$this->assertInstanceOf(
|
||||||
|
'\MyTagHandler',
|
||||||
|
$tagPostReg
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->assertTrue(Tag::registerTagHandler('var', $currentHandler));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @depends testTagHandlerCorrectRegistration
|
||||||
|
* @covers \phpDocumentor\Reflection\DocBlock\Tag::registerTagHandler
|
||||||
|
* @covers \phpDocumentor\Reflection\DocBlock\Tag::createInstance
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testNamespacedTagHandlerCorrectRegistration()
|
||||||
|
{
|
||||||
|
$tagPreReg = Tag::createInstance('@T something');
|
||||||
|
$this->assertInstanceOf(
|
||||||
|
__NAMESPACE__ . '\Tag',
|
||||||
|
$tagPreReg
|
||||||
|
);
|
||||||
|
$this->assertNotInstanceOf(
|
||||||
|
'\MyTagHandler',
|
||||||
|
$tagPreReg
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->assertTrue(
|
||||||
|
Tag::registerTagHandler('\MyNamespace\MyTag', '\MyTagHandler')
|
||||||
|
);
|
||||||
|
|
||||||
|
$tagPostReg = Tag::createInstance(
|
||||||
|
'@T something',
|
||||||
|
new DocBlock(
|
||||||
|
'',
|
||||||
|
new Context('', array('T' => '\MyNamespace\MyTag'))
|
||||||
|
)
|
||||||
|
);
|
||||||
|
$this->assertInstanceOf(
|
||||||
|
__NAMESPACE__ . '\Tag',
|
||||||
|
$tagPostReg
|
||||||
|
);
|
||||||
|
$this->assertInstanceOf(
|
||||||
|
'\MyTagHandler',
|
||||||
|
$tagPostReg
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->assertTrue(
|
||||||
|
Tag::registerTagHandler('\MyNamespace\MyTag', null)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @depends testTagHandlerCorrectRegistration
|
||||||
|
* @covers \phpDocumentor\Reflection\DocBlock\Tag::registerTagHandler
|
||||||
|
* @covers \phpDocumentor\Reflection\DocBlock\Tag::createInstance
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testNamespacedTagHandlerIncorrectRegistration()
|
||||||
|
{
|
||||||
|
$tagPreReg = Tag::createInstance('@T something');
|
||||||
|
$this->assertInstanceOf(
|
||||||
|
__NAMESPACE__ . '\Tag',
|
||||||
|
$tagPreReg
|
||||||
|
);
|
||||||
|
$this->assertNotInstanceOf(
|
||||||
|
'\MyTagHandler',
|
||||||
|
$tagPreReg
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->assertFalse(
|
||||||
|
Tag::registerTagHandler('MyNamespace\MyTag', '\MyTagHandler')
|
||||||
|
);
|
||||||
|
|
||||||
|
$tagPostReg = Tag::createInstance(
|
||||||
|
'@T something',
|
||||||
|
new DocBlock(
|
||||||
|
'',
|
||||||
|
new Context('', array('T' => '\MyNamespace\MyTag'))
|
||||||
|
)
|
||||||
|
);
|
||||||
|
$this->assertInstanceOf(
|
||||||
|
__NAMESPACE__ . '\Tag',
|
||||||
|
$tagPostReg
|
||||||
|
);
|
||||||
|
$this->assertNotInstanceOf(
|
||||||
|
'\MyTagHandler',
|
||||||
|
$tagPostReg
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers \phpDocumentor\Reflection\DocBlock\Tag::registerTagHandler
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testNonExistentTagHandlerRegistration()
|
||||||
|
{
|
||||||
|
$currentHandler = __NAMESPACE__ . '\Tag\VarTag';
|
||||||
|
$tagPreReg = Tag::createInstance('@var mixed');
|
||||||
|
$this->assertInstanceOf(
|
||||||
|
$currentHandler,
|
||||||
|
$tagPreReg
|
||||||
|
);
|
||||||
|
$this->assertInstanceOf(
|
||||||
|
__NAMESPACE__ . '\Tag',
|
||||||
|
$tagPreReg
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->assertFalse(Tag::registerTagHandler('var', 'Non existent'));
|
||||||
|
|
||||||
|
$tagPostReg = Tag::createInstance('@var mixed');
|
||||||
|
$this->assertInstanceOf(
|
||||||
|
$currentHandler,
|
||||||
|
$tagPostReg
|
||||||
|
);
|
||||||
|
$this->assertInstanceOf(
|
||||||
|
__NAMESPACE__ . '\Tag',
|
||||||
|
$tagPostReg
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers \phpDocumentor\Reflection\DocBlock\Tag::registerTagHandler
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testIncompatibleTagHandlerRegistration()
|
||||||
|
{
|
||||||
|
$currentHandler = __NAMESPACE__ . '\Tag\VarTag';
|
||||||
|
$tagPreReg = Tag::createInstance('@var mixed');
|
||||||
|
$this->assertInstanceOf(
|
||||||
|
$currentHandler,
|
||||||
|
$tagPreReg
|
||||||
|
);
|
||||||
|
$this->assertInstanceOf(
|
||||||
|
__NAMESPACE__ . '\Tag',
|
||||||
|
$tagPreReg
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->assertFalse(
|
||||||
|
Tag::registerTagHandler('var', __NAMESPACE__ . '\TagTest')
|
||||||
|
);
|
||||||
|
|
||||||
|
$tagPostReg = Tag::createInstance('@var mixed');
|
||||||
|
$this->assertInstanceOf(
|
||||||
|
$currentHandler,
|
||||||
|
$tagPostReg
|
||||||
|
);
|
||||||
|
$this->assertInstanceOf(
|
||||||
|
__NAMESPACE__ . '\Tag',
|
||||||
|
$tagPostReg
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Test that the \phpDocumentor\Reflection\DocBlock\Tag\VarTag can
|
||||||
|
* understand the @var doc block.
|
||||||
|
*
|
||||||
|
* @param string $type
|
||||||
|
* @param string $content
|
||||||
|
* @param string $exDescription
|
||||||
|
*
|
||||||
|
* @covers \phpDocumentor\Reflection\DocBlock\Tag
|
||||||
|
* @dataProvider provideDataForConstuctor
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testConstructorParesInputsIntoCorrectFields(
|
||||||
|
$type,
|
||||||
|
$content,
|
||||||
|
$exDescription
|
||||||
|
) {
|
||||||
|
$tag = new Tag($type, $content);
|
||||||
|
|
||||||
|
$this->assertEquals($type, $tag->getName());
|
||||||
|
$this->assertEquals($content, $tag->getContent());
|
||||||
|
$this->assertEquals($exDescription, $tag->getDescription());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Data provider for testConstructorParesInputsIntoCorrectFields
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
public function provideDataForConstuctor()
|
||||||
|
{
|
||||||
|
// $type, $content, $exDescription
|
||||||
|
return array(
|
||||||
|
array(
|
||||||
|
'unknown',
|
||||||
|
'some content',
|
||||||
|
'some content',
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'unknown',
|
||||||
|
'',
|
||||||
|
'',
|
||||||
|
)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,195 @@
|
|||||||
|
<?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;
|
||||||
|
|
||||||
|
use phpDocumentor\Reflection\DocBlock\Context;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection::__construct
|
||||||
|
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection::getContext
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testConstruct()
|
||||||
|
{
|
||||||
|
$collection = new Collection();
|
||||||
|
$this->assertCount(0, $collection);
|
||||||
|
$this->assertEquals('', $collection->getContext()->getNamespace());
|
||||||
|
$this->assertCount(0, $collection->getContext()->getNamespaceAliases());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection::__construct
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testConstructWithTypes()
|
||||||
|
{
|
||||||
|
$collection = new Collection(array('integer', 'string'));
|
||||||
|
$this->assertCount(2, $collection);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection::__construct
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testConstructWithNamespace()
|
||||||
|
{
|
||||||
|
$collection = new Collection(array(), new Context('\My\Space'));
|
||||||
|
$this->assertEquals('My\Space', $collection->getContext()->getNamespace());
|
||||||
|
|
||||||
|
$collection = new Collection(array(), new Context('My\Space'));
|
||||||
|
$this->assertEquals('My\Space', $collection->getContext()->getNamespace());
|
||||||
|
|
||||||
|
$collection = new Collection(array(), null);
|
||||||
|
$this->assertEquals('', $collection->getContext()->getNamespace());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection::__construct
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testConstructWithNamespaceAliases()
|
||||||
|
{
|
||||||
|
$fixture = array('a' => 'b');
|
||||||
|
$collection = new Collection(array(), new Context(null, $fixture));
|
||||||
|
$this->assertEquals(
|
||||||
|
array('a' => '\b'),
|
||||||
|
$collection->getContext()->getNamespaceAliases()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $fixture
|
||||||
|
* @param array $expected
|
||||||
|
*
|
||||||
|
* @dataProvider provideTypesToExpand
|
||||||
|
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection::add
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testAdd($fixture, $expected)
|
||||||
|
{
|
||||||
|
$collection = new Collection(
|
||||||
|
array(),
|
||||||
|
new Context('\My\Space', array('Alias' => '\My\Space\Aliasing'))
|
||||||
|
);
|
||||||
|
$collection->add($fixture);
|
||||||
|
|
||||||
|
$this->assertSame($expected, $collection->getArrayCopy());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $fixture
|
||||||
|
* @param array $expected
|
||||||
|
*
|
||||||
|
* @dataProvider provideTypesToExpandWithoutNamespace
|
||||||
|
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection::add
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testAddWithoutNamespace($fixture, $expected)
|
||||||
|
{
|
||||||
|
$collection = new Collection(
|
||||||
|
array(),
|
||||||
|
new Context(null, array('Alias' => '\My\Space\Aliasing'))
|
||||||
|
);
|
||||||
|
$collection->add($fixture);
|
||||||
|
|
||||||
|
$this->assertSame($expected, $collection->getArrayCopy());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers phpDocumentor\Reflection\DocBlock\Type\Collection::add
|
||||||
|
* @expectedException InvalidArgumentException
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testAddWithInvalidArgument()
|
||||||
|
{
|
||||||
|
$collection = new Collection();
|
||||||
|
$collection->add(array());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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 $namespace Name of the namespace to user as basis.
|
||||||
|
*
|
||||||
|
* @return string[]
|
||||||
|
*/
|
||||||
|
public function provideTypesToExpand($method, $namespace = '\My\Space\\')
|
||||||
|
{
|
||||||
|
return array(
|
||||||
|
array('', array()),
|
||||||
|
array(' ', array()),
|
||||||
|
array('int', array('int')),
|
||||||
|
array('int ', array('int')),
|
||||||
|
array('string', array('string')),
|
||||||
|
array('DocBlock', array($namespace.'DocBlock')),
|
||||||
|
array('DocBlock[]', array($namespace.'DocBlock[]')),
|
||||||
|
array(' DocBlock ', array($namespace.'DocBlock')),
|
||||||
|
array('\My\Space\DocBlock', array('\My\Space\DocBlock')),
|
||||||
|
array('Alias\DocBlock', array('\My\Space\Aliasing\DocBlock')),
|
||||||
|
array(
|
||||||
|
'DocBlock|Tag',
|
||||||
|
array($namespace .'DocBlock', $namespace .'Tag')
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'DocBlock|null',
|
||||||
|
array($namespace.'DocBlock', 'null')
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'\My\Space\DocBlock|Tag',
|
||||||
|
array('\My\Space\DocBlock', $namespace.'Tag')
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'DocBlock[]|null',
|
||||||
|
array($namespace.'DocBlock[]', 'null')
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'DocBlock[]|int[]',
|
||||||
|
array($namespace.'DocBlock[]', 'int[]')
|
||||||
|
),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the types and their expected values to test the retrieval of
|
||||||
|
* types when no namespace is available.
|
||||||
|
*
|
||||||
|
* @param string $method Name of the method consuming this data provider.
|
||||||
|
*
|
||||||
|
* @return string[]
|
||||||
|
*/
|
||||||
|
public function provideTypesToExpandWithoutNamespace($method)
|
||||||
|
{
|
||||||
|
return $this->provideTypesToExpand($method, '\\');
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -2,147 +2,336 @@
|
|||||||
/**
|
/**
|
||||||
* 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;
|
||||||
|
|
||||||
require_once __DIR__.'/../../../src/phpDocumentor/Reflection/DocBlock.php';
|
use phpDocumentor\Reflection\DocBlock\Context;
|
||||||
require_once __DIR__
|
use phpDocumentor\Reflection\DocBlock\Location;
|
||||||
.'/../../../src/phpDocumentor/Reflection/DocBlock/LongDescription.php';
|
use phpDocumentor\Reflection\DocBlock\Tag\ReturnTag;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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
|
||||||
{
|
{
|
||||||
|
/**
|
||||||
|
* @covers \phpDocumentor\Reflection\DocBlock
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
public function testConstruct()
|
public function testConstruct()
|
||||||
{
|
{
|
||||||
$fixture = <<<DOCBLOCK
|
$fixture = <<<DOCBLOCK
|
||||||
|
/**
|
||||||
|
* This is a short description
|
||||||
|
*
|
||||||
|
* This is a long description
|
||||||
|
*
|
||||||
|
* @see \MyClass
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
DOCBLOCK;
|
||||||
|
$object = new DocBlock(
|
||||||
|
$fixture,
|
||||||
|
new Context('\MyNamespace', array('PHPDoc' => '\phpDocumentor')),
|
||||||
|
new Location(2)
|
||||||
|
);
|
||||||
|
$this->assertEquals(
|
||||||
|
'This is a short description',
|
||||||
|
$object->getShortDescription()
|
||||||
|
);
|
||||||
|
$this->assertEquals(
|
||||||
|
'This is a long description',
|
||||||
|
$object->getLongDescription()->getContents()
|
||||||
|
);
|
||||||
|
$this->assertCount(2, $object->getTags());
|
||||||
|
$this->assertTrue($object->hasTag('see'));
|
||||||
|
$this->assertTrue($object->hasTag('return'));
|
||||||
|
$this->assertFalse($object->hasTag('category'));
|
||||||
|
|
||||||
|
$this->assertSame('MyNamespace', $object->getContext()->getNamespace());
|
||||||
|
$this->assertSame(
|
||||||
|
array('PHPDoc' => '\phpDocumentor'),
|
||||||
|
$object->getContext()->getNamespaceAliases()
|
||||||
|
);
|
||||||
|
$this->assertSame(2, $object->getLocation()->getLineNumber());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers \phpDocumentor\Reflection\DocBlock::splitDocBlock
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testConstructWithTagsOnly()
|
||||||
|
{
|
||||||
|
$fixture = <<<DOCBLOCK
|
||||||
|
/**
|
||||||
|
* @see \MyClass
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
DOCBLOCK;
|
||||||
|
$object = new DocBlock($fixture);
|
||||||
|
$this->assertEquals('', $object->getShortDescription());
|
||||||
|
$this->assertEquals('', $object->getLongDescription()->getContents());
|
||||||
|
$this->assertCount(2, $object->getTags());
|
||||||
|
$this->assertTrue($object->hasTag('see'));
|
||||||
|
$this->assertTrue($object->hasTag('return'));
|
||||||
|
$this->assertFalse($object->hasTag('category'));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers \phpDocumentor\Reflection\DocBlock::isTemplateStart
|
||||||
|
*/
|
||||||
|
public function testIfStartOfTemplateIsDiscovered()
|
||||||
|
{
|
||||||
|
$fixture = <<<DOCBLOCK
|
||||||
|
/**#@+
|
||||||
|
* @see \MyClass
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
DOCBLOCK;
|
||||||
|
$object = new DocBlock($fixture);
|
||||||
|
$this->assertEquals('', $object->getShortDescription());
|
||||||
|
$this->assertEquals('', $object->getLongDescription()->getContents());
|
||||||
|
$this->assertCount(2, $object->getTags());
|
||||||
|
$this->assertTrue($object->hasTag('see'));
|
||||||
|
$this->assertTrue($object->hasTag('return'));
|
||||||
|
$this->assertFalse($object->hasTag('category'));
|
||||||
|
$this->assertTrue($object->isTemplateStart());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers \phpDocumentor\Reflection\DocBlock::isTemplateEnd
|
||||||
|
*/
|
||||||
|
public function testIfEndOfTemplateIsDiscovered()
|
||||||
|
{
|
||||||
|
$fixture = <<<DOCBLOCK
|
||||||
|
/**#@-*/
|
||||||
|
DOCBLOCK;
|
||||||
|
$object = new DocBlock($fixture);
|
||||||
|
$this->assertEquals('', $object->getShortDescription());
|
||||||
|
$this->assertEquals('', $object->getLongDescription()->getContents());
|
||||||
|
$this->assertTrue($object->isTemplateEnd());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers \phpDocumentor\Reflection\DocBlock::cleanInput
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testConstructOneLiner()
|
||||||
|
{
|
||||||
|
$fixture = '/** Short description and nothing more. */';
|
||||||
|
$object = new DocBlock($fixture);
|
||||||
|
$this->assertEquals(
|
||||||
|
'Short description and nothing more.',
|
||||||
|
$object->getShortDescription()
|
||||||
|
);
|
||||||
|
$this->assertEquals('', $object->getLongDescription()->getContents());
|
||||||
|
$this->assertCount(0, $object->getTags());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers \phpDocumentor\Reflection\DocBlock::__construct
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testConstructFromReflector()
|
||||||
|
{
|
||||||
|
$object = new DocBlock(new \ReflectionClass($this));
|
||||||
|
$this->assertEquals(
|
||||||
|
'Test class for phpDocumentor\Reflection\DocBlock',
|
||||||
|
$object->getShortDescription()
|
||||||
|
);
|
||||||
|
$this->assertEquals('', $object->getLongDescription()->getContents());
|
||||||
|
$this->assertCount(4, $object->getTags());
|
||||||
|
$this->assertTrue($object->hasTag('author'));
|
||||||
|
$this->assertTrue($object->hasTag('copyright'));
|
||||||
|
$this->assertTrue($object->hasTag('license'));
|
||||||
|
$this->assertTrue($object->hasTag('link'));
|
||||||
|
$this->assertFalse($object->hasTag('category'));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @expectedException \InvalidArgumentException
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testExceptionOnInvalidObject()
|
||||||
|
{
|
||||||
|
new DocBlock($this);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testDotSeperation()
|
||||||
|
{
|
||||||
|
$fixture = <<<DOCBLOCK
|
||||||
|
/**
|
||||||
|
* This is a short description.
|
||||||
|
* This is a long description.
|
||||||
|
* This is a continuation of the long description.
|
||||||
|
*/
|
||||||
|
DOCBLOCK;
|
||||||
|
$object = new DocBlock($fixture);
|
||||||
|
$this->assertEquals(
|
||||||
|
'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()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers \phpDocumentor\Reflection\DocBlock::parseTags
|
||||||
|
* @expectedException \LogicException
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testInvalidTagBlock()
|
||||||
|
{
|
||||||
|
if (0 == ini_get('allow_url_include')) {
|
||||||
|
$this->markTestSkipped('"data" URIs for includes are required.');
|
||||||
|
}
|
||||||
|
|
||||||
|
include 'data:text/plain;base64,'. base64_encode(
|
||||||
|
<<<DOCBLOCK_EXTENSION
|
||||||
|
<?php
|
||||||
|
class MyReflectionDocBlock extends \phpDocumentor\Reflection\DocBlock {
|
||||||
|
protected function splitDocBlock(\$comment) {
|
||||||
|
return array('', '', 'Invalid tag block');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
DOCBLOCK_EXTENSION
|
||||||
|
);
|
||||||
|
new \MyReflectionDocBlock('');
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testTagCaseSensitivity()
|
||||||
|
{
|
||||||
|
$fixture = <<<DOCBLOCK
|
||||||
/**
|
/**
|
||||||
* This is a short description.
|
* This is a short description.
|
||||||
*
|
*
|
||||||
* This is a long description.
|
* This is a long description.
|
||||||
*
|
*
|
||||||
* @see \MyClass
|
* @method null something()
|
||||||
* @return void
|
* @Method({"GET", "POST"})
|
||||||
*/
|
*/
|
||||||
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.',
|
||||||
$object->getLongDescription()->getContents()
|
$object->getLongDescription()->getContents()
|
||||||
);
|
);
|
||||||
$this->assertEquals(2, count($object->getTags()));
|
$tags = $object->getTags();
|
||||||
$this->assertTrue($object->hasTag('see'));
|
$this->assertCount(2, $tags);
|
||||||
$this->assertTrue($object->hasTag('return'));
|
$this->assertTrue($object->hasTag('method'));
|
||||||
|
$this->assertTrue($object->hasTag('Method'));
|
||||||
|
$this->assertInstanceOf(
|
||||||
|
__NAMESPACE__ . '\DocBlock\Tag\MethodTag',
|
||||||
|
$tags[0]
|
||||||
|
);
|
||||||
|
$this->assertInstanceOf(
|
||||||
|
__NAMESPACE__ . '\DocBlock\Tag',
|
||||||
|
$tags[1]
|
||||||
|
);
|
||||||
|
$this->assertNotInstanceOf(
|
||||||
|
__NAMESPACE__ . '\DocBlock\Tag\MethodTag',
|
||||||
|
$tags[1]
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
public function testDotSeperation()
|
/**
|
||||||
|
* @depends testConstructFromReflector
|
||||||
|
* @covers \phpDocumentor\Reflection\DocBlock::getTagsByName
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testGetTagsByNameZeroAndOneMatch()
|
||||||
|
{
|
||||||
|
$object = new DocBlock(new \ReflectionClass($this));
|
||||||
|
$this->assertEmpty($object->getTagsByName('category'));
|
||||||
|
$this->assertCount(1, $object->getTagsByName('author'));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @depends testConstructWithTagsOnly
|
||||||
|
* @covers \phpDocumentor\Reflection\DocBlock::parseTags
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function testParseMultilineTag()
|
||||||
{
|
{
|
||||||
$fixture = <<<DOCBLOCK
|
$fixture = <<<DOCBLOCK
|
||||||
/**
|
/**
|
||||||
* This is a short description. This is a long description.
|
* @return void Content on
|
||||||
* This is a continuation of the long description.
|
* multiple lines.
|
||||||
*/
|
*/
|
||||||
DOCBLOCK;
|
DOCBLOCK;
|
||||||
$object = new DocBlock($fixture);
|
$object = new DocBlock($fixture);
|
||||||
$this->assertEquals(
|
$this->assertCount(1, $object->getTags());
|
||||||
'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()
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Tests whether a type is expanded with the given namespace and that a
|
* @depends testConstructWithTagsOnly
|
||||||
* keyword is not expanded.
|
* @covers \phpDocumentor\Reflection\DocBlock::parseTags
|
||||||
*
|
|
||||||
* @covers \phpDocumentor\Reflection\DocBlock::expandType()
|
|
||||||
*
|
*
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function testExpandTypeUsingNamespace()
|
public function testParseMultilineTagWithLineBreaks()
|
||||||
{
|
{
|
||||||
$docblock = new DocBlock('', '\My\Namespace');
|
$fixture = <<<DOCBLOCK
|
||||||
$this->assertEquals('\My\Namespace\Mine', $docblock->expandType('Mine'));
|
/**
|
||||||
|
* @return void Content on
|
||||||
|
* multiple lines.
|
||||||
|
*
|
||||||
|
* One more, after the break.
|
||||||
|
*/
|
||||||
|
DOCBLOCK;
|
||||||
|
$object = new DocBlock($fixture);
|
||||||
|
$this->assertCount(1, $tags = $object->getTags());
|
||||||
|
/** @var ReturnTag $tag */
|
||||||
|
$tag = reset($tags);
|
||||||
|
$this->assertEquals("Content on\n multiple lines.\n\n One more, after the break.", $tag->getDescription());
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Tests whether a type is expanded when no namespace is given.
|
* @depends testConstructWithTagsOnly
|
||||||
*
|
* @covers \phpDocumentor\Reflection\DocBlock::getTagsByName
|
||||||
* @covers \phpDocumentor\Reflection\DocBlock::expandType()
|
|
||||||
*
|
*
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function testExpandTypeWithoutNamespace()
|
public function testGetTagsByNameMultipleMatch()
|
||||||
{
|
{
|
||||||
$docblock = new DocBlock('');
|
$fixture = <<<DOCBLOCK
|
||||||
$this->assertEquals('\Mine', $docblock->expandType('Mine'));
|
/**
|
||||||
}
|
* @param string
|
||||||
|
* @param int
|
||||||
/**
|
* @return void
|
||||||
* Tests whether a type is expanded with the given namespace when an alias
|
*/
|
||||||
* is provided.
|
DOCBLOCK;
|
||||||
*
|
$object = new DocBlock($fixture);
|
||||||
* @covers \phpDocumentor\Reflection\DocBlock::expandType()
|
$this->assertEmpty($object->getTagsByName('category'));
|
||||||
*
|
$this->assertCount(1, $object->getTagsByName('return'));
|
||||||
* @return void
|
$this->assertCount(2, $object->getTagsByName('param'));
|
||||||
*/
|
|
||||||
public function testExpandTypeUsingNamespaceAlias()
|
|
||||||
{
|
|
||||||
$docblock = new DocBlock(
|
|
||||||
'', '\My\Namespace', array('Alias' => '\My\Namespace\Alias')
|
|
||||||
);
|
|
||||||
|
|
||||||
// first try a normal resolution without alias
|
|
||||||
$this->assertEquals(
|
|
||||||
'\My\Namespace\Al', $docblock->expandType('Al')
|
|
||||||
);
|
|
||||||
|
|
||||||
// try to use the alias
|
|
||||||
$this->assertEquals(
|
|
||||||
'\My\Namespace\Alias\Al', $docblock->expandType('Alias\Al')
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Tests whether the keywords that should not be converted are not converted.
|
|
||||||
*
|
|
||||||
* @param string $keyword The keyword that is to be tested; this is provided
|
|
||||||
* by the dataprovider.
|
|
||||||
*
|
|
||||||
* @covers \phpDocumentor\Reflection\DocBlock::expandType()
|
|
||||||
*
|
|
||||||
* @dataProvider getNonExpandableKeywordsForExpandType
|
|
||||||
*
|
|
||||||
* @return void
|
|
||||||
*/
|
|
||||||
public function testThatExpandTypeDoesNotExpandAllKeywords($keyword)
|
|
||||||
{
|
|
||||||
$docblock = new DocBlock('', '\My\Namespace');
|
|
||||||
$this->assertEquals($keyword, $docblock->expandType($keyword));
|
|
||||||
}
|
|
||||||
|
|
||||||
public function getNonExpandableKeywordsForExpandType()
|
|
||||||
{
|
|
||||||
return array(
|
|
||||||
array('string'), array('int'), array('integer'), array('bool'),
|
|
||||||
array('boolean'), array('float'), array('double'), array('object'),
|
|
||||||
array('mixed'), array('array'), array('resource'), array('void'),
|
|
||||||
array('null'), array('callback'), array('false'), array('true')
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user