Zend1::getAncestors() - Code Metrics - Inspection of "added - ancestor query builder" - bartko-s/stefano-tree - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — develop ( ec49e5...a553c2 )

by Bartko
created 2017-10-14 21:14 UTC
Zend1::getAncestors() B

↳ Parent: Zend1
Complexity

Conditions	5
Paths	9
Size

Total Lines	41
Code Lines	22
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	22
CRAP Score	5
Importance

Changes
Metric	Value
cc	5
eloc	22
nc	9
nop	3
dl	0
loc	41
ccs	22
cts	22
cp	1
crap	5
rs	8.439
c	0
b	0
f	0
<?php

declare(strict_types=1);

namespace StefanoTree\NestedSet\Adapter;

use StefanoTree\NestedSet\NodeInfo;
use StefanoTree\NestedSet\Options;
use Zend_Db_Adapter_Abstract as ZendDbAdapter;
use Zend_Db_Select as ZendDbSelect;

class Zend1 extends AdapterAbstract implements AdapterInterface
{
    protected $dbAdapter;

    protected $defaultDbSelect;

    public function __construct(Options $options, ZendDbAdapter $dbAdapter)
    {
        $this->setOptions($options);
        $this->setDbAdapter($dbAdapter);
    }

    /**
     * @param ZendDbAdapter $dbAdapter
     */
    protected function setDbAdapter(ZendDbAdapter $dbAdapter): void
    {
        $this->dbAdapter = $dbAdapter;
    }

    /**
     * @return ZendDbAdapter
     */
    public function getDbAdapter(): ZendDbAdapter
    {
        return $this->dbAdapter;
    }

    /**
     * Return base db select without any join, etc.
     *
     * @return ZendDbSelect
     */
    public function getBlankDbSelect(): ZendDbSelect
    {
        return $this->getDbAdapter()->select()->from($this->getOptions()->getTableName());
    }

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

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

        $dbSelect = clone $this->defaultDbSelect;

