Gecko [ unitednationsplay.com ]

Name	Size	Permission	Date	Action
PhpDocTypeHelper.php	5.24 KB	-rw-r--r--	2020-12-11 09:00

Rename

<?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\Array_;
use phpDocumentor\Reflection\Types\Collection;
use phpDocumentor\Reflection\Types\Compound;
use phpDocumentor\Reflection\Types\Null_;
use phpDocumentor\Reflection\Types\Nullable;
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): array
    {
        $types = [];
        $nullable = false;

if ($varType instanceof Nullable) {
            $nullable = true;
            $varType = $varType->getActualType();
        }

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

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

return $types;
        }

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

// If null is present, all types are nullable
            if ($type instanceof Null_) {
                $nullable = true;
                continue;
            }

if ($type instanceof Nullable) {
                $nullable = true;
                $type = $type->getActualType();
            }

$varTypes[] = $type;
        }

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

return $types;
    }

/**
     * Creates a {@see Type} from a PHPDoc type.
     */
    private function createType(DocType $type, bool $nullable, string $docType = null): ?Type
    {
        $docType = $docType ?? (string) $type;

if ($type instanceof Collection) {
            [$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
            // 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;
        }

if ('[]' === substr($docType, -2)) {
            $collectionKeyType = new Type(Type::BUILTIN_TYPE_INT);
            $collectionValueType = $this->createType($type, false, substr($docType, 0, -2));

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

if (0 === strpos($docType, 'array<') && $type instanceof Array_) {
            // array<value> is converted to x[] which is handled above
            // so it's only necessary to handle array<key, value> here
            $collectionKeyType = $this->getTypes($type->getKeyType())[0];

$collectionValueTypes = $this->getTypes($type->getValueType());
            if (\count($collectionValueTypes) != 1) {
                // the Type class does not support union types yet, so assume that no type was defined
                $collectionValueType = null;
            } else {
                $collectionValueType = $collectionValueTypes[0];
            }

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

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

if ('array' === $docType) {
            return new Type(Type::BUILTIN_TYPE_ARRAY, $nullable, null, true, null, null);
        }

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

private function normalizeType(string $docType): string
    {
        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;
        }
    }

private function getPhpTypeAndClass(string $docType): array
    {
        if (\in_array($docType, Type::$builtinTypes)) {
            return [$docType, null];
        }

return ['object', substr($docType, 1)]; // substr to strip the namespace's `\`-prefix
    }
}