Skip to content

[PropertyInfo] Extract the logic converting a php doc to a Type #19484

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
Sep 14, 2016
Merged

[PropertyInfo] Extract the logic converting a php doc to a Type #19484

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
135 changes: 8 additions & 127 deletions src/Symfony/Component/PropertyInfo/Extractor/PhpDocExtractor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,11 @@
use phpDocumentor\Reflection\DocBlock;
use phpDocumentor\Reflection\DocBlockFactory;
use phpDocumentor\Reflection\DocBlockFactoryInterface;
use phpDocumentor\Reflection\Types\Compound;
use phpDocumentor\Reflection\Types\ContextFactory;
use phpDocumentor\Reflection\Types\Null_;
use Symfony\Component\PropertyInfo\PropertyDescriptionExtractorInterface;
use Symfony\Component\PropertyInfo\PropertyTypeExtractorInterface;
use Symfony\Component\PropertyInfo\Type;
use Symfony\Component\PropertyInfo\Util\PhpDocTypeHelper;

/**
* Extracts data using a PHPDoc parser.
Expand Down Expand Up @@ -47,10 +46,16 @@ class PhpDocExtractor implements PropertyDescriptionExtractorInterface, Property
*/
private $contextFactory;

/**
* @var PhpDocTypeHelper
*/
private $phpDocTypeHelper;

public function __construct(DocBlockFactoryInterface $docBlockFactory = null)
{
$this->docBlockFactory = $docBlockFactory ?: DocBlockFactory::createInstance();
$this->contextFactory = new ContextFactory();
$this->phpDocTypeHelper = new PhpDocTypeHelper();
}

/**
Expand Down Expand Up @@ -123,45 +128,7 @@ public function getTypes($class, $property, array $context = array())
$types = array();
/** @var DocBlock\Tags\Var_|DocBlock\Tags\Return_|DocBlock\Tags\Param $tag */
foreach ($docBlock->getTagsByName($tag) as $tag) {
$varType = $tag->getType();
$nullable = false;

if (!$varType instanceof Compound) {
if ($varType instanceof Null_) {
$nullable = true;
}

$type = $this->createType((string) $varType, $nullable);

if (null !== $type) {
$types[] = $type;
}

continue;
}

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

// If null is present, all types are nullable
$nullKey = array_search(Type::BUILTIN_TYPE_NULL, $varTypes);
$nullable = false !== $nullKey;

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

foreach ($varTypes as $varType) {
$type = $this->createType($varType, $nullable);
if (null !== $type) {
$types[] = $type;
}
}
$types = array_merge($types, $this->phpDocTypeHelper->getTypes($tag->getType()));
}

if (!isset($types[0])) {
Expand Down Expand Up @@ -274,90 +241,4 @@ private function getDocBlockFromMethod($class, $ucFirstProperty, $type)

return array($this->docBlockFactory->create($reflectionMethod, $this->contextFactory->createFromReflector($reflectionMethod)), $prefix);
}

/**
* Creates a {@see Type} from a PHPDoc type.
*
* @param string $docType
* @param bool $nullable
*
* @return Type|null
*/
private function createType($docType, $nullable)
{
// Cannot guess
if (!$docType || 'mixed' === $docType) {
return;
}

if ($collection = '[]' === substr($docType, -2)) {
$docType = substr($docType, 0, -2);
}

$docType = $this->normalizeType($docType);
list($phpType, $class) = $this->getPhpTypeAndClass($docType);

$array = 'array' === $docType;

if ($collection || $array) {
if ($array || 'mixed' === $docType) {
$collectionKeyType = null;
$collectionValueType = null;
} else {
$collectionKeyType = new Type(Type::BUILTIN_TYPE_INT);
$collectionValueType = new Type($phpType, false, $class);
}

return new Type(Type::BUILTIN_TYPE_ARRAY, false, null, true, $collectionKeyType, $collectionValueType);
}

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

/**
* Normalizes the type.
*
* @param string $docType
*
* @return string
*/
private function normalizeType($docType)
{
switch ($docType) {
case 'integer':
return 'int';

case 'boolean':
return 'bool';

// real is not part of the PHPDoc standard, so we ignore it
case 'double':
return 'float';

case 'callback':
return 'callable';

case 'void':
return 'null';

default:
return $docType;
}
}

/**
* Gets an array containing the PHP type and the class.
*
* @param string $docType
*
* @return array
*/
private function getPhpTypeAndClass($docType)
{
if (in_array($docType, Type::$builtinTypes)) {
return array($docType, null);
}

return array('object', substr($docType, 1));
}
}
159 changes: 159 additions & 0 deletions src/Symfony/Component/PropertyInfo/Util/PhpDocTypeHelper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
<?php

/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Symfony\Component\PropertyInfo\Util;

use phpDocumentor\Reflection\Type as DocType;
use phpDocumentor\Reflection\Types\Compound;
use phpDocumentor\Reflection\Types\Null_;
use Symfony\Component\PropertyInfo\Type;

/**
* Transforms a php doc type to a {@link Type} instance.
*
* @author Kévin Dunglas <dunglas@gmail.com>
* @author Guilhem N. <egetick@gmail.com>
*/
final class PhpDocTypeHelper
{
/**
* Creates a {@see Type} from a PHPDoc type.
*
* @return Type
*/
public function getTypes(DocType $varType)
{
$types = array();
$nullable = false;

if (!$varType instanceof Compound) {
if ($varType instanceof Null_) {
$nullable = true;
}

$type = $this->createType((string) $varType, $nullable);
if (null !== $type) {
$types[] = $type;
}

return $types;
}

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

// If null is present, all types are nullable
$nullKey = array_search(Type::BUILTIN_TYPE_NULL, $varTypes);
$nullable = false !== $nullKey;

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

foreach ($varTypes as $varType) {
$type = $this->createType($varType, $nullable);
if (null !== $type) {
$types[] = $type;
}
}

return $types;
}

/**
* Creates a {@see Type} from a PHPDoc type.
*
* @param string $docType
* @param bool $nullable
*
* @return Type|null
*/
private function createType($docType, $nullable)
{
// Cannot guess
if (!$docType || 'mixed' === $docType) {
return;
}

if ($collection = '[]' === substr($docType, -2)) {
$docType = substr($docType, 0, -2);
}

$docType = $this->normalizeType($docType);
list($phpType, $class) = $this->getPhpTypeAndClass($docType);

$array = 'array' === $docType;

if ($collection || $array) {
if ($array || 'mixed' === $docType) {
$collectionKeyType = null;
$collectionValueType = null;
} else {
$collectionKeyType = new Type(Type::BUILTIN_TYPE_INT);
$collectionValueType = new Type($phpType, false, $class);
}

return new Type(Type::BUILTIN_TYPE_ARRAY, false, null, true, $collectionKeyType, $collectionValueType);
}

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

/**
* Normalizes the type.
*
* @param string $docType
*
* @return string
*/
private function normalizeType($docType)
{
switch ($docType) {
case 'integer':
return 'int';

case 'boolean':
return 'bool';

// real is not part of the PHPDoc standard, so we ignore it
case 'double':
return 'float';

case 'callback':
return 'callable';

case 'void':
return 'null';

default:
return $docType;
}
}

/**
* Gets an array containing the PHP type and the class.
*
* @param string $docType
*
* @return array
*/
private function getPhpTypeAndClass($docType)
{
if (in_array($docType, Type::$builtinTypes)) {
return array($docType, null);
}

return array('object', substr($docType, 1));
}
}