Doctrine\ODM\MongoDB\Persisters\CollectionPersister

Complexity

Total Complexity

82

Size/Duplication

Total Lines	606
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

86.11%

Importance

Changes

0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	deleteAll()	0	25	5
A	delete()	0	13	3
B	update()	0	29	8
B	updateAll()	0	41	11
A	setCollection()	0	9	1
A	setCollections()	0	35	5
A	deleteElements()	0	26	3
B	deleteCollections()	0	55	9
B	insertElements()	0	39	5
C	insertCollections()	0	71	10
A	pushAllCollections()	0	24	4
A	addToSetCollections()	0	19	3
A	getValuePrepareCallback()	0	13	2
A	getPathAndParent()	0	20	4
A	executeQuery()	0	15	4
A	excludeSubPaths()	0	17	4

<?php

declare(strict_types=1);

namespace Doctrine\ODM\MongoDB\Persisters;

use Closure;
use Doctrine\ODM\MongoDB\DocumentManager;
use Doctrine\ODM\MongoDB\LockException;
use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
use Doctrine\ODM\MongoDB\PersistentCollection\PersistentCollectionInterface;
use Doctrine\ODM\MongoDB\UnitOfWork;
use Doctrine\ODM\MongoDB\Utility\CollectionHelper;
use LogicException;
use UnexpectedValueException;
use function array_diff_key;
use function array_fill_keys;
use function array_flip;
use function array_intersect_key;
use function array_keys;
use function array_map;
use function array_reverse;
use function array_values;
use function count;
use function end;
use function get_class;
use function implode;
use function sort;
use function spl_object_hash;
use function sprintf;
use function strpos;

/**
 * The CollectionPersister is responsible for persisting collections of embedded
 * or referenced documents. When a PersistentCollection is scheduledForDeletion
 * in the UnitOfWork by calling PersistentCollection::clear() or is
 * de-referenced in the domain application code, CollectionPersister::delete()
 * will be called. When documents within the PersistentCollection are added or
 * removed, CollectionPersister::update() will be called, which may set the
 * entire collection or delete/insert individual elements, depending on the
 * mapping strategy.
 */
class CollectionPersister
{
    /**
     * Validation map that is used for strategy validation in insertCollections method.
     */
    public const INSERT_STRATEGIES_MAP = [
        ClassMetadata::STORAGE_STRATEGY_PUSH_ALL => true,
        ClassMetadata::STORAGE_STRATEGY_ADD_TO_SET => true,
    ];

    /**
     * The DocumentManager instance.
     *
     * @var DocumentManager
     */
    private $dm;

    /** @var PersistenceBuilder */
    private $pb;

    /** @var UnitOfWork */
    private $uow;

    public function __construct(DocumentManager $dm, PersistenceBuilder $pb, UnitOfWork $uow)
    {
        $this->dm  = $dm;
        $this->pb  = $pb;
        $this->uow = $uow;
    }

    /**
     * Deletes a PersistentCollection instances completely from a document using $unset. If collections belong to the different
     *
     * @param PersistentCollectionInterface[] $collections
     * @param array                           $options
     */
    public function deleteAll(array $collections, array $options) : void
    {
        $parents       = [];
        $unsetPathsMap = [];

        foreach ($collections as $coll) {
            $mapping = $coll->getMapping();
            if ($mapping['isInverseSide']) {
                continue; // ignore inverse side
            }
            if (CollectionHelper::isAtomic($mapping['strategy'])) {
                throw new UnexpectedValueException($mapping['strategy'] . ' delete collection strategy should have been handled by DocumentPersister. Please report a bug in issue tracker');
            }
            [$propertyPath, $parent]            = $this->getPathAndParent($coll);

The variable $propertyPath does not exist. Did you forget to declare it?

The variable $parent does not exist. Did you mean $parents?

            $oid                                = spl_object_hash($parent);

The variable $parent does not exist. Did you mean $parents?

            $parents[$oid]                      = $parent;

The variable $parent does not exist. Did you mean $parents?

            $unsetPathsMap[$oid][$propertyPath] = true;
        }

        foreach ($unsetPathsMap as $oid => $paths) {
            $unsetPaths = array_fill_keys($this->excludeSubPaths(array_keys($paths)), true);
            $query      = ['$unset' => $unsetPaths];
            $this->executeQuery($parents[$oid], $query, $options);
        }
    }

