StefanoTree\NestedSet\Adapter\Doctrine2DBAL

Complexity

Total Complexity

56

Size/Duplication

Total Lines	598
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

98.59%

Importance

Changes

0

26 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getConnection()	0	4	1
B	updateLevels()	0	29	3
A	setConnection()	0	4	1
A	getBlankDbSelect()	0	10	1
A	setDefaultDbSelect()	0	4	1
A	getDefaultDbSelect()	0	10	2
A	lockTree()	0	13	1
A	beginTransaction()	0	5	1
A	commitTransaction()	0	5	1
A	rollbackTransaction()	0	5	1
A	update()	0	21	2
A	insert()	0	19	2
A	delete()	0	16	1
B	moveLeftIndexes()	0	27	3
B	moveRightIndexes()	0	27	3
A	updateParentId()	0	18	1
B	moveBranch()	0	30	3
A	getRoots()	0	23	3
A	getRoot()	0	6	2
A	getNode()	0	21	2
B	getNodeInfo()	0	25	3
B	getChildrenNodeInfo()	0	36	2
A	updateNodeMetadata()	0	19	1
B	getDescendants()	0	54	8
B	getAncestors()	0	47	6

<?php

declare(strict_types=1);

namespace StefanoTree\NestedSet\Adapter;

use Doctrine\DBAL\Connection as DbConnection;
use Doctrine\DBAL\Query\QueryBuilder;
use StefanoTree\NestedSet\NodeInfo;
use StefanoTree\NestedSet\Options;

class Doctrine2DBAL extends AdapterAbstract implements AdapterInterface
{
    private $connection;

    private $defaultDbSelect;

    /**
     * @param Options      $options
     * @param DbConnection $connection
     */
    public function __construct(Options $options, DbConnection $connection)
    {
        $this->setOptions($options);
        $this->setConnection($connection);
    }

    /**
     * @param DbConnection $dbAdapter
     */
    protected function setConnection(DbConnection $dbAdapter): void
    {
        $this->connection = $dbAdapter;
    }

    /**
     * @return DbConnection
     */
    private function getConnection(): DbConnection
    {
        return $this->connection;
    }

    /**
     * Return base db select without any join, etc.
     *
     * @return QueryBuilder
     */
    public function getBlankDbSelect(): QueryBuilder
    {
        $queryBuilder = $this->getConnection()
                             ->createQueryBuilder();

        $queryBuilder->select('*')
                     ->from($this->getOptions()->getTableName(), null);

        return $queryBuilder;
    }

    /**
     * @param QueryBuilder $dbSelect
     */
    public function setDefaultDbSelect(QueryBuilder $dbSelect): void
    {
        $this->defaultDbSelect = $dbSelect;
    }

    /**
     * Return clone of default db select.
     *
     * @return QueryBuilder
     */
    public function getDefaultDbSelect(): QueryBuilder
    {
        if (null === $this->defaultDbSelect) {
            $this->defaultDbSelect = $this->getBlankDbSelect();
        }

        $dbSelect = clone $this->defaultDbSelect;

        return $dbSelect;
    }

    /**
     * {@inheritdoc}
     */
    public function lockTree(): void
    {
        $options = $this->getOptions();

        $connection = $this->getConnection();

        $sql = $this->getBlankDbSelect();
        $sql->select($options->getIdColumnName().' AS i');

        $sql = $sql->getSQL().' FOR UPDATE';

        $connection->executeQuery($sql);
    }

    /**
     * {@inheritdoc}
     */
    public function beginTransaction(): void
    {
        $this->getConnection()
             ->beginTransaction();
    }

    /**
     * {@inheritdoc}
     */
    public function commitTransaction(): void
    {
        $this->getConnection()
             ->commit();
    }

    /**
     * {@inheritdoc}
     */
    public function rollbackTransaction(): void
    {
        $this->getConnection()
             ->rollBack();
    }

    /**
     * {@inheritdoc}
     */
    public function update($nodeId, array $data): void
    {
        $options = $this->getOptions();

        $connection = $this->getConnection();

        $data = $this->cleanData($data);

        $sql = $connection->createQueryBuilder();

        $sql->update($options->getTableName(), null)
            ->where($options->getIdColumnName().' = :'.$options->getIdColumnName());

        foreach ($data as $key => $value) {
            $sql->set($connection->quoteIdentifier($key), ':'.$key);
        }

        $data[$options->getIdColumnName()] = $nodeId;

        $connection->executeUpdate($sql->getSQL(), $data);
    }

