vendor/vich/uploader-bundle/src/Metadata/MetadataReader.php line 42

Open in your IDE?
  1. <?php
  3. namespace Vich\UploaderBundle\Metadata;
  5. use Metadata\AdvancedMetadataFactoryInterface;
  6. use Vich\UploaderBundle\Exception\MappingNotFoundException;
  8. /**
  9.  * MetadataReader.
  10.  *
  11.  * Exposes a simple interface to read objects metadata.
  12.  *
  13.  * @author Kévin Gomez <contact@kevingomez.fr>
  14.  */
  15. class MetadataReader
  16. {
  17.     /**
  18.      * @var AdvancedMetadataFactoryInterface
  19.      */
  20.     protected $reader;
  22.     /**
  23.      * Constructs a new instance of the MetadataReader.
  24.      *
  25.      * @param AdvancedMetadataFactoryInterface $reader The "low-level" metadata reader
  26.      */
  27.     public function __construct(AdvancedMetadataFactoryInterface $reader)
  28.     {
  29.         $this->reader = $reader;
  30.     }
  32.     /**
  33.      * Tells if the given class is uploadable.
  34.      *
  35.      * @param string      $class   The class name to test (FQCN)
  36.      * @param string|null $mapping If given, also checks that the object has the given mapping
  37.      *
  38.      * @throws MappingNotFoundException
  39.      */
  40.     public function isUploadable(string $class, ?string $mapping = null): bool
  41.     {
  42.         $metadata = $this->reader->getMetadataForClass($class);
  44.         if (null === $metadata) {
  45.             return false;
  46.         }
  48.         if (null === $mapping) {
  49.             return true;
  50.         }
  52.         foreach ($this->getUploadableFields($class) as $fieldMetadata) {
  53.             if ($fieldMetadata['mapping'] === $mapping) {
  54.                 return true;
  55.             }
  56.         }
  58.         return false;
  59.     }
  61.     /**
  62.      * Search for all uploadable classes.
  63.      *
  64.      * @return array|null A list of uploadable class names
  65.      *
  66.      * @throws \RuntimeException
  67.      */
  68.     public function getUploadableClasses(): ?array
  69.     {
  70.         return $this->reader->getAllClassNames();
  71.     }
  73.     /**
  74.      * Attempts to read the uploadable fields.
  75.      *
  76.      * @param string      $class   The class name to test (FQCN)
  77.      * @param string|null $mapping If given, also checks that the object has the given mapping
  78.      *
  79.      * @return array A list of uploadable fields
  80.      *
  81.      * @throws MappingNotFoundException
  82.      */
  83.     public function getUploadableFields(string $class, ?string $mapping = null): array
  84.     {
  85.         if (null === $metadata = $this->reader->getMetadataForClass($class)) {
  86.             throw MappingNotFoundException::createNotFoundForClass($mapping ?? '', $class);
  87.         }
  88.         $uploadableFields = [];
  90.         /** @var ClassMetadata $classMetadata */
  91.         foreach ($metadata->classMetadata as $classMetadata) {
  92.             $uploadableFields = \array_merge($uploadableFields, $classMetadata->fields);
  93.         }
  95.         if (null !== $mapping) {
  96.             $uploadableFields = \array_filter($uploadableFields, static function (array $fieldMetadata) use ($mapping): bool {
  97.                 return $fieldMetadata['mapping'] === $mapping;
  98.             });
  99.         }
  101.         return $uploadableFields;
  102.     }
  104.     /**
  105.      * Attempts to read the mapping of a specified property.
  106.      *
  107.      * @param string $class The class name to test (FQCN)
  108.      * @param string $field The field
  109.      *
  110.      * @return mixed The field mapping
  111.      *
  112.      * @throws MappingNotFoundException
  113.      */
  114.     public function getUploadableField(string $class, string $field)
  115.     {
  116.         $fieldsMetadata = $this->getUploadableFields($class);
  118.         return $fieldsMetadata[$field] ?? null;
  119.     }
  120. }