Doctrine\ORM\Tools\Export\Driver\XmlExporter

Complexity

Total Complexity

96

Size/Duplication

Total Lines	526
Duplicated Lines	8.17 %

Test Coverage

Coverage

81.04%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	addClassToMapIfExists()	0	11	2
A	processEntityListeners()	0	10	2
A	asXml()	0	8	1
A	generateEntityListenerXml()	0	13	3
F	exportFieldMetadata()	7	47	11
A	exportTableOptions()	0	12	4
B	exportCascade()	0	19	6
A	exportSequenceInformation()	0	12	3
F	exportAssociationMetadata()	0	63	15
F	exportClassMetadata()	25	206	40
D	exportJoinColumns()	7	42	9

<?php

declare(strict_types=1);

namespace Doctrine\ORM\Tools\Export\Driver;

use Doctrine\ORM\Mapping\AssociationMetadata;
use Doctrine\ORM\Mapping\ChangeTrackingPolicy;
use Doctrine\ORM\Mapping\ClassMetadata;
use \SimpleXMLElement;
use Doctrine\ORM\Mapping\FieldMetadata;
use Doctrine\ORM\Mapping\GeneratorType;
use Doctrine\ORM\Mapping\InheritanceType;
use Doctrine\ORM\Mapping\JoinColumnMetadata;
use Doctrine\ORM\Mapping\ManyToManyAssociationMetadata;
use Doctrine\ORM\Mapping\ManyToOneAssociationMetadata;
use Doctrine\ORM\Mapping\OneToManyAssociationMetadata;
use Doctrine\ORM\Mapping\OneToOneAssociationMetadata;
use Doctrine\ORM\Mapping\ToManyAssociationMetadata;
use Doctrine\ORM\Mapping\ToOneAssociationMetadata;

/**
 * ClassMetadata exporter for Doctrine XML mapping files.
 *
 * @link    www.doctrine-project.org
 * @since   2.0
 * @author  Jonathan Wage <jonwage@gmail.com>
 */
class XmlExporter extends AbstractExporter
{
    /**
     * @var string
     */
    protected $extension = '.dcm.xml';