    /**
     * {@inheritdoc}
     */
    public function insert(NodeInfo $nodeInfo, array $data)
    {
        $options = $this->getOptions();

        $connection = $this->getConnection();

        $data[$options->getParentIdColumnName()] = $nodeInfo->getParentId();
        $data[$options->getLevelColumnName()] = $nodeInfo->getLevel();
        $data[$options->getLeftColumnName()] = $nodeInfo->getLeft();
        $data[$options->getRightColumnName()] = $nodeInfo->getRight();

        if ($options->getScopeColumnName()) {

The expression $options->getScopeColumnName() of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

            $data[$options->getScopeColumnName()] = $nodeInfo->getScope();
        }

        $connection->insert($options->getTableName(), $data);

        return $connection->lastInsertId($options->getSequenceName());
    }

    /**
     * {@inheritdoc}
     */
    public function delete($nodeId): void
    {
        $options = $this->getOptions();

        $connection = $this->getConnection();

        $sql = $connection->createQueryBuilder();
        $sql->delete($options->getTableName())
            ->where($options->getIdColumnName().' = :id');

        $params = array(
            ':id' => $nodeId,
        );

        $connection->executeQuery($sql->getSQL(), $params);
    }

    /**
     * {@inheritdoc}
     */
    public function moveLeftIndexes($fromIndex, $shift, $scope = null): void
    {
        $options = $this->getOptions();

        if (0 == $shift) {
            return;
        }

        $connection = $this->getConnection();

        $sql = $connection->createQueryBuilder();
        $sql->update($options->getTableName())
            ->set($options->getLeftColumnName(), $options->getLeftColumnName().' + :shift')
            ->where($options->getLeftColumnName().' > :fromIndex');

        $params = array(
            ':shift' => $shift,
            ':fromIndex' => $fromIndex,
        );

        if ($options->getScopeColumnName()) {

The expression $options->getScopeColumnName() of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

            $sql->andWhere($options->getScopeColumnName().' = :scope');
            $params[':scope'] = $scope;
        }

        $connection->executeUpdate($sql->getSQL(), $params);
    }

    /**
     * {@inheritdoc}
     */
    public function moveRightIndexes($fromIndex, $shift, $scope = null): void
    {
        $options = $this->getOptions();

        if (0 == $shift) {
            return;
        }

        $connection = $this->getConnection();

        $sql = $connection->createQueryBuilder();
        $sql->update($options->getTableName())
            ->set($options->getRightColumnName(), $options->getRightColumnName().' + :shift')
            ->where($options->getRightColumnName().' > :fromIndex');

        $params = array(
            ':shift' => $shift,
            ':fromIndex' => $fromIndex,
        );

        if ($options->getScopeColumnName()) {

The expression $options->getScopeColumnName() of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

            $sql->andWhere($options->getScopeColumnName().' = :scope');
            $params[':scope'] = $scope;
        }

        $connection->executeUpdate($sql->getSQL(), $params);
    }

    /**
     * {@inheritdoc}
     */
    public function updateParentId($nodeId, $newParentId): void
    {
        $options = $this->getOptions();

        $connection = $this->getConnection();

        $sql = $connection->createQueryBuilder();
        $sql->update($options->getTableName())
            ->set($options->getParentIdColumnName(), ':parentId')
            ->where($options->getIdColumnName().' = :nodeId');

        $params = array(
            ':parentId' => $newParentId,
            ':nodeId' => $nodeId,
        );

        $connection->executeUpdate($sql->getSQL(), $params);
    }

    /**
     * {@inheritdoc}
     */
    public function updateLevels(int $leftIndexFrom, int $rightIndexTo, int $shift, $scope = null): void
    {
        $options = $this->getOptions();

        if (0 == $shift) {
            return;
        }

        $connection = $this->getConnection();

        $sql = $connection->createQueryBuilder();
        $sql->update($options->getTableName())
            ->set($options->getLevelColumnName(), $options->getLevelColumnName().' + :shift')
            ->where($options->getLeftColumnName().' >= :leftFrom'
                    .' AND '.$options->getRightColumnName().' <= :rightTo');

        $params = array(
            ':shift' => $shift,
            ':leftFrom' => $leftIndexFrom,
            ':rightTo' => $rightIndexTo,
        );

        if ($options->getScopeColumnName()) {

The expression $options->getScopeColumnName() of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

            $sql->andWhere($options->getScopeColumnName().' = :scope');
            $params[':scope'] = $scope;
        }

        $connection->executeUpdate($sql->getSQL(), $params);
    }

