Arcanedev\LaravelNestedSet\Contracts\Nodeable

Size/Duplication

Total Lines	451
Duplicated Lines	0 %

Importance

Changes

0

52 Methods

Rating	Name	Duplication	Size	Complexity
	getLftName()	0	1	?
	getRgtName()	0	1	?
	getParentIdName()	0	1	?
	getLft()	0	1	?
	setLft()	0	1	?
	getRgt()	0	1	?
	setRgt()	0	1	?
	getParentId()	0	1	?
	setParentId()	0	1	?
	setParentIdAttribute()	0	1	?
	getBounds()	0	1	?
	getNextNode()	0	1	?
	getPrevNode()	0	1	?
	getAncestors()	0	1	?
	getDescendants()	0	1	?
	getSiblings()	0	1	?
	getNextSiblings()	0	1	?
	getPrevSiblings()	0	1	?
	getNextSibling()	0	1	?
	getPrevSibling()	0	1	?
	getNodeHeight()	0	1	?
	getDescendantCount()	0	1	?
	rawNode()	0	1	?
	refreshNode()	0	1	?
	nextSiblings()	0	1	?
	prevSiblings()	0	1	?
	nextNodes()	0	1	?
	prevNodes()	0	1	?
	ancestors()	0	1	?
	makeRoot()	0	1	?
	saveAsRoot()	0	1	?
	appendNode()	0	1	?
	prependNode()	0	1	?
	appendToNode()	0	1	?
	prependToNode()	0	1	?
	appendOrPrependTo()	0	1	?
	afterNode()	0	1	?
	beforeNode()	0	1	?
	beforeOrAfterNode()	0	1	?
	insertAfterNode()	0	1	?
	insertBeforeNode()	0	1	?
	up()	0	1	?
	down()	0	1	?
	newNestedSetQuery()	0	1	?
	newScopedQuery()	0	1	?
	applyNestedSetScope()	0	1	?
	isRoot()	0	1	?
	isDescendantOf()	0	1	?
	isChildOf()	0	1	?
	isSiblingOf()	0	1	?
	isAncestorOf()	0	1	?
	hasMoved()	0	1	?

<?php namespace Arcanedev\LaravelNestedSet\Contracts;

/**
 * Interface  Nodeable
 *
 * @package   Arcanedev\LaravelNestedSet\Contracts
 * @author    ARCANEDEV <arcanedev.maroc@gmail.com>
 *
 * @property  int                                             $id
 * @property  int                                             $_lft
 * @property  int                                             $_rgt
 * @property  int                                             $parent_id
 * @property  \Arcanedev\LaravelNestedSet\Contracts\Nodeable  $parent
 * @property  \Illuminate\Database\Eloquent\Collection        $children
 */
interface Nodeable extends Eloquent
{
    /* -----------------------------------------------------------------
     |  Getters & Setters
     | -----------------------------------------------------------------
     */
    /**
     * Get the lft key name.
     *
     * @return string
     */
    public function getLftName();

    /**
     * Get the rgt key name.
     *
     * @return string
     */
    public function getRgtName();

    /**
     * Get the parent id key name.
     *
     * @return string
     */
    public function getParentIdName();

    /**
     * Get the value of the model's lft key.
     *
     * @return int
     */
    public function getLft();

    /**
     * Set the value of the model's lft key.
     *
     * @param  int  $value
     *
     * @return self
     */
    public function setLft($value);

    /**
     * Get the value of the model's rgt key.
     *
     * @return int
     */
    public function getRgt();

    /**
     * Set the value of the model's rgt key.
     *
     * @param  int  $value
     *
     * @return self
     */
    public function setRgt($value);

    /**
     * Get the value of the model's parent id key.
     *
     * @return int
     */
    public function getParentId();

    /**
     * Set the value of the model's parent id key.
     *
     * @param  int  $value
     *
     * @return self
     */
    public function setParentId($value);

    /**
     * Set the value of model's parent id key.
     *
     * Behind the scenes node is appended to found parent node.
     *
     * @param  int  $value
     *
     * @throws \Exception If parent node doesn't exists
     */
    public function setParentIdAttribute($value);

    /**
     * Get the boundaries.
     *
     * @return array
     */
    public function getBounds();

    /**
     * Returns node that is next to current node without constraining to siblings.
     * This can be either a next sibling or a next sibling of the parent node.
     *
     * @param  array  $columns
     *
     * @return self
     */
    public function getNextNode(array $columns = ['*']);

    /**
     * Returns node that is before current node without constraining to siblings.
     * This can be either a prev sibling or parent node.
     *
     * @param  array  $columns
     *
     * @return self
     */
    public function getPrevNode(array $columns = ['*']);

    /**
     * Get the ancestors nodes.
     *
     * @param  array  $columns
     *
     * @return \Arcanedev\LaravelNestedSet\Eloquent\Collection
     */
    public function getAncestors(array $columns = ['*']);

    /**
     * Get the descendants nodes.
     *
     * @param  array  $columns
     *
     * @return \Arcanedev\LaravelNestedSet\Eloquent\Collection
     */
    public function getDescendants(array $columns = ['*']);

    /**
     * Get the siblings nodes.
     *
     * @param  array  $columns
     *
     * @return \Arcanedev\LaravelNestedSet\Eloquent\Collection
     */
    public function getSiblings(array $columns = ['*']);

    /**
     * Get the next siblings nodes.
     *
     * @param  array  $columns
     *
     * @return \Arcanedev\LaravelNestedSet\Eloquent\Collection
     */
    public function getNextSiblings(array $columns = ['*']);

    /**
     * Get the previous siblings nodes.
     *
     * @param  array  $columns
     *
     * @return \Arcanedev\LaravelNestedSet\Eloquent\Collection
     */
    public function getPrevSiblings(array $columns = ['*']);

