-
Notifications
You must be signed in to change notification settings - Fork 0
/
NestedSetInterface.php
129 lines (112 loc) · 3.85 KB
/
NestedSetInterface.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
<?php
/*
* Phalcon Ext
* Copyright (c) 2016 David Hübner
* This source file is subject to the New BSD License
* Licence is bundled with this package in the file docs/LICENSE.txt
* Author: David Hübner <[email protected]>
*/
namespace PhalconExt\Mvc\Model;
use Phalcon\Mvc\ModelInterface;
/**
* Nested set (multi root tree) interface
* @author david
*/
interface NestedSetInterface extends ModelInterface
{
/**
* Gets root node
* @return mixed
*/
public function getRoot();
/**
* Gets left value
* @return int
*/
public function getLeft();
/**
* Gets right value
* @return int
*/
public function getRight();
/**
* Gets level
* @return int
*/
public function getLevel();
/**
* Checks if node is root
* @return bool
*/
public function isRoot();
/**
* Checks if node is leaf
* @return bool
*/
public function isleaf();
/**
* Checks if node is descendant of subject
* @param \PhalconExt\Mvc\Model\NestedSetInterface $subject - subject node
* @return bool
*/
public function isDescendantOf(NestedSetInterface $subject);
/**
* Checks if node is ancestor of subject
* @param \PhalconExt\Mvc\Model\NestedSetInterface $subject - subject node
* @return bool
*/
public function isAncestorOf(NestedSetInterface $subject);
/**
* Finds all root nodes
* @static
* @param string $extraCond - query extra conditions, default null
* @param array $extraBind - query extra bindings, default array()
* @param string $columns - selected columns
* @return \Phalcon\Mvc\Model\ResultsetInterface
*/
public static function findRoots($extraCond = null, array $extraBind = array(), $columns = null);
/**
* Finds all descendants
* @param string $extraCond - query extra conditions, default null
* @param array $extraBind - query extra bindings, default array()
* @param string $columns - selected columns, default null
* @param int $depth - how many levels to return, default null
* @return \Phalcon\Mvc\Model\ResultsetInterface
*/
public function findDescendants($extraCond = null, array $extraBind = array(), $columns = null, $depth = null);
/**
* Finds all children
* @param string $extraCond - query extra conditions, default null
* @param array $extraBind - query extra bindings, default array()
* @param string $columns - selected columns, default null
* @return \Phalcon\Mvc\Model\ResultsetInterface
*/
public function findChildren($extraCond = null, array $extraBind = array(), $columns = null);
/**
* Finds all ancestors
* @param string $extraCond - query extra conditions, default null
* @param array $extraBind - query extra bindings, default array()
* @param string $columns - selected columns, default null
* @param int $depth - how many levels to return, default null
* @return \Phalcon\Mvc\Model\ResultsetInterface
*/
public function findAncestors($extraCond = null, array $extraBind = array(), $columns = null, $depth = null);
/**
* Finds parent node
* @param string $columns - selected columns, default null
* @return \PhalconExt\Mvc\Model\NestedSetInterface | false
*/
public function findParent($columns = null);
/**
* Finds previous sibling or previous root
* @param string $columns - selected columns, default null
* @return \PhalconExt\Mvc\Model\NestedSetInterface | false
*/
public function findPrev($columns = null);
/**
* Finds next sibling or next root
* @param string $columns - selected columns, default null
* @return \PhalconExt\Mvc\Model\NestedSetInterface | false
*/
public function findNext($columns = null);
}