Rb\Specification\Doctrine\SpecificationRepositoryTrait

Complexity

Total Complexity

6

Size/Duplication

Total Lines	70
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	match()	0	14	2
A	modifyQueryBuilder()	0	10	2
A	modifyQuery()	0	10	2

<?php

namespace Rb\Specification\Doctrine;

use Doctrine\ORM\Query;
use Doctrine\ORM\QueryBuilder;
use Rb\Specification\Doctrine\Exception\LogicException;
use Rb\Specification\Doctrine\Result\ModifierInterface;

/**
 * Class SpecificationRepositoryTrait.
 */
trait SpecificationRepositoryTrait
{
    /**
     * @var string
     */
    protected $dqlAlias = 'e';

    /**
     * @see SpecificationAware::match()
     *
     * @param SpecificationInterface $specification
     * @param ModifierInterface|null $modifier
     *
     * @return Query
     * @throws LogicException
     */
    public function match(SpecificationInterface $specification, ModifierInterface $modifier = null)
    {
        if (! $specification->isSatisfiedBy($this->getEntityName())) {

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

            throw new LogicException(sprintf(
                'Specification "%s" not supported by this repository!',
                get_class($specification)
            ));
        }

        $queryBuilder = $this->createQueryBuilder($this->dqlAlias);

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

        $this->modifyQueryBuilder($queryBuilder, $specification);

        return $this->modifyQuery($queryBuilder, $modifier);
    }

    /**
     * Modifies the QueryBuilder according to the passed Specification.
     * Will also set the condition for this query if needed.
     *
     * @param QueryBuilder           $queryBuilder
     * @param SpecificationInterface $specification
     *
     * @internal param string $dqlAlias
     */
    private function modifyQueryBuilder(QueryBuilder $queryBuilder, SpecificationInterface $specification)
    {
        $condition = $specification->modify($queryBuilder, $this->dqlAlias);

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

        $queryBuilder->where($condition);
    }

    /**
     * Modifies and returns a Query object according to the (optional) result modifier.
     *
     * @param QueryBuilder           $queryBuilder
     * @param ModifierInterface|null $modifier
     *
     * @return Query
     */
    private function modifyQuery(QueryBuilder $queryBuilder, ModifierInterface $modifier = null)
    {
        $query = $queryBuilder->getQuery();

        if ($modifier) {
            $modifier->modify($query);
        }

        return $query;
    }
}