/usr/share/php/propel/util/NodePeer.php is in php-propel-runtime 1.6.9-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 | <?php
/**
* This file is part of the Propel package.
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @license MIT License
*/
/**
* This is a utility interface for all generated NodePeer classes in the system.
*
* @author Heltem <heltem@o2php.com> (Propel)
* @version $Revision$
* @package propel.runtime.util
*/
interface NodePeer
{
/**
* Creates the supplied node as the root node.
*
* @param NodeObject $node Propel object for model
* @return object Inserted propel object for model
*/
public static function createRoot(NodeObject $node);
/**
* Returns the root node for a given scope id
*
* @param int $scopeId Scope id to determine which root node to return
* @param PropelPDO $con Connection to use.
* @return object Propel object for root node
*/
public static function retrieveRoot($scopeId = 1, PropelPDO $con = null);
/**
* Inserts $child as first child of destination node $parent
*
* @param object $child Propel object for child node
* @param object $parent Propel object for parent node
* @param PropelPDO $con Connection to use.
* @return void
*/
public static function insertAsFirstChildOf(NodeObject $child, NodeObject $parent, PropelPDO $con = null);
/**
* Inserts $child as last child of destination node $parent
*
* @param object $child Propel object for child node
* @param object $parent Propel object for parent node
* @param PropelPDO $con Connection to use.
* @return void
*/
public static function insertAsLastChildOf(NodeObject $child, NodeObject $parent, PropelPDO $con = null);
/**
* Inserts $sibling as previous sibling to destination node $node
*
* @param object $node Propel object for destination node
* @param object $sibling Propel object for source node
* @param PropelPDO $con Connection to use.
* @return void
*/
public static function insertAsPrevSiblingOf(NodeObject $node, NodeObject $sibling, PropelPDO $con = null);
/**
* Inserts $sibling as next sibling to destination node $node
*
* @param object $node Propel object for destination node
* @param object $sibling Propel object for source node
* @param PropelPDO $con Connection to use.
* @return void
*/
public static function insertAsNextSiblingOf(NodeObject $node, NodeObject $sibling, PropelPDO $con = null);
/**
* Inserts $parent as parent of given $node.
*
* @param object $parent Propel object for given parent node
* @param object $node Propel object for given destination node
* @param PropelPDO $con Connection to use.
* @return void
* @throws Exception When trying to insert node as parent of a root node
*/
public static function insertAsParentOf(NodeObject $parent, NodeObject $node, PropelPDO $con = null);
/**
* Inserts $node as root node
*
* @param object $node Propel object as root node
* @param PropelPDO $con Connection to use.
* @return void
*/
public static function insertRoot(NodeObject $node, PropelPDO $con = null);
/**
* Delete root node
*
* @param int $scopeId Scope id to determine which root node to delete
* @param PropelPDO $con Connection to use.
* @return boolean Deletion status
*/
public static function deleteRoot($scopeId = 1, PropelPDO $con = null);
/**
* Delete $dest node
*
* @param object $dest Propel object node to delete
* @param PropelPDO $con Connection to use.
* @return boolean Deletion status
*/
public static function deleteNode(NodeObject $dest, PropelPDO $con = null);
/**
* Moves $child to be first child of $parent
*
* @param object $parent Propel object for parent node
* @param object $child Propel object for child node
* @param PropelPDO $con Connection to use.
* @return void
*/
public static function moveToFirstChildOf(NodeObject $parent, NodeObject $child, PropelPDO $con = null);
/**
* Moves $node to be last child of $dest
*
* @param object $dest Propel object for destination node
* @param object $node Propel object for source node
* @param PropelPDO $con Connection to use.
* @return void
*/
public static function moveToLastChildOf(NodeObject $dest, NodeObject $node, PropelPDO $con = null);
/**
* Moves $node to be prev sibling to $dest
*
* @param object $dest Propel object for destination node
* @param object $node Propel object for source node
* @param PropelPDO $con Connection to use.
* @return void
*/
public static function moveToPrevSiblingOf(NodeObject $dest, NodeObject $node, PropelPDO $con = null);
/**
* Moves $node to be next sibling to $dest
*
* @param object $dest Propel object for destination node
* @param object $node Propel object for source node
* @param PropelPDO $con Connection to use.
* @return void
*/
public static function moveToNextSiblingOf(NodeObject $dest, NodeObject $node, PropelPDO $con = null);
/**
* Gets first child for the given node if it exists
*
* @param object $node Propel object for src node
* @param PropelPDO $con Connection to use.
* @return mixed Propel object if exists else false
*/
public static function retrieveFirstChild(NodeObject $node, PropelPDO $con = null);
/**
* Gets last child for the given node if it exists
*
* @param object $node Propel object for src node
* @param PropelPDO $con Connection to use.
* @return mixed Propel object if exists else false
*/
public static function retrieveLastChild(NodeObject $node, PropelPDO $con = null);
/**
* Gets prev sibling for the given node if it exists
*
* @param object $node Propel object for src node
* @param PropelPDO $con Connection to use.
* @return mixed Propel object if exists else false
*/
public static function retrievePrevSibling(NodeObject $node, PropelPDO $con = null);
/**
* Gets next sibling for the given node if it exists
*
* @param object $node Propel object for src node
* @param PropelPDO $con Connection to use.
* @return mixed Propel object if exists else false
*/
public static function retrieveNextSibling(NodeObject $node, PropelPDO $con = null);
/**
* Retrieves the entire tree from root
*
* @param int $scopeId Scope id to determine which scope tree to return
* @param PropelPDO $con Connection to use.
*/
public static function retrieveTree($scopeId = 1, PropelPDO $con = null);
/**
* Retrieves the entire tree from parent $node
*
* @param PropelPDO $con Connection to use.
*/
public static function retrieveBranch(NodeObject $node, PropelPDO $con = null);
/**
* Gets direct children for the node
*
* @param object $node Propel object for parent node
* @param PropelPDO $con Connection to use.
*/
public static function retrieveChildren(NodeObject $node, PropelPDO $con = null);
/**
* Gets all descendants for the node
*
* @param object $node Propel object for parent node
* @param PropelPDO $con Connection to use.
*/
public static function retrieveDescendants(NodeObject $node, PropelPDO $con = null);
/**
* Gets all siblings for the node
*
* @param object $node Propel object for src node
* @param PropelPDO $con Connection to use.
*/
public static function retrieveSiblings(NodeObject $node, PropelPDO $con = null);
/**
* Gets ancestor for the given node if it exists
*
* @param object $node Propel object for src node
* @param PropelPDO $con Connection to use.
* @return mixed Propel object if exists else false
*/
public static function retrieveParent(NodeObject $node, PropelPDO $con = null);
/**
* Gets level for the given node
*
* @param object $node Propel object for src node
* @param PropelPDO $con Connection to use.
* @return int Level for the given node
*/
public static function getLevel(NodeObject $node, PropelPDO $con = null);
/**
* Gets number of direct children for given node
*
* @param object $node Propel object for src node
* @param PropelPDO $con Connection to use.
* @return int Level for the given node
*/
public static function getNumberOfChildren(NodeObject $node, PropelPDO $con = null);
/**
* Gets number of descendants for given node
*
* @param object $node Propel object for src node
* @param PropelPDO $con Connection to use.
* @return int Level for the given node
*/
public static function getNumberOfDescendants(NodeObject $node, PropelPDO $con = null);
/**
* Returns path to a specific node as an array, useful to create breadcrumbs
*
* @param object $node Propel object of node to create path to
* @param PropelPDO $con Connection to use.
* @return array Array in order of heirarchy
*/
public static function getPath(NodeObject $node, PropelPDO $con = null);
/**
* Tests if node is valid
*
* @param object $node Propel object for src node
* @return bool
*/
public static function isValid(NodeObject $node = null);
/**
* Tests if node is a root
*
* @param object $node Propel object for src node
* @return bool
*/
public static function isRoot(NodeObject $node);
/**
* Tests if node is a leaf
*
* @param object $node Propel object for src node
* @return bool
*/
public static function isLeaf(NodeObject $node);
/**
* Tests if $child is a child of $parent
*
* @param object $child Propel object for node
* @param object $parent Propel object for node
* @return bool
*/
public static function isChildOf(NodeObject $child, NodeObject $parent);
/**
* Tests if $node1 is equal to $node2
*
* @param object $node1 Propel object for node
* @param object $node2 Propel object for node
* @return bool
*/
public static function isEqualTo(NodeObject $node1, NodeObject $node2);
/**
* Tests if $node has an ancestor
*
* @param object $node Propel object for node
* @param PropelPDO $con Connection to use.
* @return bool
*/
public static function hasParent(NodeObject $node, PropelPDO $con = null);
/**
* Tests if $node has prev sibling
*
* @param object $node Propel object for node
* @param PropelPDO $con Connection to use.
* @return bool
*/
public static function hasPrevSibling(NodeObject $node, PropelPDO $con = null);
/**
* Tests if $node has next sibling
*
* @param object $node Propel object for node
* @param PropelPDO $con Connection to use.
* @return bool
*/
public static function hasNextSibling(NodeObject $node, PropelPDO $con = null);
/**
* Tests if $node has children
*
* @param object $node Propel object for node
* @return bool
*/
public static function hasChildren(NodeObject $node);
/**
* Deletes $node and all of its descendants
*
* @param object $node Propel object for source node
* @param PropelPDO $con Connection to use.
*/
public static function deleteDescendants(NodeObject $node, PropelPDO $con = null);
/**
* Returns a node given its primary key or the node itself
*
* @param int/object $node Primary key/instance of required node
* @param PropelPDO $con Connection to use.
* @return object Propel object for model
*/
public static function getNode($node, PropelPDO $con = null);
} // NodePeer
|