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

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