    /**
     * {@inheritdoc}
     */
    public function moveBranch(int $leftIndexFrom, int $rightIndexTo, int $shift, $scope = null): void
    {
        if (0 == $shift) {
            return;
        }

        $options = $this->getOptions();

        $connection = $this->getConnection();

        $sql = $connection->createQueryBuilder();
        $sql->update($options->getTableName())
            ->set($options->getLeftColumnName(), $options->getLeftColumnName().' + :shift')
            ->set($options->getRightColumnName(), $options->getRightColumnName().' + :shift')
            ->where($options->getLeftColumnName().' >= :leftFrom'
                    .' AND '.$options->getRightColumnName().' <= :rightTo');

        $params = array(
            ':shift' => $shift,
            ':leftFrom' => $leftIndexFrom,
            ':rightTo' => $rightIndexTo,
        );

        if ($options->getScopeColumnName()) {

The expression $options->getScopeColumnName() of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

            $sql->andWhere($options->getScopeColumnName().' = :scope');
            $params[':scope'] = $scope;
        }

        $connection->executeUpdate($sql->getSQL(), $params);
    }

    /**
     * {@inheritdoc}
     */
    public function getRoots($scope = null): array
    {
        $options = $this->getOptions();

        $connection = $this->getConnection();

        $sql = $this->getBlankDbSelect();
        $sql->where($options->getParentIdColumnName().' IS NULL');
        $sql->orderBy($options->getIdColumnName());

        $params = array();

        if (null != $scope && $options->getScopeColumnName()) {

The expression $options->getScopeColumnName() of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

            $sql->where($options->getScopeColumnName().' = :scope');
            $params[':scope'] = $scope;
        }

        $stmt = $connection->executeQuery($sql->getSQL(), $params);

        $node = $stmt->fetchAll();

        return $node;
    }

    /**
     * {@inheritdoc}
     */
    public function getRoot($scope = null): array
    {
        $roots = $this->getRoots($scope);

        return ($roots) ? $roots[0] : array();
    }

    /**
     * {@inheritdoc}
     */
    public function getNode($nodeId): ?array
    {
        $options = $this->getOptions();

        $nodeId = (int) $nodeId;

        $connection = $this->getConnection();

        $sql = $this->getDefaultDbSelect();
        $sql->where($options->getIdColumnName().' = :'.$options->getIdColumnName());

        $params = array(
            $options->getIdColumnName() => $nodeId,
        );

        $stmt = $connection->executeQuery($sql->getSQL(), $params);

        $node = $stmt->fetch();

        return is_array($node) ? $node : null;
    }

    /**
     * {@inheritdoc}
     */
    public function getNodeInfo($nodeId): ?NodeInfo
    {
        $options = $this->getOptions();

        $nodeId = (int) $nodeId;

        $connection = $this->getConnection();

        $sql = $this->getBlankDbSelect();
        $sql->where($options->getIdColumnName().' = :'.$options->getIdColumnName());

        $params = array(
            $options->getIdColumnName() => $nodeId,
        );

        $stmt = $connection->executeQuery($sql->getSQL(), $params);

        $node = $stmt->fetch();

        $data = is_array($node) ? $node : null;

        $result = ($data) ? $this->_buildNodeInfoObject($data) : null;

        return $result;
    }

    /**
     * {@inheritdoc}
     */
    public function getChildrenNodeInfo($parentNodeId): array
    {
        $connection = $this->getConnection();
        $options = $this->getOptions();

        $queryBuilder = $connection->createQueryBuilder();

        $columns = array(
            $options->getIdColumnName(),
            $options->getLeftColumnName(),
            $options->getRightColumnName(),
            $options->getParentIdColumnName(),
            $options->getLevelColumnName(),
        );

        $sql = $queryBuilder->select($columns)
                            ->from($options->getTableName())
                            ->where($options->getParentIdColumnName().' = :parentId')
                            ->orderBy($options->getLeftColumnName(), 'ASC');

        $params = array(
            'parentId' => $parentNodeId,
        );

        $stmt = $connection->executeQuery($sql->getSQL(), $params);

        $data = $stmt->fetchAll();

        $result = array();

        foreach ($data as $nodeData) {
            $result[] = $this->_buildNodeInfoObject($nodeData);
        }

        return $result;
    }