    /**
     * Deletes a PersistentCollection instance completely from a document using $unset.
     */
    public function delete(PersistentCollectionInterface $coll, array $options) : void
    {
        $mapping = $coll->getMapping();
        if ($mapping['isInverseSide']) {
            return; // ignore inverse side
        }
        if (CollectionHelper::isAtomic($mapping['strategy'])) {
            throw new UnexpectedValueException($mapping['strategy'] . ' delete collection strategy should have been handled by DocumentPersister. Please report a bug in issue tracker');
        }
        [$propertyPath, $parent] = $this->getPathAndParent($coll);

The variable $propertyPath does not exist. Did you forget to declare it?

The variable $parent does not exist. Did you forget to declare it?

        $query                   = ['$unset' => [$propertyPath => true]];
        $this->executeQuery($parent, $query, $options);
    }

    /**
     * Updates a PersistentCollection instance deleting removed rows and
     * inserting new rows.
     */
    public function update(PersistentCollectionInterface $coll, array $options) : void
    {
        $mapping = $coll->getMapping();

        if ($mapping['isInverseSide']) {
            return; // ignore inverse side
        }

        switch ($mapping['strategy']) {
            case ClassMetadata::STORAGE_STRATEGY_ATOMIC_SET:
            case ClassMetadata::STORAGE_STRATEGY_ATOMIC_SET_ARRAY:
                throw new UnexpectedValueException($mapping['strategy'] . ' update collection strategy should have been handled by DocumentPersister. Please report a bug in issue tracker');

            case ClassMetadata::STORAGE_STRATEGY_SET:
            case ClassMetadata::STORAGE_STRATEGY_SET_ARRAY:
                $this->setCollection($coll, $options);
                break;

            case ClassMetadata::STORAGE_STRATEGY_ADD_TO_SET:
            case ClassMetadata::STORAGE_STRATEGY_PUSH_ALL:
                $coll->initialize();
                $this->deleteElements($coll, $options);
                $this->insertElements($coll, $options);
                break;

            default:
                throw new UnexpectedValueException('Unsupported collection strategy: ' . $mapping['strategy']);
        }
    }

    /**
     * Updates a list PersistentCollection instances deleting removed rows and inserting new rows.
     *
     * @param PersistentCollectionInterface[] $collections
     * @param array                           $options
     */
    public function updateAll(array $collections, array $options) : void
    {
        $setStrategyColls     = [];
        $addPushStrategyColls = [];

        foreach ($collections as $coll) {
            $mapping = $coll->getMapping();

            if ($mapping['isInverseSide']) {
                continue; // ignore inverse side
            }
            switch ($mapping['strategy']) {
                case ClassMetadata::STORAGE_STRATEGY_ATOMIC_SET:
                case ClassMetadata::STORAGE_STRATEGY_ATOMIC_SET_ARRAY:
                    throw new UnexpectedValueException($mapping['strategy'] . ' update collection strategy should have been handled by DocumentPersister. Please report a bug in issue tracker');

                case ClassMetadata::STORAGE_STRATEGY_SET:
                case ClassMetadata::STORAGE_STRATEGY_SET_ARRAY:
                    $setStrategyColls[] = $coll;
                    break;

                case ClassMetadata::STORAGE_STRATEGY_ADD_TO_SET:
                case ClassMetadata::STORAGE_STRATEGY_PUSH_ALL:
                    $addPushStrategyColls[] = $coll;
                    break;

                default:
                    throw new UnexpectedValueException('Unsupported collection strategy: ' . $mapping['strategy']);
            }
        }

        if (! empty($setStrategyColls)) {
            $this->setCollections($setStrategyColls, $options);
        }
        if (empty($addPushStrategyColls)) {
            return;
        }

        $this->deleteCollections($addPushStrategyColls, $options);
        $this->insertCollections($addPushStrategyColls, $options); // TODO
    }

