Skip to content

[PropertyInfo] Implement "Collection" types in PhpDocExtractor #26300

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 26, 2018
Merged

[PropertyInfo] Implement "Collection" types in PhpDocExtractor #26300

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions src/Symfony/Component/PropertyInfo/Tests/Extractor/PhpDocExtractorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
use PHPUnit\Framework\TestCase;
use Symfony\Component\PropertyInfo\Extractor\PhpDocExtractor;
use Symfony\Component\PropertyInfo\Type;
use phpDocumentor\Reflection\Types\Collection;

/**
* @author Kévin Dunglas <dunglas@gmail.com>
Expand Down Expand Up @@ -77,6 +78,39 @@ public function typesProvider()
);
}

/**
* @dataProvider provideCollectionTypes
*/
public function testExtractCollection($property, array $type = null, $shortDescription, $longDescription)
{
if (!class_exists(Collection::class)) {
$this->markTestSkipped('Collections are not implemented in current phpdocumentor/type-resolver version');
}

$this->testExtract($property, $type, $shortDescription, $longDescription);
}

public function provideCollectionTypes()
{
return array(
array('iteratorCollection', array(new Type(Type::BUILTIN_TYPE_OBJECT, false, 'Iterator', true, null, new Type(Type::BUILTIN_TYPE_STRING))), null, null),
array('iteratorCollectionWithKey', array(new Type(Type::BUILTIN_TYPE_OBJECT, false, 'Iterator', true, new Type(Type::BUILTIN_TYPE_INT), new Type(Type::BUILTIN_TYPE_STRING))), null, null),
array(
'nestedIterators',
array(new Type(
Type::BUILTIN_TYPE_OBJECT,
false,
'Iterator',
true,
new Type(Type::BUILTIN_TYPE_INT),
new Type(Type::BUILTIN_TYPE_OBJECT, false, 'Iterator', true, new Type(Type::BUILTIN_TYPE_INT), new Type(Type::BUILTIN_TYPE_STRING))
)),
null,
null,
),
);
}

public function testParamTagTypeIsOmitted()
{
$this->assertNull($this->extractor->getTypes(OmittedParamTagTypeDocBlock::class, 'omittedType'));
Expand Down
9 changes: 9 additions & 0 deletions src/Symfony/Component/PropertyInfo/Tests/Extractor/ReflectionExtractorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ public function testGetProperties()
'Guid',
'array',
'emptyVar',
'iteratorCollection',
'iteratorCollectionWithKey',
'nestedIterators',
'foo',
'foo2',
'foo3',
Expand Down Expand Up @@ -79,6 +82,9 @@ public function testGetPropertiesWithCustomPrefixes()
'Guid',
'array',
'emptyVar',
'iteratorCollection',
'iteratorCollectionWithKey',
'nestedIterators',
'foo',
'foo2',
'foo3',
Expand Down Expand Up @@ -107,6 +113,9 @@ public function testGetPropertiesWithNoPrefixes()
'Guid',
'array',
'emptyVar',
'iteratorCollection',
'iteratorCollectionWithKey',
'nestedIterators',
'foo',
'foo2',
'foo3',
Expand Down
15 changes: 15 additions & 0 deletions src/Symfony/Component/PropertyInfo/Tests/Fixtures/Dummy.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,21 @@ class Dummy extends ParentDummy
*/
public $emptyVar;

/**
* @var \Iterator<string>
*/
public $iteratorCollection;

/**
* @var \Iterator<integer,string>
*/
public $iteratorCollectionWithKey;

/**
* @var \Iterator<integer,\Iterator<integer,string>>
*/
public $nestedIterators;

public static function getStatic()
{
}
Expand Down
36 changes: 26 additions & 10 deletions src/Symfony/Component/PropertyInfo/Util/PhpDocTypeHelper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
namespace Symfony\Component\PropertyInfo\Util;

use phpDocumentor\Reflection\Type as DocType;
use phpDocumentor\Reflection\Types\Collection;
use phpDocumentor\Reflection\Types\Compound;
use phpDocumentor\Reflection\Types\Null_;
use Symfony\Component\PropertyInfo\Type;
Expand Down Expand Up @@ -39,7 +40,7 @@ public function getTypes(DocType $varType): array
$nullable = true;
}

$type = $this->createType((string) $varType, $nullable);
$type = $this->createType($varType, $nullable);
if (null !== $type) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can inline this IMO

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah since you are not modifying it, forgot about this ;). It will be harder to merge things back to master.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I tried to modify as few lines as possible, to keep diffs shorts.

$types[] = $type;
}
Expand All @@ -49,16 +50,15 @@ public function getTypes(DocType $varType): array

$varTypes = array();
for ($typeIndex = 0; $varType->has($typeIndex); ++$typeIndex) {
$varTypes[] = (string) $varType->get($typeIndex);
}
$type = $varType->get($typeIndex);

// If null is present, all types are nullable
$nullKey = array_search(Type::BUILTIN_TYPE_NULL, $varTypes);
$nullable = false !== $nullKey;
// If null is present, all types are nullable
if ($type instanceof Null_) {
$nullable = true;
continue;
}

// Remove the null type from the type if other types are defined
if ($nullable && count($varTypes) > 1) {
unset($varTypes[$nullKey]);
$varTypes[] = $type;
}

foreach ($varTypes as $varType) {
Expand All @@ -74,8 +74,24 @@ public function getTypes(DocType $varType): array
/**
* Creates a {@see Type} from a PHPDoc type.
*/
private function createType(string $docType, bool $nullable): ?Type
private function createType(DocType $type, bool $nullable): ?Type
{
$docType = (string) $type;

if ($type instanceof Collection) {
list($phpType, $class) = $this->getPhpTypeAndClass((string) $type->getFqsen());

$key = $this->getTypes($type->getKeyType());
$value = $this->getTypes($type->getValueType());

// More than 1 type returned means it is a Compound type, which is
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think we can improve the type VO (it's a final class exactly for this reason) to support this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess it could be done without much shenanigans (adding a counpound internal type, and a property holding composing types).

But i'm afraid that would be a breaking change, as the component will start to return non-null types where it previously did.

// not handled by Type, so better use a null value.
$key = 1 === \count($key) ? $key[0] : null;
$value = 1 === \count($value) ? $value[0] : null;

return new Type($phpType, $nullable, $class, true, $key, $value);
}

// Cannot guess
if (!$docType || 'mixed' === $docType) {
return null;
Expand Down