NodeTranslationRepository::getTopNodeTranslations() - Code Metrics - Inspection of "Merge branch '5.3'" - Kunstmaan/KunstmaanBundlesCMS - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( 770316...74fc07 )

by Jeroen
created 2019-10-18 13:07 UTC
getTopNodeTranslations() A

↳ Parent: NodeTranslationRepository
Complexity

Conditions	1
Paths	1
Size

Total Lines
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	2
Importance

Changes
Metric	Value
dl	0
loc	16
ccs	0
cts	12
cp	0
rs	9.7333
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	2
<?php

namespace Kunstmaan\NodeBundle\Repository;

use Doctrine\ORM\EntityRepository;
use Doctrine\ORM\Query\ResultSetMappingBuilder;
use Doctrine\ORM\QueryBuilder;
use Kunstmaan\AdminBundle\Entity\BaseUser;
use Kunstmaan\NodeBundle\Entity\HasNodeInterface;
use Kunstmaan\NodeBundle\Entity\Node;
use Kunstmaan\NodeBundle\Entity\NodeTranslation;
use Kunstmaan\NodeBundle\Entity\NodeVersion;
use Kunstmaan\UtilitiesBundle\Helper\ClassLookup;

/**
 * NodeRepository
 */
class NodeTranslationRepository extends EntityRepository
{
    /**
     * Get the QueryBuilder based on node id and language.
     *
     * @param int    $nodeId
     * @param string $lang
     *
     * @return array_shift($result)

     */
    public function getNodeTranslationByNodeIdQueryBuilder($nodeId, $lang)
    {
        $qb = $this->createQueryBuilder('nt')
            ->select('nt')
            ->innerJoin('nt.node', 'n', 'WITH', 'nt.node = n.id')
            ->where('n.deleted != 1')
            ->andWhere('nt.online = 1')
            ->andWhere('nt.lang = :lang')
            ->setParameter('lang', $lang)
            ->andWhere('n.id = :node_id')
            ->setParameter('node_id', $nodeId)
            ->setFirstResult(0)
            ->setMaxResults(1);

        return $qb->getQuery()->getOneOrNullResult();
    }

    /**
     * Get max children weight
     *
     * @param Node   $parentNode

     * @param string $lang       (optional) Only return max weight for the

     *                           given language
     *
     * @return int
     */
    public function getMaxChildrenWeight(Node $parentNode = null, $lang = null)
    {
        $maxWeight = $this->getNodeTranslationsQueryBuilder($lang)
            ->select('max(nt.weight)')
            ->andWhere('n.parent = :parentNode')
            ->setParameter('parentNode', $parentNode)
            ->getQuery()
            ->getSingleScalarResult();

        return (int) $maxWeight;
    }

    /**
     * QueryBuilder to fetch node translations (ignoring nodes that have been
     * deleted)
     *
     * @param string $lang (optional) Only return NodeTranslations for the

     *                     given language
     *
     * @return \Doctrine\ORM\QueryBuilder
     */
    public function getNodeTranslationsQueryBuilder($lang = null)
    {
        $queryBuilder = $this->createQueryBuilder('nt')
            ->select('nt,n,v')
            ->innerJoin('nt.node', 'n')
            ->leftJoin(
                'nt.publicNodeVersion',
                'v',
                'WITH',
                'nt.publicNodeVersion = v.id'
            )
            ->where('n.deleted = false')
            ->orderBy('nt.weight')
            ->addOrderBy('nt.weight');

        if (!empty($lang)) {
            $queryBuilder
                ->andWhere('nt.lang = :lang')
                ->setParameter('lang', $lang);
        }

        return $queryBuilder;
    }

    /**
     * QueryBuilder to fetch node translations that are currently published
     * (ignoring nodes that have been deleted)
     *
     * @param string $lang (optional) Only return NodeTranslations for the

     *                     given language
     *
     * @return \Doctrine\ORM\QueryBuilder
     */
    public function getOnlineNodeTranslationsQueryBuilder($lang = null)
    {
        return $this->getNodeTranslationsQueryBuilder($lang)
            ->andWhere('nt.online = true');
    }

    /**
     * QueryBuilder to fetch immediate child NodeTranslations for a specific
     * node and (optional) language
     *
     * @return \Doctrine\ORM\QueryBuilder
     */
    public function getChildrenQueryBuilder(Node $parent, $lang = null)
    {
        return $this->getNodeTranslationsQueryBuilder($lang)
            ->andWhere('n.parent = :parent')
            ->setParameter('parent', $parent);
    }

