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

  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.     public function getProperties(string $class, array $context = []): ?array
  46.     {
  47.         return $this->extract($this->listExtractors, 'getProperties', [$class, $context]);
  48.     }
  50.     public function getShortDescription(string $class, string $property, array $context = []): ?string
  51.     {
  52.         return $this->extract($this->descriptionExtractors, 'getShortDescription', [$class, $property, $context]);
  53.     }
  55.     public function getLongDescription(string $class, string $property, array $context = []): ?string
  56.     {
  57.         return $this->extract($this->descriptionExtractors, 'getLongDescription', [$class, $property, $context]);
  58.     }
  60.     public function getTypes(string $class, string $property, array $context = []): ?array
  61.     {
  62.         return $this->extract($this->typeExtractors, 'getTypes', [$class, $property, $context]);
  63.     }
  65.     public function isReadable(string $class, string $property, array $context = []): ?bool
  66.     {
  67.         return $this->extract($this->accessExtractors, 'isReadable', [$class, $property, $context]);
  68.     }
  70.     public function isWritable(string $class, string $property, array $context = []): ?bool
  71.     {
  72.         return $this->extract($this->accessExtractors, 'isWritable', [$class, $property, $context]);
  73.     }
  75.     public function isInitializable(string $class, string $property, array $context = []): ?bool
  76.     {
  77.         return $this->extract($this->initializableExtractors, 'isInitializable', [$class, $property, $context]);
  78.     }
  80.     /**
  81.      * Iterates over registered extractors and return the first value found.
  82.      *
  83.      * @param iterable<mixed, object> $extractors
  84.      * @param list<mixed>             $arguments
  85.      */
  86.     private function extract(iterable $extractors, string $method, array $arguments): mixed
  87.     {
  88.         foreach ($extractors as $extractor) {
  89.             if (null !== $value = $extractor->{$method}(...$arguments)) {
  90.                 return $value;
  91.             }
  92.         }
  94.         return null;
  95.     }
  96. }