mirror of
https://github.com/barryvdh/ReflectionDocBlock.git
synced 2026-08-18 10:07:12 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
4f5ba70c30 | ||
|
|
700b4e071f | ||
|
|
d103774cbe | ||
|
|
5a3e22c213 | ||
|
|
b6ff9f9360 | ||
|
|
ffb733ef78 | ||
|
|
818be8de6a | ||
|
|
268ae0f584 | ||
|
|
6b3854ad25 |
@@ -7,8 +7,6 @@ on:
|
|||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
branches:
|
||||||
- "*"
|
- "*"
|
||||||
schedule:
|
|
||||||
- cron: '0 0 * * *'
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
php-tests:
|
php-tests:
|
||||||
|
|||||||
@@ -1,6 +1,9 @@
|
|||||||
The ReflectionDocBlock Component [](https://travis-ci.org/phpDocumentor/ReflectionDocBlock)
|
The ReflectionDocBlock Component
|
||||||
================================
|
================================
|
||||||
|
|
||||||
|
> This is a fork of [phpDocumentor/ReflectionDocBlock 2.x](https://github.com/phpDocumentor/ReflectionDocBlock/tree/release/2.x) combined with bits of [phpDocumentor/TypeResolver](https://github.com/phpDocumentor/TypeResolver) and various tweaks. The main reason for this fork is to add functionality for https://github.com/barryvdh/laravel-ide-helper
|
||||||
|
> Any other use of this library is discouraged. You are probably better of using https://github.com/phpDocumentor/ReflectionDocBlock directly.
|
||||||
|
|
||||||
Introduction
|
Introduction
|
||||||
------------
|
------------
|
||||||
|
|
||||||
|
|||||||
+2
-2
@@ -6,7 +6,7 @@
|
|||||||
{"name": "Mike van Riel", "email": "[email protected]"}
|
{"name": "Mike van Riel", "email": "[email protected]"}
|
||||||
],
|
],
|
||||||
"require": {
|
"require": {
|
||||||
"php": ">=5.3.3"
|
"php": ">=7.1"
|
||||||
},
|
},
|
||||||
"autoload": {
|
"autoload": {
|
||||||
"psr-0": {"Barryvdh": ["src/"]}
|
"psr-0": {"Barryvdh": ["src/"]}
|
||||||
@@ -20,7 +20,7 @@
|
|||||||
},
|
},
|
||||||
"extra": {
|
"extra": {
|
||||||
"branch-alias": {
|
"branch-alias": {
|
||||||
"dev-master": "2.2.x-dev"
|
"dev-master": "2.3.x-dev"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,422 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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.
|
||||||
|
*
|
||||||
|
* @link http://phpdoc.org
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Barryvdh\Reflection\DocBlock;
|
||||||
|
|
||||||
|
use ArrayIterator;
|
||||||
|
use InvalidArgumentException;
|
||||||
|
use ReflectionClass;
|
||||||
|
use ReflectionClassConstant;
|
||||||
|
use ReflectionMethod;
|
||||||
|
use ReflectionParameter;
|
||||||
|
use ReflectionProperty;
|
||||||
|
use Reflector;
|
||||||
|
use RuntimeException;
|
||||||
|
use UnexpectedValueException;
|
||||||
|
|
||||||
|
use function define;
|
||||||
|
use function defined;
|
||||||
|
use function file_exists;
|
||||||
|
use function file_get_contents;
|
||||||
|
use function get_class;
|
||||||
|
use function in_array;
|
||||||
|
use function is_string;
|
||||||
|
use function strrpos;
|
||||||
|
use function substr;
|
||||||
|
use function token_get_all;
|
||||||
|
use function trim;
|
||||||
|
|
||||||
|
use const T_AS;
|
||||||
|
use const T_CLASS;
|
||||||
|
use const T_CURLY_OPEN;
|
||||||
|
use const T_DOLLAR_OPEN_CURLY_BRACES;
|
||||||
|
use const T_NAME_FULLY_QUALIFIED;
|
||||||
|
use const T_NAME_QUALIFIED;
|
||||||
|
use const T_NAMESPACE;
|
||||||
|
use const T_NS_SEPARATOR;
|
||||||
|
use const T_STRING;
|
||||||
|
use const T_TRAIT;
|
||||||
|
use const T_USE;
|
||||||
|
|
||||||
|
if (!defined('T_NAME_QUALIFIED')) {
|
||||||
|
define('T_NAME_QUALIFIED', 10001);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!defined('T_NAME_FULLY_QUALIFIED')) {
|
||||||
|
define('T_NAME_FULLY_QUALIFIED', 10002);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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. */
|
||||||
|
private const T_LITERAL_END_OF_USE = ';';
|
||||||
|
|
||||||
|
/** The literal used between sets of use statements */
|
||||||
|
private const T_LITERAL_USE_SEPARATOR = ',';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Build a Context given a Class Reflection.
|
||||||
|
*
|
||||||
|
* @see Context for more information on Contexts.
|
||||||
|
*/
|
||||||
|
public function createFromReflector(Reflector $reflector): Context
|
||||||
|
{
|
||||||
|
if ($reflector instanceof ReflectionClass) {
|
||||||
|
//phpcs:ignore SlevomatCodingStandard.Commenting.InlineDocCommentDeclaration.MissingVariable
|
||||||
|
/** @var ReflectionClass<object> $reflector */
|
||||||
|
|
||||||
|
return $this->createFromReflectionClass($reflector);
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($reflector instanceof ReflectionParameter) {
|
||||||
|
return $this->createFromReflectionParameter($reflector);
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($reflector instanceof ReflectionMethod) {
|
||||||
|
return $this->createFromReflectionMethod($reflector);
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($reflector instanceof ReflectionProperty) {
|
||||||
|
return $this->createFromReflectionProperty($reflector);
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($reflector instanceof ReflectionClassConstant) {
|
||||||
|
return $this->createFromReflectionClassConstant($reflector);
|
||||||
|
}
|
||||||
|
|
||||||
|
throw new UnexpectedValueException('Unhandled \Reflector instance given: ' . get_class($reflector));
|
||||||
|
}
|
||||||
|
|
||||||
|
private function createFromReflectionParameter(ReflectionParameter $parameter): Context
|
||||||
|
{
|
||||||
|
$class = $parameter->getDeclaringClass();
|
||||||
|
if (!$class) {
|
||||||
|
throw new InvalidArgumentException('Unable to get class of ' . $parameter->getName());
|
||||||
|
}
|
||||||
|
|
||||||
|
return $this->createFromReflectionClass($class);
|
||||||
|
}
|
||||||
|
|
||||||
|
private function createFromReflectionMethod(ReflectionMethod $method): Context
|
||||||
|
{
|
||||||
|
$class = $method->getDeclaringClass();
|
||||||
|
|
||||||
|
return $this->createFromReflectionClass($class);
|
||||||
|
}
|
||||||
|
|
||||||
|
private function createFromReflectionProperty(ReflectionProperty $property): Context
|
||||||
|
{
|
||||||
|
$class = $property->getDeclaringClass();
|
||||||
|
|
||||||
|
return $this->createFromReflectionClass($class);
|
||||||
|
}
|
||||||
|
|
||||||
|
private function createFromReflectionClassConstant(ReflectionClassConstant $constant): Context
|
||||||
|
{
|
||||||
|
//phpcs:ignore SlevomatCodingStandard.Commenting.InlineDocCommentDeclaration.MissingVariable
|
||||||
|
/** @phpstan-var ReflectionClass<object> $class */
|
||||||
|
$class = $constant->getDeclaringClass();
|
||||||
|
|
||||||
|
return $this->createFromReflectionClass($class);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @phpstan-param ReflectionClass<object> $class
|
||||||
|
*/
|
||||||
|
private function createFromReflectionClass(ReflectionClass $class): Context
|
||||||
|
{
|
||||||
|
$fileName = $class->getFileName();
|
||||||
|
$namespace = $class->getNamespaceName();
|
||||||
|
|
||||||
|
if (is_string($fileName) && file_exists($fileName)) {
|
||||||
|
$contents = file_get_contents($fileName);
|
||||||
|
if ($contents === false) {
|
||||||
|
throw new RuntimeException('Unable to read file "' . $fileName . '"');
|
||||||
|
}
|
||||||
|
|
||||||
|
return $this->createForNamespace($namespace, $contents);
|
||||||
|
}
|
||||||
|
|
||||||
|
return new Context($namespace, []);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Build a Context for a namespace in the provided file contents.
|
||||||
|
*
|
||||||
|
* @see Context for more information on Contexts.
|
||||||
|
*
|
||||||
|
* @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.
|
||||||
|
*/
|
||||||
|
public function createForNamespace(string $namespace, string $fileContents): Context
|
||||||
|
{
|
||||||
|
$namespace = trim($namespace, '\\');
|
||||||
|
$useStatements = [];
|
||||||
|
$currentNamespace = '';
|
||||||
|
$tokens = new ArrayIterator(token_get_all($fileContents));
|
||||||
|
|
||||||
|
while ($tokens->valid()) {
|
||||||
|
$currentToken = $tokens->current();
|
||||||
|
switch ($currentToken[0]) {
|
||||||
|
case T_NAMESPACE:
|
||||||
|
$currentNamespace = $this->parseNamespace($tokens);
|
||||||
|
break;
|
||||||
|
case T_CLASS:
|
||||||
|
case T_TRAIT:
|
||||||
|
// Fast-forward the iterator through the class so that any
|
||||||
|
// T_USE tokens found within are skipped - these are not
|
||||||
|
// valid namespace use statements so should be ignored.
|
||||||
|
$braceLevel = 0;
|
||||||
|
$firstBraceFound = false;
|
||||||
|
while ($tokens->valid() && ($braceLevel > 0 || !$firstBraceFound)) {
|
||||||
|
$currentToken = $tokens->current();
|
||||||
|
if (
|
||||||
|
$currentToken === '{'
|
||||||
|
|| in_array($currentToken[0], [T_CURLY_OPEN, T_DOLLAR_OPEN_CURLY_BRACES], true)
|
||||||
|
) {
|
||||||
|
if (!$firstBraceFound) {
|
||||||
|
$firstBraceFound = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
++$braceLevel;
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($currentToken === '}') {
|
||||||
|
--$braceLevel;
|
||||||
|
}
|
||||||
|
|
||||||
|
$tokens->next();
|
||||||
|
}
|
||||||
|
|
||||||
|
break;
|
||||||
|
case T_USE:
|
||||||
|
if ($currentNamespace === $namespace) {
|
||||||
|
$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<int, string|array{0:int,1:string,2:int}> $tokens
|
||||||
|
*/
|
||||||
|
private function parseNamespace(ArrayIterator $tokens): string
|
||||||
|
{
|
||||||
|
// skip to the first string or namespace separator
|
||||||
|
$this->skipToNextStringOrNamespaceSeparator($tokens);
|
||||||
|
|
||||||
|
$name = '';
|
||||||
|
$acceptedTokens = [T_STRING, T_NS_SEPARATOR, T_NAME_QUALIFIED];
|
||||||
|
while ($tokens->valid() && in_array($tokens->current()[0], $acceptedTokens, true)) {
|
||||||
|
$name .= $tokens->current()[1];
|
||||||
|
$tokens->next();
|
||||||
|
}
|
||||||
|
|
||||||
|
return $name;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Deduce the names of all imports when we are at the T_USE token.
|
||||||
|
*
|
||||||
|
* @param ArrayIterator<int, string|array{0:int,1:string,2:int}> $tokens
|
||||||
|
*
|
||||||
|
* @return string[]
|
||||||
|
* @psalm-return array<string, string>
|
||||||
|
*/
|
||||||
|
private function parseUseStatement(ArrayIterator $tokens): array
|
||||||
|
{
|
||||||
|
$uses = [];
|
||||||
|
|
||||||
|
while ($tokens->valid()) {
|
||||||
|
$this->skipToNextStringOrNamespaceSeparator($tokens);
|
||||||
|
|
||||||
|
$uses += $this->extractUseStatements($tokens);
|
||||||
|
$currentToken = $tokens->current();
|
||||||
|
if ($currentToken[0] === self::T_LITERAL_END_OF_USE) {
|
||||||
|
return $uses;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return $uses;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fast-forwards the iterator as longs as we don't encounter a T_STRING or T_NS_SEPARATOR token.
|
||||||
|
*
|
||||||
|
* @param ArrayIterator<int, string|array{0:int,1:string,2:int}> $tokens
|
||||||
|
*/
|
||||||
|
private function skipToNextStringOrNamespaceSeparator(ArrayIterator $tokens): void
|
||||||
|
{
|
||||||
|
while ($tokens->valid()) {
|
||||||
|
$currentToken = $tokens->current();
|
||||||
|
if (in_array($currentToken[0], [T_STRING, T_NS_SEPARATOR], true)) {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($currentToken[0] === T_NAME_QUALIFIED) {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (defined('T_NAME_FULLY_QUALIFIED') && $currentToken[0] === T_NAME_FULLY_QUALIFIED) {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
$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. This will return a key/value array of the alias => namespace.
|
||||||
|
*
|
||||||
|
* @param ArrayIterator<int, string|array{0:int,1:string,2:int}> $tokens
|
||||||
|
*
|
||||||
|
* @return string[]
|
||||||
|
* @psalm-return array<string, string>
|
||||||
|
*
|
||||||
|
* @psalm-suppress TypeDoesNotContainType
|
||||||
|
*/
|
||||||
|
private function extractUseStatements(ArrayIterator $tokens): array
|
||||||
|
{
|
||||||
|
$extractedUseStatements = [];
|
||||||
|
$groupedNs = '';
|
||||||
|
$currentNs = '';
|
||||||
|
$currentAlias = '';
|
||||||
|
$state = 'start';
|
||||||
|
|
||||||
|
while ($tokens->valid()) {
|
||||||
|
$currentToken = $tokens->current();
|
||||||
|
$tokenId = is_string($currentToken) ? $currentToken : $currentToken[0];
|
||||||
|
$tokenValue = is_string($currentToken) ? null : $currentToken[1];
|
||||||
|
switch ($state) {
|
||||||
|
case 'start':
|
||||||
|
switch ($tokenId) {
|
||||||
|
case T_STRING:
|
||||||
|
case T_NS_SEPARATOR:
|
||||||
|
$currentNs .= (string) $tokenValue;
|
||||||
|
$currentAlias = $tokenValue;
|
||||||
|
break;
|
||||||
|
case T_NAME_QUALIFIED:
|
||||||
|
case T_NAME_FULLY_QUALIFIED:
|
||||||
|
$currentNs .= (string) $tokenValue;
|
||||||
|
$currentAlias = substr(
|
||||||
|
(string) $tokenValue,
|
||||||
|
(int) (strrpos((string) $tokenValue, '\\')) + 1
|
||||||
|
);
|
||||||
|
break;
|
||||||
|
case T_CURLY_OPEN:
|
||||||
|
case '{':
|
||||||
|
$state = 'grouped';
|
||||||
|
$groupedNs = $currentNs;
|
||||||
|
break;
|
||||||
|
case T_AS:
|
||||||
|
$state = 'start-alias';
|
||||||
|
break;
|
||||||
|
case self::T_LITERAL_USE_SEPARATOR:
|
||||||
|
case self::T_LITERAL_END_OF_USE:
|
||||||
|
$state = 'end';
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
break;
|
||||||
|
case 'start-alias':
|
||||||
|
switch ($tokenId) {
|
||||||
|
case T_STRING:
|
||||||
|
$currentAlias = $tokenValue;
|
||||||
|
break;
|
||||||
|
case self::T_LITERAL_USE_SEPARATOR:
|
||||||
|
case self::T_LITERAL_END_OF_USE:
|
||||||
|
$state = 'end';
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
break;
|
||||||
|
case 'grouped':
|
||||||
|
switch ($tokenId) {
|
||||||
|
case T_STRING:
|
||||||
|
case T_NS_SEPARATOR:
|
||||||
|
$currentNs .= (string) $tokenValue;
|
||||||
|
$currentAlias = $tokenValue;
|
||||||
|
break;
|
||||||
|
case T_AS:
|
||||||
|
$state = 'grouped-alias';
|
||||||
|
break;
|
||||||
|
case self::T_LITERAL_USE_SEPARATOR:
|
||||||
|
$state = 'grouped';
|
||||||
|
$extractedUseStatements[(string) $currentAlias] = $currentNs;
|
||||||
|
$currentNs = $groupedNs;
|
||||||
|
$currentAlias = '';
|
||||||
|
break;
|
||||||
|
case self::T_LITERAL_END_OF_USE:
|
||||||
|
$state = 'end';
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
break;
|
||||||
|
case 'grouped-alias':
|
||||||
|
switch ($tokenId) {
|
||||||
|
case T_STRING:
|
||||||
|
$currentAlias = $tokenValue;
|
||||||
|
break;
|
||||||
|
case self::T_LITERAL_USE_SEPARATOR:
|
||||||
|
$state = 'grouped';
|
||||||
|
$extractedUseStatements[(string) $currentAlias] = $currentNs;
|
||||||
|
$currentNs = $groupedNs;
|
||||||
|
$currentAlias = '';
|
||||||
|
break;
|
||||||
|
case self::T_LITERAL_END_OF_USE:
|
||||||
|
$state = 'end';
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($state === 'end') {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
$tokens->next();
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($groupedNs !== $currentNs) {
|
||||||
|
$extractedUseStatements[(string) $currentAlias] = $currentNs;
|
||||||
|
}
|
||||||
|
|
||||||
|
return $extractedUseStatements;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -206,8 +206,9 @@ class Serializer
|
|||||||
$text = wordwrap($text, $wrapLength);
|
$text = wordwrap($text, $wrapLength);
|
||||||
}
|
}
|
||||||
$text = str_replace("\n", "\n{$indent} * ", $text);
|
$text = str_replace("\n", "\n{$indent} * ", $text);
|
||||||
|
$text = preg_replace('/^(\s*\*)[ \t]+$/m', '$1', $text);
|
||||||
|
|
||||||
$comment = "{$firstIndent}/**\n{$indent} * {$text}\n{$indent} *\n";
|
$comment = !empty($text)? "{$firstIndent}/**\n{$indent} * {$text}\n{$indent} *\n" : "{$firstIndent}/**\n";
|
||||||
|
|
||||||
$tags = array_values($docblock->getTags());
|
$tags = array_values($docblock->getTags());
|
||||||
|
|
||||||
@@ -220,6 +221,7 @@ class Serializer
|
|||||||
$tagText = wordwrap($tagText, $wrapLength);
|
$tagText = wordwrap($tagText, $wrapLength);
|
||||||
}
|
}
|
||||||
$tagText = str_replace("\n", "\n{$indent} * ", $tagText);
|
$tagText = str_replace("\n", "\n{$indent} * ", $tagText);
|
||||||
|
$tagText = preg_replace('/^(\s*\*)[ \t]+$/m', '$1', $tagText);
|
||||||
|
|
||||||
$comment .= "{$indent} * {$tagText}\n";
|
$comment .= "{$indent} * {$tagText}\n";
|
||||||
|
|
||||||
|
|||||||
@@ -409,6 +409,6 @@ class Tag implements \Reflector
|
|||||||
*/
|
*/
|
||||||
public function __toString()
|
public function __toString()
|
||||||
{
|
{
|
||||||
return "@{$this->getName()} {$this->getContent()}";
|
return trim("@{$this->getName()} {$this->getContent()}");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -54,16 +54,15 @@ class ParamTag extends ReturnTag
|
|||||||
for($pos = 0, $stacks = []; $pos < strlen($rest); $pos++) {
|
for($pos = 0, $stacks = []; $pos < strlen($rest); $pos++) {
|
||||||
$char = $rest[$pos];
|
$char = $rest[$pos];
|
||||||
|
|
||||||
if($char === '<') {
|
if(in_array($char, ['<', '(', '[', '{'])) {
|
||||||
array_unshift($stacks, $char);
|
array_unshift($stacks, $char);
|
||||||
}
|
}
|
||||||
if($char === '(') {
|
if(
|
||||||
array_unshift($stacks, $char);
|
($char === '>' && isset($stacks[0]) && $stacks[0] === '<')
|
||||||
}
|
|| ($char === ')' && isset($stacks[0]) && $stacks[0] === '(')
|
||||||
if($char === '>' && isset($stacks[0]) && $stacks[0] === '<') {
|
|| ($char === ']' && isset($stacks[0]) && $stacks[0] === '[')
|
||||||
array_shift($stacks);
|
|| ($char === '}' && isset($stacks[0]) && $stacks[0] === '{')
|
||||||
}
|
) {
|
||||||
if($char === ')' && isset($stacks[0]) && $stacks[0] === '(') {
|
|
||||||
array_shift($stacks);
|
array_shift($stacks);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -161,9 +161,9 @@ class Collection extends \ArrayObject
|
|||||||
$type_parts[] = $curr_type;
|
$type_parts[] = $curr_type;
|
||||||
$curr_type = '';
|
$curr_type = '';
|
||||||
} else {
|
} else {
|
||||||
if ($char === '<' || $char === '(') {
|
if (in_array($char, ['<', '(', '[', '{'])) {
|
||||||
$nest_level++;
|
$nest_level++;
|
||||||
} else if ($char === '>' || $char === ')') {
|
} else if (in_array($char, ['>', ')', ']', '}'])) {
|
||||||
$nest_level--;
|
$nest_level--;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -201,7 +201,13 @@ class Collection extends \ArrayObject
|
|||||||
return '';
|
return '';
|
||||||
}
|
}
|
||||||
|
|
||||||
if (preg_match('/^[\w-]+<.*>$/', $type)) {
|
// Check for generics values and array shapes
|
||||||
|
if (preg_match('/^[\w-]+(<.+>|\[.+\]|{.+})$/', $type)) {
|
||||||
|
return $type;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check for callable types
|
||||||
|
if (preg_match('/\(.*?(?=\:)/', $type)) {
|
||||||
return $type;
|
return $type;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -209,6 +215,11 @@ class Collection extends \ArrayObject
|
|||||||
return $type;
|
return $type;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Literal strings
|
||||||
|
if ($type[0] === '"' || $type[0] === "'") {
|
||||||
|
return $type;
|
||||||
|
}
|
||||||
|
|
||||||
if ($this->isTypeAnArray($type)) {
|
if ($this->isTypeAnArray($type)) {
|
||||||
return $this->expand(substr($type, 0, -2)) . self::OPERATOR_ARRAY;
|
return $this->expand(substr($type, 0, -2)) . self::OPERATOR_ARRAY;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,227 @@
|
|||||||
|
<?php
|
||||||
|
declare(strict_types=1);
|
||||||
|
/**
|
||||||
|
* 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.
|
||||||
|
*
|
||||||
|
* @link http://phpdoc.org
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Barryvdh\Reflection\DocBlock;
|
||||||
|
|
||||||
|
// Added imports on purpose as mock for the unit tests, please do not remove.
|
||||||
|
use Barryvdh\Reflection\DocBlock\Tag as m, Barryvdh;
|
||||||
|
use Barryvdh\Reflection\DocBlock;
|
||||||
|
use Barryvdh\Reflection\DocBlock\Tag;
|
||||||
|
use PHPUnit\Framework\TestCase;
|
||||||
|
|
||||||
|
// yes, the slash is part of the test
|
||||||
|
use PHPUnit\Framework\{
|
||||||
|
Assert,
|
||||||
|
Exception as e
|
||||||
|
};
|
||||||
|
use \ReflectionClass;
|
||||||
|
use stdClass;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @coversDefaultClass \phpDocumentor\Reflection\Types\ContextFactory
|
||||||
|
* @covers ::<private>
|
||||||
|
*/
|
||||||
|
class ContextFactoryTest extends TestCase
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @covers ::createFromReflector
|
||||||
|
* @covers ::createForNamespace
|
||||||
|
* @uses Barryvdh\Reflection\DocBlock\Context
|
||||||
|
*/
|
||||||
|
public function testReadsNamespaceFromClassReflection(): void
|
||||||
|
{
|
||||||
|
$fixture = new ContextFactory();
|
||||||
|
$context = $fixture->createFromReflector(new ReflectionClass($this));
|
||||||
|
|
||||||
|
$this->assertSame(__NAMESPACE__, $context->getNamespace());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers ::createFromReflector
|
||||||
|
* @covers ::createForNamespace
|
||||||
|
* @uses Barryvdh\Reflection\DocBlock\Context
|
||||||
|
*/
|
||||||
|
public function testReadsAliasesFromClassReflection(): void
|
||||||
|
{
|
||||||
|
$fixture = new ContextFactory();
|
||||||
|
$context = $fixture->createFromReflector(new ReflectionClass($this));
|
||||||
|
|
||||||
|
$this->assertNamespaceAliasesFrom($context);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers ::createForNamespace
|
||||||
|
* @uses Barryvdh\Reflection\DocBlock\Context
|
||||||
|
*/
|
||||||
|
public function testReadsNamespaceFromProvidedNamespaceAndContent(): void
|
||||||
|
{
|
||||||
|
$fixture = new ContextFactory();
|
||||||
|
$context = $fixture->createForNamespace(__NAMESPACE__, file_get_contents(__FILE__));
|
||||||
|
|
||||||
|
$this->assertSame(__NAMESPACE__, $context->getNamespace());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers ::createForNamespace
|
||||||
|
* @uses Barryvdh\Reflection\DocBlock\Context
|
||||||
|
*/
|
||||||
|
public function testReadsAliasesFromProvidedNamespaceAndContent(): void
|
||||||
|
{
|
||||||
|
$fixture = new ContextFactory();
|
||||||
|
$context = $fixture->createForNamespace(__NAMESPACE__, file_get_contents(__FILE__));
|
||||||
|
|
||||||
|
$this->assertNamespaceAliasesFrom($context);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers ::createForNamespace
|
||||||
|
* @uses Barryvdh\Reflection\DocBlock\Context
|
||||||
|
*/
|
||||||
|
public function testTraitUseIsNotDetectedAsNamespaceUse(): void
|
||||||
|
{
|
||||||
|
$php = '<?php declare(strict_types=1);
|
||||||
|
namespace Foo;
|
||||||
|
|
||||||
|
trait FooTrait {}
|
||||||
|
|
||||||
|
class FooClass {
|
||||||
|
use FooTrait;
|
||||||
|
}
|
||||||
|
';
|
||||||
|
|
||||||
|
$fixture = new ContextFactory();
|
||||||
|
$context = $fixture->createForNamespace('Foo', $php);
|
||||||
|
|
||||||
|
$this->assertSame([], $context->getNamespaceAliases());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers ::createForNamespace
|
||||||
|
* @uses Barryvdh\Reflection\DocBlock\Context
|
||||||
|
*/
|
||||||
|
public function testAllOpeningBracesAreCheckedWhenSearchingForEndOfClass(): void
|
||||||
|
{
|
||||||
|
$php = '<?php declare(strict_types=1);
|
||||||
|
namespace Foo;
|
||||||
|
|
||||||
|
trait FooTrait {}
|
||||||
|
trait BarTrait {}
|
||||||
|
|
||||||
|
class FooClass {
|
||||||
|
use FooTrait;
|
||||||
|
|
||||||
|
public function bar()
|
||||||
|
{
|
||||||
|
echo "{$baz}";
|
||||||
|
echo "${baz}";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
class BarClass {
|
||||||
|
use BarTrait;
|
||||||
|
|
||||||
|
public function bar()
|
||||||
|
{
|
||||||
|
echo "{$baz}";
|
||||||
|
echo "${baz}";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
';
|
||||||
|
|
||||||
|
$fixture = new ContextFactory();
|
||||||
|
$context = $fixture->createForNamespace('Foo', $php);
|
||||||
|
|
||||||
|
$this->assertSame([], $context->getNamespaceAliases());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers ::createForNamespace
|
||||||
|
* @uses Barryvdh\Reflection\DocBlock\Context
|
||||||
|
*/
|
||||||
|
public function testTraitContainsClosureWithUseStatement(): void
|
||||||
|
{
|
||||||
|
$php = '<?php declare(strict_types=1);
|
||||||
|
namespace Foo;
|
||||||
|
|
||||||
|
trait FooTrait {
|
||||||
|
protected function check(array $data, string $key) : void
|
||||||
|
{
|
||||||
|
array_walk($data, function(&$item) use ($key) {
|
||||||
|
// update item based on the key
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
class FooClass {
|
||||||
|
use FooTrait;
|
||||||
|
}
|
||||||
|
';
|
||||||
|
|
||||||
|
$fixture = new ContextFactory();
|
||||||
|
$context = $fixture->createForNamespace('Foo', $php);
|
||||||
|
|
||||||
|
$this->assertSame([], $context->getNamespaceAliases());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers ::createFromReflector
|
||||||
|
*/
|
||||||
|
public function testEmptyFileName(): void
|
||||||
|
{
|
||||||
|
$fixture = new ContextFactory();
|
||||||
|
$context = $fixture->createFromReflector(new ReflectionClass(stdClass::class));
|
||||||
|
|
||||||
|
$this->assertSame([], $context->getNamespaceAliases());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers ::createFromReflector
|
||||||
|
*/
|
||||||
|
public function testEvalDClass(): void
|
||||||
|
{
|
||||||
|
eval(
|
||||||
|
<<<PHP
|
||||||
|
namespace Foo;
|
||||||
|
|
||||||
|
class Bar
|
||||||
|
{
|
||||||
|
}
|
||||||
|
PHP
|
||||||
|
);
|
||||||
|
$fixture = new ContextFactory();
|
||||||
|
$context = $fixture->createFromReflector(new ReflectionClass('Foo\Bar'));
|
||||||
|
|
||||||
|
$this->assertSame([], $context->getNamespaceAliases());
|
||||||
|
}
|
||||||
|
|
||||||
|
public function assertNamespaceAliasesFrom(Context $context)
|
||||||
|
{
|
||||||
|
$expected = [
|
||||||
|
'm' => '\\' . m::class,
|
||||||
|
'DocBlock' => '\\' . DocBlock::class,
|
||||||
|
'Tag' => '\\' . Tag::class,
|
||||||
|
'Barryvdh' => '\\' . 'Barryvdh',
|
||||||
|
'TestCase' => '\\' . TestCase::class,
|
||||||
|
'Assert' => '\\' . Assert::class,
|
||||||
|
'e' => '\\' . e::class,
|
||||||
|
ReflectionClass::class => '\\' . ReflectionClass::class,
|
||||||
|
\stdClass::class => '\\' . \stdClass::class,
|
||||||
|
];
|
||||||
|
|
||||||
|
$actual = $context->getNamespaceAliases();
|
||||||
|
|
||||||
|
// sort so that order differences don't break it
|
||||||
|
asort($expected);
|
||||||
|
asort($actual);
|
||||||
|
|
||||||
|
$this->assertSame($expected, $actual);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -183,6 +183,24 @@ class ParamTagTest extends TestCase
|
|||||||
'$callback',
|
'$callback',
|
||||||
''
|
''
|
||||||
),
|
),
|
||||||
|
|
||||||
|
// array shapes
|
||||||
|
array(
|
||||||
|
'param',
|
||||||
|
'array{foo: string, bar: int} $array',
|
||||||
|
'array{foo: string, bar: int}',
|
||||||
|
array('array{foo: string, bar: int}'),
|
||||||
|
'$array',
|
||||||
|
''
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'param',
|
||||||
|
'MyArray[\'key\'] $value',
|
||||||
|
'MyArray[\'key\']',
|
||||||
|
array('MyArray[\'key\']'),
|
||||||
|
'$value',
|
||||||
|
''
|
||||||
|
)
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -119,6 +119,13 @@ class ReturnTagTest extends TestCase
|
|||||||
'array<int, string|bool>|string',
|
'array<int, string|bool>|string',
|
||||||
array('array<int, string|bool>', 'string'),
|
array('array<int, string|bool>', 'string'),
|
||||||
'Types of Bobs'
|
'Types of Bobs'
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'return',
|
||||||
|
'MyArray[\'key\'] Type of Bobs',
|
||||||
|
'MyArray[\'key\']',
|
||||||
|
array('MyArray[\'key\']'),
|
||||||
|
'Type of Bobs'
|
||||||
)
|
)
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -239,6 +239,18 @@ class CollectionTest extends TestCase
|
|||||||
'array<int, string|array<int, bool>>|array<int, float>|string',
|
'array<int, string|array<int, bool>>|array<int, float>|string',
|
||||||
array('array<int, string|array<int, bool>>', 'array<int, float>', 'string')
|
array('array<int, string|array<int, bool>>', 'array<int, float>', 'string')
|
||||||
),
|
),
|
||||||
|
array(
|
||||||
|
'array{ 0: string, 1: string|int }',
|
||||||
|
array('array{ 0: string, 1: string|int }')
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
"array{ 'key': string, 'value': string|int }",
|
||||||
|
array("array{ 'key': string, 'value': string|int }")
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
"MyArray['bar']",
|
||||||
|
array("MyArray['bar']")
|
||||||
|
),
|
||||||
array(
|
array(
|
||||||
'LinkDescriptor::setLink()',
|
'LinkDescriptor::setLink()',
|
||||||
array($namespace.'LinkDescriptor::setLink()')
|
array($namespace.'LinkDescriptor::setLink()')
|
||||||
@@ -283,6 +295,18 @@ class CollectionTest extends TestCase
|
|||||||
'iterable<string>',
|
'iterable<string>',
|
||||||
array('iterable<string>')
|
array('iterable<string>')
|
||||||
),
|
),
|
||||||
|
array(
|
||||||
|
'callable',
|
||||||
|
array('callable')
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'callable(int, string): int',
|
||||||
|
array('callable(int, string): int')
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
"'text'",
|
||||||
|
array("'text'")
|
||||||
|
)
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user