    /**
     * QueryBuilder to fetch immediate child NodeTranslations for a specific
     * node and (optional) language that are currently published
     *
     * @return \Doctrine\ORM\QueryBuilder
     */
    public function getOnlineChildrenQueryBuilder(Node $parent, $lang = null)
    {
        return $this->getChildrenQueryBuilder($parent, $lang)
            ->andWhere('nt.online = true');
    }

    /**
     * Get all online child node translations for a given node and (optional)
     * language
     *
     * @param Node   $parent
     * @param string $lang   (optional, if not specified all languages will be

     *                       returned)
     *
     * @return array
     */
    public function getOnlineChildren(Node $parent, $lang = null)
    {
        return $this->getOnlineChildrenQueryBuilder($parent, $lang)
            ->getQuery()->getResult();
    }

    /**
     * Finds all nodetranslations where title is like the given $title parameter
     *
     *
     * @param string $title
     * @param string $lang  (optional, if not specified all languages will be

     *                      returned)
     *
     * @return array
     */
    public function getNodeTranslationsLikeTitle($title, $lang = null)
    {
        /** @var QueryBuilder $qb */
        $qb = $this->getNodeTranslationsQueryBuilder($lang);
        $qb->andWhere('nt.title like :title')
            ->setParameter('title', '%' . $title . '%');

        return $qb->getQuery()->getResult();
    }

    /**
     * Get the node translation for a node
     *
     * @param HasNodeInterface $hasNode
     *
     * @return NodeTranslation

     */
    public function getNodeTranslationFor(HasNodeInterface $hasNode)
    {
        /* @var NodeVersion $nodeVersion */
        $nodeVersion = $this->getEntityManager()
            ->getRepository('KunstmaanNodeBundle:NodeVersion')
            ->getNodeVersionFor($hasNode);

        if (!\is_null($nodeVersion)) {
            return $nodeVersion->getNodeTranslation();
        }

        return null;
    }

    /**
     * Get the node translation for a given slug string
     *
     * @param string               $slug       The slug
     * @param NodeTranslation|null $parentNode The parentnode
     *
     * @return NodeTranslation|null
     */
    public function getNodeTranslationForSlug(
        $slug,
        NodeTranslation $parentNode = null
    ) {
        if (empty($slug)) {
            return $this->getNodeTranslationForSlugPart(null, $slug);
        }

        $slugParts = explode('/', $slug);
        $result = $parentNode;
        foreach ($slugParts as $slugPart) {
            $result = $this->getNodeTranslationForSlugPart($result, $slugPart);
        }

        return $result;
    }

    /**
     * Returns the node translation for a given slug
     *
     * @param NodeTranslation|null $parentNode The parentNode
     * @param string               $slugPart   The slug part
     *
     * @return NodeTranslation|null
     */
    private function getNodeTranslationForSlugPart(
        NodeTranslation $parentNode = null,
        $slugPart = ''
    ) {
        $qb = $this->createQueryBuilder('t')
            ->select('t', 'v', 'n')
            ->innerJoin('t.node', 'n', 'WITH', 't.node = n.id')
            ->leftJoin(
                't.publicNodeVersion',
                'v',
                'WITH',
                't.publicNodeVersion = v.id'
            )
            ->where('n.deleted != 1')
            ->setFirstResult(0)
            ->setMaxResults(1);

        if ($parentNode !== null) {
            $qb->andWhere('t.slug = :slug')
                ->andWhere('n.parent = :parent')
                ->setParameter('slug', $slugPart)
                ->setParameter('parent', $parentNode->getNode()->getId());
        } else {
            /* if parent is null we should look for slugs that have no parent */
            $qb->andWhere('n.parent IS NULL');
            if (empty($slugPart)) {
                $qb->andWhere('t.slug is NULL');
            } else {
                $qb->andWhere('t.slug = :slug');
                $qb->setParameter('slug', $slugPart);
            }
        }

        return $qb->getQuery()->getOneOrNullResult();
    }

