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

Fixed parsing of string literals and array shapes (#27)

Browse Source
This commit is contained in:
Nereo Berardozzi
2025-01-18 20:26:32 +01:00
committed by GitHub
parent ffb733ef78
commit b6ff9f9360
5 changed files with 57 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/Barryvdh/Reflection/DocBlock/Tag/ParamTag.php
+7 -8
View File
@@ -54,16 +54,15 @@ class ParamTag extends ReturnTag
for($pos = 0, $stacks = []; $pos < strlen($rest); $pos++) {
$char = $rest[$pos];
if($char === '<') {
if(in_array($char, ['<', '(', '[', '{'])) {
array_unshift($stacks, $char);
}
if($char === '(') {
array_unshift($stacks, $char);
}
if($char === '>' && isset($stacks[0]) && $stacks[0] === '<') {
array_shift($stacks);
}
if($char === ')' && isset($stacks[0]) && $stacks[0] === '(') {
if(
($char === '>' && isset($stacks[0]) && $stacks[0] === '<')
|| ($char === ')' && isset($stacks[0]) && $stacks[0] === '(')
|| ($char === ']' && isset($stacks[0]) && $stacks[0] === '[')
|| ($char === '}' && isset($stacks[0]) && $stacks[0] === '{')
) {
array_shift($stacks);
}
src/Barryvdh/Reflection/DocBlock/Type/Collection.php
+9 -3
View File
@@ -161,9 +161,9 @@ class Collection extends \ArrayObject
$type_parts[] = $curr_type;
$curr_type = '';
} else {
if ($char === '<' || $char === '(') {
if (in_array($char, ['<', '(', '[', '{'])) {
$nest_level++;
} else if ($char === '>' || $char === ')') {
} else if (in_array($char, ['>', ')', ']', '}'])) {
$nest_level--;
}
@@ -201,7 +201,8 @@ class Collection extends \ArrayObject
return '';
}
if (preg_match('/^[\w-]+<.*>$/', $type)) {
// Check for generics values and array shapes
if (preg_match('/^[\w-]+(<.+>|\[.+\]|{.+})$/', $type)) {
return $type;
}
@@ -214,6 +215,11 @@ class Collection extends \ArrayObject
return $type;
}
// Literal strings
if ($type[0] === '"' || $type[0] === "'") {
return $type;
}
if ($this->isTypeAnArray($type)) {
return $this->expand(substr($type, 0, -2)) . self::OPERATOR_ARRAY;
}
tests/Barryvdh/Reflection/DocBlock/Tag/ParamTagTest.php
+18
View File
@@ -183,6 +183,24 @@ class ParamTagTest extends TestCase
'$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',
''
)
);
}
}
tests/Barryvdh/Reflection/DocBlock/Tag/ReturnTagTest.php
+7
View File
@@ -119,6 +119,13 @@ class ReturnTagTest extends TestCase
'array<int, string|bool>|string',
array('array<int, string|bool>', 'string'),
'Types of Bobs'
),
array(
'return',
'MyArray[\'key\'] Type of Bobs',
'MyArray[\'key\']',
array('MyArray[\'key\']'),
'Type of Bobs'
)
);
}
tests/Barryvdh/Reflection/DocBlock/Type/CollectionTest.php
+16
View File
@@ -239,6 +239,18 @@ class CollectionTest extends TestCase
'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(
'LinkDescriptor::setLink()',
array($namespace.'LinkDescriptor::setLink()')
@@ -290,6 +302,10 @@ class CollectionTest extends TestCase
array(
'callable(int, string): int',
array('callable(int, string): int')
),
array(
"'text'",
array("'text'")
)
);
}