vendor/symfony/property-info/PropertyInfoExtractor.php line 88

Open in your IDE?
  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.  * Default {@see PropertyInfoExtractorInterface} implementation.
  16.  *
  17.  * @author Kévin Dunglas <dunglas@gmail.com>
  18.  *
  19.  * @final
  20.  */
  21. class PropertyInfoExtractor implements PropertyInfoExtractorInterface, PropertyInitializableExtractorInterface
  22. {
  23.     private $listExtractors;
  24.     private $typeExtractors;
  25.     private $descriptionExtractors;
  26.     private $accessExtractors;
  27.     private $initializableExtractors;
  29.     /**
  30.      * @param iterable<mixed, PropertyListExtractorInterface>          $listExtractors
  31.      * @param iterable<mixed, PropertyTypeExtractorInterface>          $typeExtractors
  32.      * @param iterable<mixed, PropertyDescriptionExtractorInterface>   $descriptionExtractors
  33.      * @param iterable<mixed, PropertyAccessExtractorInterface>        $accessExtractors
  34.      * @param iterable<mixed, PropertyInitializableExtractorInterface> $initializableExtractors
  35.      */
  36.     public function __construct(iterable $listExtractors = [], iterable $typeExtractors = [], iterable $descriptionExtractors = [], iterable $accessExtractors = [], iterable $initializableExtractors = [])
  37.     {
  38.         $this->listExtractors = $listExtractors;
  39.         $this->typeExtractors = $typeExtractors;
  40.         $this->descriptionExtractors = $descriptionExtractors;
  41.         $this->accessExtractors = $accessExtractors;
  42.         $this->initializableExtractors = $initializableExtractors;
  43.     }
  45.     /**
  46.      * {@inheritdoc}
  47.      */
  48.     public function getProperties(string $class, array $context = []): ?array
  49.     {
  50.         return $this->extract($this->listExtractors, 'getProperties', [$class, $context]);
  51.     }
  53.     /**
  54.      * {@inheritdoc}
  55.      */
  56.     public function getShortDescription(string $class, string $property, array $context = []): ?string
  57.     {
  58.         return $this->extract($this->descriptionExtractors, 'getShortDescription', [$class, $property, $context]);
  59.     }
  61.     /**
  62.      * {@inheritdoc}
  63.      */
  64.     public function getLongDescription(string $class, string $property, array $context = []): ?string
  65.     {
  66.         return $this->extract($this->descriptionExtractors, 'getLongDescription', [$class, $property, $context]);
  67.     }
  69.     /**
  70.      * {@inheritdoc}
  71.      */
  72.     public function getTypes(string $class, string $property, array $context = []): ?array
  73.     {
  74.         return $this->extract($this->typeExtractors, 'getTypes', [$class, $property, $context]);
  75.     }
  77.     /**
  78.      * {@inheritdoc}
  79.      */
  80.     public function isReadable(string $class, string $property, array $context = []): ?bool
  81.     {
  82.         return $this->extract($this->accessExtractors, 'isReadable', [$class, $property, $context]);
  83.     }
  85.     /**
  86.      * {@inheritdoc}
  87.      */
  88.     public function isWritable(string $class, string $property, array $context = []): ?bool
  89.     {
  90.         return $this->extract($this->accessExtractors, 'isWritable', [$class, $property, $context]);
  91.     }
  93.     /**
  94.      * {@inheritdoc}
  95.      */
  96.     public function isInitializable(string $class, string $property, array $context = []): ?bool
  97.     {
  98.         return $this->extract($this->initializableExtractors, 'isInitializable', [$class, $property, $context]);
  99.     }
  101.     /**
  102.      * Iterates over registered extractors and return the first value found.
  103.      *
  104.      * @param iterable<mixed, object> $extractors
  105.      * @param list<mixed>             $arguments
  106.      *
  107.      * @return mixed
  108.      */
  109.     private function extract(iterable $extractors, string $method, array $arguments)
  110.     {
  111.         foreach ($extractors as $extractor) {
  112.             if (null !== $value = $extractor->{$method}(...$arguments)) {
  113.                 return $value;
  114.             }
  115.         }
  117.         return null;
  118.     }
  119. }