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

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. * @final
  15. *
  16. * @internal
  17. */
  18. class MetadataReader
  19. {
  20. /**
  21. * @var AdvancedMetadataFactoryInterface
  22. */
  23. protected $reader;
  25. /**
  26. * Constructs a new instance of the MetadataReader.
  27. *
  28. * @param AdvancedMetadataFactoryInterface $reader The "low-level" metadata reader
  29. */
  30. public function __construct(AdvancedMetadataFactoryInterface $reader)
  31. {
  32. $this->reader = $reader;
  33. }
  35. /**
  36. * Tells if the given class is uploadable.
  37. *
  38. * @param string $class The class name to test (FQCN)
  39. * @param string|null $mapping If given, also checks that the object has the given mapping
  40. *
  41. * @throws MappingNotFoundException
  42. */
  43. public function isUploadable(string $class, ?string $mapping = null): bool
  44. {
  45. $metadata = $this->reader->getMetadataForClass($class);
  47. if (null === $metadata) {
  48. return false;
  49. }
  51. if (null === $mapping) {
  52. return true;
  53. }
  55. foreach ($this->getUploadableFields($class) as $fieldMetadata) {
  56. if ($fieldMetadata['mapping'] === $mapping) {
  57. return true;
  58. }
  59. }
  61. return false;
  62. }
  64. /**
  65. * Search for all uploadable classes.
  66. *
  67. * @return array|null A list of uploadable class names
  68. *
  69. * @throws \RuntimeException
  70. */
  71. public function getUploadableClasses(): ?array
  72. {
  73. return $this->reader->getAllClassNames();
  74. }
  76. /**
  77. * Attempts to read the uploadable fields.
  78. *
  79. * @param string $class The class name to test (FQCN)
  80. * @param string|null $mapping If given, also checks that the object has the given mapping
  81. *
  82. * @return array A list of uploadable fields
  83. *
  84. * @throws MappingNotFoundException
  85. */
  86. public function getUploadableFields(string $class, ?string $mapping = null): array
  87. {
  88. if (null === $metadata = $this->reader->getMetadataForClass($class)) {
  89. throw MappingNotFoundException::createNotFoundForClass($mapping ?? '', $class);
  90. }
  91. $uploadableFields = [];
  93. /** @var ClassMetadata $classMetadata */
  94. foreach ($metadata->classMetadata as $classMetadata) {
  95. $uploadableFields = \array_merge($uploadableFields, $classMetadata->fields);
  96. }
  98. if (null !== $mapping) {
  99. $uploadableFields = \array_filter($uploadableFields, static function (array $fieldMetadata) use ($mapping): bool {
  100. return $fieldMetadata['mapping'] === $mapping;
  101. });
  102. }
  104. return $uploadableFields;
  105. }
  107. /**
  108. * Attempts to read the mapping of a specified property.
  109. *
  110. * @param string $class The class name to test (FQCN)
  111. * @param string $field The field
  112. *
  113. * @return mixed The field mapping
  114. *
  115. * @throws MappingNotFoundException
  116. */
  117. public function getUploadableField(string $class, string $field)
  118. {
  119. $fieldsMetadata = $this->getUploadableFields($class);
  121. return $fieldsMetadata[$field] ?? null;
  122. }
  123. }