        return $dbSelect;
    }

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

        $dbAdapter = $this->getDbAdapter();

        $select = $this->getBlankDbSelect()
            ->reset(\Zend_Db_Select::COLUMNS)
            ->columns(array('i' => $options->getIdColumnName()))
            ->forUpdate(true);

        $dbAdapter->fetchAll($select);
    }

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

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

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

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

        $dbAdapter = $this->getDbAdapter();

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

        $where = array(
            $dbAdapter->quoteIdentifier($options->getIdColumnName()).' = ?' => $nodeId,
        );
        $dbAdapter->update($options->getTableName(), $data, $where);
    }

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

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

        if ($options->getScopeColumnName()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $data[$options->getScopeColumnName()] = $nodeInfo->getScope();
        }

        $dbAdapter->insert($options->getTableName(), $data);
        if ('' != $options->getSequenceName()) {
            $lastGeneratedValue = $dbAdapter->lastSequenceId($options->getSequenceName());
        } else {
            $lastGeneratedValue = $dbAdapter->lastInsertId();
        }

        return $lastGeneratedValue;
    }

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

        $dbAdapter = $this->getDbAdapter();

        $where = array(
            $dbAdapter->quoteIdentifier($options->getIdColumnName()).' = ?' => $nodeId,
        );

        $dbAdapter->delete($options->getTableName(), $where);
    }

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

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

        $dbAdapter = $this->getDbAdapter();
        $sql = 'UPDATE '.$dbAdapter->quoteIdentifier($options->getTableName())
            .' SET '.$dbAdapter->quoteIdentifier($options->getLeftColumnName())
            .' = '.$dbAdapter->quoteIdentifier($options->getLeftColumnName()).' + :shift'
            .' WHERE '.$dbAdapter->quoteIdentifier($options->getLeftColumnName()).' > :fromIndex';

        if ($options->getScopeColumnName()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $sql .= ' AND '.$dbAdapter->quoteIdentifier($options->getScopeColumnName()).' = '.$dbAdapter->quote($scope);
        }

        $binds = array(
            ':shift' => $shift,
            ':fromIndex' => $fromIndex,
        );
        $dbAdapter->prepare($sql)->execute($binds);
    }

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

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

        $dbAdapter = $this->getDbAdapter();

        $sql = 'UPDATE '.$dbAdapter->quoteIdentifier($options->getTableName())
            .' SET '.$dbAdapter->quoteIdentifier($options->getRightColumnName())
            .' = '.$dbAdapter->quoteIdentifier($options->getRightColumnName()).' + :shift'
            .' WHERE '.$dbAdapter->quoteIdentifier($options->getRightColumnName()).' > :fromIndex';

        if ($options->getScopeColumnName()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $sql .= ' AND '.$dbAdapter->quoteIdentifier($options->getScopeColumnName()).' = '.$dbAdapter->quote($scope);
        }

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

        $dbAdapter->prepare($sql)->execute($binds);
    }

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

        $dbAdapter = $this->getDbAdapter();

        $bind = array(
            $options->getParentIdColumnName() => $newParentId,
        );

        $where = array(
            $dbAdapter->quoteIdentifier($options->getIdColumnName()).' = ?' => $nodeId,
        );
        $dbAdapter->update($options->getTableName(), $bind, $where);
    }

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

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

        $dbAdapter = $this->getDbAdapter();

        $sql = 'UPDATE '.$dbAdapter->quoteIdentifier($options->getTableName())
            .' SET '.$dbAdapter->quoteIdentifier($options->getLevelColumnName())
            .' = '.$dbAdapter->quoteIdentifier($options->getLevelColumnName()).' + :shift'
            .' WHERE '.$dbAdapter->quoteIdentifier($options->getLeftColumnName())
            .' >= :leftFrom'.' AND '.$dbAdapter->quoteIdentifier($options->getRightColumnName())
            .' <= :rightTo';

        if ($options->getScopeColumnName()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $sql .= ' AND '.$dbAdapter->quoteIdentifier($options->getScopeColumnName()).' = '.$dbAdapter->quote($scope);
        }

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

        $dbAdapter->prepare($sql)->execute($binds);
    }

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

        $options = $this->getOptions();

        $dbAdapter = $this->getDbAdapter();

        $sql = 'UPDATE '.$dbAdapter->quoteIdentifier($options->getTableName())
            .' SET '.$dbAdapter->quoteIdentifier($options->getLeftColumnName())
            .' = '.$dbAdapter->quoteIdentifier($options->getLeftColumnName()).' + :shift, '
            .$dbAdapter->quoteIdentifier($options->getRightColumnName())
            .' = '.$dbAdapter->quoteIdentifier($options->getRightColumnName()).' + :shift'
            .' WHERE '.$dbAdapter->quoteIdentifier($options->getLeftColumnName()).' >= :leftFrom'
            .' AND '.$dbAdapter->quoteIdentifier($options->getRightColumnName()).' <= :rightTo';

        if ($options->getScopeColumnName()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $sql .= ' AND '.$dbAdapter->quoteIdentifier($options->getScopeColumnName()).' = '.$dbAdapter->quote($scope);
        }

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

        $dbAdapter->prepare($sql)->execute($binds);
    }

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

        $dbAdapter = $this->getDbAdapter();

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

        if (null != $scope && $options->getScopeColumnName()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $select->where($options->getScopeColumnName().' = ?', $scope);
        }

        return $dbAdapter->fetchAll($select);
    }

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

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

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

        $nodeId = (int) $nodeId;

        $dbAdapter = $this->getDbAdapter();

        $select = $this->getDefaultDbSelect()
            ->where($options->getIdColumnName().' = ?', $nodeId);

        $row = $dbAdapter->fetchRow($select);

        return $row ? $row : null;
    }

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

        $nodeId = (int) $nodeId;

        $dbAdapter = $this->getDbAdapter();

        $select = $this->getBlankDbSelect()
            ->where($options->getIdColumnName().' = ?', $nodeId);

        $row = $dbAdapter->fetchRow($select);

        $data = $row ? $row : null;

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

        return $result;
    }

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

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

        if ($options->getScopeColumnName()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $columns[] = $options->getScopeColumnName();
        }

        $select = $this->getBlankDbSelect();
        $select->reset(\Zend_Db_Select::COLUMNS);
        $select->columns($columns);
        $select->order($options->getLeftColumnName());
        $select->where($options->getParentIdColumnName().' = ?', $parentNodeId);

        $data = $dbAdapter->fetchAll($select);

        $result = array();

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

        return $result;
    }

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

        $bind = array(
            $options->getRightColumnName() => $nodeInfo->getRight(),
            $options->getLeftColumnName() => $nodeInfo->getLeft(),
            $options->getLevelColumnName() => $nodeInfo->getLevel(),
        );

        $where = array(
            $dbAdapter->quoteIdentifier($options->getIdColumnName()).' = ?' => $nodeInfo->getId(),
        );

        $dbAdapter->update($options->getTableName(), $bind, $where);
    }

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

        $startLevel = (int) $startLevel;

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

        $dbAdapter = $this->getDbAdapter();

        $select = $this->getDefaultDbSelect();

        if ($options->getScopeColumnName()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $select->where($options->getScopeColumnName().' = ?', $nodeInfo->getScope());
        }

        $select->where(
            $dbAdapter->quoteIdentifier($options->getLeftColumnName()).' <= ?', $nodeInfo->getLeft()
        )->where(
            $dbAdapter->quoteIdentifier($options->getRightColumnName()).' >= ?', $nodeInfo->getRight()
        )->order($options->getLeftColumnName().' ASC');

        if (0 < $startLevel) {
            $select->where(
                $dbAdapter->quoteIdentifier($options->getLevelColumnName()).' >= ?', $startLevel
            );
        }

        if (true == $excludeLastNode) {

            $select->where(
                $dbAdapter->quoteIdentifier($options->getLevelColumnName()).' < ?', $nodeInfo->getLevel()
            );
        }

        $result = $dbAdapter->fetchAll($select);

        return $result;
    }

    /**
     * {@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();
        }

        $dbAdapter = $this->getDbAdapter();
        $select = $this->getDefaultDbSelect();
        $select->order($options->getLeftColumnName().' ASC');

        if ($options->getScopeColumnName()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $select->where($options->getScopeColumnName().' = ?', $nodeInfo->getScope());
        }

        if (0 != $startLevel) {
            $level = $nodeInfo->getLevel() + (int) $startLevel;
            $select->where(
                $dbAdapter->quoteIdentifier($options->getLevelColumnName()).' >= ?', $level
            );
        }

        if (null != $levels) {

            $endLevel = $nodeInfo->getLevel() + (int) $startLevel + abs($levels);
            $select->where(
                $dbAdapter->quoteIdentifier($options->getLevelColumnName()).' < ?', $endLevel
            );
        }

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

            $where = sprintf(
                '(%s OR %s) AND (%s OR %s)',
                $this->getWhereBetween($options->getLeftColumnName(), $nodeInfo->getLeft(), $excludeNodeInfo->getLeft() - 1),
                $this->getWhereBetween($options->getLeftColumnName(),
                    $excludeNodeInfo->getRight() + 1, $nodeInfo->getRight()),
                $this->getWhereBetween($options->getRightColumnName(),
                    $excludeNodeInfo->getRight() + 1, $nodeInfo->getRight()),
                $this->getWhereBetween($options->getRightColumnName(),
                    $nodeInfo->getLeft(), $excludeNodeInfo->getLeft() - 1)
            );
            $select->where($where);
        } else {
            $select->where(
                $dbAdapter->quoteIdentifier($options->getLeftColumnName()).' >= ?', $nodeInfo->getLeft()
            );
            $select->where(
                $dbAdapter->quoteIdentifier($options->getRightColumnName()).' <= ?', $nodeInfo->getRight()
            );
        }

        $resultArray = $dbAdapter->fetchAll($select);

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

    /**
     * {@inheritdoc}
     */
    protected function getWhereBetween($column, $first, $second)
    {
        $dbAdapter = $this->getDbAdapter();
        $quotedColumn = $dbAdapter->quoteIdentifier($column);
        $quotedFirst = $dbAdapter->quote($first);
        $quotedSecond = $dbAdapter->quote($second);

        return sprintf('(%s BETWEEN %s AND %s)', $quotedColumn, $quotedFirst, $quotedSecond);
    }
}

