Sulu\Bundle\PageBundle\Repository\NodeRepository

Complexity

Total Complexity

68

Size/Duplication

Total Lines	720
Duplicated Lines	2.64 %

Coupling/Cohesion

Components	2
Dependencies	13

Importance

Changes

0

24 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	19	1
A	getMapper()	0	4	1
A	getFullNameByUserId()	0	4	1
B	prepareNode()	11	42	5
A	setApiBasePath()	0	4	1
A	getNode()	0	21	3
A	getIndexNode()	0	6	1
A	deleteNode()	0	5	1
A	getReferences()	0	7	1
A	getNodes()	0	33	2
A	getNodesByIds()	0	33	2
A	getWebspaceNode()	0	23	2
A	getWebspaceNodes()	0	19	2
A	createWebspaceNode()	0	38	3
B	getFilteredNodes()	0	46	6
A	getParentNode()	0	8	2
B	prepareNodesTree()	0	34	6
A	getNodesTree()	8	34	4
B	loadNodeAndAncestors()	0	43	10
B	iterateTiers()	0	32	6
A	loadExtensionData()	0	25	1
A	saveExtensionData()	0	30	1
A	orderAt()	0	15	4
A	copyLocale()	0	11	2

<?php

/*
 * This file is part of Sulu.
 *
 * (c) MASSIVE ART WebServices GmbH
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Sulu\Bundle\PageBundle\Repository;

use PHPCR\RepositoryException;
use Sulu\Bundle\AdminBundle\UserManager\UserManagerInterface;
use Sulu\Bundle\PageBundle\Content\InternalLinksContainer;
use Sulu\Component\Content\Compat\StructureInterface;
use Sulu\Component\Content\Document\Behavior\SecurityBehavior;
use Sulu\Component\Content\Exception\InvalidOrderPositionException;
use Sulu\Component\Content\Mapper\ContentMapperInterface;
use Sulu\Component\Content\Query\ContentQueryBuilderInterface;
use Sulu\Component\Content\Query\ContentQueryExecutorInterface;
use Sulu\Component\DocumentManager\Exception\DocumentManagerException;
use Sulu\Component\PHPCR\SessionManager\SessionManagerInterface;
use Sulu\Component\Rest\Exception\RestException;
use Sulu\Component\Security\Authorization\AccessControl\AccessControlManagerInterface;
use Sulu\Component\Security\Authorization\SecurityCondition;
use Sulu\Component\Webspace\Manager\WebspaceManagerInterface;
use Sulu\Component\Webspace\Webspace;
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;

/**
 * repository for node objects.
 *
 * @deprecated
 */
class NodeRepository implements NodeRepositoryInterface

The interface Sulu\Bundle\PageBundle\Repository\NodeRepositoryInterface has been deprecated.