    /**
     * {@inheritdoc}
     */
    public function exportClassMetadata(ClassMetadata $metadata)
    {
        $xml = new SimpleXmlElement('<?xml version="1.0" encoding="utf-8"?><doctrine-mapping ' .
            'xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping" ' .
            'xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ' .
            'xsi:schemaLocation="http://doctrine-project.org/schemas/orm/doctrine-mapping http://doctrine-project.org/schemas/orm/doctrine-mapping.xsd" />');

        if ($metadata->isMappedSuperclass) {
            $root = $xml->addChild('mapped-superclass');
        } else {
            $root = $xml->addChild('entity');
        }

        if ($metadata->getCustomRepositoryClassName()) {

The expression $metadata->getCustomRepositoryClassName() of type null|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

            $root->addAttribute('repository-class', $metadata->getCustomRepositoryClassName());
        }

        $root->addAttribute('name', $metadata->getClassName());

        if ($metadata->table->getName()) {

The expression $metadata->table->getName() of type null|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

            $root->addAttribute('table', $metadata->table->getName());
        }

        if ($metadata->table->getSchema()) {

The expression $metadata->table->getSchema() of type null|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

            $root->addAttribute('schema', $metadata->table->getSchema());
        }

        if ($metadata->inheritanceType && $metadata->inheritanceType !== InheritanceType::NONE) {
            $root->addAttribute('inheritance-type', $metadata->inheritanceType);
        }

        if ($metadata->table->getOptions()) {
            $optionsXml = $root->addChild('options');

            $this->exportTableOptions($optionsXml, $metadata->table->getOptions());
        }

        if ($metadata->discriminatorColumn) {
            $discrColumn            = $metadata->discriminatorColumn;
            $discriminatorColumnXml = $root->addChild('discriminator-column');

            $discriminatorColumnXml->addAttribute('name', $discrColumn->getColumnName());
            $discriminatorColumnXml->addAttribute('type', $discrColumn->getTypeName());

            if (is_int($discrColumn->getLength())) {
                $discriminatorColumnXml->addAttribute('length', (string) $discrColumn->getLength());
            }

            if (is_int($discrColumn->getScale())) {
                $discriminatorColumnXml->addAttribute('scale', (string) $discrColumn->getScale());
            }

            if (is_int($discrColumn->getPrecision())) {
                $discriminatorColumnXml->addAttribute('precision', (string) $discrColumn->getPrecision());
            }
        }

        if ($metadata->discriminatorMap) {

The expression $metadata->discriminatorMap of type array<string,string> is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

            $discriminatorMapXml = $root->addChild('discriminator-map');

            foreach ($metadata->discriminatorMap as $value => $className) {
                $discriminatorMappingXml = $discriminatorMapXml->addChild('discriminator-mapping');
                $discriminatorMappingXml->addAttribute('value', (string) $value);
                $discriminatorMappingXml->addAttribute('class', $className);
            }
        }

        if ($metadata->changeTrackingPolicy !== ChangeTrackingPolicy::DEFERRED_IMPLICIT) {
            $root->addChild('change-tracking-policy', $metadata->changeTrackingPolicy);
        }

        if ($metadata->table->getIndexes()) {
            $indexesXml = $root->addChild('indexes');

            foreach ($metadata->table->getIndexes() as $name => $index) {
                $indexXml = $indexesXml->addChild('index');

                $indexXml->addAttribute('name', $name);
                $indexXml->addAttribute('columns', implode(',', $index['columns']));

                if ($index['unique']) {
                    $indexXml->addAttribute('unique', 'true');
                }

                if ($index['flags']) {
                    $indexXml->addAttribute('flags', implode(',', $index['flags']));
                }

                if ($index['options']) {

This code seems to be duplicated across your project.

                    $optionsXml = $indexXml->addChild('options');

                    foreach ($index['options'] as $key => $value) {
                        $optionXml = $optionsXml->addChild('option', $value);

                        $optionXml->addAttribute('name', $key);
                    }
                }
            }
        }

        if ($metadata->table->getUniqueConstraints()) {
            $uniqueConstraintsXml = $root->addChild('unique-constraints');

            foreach ($metadata->table->getUniqueConstraints() as $name => $constraint) {
                $uniqueConstraintXml = $uniqueConstraintsXml->addChild('unique-constraint');

                $uniqueConstraintXml->addAttribute('name', $name);
                $uniqueConstraintXml->addAttribute('columns', implode(',', $constraint['columns']));

                if ($constraint['flags']) {
                    $uniqueConstraintXml->addAttribute('flags', implode(',', $constraint['flags']));
                }

                if ($constraint['options']) {

This code seems to be duplicated across your project.

                    $optionsXml = $uniqueConstraintXml->addChild('options');

                    foreach ($constraint['options'] as $key => $value) {
                        $optionXml = $optionsXml->addChild('option', $value);

                        $optionXml->addAttribute('name', $key);
                    }
                }
            }
        }

        $properties = iterator_to_array($metadata->getDeclaredPropertiesIterator());
        $id         = [];

        foreach ($properties as $name => $property) {
            if ($property->isPrimaryKey()) {
                $id[$name] = $property;

                unset($properties[$name]);
            }
        }

        if ($id) {
            foreach ($id as $property) {
                $idXml = $root->addChild('id');

                $idXml->addAttribute('name', $property->getName());

                if ($property instanceof AssociationMetadata) {
                    $idXml->addAttribute('association-key', 'true');

                    continue;
                }

                $idXml->addAttribute('type', $property->getTypeName());
                $idXml->addAttribute('column', $property->getColumnName());

                if (is_int($property->getLength())) {
                    $idXml->addAttribute('length', $property->getLength());
                }

                if ($property->hasValueGenerator()) {
                    $generatorXml = $idXml->addChild('generator');

                    $generatorXml->addAttribute('strategy', $property->getValueGenerator()->getType());

                    $this->exportSequenceInformation($idXml, $property);
                }
            }
        }

        $orderMap = [
            FieldMetadata::class,
            OneToOneAssociationMetadata::class,
            OneToManyAssociationMetadata::class,
            ManyToOneAssociationMetadata::class,
            ManyToManyAssociationMetadata::class,
        ];



        uasort($properties, function($m1, $m2) use (&$orderMap) {
            $a1 = array_search(get_class($m1), $orderMap);
            $a2 = array_search(get_class($m2), $orderMap);

            return strcmp((string) $a1, (string) $a2);
        });

        foreach ($properties as $property) {

This code seems to be duplicated across your project.

            if ($property instanceof FieldMetadata) {
                $this->exportFieldMetadata($root, $metadata, $property);
            } else if ($property instanceof AssociationMetadata) {
                $this->exportAssociationMetadata($root, $metadata, $property);
            }
        }

        if (isset($metadata->lifecycleCallbacks) && count($metadata->lifecycleCallbacks)>0) {
            $lifecycleCallbacksXml = $root->addChild('lifecycle-callbacks');

            foreach ($metadata->lifecycleCallbacks as $name => $methods) {
                foreach ($methods as $method) {
                    $lifecycleCallbackXml = $lifecycleCallbacksXml->addChild('lifecycle-callback');

                    $lifecycleCallbackXml->addAttribute('type', $name);
                    $lifecycleCallbackXml->addAttribute('method', $method);
                }
            }
        }

        $this->processEntityListeners($metadata, $root);

        return $this->asXml($xml);
    }

