Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. YamlFileLoader.php

class YamlFileLoader

Same name in this branch
  1. 11.1.x vendor/symfony/validator/Mapping/Loader/YamlFileLoader.php \Symfony\Component\Validator\Mapping\Loader\YamlFileLoader
  2. 11.1.x vendor/symfony/routing/Loader/YamlFileLoader.php \Symfony\Component\Routing\Loader\YamlFileLoader
  3. 11.1.x vendor/symfony/dependency-injection/Loader/YamlFileLoader.php \Symfony\Component\DependencyInjection\Loader\YamlFileLoader
  4. 11.1.x core/lib/Drupal/Core/DependencyInjection/YamlFileLoader.php \Drupal\Core\DependencyInjection\YamlFileLoader

YAML File Loader.

@author Kévin Dunglas <dunglas@gmail.com>

Hierarchy

  • class \Symfony\Component\Serializer\Mapping\Loader\FileLoader implements \Symfony\Component\Serializer\Mapping\Loader\LoaderInterface
    • class \Symfony\Component\Serializer\Mapping\Loader\YamlFileLoader extends \Symfony\Component\Serializer\Mapping\Loader\FileLoader

Expanded class hierarchy of YamlFileLoader

File

vendor/symfony/serializer/Mapping/Loader/YamlFileLoader.php, line 28

Namespace

Symfony\Component\Serializer\Mapping\Loader
View source
class YamlFileLoader extends FileLoader {
    private ?Parser $yamlParser = null;
    
    /**
     * An array of YAML class descriptions.
     */
    private ?array $classes = null;
    public function loadClassMetadata(ClassMetadataInterface $classMetadata) : bool {
        if (!($this->classes ??= $this->getClassesFromYaml())) {
            return false;
        }
        if (!isset($this->classes[$classMetadata->getName()])) {
            return false;
        }
        $yaml = $this->classes[$classMetadata->getName()];
        if (isset($yaml['attributes']) && \is_array($yaml['attributes'])) {
            $attributesMetadata = $classMetadata->getAttributesMetadata();
            foreach ($yaml['attributes'] as $attribute => $data) {
                if (isset($attributesMetadata[$attribute])) {
                    $attributeMetadata = $attributesMetadata[$attribute];
                }
                else {
                    $attributeMetadata = new AttributeMetadata($attribute);
                    $classMetadata->addAttributeMetadata($attributeMetadata);
                }
                if (isset($data['groups'])) {
                    if (!\is_array($data['groups'])) {
                        throw new MappingException(\sprintf('The "groups" key must be an array of strings in "%s" for the attribute "%s" of the class "%s".', $this->file, $attribute, $classMetadata->getName()));
                    }
                    foreach ($data['groups'] as $group) {
                        if (!\is_string($group)) {
                            throw new MappingException(\sprintf('Group names must be strings in "%s" for the attribute "%s" of the class "%s".', $this->file, $attribute, $classMetadata->getName()));
                        }
                        $attributeMetadata->addGroup($group);
                    }
                }
                if (isset($data['max_depth'])) {
                    if (!\is_int($data['max_depth'])) {
                        throw new MappingException(\sprintf('The "max_depth" value must be an integer in "%s" for the attribute "%s" of the class "%s".', $this->file, $attribute, $classMetadata->getName()));
                    }
                    $attributeMetadata->setMaxDepth($data['max_depth']);
                }
                if (isset($data['serialized_name'])) {
                    if (!\is_string($data['serialized_name']) || '' === $data['serialized_name']) {
                        throw new MappingException(\sprintf('The "serialized_name" value must be a non-empty string in "%s" for the attribute "%s" of the class "%s".', $this->file, $attribute, $classMetadata->getName()));
                    }
                    $attributeMetadata->setSerializedName($data['serialized_name']);
                }
                if (isset($data['serialized_path'])) {
                    try {
                        $attributeMetadata->setSerializedPath(new PropertyPath((string) $data['serialized_path']));
                    } catch (InvalidPropertyPathException) {
                        throw new MappingException(\sprintf('The "serialized_path" value must be a valid property path in "%s" for the attribute "%s" of the class "%s".', $this->file, $attribute, $classMetadata->getName()));
                    }
                }
                if (isset($data['ignore'])) {
                    if (!\is_bool($data['ignore'])) {
                        throw new MappingException(\sprintf('The "ignore" value must be a boolean in "%s" for the attribute "%s" of the class "%s".', $this->file, $attribute, $classMetadata->getName()));
                    }
                    $attributeMetadata->setIgnore($data['ignore']);
                }
                foreach ($data['contexts'] ?? [] as $line) {
                    $groups = $line['groups'] ?? [];
                    if ($context = $line['context'] ?? false) {
                        $attributeMetadata->setNormalizationContextForGroups($context, $groups);
                        $attributeMetadata->setDenormalizationContextForGroups($context, $groups);
                    }
                    if ($context = $line['normalization_context'] ?? false) {
                        $attributeMetadata->setNormalizationContextForGroups($context, $groups);
                    }
                    if ($context = $line['denormalization_context'] ?? false) {
                        $attributeMetadata->setDenormalizationContextForGroups($context, $groups);
                    }
                }
            }
        }
        if (isset($yaml['discriminator_map'])) {
            if (!isset($yaml['discriminator_map']['type_property'])) {
                throw new MappingException(\sprintf('The "type_property" key must be set for the discriminator map of the class "%s" in "%s".', $classMetadata->getName(), $this->file));
            }
            if (!isset($yaml['discriminator_map']['mapping'])) {
                throw new MappingException(\sprintf('The "mapping" key must be set for the discriminator map of the class "%s" in "%s".', $classMetadata->getName(), $this->file));
            }
            $classMetadata->setClassDiscriminatorMapping(new ClassDiscriminatorMapping($yaml['discriminator_map']['type_property'], $yaml['discriminator_map']['mapping']));
        }
        return true;
    }
    
    /**
     * Return the names of the classes mapped in this file.
     *
     * @return string[]
     */
    public function getMappedClasses() : array {
        return array_keys($this->classes ??= $this->getClassesFromYaml());
    }
    private function getClassesFromYaml() : array {
        if (!stream_is_local($this->file)) {
            throw new MappingException(\sprintf('This is not a local file "%s".', $this->file));
        }
        $this->yamlParser ??= new Parser();
        $classes = $this->yamlParser
            ->parseFile($this->file, Yaml::PARSE_CONSTANT);
        if (!$classes) {
            return [];
        }
        if (!\is_array($classes)) {
            throw new MappingException(\sprintf('The file "%s" must contain a YAML array.', $this->file));
        }
        return $classes;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
FileLoader::__construct public function
YamlFileLoader::$classes private property An array of YAML class descriptions.
YamlFileLoader::$yamlParser private property
YamlFileLoader::getClassesFromYaml private function
YamlFileLoader::getMappedClasses public function Return the names of the classes mapped in this file.
YamlFileLoader::loadClassMetadata public function Overrides LoaderInterface::loadClassMetadata
RSS feed
Powered by Drupal