Lug\Component\Resource\Repository\Doctrine\MongoDB\RepositoryTrait

Complexity

Total Complexity

24

Size/Duplication

Total Lines	157
Duplicated Lines	19.75 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	1
A	findForIndex()	0	4	1
A	findForShow()	0	4	1
A	findForUpdate()	0	4	1
A	findForDelete()	0	4	1
A	findOneBy()	0	4	1
A	findBy()	14	14	3
A	createQueryBuilderForCollection()	0	4	1
A	createDataSourceBuilder()	0	4	1
A	getProperty()	0	8	3
A	buildQueryBuilder()	9	9	2
B	applyCriteria()	0	12	5
A	applySorting()	8	8	3

<?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\Resource\Repository\Doctrine\MongoDB;

use Doctrine\ODM\MongoDB\DocumentManager;
use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
use Doctrine\ODM\MongoDB\Query\Builder;
use Doctrine\ODM\MongoDB\UnitOfWork;
use Lug\Component\Grid\DataSource\Doctrine\MongoDB\DataSourceBuilder;
use Lug\Component\Resource\Model\ResourceInterface;
use Pagerfanta\Adapter\DoctrineODMMongoDBAdapter;
use Pagerfanta\Pagerfanta;

/**
 * WARNING - This trait should only be used with a class extending an DocumentRepository.
 *
 * @author GeLo <geloen.eric@gmail.com>
 */
trait RepositoryTrait
{
    /**
     * @var ResourceInterface
     */
    private $resource;

    /***
     * @param DocumentManager   $dm
     * @param UnitOfWork        $uow
     * @param ClassMetadata     $class
     * @param ResourceInterface $resource
     */
    public function __construct(
        DocumentManager $dm,
        UnitOfWork $uow,
        ClassMetadata $class,
        ResourceInterface $resource
    ) {
        parent::__construct($dm, $uow, $class);

        $this->resource = $resource;
    }

    /**
     * {@inheritdoc}
     */
    public function findForIndex(array $criteria, array $orderBy = [])
    {
        return new Pagerfanta(new DoctrineODMMongoDBAdapter($this->buildQueryBuilder($criteria, $orderBy, true)));
    }

    /**
     * {@inheritdoc}
     */
    public function findForShow(array $criteria, array $orderBy = [])
    {
        return $this->findOneBy($criteria, $orderBy);
    }

    /**
     * {@inheritdoc}
     */
    public function findForUpdate(array $criteria, array $orderBy = [])
    {
        return $this->findOneBy($criteria, $orderBy);
    }

    /**
     * {@inheritdoc}
     */
    public function findForDelete(array $criteria, array $orderBy = [])
    {
        return $this->findOneBy($criteria, $orderBy);
    }

    /**
     * {@inheritdoc}
     */
    public function findOneBy(array $criteria, array $orderBy = [])
    {
        return $this->buildQueryBuilder($criteria, $orderBy)->getQuery()->getSingleResult();
    }

    /**
     * {@inheritdoc}
     */
    public function findBy(array $criteria, array $orderBy = [], $limit = null, $offset = null)

This method seems to be duplicated in your project.

    {
        $queryBuilder = $this->buildQueryBuilder($criteria, $orderBy);

        if ($limit !== null) {
            $queryBuilder->limit($limit);
        }

        if ($offset !== null) {
            $queryBuilder->skip($offset);
        }

        return $queryBuilder->getQuery()->getIterator()->toArray();
    }

    /**
     * {@inheritdoc}
     */
    public function createQueryBuilderForCollection()
    {
        return $this->createQueryBuilder();

The method createQueryBuilder() does not exist on Lug\Component\Resource\Repository\Doctrine\MongoDB\RepositoryTrait. Did you maybe mean createQueryBuilderForCollection()?

    }

    /**
     * {@inheritdoc}
     */
    public function createDataSourceBuilder(array $options = [])
    {
        return new DataSourceBuilder($this, $options);
    }

    /**
     * {@inheritdoc}
     */
    public function getProperty($property, $root = null)
    {
        if (is_string($root) && !empty($root)) {
            return $root.'.'.$property;
        }

        return $property;
    }

    /**
     * @param mixed[]  $criteria
     * @param string[] $orderBy
     * @param bool     $collection
     *
     * @return Builder
     */
    protected function buildQueryBuilder(array $criteria, array $orderBy, $collection = false)

This method seems to be duplicated in your project.

    {
        $queryBuilder = $collection ? $this->createQueryBuilderForCollection() : $this->createQueryBuilder();

The method createQueryBuilder() does not exist on Lug\Component\Resource\Repository\Doctrine\MongoDB\RepositoryTrait. Did you maybe mean createQueryBuilderForCollection()?

        $this->applyCriteria($queryBuilder, $criteria);
        $this->applySorting($queryBuilder, $orderBy);

        return $queryBuilder;
    }

    /**
     * @param Builder $queryBuilder
     * @param mixed[] $criteria
     */
    private function applyCriteria(Builder $queryBuilder, array $criteria = null)
    {
        foreach ($criteria as $property => $value) {

The expression $criteria of type null|array<integer,*> is not guaranteed to be traversable. How about adding an additional type check?

            if ($value === null) {
                $queryBuilder->field($this->getProperty($property, $queryBuilder))->equals(null);
            } elseif (is_array($value)) {
                $queryBuilder->field($this->getProperty($property, $queryBuilder))->in($value);
            } elseif ($value !== null) {
                $queryBuilder->field($this->getProperty($property, $queryBuilder))->equals($value);
            }
        }
    }

    /**
     * @param Builder  $queryBuilder
     * @param string[] $orderBy
     */
    private function applySorting(Builder $queryBuilder, array $orderBy = [])

This method seems to be duplicated in your project.

    {
        foreach ($orderBy as $property => $order) {
            if (!empty($order)) {
                $queryBuilder->sort($this->getProperty($property, $queryBuilder), $order);
            }
        }
    }
}