    /**
     * @param \SimpleXMLElement $root
     * @param ClassMetadata     $metadata
     * @param FieldMetadata     $property
     */
    private function exportFieldMetadata(
        \SimpleXMLElement $root,
        ClassMetadata $metadata,
        FieldMetadata $property
    )
    {
        $fieldXml = $root->addChild('field');

        $fieldXml->addAttribute('name', $property->getName());
        $fieldXml->addAttribute('type', $property->getTypeName());
        $fieldXml->addAttribute('column', $property->getColumnName());

        if ($property->isNullable()) {
            $fieldXml->addAttribute('nullable', 'true');
        }

        if ($property->isUnique()) {
            $fieldXml->addAttribute('unique', 'true');
        }

        if (is_int($property->getLength())) {
            $fieldXml->addAttribute('length', (string) $property->getLength());
        }

        if (is_int($property->getPrecision())) {
            $fieldXml->addAttribute('precision', (string) $property->getPrecision());
        }

        if (is_int($property->getScale())) {
            $fieldXml->addAttribute('scale', (string) $property->getScale());
        }

        if ($metadata->isVersioned() && $metadata->versionProperty->getName() === $property->getName()) {
            $fieldXml->addAttribute('version', 'true');
        }

        if ($property->getColumnDefinition()) {

The expression $property->getColumnDefinition() of type null|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

            $fieldXml->addAttribute('column-definition', $property->getColumnDefinition());
        }

        if ($property->getOptions()) {

This code seems to be duplicated across your project.

            $optionsXml = $fieldXml->addChild('options');

            foreach ($property->getOptions() as $key => $value) {
                $optionXml = $optionsXml->addChild('option', (string) $value);

                $optionXml->addAttribute('name', $key);
            }
        }
    }

