SWP\Bundle\ContentBundle\Doctrine\ORM\ArticleRepository

Complexity

Total Complexity

53

Size/Duplication

Total Lines	281
Duplicated Lines	26.33 %

Coupling/Cohesion

Components	1
Dependencies	11

Test Coverage

Coverage

77.27%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	findOneBySlug()	0	6	1
A	findAllArticles()	0	4	1
A	getByCriteria()	0	13	1
A	countByCriteria()	0	16	2
A	getArticlesByCriteria()	0	28	3
A	getArticlesByCriteriaIds()	0	9	1
A	getPaginatedByCriteria()	11	11	2
A	getQueryForRouteArticles()	0	4	1
F	applyCustomFiltering()	63	153	41

<?php

declare(strict_types=1);

/*
 * This file is part of the Superdesk Web Publisher Content Bundle.
 *
 * Copyright 2016 Sourcefabric z.ú. and contributors.
 *
 * For the full copyright and license information, please see the
 * AUTHORS and LICENSE files distributed with this source code.
 *
 * @copyright 2016 Sourcefabric z.ú
 * @license http://www.superdesk.org/license
 */

namespace SWP\Bundle\ContentBundle\Doctrine\ORM;

use Doctrine\ORM\QueryBuilder;
use SWP\Bundle\ContentBundle\Model\ArticleSourceReference;
use SWP\Component\Common\Criteria\Criteria;
use SWP\Bundle\ContentBundle\Doctrine\ArticleRepositoryInterface;
use SWP\Bundle\ContentBundle\Model\ArticleInterface;
use SWP\Bundle\StorageBundle\Doctrine\ORM\EntityRepository;
use SWP\Component\Common\Pagination\PaginationData;
use SWP\Component\TemplatesSystem\Gimme\Meta\Meta;

/**
 * Class ArticleRepository.
 */
class ArticleRepository extends EntityRepository implements ArticleRepositoryInterface
{
    /**
     * {@inheritdoc}
     */
    public function findOneBySlug($slug)
    {
        return $this->findOneBy([
            'slug' => $slug,
        ]);
    }

    /**
     * {@inheritdoc}
     */
    public function findAllArticles()
    {
        return $this->getQueryByCriteria(new Criteria(), [], 'a')->getQuery()->getResult();
    }

    /**
     * {@inheritdoc}
     */
    public function getByCriteria(Criteria $criteria, array $sorting): QueryBuilder
    {
        $qb = $this->getQueryByCriteria($criteria, $sorting, 'a');
        $qb->andWhere('a.status = :status')
            ->setParameter('status', $criteria->get('status', ArticleInterface::STATUS_PUBLISHED))
            ->leftJoin('a.media', 'm')
            ->leftJoin('m.renditions', 'r')
            ->addSelect('m', 'r');

        $this->applyCustomFiltering($qb, $criteria);

        return $qb;
    }

    /**
     * {@inheritdoc}
     */
    public function countByCriteria(Criteria $criteria, $status = ArticleInterface::STATUS_PUBLISHED): int
    {
        $queryBuilder = $this->createQueryBuilder('a')
            ->select('COUNT(a.id)');

        if (null !== $status) {
            $queryBuilder
                ->where('a.status = :status')
                ->setParameter('status', $criteria->get('status', $status));
        }

        $this->applyCustomFiltering($queryBuilder, $criteria);
        $this->applyCriteria($queryBuilder, $criteria, 'a');

        return (int) $queryBuilder->getQuery()->getSingleScalarResult();
    }

    /**
     * {@inheritdoc}
     */
    public function getArticlesByCriteria(Criteria $criteria, array $sorting = []): QueryBuilder
    {
        $queryBuilder = $this->getArticlesByCriteriaIds($criteria);
        $queryBuilder->andWhere('a.route IS NOT NULL');
        $this->applyCustomFiltering($queryBuilder, $criteria);
        $this->applyCriteria($queryBuilder, $criteria, 'a');
        $this->applySorting($queryBuilder, $sorting, 'a', $criteria);
        $articlesQueryBuilder = clone $queryBuilder;
        $this->applyLimiting($queryBuilder, $criteria);
        $selectedArticles = $queryBuilder->getQuery()->getScalarResult();
        if (!is_array($selectedArticles)) {
            return [];
        }

        $ids = [];

        foreach ($selectedArticles as $partialArticle) {
            $ids[] = $partialArticle['a_id'];
        }
        $articlesQueryBuilder->addSelect('a')
            ->leftJoin('a.media', 'm')
            ->leftJoin('m.renditions', 'r')
            ->addSelect('m', 'r')
            ->andWhere('a.id IN (:ids)')
            ->setParameter('ids', $ids);

        return $articlesQueryBuilder;
    }

