Lug\Component\Translation\Repository\Doctrine\ORM\TranslatableRepositoryTrait

Complexity

Total Complexity

12

Size/Duplication

Total Lines	129
Duplicated Lines	7.75 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	createQueryBuilderForCollection()	0	14	1
A	getTranslationAlias()	0	4	1
A	getRootAlias()	0	8	2
A	getLocales()	10	10	2

<?php

/*
 * This file is part of the Lug package.
 *
 * (c) Eric GELOEN <geloen.eric@gmail.com>
 *
 * For the full copyright and license information, please read the LICENSE
 * file that was distributed with this source code.
 */

namespace Lug\Component\Translation\Repository\Doctrine\ORM;

use Doctrine\ORM\EntityManager;
use Doctrine\ORM\Mapping\ClassMetadata;
use Doctrine\ORM\Query\Expr\Join;
use Doctrine\ORM\QueryBuilder;
use Lug\Component\Resource\Model\ResourceInterface;
use Lug\Component\Resource\Repository\Doctrine\ORM\RepositoryTrait;
use Lug\Component\Translation\Context\LocaleContextInterface;

/**
 * WARNING - This trait should only be used with a class extending an EntityRepository.
 *
 * @author GeLo <geloen.eric@gmail.com>
 */
trait TranslatableRepositoryTrait
{
    use RepositoryTrait {
        __construct as private constructFromRepositoryTrait;
        createQueryBuilder as private createQueryBuilderFromRepositoryTrait;
        getProperty as private getPropertyFromRepositoryTrait;
    }

    /**
     * @var LocaleContextInterface
     */
    private $localeContext;

    /**
     * @var string[]
     */
    private $cache;

    /**
     * @param EntityManager          $em
     * @param ClassMetadata          $class
     * @param ResourceInterface      $resource
     * @param LocaleContextInterface $localeContext
     */
    public function __construct(
        $em,
        ClassMetadata $class,
        ResourceInterface $resource,
        LocaleContextInterface $localeContext
    ) {
        $this->constructFromRepositoryTrait($em, $class, $resource);

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

        $this->localeContext = $localeContext;
    }

    /**
     * {@inheritdoc}
     */
    public function createQueryBuilder($alias = null, $indexBy = null)
    {
        $queryBuilder = $this->createQueryBuilderFromRepositoryTrait($alias, $indexBy);

The method createQueryBuilderFromRepositoryTrait() does not exist on Lug\Component\Translation\Repository\Doctrine\ORM\TranslatableRepositoryTrait. Did you maybe mean createQueryBuilder()?

        $queryBuilder
            ->addSelect($alias = $this->getTranslationAlias($queryBuilder))
            ->leftJoin($this->getProperty('translations', $queryBuilder), $alias);

        return $queryBuilder;
    }

    /**
     * {@inheritdoc}
     */
    public function createQueryBuilderForCollection($alias = null, $indexBy = null)
    {
        $queryBuilder = $this->createQueryBuilderFromRepositoryTrait($alias, $indexBy);

The method createQueryBuilderFromRepositoryTrait() does not exist on Lug\Component\Translation\Repository\Doctrine\ORM\TranslatableRepositoryTrait. Did you maybe mean createQueryBuilder()?

        $queryBuilder
            ->addSelect($alias = $this->getTranslationAlias($queryBuilder))
            ->innerJoin(
                $this->getProperty('translations', $queryBuilder),
                $alias,
                Join::WITH,
                $queryBuilder->expr()->in($this->getProperty('locale', $queryBuilder), $this->getLocales())
            );

        return $queryBuilder;
    }

    /**
     * {@inheritdoc}
     */
    public function getProperty($property, $root = null)
    {
        if ($this->cache === null) {
            $translatableFields = $this->getClassMetadata()->getFieldNames();

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

            $translationFields = $this->getEntityManager()

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

                ->getClassMetadata($this->getClassMetadata()->getAssociationMapping('translations')['targetEntity'])

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

                ->getFieldNames();

            $this->cache = array_diff($translationFields, $translatableFields);
        }

        if (($pos = strpos($property, '.')) !== false) {

This if statement is empty and can be removed.

        }

        if (in_array($property, $this->cache, true)) {
            $root = $this->getTranslationAlias($root);
        }

        return $this->getPropertyFromRepositoryTrait($property, $root);

The method getPropertyFromRepositoryTrait() does not exist on Lug\Component\Translation\Repository\Doctrine\ORM\TranslatableRepositoryTrait. Did you maybe mean getProperty()?

    }

    /**
     * @param QueryBuilder|string|null $root
     *
     * @return string
     */
    private function getTranslationAlias($root)
    {
        return $this->getRootAlias($root).'_translation';
    }

    /**
     * @param QueryBuilder|string|null $root
     *
     * @return string
     */
    private function getRootAlias($root)
    {
        if ($root instanceof QueryBuilder) {
            $root = $root->getRootAliases()[0];
        }

        return (string) $root;
    }

    /**
     * @return string[]
     */
    private function getLocales()

This method seems to be duplicated in your project.

    {
        $locales = $this->localeContext->getLocales();

        if (($fallbackLocale = $this->localeContext->getFallbackLocale()) !== null) {
            $locales[] = $fallbackLocale;
        }

        return $locales;
    }
}