    /**
     * Get the node translation for a given url
     *
     * @param string          $urlSlug        The full url
     * @param string          $locale         The locale
     * @param bool            $includeDeleted Include deleted nodes
     * @param NodeTranslation $toExclude      Optional NodeTranslation instance

     *                                        you wish to exclude
     * @param Node            $rootNode       Optional Root node of the tree you

     *                                        wish to use
     *
     * @return array
     */
    public function getAllNodeTranslationsForUrl(
        $urlSlug,
        $locale = '',
        $includeDeleted = false,
        NodeTranslation $toExclude = null,
        Node $rootNode = null
    ) {
        $qb = $this->createQueryBuilder('b')
            ->select('b', 'v')
            ->innerJoin('b.node', 'n', 'WITH', 'b.node = n.id')
            ->leftJoin(
                'b.publicNodeVersion',
                'v',
                'WITH',
                'b.publicNodeVersion = v.id'
            )
            ->addOrderBy('b.online', 'DESC')
            ->setFirstResult(0)
            ->setMaxResults(1);

        if (!$includeDeleted) {
            $qb->andWhere('n.deleted = 0');
        }

        if (!empty($locale)) {
            $qb->andWhere('b.lang = :lang')
                ->setParameter('lang', $locale);
        }

        if (empty($urlSlug)) {
            $qb->andWhere('b.url IS NULL');
        } else {
            $qb->andWhere('b.url = :url');
            $qb->setParameter('url', $urlSlug);
        }

        if (!\is_null($toExclude)) {
            $qb->andWhere('NOT b.id = :exclude_id')
                ->setParameter('exclude_id', $toExclude->getId());
        }

        if ($rootNode) {
            $qb->andWhere('n.lft >= :left')
                ->andWhere('n.rgt <= :right')
                ->setParameter('left', $rootNode->getLeft())
                ->setParameter('right', $rootNode->getRight());
        }

        return $qb->getQuery()->getResult();
    }

    /**
     * Get the node translation for a given url
     *
     * @param string          $urlSlug        The full url
     * @param string          $locale         The locale
     * @param bool            $includeDeleted Include deleted nodes
     * @param NodeTranslation $toExclude      Optional NodeTranslation instance

     *                                        you wish to exclude
     * @param Node            $rootNode       Optional Root node of the tree you

     *                                        wish to use
     *
     * @return NodeTranslation|null
     */
    public function getNodeTranslationForUrl(
        $urlSlug,
        $locale = '',
        $includeDeleted = false,
        NodeTranslation $toExclude = null,
        Node $rootNode = null
    ) {
        $translations = $this->getAllNodeTranslationsForUrl($urlSlug, $locale, $includeDeleted, $toExclude, $rootNode);

        if (empty($translations)) {
            return null;
        }

        return $translations[0];
    }

    /**
     * Get all top node translations
     *
     * @return NodeTranslation[]
     */
    public function getTopNodeTranslations()
    {
        $qb = $this->createQueryBuilder('b')
            ->select('b', 'v')
            ->innerJoin('b.node', 'n', 'WITH', 'b.node = n.id')
            ->leftJoin(
                'b.publicNodeVersion',
                'v',
                'WITH',
                'b.publicNodeVersion = v.id'
            )
            ->where('n.parent IS NULL')
            ->andWhere('n.deleted != 1');

        return $qb->getQuery()->getResult();
    }

    /**
     * Create a node translation for a given node
     *
     * @param HasNodeInterface $hasNode The hasNode
     * @param string           $lang    The locale
     * @param Node             $node    The node
     * @param BaseUser         $owner   The user
     *
     * @throws \InvalidArgumentException
     *
     * @return NodeTranslation
     */
    public function createNodeTranslationFor(
        HasNodeInterface $hasNode,
        $lang,
        Node $node,
        BaseUser $owner
    ) {
        $em = $this->getEntityManager();
        $className = ClassLookup::getClass($hasNode);
        if (!$hasNode->getId() > 0) {
            throw new \InvalidArgumentException(
                'The entity of class ' . $className .
                ' has no id, maybe you forgot to flush first'
            );
        }

        $nodeTranslation = new NodeTranslation();
        $nodeTranslation
            ->setNode($node)
            ->setLang($lang)
            ->setTitle($hasNode->getTitle())
            ->setOnline(false)
            ->setWeight(0);

        $em->persist($nodeTranslation);

        $nodeVersion = $em->getRepository('KunstmaanNodeBundle:NodeVersion')
            ->createNodeVersionFor(
                $hasNode,
                $nodeTranslation,
                $owner,
                null
            );

        $nodeTranslation->setPublicNodeVersion($nodeVersion);
        $em->persist($nodeTranslation);
        $em->flush();
        $em->refresh($nodeTranslation);
        $em->refresh($node);

        return $nodeTranslation;
    }

    /**
     * Add a draft node version for a given node
     *
     * @param HasNodeInterface $hasNode The hasNode
     * @param string           $lang    The locale
     * @param Node             $node    The node
     * @param BaseUser         $owner   The user
     *
     * @throws \InvalidArgumentException
     *
     * @return NodeTranslation

     */
    public function addDraftNodeVersionFor(
        HasNodeInterface $hasNode,
        $lang,
        Node $node,
        BaseUser $owner
    ) {
        $em = $this->getEntityManager();
        $className = ClassLookup::getClass($hasNode);
        if (!$hasNode->getId() > 0) {
            throw new \InvalidArgumentException(
                'The entity of class ' . $className .
                ' has no id, maybe you forgot to flush first'
            );
        }

        $nodeTranslation = $em->getRepository('KunstmaanNodeBundle:NodeTranslation')->findOneBy(['lang' => $lang, 'node' => $node]);

        $em->getRepository('KunstmaanNodeBundle:NodeVersion')
            ->createNodeVersionFor(
                $hasNode,
                $nodeTranslation,
                $owner,
                null,
                NodeVersion::DRAFT_VERSION
            );

        $em->refresh($nodeTranslation);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        $em->refresh($node);

        return $nodeTranslation;
    }

