vendor/symfony/property-info/Type.php line 79

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\PropertyInfo;
  14. /**
  15.  * Type value object (immutable).
  16.  *
  17.  * @author Kévin Dunglas <dunglas@gmail.com>
  18.  *
  19.  * @final
  20.  */
  21. class Type
  22. {
  23.     public const BUILTIN_TYPE_INT = 'int';
  24.     public const BUILTIN_TYPE_FLOAT = 'float';
  25.     public const BUILTIN_TYPE_STRING = 'string';
  26.     public const BUILTIN_TYPE_BOOL = 'bool';
  27.     public const BUILTIN_TYPE_RESOURCE = 'resource';
  28.     public const BUILTIN_TYPE_OBJECT = 'object';
  29.     public const BUILTIN_TYPE_ARRAY = 'array';
  30.     public const BUILTIN_TYPE_NULL = 'null';
  31.     public const BUILTIN_TYPE_FALSE = 'false';
  32.     public const BUILTIN_TYPE_TRUE = 'true';
  33.     public const BUILTIN_TYPE_CALLABLE = 'callable';
  34.     public const BUILTIN_TYPE_ITERABLE = 'iterable';
  36.     /**
  37.      * List of PHP builtin types.
  38.      *
  39.      * @var string[]
  40.      */
  41.     public static $builtinTypes = [
  42.         self::BUILTIN_TYPE_INT,
  43.         self::BUILTIN_TYPE_FLOAT,
  44.         self::BUILTIN_TYPE_STRING,
  45.         self::BUILTIN_TYPE_BOOL,
  46.         self::BUILTIN_TYPE_RESOURCE,
  47.         self::BUILTIN_TYPE_OBJECT,
  48.         self::BUILTIN_TYPE_ARRAY,
  49.         self::BUILTIN_TYPE_CALLABLE,
  50.         self::BUILTIN_TYPE_FALSE,
  51.         self::BUILTIN_TYPE_TRUE,
  52.         self::BUILTIN_TYPE_NULL,
  53.         self::BUILTIN_TYPE_ITERABLE,
  54.     ];
  56.     /**
  57.      * List of PHP builtin collection types.
  58.      *
  59.      * @var string[]
  60.      */
  61.     public static $builtinCollectionTypes = [
  62.         self::BUILTIN_TYPE_ARRAY,
  63.         self::BUILTIN_TYPE_ITERABLE,
  64.     ];
  66.     private $builtinType;
  67.     private $nullable;
  68.     private $class;
  69.     private $collection;
  70.     private $collectionKeyType;
  71.     private $collectionValueType;
  73.     /**
  74.      * @param Type[]|Type|null $collectionKeyType
  75.      * @param Type[]|Type|null $collectionValueType
  76.      *
  77.      * @throws \InvalidArgumentException
  78.      */
  79.     public function __construct(string $builtinType, bool $nullable = false, string $class = null, bool $collection = false, array|Type $collectionKeyType = null, array|Type $collectionValueType = null)
  80.     {
  81.         if (!\in_array($builtinType, self::$builtinTypes)) {
  82.             throw new \InvalidArgumentException(sprintf('"%s" is not a valid PHP type.', $builtinType));
  83.         }
  85.         $this->builtinType = $builtinType;
  86.         $this->nullable = $nullable;
  87.         $this->class = $class;
  88.         $this->collection = $collection;
  89.         $this->collectionKeyType = $this->validateCollectionArgument($collectionKeyType, 5, '$collectionKeyType') ?? [];
  90.         $this->collectionValueType = $this->validateCollectionArgument($collectionValueType, 6, '$collectionValueType') ?? [];
  91.     }
  93.     private function validateCollectionArgument(array|Type|null $collectionArgument, int $argumentIndex, string $argumentName): ?array
  94.     {
  95.         if (null === $collectionArgument) {
  96.             return null;
  97.         }
  99.         if (\is_array($collectionArgument)) {
  100.             foreach ($collectionArgument as $type) {
  101.                 if (!$type instanceof self) {
  102.                     throw new \TypeError(sprintf('"%s()": Argument #%d (%s) must be of type "%s[]", "%s" or "null", array value "%s" given.', __METHOD__, $argumentIndex, $argumentName, self::class, self::class, get_debug_type($collectionArgument)));
  103.                 }
  104.             }
  106.             return $collectionArgument;
  107.         }
  109.         return [$collectionArgument];
  110.     }
  112.     /**
  113.      * Gets built-in type.
  114.      *
  115.      * Can be bool, int, float, string, array, object, resource, null, callback or iterable.
  116.      */
  117.     public function getBuiltinType(): string
  118.     {
  119.         return $this->builtinType;
  120.     }
  122.     public function isNullable(): bool
  123.     {
  124.         return $this->nullable;
  125.     }
  127.     /**
  128.      * Gets the class name.
  129.      *
  130.      * Only applicable if the built-in type is object.
  131.      */
  132.     public function getClassName(): ?string
  133.     {
  134.         return $this->class;
  135.     }
  137.     public function isCollection(): bool
  138.     {
  139.         return $this->collection;
  140.     }
  142.     /**
  143.      * Gets collection key types.
  144.      *
  145.      * Only applicable for a collection type.
  146.      *
  147.      * @return Type[]
  148.      */
  149.     public function getCollectionKeyTypes(): array
  150.     {
  151.         return $this->collectionKeyType;
  152.     }
  154.     /**
  155.      * Gets collection value types.
  156.      *
  157.      * Only applicable for a collection type.
  158.      *
  159.      * @return Type[]
  160.      */
  161.     public function getCollectionValueTypes(): array
  162.     {
  163.         return $this->collectionValueType;
  164.     }
  165. }