    /**
     * Sets a PersistentCollection instance.
     *
     * This method is intended to be used with the "set" or "setArray"
     * strategies. The "setArray" strategy will ensure that the collection is
     * set as a BSON array, which means the collection elements will be
     * reindexed numerically before storage.
     */
    private function setCollection(PersistentCollectionInterface $coll, array $options) : void
    {
        [$propertyPath, $parent] = $this->getPathAndParent($coll);

The variable $propertyPath does not exist. Did you forget to declare it?

The variable $parent does not exist. Did you forget to declare it?

        $coll->initialize();
        $mapping = $coll->getMapping();
        $setData = $this->pb->prepareAssociatedCollectionValue($coll, CollectionHelper::usesSet($mapping['strategy']));
        $query   = ['$set' => [$propertyPath => $setData]];
        $this->executeQuery($parent, $query, $options);
    }

    /**
     * Sets a list of PersistentCollection instances.
     *
     * This method is intended to be used with the "set" or "setArray"
     * strategies. The "setArray" strategy will ensure that the collection is
     * set as a BSON array, which means the collection elements will be
     * reindexed numerically before storage.
     *
     * @param PersistentCollectionInterface[] $collections
     * @param array                           $options
     */
    private function setCollections(array $collections, array $options) : void
    {
        $parents     = [];
        $pathCollMap = [];
        $pathsMap    = [];
        foreach ($collections as $coll) {
            [$propertyPath, $parent]          = $this->getPathAndParent($coll);

The variable $propertyPath seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition?

The variable $parent does not exist. Did you mean $parents?

            $oid                              = spl_object_hash($parent);

The variable $parent does not exist. Did you mean $parents?

            $parents[$oid]                    = $parent;

The variable $parent does not exist. Did you mean $parents?

            $pathCollMap[$oid][$propertyPath] = $coll;

The variable $propertyPath seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition?

            $pathsMap[$oid][]                 = $propertyPath;

The variable $propertyPath seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition?

        }

        foreach ($pathsMap as $oid => $paths) {
            $paths = $this->excludeSubPaths($paths);
            /** @var PersistentCollectionInterface[] $setColls */
            $setColls   = array_intersect_key($pathCollMap[$oid], array_flip($paths));
            $setPayload = [];
            foreach ($setColls as $propertyPath => $coll) {
                $coll->initialize();
                $mapping                   = $coll->getMapping();
                $setData                   = $this->pb->prepareAssociatedCollectionValue(
                    $coll,
                    CollectionHelper::usesSet($mapping['strategy'])
                );
                $setPayload[$propertyPath] = $setData;
            }
            if (empty($setPayload)) {
                continue;
            }

            $query = ['$set' => $setPayload];
            $this->executeQuery($parents[$oid], $query, $options);
        }
    }

    /**
     * Deletes removed elements from a PersistentCollection instance.
     *
     * This method is intended to be used with the "pushAll" and "addToSet"
     * strategies.
     */
    private function deleteElements(PersistentCollectionInterface $coll, array $options) : void
    {
        $deleteDiff = $coll->getDeleteDiff();

        if (empty($deleteDiff)) {
            return;
        }

        [$propertyPath, $parent] = $this->getPathAndParent($coll);

The variable $propertyPath does not exist. Did you forget to declare it?

The variable $parent does not exist. Did you forget to declare it?

        $query = ['$unset' => []];

        foreach ($deleteDiff as $key => $document) {
            $query['$unset'][$propertyPath . '.' . $key] = true;
        }

        $this->executeQuery($parent, $query, $options);

        /**
         * @todo This is a hack right now because we don't have a proper way to
         * remove an element from an array by its key. Unsetting the key results
         * in the element being left in the array as null so we have to pull
         * null values.
         */
        $this->executeQuery($parent, ['$pull' => [$propertyPath => null]], $options);
    }