    /**
     * @param Criteria $criteria
     *
     * @return QueryBuilder
     */
    public function getArticlesByCriteriaIds(Criteria $criteria): QueryBuilder
    {
        $queryBuilder = $this->createQueryBuilder('a')
            ->select('partial a.{id}')
            ->where('a.status = :status')
            ->setParameter('status', $criteria->get('status', ArticleInterface::STATUS_PUBLISHED));

        return $queryBuilder;
    }

    /**
     * {@inheritdoc}
     */
    public function getPaginatedByCriteria(Criteria $criteria, array $sorting = [], PaginationData $paginationData = null)

This method seems to be duplicated in your project.

    {
        $queryBuilder = $this->getQueryByCriteria($criteria, $sorting, 'a');
        $this->applyCustomFiltering($queryBuilder, $criteria);

        if (null === $paginationData) {
            $paginationData = new PaginationData();
        }

        return $this->getPaginator($queryBuilder, $paginationData);
    }

    /**
     * {@inheritdoc}
     */
    public function getQueryForRouteArticles(string $identifier, array $order = [])
    {
        throw new \Exception('Not implemented');
    }

    private function applyCustomFiltering(QueryBuilder $queryBuilder, Criteria $criteria)
    {
        foreach (['metadata', 'extra', 'exclude_metadata', 'exclude_extra'] as $name) {
            if (!$criteria->has($name)) {
                continue;
            }

            if (!is_array($criteria->get($name))) {
                $criteria->remove($name);

                continue;
            }

            $orX = $queryBuilder->expr()->orX();
            foreach ($criteria->get($name) as $key => $value) {
                $search = ('***' !== $value) ? [$key => $value] : $key;
                if ('metadata' === $name || 'exclude_metadata' === $name) {
                    $valueExpression = \str_replace('{', '',
                        \str_replace('}', '',
                            '%'.\json_encode($search).'%'
                        )
                    );
                } else {
                    $valueExpression = '%'.\str_replace('a:1:{', '',
                        \str_replace(';}', ';',
                            \serialize($search).'%'
                        )
                    );
                }

                $valueExpression = $queryBuilder->expr()->literal($valueExpression);
                if (false === strpos($name, 'exclude_')) {
                    $orX->add($queryBuilder->expr()->like('a.'.$name, $valueExpression));
                } else {
                    $orX->add($queryBuilder->expr()->notLike('a.'.\str_replace('exclude_', '', $name), $valueExpression));
                }
            }

            $queryBuilder->andWhere($orX);
            $criteria->remove($name);
        }

        if ($criteria->has('keywords')) {
            $queryBuilder->leftJoin('a.keywords', 'k');
            $orX = $queryBuilder->expr()->orX();
            foreach ($criteria->get('keywords') as $key => $value) {

The expression $criteria->get('keywords') of type object|integer|double|string|null|boolean|array is not guaranteed to be traversable. How about adding an additional type check?

                $queryBuilder->setParameter($key, $value);
                $orX->add($queryBuilder->expr()->eq('k.name', '?'.$key));
                $orX->add($queryBuilder->expr()->eq('k.slug', '?'.$key));
            }

            $queryBuilder->andWhere($orX);
            $criteria->remove('keywords');
        }

        if ($criteria->has('publishedBefore') && null !== $criteria->get('publishedBefore')) {

This code seems to be duplicated across your project.

            $publishedBefore = $criteria->get('publishedBefore');
            $queryBuilder->andWhere('a.publishedAt < :before')
                ->setParameter('before', $publishedBefore instanceof \DateTimeInterface ? $publishedBefore : new \DateTime($publishedBefore));
            $criteria->remove('publishedBefore');
        }

        if ($criteria->has('publishedAfter') && null !== $criteria->get('publishedAfter')) {

This code seems to be duplicated across your project.

            $publishedAfter = $criteria->get('publishedAfter');
            $queryBuilder->andWhere('a.publishedAt > :after')
                ->setParameter('after', $publishedAfter instanceof \DateTimeInterface ? $publishedAfter : new \DateTime($publishedAfter));
            $criteria->remove('publishedAfter');
        }

        if ($criteria->has('query') && strlen($query = trim($criteria->get('query'))) > 0) {
            $like = $queryBuilder->expr()->like('a.title', $queryBuilder->expr()->literal('%'.$query.'%'));

            $queryBuilder->andWhere($like);
            $criteria->remove('query');
        }

        if ($criteria->has('exclude_source') && !empty($criteria->get('exclude_source'))) {

This code seems to be duplicated across your project.

            $articleSourcesQueryBuilder = $this->getEntityManager()
                ->createQueryBuilder()
                ->select('excluded_article.id')
                ->from(ArticleSourceReference::class, 'excluded_asr')
                ->join('excluded_asr.article', 'excluded_article')
                ->join('excluded_asr.articleSource', 'excluded_articleSource');

            $orX = $queryBuilder->expr()->orX();
            foreach ((array) $criteria->get('exclude_source') as $value) {
                $orX->add($articleSourcesQueryBuilder->expr()->eq('excluded_articleSource.name', $articleSourcesQueryBuilder->expr()->literal($value)));
            }
            $articleSourcesQueryBuilder->andWhere($orX);
            $queryBuilder->andWhere($queryBuilder->expr()->notIn('a.id', $articleSourcesQueryBuilder->getQuery()->getDQL()));

            $criteria->remove('exclude_source');
        }

        if ($criteria->has('source') && !empty($criteria->get('source'))) {

This code seems to be duplicated across your project.

            $articleSourcesQueryBuilder = $this->getEntityManager()
                ->createQueryBuilder()
                ->select('article.id')
                ->from(ArticleSourceReference::class, 'asr')
                ->join('asr.article', 'article')
                ->join('asr.articleSource', 'articleSource');
            $orX = $queryBuilder->expr()->orX();
            foreach ((array) $criteria->get('source') as $value) {
                $orX->add($articleSourcesQueryBuilder->expr()->eq('articleSource.name', $articleSourcesQueryBuilder->expr()->literal($value)));
            }
            $articleSourcesQueryBuilder->andWhere($orX);
            $queryBuilder->andWhere($queryBuilder->expr()->in('a.id', $articleSourcesQueryBuilder->getQuery()->getDQL()));

            $criteria->remove('source');
        }

        if (
            ($criteria->has('author') && !empty($criteria->get('author'))) ||
            ($criteria->has('exclude_author') && !empty($criteria->get('exclude_author')))
        ) {
            $queryBuilder->leftJoin('a.authors', 'au');
        }

        if ($criteria->has('author') && !empty($criteria->get('author'))) {

This code seems to be duplicated across your project.

            $orX = $queryBuilder->expr()->orX();
            foreach ((array) $criteria->get('author') as $value) {
                $orX->add($queryBuilder->expr()->eq('au.name', $queryBuilder->expr()->literal($value)));
            }

            $queryBuilder->andWhere($orX);
            $criteria->remove('author');
        }

        if ($criteria->has('exclude_author') && !empty($criteria->get('exclude_author'))) {

This code seems to be duplicated across your project.

            $andX = $queryBuilder->expr()->andX();
            foreach ((array) $criteria->get('exclude_author') as $value) {
                $andX->add($queryBuilder->expr()->neq('au.name', $queryBuilder->expr()->literal($value)));
            }

            $queryBuilder->andWhere($andX);
            $criteria->remove('exclude_author');
        }

        if ($criteria->has('exclude_article') && !empty($criteria->get('exclude_article'))) {
            $excludedArticles = [];
            foreach ((array) $criteria->get('exclude_article') as $value) {
                if (is_numeric($value)) {
                    $excludedArticles[] = $value;
                } elseif ($value instanceof Meta and $value->getValues() instanceof ArticleInterface) {
                    $excludedArticles[] = $value->getValues()->getId();
                }
            }

            $queryBuilder->andWhere('a.id NOT IN (:excludedArticles)')
                ->setParameter('excludedArticles', $excludedArticles);
            $criteria->remove('exclude_article');
        }
    }
}