    /**
     * Find best match for given URL and locale
     *
     * @param string $urlSlug The slug
     * @param string $locale  The locale
     *
     * @return NodeTranslation
     */
    public function getBestMatchForUrl($urlSlug, $locale)
    {
        $em = $this->getEntityManager();

        $rsm = new ResultSetMappingBuilder($em);
        $rsm->addRootEntityFromClassMetadata(
            'Kunstmaan\NodeBundle\Entity\NodeTranslation',
            'nt'
        );

        $query = $em
            ->createNativeQuery(
                'select nt.*
                from kuma_node_translations nt
                join kuma_nodes n on n.id = nt.node_id
                where n.deleted = 0 and nt.lang = :lang and locate(nt.url, :url) = 1
                order by length(nt.url) desc limit 1',
                $rsm
            );
        $query->setParameter('lang', $locale);
        $query->setParameter('url', $urlSlug);

        return $query->getOneOrNullResult();
    }

    /**
     * Test if all parents of the specified NodeTranslation have a node
     * translation for the specified language
     *
     * @param NodeTranslation $nodeTranslation The node translation
     * @param string          $language        The locale
     *
     * @return bool
     */
    public function hasParentNodeTranslationsForLanguage(
        NodeTranslation $nodeTranslation,
        $language
    ) {
        $parentNode = $nodeTranslation->getNode()->getParent();
        if ($parentNode !== null) {
            $parentNodeTranslation = $parentNode->getNodeTranslation(
                $language,
                true
            );
            if ($parentNodeTranslation !== null) {
                return $this->hasParentNodeTranslationsForLanguage(
                    $parentNodeTranslation,
                    $language
                );
            }

            return false;
        }

        return true;
    }

    /**
     * This will return 1 NodeTranslation by default (if one exists).
     * Just give it the internal name as defined on the Node in the database
     * and the language.
     *
     * It'll only return the latest version. It'll also hide deleted & offline
     * nodes.
     *
     * @param $language
     * @param $internalName
     */
    public function getNodeTranslationByLanguageAndInternalName(
        $language,
        $internalName
    ) {
        $qb = $this->createQueryBuilder('nt')
            ->select('nt', 'v')
            ->innerJoin('nt.node', 'n', 'WITH', 'nt.node = n.id')
            ->leftJoin(
                'nt.publicNodeVersion',
                'v',
                'WITH',
                'nt.publicNodeVersion = v.id'
            )
            ->where('n.deleted != 1')
            ->andWhere('nt.online = 1')
            ->setFirstResult(0)
            ->setMaxResults(1);

        $qb->andWhere('nt.lang = :lang')
            ->setParameter('lang', $language);

        $qb->andWhere('n.internalName = :internal_name')
            ->setParameter('internal_name', $internalName);

        return $qb->getQuery()->getOneOrNullResult();
    }

    public function getAllNodeTranslationsByRefEntityName($refEntityName)
    {
        $qb = $this->createQueryBuilder('nt')
            ->select('nt,n')
            ->innerJoin('nt.publicNodeVersion', 'nv')
            ->innerJoin('nt.node', 'n')
            ->where('nv.refEntityName = :refEntityName')
            ->setParameter('refEntityName', $refEntityName);

        return $qb->getQuery()->getResult();
    }

    public function getParentNodeTranslation(NodeTranslation $nodeTranslation)
    {
        $parent = $nodeTranslation->getNode()->getParent();
        if (\is_null($parent)) {
            return null;
        }

        $qb = $this->createQueryBuilder('nt')
            ->select('nt,n')
            ->innerJoin('nt.publicNodeVersion', 'nv')
            ->innerJoin('nt.node', 'n')
            ->where('nt.node = :parent')
            ->andWhere('n.deleted = 0')
            ->andWhere('nt.lang = :lang')
            ->setParameter('parent', $parent)
            ->setParameter('lang', $nodeTranslation->getLang());

        return $qb->getQuery()->getOneOrNullResult();
    }
}

Kunstmaan / KunstmaanBundlesCMS

Push — master ( 770316...74fc07 )

getTopNodeTranslations() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