    /**
     * Deletes removed elements from a list of PersistentCollection instances.
     *
     * This method is intended to be used with the "pushAll" and "addToSet" strategies.
     *
     * @param PersistentCollectionInterface[] $collections
     * @param array                           $options
     */
    private function deleteCollections(array $collections, array $options) : void
    {
        $parents       = [];
        $pathCollMap   = [];
        $pathsMap      = [];
        $deleteDiffMap = [];

        foreach ($collections as $coll) {
            $coll->initialize();
            if (! $this->uow->isCollectionScheduledForUpdate($coll)) {
                continue;
            }
            $deleteDiff = $coll->getDeleteDiff();

            if (empty($deleteDiff)) {
                continue;
            }
            [$propertyPath, $parent] = $this->getPathAndParent($coll);

The variable $propertyPath seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition?

The variable $parent does not exist. Did you mean $parents?

            $oid                                = spl_object_hash($parent);

The variable $parent does not exist. Did you mean $parents?

            $parents[$oid]                      = $parent;

The variable $parent does not exist. Did you mean $parents?

            $pathCollMap[$oid][$propertyPath]   = $coll;

The variable $propertyPath seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition?

            $pathsMap[$oid][]                   = $propertyPath;

The variable $propertyPath seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition?

            $deleteDiffMap[$oid][$propertyPath] = $deleteDiff;

The variable $propertyPath seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition?

        }

        foreach ($pathsMap as $oid => $paths) {
            $paths        = $this->excludeSubPaths($paths);
            $deleteColls  = array_intersect_key($pathCollMap[$oid], array_flip($paths));
            $unsetPayload = [];
            $pullPayload  = [];
            foreach ($deleteColls as $propertyPath => $coll) {
                $deleteDiff = $deleteDiffMap[$oid][$propertyPath];
                foreach ($deleteDiff as $key => $document) {
                    $unsetPayload[$propertyPath . '.' . $key] = true;
                }
                $pullPayload[$propertyPath] = null;
            }

            if (! empty($unsetPayload)) {
                $this->executeQuery($parents[$oid], ['$unset' => $unsetPayload], $options);
            }
            if (empty($pullPayload)) {
                continue;
            }

            /**
             * @todo This is a hack right now because we don't have a proper way to
             * remove an element from an array by its key. Unsetting the key results
             * in the element being left in the array as null so we have to pull
             * null values.
             */
            $this->executeQuery($parents[$oid], ['$pull' => $pullPayload], $options);
        }
    }

    /**
     * Inserts new elements for a PersistentCollection instance.
     *
     * This method is intended to be used with the "pushAll" and "addToSet"
     * strategies.
     */
    private function insertElements(PersistentCollectionInterface $coll, array $options) : void
    {
        $insertDiff = $coll->getInsertDiff();

        if (empty($insertDiff)) {
            return;
        }

        $mapping = $coll->getMapping();

        switch ($mapping['strategy']) {
            case ClassMetadata::STORAGE_STRATEGY_PUSH_ALL:
                $operator = 'push';
                break;

            case ClassMetadata::STORAGE_STRATEGY_ADD_TO_SET:
                $operator = 'addToSet';
                break;

            default:
                throw new LogicException(sprintf('Invalid strategy %s given for insertElements', $mapping['strategy']));
        }

        [$propertyPath, $parent] = $this->getPathAndParent($coll);

The variable $propertyPath does not exist. Did you forget to declare it?

The variable $parent does not exist. Did you forget to declare it?

        $callback = isset($mapping['embedded'])
            ? function ($v) use ($mapping) {
                return $this->pb->prepareEmbeddedDocumentValue($mapping, $v);
            }
            : function ($v) use ($mapping) {
                return $this->pb->prepareReferencedDocumentValue($mapping, $v);
            };

        $value = array_values(array_map($callback, $insertDiff));

        $query = ['$' . $operator => [$propertyPath => ['$each' => $value]]];

        $this->executeQuery($parent, $query, $options);
    }

    /**
     * Inserts new elements for a list of PersistentCollection instances.
     *
     * This method is intended to be used with the "pushAll" and "addToSet" strategies.
     *
     * @param PersistentCollectionInterface[] $collections
     * @param array                           $options
     */
    private function insertCollections(array $collections, array $options) : void
    {
        $parents             = [];
        $pushAllPathCollMap  = [];
        $addToSetPathCollMap = [];
        $pushAllPathsMap     = [];
        $addToSetPathsMap    = [];
        $diffsMap            = [];

        foreach ($collections as $coll) {
            $coll->initialize();
            if (! $this->uow->isCollectionScheduledForUpdate($coll)) {
                continue;
            }
            $insertDiff = $coll->getInsertDiff();

            if (empty($insertDiff)) {
                continue;
            }

            $mapping  = $coll->getMapping();
            $strategy = $mapping['strategy'];

            if (empty(self::INSERT_STRATEGIES_MAP[$strategy])) {
                throw new LogicException('Invalid strategy ' . $strategy . ' given for insertCollections');
            }

            [$propertyPath, $parent]       = $this->getPathAndParent($coll);

The variable $propertyPath does not exist. Did you forget to declare it?

The variable $parent seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition?

            $oid                           = spl_object_hash($parent);

The variable $parent seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition?

            $parents[$oid]                 = $parent;

The variable $parent seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition?

            $diffsMap[$oid][$propertyPath] = $insertDiff;

            switch ($strategy) {
                case ClassMetadata::STORAGE_STRATEGY_PUSH_ALL:
                    $pushAllPathCollMap[$oid][$propertyPath] = $coll;
                    $pushAllPathsMap[$oid][]                 = $propertyPath;
                    break;

                case ClassMetadata::STORAGE_STRATEGY_ADD_TO_SET:
                    $addToSetPathCollMap[$oid][$propertyPath] = $coll;
                    $addToSetPathsMap[$oid][]                 = $propertyPath;
                    break;

                default:
                    throw new LogicException('Invalid strategy ' . $strategy . ' given for insertCollections');
            }
        }

        foreach ($parents as $oid => $parent) {
            if (! empty($pushAllPathsMap[$oid])) {
                $this->pushAllCollections(
                    $parent,
                    $pushAllPathsMap[$oid],
                    $pushAllPathCollMap[$oid],
                    $diffsMap[$oid],
                    $options
                );
            }
            if (empty($addToSetPathsMap[$oid])) {
                continue;
            }

            $this->addToSetCollections(
                $parent,
                $addToSetPathsMap[$oid],
                $addToSetPathCollMap[$oid],
                $diffsMap[$oid],
                $options
            );
        }
    }

    /**
     * Perform collections update for 'pushAll' strategy.
     *
     * @param object $parent       Parent object to which passed collections is belong.
     * @param array  $collsPaths   Paths of collections that is passed.
     * @param array  $pathCollsMap List of collections indexed by their paths.
     * @param array  $diffsMap     List of collection diffs indexed by collections paths.
     * @param array  $options
     */
    private function pushAllCollections(object $parent, array $collsPaths, array $pathCollsMap, array $diffsMap, array $options) : void
    {
        $pushAllPaths = $this->excludeSubPaths($collsPaths);
        /** @var PersistentCollectionInterface[] $pushAllColls */
        $pushAllColls   = array_intersect_key($pathCollsMap, array_flip($pushAllPaths));
        $pushAllPayload = [];
        foreach ($pushAllColls as $propertyPath => $coll) {
            $callback                      = $this->getValuePrepareCallback($coll);
            $value                         = array_values(array_map($callback, $diffsMap[$propertyPath]));
            $pushAllPayload[$propertyPath] = ['$each' => $value];
        }

        if (! empty($pushAllPayload)) {
            $this->executeQuery($parent, ['$push' => $pushAllPayload], $options);
        }

        $pushAllColls = array_diff_key($pathCollsMap, array_flip($pushAllPaths));
        foreach ($pushAllColls as $propertyPath => $coll) {
            $callback = $this->getValuePrepareCallback($coll);
            $value    = array_values(array_map($callback, $diffsMap[$propertyPath]));
            $query    = ['$push' => [$propertyPath => ['$each' => $value]]];
            $this->executeQuery($parent, $query, $options);
        }
    }

