Zend2DbAdapter::getRoots() - Code Metrics - Inspection of "scope support added" - bartko-s/stefano-tree - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — develop ( d0fbe3...729812 )

by Bartko
created 2016-05-23 17:39 UTC
Zend2DbAdapter::getRoots() A

↳ Parent: Zend2DbAdapter
Complexity

Conditions	3
Paths	2
Size

Total Lines	20
Code Lines	12
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	13
CRAP Score	3
Importance

Changes	1
Bugs	0	Features	1
Metric	Value
c	1
b	0
f	1
dl	0
loc	20
ccs	13
cts	13
cp	1
rs	9.4285
cc	3
eloc	12
nc	2
nop	1
crap	3
<?php
namespace StefanoTree\NestedSet\Adapter;

use StefanoDb\Adapter\Adapter as DbAdapter;
use StefanoLockTable\Adapter\AdapterInterface as LockSqlBuilderInterface;
use StefanoLockTable\Factory as LockSqlBuilderFactory;
use StefanoTree\NestedSet\NodeInfo;
use StefanoTree\NestedSet\Options;
use Zend\Db;

class Zend2DbAdapter
    implements AdapterInterface

{
    private $options;

    private $dbAdapter;

    private $defaultDbSelect = null;

    private $lockSqlBuilder;

    public function __construct(Options $options, DbAdapter $dbAdapter)
    {
        $this->options = $options;
        $this->dbAdapter = $dbAdapter;
    }

    /**
     * @return Options
     */
    private function getOptions()
    {
        return $this->options;
    }

    /**
     * @return DbAdapter
     */
    private function getDbAdapter()
    {
        return $this->dbAdapter;
    }

    /**
     * Data cannot contain keys like idColumnName, levelColumnName, ...
     *
     * @param array $data
     * @return array
     */
    private function cleanData(array $data)
    {
        $options = $this->getOptions();

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

        return array_diff_key($data, array_flip($disallowedDataKeys));
    }

    /**
     * @param Db\Sql\Select $dbSelect
     * @return void
     */
    public function setDefaultDbSelect(Db\Sql\Select $dbSelect)
    {
        $this->defaultDbSelect = $dbSelect;
    }

    /**
     * Return clone of default db select
     * @return Db\Sql\Select
     */
    public function getDefaultDbSelect()
    {
        $options = $this->getOptions();

        if (null == $this->defaultDbSelect) {
            $this->defaultDbSelect = new Db\Sql\Select($options->getTableName());
        }

        $dbSelect = clone $this->defaultDbSelect;

        return $dbSelect;
    }

    /**
    * @return LockSqlBuilderInterface
    */
    private function getLockSqlBuilder()
    {
        if (null == $this->lockSqlBuilder) {
            $vendorName = $this->getDbAdapter()
                               ->getDriver()
                               ->getDatabasePlatformName();

            $factory = new LockSqlBuilderFactory();
            $this->lockSqlBuilder = $factory->createAdapter($vendorName);
        }

        return $this->lockSqlBuilder;
    }

    public function lockTable()
    {
        $tableName = $this->getOptions()
                          ->getTableName();

        $sql = $this->getLockSqlBuilder()
                    ->getLockSqlString($tableName);

        if (null != $sql) {

            $this->getDbAdapter()
                 ->query($sql, DbAdapter::QUERY_MODE_EXECUTE);
        }
    }

    public function unlockTable()
    {
        $sql = $this->getLockSqlBuilder()
                    ->getUnlockSqlString();

        if (null != $sql) {

            $this->getDbAdapter()
                 ->query($sql, DbAdapter::QUERY_MODE_EXECUTE);
        }
    }

    public function beginTransaction()
    {
        $this->getDbAdapter()
             ->begin();
    }

    public function commitTransaction()
    {
        $this->getDbAdapter()
             ->commit();
    }

    public function rollbackTransaction()
    {
        $this->getDbAdapter()
             ->rollback();
    }

    public function update($nodeId, array $data)
    {
        $options = $this->getOptions();

        $dbAdapter = $this->getDbAdapter();

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

        $update = new Db\Sql\Update($options->getTableName());
        $update->set($data)
               ->where(array(
                    $options->getIdColumnName() => $nodeId,
               ));

        $dbAdapter->query($update->getSqlString($dbAdapter->getPlatform()),
                DbAdapter::QUERY_MODE_EXECUTE);
    }

    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()) {
            $data[$options->getScopeColumnName()] = $nodeInfo->getScope();
        }

        $insert = new Db\Sql\Insert($options->getTableName());
        $insert->values($data);
        $dbAdapter->query($insert->getSqlString($dbAdapter->getPlatform()),
            DbAdapter::QUERY_MODE_EXECUTE);

        $lastGeneratedValue = $dbAdapter->getDriver()
                                        ->getLastGeneratedValue($options->getSequenceName());


        return $lastGeneratedValue;
    }

    public function delete($leftIndex, $rightIndex, $scope=null)
    {
        $options = $this->getOptions();

        $dbAdapter = $this->getDbAdapter();

        $delete = new Db\Sql\Delete($options->getTableName());
        $delete->where
               ->greaterThanOrEqualTo($options->getLeftColumnName(), $leftIndex)
               ->AND
               ->lessThanOrEqualTo($options->getRightColumnName(), $rightIndex);

        if ($options->getScopeColumnName()) {
            $delete->where
                   ->AND
                   ->equalTo($options->getScopeColumnName(), $scope);
        }

        $dbAdapter->query($delete->getSqlString($dbAdapter->getPlatform()),
            DbAdapter::QUERY_MODE_EXECUTE);
    }

    public function moveLeftIndexes($fromIndex, $shift, $scope=null)
    {
        $options = $this->getOptions();

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

        $dbAdapter = $this->getDbAdapter();
        $dbPlatform = $dbAdapter->getPlatform();

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

        if ($options->getScopeColumnName()) {
            $sql .= ' AND ' . $dbPlatform->quoteIdentifier($options->getScopeColumnName()) . ' = ' . $dbPlatform->quoteValue($scope);
        }

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

        $dbAdapter->query($sql)
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                  ->execute($binds);
    }

    public function moveRightIndexes($fromIndex, $shift, $scope=null)
    {
        $options = $this->getOptions();

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

        $dbAdapter = $this->getDbAdapter();
        $dbPlatform = $dbAdapter->getPlatform();

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

        if ($options->getScopeColumnName()) {
            $sql .= ' AND ' . $dbPlatform->quoteIdentifier($options->getScopeColumnName()) . ' = ' . $dbPlatform->quoteValue($scope);
        }

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

        $dbAdapter->query($sql)
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                  ->execute($binds);
    }

    public function updateParentId($nodeId, $newParentId)
    {
        $options = $this->getOptions();

        $dbAdapter = $this->getDbAdapter();

        $update = new Db\Sql\Update($options->getTableName());
        $update->set(array(
                    $options->getParentIdColumnName() => $newParentId,
               ))
               ->where(array(
                   $options->getIdColumnName() => $nodeId,
               ));

        $dbAdapter->query($update->getSqlString($dbAdapter->getPlatform()),
            DbAdapter::QUERY_MODE_EXECUTE);
    }

    public function updateLevels($leftIndexFrom, $rightIndexTo, $shift, $scope=null)
    {
        $options = $this->getOptions();

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

        $dbAdapter = $this->getDbAdapter();
        $dbPlatform = $dbAdapter->getPlatform();

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

        if ($options->getScopeColumnName()) {
            $sql .= ' AND ' . $dbPlatform->quoteIdentifier($options->getScopeColumnName()) . ' = ' . $dbPlatform->quoteValue($scope);
        }

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

        $dbAdapter->query($sql)
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                  ->execute($binds);
    }

    public function moveBranch($leftIndexFrom, $rightIndexTo, $shift, $scope=null)
    {
        if (0 == $shift) {
            return;
        }

        $options = $this->getOptions();

        $dbAdapter = $this->getDbAdapter();
        $dbPlatform = $dbAdapter->getPlatform();

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

        if ($options->getScopeColumnName()) {
            $sql .= ' AND ' . $dbPlatform->quoteIdentifier($options->getScopeColumnName()) . ' = ' . $dbPlatform->quoteValue($scope);
        }

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

        $dbAdapter->query($sql)
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                  ->execute($binds);
    }

    public function getRoots($scope=null)
    {
        $options = $this->getOptions();

        $dbAdapter = $this->getDbAdapter();

        $select = $this->getDefaultDbSelect();
        $select->where
            ->equalTo($options->getParentIdColumnName(),  0);

        if (null != $scope && $options->getScopeColumnName()) {
            $select->where
                ->equalTo($options->getScopeColumnName(), $scope);
        }

        $result = $dbAdapter->query($select->getSqlString($dbAdapter->getPlatform()),
            DbAdapter::QUERY_MODE_EXECUTE);

        return $result->toArray();
    }

    public function getRoot($scope=null)
    {
        $roots = $this->getRoots($scope);

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

    public function getNode($nodeId)
    {
        $options = $this->getOptions();

        $nodeId = (int) $nodeId;

        $dbAdapter = $this->getDbAdapter();

        $select = $this->getDefaultDbSelect()
                       ->where(array($options->getIdColumnName() =>  $nodeId));

        $result = $dbAdapter->query($select->getSqlString($dbAdapter->getPlatform()),
                DbAdapter::QUERY_MODE_EXECUTE);

        $array = $result->toArray();

        if (0 < count($array)) {
            return $array[0];
        }
    }

    public function getNodeInfo($nodeId)
    {
        $options = $this->getOptions();
        $result = $this->getNode($nodeId);

        if (null == $result) {
            $result = null;
        } else {
            $id        = $result[$options->getIdColumnName()];
            $parentId  = $result[$options->getParentIdColumnName()];
            $level     = $result[$options->getLevelColumnName()];
            $left      = $result[$options->getLeftColumnName()];
            $right     = $result[$options->getRightColumnName()];

            if (isset($result[$options->getScopeColumnName()])) {
                $scope = $result[$options->getScopeColumnName()];
            } else {
                $scope = null;
            }

            $result = new NodeInfo($id, $parentId, $level, $left, $right, $scope);
        }

        return $result;
    }

    public function getPath($nodeId, $startLevel = 0, $excludeLastNode = false)
    {
        $options = $this->getOptions();

        $startLevel = (int) $startLevel;

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

        $dbAdapter = $this->getDbAdapter();

        $select = $this->getDefaultDbSelect();

        if ($options->getScopeColumnName()) {
            $select->where
                ->equalTo($options->getScopeColumnName(), $nodeInfo->getScope());
        }

        $select->where
               ->lessThanOrEqualTo($options->getLeftColumnName(), $nodeInfo->getLeft())
               ->AND
               ->greaterThanOrEqualTo($options->getRightColumnName(), $nodeInfo->getRight());

        $select->order($options->getLeftColumnName() . ' ASC');

        if (0 < $startLevel) {
            $select->where
                   ->greaterThanOrEqualTo($options->getLevelColumnName(), $startLevel);
        }

        if (true == $excludeLastNode) {

            $select->where
                   ->lessThan($options->getLevelColumnName(), $nodeInfo->getLevel());
        }

        $result = $dbAdapter->query($select->getSqlString($dbAdapter->getPlatform()),
            DbAdapter::QUERY_MODE_EXECUTE);

        return $result->toArray();
    }

    public function getDescendants($nodeId = 1, $startLevel = 0, $levels = null, $excludeBranch = null)
    {
        $options = $this->getOptions();

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

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

        if ($options->getScopeColumnName()) {
            $select->where
                   ->equalTo($options->getScopeColumnName(), $nodeInfo->getScope());
        }

        if (0 != $startLevel) {
            $level = $nodeInfo->getLevel() + (int) $startLevel;
            $select->where
                   ->greaterThanOrEqualTo($options->getLevelColumnName(), $level);
        }

        if (null != $levels) {

            $endLevel = $nodeInfo->getLevel() + (int) $startLevel + abs($levels);
            $select->where
                   ->lessThan($options->getLevelColumnName(), $endLevel);
        }

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

            $select->where
                   ->NEST
                   ->between($options->getLeftColumnName(),
                        $nodeInfo->getLeft(), $excludeNodeInfo->getLeft() - 1)
                   ->OR
                   ->between($options->getLeftColumnName(),
                        $excludeNodeInfo->getRight() + 1, $nodeInfo->getRight())
                   ->UNNEST
                   ->AND
                   ->NEST
                   ->between($options->getRightColumnName(),
                        $excludeNodeInfo->getRight() + 1, $nodeInfo->getRight())
                   ->OR
                   ->between($options->getRightColumnName(),
                        $nodeInfo->getLeft(), $excludeNodeInfo->getLeft() - 1)
                   ->UNNEST;
        } else {
            $select->where
                   ->greaterThanOrEqualTo($options->getLeftColumnName(), $nodeInfo->getLeft())
                   ->AND
                   ->lessThanOrEqualTo($options->getRightColumnName(), $nodeInfo->getRight());
        }

        $result =  $dbAdapter->query($select->getSqlString($dbAdapter->getPlatform()),
            DbAdapter::QUERY_MODE_EXECUTE);

        $resultArray = $result->toArray();

        if (0 < count($resultArray)) {
            return $resultArray;
        }
    }
}

Push — develop ( d0fbe3...729812 )

Zend2DbAdapter::getRoots() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

bartko-s / stefano-tree

Push — develop ( d0fbe3...729812 )

Zend2DbAdapter::getRoots() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like
