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

Breadcrumb

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

class XmlFileLoader

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

Loads XML mapping files.

@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\XmlFileLoader extends \Symfony\Component\Serializer\Mapping\Loader\FileLoader

Expanded class hierarchy of XmlFileLoader

File

vendor/symfony/serializer/Mapping/Loader/XmlFileLoader.php, line 27

Namespace

Symfony\Component\Serializer\Mapping\Loader
View source
class XmlFileLoader extends FileLoader {
    
    /**
     * An array of {@class \SimpleXMLElement} instances.
     *
     * @var \SimpleXMLElement[]|null
     */
    private ?array $classes = null;
    public function loadClassMetadata(ClassMetadataInterface $classMetadata) : bool {
        if (!($this->classes ??= $this->getClassesFromXml())) {
            return false;
        }
        $attributesMetadata = $classMetadata->getAttributesMetadata();
        if (isset($this->classes[$classMetadata->getName()])) {
            $xml = $this->classes[$classMetadata->getName()];
            foreach ($xml->attribute as $attribute) {
                $attributeName = (string) $attribute['name'];
                if (isset($attributesMetadata[$attributeName])) {
                    $attributeMetadata = $attributesMetadata[$attributeName];
                }
                else {
                    $attributeMetadata = new AttributeMetadata($attributeName);
                    $classMetadata->addAttributeMetadata($attributeMetadata);
                }
                foreach ($attribute->group as $group) {
                    $attributeMetadata->addGroup((string) $group);
                }
                if (isset($attribute['max-depth'])) {
                    $attributeMetadata->setMaxDepth((int) $attribute['max-depth']);
                }
                if (isset($attribute['serialized-name'])) {
                    $attributeMetadata->setSerializedName((string) $attribute['serialized-name']);
                }
                if (isset($attribute['serialized-path'])) {
                    try {
                        $attributeMetadata->setSerializedPath(new PropertyPath((string) $attribute['serialized-path']));
                    } catch (InvalidPropertyPathException) {
                        throw new MappingException(\sprintf('The "serialized-path" value must be a valid property path for the attribute "%s" of the class "%s".', $attributeName, $classMetadata->getName()));
                    }
                }
                if (isset($attribute['ignore'])) {
                    $attributeMetadata->setIgnore(XmlUtils::phpize($attribute['ignore']));
                }
                foreach ($attribute->context as $node) {
                    $groups = (array) $node->group;
                    $context = $this->parseContext($node->entry);
                    $attributeMetadata->setNormalizationContextForGroups($context, $groups);
                    $attributeMetadata->setDenormalizationContextForGroups($context, $groups);
                }
                foreach ($attribute->normalization_context as $node) {
                    $groups = (array) $node->group;
                    $context = $this->parseContext($node->entry);
                    $attributeMetadata->setNormalizationContextForGroups($context, $groups);
                }
                foreach ($attribute->denormalization_context as $node) {
                    $groups = (array) $node->group;
                    $context = $this->parseContext($node->entry);
                    $attributeMetadata->setDenormalizationContextForGroups($context, $groups);
                }
            }
            if (isset($xml->{'discriminator-map'})) {
                $mapping = [];
                foreach ($xml->{'discriminator-map'}->mapping as $element) {
                    $elementAttributes = $element->attributes();
                    $mapping[(string) $elementAttributes->type] = (string) $elementAttributes->class;
                }
                $classMetadata->setClassDiscriminatorMapping(new ClassDiscriminatorMapping((string) $xml->{'discriminator-map'}
                    ->attributes()->{'type-property'}, $mapping));
            }
            return true;
        }
        return false;
    }
    
    /**
     * Return the names of the classes mapped in this file.
     *
     * @return string[]
     */
    public function getMappedClasses() : array {
        return array_keys($this->classes ??= $this->getClassesFromXml());
    }
    
    /**
     * Parses an XML File.
     *
     * @throws MappingException
     */
    private function parseFile(string $file) : \SimpleXMLElement {
        try {
            $dom = XmlUtils::loadFile($file, __DIR__ . '/schema/dic/serializer-mapping/serializer-mapping-1.0.xsd');
        } catch (\Exception $e) {
            throw new MappingException($e->getMessage(), $e->getCode(), $e);
        }
        return simplexml_import_dom($dom);
    }
    private function getClassesFromXml() : array {
        $xml = $this->parseFile($this->file);
        $classes = [];
        foreach ($xml->class as $class) {
            $classes[(string) $class['name']] = $class;
        }
        return $classes;
    }
    private function parseContext(\SimpleXMLElement $nodes) : array {
        $context = [];
        foreach ($nodes as $node) {
            if (\count($node) > 0) {
                if (\count($node->entry) > 0) {
                    $value = $this->parseContext($node->entry);
                }
                else {
                    $value = [];
                }
            }
            else {
                $value = XmlUtils::phpize($node);
            }
            if (isset($node['name'])) {
                $context[(string) $node['name']] = $value;
            }
            else {
                $context[] = $value;
            }
        }
        return $context;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
FileLoader::__construct public function
XmlFileLoader::$classes private property An array of {@class \SimpleXMLElement} instances.
XmlFileLoader::getClassesFromXml private function
XmlFileLoader::getMappedClasses public function Return the names of the classes mapped in this file.
XmlFileLoader::loadClassMetadata public function Overrides LoaderInterface::loadClassMetadata
XmlFileLoader::parseContext private function
XmlFileLoader::parseFile private function Parses an XML File.

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal