ApiPlatform\Core\Bridge\Doctrine\MongoDbOdm\PropertyHelperTrait

Complexity

Total Complexity

4

Size/Duplication

Total Lines	29
Duplicated Lines	0 %

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	addLookupsForNestedProperty()	0	18	4

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <dunglas@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace ApiPlatform\Core\Bridge\Doctrine\MongoDbOdm;

use ApiPlatform\Core\Exception\InvalidArgumentException;
use Doctrine\ODM\MongoDB\Aggregation\Builder;
use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;

/**
 * Helper trait regarding a property in a MongoDB document using the resource metadata.
 *
 * @author Alan Poulain <contact@alanpoulain.eu>
 */
trait PropertyHelperTrait
{
    /**
     * Adds the necessary lookups for a nested property.
     *
     * @throws InvalidArgumentException If property is not nested
     *
     * @return array An array where the first element is the $alias of the lookup,
     *               the second element is the $field name
     *               the third element is the $associations array
     */
    protected function addLookupsForNestedProperty(string $property, Builder $aggregationBuilder, string $resourceClass): array
    {
        $propertyParts = $this->splitPropertyParts($property, $resourceClass);

It seems like splitPropertyParts() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $association = $propertyParts['associations'][0] ?? null;

        if (null === $association) {
            throw new InvalidArgumentException(sprintf('Cannot add lookups for property "%s" - property is not nested.', $property));
        }

        $alias = $association;
        $classMetadata = $this->getClassMetadata($resourceClass);

It seems like getClassMetadata() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        if ($classMetadata instanceof ClassMetadata && $classMetadata->hasReference($association)) {
            $alias = "${association}_lkup";
            $aggregationBuilder->lookup($association)->alias($alias);
        }

        // assocation.property => association_lkup.property
        return [substr_replace($property, $alias, 0, \strlen($association)), $propertyParts['field'], $propertyParts['associations']];
    }
}