SWP\Bundle\ContentBundle\Loader\ArticleLoader

Complexity

Total Complexity

30

Size/Duplication

Total Lines	176
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Test Coverage

Coverage

92.42%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	13	1
C	load()	0	61	18
A	isSupported()	0	4	1
A	getArticleMeta()	0	8	2
C	getQueryString()	0	22	8

<?php

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

namespace SWP\Bundle\ContentBundle\Loader;

use PHPCR\Query\QueryInterface;
use SWP\Bundle\ContentBundle\Doctrine\ODM\PHPCR\ArticleInterface;
use SWP\Component\TemplatesSystem\Gimme\Context\Context;
use SWP\Component\TemplatesSystem\Gimme\Factory\MetaFactoryInterface;
use SWP\Component\TemplatesSystem\Gimme\Loader\LoaderInterface;
use SWP\Component\TemplatesSystem\Gimme\Meta\Meta;
use SWP\Component\TemplatesSystem\Gimme\Meta\MetaCollection;
use Doctrine\ODM\PHPCR\DocumentManager;
use SWP\Component\MultiTenancy\PathBuilder\TenantAwarePathBuilderInterface;

/**
 * Class ArticleLoader.
 */
class ArticleLoader implements LoaderInterface
{
    /**
     * @var DocumentManager
     */
    protected $dm;

    /**
     * @var TenantAwarePathBuilderInterface
     */
    protected $pathBuilder;

    /**
     * @var string
     */
    protected $routeBasepaths;

    /**
     * @var MetaFactoryInterface
     */
    protected $metaFactory;

    /**
     * @var Context
     */
    protected $context;

    /**
     * ArticleLoader constructor.
     *
     * @param DocumentManager                 $dm
     * @param TenantAwarePathBuilderInterface $pathBuilder
     * @param string                          $routeBasepaths
     * @param MetaFactoryInterface            $metaFactory
     * @param Context                         $context
     */
    public function __construct(
        DocumentManager $dm,
        TenantAwarePathBuilderInterface $pathBuilder,
        $routeBasepaths,
        MetaFactoryInterface $metaFactory,
        Context $context
    ) {
        $this->dm = $dm;
        $this->pathBuilder = $pathBuilder;
        $this->routeBasepaths = $routeBasepaths;
        $this->metaFactory = $metaFactory;
        $this->context = $context;
    }

    /**
     * Load meta object by provided type and parameters.
     *
     * @MetaLoaderDoc(
     *     description="Article Loader loads articles from Content Repository",
     *     parameters={
     *         contentPath="SINGLE|required content path",
     *         slug="SINGLE|required content slug",
     *         pageName="COLLECTiON|name of Page for required articles"
     *     }
     * )
     *
     * @param string $type         object type
     * @param array  $parameters   parameters needed to load required object type
     * @param int    $responseType response type: single meta (LoaderInterface::SINGLE) or collection of metas (LoaderInterface::COLLECTION)
     *
     * @return Meta|Meta[]|bool false if meta cannot be loaded, a Meta instance otherwise
     *
     * @throws \Exception
     */
    public function load($type, $parameters = [], $responseType = LoaderInterface::SINGLE)
    {
        $article = null;

        if ($responseType === LoaderInterface::SINGLE) {
            if (array_key_exists('contentPath', $parameters)) {
                $article = $this->dm->find('SWP\Bundle\ContentBundle\Doctrine\ODM\PHPCR\Article', $parameters['contentPath']);
                if (null !== $article && !$article->isPublished()) {
                    $article = null;
                }
            } elseif (array_key_exists('article', $parameters)) {
                $this->dm->detach($parameters['article']);
                $article = $this->dm->find('SWP\Bundle\ContentBundle\Doctrine\ODM\PHPCR\Article', $parameters['article']->getId());
                if (null !== $article && !$article->isPublished()) {
                    $article = null;
                }
            } elseif (array_key_exists('slug', $parameters)) {
                $article = $this->dm->getRepository('SWP\Bundle\ContentBundle\Doctrine\ODM\PHPCR\Article')->findOneBy([
                    'slug' => $parameters['slug'],
                    'status' => ArticleInterface::STATUS_PUBLISHED,
                ]);
            }

            return $this->getArticleMeta($article);
        } elseif ($responseType === LoaderInterface::COLLECTION) {
            $route = null;
            if (array_key_exists('route', $parameters)) {
                $route = $this->dm->find(null, $this->pathBuilder->build($this->routeBasepaths[0].$parameters['route']));

It seems like $this->pathBuilder->build($this->routeBasepaths[0] . $parameters['route']) targeting SWP\Component\MultiTenancy\PathBuilder\TenantAwarePathBuilderInterface::build() can also be of type array; however, Doctrine\ODM\PHPCR\DocumentManager::find() does only seem to accept string, maybe add an additional type check?

            } elseif (null !== ($currentPage = $this->context->getCurrentPage())) {
                $route = $currentPage->getValues();
            }

            if (null !== $route && is_object($route)) {
                $identifier = $this->dm->getNodeForDocument($route)->getIdentifier();
                $query = $this->dm->createPhpcrQuery($this->getQueryString($identifier, $parameters), QueryInterface::JCR_SQL2);
                $countQuery = clone $query;

                if (isset($parameters['limit'])) {
                    $query->setLimit($parameters['limit']);
                }

                if (isset($parameters['start'])) {
                    $query->setOffset($parameters['start']);
                }

                $articles = $this->dm->getDocumentsByPhpcrQuery($query);
                $metaCollection = new MetaCollection();
                $metaCollection->setTotalItemsCount($countQuery->execute()->getRows()->count());
                foreach ($articles as $article) {
                    $articleMeta = $this->getArticleMeta($article);

Are you sure the assignment to $articleMeta is correct as $this->getArticleMeta($article) (which targets SWP\Bundle\ContentBundle\Loader\ArticleLoader::getArticleMeta()) seems to always return null.

                    if ($articleMeta) {
                        $metaCollection->add($articleMeta);
                    }
                }

                return $metaCollection;
            }
        }

        return;
    }

    /**
     * Checks if Loader supports provided type.
     *
     * @param string $type
     *
     * @return bool
     */
    public function isSupported($type)
    {
        return in_array($type, ['articles', 'article']);
    }

    private function getArticleMeta($article)
    {
        if (!is_null($article)) {
            return $this->metaFactory->create($article);
        }

        return;
    }

    private function getQueryString($identifier, $parameters)
    {
        $queryStr = sprintf("SELECT * FROM [nt:unstructured] as S WHERE S.phpcr:class='SWP\Bundle\ContentBundle\Doctrine\ODM\PHPCR\Article' AND S.route=%s AND S.status=published", $identifier);
        if (isset($parameters['order'])) {
            $order = $parameters['order'];
            if (!is_array($order) || count($order) !== 2 || (strtoupper($order[1]) != 'ASC' && strtoupper($order[1]) != 'DESC')) {
                throw new \Exception('Order filter must have two parameters with second one asc or desc, e.g. order(id, desc)');
            }
            if ($order[0] === 'id') {
                $order[0] = 'jcr:uuid';
            } else {
                // Check that the given parameter is actually a field name of a route
                $metaData = $this->dm->getClassMetadata('SWP\Bundle\ContentBundle\Doctrine\ODM\PHPCR\Article');
                if (!in_array($order[0], $metaData->getFieldNames())) {
                    throw new \Exception('Order parameter must be id or the name of one of the fields in the route class');
                }
            }
            $queryStr .= sprintf(' ORDER BY S.%s %s', $order[0], $order[1]);
        }

        return $queryStr;
    }
}