Doctrine\ODM\MongoDB\Tools\ResolveTargetDocumentListener

Complexity

Total Complexity

12

Size/Duplication

Total Lines	85
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

97.22%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getSubscribedEvents()	0	7	1
A	addResolveTargetDocument()	0	5	1
A	onClassMetadataNotFound()	0	12	2
A	loadClassMetadata()	0	12	3
A	remapAssociation()	0	25	5

<?php

declare(strict_types=1);

namespace Doctrine\ODM\MongoDB\Tools;

use Doctrine\Common\EventSubscriber;
use Doctrine\ODM\MongoDB\Event\LoadClassMetadataEventArgs;
use Doctrine\ODM\MongoDB\Event\OnClassMetadataNotFoundEventArgs;
use Doctrine\ODM\MongoDB\Events;
use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
use function array_key_exists;
use function array_replace_recursive;
use function ltrim;

/**
 * ResolveTargetDocumentListener
 *
 * Mechanism to overwrite document interfaces or classes specified as association targets.
 */
class ResolveTargetDocumentListener implements EventSubscriber
{
    /** @var array */
    private $resolveTargetDocuments = [];

    /**
     * {@inheritDoc}
     */
    public function getSubscribedEvents()
    {
        return [
            Events::loadClassMetadata,
            Events::onClassMetadataNotFound,
        ];
    }

    /**
     * Add a target-document class name to resolve to a new class name.
     */
    public function addResolveTargetDocument(string $originalDocument, string $newDocument, array $mapping) : void
    {
        $mapping['targetDocument']                                    = ltrim($newDocument, '\\');
        $this->resolveTargetDocuments[ltrim($originalDocument, '\\')] = $mapping;
    }

    /**
     * @internal this is an event callback, and should not be called directly
     *
     * @return void
     */
    public function onClassMetadataNotFound(OnClassMetadataNotFoundEventArgs $args)
    {
        if (! array_key_exists($args->getClassName(), $this->resolveTargetDocuments)) {
            return;
        }

        $args->setFoundMetadata(
            $args
                ->getDocumentManager()
                ->getClassMetadata($this->resolveTargetDocuments[$args->getClassName()]['targetDocument'])
        );
    }

    /**
     * Process event and resolve new target document names.
     */
    public function loadClassMetadata(LoadClassMetadataEventArgs $args) : void
    {
        /** @var ClassMetadata $cm */
        $cm = $args->getClassMetadata();
        foreach ($cm->associationMappings as $mapping) {
            if (! isset($this->resolveTargetDocuments[$mapping['targetDocument']])) {
                continue;
            }

            $this->remapAssociation($cm, $mapping);
        }
    }

    private function remapAssociation(ClassMetadata $classMetadata, array $mapping) : void
    {
        $newMapping              = $this->resolveTargetDocuments[$mapping['targetDocument']];
        $newMapping              = array_replace_recursive($mapping, $newMapping);
        $newMapping['fieldName'] = $mapping['fieldName'];

        // clear reference case of duplicate exception
        unset($classMetadata->fieldMappings[$mapping['fieldName']]);
        unset($classMetadata->associationMappings[$mapping['fieldName']]);

        switch ($mapping['association']) {
            case ClassMetadata::REFERENCE_ONE:
                $classMetadata->mapOneReference($newMapping);
                break;
            case ClassMetadata::REFERENCE_MANY:
                $classMetadata->mapManyReference($newMapping);
                break;
            case ClassMetadata::EMBED_ONE:
                $classMetadata->mapOneEmbedded($newMapping);
                break;
            case ClassMetadata::EMBED_MANY:
                $classMetadata->mapManyEmbedded($newMapping);
                break;
        }
    }
}