ApiPlatform\Core\Bridge\Doctrine\Orm\Util\EagerLoadingTrait

Complexity

Total Complexity

11

Size/Duplication

Total Lines	89
Duplicated Lines	7.87 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	shouldOperationForceEager()	0	4	1
A	shouldOperationFetchPartial()	0	4	1
A	getBooleanOperationAttribute()	7	14	4
B	hasFetchEagerAssociation()	0	22	5

<?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\Orm\Util;

use Doctrine\ORM\EntityManager;
use Doctrine\ORM\Mapping\ClassMetadataInfo;

/**
 * @author Antoine Bluchet <soyuka@gmail.com>
 *
 * @internal
 */
trait EagerLoadingTrait
{
    private $forceEager;
    private $fetchPartial;
    private $resourceMetadataFactory;

    /**
     * Checks if an operation has a `force_eager` attribute.
     *
     * @param string $resourceClass
     * @param array  $options
     *
     * @return bool
     */
    private function shouldOperationForceEager(string $resourceClass, array $options): bool
    {
        return $this->getBooleanOperationAttribute($resourceClass, $options, 'force_eager', $this->forceEager);
    }

    /**
     * Checks if an operation has a `fetch_partial` attribute.
     *
     * @param string $resourceClass
     * @param array  $options
     *
     * @return bool
     */
    private function shouldOperationFetchPartial(string $resourceClass, array $options): bool
    {
        return $this->getBooleanOperationAttribute($resourceClass, $options, 'fetch_partial', $this->fetchPartial);
    }

    /**
     * Get the boolean attribute of an operation or the resource metadata.
     *
     * @param string $resourceClass
     * @param array  $options
     * @param string $attributeName
     * @param bool   $default
     *
     * @return bool
     */
    private function getBooleanOperationAttribute(string $resourceClass, array $options, string $attributeName, bool $default): bool

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

    {
        $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);

        if (isset($options['collection_operation_name'])) {

This code seems to be duplicated across your project.

            $attribute = $resourceMetadata->getCollectionOperationAttribute($options['collection_operation_name'], $attributeName, null, true);

$attribute is not used, you could remove the assignment.

        } elseif (isset($options['item_operation_name'])) {
            $attribute = $resourceMetadata->getItemOperationAttribute($options['item_operation_name'], $attributeName, null, true);

$attribute is not used, you could remove the assignment.

        } else {
            $attribute = $resourceMetadata->getAttribute($attributeName);

$attribute is not used, you could remove the assignment.

        }

        return is_bool($forceEager) ? $forceEager : (bool) $this->forceEager;

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

    }

    /**
     * Checkes if the class has an associationMapping with FETCH=EAGER.
     *
     * @param EntityManager     $em
     * @param ClassMetadataInfo $classMetadata
     * @param array             $checked       array cache of tested metadata classes
     *
     * @return bool
     */
    private function hasFetchEagerAssociation(EntityManager $em, ClassMetadataInfo $classMetadata, array &$checked = []): bool
    {
        $checked[] = $classMetadata->name;

        foreach ($classMetadata->associationMappings as $mapping) {
            if (ClassMetadataInfo::FETCH_EAGER === $mapping['fetch']) {
                return true;
            }

            $related = $em->getClassMetadata($mapping['targetEntity']);

            if (in_array($related->name, $checked, true)) {
                continue;
            }

            if (true === $this->hasFetchEagerAssociation($em, $related, $checked)) {
                return true;
            }
        }

        return false;
    }
}