{
    /**
     * @var ContentMapperInterface
     */
    private $mapper;

    /**
     * @var SessionManagerInterface
     */
    private $sessionManager;

    /**
     * for returning self link in get action.
     *
     * @var string
     */
    private $apiBasePath = '/admin/api/nodes';

    /**
     * @var UserManagerInterface
     */
    private $userManager;

    /**
     * @var WebspaceManagerInterface
     */
    private $webspaceManager;

    /**
     * @var ContentQueryBuilderInterface
     */
    private $queryBuilder;

    /**
     * @var ContentQueryExecutorInterface
     */
    private $queryExecutor;

    /**
     * @var AccessControlManagerInterface
     */
    private $accessControlManager;

    /**
     * @var TokenStorageInterface
     */
    private $tokenStorage;

    public function __construct(
        ContentMapperInterface $mapper,
        SessionManagerInterface $sessionManager,
        UserManagerInterface $userManager,
        WebspaceManagerInterface $webspaceManager,
        ContentQueryBuilderInterface $queryBuilder,
        ContentQueryExecutorInterface $queryExecutor,
        AccessControlManagerInterface $accessControlManager,
        TokenStorageInterface $tokenStorage = null
    ) {
        $this->mapper = $mapper;
        $this->sessionManager = $sessionManager;
        $this->userManager = $userManager;
        $this->webspaceManager = $webspaceManager;
        $this->queryBuilder = $queryBuilder;
        $this->queryExecutor = $queryExecutor;
        $this->accessControlManager = $accessControlManager;
        $this->tokenStorage = $tokenStorage;
    }

    /**
     * return content mapper.
     *
     * @return ContentMapperInterface
     */
    protected function getMapper()
    {
        return $this->mapper;
    }

    /**
     * returns user fullName.
     *
     * @param int $id userId
     *
     * @return string
     */
    protected function getFullNameByUserId($id)
    {
        return $this->userManager->getFullNameByUserId($id);
    }

    /**
     * returns finished Node (with _links and _embedded).
     *
     * @param StructureInterface $structure
     * @param string $webspaceKey
     * @param string $languageCode
     * @param int $depth
     * @param bool $complete
     * @param bool $excludeGhosts
     * @param string|null $extension
     *
     * @return array
     *
     * @deprecated This part should be split into a serialization handler and using the hateoas bundle
     */
    protected function prepareNode(
        StructureInterface $structure,
        $webspaceKey,
        $languageCode,
        $depth = 1,
        $complete = true,
        $excludeGhosts = false,
        $extension = null
    ) {
        $result = $structure->toArray($complete);

The method Sulu\Component\Content\Compat\StructureInterface::toArray() has been deprecated with message: Use the serializer instead

        // add default embedded property with empty nodes array
        $result['_embedded'] = [];
        $result['_embedded']['nodes'] = [];

        // add api links
        $result['_links'] = [
            'self' => [
                'href' => $this->apiBasePath . '/' . $structure->getUuid() .
                    (null !== $extension ? '/' . $extension : ''),
            ],
            'children' => [
                'href' => $this->apiBasePath . '?parentId=' . $structure->getUuid() . '&depth=' . $depth .
                    '&webspace=' . $webspaceKey . '&language=' . $languageCode .
                    (true === $excludeGhosts ? '&exclude-ghosts=true' : ''),
            ],
        ];

        if ($this->tokenStorage && ($token = $this->tokenStorage->getToken())) {

This code seems to be duplicated across your project.

            $result['_permissions'] = $this->accessControlManager->getUserPermissions(
                new SecurityCondition(
                    'sulu.webspaces.' . $webspaceKey,
                    $languageCode,
                    SecurityBehavior::class,
                    $structure->getUuid()
                ),
                $token->getUser()
            );
        }

        return $result;
    }

    /**
     * @param string $apiBasePath
     */
    public function setApiBasePath($apiBasePath)
    {
        $this->apiBasePath = $apiBasePath;
    }

    /**
     * {@inheritdoc}
     */
    public function getNode(
        $uuid,
        $webspaceKey,
        $languageCode,
        $breadcrumb = false,
        $complete = true,
        $loadGhostContent = false
    ) {
        $structure = $this->getMapper()->load($uuid, $webspaceKey, $languageCode, $loadGhostContent);

        $result = $this->prepareNode($structure, $webspaceKey, $languageCode, 1, $complete);

The method Sulu\Bundle\PageBundle\Repository\NodeRepository::prepareNode() has been deprecated with message: This part should be split into a serialization handler and using the hateoas bundle

        if ($breadcrumb) {
            $breadcrumb = $this->getMapper()->loadBreadcrumb($uuid, $languageCode, $webspaceKey);

The method Sulu\Component\Content\Mapper\ContentMapperInterface::loadBreadcrumb() has been deprecated.

            $result['breadcrumb'] = [];
            foreach ($breadcrumb as $item) {
                $result['breadcrumb'][$item->getDepth()] = $item->toArray();
            }
        }

        return $result;
    }

    /**
     * {@inheritdoc}
     */
    public function getIndexNode($webspaceKey, $languageCode)
    {
        $structure = $this->getMapper()->loadStartPage($webspaceKey, $languageCode);

        return $this->prepareNode($structure, $webspaceKey, $languageCode);

The method Sulu\Bundle\PageBundle\Repository\NodeRepository::prepareNode() has been deprecated with message: This part should be split into a serialization handler and using the hateoas bundle

    }

    /**
     * {@inheritdoc}
     */
    public function deleteNode($uuid, $webspaceKey)
    {
        // TODO remove third parameter, and ask in UI if referenced node should be deleted
        $this->getMapper()->delete($uuid, $webspaceKey, true);

The call to ContentMapperInterface::delete() has too many arguments starting with true.

    }

    /**
     * {@inheritdoc}
     */
    public function getReferences($uuid)
    {
        $session = $this->sessionManager->getSession();

The method Sulu\Component\PHPCR\SessionManager\SessionManagerInterface::getSession() has been deprecated with message: Use the doctrine_phpcr service to retrieve the session

        $node = $session->getNodeByIdentifier($uuid);

        return iterator_to_array($node->getReferences());
    }

    /**
     * {@inheritdoc}
     */
    public function getNodes(
        $parent,
        $webspaceKey,
        $languageCode,
        $depth = 1,
        $flat = true,
        $complete = true,
        $excludeGhosts = false
    ) {
        $nodes = $this->getMapper()->loadByParent(
            $parent,
            $webspaceKey,
            $languageCode,
            $depth,
            $flat,
            false,
            $excludeGhosts
        );

        $parentNode = $this->getParentNode($parent, $webspaceKey, $languageCode);
        $result = $this->prepareNode($parentNode, $webspaceKey, $languageCode, 1, $complete, $excludeGhosts);

The method Sulu\Bundle\PageBundle\Repository\NodeRepository::prepareNode() has been deprecated with message: This part should be split into a serialization handler and using the hateoas bundle

        $result['_embedded']['nodes'] = $this->prepareNodesTree(
            $nodes,
            $webspaceKey,
            $languageCode,
            $complete,
            $excludeGhosts,
            $flat ? 1 : $depth
        );
        $result['total'] = count($result['_embedded']['nodes']);

        return $result;
    }

    /**
     * {@inheritdoc}
     */
    public function getNodesByIds(
        $ids,
        $webspaceKey,
        $languageCode
    ) {
        $result = [];
        $idString = '';

        if (!empty($ids)) {
            $container = new InternalLinksContainer(
                $ids,
                $this->queryExecutor,
                $this->queryBuilder,
                [],
                $webspaceKey,
                $languageCode,
                true
            );

            $result = $container->getData();
            $idString = implode(',', $ids);
        }

        return [
            '_embedded' => [
                'nodes' => $result,
            ],
            'total' => count($result),
            '_links' => [
                'self' => ['href' => $this->apiBasePath . '?ids=' . $idString],
            ],
        ];
    }

    /**
     * {@inheritdoc}
     */
    public function getWebspaceNode(
        $webspaceKey,
        $languageCode,
        $depth = 1,
        $excludeGhosts = false
    ) {
        // init result
        $data = [];

        // add default empty embedded property
        $data['_embedded'] = [
            'nodes' => [$this->createWebspaceNode($webspaceKey, $languageCode, $depth, $excludeGhosts)],
        ];
        // add api links
        $data['_links'] = [
            'self' => [
                'href' => $this->apiBasePath . '/entry?depth=' . $depth . '&webspace=' . $webspaceKey .
                    '&language=' . $languageCode . (true === $excludeGhosts ? '&exclude-ghosts=true' : ''),
            ],
        ];

        return $data;
    }

    /**
     * {@inheritdoc}
     */
    public function getWebspaceNodes($languageCode)
    {
        // init result
        $data = ['_embedded' => ['nodes' => []]];

        /** @var Webspace $webspace */
        foreach ($this->webspaceManager->getWebspaceCollection() as $webspace) {
            $data['_embedded']['nodes'][] = $this->createWebspaceNode($webspace->getKey(), $languageCode, 0);
        }

        // add api links
        $data['_links'] = [
            'self' => [
                'href' => $this->apiBasePath . '/entry?language=' . $languageCode,
            ],
        ];

        return $data;
    }

    /**
     * Creates a webspace node.
     */
    private function createWebspaceNode(
        $webspaceKey,
        $languageCode,
        $depth = 1,
        $excludeGhosts = false
    ) {
        $webspace = $this->webspaceManager->getWebspaceCollection()->getWebspace($webspaceKey);

        if ($depth > 0) {
            $nodes = $this->getMapper()->loadByParent(
                null,
                $webspaceKey,
                $languageCode,
                $depth,
                false,
                false,
                $excludeGhosts
            );
            $embedded = $this->prepareNodesTree($nodes, $webspaceKey, $languageCode, true, $excludeGhosts, $depth);
        } else {
            $embedded = [];
        }

        return [
            'id' => $this->sessionManager->getContentNode($webspace->getKey())->getIdentifier(),

The method Sulu\Component\PHPCR\SessionManager\SessionManagerInterface::getContentNode() has been deprecated with message: Do not use anymore, because the node is always returned from the default session, although multiple sessions can exist

            'path' => '/',
            'title' => $webspace->getName(),
            'hasSub' => true,
            'publishedState' => true,
            '_embedded' => $embedded,
            '_links' => [
                'children' => [
                    'href' => $this->apiBasePath . '?depth=' . $depth . '&webspace=' . $webspaceKey .
                        '&language=' . $languageCode . (true === $excludeGhosts ? '&exclude-ghosts=true' : ''),
                ],
            ],
        ];
    }

    /**
     * {@inheritdoc}
     */
    public function getFilteredNodes(
        array $filterConfig,
        $languageCode,
        $webspaceKey,
        $preview = false,
        $api = false,
        $exclude = []
    ) {
        $limit = isset($filterConfig['limitResult']) ? $filterConfig['limitResult'] : null;
        $initParams = ['config' => $filterConfig];
        if ($exclude) {

The expression $exclude of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

            $initParams['excluded'] = $exclude;
        }

        $this->queryBuilder->init($initParams);
        $data = $this->queryExecutor->execute(
            $webspaceKey,
            [$languageCode],
            $this->queryBuilder,
            true,
            -1,
            $limit
        );

        if ($api) {
            if (isset($filterConfig['dataSource'])) {
                if (null !== $this->webspaceManager->findWebspaceByKey($filterConfig['dataSource'])) {
                    $node = $this->sessionManager->getContentNode($filterConfig['dataSource']);

The method Sulu\Component\PHPCR\SessionManager\SessionManagerInterface::getContentNode() has been deprecated with message: Do not use anymore, because the node is always returned from the default session, although multiple sessions can exist

                } else {
                    $node = $this->sessionManager->getSession()->getNodeByIdentifier($filterConfig['dataSource']);

The method Sulu\Component\PHPCR\SessionManager\SessionManagerInterface::getSession() has been deprecated with message: Use the doctrine_phpcr service to retrieve the session

                }
            } else {
                $node = $this->sessionManager->getContentNode($webspaceKey);

The method Sulu\Component\PHPCR\SessionManager\SessionManagerInterface::getContentNode() has been deprecated with message: Do not use anymore, because the node is always returned from the default session, although multiple sessions can exist

            }

            $parentNode = $this->getParentNode($node->getIdentifier(), $webspaceKey, $languageCode);
            $result = $this->prepareNode($parentNode, $webspaceKey, $languageCode, 1, false);

The method Sulu\Bundle\PageBundle\Repository\NodeRepository::prepareNode() has been deprecated with message: This part should be split into a serialization handler and using the hateoas bundle

            $result['_embedded']['nodes'] = $data;
            $result['total'] = count($result['_embedded']['nodes']);
        } else {
            $result = $data;
        }

        return $result;
    }

    /**
     * if parent is null return home page else the page with given uuid.
     *
     * @param string|null $parent uuid of parent node
     * @param string $webspaceKey
     * @param string $languageCode
     *
     * @return StructureInterface
     */
    private function getParentNode($parent, $webspaceKey, $languageCode)
    {
        if (null != $parent) {

It seems like you are loosely comparing $parent of type string|null against null; this is ambiguous if the string can be empty. Consider using a strict comparison !== instead.

            return $this->getMapper()->load($parent, $webspaceKey, $languageCode);
        } else {
            return $this->getMapper()->loadStartPage($webspaceKey, $languageCode);
        }
    }

    /**
     * @param StructureInterface[] $nodes
     * @param string $webspaceKey
     * @param string $languageCode
     * @param bool $complete
     * @param bool $excludeGhosts
     *
     * @return array
     */
    private function prepareNodesTree(
        $nodes,
        $webspaceKey,
        $languageCode,
        $complete = true,
        $excludeGhosts = false,
        $maxDepth = 1,
        $currentDepth = 0
    ) {
        ++$currentDepth;

        $results = [];
        foreach ($nodes as $node) {
            $result = $this->prepareNode($node, $webspaceKey, $languageCode, 1, $complete, $excludeGhosts);

The method Sulu\Bundle\PageBundle\Repository\NodeRepository::prepareNode() has been deprecated with message: This part should be split into a serialization handler and using the hateoas bundle

            if (null !== $maxDepth &&
                $currentDepth < $maxDepth &&
                $node->getHasChildren() &&
                null != $node->getChildren()
            ) {
                $result['_embedded']['nodes'] = $this->prepareNodesTree(
                    $node->getChildren(),
                    $webspaceKey,
                    $languageCode,
                    $complete,
                    $excludeGhosts,
                    $maxDepth,
                    $currentDepth
                );
            }
            $results[] = $result;
        }

        return $results;
    }

    /**
     * {@inheritdoc}
     */
    public function getNodesTree(
        $uuid,
        $webspaceKey,
        $languageCode,
        $excludeGhosts = false,
        $excludeShadows = false
    ) {
        $nodes = $this->loadNodeAndAncestors($uuid, $webspaceKey, $languageCode, $excludeGhosts, $excludeShadows, true);

        $result = [
            '_embedded' => [
                'nodes' => $nodes,
            ],
        ];

        if ($this->tokenStorage && ($token = $this->tokenStorage->getToken())) {

This code seems to be duplicated across your project.

            $result['_permissions'] = $this->accessControlManager->getUserPermissions(
                new SecurityCondition(
                    'sulu.webspaces.' . $webspaceKey
                ),
                $token->getUser()
            );
        }

        // add api links
        $result['_links'] = [
            'self' => [
                'href' => $this->apiBasePath . '/tree?uuid=' . $uuid . '&webspace=' . $webspaceKey . '&language=' .
                    $languageCode . (true === $excludeGhosts ? '&exclude-ghosts=true' : ''),
            ],
        ];

        return $result;
    }

    /**
     * Load the node and its ancestors and convert them into a HATEOAS representation.
     *
     * @param string $uuid
     * @param string $webspaceKey
     * @param string $locale
     * @param bool $excludeGhosts
     * @param bool $excludeShadows
     * @param bool $complete
     *
     * @return array
     */
    private function loadNodeAndAncestors($uuid, $webspaceKey, $locale, $excludeGhosts, $excludeShadows, $complete)
    {
        $descendants = $this->getMapper()->loadNodeAndAncestors(
            $uuid,
            $locale,
            $webspaceKey,
            $excludeGhosts,
            $excludeShadows
        );
        $descendants = array_reverse($descendants);

        $childTiers = [];
        foreach ($descendants as $descendant) {
            foreach ($descendant->getChildren() as $child) {
                $type = $child->getType();

                if ($excludeShadows && null !== $type && 'shadow' === $type->getName()) {
                    continue;
                }

                if ($excludeGhosts && null !== $type && 'ghost' === $type->getName()) {
                    continue;
                }

                if (!isset($childTiers[$descendant->getUuid()])) {
                    $childTiers[$descendant->getUuid()] = [];
                }
                $childTiers[$descendant->getUuid()][] = $this->prepareNode(

The method Sulu\Bundle\PageBundle\Repository\NodeRepository::prepareNode() has been deprecated with message: This part should be split into a serialization handler and using the hateoas bundle

                    $child,
                    $webspaceKey,
                    $locale,
                    1,
                    $complete,
                    $excludeGhosts
                );
            }
        }
        $result = array_shift($childTiers);

        $this->iterateTiers($childTiers, $result);

        return $result;
    }

    /**
     * Iterate over the ancestor tiers and build up the result.
     *
     * @param array $tiers
     * @param array $result (by rereference)
     */
    private function iterateTiers($tiers, &$result)
    {
        reset($tiers);
        $uuid = key($tiers);
        $tier = array_shift($tiers);

        $found = false;
        if (is_array($result)) {
            foreach ($result as &$node) {
                if ($node['id'] === $uuid) {
                    $node['_embedded']['nodes'] = $tier;
                    $found = true;
                    break;
                }
            }
        }

        if (!$tiers) {

The expression $tiers of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

            return;
        }

        if (!$found) {
            throw new \RuntimeException(
                sprintf(
                    'Could not find target node in with UUID "%s" in tier. This should not happen.',
                    $uuid
                )
            );
        }

        $this->iterateTiers($tiers, $node['_embedded']['nodes']);

The variable $node seems to be defined by a foreach iteration on line 635. Are you sure the iterator is never empty, otherwise this variable is not defined?

    }

    /**
     * {@inheritdoc}
     */
    public function loadExtensionData($uuid, $extensionName, $webspaceKey, $languageCode)
    {
        $structure = $this->getMapper()->load($uuid, $webspaceKey, $languageCode);

        // extract extension
        $extensionData = $structure->getExt();
        $data = $extensionData[$extensionName];

        // add uuid and path
        $data['id'] = $structure->getUuid();
        $data['path'] = $structure->getPath();
        $data['url'] = $structure->getResourceLocator();
        $data['publishedState'] = $structure->getPublishedState();
        $data['published'] = $structure->getPublished();

        // prepare data
        $data['_links'] = [
            'self' => [
                'href' => $this->apiBasePath . '/' . $uuid . '/' . $extensionName . '?webspace=' . $webspaceKey .
                    '&language=' . $languageCode,
            ],
        ];

        return $data;
    }

    /**
     * {@inheritdoc}
     */
    public function saveExtensionData($uuid, $data, $extensionName, $webspaceKey, $languageCode, $userId)
    {
        $structure = $this->getMapper()->saveExtension(
            $uuid,
            $data,
            $extensionName,
            $webspaceKey,
            $languageCode,
            $userId
        );

        // extract extension
        $extensionData = $structure->getExt();
        $data = $extensionData[$extensionName];

        // add uuid and path
        $data['id'] = $structure->getUuid();
        $data['path'] = $structure->getPath();
        $data['url'] = $structure->getResourceLocator();

        // prepare data
        $data['_links'] = [
            'self' => [
                'href' => $this->apiBasePath . '/' . $uuid . '/' . $extensionName . '?webspace=' . $webspaceKey .
                    '&language=' . $languageCode,
            ],
        ];

        return $data;
    }

    /**
     * {@inheritdoc}
     */
    public function orderAt($uuid, $position, $webspaceKey, $languageCode, $userId)
    {
        try {
            // call mapper function
            $structure = $this->getMapper()->orderAt($uuid, $position, $userId, $webspaceKey, $languageCode);
        } catch (DocumentManagerException $ex) {
            throw new RestException($ex->getMessage(), 1, $ex);
        } catch (RepositoryException $ex) {

The class PHPCR\RepositoryException does not exist. Did you forget a USE statement, or did you not list all dependencies?

            throw new RestException($ex->getMessage(), 1, $ex);
        } catch (InvalidOrderPositionException $ex) {
            throw new RestException($ex->getMessage(), 1, $ex);
        }

        return $this->prepareNode($structure, $webspaceKey, $languageCode);

The method Sulu\Bundle\PageBundle\Repository\NodeRepository::prepareNode() has been deprecated with message: This part should be split into a serialization handler and using the hateoas bundle

    }

    /**
     * {@inheritdoc}
     */
    public function copyLocale($uuid, $userId, $webspaceKey, $srcLocale, $destLocales)
    {
        try {
            // call mapper function
            $structure = $this->getMapper()->copyLanguage($uuid, $userId, $webspaceKey, $srcLocale, $destLocales);
        } catch (RepositoryException $ex) {

The class PHPCR\RepositoryException does not exist. Did you forget a USE statement, or did you not list all dependencies?

            throw new RestException($ex->getMessage(), 1, $ex);
        }

        return $this->prepareNode($structure, $webspaceKey, $srcLocale);

The method Sulu\Bundle\PageBundle\Repository\NodeRepository::prepareNode() has been deprecated with message: This part should be split into a serialization handler and using the hateoas bundle

    }
}