    /**
     * @param \SimpleXMLElement   $root
     * @param ClassMetadata       $metadata
     * @param AssociationMetadata $association
     */
    private function exportAssociationMetadata(
        \SimpleXMLElement $root,
        ClassMetadata $metadata,

The parameter $metadata is not used and could be removed.

        AssociationMetadata $association
    ) {
        if ($association instanceof OneToOneAssociationMetadata) {
            $associationMappingXml = $root->addChild('one-to-one');
        } elseif ($association instanceof OneToManyAssociationMetadata) {
            $associationMappingXml = $root->addChild('one-to-many');
        } elseif ($association instanceof ManyToOneAssociationMetadata) {
            $associationMappingXml = $root->addChild('many-to-one');
        } else {
            $associationMappingXml = $root->addChild('many-to-many');
        }

        $associationMappingXml->addAttribute('field', $association->getName());
        $associationMappingXml->addAttribute('target-entity', $association->getTargetEntity());
        $associationMappingXml->addAttribute('fetch', $association->getFetchMode());

        $this->exportCascade($associationMappingXml, $association->getCascade());

        if ($association->getMappedBy()) {

The expression $association->getMappedBy() of type null|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

            $associationMappingXml->addAttribute('mapped-by', $association->getMappedBy());
        }

        if ($association->getInversedBy()) {

The expression $association->getInversedBy() of type null|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

            $associationMappingXml->addAttribute('inversed-by', $association->getInversedBy());
        }

        if ($association->isOrphanRemoval()) {
            $associationMappingXml->addAttribute('orphan-removal', 'true');
        }

        if ($association instanceof ToManyAssociationMetadata) {
            if ($association instanceof ManyToManyAssociationMetadata && $association->getJoinTable()) {
                $joinTableXml = $associationMappingXml->addChild('join-table');
                $joinTable    = $association->getJoinTable();

                $joinTableXml->addAttribute('name', $joinTable->getName());

                $this->exportJoinColumns($joinTableXml, $joinTable->getJoinColumns(), 'join-columns');
                $this->exportJoinColumns($joinTableXml, $joinTable->getInverseJoinColumns(), 'inverse-join-columns');
            }

            if ($association->getIndexedBy()) {

The expression $association->getIndexedBy() of type null|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

The method getIndexedBy() does not exist on Doctrine\ORM\Mapping\AssociationMetadata. It seems like you code against a sub-type of Doctrine\ORM\Mapping\AssociationMetadata such as Doctrine\ORM\Mapping\ToManyAssociationMetadata.

                $associationMappingXml->addAttribute('index-by', $association->getIndexedBy());
            }

            if ($association->getOrderBy()) {

The method getOrderBy() does not exist on Doctrine\ORM\Mapping\AssociationMetadata. It seems like you code against a sub-type of Doctrine\ORM\Mapping\AssociationMetadata such as Doctrine\ORM\Mapping\ToManyAssociationMetadata.

                $orderByXml = $associationMappingXml->addChild('order-by');

                foreach ($association->getOrderBy() as $name => $direction) {
                    $orderByFieldXml = $orderByXml->addChild('order-by-field');

                    $orderByFieldXml->addAttribute('name', $name);
                    $orderByFieldXml->addAttribute('direction', $direction);
                }
            }
        }

        if ($association instanceof ToOneAssociationMetadata) {
            if ($association->getJoinColumns()) {
                $this->exportJoinColumns($associationMappingXml, $association->getJoinColumns());
            }
        }
    }

    /**
     * @param \SimpleXMLElement $associationXml
     * @param array             $joinColumns
     * @param string            $joinColumnsName
     */
    private function exportJoinColumns(
        \SimpleXMLElement $associationXml,
        array $joinColumns,
        $joinColumnsName = 'join-columns'
    )
    {
        $joinColumnsXml = $associationXml->addChild($joinColumnsName);

        foreach ($joinColumns as $joinColumn) {
            /** @var JoinColumnMetadata $joinColumn */
            $joinColumnXml = $joinColumnsXml->addChild('join-column');

            $joinColumnXml->addAttribute('name', $joinColumn->getColumnName());
            $joinColumnXml->addAttribute('referenced-column-name', $joinColumn->getReferencedColumnName());

            if (! empty($joinColumn->getAliasedName())) {
                $joinColumnXml->addAttribute('field-name', $joinColumn->getAliasedName());
            }

            if (! empty($joinColumn->getOnDelete())) {
                $joinColumnXml->addAttribute('on-delete', $joinColumn->getOnDelete());
            }

            if (! empty($joinColumn->getColumnDefinition())) {
                $joinColumnXml->addAttribute('column-definition', $joinColumn->getColumnDefinition());
            }

            if ($joinColumn->isNullable()) {
                $joinColumnXml->addAttribute('nullable', (string) $joinColumn->isNullable());
            }

            if ($joinColumn->isUnique()) {
                $joinColumnXml->addAttribute('unique', (string) $joinColumn->isUnique());
            }

            if ($joinColumn->getOptions()) {

This code seems to be duplicated across your project.

                $optionsXml = $joinColumnXml->addChild('options');

                foreach ($joinColumn->getOptions() as $key => $value) {
                    $optionXml = $optionsXml->addChild('option', (string) $value);

                    $optionXml->addAttribute('name', $key);
                }
            }
        }
    }

