Happyr\DoctrineSpecification\Specification\BaseSpecification

Complexity

Total Complexity

13

Size/Duplication

Total Lines	108
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getFilter()	0	10	2
A	modify()	0	8	2
A	filterCollection()	0	10	2
A	isSatisfiedBy()	0	10	2
	getSpec()	0	1	?
A	getContext()	0	8	2
A	getNestedContext()	0	8	2

<?php
declare(strict_types=1);

/**
 * This file is part of the Happyr Doctrine Specification package.
 *
 * (c) Tobias Nyholm <tobias@happyr.com>
 *     Kacper Gunia <kacper@gunia.me>
 *     Peter Gribanov <info@peter-gribanov.ru>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Happyr\DoctrineSpecification\Specification;

use Doctrine\ORM\QueryBuilder;
use Happyr\DoctrineSpecification\Filter\Filter;
use Happyr\DoctrineSpecification\Filter\Satisfiable;
use Happyr\DoctrineSpecification\Query\QueryModifier;

/**
 * Extend this abstract class if you want to build a new spec with your domain logic.
 */
abstract class BaseSpecification implements Specification
{
    /**
     * @var string|null
     */
    private $context;

    /**
     * @param string|null $context
     */
    public function __construct($context = null)
    {
        $this->context = $context;
    }

    /**
     * @param QueryBuilder $qb
     * @param string       $context
     *
     * @return string
     */
    public function getFilter(QueryBuilder $qb, string $context): string
    {
        $spec = $this->getSpec();

        if ($spec instanceof Filter) {
            return $spec->getFilter($qb, $this->getContext($context));
        }

        return '';
    }

    /**
     * @param QueryBuilder $qb
     * @param string       $context
     */
    public function modify(QueryBuilder $qb, string $context): void
    {
        $spec = $this->getSpec();

        if ($spec instanceof QueryModifier) {
            $spec->modify($qb, $this->getContext($context));
        }
    }

    /**
     * {@inheritdoc}
     */
    public function filterCollection(iterable $collection): iterable
    {
        $spec = $this->getSpec();

        if ($spec instanceof Satisfiable) {
            return $spec->filterCollection($collection);
        }

        return $collection;
    }

    /**
     * {@inheritdoc}
     */
    public function isSatisfiedBy($candidate): bool
    {
        $spec = $this->getSpec();

        if ($spec instanceof Satisfiable) {
            return $spec->isSatisfiedBy($candidate);
        }

        return true;
    }

    /**
     * Return all the specifications.
     *
     * @return Filter|QueryModifier
     */
    abstract protected function getSpec();

    /**
     * @param string $context
     *
     * @return string
     */
    private function getContext(string $context): string
    {
        if (null !== $this->context) {
            return sprintf('%s.%s', $context, $this->context);
        }

        return $context;
    }

    /**
     * @param string $context
     *
     * @return string
     */
    protected function getNestedContext(string $context): string
    {
        if (null !== $this->context) {
            return sprintf('%s.%s', $this->context, $context);
        }

        return $context;
    }
}