    /**
     * {@inheritdoc}
     */
    public function updateNodeMetadata(NodeInfo $nodeInfo): void
    {
        $options = $this->getOptions();

        $connection = $this->getConnection();

        $sql = $connection->createQueryBuilder();
        $sql->update($options->getTableName())
            ->set($options->getRightColumnName(), $nodeInfo->getRight())
            ->set($options->getLeftColumnName(), $nodeInfo->getLeft())
            ->set($options->getLevelColumnName(), $nodeInfo->getLevel())
            ->where($options->getIdColumnName().' = :nodeId');

        $params = array(
            ':nodeId' => $nodeInfo->getId(),
        );

        $connection->executeUpdate($sql->getSQL(), $params);
    }

    /**
     * {@inheritdoc}
     */
    public function getAncestors($nodeId, int $startLevel = 0, bool $excludeLastNode = false): array
    {
        $options = $this->getOptions();

        $startLevel = (int) $startLevel;

        // node does not exist
        $nodeInfo = $this->getNodeInfo($nodeId);
        if (!$nodeInfo) {
            return array();
        }

        $connection = $this->getConnection();

        $sql = $this->getDefaultDbSelect();
        $params = array();

        if ($options->getScopeColumnName()) {

The expression $options->getScopeColumnName() of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

            $sql->andWhere($options->getScopeColumnName().' = :scope');
            $params['scope'] = $nodeInfo->getScope();
        }

        $sql->andWhere($options->getLeftColumnName().' <= :leftIndex')
            ->andWhere($options->getRightColumnName().' >= :rightIndex')
            ->orderBy($options->getLeftColumnName(), 'ASC');

        $params['leftIndex'] = $nodeInfo->getLeft();
        $params['rightIndex'] = $nodeInfo->getRight();

        if (0 < $startLevel) {
            $sql->andWhere($options->getLevelColumnName().' >= :startLevel');

            $params['startLevel'] = $startLevel;
        }

        if (true == $excludeLastNode) {

It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

            $sql->andWhere($options->getLevelColumnName().' < :level');

            $params['level'] = $nodeInfo->getLevel();
        }

        $stmt = $connection->executeQuery($sql->getSQL(), $params);

        $result = $stmt->fetchAll();

        return (is_array($result)) ? $result : array();
    }

    /**
     * {@inheritdoc}
     */
    public function getDescendants($nodeId, int $startLevel = 0, ?int $levels = null, ?int $excludeBranch = null): array
    {
        $options = $this->getOptions();

        if (!$nodeInfo = $this->getNodeInfo($nodeId)) {
            return array();
        }

        $connection = $this->getConnection();
        $sql = $this->getDefaultDbSelect();
        $sql->orderBy($options->getLeftColumnName(), 'ASC');

        $params = array();

        if ($options->getScopeColumnName()) {

The expression $options->getScopeColumnName() of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

            $sql->andWhere($options->getScopeColumnName().' = :scope');
            $params['scope'] = $nodeInfo->getScope();
        }

        if (0 != $startLevel) {
            $sql->andWhere($options->getLevelColumnName().' >= :startLevel');

            $params['startLevel'] = $nodeInfo->getLevel() + (int) $startLevel;
        }

        if (null != $levels) {

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

            $sql->andWhere($options->getLevelColumnName().'< :endLevel');
            $params['endLevel'] = $nodeInfo->getLevel() + (int) $startLevel + abs($levels);
        }

        if (null != $excludeBranch && null != ($excludeNodeInfo = $this->getNodeInfo($excludeBranch))) {

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

            $sql->andWhere('('.$options->getLeftColumnName().' BETWEEN :left AND :exLeftMinusOne'
                           .') OR ('.$options->getLeftColumnName().' BETWEEN :exRightPlusOne AND :right)')
                ->andWhere('('.$options->getRightColumnName().' BETWEEN :exRightPlusOne AND :right'
                           .') OR ('.$options->getRightColumnName().' BETWEEN :left AND :exLeftMinusOne)');

            $params['left'] = $nodeInfo->getLeft();
            $params['exLeftMinusOne'] = $excludeNodeInfo->getLeft() - 1;
            $params['exRightPlusOne'] = $excludeNodeInfo->getRight() + 1;
            $params['right'] = $nodeInfo->getRight();
        } else {
            $sql->andWhere($options->getLeftColumnName().' >= :left')
                ->andWhere($options->getRightColumnName().' <= :right');

            $params['left'] = $nodeInfo->getLeft();
            $params['right'] = $nodeInfo->getRight();
        }

        $stmt = $connection->executeQuery($sql->getSQL(), $params);

        $result = $stmt->fetchAll();

        return (0 < count($result)) ? $result : array();
    }
}