1		<?php
2
3		declare(strict_types=1);
4
5		namespace StefanoTree\NestedSet\Adapter;
6
7		use StefanoTree\NestedSet\NodeInfo;
8		use StefanoTree\NestedSet\Options;
9		use Zend_Db_Adapter_Abstract as ZendDbAdapter;
10		use Zend_Db_Select as ZendDbSelect;
11
12		class Zend1 extends AdapterAbstract implements AdapterInterface
13		{
14		protected $dbAdapter;
15
16		protected $defaultDbSelect;
17
18	50	public function __construct(Options $options, ZendDbAdapter $dbAdapter)
19		{
20	50	$this->setOptions($options);
21	50	$this->setDbAdapter($dbAdapter);
22	50	}
23
24		/**
25		* @param ZendDbAdapter $dbAdapter
26		*/
27	50	protected function setDbAdapter(ZendDbAdapter $dbAdapter): void
28		{
29	50	$this->dbAdapter = $dbAdapter;
30	50	}
31
32		/**
33		* @return ZendDbAdapter
34		*/
35	47	public function getDbAdapter(): ZendDbAdapter
36		{
37	47	return $this->dbAdapter;
38		}
39
40		/**
bartko-s / stefano-tree

Push — develop ( ec49e5...a553c2 )

Zend1::getAncestors() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