    /**
     * Perform collections update by 'addToSet' strategy.
     *
     * @param object $parent       Parent object to which passed collections is belong.
     * @param array  $collsPaths   Paths of collections that is passed.
     * @param array  $pathCollsMap List of collections indexed by their paths.
     * @param array  $diffsMap     List of collection diffs indexed by collections paths.
     * @param array  $options
     */
    private function addToSetCollections(object $parent, array $collsPaths, array $pathCollsMap, array $diffsMap, array $options) : void
    {
        $addToSetPaths = $this->excludeSubPaths($collsPaths);
        /** @var PersistentCollectionInterface[] $addToSetColls */
        $addToSetColls = array_intersect_key($pathCollsMap, array_flip($addToSetPaths));

        $addToSetPayload = [];
        foreach ($addToSetColls as $propertyPath => $coll) {
            $callback                       = $this->getValuePrepareCallback($coll);
            $value                          = array_values(array_map($callback, $diffsMap[$propertyPath]));
            $addToSetPayload[$propertyPath] = ['$each' => $value];
        }

        if (empty($addToSetPayload)) {
            return;
        }

        $this->executeQuery($parent, ['$addToSet' => $addToSetPayload], $options);
    }

    /**
     * Return callback instance for specified collection. This callback will prepare values for query from documents
     * that collection contain.
     */
    private function getValuePrepareCallback(PersistentCollectionInterface $coll) : Closure
    {
        $mapping = $coll->getMapping();
        if (isset($mapping['embedded'])) {
            return function ($v) use ($mapping) {
                return $this->pb->prepareEmbeddedDocumentValue($mapping, $v);
            };
        }

        return function ($v) use ($mapping) {
            return $this->pb->prepareReferencedDocumentValue($mapping, $v);
        };
    }

    /**
     * Gets the parent information for a given PersistentCollection. It will
     * retrieve the top-level persistent Document that the PersistentCollection
     * lives in. We can use this to issue queries when updating a
     * PersistentCollection that is multiple levels deep inside an embedded
     * document.
     *
     *     <code>
     *     list($path, $parent) = $this->getPathAndParent($coll)
     *     </code>
     */
    private function getPathAndParent(PersistentCollectionInterface $coll) : array
    {
        $mapping = $coll->getMapping();
        $fields  = [];
        $parent  = $coll->getOwner();
        while (($association = $this->uow->getParentAssociation($parent)) !== null) {
            [$m, $owner, $field] = $association;

The variable $m does not exist. Did you forget to declare it?

The variable $owner does not exist. Did you forget to declare it?

The variable $field does not exist. Did you mean $fields?

            if (isset($m['reference'])) {
                break;
            }
            $parent   = $owner;
            $fields[] = $field;

The variable $field does not exist. Did you mean $fields?

        }
        $propertyPath = implode('.', array_reverse($fields));
        $path         = $mapping['name'];
        if ($propertyPath) {
            $path = $propertyPath . '.' . $path;
        }
        return [$path, $parent];
    }

    /**
     * Executes a query updating the given document.
     */
    private function executeQuery(object $document, array $newObj, array $options) : void
    {
        $className = get_class($document);
        $class     = $this->dm->getClassMetadata($className);
        $id        = $class->getDatabaseIdentifierValue($this->uow->getDocumentIdentifier($document));
        $query     = ['_id' => $id];
        if ($class->isVersioned) {
            $query[$class->fieldMappings[$class->versionField]['name']] = $class->reflFields[$class->versionField]->getValue($document);
        }
        $collection = $this->dm->getDocumentCollection($className);
        $result     = $collection->updateOne($query, $newObj, $options);
        if ($class->isVersioned && ! $result->getMatchedCount()) {
            throw LockException::lockFailed($document);
        }
    }

    /**
     * Remove from passed paths list all sub-paths.
     *
     * @param string[] $paths
     *
     * @return string[]
     */
    private function excludeSubPaths(array $paths) : array
    {
        if (empty($paths)) {
            return $paths;
        }
        sort($paths);
        $uniquePaths = [$paths[0]];
        for ($i = 1; $i < count($paths); ++$i) {

It seems like you are calling the size function count() as part of the test condition. You might want to compute the size beforehand, and not on each iteration.

            if (strpos($paths[$i], end($uniquePaths)) === 0) {
                continue;
            }

            $uniquePaths[] = $paths[$i];
        }

        return $uniquePaths;
    }
}