encima-io / albero

src/Move.php

<?php

namespace Encima\Albero;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Contracts\Events\Dispatcher;

/**
* Move
*/
class Move
{
    /** @var \Illuminate\Database\Eloquent\Model */
    protected $node = null;

    /** @var \Illuminate\Database\Eloquent\Model|int */
    protected $target = null;

    /** @var string|null */
    protected $position = null;

    /** @var int|null */
    protected $_bound1 = null;

    /** @var int|null */
    protected $_bound2 = null;

    /** @var array|null */
    protected $_boundaries = null;

    /** @var \Illuminate\Events\Dispatcher */
    protected static $dispatcher;

    /**
     * Create a new Move class instance.
     *
     * @param   \Illuminate\Database\Eloquent\Model      $node
     * @param   \Illuminate\Database\Eloquent\Model|int  $target
     * @param   string          $position
     * @return  void
     */
    public function __construct(Model $node, $target, string $position)
    {
        $this->node = $node;
        $this->target = $this->resolveNode($target);
        $this->position = $position;
        $this->setEventDispatcher($node->getEventDispatcher());
    }

    /**
     * Easy static accessor for performing a move operation.
     *
     * @param   \Illuminate\Database\Eloquent\Model      $node
     * @param   \Illuminate\Database\Eloquent\Model|int  $target
     * @param   string          $position
     * @return \Illuminate\Database\Eloquent\Model
     */
    public static function to(Model $node, $target, string $position): Model
    {
        $instance = new static($node, $target, $position);

        return $instance->perform();
    }

    /**
     * Perform the move operation.
     *
     * @return \Illuminate\Database\Eloquent\Model
     */
    public function perform(): Model
    {
        $this->guardAgainstImpossibleMove();

        if ($this->fireMoveEvent('moving') === false) {
            return $this->node;
        }

        if ($this->hasChange()) {
            $self = $this;

            $this->node->getConnection()->transaction(function () use ($self) {
                $self->updateStructure();
            });

            $this->target->reload();

            $this->node->setDepthWithSubtree();

            $this->node->reload();
        }

        $this->fireMoveEvent('moved', false);

        return $this->node;
    }

    /**
     * Runs the SQL query associated with the update of the indexes affected
     * by the move operation.
     *
     * @return int
     */
    public function updateStructure(): int
    {
        list($a, $b, $c, $d) = $this->boundaries();

        // select the rows between the leftmost & the rightmost boundaries and apply a lock
        $this->applyLockBetween($a, $d);

        $connection = $this->node->getConnection();
        $grammar = $connection->getQueryGrammar();

        $currentId = $this->quoteIdentifier($this->node->getKey());
        $parentId = $this->quoteIdentifier($this->parentId());
        $leftColumn = $this->node->getLeftColumnName();
        $rightColumn = $this->node->getRightColumnName();
        $parentColumn = $this->node->getParentColumnName();
        $wrappedLeft = $grammar->wrap($leftColumn);

It seems like $leftColumn can also be of type Illuminate\Database\Eloquent\Builder; however, parameter $value of Illuminate\Database\Query\Grammars\Grammar::wrap() does only seem to accept Illuminate\Database\Query\Expression|string, maybe add an additional type check?

        $wrappedRight = $grammar->wrap($rightColumn);
        $wrappedParent = $grammar->wrap($parentColumn);
        $wrappedId = $grammar->wrap($this->node->getKeyName());

        $lftSql = "CASE
      WHEN ${wrappedLeft} BETWEEN ${a} AND ${b} THEN ${wrappedLeft} + ${d} - ${b}
      WHEN ${wrappedLeft} BETWEEN ${c} AND ${d} THEN ${wrappedLeft} + ${a} - ${c}
      ELSE ${wrappedLeft} END";

        $rgtSql = "CASE
      WHEN ${wrappedRight} BETWEEN ${a} AND ${b} THEN ${wrappedRight} + ${d} - ${b}
      WHEN ${wrappedRight} BETWEEN ${c} AND ${d} THEN ${wrappedRight} + ${a} - ${c}
      ELSE ${wrappedRight} END";

        $parentSql = "CASE
      WHEN ${wrappedId} = ${currentId} THEN ${parentId}
      ELSE ${wrappedParent} END";

        $updateConditions = [
      $leftColumn => $connection->raw($lftSql),
      $rightColumn => $connection->raw($rgtSql),
      $parentColumn => $connection->raw($parentSql),
    ];

        if ($this->node->timestamps) {
            $updateConditions[$this->node->getUpdatedAtColumn()] = $this->node->freshTimestamp();
        }

        return $this->node
                ->newNestedSetQuery()
                ->where(function ($query) use ($leftColumn, $rightColumn, $a, $d) {
                    $query->whereBetween($leftColumn, [$a, $d])
                        ->orWhereBetween($rightColumn, [$a, $d]);
                })
                ->update($updateConditions);
    }

    /**
     * Resolves suplied node. Basically returns the node unchanged if
     * supplied parameter is an instance of \Illuminate\Database\Eloquent\Model. Otherwise it will try
     * to find the node in the database.
     *
     * @param   \Illuminate\Database\Eloquent\Model|int
     * @return  \Illuminate\Database\Eloquent\Model
     */
    protected function resolveNode($node): ?Model
    {
        if (is_object($node)) {
            return $node->reload();
        }

        return $this->node->newNestedSetQuery()->find($node);
    }

