vendor/api-platform/core/src/Annotation/AttributesHydratorTrait.php line 75

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the API Platform project.
  5.  *
  6.  * (c) Kévin Dunglas <dunglas@gmail.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. declare(strict_types=1);
  14. namespace ApiPlatform\Core\Annotation;
  16. use ApiPlatform\Core\Exception\InvalidArgumentException;
  17. use ApiPlatform\Core\Util\Inflector;
  19. /**
  20.  * Hydrates attributes from annotation's parameters.
  21.  *
  22.  * @internal
  23.  *
  24.  * @author Baptiste Meyer <baptiste.meyer@gmail.com>
  25.  * @author Kévin Dunglas <dunglas@gmail.com>
  26.  */
  27. trait AttributesHydratorTrait
  28. {
  29.     private static $configMetadata;
  31.     /**
  32.      * @internal
  33.      */
  34.     public static function getConfigMetadata(): array
  35.     {
  36.         if (null !== self::$configMetadata) {
  37.             return self::$configMetadata;
  38.         }
  40.         $rc = new \ReflectionClass(self::class);
  42.         $publicProperties = [];
  43.         foreach ($rc->getProperties(\ReflectionProperty::IS_PUBLIC) as $reflectionProperty) {
  44.             $publicProperties[$reflectionProperty->getName()] = true;
  45.         }
  47.         $configurableAttributes = [];
  48.         foreach ($rc->getConstructor()->getParameters() as $param) {
  49.             if (!isset($publicProperties[$name = $param->getName()])) {
  50.                 $configurableAttributes[$name] = true;
  51.             }
  52.         }
  54.         return [$publicProperties, $configurableAttributes];
  55.     }
  57.     /**
  58.      * @var array
  59.      */
  60.     public $attributes = null;
  62.     /**
  63.      * @throws InvalidArgumentException
  64.      */
  65.     private function hydrateAttributes(array $values): void
  66.     {
  67.         if (isset($values['attributes'])) {
  68.             $this->attributes = $values['attributes'];
  69.             unset($values['attributes']);
  70.         }
  72.         foreach (self::$deprecatedAttributes as $deprecatedAttribute => $options) {
  73.             if (\array_key_exists($deprecatedAttribute, $values)) {
  74.                 $values[$options[0]] = $values[$deprecatedAttribute];
  75.                 @trigger_error(sprintf('Attribute "%s" is deprecated in annotation since API Platform %s, prefer using "%s" attribute instead', $deprecatedAttribute, $options[1], $options[0]), \E_USER_DEPRECATED);
  76.                 unset($values[$deprecatedAttribute]);
  77.             }
  78.         }
  80.         [$publicProperties, $configurableAttributes] = self::getConfigMetadata();
  81.         foreach ($values as $key => $value) {
  82.             $key = (string) $key;
  83.             if (!isset($publicProperties[$key]) && !isset($configurableAttributes[$key]) && !isset(self::$deprecatedAttributes[$key])) {
  84.                 throw new InvalidArgumentException(sprintf('Unknown property "%s" on annotation "%s".', $key, self::class));
  85.             }
  87.             if (isset($publicProperties[$key])) {
  88.                 $this->{$key} = $value;
  89.                 continue;
  90.             }
  92.             if (!\is_array($this->attributes)) {
  93.                 $this->attributes = [];
  94.             }
  96.             $this->attributes += [Inflector::tableize($key) => $value];
  97.         }
  98.     }
  99. }