    /**
     * @param \SimpleXMLElement $associationXml
     * @param array             $associationCascades
     *
     * @return string
     */
    private function exportCascade(\SimpleXMLElement $associationXml, array $associationCascades)
    {
        $cascades = [];

        foreach (['persist', 'remove', 'refresh'] as $type) {
            if (in_array($type, $associationCascades)) {
                $cascades[] = 'cascade-' . $type;
            }
        }

        if (count($cascades) === 5) {
            $cascades = ['cascade-all'];
        }

        if ($cascades) {
            $cascadeXml = $associationXml->addChild('cascade');

            foreach ($cascades as $type) {
                $cascadeXml->addChild($type);
            }
        }
    }

    /**
     * Exports (nested) option elements.
     *
     * @param SimpleXMLElement $parentXml
     * @param array            $options
     */
    private function exportTableOptions(SimpleXMLElement $parentXml, array $options) : void
    {
        foreach ($options as $name => $option) {
            $isArray   = is_array($option);
            $optionXml = $isArray
                ? $parentXml->addChild('option')
                : $parentXml->addChild('option', (string) $option);

            $optionXml->addAttribute('name', (string) $name);

            if ($isArray) {
                $this->exportTableOptions($optionXml, $option);
            }
        }
    }

    /**
     * Export sequence information (if available/configured) into the current identifier XML node
     *
     * @param \SimpleXMLElement $identifierXmlNode
     * @param FieldMetadata     $metadata
     *
     * @return void
     */
    private function exportSequenceInformation(\SimpleXMLElement $identifierXmlNode, FieldMetadata $metadata)
    {
        $sequenceDefinition = $metadata->getValueGenerator()->getDefinition();

        if (! ($metadata->getValueGenerator()->getType() === GeneratorType::SEQUENCE && $sequenceDefinition)) {

The expression $sequenceDefinition of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

            return;
        }

        $sequenceGeneratorXml = $identifierXmlNode->addChild('sequence-generator');

        $sequenceGeneratorXml->addAttribute('sequence-name', $sequenceDefinition['sequenceName']);
        $sequenceGeneratorXml->addAttribute('allocation-size', (string) $sequenceDefinition['allocationSize']);
    }

    /**
     * @param \SimpleXMLElement $simpleXml
     *
     * @return string $xml
     */
    private function asXml(SimpleXMLElement $simpleXml) : string
    {
        $dom = new \DOMDocument('1.0', 'UTF-8');

        $dom->loadXML($simpleXml->asXML());
        $dom->formatOutput = true;

        return $dom->saveXML();
    }

    private function processEntityListeners(ClassMetadata $metadata, SimpleXMLElement $root): void
    {
        if (0 === \count($metadata->entityListeners)) {
            return;
        }

        $entityListenersXml = $root->addChild('entity-listeners');
        $entityListenersXmlMap = [];

        $this->generateEntityListenerXml($metadata, $entityListenersXmlMap, $entityListenersXml);
    }

    private function generateEntityListenerXml(ClassMetadata $metadata, array $entityListenersXmlMap, SimpleXMLElement $entityListenersXml): void
    {
        foreach ($metadata->entityListeners as $event => $entityListenerConfig) {
            foreach ($entityListenerConfig as $entityListener) {
                $entityListenerXml = $this->addClassToMapIfExists(
                    $entityListenersXmlMap,
                    $entityListener,
                    $entityListenersXml
                );

                $entityListenerCallbackXml = $entityListenerXml->addChild('lifecycle-callback');
                $entityListenerCallbackXml->addAttribute('type', $event);
                $entityListenerCallbackXml->addAttribute('method', $entityListener['method']);
            }
        }
    }

    private function addClassToMapIfExists(array $entityListenersXmlMap, array $entityListener, SimpleXMLElement $entityListenersXml): SimpleXMLElement
    {
        if (isset($entityListenersXmlMap[$entityListener['class']])) {
            return $entityListenersXmlMap[$entityListener['class']];
        }

        $entityListenerXml = $entityListenersXml->addChild('entity-listener');
        $entityListenerXml->addAttribute('class', $entityListener['class']);
        $entityListenersXmlMap[$entityListener['class']] = $entityListenerXml;

        return $entityListenerXml;
    }
}