    /**
     * Check wether the current move is possible and if not, rais an exception.
     *
     * @return void
     */
    protected function guardAgainstImpossibleMove(): void
    {
        if (!$this->node->exists) {
            throw new MoveNotPossibleException('A new node cannot be moved.');
        }

        if (array_search($this->position, ['child', 'left', 'right', 'root']) === false) {
            throw new MoveNotPossibleException("Position should be one of ['child', 'left', 'right'] but is {$this->position}.");
        }

        if (!$this->promotingToRoot()) {
            if (is_null($this->target)) {
                if ($this->position === 'left' || $this->position === 'right') {
                    throw new MoveNotPossibleException("Could not resolve target node. This node cannot move any further to the {$this->position}.");
                }

                throw new MoveNotPossibleException('Could not resolve target node.');
            }

            if ($this->node->equals($this->target)) {
                throw new MoveNotPossibleException('A node cannot be moved to itself.');
            }

            if ($this->target->insideSubtree($this->node)) {
                throw new MoveNotPossibleException('A node cannot be moved to a descendant of itself (inside moved tree).');
            }

            if (!$this->node->inSameScope($this->target)) {
                throw new MoveNotPossibleException('A node cannot be moved to a different scope.');
            }
        }
    }

    /**
     * Computes the boundary.
     *
     * @return int
     */
    protected function bound1(): int
    {
        if (!is_null($this->_bound1)) {
            return $this->_bound1;
        }

        switch ($this->position) {
      case 'child':
        $this->_bound1 = $this->target->getRight();

It seems like $this->target->getRight() can also be of type Illuminate\Database\Eloquent\Builder. However, the property $_bound1 is declared as type integer|null. Maybe add an additional type check?

        break;

      case 'left':
        $this->_bound1 = $this->target->getLeft();

        break;

      case 'right':
        $this->_bound1 = $this->target->getRight() + 1;

        break;

      case 'root':
        $this->_bound1 = $this->node->newNestedSetQuery()->max($this->node->getRightColumnName()) + 1;

        break;
    }

        $this->_bound1 = (($this->_bound1 > $this->node->getRight()) ? $this->_bound1 - 1 : $this->_bound1);

        return $this->_bound1;
    }

    /**
     * Computes the other boundary.
     * TODO: Maybe find a better name for this... ¿?
     *
     * @return int
     */
    protected function bound2(): int
    {
        if (!is_null($this->_bound2)) {
            return $this->_bound2;
        }

        $this->_bound2 = (($this->bound1() > $this->node->getRight()) ? $this->node->getRight() + 1 : $this->node->getLeft() - 1);

        return $this->_bound2;
    }

    /**
     * Computes the boundaries array.
     *
     * @return array
     */
    protected function boundaries(): array
    {
        if (!is_null($this->_boundaries)) {
            return $this->_boundaries;
        }

        // we have defined the boundaries of two non-overlapping intervals,
        // so sorting puts both the intervals and their boundaries in order
        $this->_boundaries = [
      $this->node->getLeft(),
      $this->node->getRight(),
      $this->bound1(),
      $this->bound2(),
    ];
        sort($this->_boundaries);

        return $this->_boundaries;
    }

    /**
     * Computes the new parent id for the node being moved.
     *
     * @return int|string|null
     */
    protected function parentId()
    {
        switch ($this->position) {
      case 'root':
        return null;

      case 'child':
        return $this->target->getKey();

      default:
        return $this->target->getParentId();
    }
    }

    /**
     * Check wether there should be changes in the downward tree structure.
     *
     * @return boolean
     */
    protected function hasChange(): bool
    {
        return !($this->bound1() == $this->node->getRight() || $this->bound1() == $this->node->getLeft());
    }

    /**
     * Check if we are promoting the provided instance to a root node.
     *
     * @return boolean
     */
    protected function promotingToRoot(): bool
    {
        return ($this->position == 'root');
    }

    /**
     * Get the event dispatcher instance.
     *
     * @return \Illuminate\Contracts\Events\Dispatcher
     */
    public static function getEventDispatcher(): Dispatcher
    {
        return static::$dispatcher;
    }

    /**
     * Set the event dispatcher instance.
     *
     * @param  \Illuminate\Events\Dispatcher
     * @return void
     */
    public static function setEventDispatcher(Dispatcher $dispatcher): void
    {
        static::$dispatcher = $dispatcher;

$dispatcher is of type Illuminate\Contracts\Events\Dispatcher, but the property $dispatcher was declared to be of type Illuminate\Events\Dispatcher. Are you sure that you always receive this specific sub-class here, or does it make sense to add an instanceof check?

    }

    /**
     * Fire the given move event for the model.
     *
     * @param  string $event
     * @param  bool   $halt
     * @return mixed
     */
    protected function fireMoveEvent(string $event, bool $halt = true)
    {
        if (!isset(static::$dispatcher)) {
            return true;
        }

        // Basically the same as \Illuminate\Database\Eloquent\Model->fireModelEvent
        // but we relay the event into the node instance.
        $event = "eloquent.{$event}: ".get_class($this->node);

        $method = $halt ? 'until' : 'dispatch';
        // dd(static::$dispatcher);

        return static::$dispatcher->{$method}($event, $this->node);
    }

    /**
     * Quotes an identifier for being used in a database query.
     *
     * @param mixed $value
     * @return string
     */
    protected function quoteIdentifier($value): string
    {
        if (is_null($value)) {
            return 'NULL';
        }

        $connection = $this->node->getConnection();

        $pdo = $connection->getPdo();

        return $pdo->quote($value);
    }

    /**
     * Applies a lock to the rows between the supplied index boundaries.
     *
     * @param   int   $lft
     * @param   int   $rgt
     * @return  void
     */
    protected function applyLockBetween(int $lft, int $rgt): void
    {
        $this->node->newQuery()
      ->where($this->node->getLeftColumnName(), '>=', $lft)
      ->where($this->node->getRightColumnName(), '<=', $rgt)
      ->select($this->node->getKeyName())
      ->lockForUpdate()
      ->get();
    }
}