    /**
     * Get the next sibling node.
     *
     * @param  array  $columns
     *
     * @return self
     */
    public function getNextSibling(array $columns = ['*']);

    /**
     * Get the previous sibling node.
     *
     * @param  array  $columns
     *
     * @return self
     */
    public function getPrevSibling(array $columns = ['*']);

    /**
     * Get node height (rgt - lft + 1).
     *
     * @return int
     */
    public function getNodeHeight();

    /**
     * Get number of descendant nodes.
     *
     * @return int
     */
    public function getDescendantCount();

    /**
     * Set raw node.
     *
     * @param  int  $lft
     * @param  int  $rgt
     * @param  int  $parentId
     *
     * @return self
     */
    public function rawNode($lft, $rgt, $parentId);

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */
    /**
     * Refresh node's crucial attributes.
     */
    public function refreshNode();

    /**
     * Get query for siblings after the node.
     *
     * @return \Arcanedev\LaravelNestedSet\Eloquent\QueryBuilder
     */
    public function nextSiblings();

    /**
     * Get query for siblings before the node.
     *
     * @return \Arcanedev\LaravelNestedSet\Eloquent\QueryBuilder
     */
    public function prevSiblings();

    /**
     * Get query for nodes after current node.
     *
     * @return \Arcanedev\LaravelNestedSet\Eloquent\QueryBuilder
     */
    public function nextNodes();

    /**
     * Get query for nodes before current node in reversed order.
     *
     * @return \Arcanedev\LaravelNestedSet\Eloquent\QueryBuilder
     */
    public function prevNodes();

    /**
     * Get query for ancestors to the node not including the node itself.
     *
     * @return \Arcanedev\LaravelNestedSet\Eloquent\QueryBuilder
     */
    public function ancestors();

    /**
     * Make this node a root node.
     *
     * @return self
     */
    public function makeRoot();

    /**
     * Save node as root.
     *
     * @return bool
     */
    public function saveAsRoot();

    /**
     * Append and save a node.
     *
     * @param  self  $node
     *
     * @return bool
     */
    public function appendNode(Nodeable $node);

    /**
     * Prepend and save a node.
     *
     * @param  self  $node
     *
     * @return bool
     */
    public function prependNode(Nodeable $node);

    /**
     * Append a node to the new parent.
     *
     * @param  self  $parent
     *
     * @return self
     */
    public function appendToNode(Nodeable $parent);

    /**
     * Prepend a node to the new parent.
     *
     * @param  self  $parent
     *
     * @return self
     */
    public function prependToNode(Nodeable $parent);

    /**
     * Append or prepend a node to parent.
     *
     * @param  self  $parent
     * @param  bool  $prepend
     *
     * @return self
     */
    public function appendOrPrependTo(Nodeable $parent, $prepend = false);

    /**
     * Insert self after a node.
     *
     * @param  self  $node
     *
     * @return self
     */
    public function afterNode(Nodeable $node);

    /**
     * Insert self before node.
     *
     * @param  self  $node
     *
     * @return self
     */
    public function beforeNode(Nodeable $node);

    /**
     * Set before or after a node.
     *
     * @param  self  $node
     * @param  bool  $after
     *
     * @return self
     */
    public function beforeOrAfterNode(Nodeable $node, $after = false);

    /**
     * Insert after a node and save.
     *
     * @param  self  $node
     *
     * @return bool
     */
    public function insertAfterNode(Nodeable $node);

    /**
     * Insert before a node and save.
     *
     * @param  self  $node
     *
     * @return bool
     */
    public function insertBeforeNode(Nodeable $node);

    /**
     * Move node up given amount of positions.
     *
     * @param  int  $amount
     *
     * @return bool
     */
    public function up($amount = 1);

    /**
     * Move node down given amount of positions.
     *
     * @param  int  $amount
     *
     * @return bool
     */
    public function down($amount = 1);

    /**
     * Get a new base query that includes deleted nodes.
     *
     * @param  string|null $table
     *
     * @return \Arcanedev\LaravelNestedSet\Eloquent\QueryBuilder
     */
    public function newNestedSetQuery($table = null);

    /**
     * Create a new scoped query.
     *
     * @param  string|null  $table
     *
     * @return \Arcanedev\LaravelNestedSet\Eloquent\QueryBuilder
     */
    public function newScopedQuery($table = null);

    /**
     * Apply the nested set scope.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder  $query
     * @param  string                                                                    $table
     *
     * @return \Arcanedev\LaravelNestedSet\Eloquent\QueryBuilder|\Illuminate\Database\Query\Builder
     */
    public function applyNestedSetScope($query, $table = null);

    /* -----------------------------------------------------------------
     |  Check Methods
     | -----------------------------------------------------------------
     */
    /**
     * Get whether node is root.
     *
     * @return bool
     */
    public function isRoot();

    /**
     * Get whether a node is a descendant of other node.
     *
     * @param  self  $node
     *
     * @return bool
     */
    public function isDescendantOf(Nodeable $node);

    /**
     * Get whether the node is immediate children of other node.
     *
     * @param  self  $node
     *
     * @return bool
     */
    public function isChildOf(Nodeable $node);

    /**
     * Get whether the node is a sibling of another node.
     *
     * @param  self  $node
     *
     * @return bool
     */
    public function isSiblingOf(Nodeable $node);

    /**
     * Get whether the node is an ancestor of other node, including immediate parent.
     *
     * @param  self  $node
     *
     * @return bool
     */
    public function isAncestorOf(Nodeable $node);

    /**
     * Get whether the node has moved since last save.
     *
     * @return bool
     */
    public function hasMoved();
}