CollectionAction::setFilterPropertyStrict() - Code Metrics - Inspection of "Update doctrine annotations | cache packages to co..." - R3VoLuT1OneR/doctrine-rest - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Pull Request — master (#11)

unknown

created 2024-02-26 16:19 UTC

CollectionAction::setFilterPropertyStrict() A

↳ Parent: CollectionAction

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	4
ccs	0
cts	0
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?php namespace Pz\Doctrine\Rest\Action;

use Doctrine\Common\Collections\Criteria;
use Doctrine\ORM\QueryBuilder;
use Doctrine\ORM\Tools\Pagination\Paginator;
use League\Fractal\Pagination\DoctrinePaginatorAdapter;
use Pz\Doctrine\Rest\BuilderChain\CriteriaChain;
use Pz\Doctrine\Rest\QueryParser\ArrayFilterParser;
use Pz\Doctrine\Rest\QueryParser\FilterParserAbstract;
use Pz\Doctrine\Rest\QueryParser\SearchFilterParser;
use Pz\Doctrine\Rest\Resource\Collection;
use Pz\Doctrine\Rest\RestAction;
use Pz\Doctrine\Rest\Contracts\RestRequestContract;
use Pz\Doctrine\Rest\RestResponse;
use Pz\Doctrine\Rest\RestResponseFactory;

/**
 * Action for providing collection (list or array) of data with API.
 */
class CollectionAction extends RestAction
{
    /**
     * Field that can be filtered if filter is string.
     *
     * @var string|null
     */
    protected $filterProperty;

    /**
     * Either to apply a loose or strict search.
     *
     * @var bool
     */
    protected $filterPropertyStrict = false;

    /**
     * Get list of filterable entity fields.
     *
     * @var array
     */
    protected $filterable = [];

    /**
     * @param string|null $property
     *
     * @return $this
     */
    public function setFilterProperty(?string $property): self
    {
        $this->filterProperty = $property;
        return $this;
    }

    /**
     * @param bool $filterPropertyStrict
     * @return $this
     */
    public function setFilterPropertyStrict(bool $filterPropertyStrict): self
    {
        $this->filterPropertyStrict = $filterPropertyStrict;
        return $this;
    }

    /**
     * @return bool
     */
    public function getFilterPropertyStrict()
    {
        return $this->filterPropertyStrict;
    }

    /**
     * @param array $filterable
     *
     * @return $this
     */
    public function setFilterable(array $filterable): self
    {
        $this->filterable = $filterable;
        return $this;
    }

    /**
     * Param that can be filtered if query is string.
     *
     * @return null|string
     */
    public function getStringFilterField()
    {
        return $this->filterProperty;
    }

    /**
     * Get list of filterable entity properties.
     *
     * @return array
     */
    public function getArrayFilterFields()
    {
        return $this->filterable;
    }

    /**
     * @param RestRequestContract $request
     * @return RestResponse
     * @throws \Doctrine\ORM\Query\QueryException
     */
    protected function handle($request)
    {
        $this->authorize($request, $this->repository()->getClassName());

        $qb = $this->repository()->sourceQueryBuilder($request);
        $this->applyPagination($request, $qb);
        $this->applyFilter($request, $qb);

        return RestResponseFactory::resource($request, $this->prepareCollection($request, $qb));
    }

    /**
     * @param RestRequestContract   $request
     * @param QueryBuilder          $qb
     * @return Collection
     */
    protected function prepareCollection($request, QueryBuilder $qb)
    {
        $paginator = new Paginator($qb, false);
        $collection = new Collection($paginator, $this->transformer(), $this->repository()->getResourceKey());

        if ($qb->getMaxResults()) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            $collection->setPaginator(
                new DoctrinePaginatorAdapter(
                    $paginator,
                    function(int $page) use ($request) {
                        // return !$resourceKey ? null : "{$request->getBaseUrl()}/$resourceKey?".http_build_query([
                        return $request->getBasePath().'?'.http_build_query([
                        return $request->/** @scrutinizer ignore-call */ getBasePath().'?'.http_build_query([
                            'page' => [
                                'number'    => $page,
                                'size'      => $request->getLimit()
                            ]
                        ]);
                    }
                )
            );
        }

        return $collection;
    }

    /**
     * @param RestRequestContract $request
     * @param QueryBuilder        $qb
     *
     * @throws \Doctrine\ORM\Query\QueryException
     * @return $this
     */
    protected function applyPagination(RestRequestContract $request, QueryBuilder $qb): self
    {
        $qb->addCriteria(
            new Criteria(null,
                $request->getOrderBy(),
                $request->getStart(),
                $request->getLimit()
            )
        );

        return $this;
    }

    /**
     * @param RestRequestContract $request
     * @param QueryBuilder        $qb
     *
     * @throws \Doctrine\ORM\Query\QueryException
     * @return $this
     */
    protected function applyFilter(RestRequestContract $request, QueryBuilder $qb): self
    {
        $qb->addCriteria(
            CriteriaChain::create($this->filterParsers($request))->process()
        );

        return $this;
    }

    /**
     * @param RestRequestContract $request
     *
     * @return array|FilterParserAbstract[]
     */
    protected function filterParsers(RestRequestContract $request)
    {
        return [
            new SearchFilterParser(
                $request,
                $this->getStringFilterField(),
                SearchFilterParser::SEARCH_KEY,
                $this->getFilterPropertyStrict()
            ),
            new ArrayFilterParser($request, $this->getArrayFilterFields()),
        ];
    }
}


R3VoLuT1OneR / doctrine-rest

Pull Request — master (#11)

CollectionAction::setFilterPropertyStrict() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like