propel-om
[ class tree: propel-om ] [ index: propel-om ] [ all elements ]
Packages:
propel
propel-adapter
propel-logger
propel-map
propel-om
propel-util
propel-validator


Files:
BaseObject.php
NestedSetRecursiveIterator.php
NodeObject.php
Persistent.php
PreOrderNodeIterator.php

Interfaces:
NodeObject
Persistent
Classes:
BaseObject
NestedSetRecursiveIterator
PreOrderNodeIterator

Class: NodeObject

Source Location: /om/NodeObject.php

Interface Overview

IteratorAggregate
   |
   --NodeObject

This interface defines methods that must be implemented by all business objects within the system to handle Node object.


Author(s):

Version:

  • $Revision: 797 $

Methods

Class Details

[line 30]
This interface defines methods that must be implemented by all business objects within the system to handle Node object.



Tags:

author:  Heltem <heltem@o2php.com> (Propel)
version:  $Revision: 797 $


[ Top ]

Class Methods

method delete [line 47]

void delete( [ $con = null])

Delete node and descendants



Tags:

throws:  PropelException
access:  public


Parameters:

PropelPDO   $con   Connection to use.

[ Top ]

method getChildren [line 95]

array getChildren( [ $con = null])

Gets the children for the node



Tags:

access:  public


Parameters:

PropelPDO   $con   Connection to use.

[ Top ]

method getDescendants [line 103]

array getDescendants( [ $con = null])

Gets the descendants for the node



Tags:

access:  public


Parameters:

PropelPDO   $con   Connection to use.

[ Top ]

method getLevel [line 63]

int getLevel( [ $con = null])

Gets the level if set, otherwise calculates this and returns it



Tags:

access:  public


Parameters:

PropelPDO   $con   Connection to use.

[ Top ]

method getNumberOfChildren [line 79]

int getNumberOfChildren( [ $con = null])

Gets the number of children for the node (direct descendants)



Tags:

access:  public


Parameters:

PropelPDO   $con   Connection to use.

[ Top ]

method getNumberOfDescendants [line 87]

int getNumberOfDescendants( [ $con = null])

Gets the total number of desceandants for the node



Tags:

access:  public


Parameters:

PropelPDO   $con   Connection to use.

[ Top ]

method getPath [line 71]

array getPath( [ $con = null])

Get the path to the node in the tree



Tags:

access:  public


Parameters:

PropelPDO   $con   Connection to use.

[ Top ]

method getScopeIdValue [line 325]

int getScopeIdValue( )

Wraps the getter for the scope value



Tags:

access:  public


[ Top ]

method hasChildren [line 180]

bool hasChildren( )

Determines if the node has children / descendants



Tags:

access:  public


[ Top ]

method hasNextSibling [line 196]

bool hasNextSibling( [ $con = null])

Determines if the node has next sibling



Tags:

access:  public


Parameters:

PropelPDO   $con   Connection to use.

[ Top ]

method hasParent [line 173]

bool hasParent( [ $con = null])

Tests if object has an ancestor



Tags:

access:  public


Parameters:

PropelPDO   $con   Connection to use.

[ Top ]

method hasPrevSibling [line 188]

bool hasPrevSibling( [ $con = null])

Determines if the node has previous sibling



Tags:

access:  public


Parameters:

PropelPDO   $con   Connection to use.

[ Top ]

method insertAsFirstChildOf [line 245]

object The insertAsFirstChildOf( NodeObject $parent, [ $con = null])

Inserts as first child of destination node $parent



Tags:

return:  current object (for fluent API support)
access:  public


Parameters:

object   $parent   Propel object for given destination node
PropelPDO   $con   Connection to use.

[ Top ]

method insertAsLastChildOf [line 254]

object The insertAsLastChildOf( NodeObject $parent, [ $con = null])

Inserts as last child of destination node $parent



Tags:

return:  current object (for fluent API support)
access:  public


Parameters:

object   $parent   Propel object for given destination node
PropelPDO   $con   Connection to use.

[ Top ]

method insertAsNextSiblingOf [line 272]

object The insertAsNextSiblingOf( NodeObject $dest, [ $con = null])

Inserts node as next sibling to destination node $dest



Tags:

return:  current object (for fluent API support)
access:  public


Parameters:

object   $dest   Propel object for given destination node
PropelPDO   $con   Connection to use.

[ Top ]

method insertAsParentOf [line 318]

void insertAsParentOf( NodeObject $node, [ $con = null])

Inserts node as parent of given node.



Tags:

throws:  Exception When trying to insert node as parent of a root node
access:  public


Parameters:

object   $node   Propel object for given destination node
PropelPDO   $con   Connection to use.

[ Top ]

method insertAsPrevSiblingOf [line 263]

object The insertAsPrevSiblingOf( NodeObject $dest, [ $con = null])

Inserts node as previous sibling to destination node $dest



Tags:

return:  current object (for fluent API support)
access:  public


Parameters:

object   $dest   Propel object for given destination node
PropelPDO   $con   Connection to use.

[ Top ]

method isEqualTo [line 165]

bool isEqualTo( NodeObject $node)

Tests if object is equal to $node



Tags:

access:  public


Parameters:

object   $node   Propel object for node to compare to

[ Top ]

method isLeaf [line 157]

bool isLeaf( )

Determines if the node is a leaf node



Tags:

access:  public


[ Top ]

method isRoot [line 150]

bool isRoot( )

Determines if the node is the root node



Tags:

access:  public


[ Top ]

method makeRoot [line 55]

object The makeRoot( )

Sets node properties to make it a root node.



Tags:

return:  current object (for fluent API support)
throws:  PropelException
access:  public


[ Top ]

method moveToFirstChildOf [line 281]

void moveToFirstChildOf( NodeObject $parent, [ $con = null])

Moves node to be first child of $parent



Tags:

access:  public


Parameters:

object   $parent   Propel object for destination node
PropelPDO   $con   Connection to use.

[ Top ]

method moveToLastChildOf [line 290]

void moveToLastChildOf( NodeObject $parent, [ $con = null])

Moves node to be last child of $parent



Tags:

access:  public


Parameters:

object   $parent   Propel object for destination node
PropelPDO   $con   Connection to use.

[ Top ]

method moveToNextSiblingOf [line 308]

void moveToNextSiblingOf( NodeObject $dest, [ $con = null])

Moves node to be next sibling to $dest



Tags:

access:  public


Parameters:

object   $dest   Propel object for destination node
PropelPDO   $con   Connection to use.

[ Top ]

method moveToPrevSiblingOf [line 299]

void moveToPrevSiblingOf( NodeObject $dest, [ $con = null])

Moves node to be prev sibling to $dest



Tags:

access:  public


Parameters:

object   $dest   Propel object for destination node
PropelPDO   $con   Connection to use.

[ Top ]

method retrieveFirstChild [line 212]

mixed retrieveFirstChild( [ $con = null])

Gets first child if it exists



Tags:

return:  Propel object if exists else false
access:  public


Parameters:

PropelPDO   $con   Connection to use.

[ Top ]

method retrieveLastChild [line 220]

mixed retrieveLastChild( [ $con = null])

Gets last child if it exists



Tags:

return:  Propel object if exists else false
access:  public


Parameters:

PropelPDO   $con   Connection to use.

[ Top ]

method retrieveNextSibling [line 236]

mixed retrieveNextSibling( [ $con = null])

Gets next sibling for the given node if it exists



Tags:

return:  Propel object if exists else false
access:  public


Parameters:

PropelPDO   $con   Connection to use.

[ Top ]

method retrieveParent [line 204]

mixed retrieveParent( [ $con = null])

Gets ancestor for the given node if it exists



Tags:

return:  Propel object if exists else false
access:  public


Parameters:

PropelPDO   $con   Connection to use.

[ Top ]

method retrievePrevSibling [line 228]

mixed retrievePrevSibling( [ $con = null])

Gets prev sibling for the given node if it exists



Tags:

return:  Propel object if exists else false
access:  public


Parameters:

PropelPDO   $con   Connection to use.

[ Top ]

method save [line 38]

void save( [ $con = null])

If object is saved without left/right values, set them as undefined (0)



Tags:

throws:  PropelException
access:  public


Parameters:

PropelPDO   $con   Connection to use.

[ Top ]

method setChildren [line 119]

object The setChildren( $children)

Sets the children array of the node in the tree



Tags:

return:  current object (for fluent API support)
access:  public


Parameters:

array   $children   of Node $children array of Propel node object

[ Top ]

method setLevel [line 111]

object The setLevel( $level, int $v)

Sets the level of the node in the tree



Tags:

return:  current object (for fluent API support)
access:  public


Parameters:

int   $v   new value
   $level  

[ Top ]

method setNextSibling [line 143]

object The setNextSibling( [NodeObject $node = null])

Sets the next sibling of the node in the tree



Tags:

return:  current object (for fluent API support)
access:  public


Parameters:

Node   $node   Propel node object

[ Top ]

method setParentNode [line 127]

object The setParentNode( [NodeObject $parent = null])

Sets the parentNode of the node in the tree



Tags:

return:  current object (for fluent API support)
access:  public


Parameters:

Node   $parent   Propel node object

[ Top ]

method setPrevSibling [line 135]

object The setPrevSibling( [NodeObject $node = null])

Sets the previous sibling of the node in the tree



Tags:

return:  current object (for fluent API support)
access:  public


Parameters:

Node   $node   Propel node object

[ Top ]

method setScopeIdValue [line 333]

object The setScopeIdValue( int $v)

Set the value of scope column



Tags:

return:  current object (for fluent API support)
access:  public


Parameters:

int   $v   new value

[ Top ]

Documentation generated on Thu, 22 Nov 2007 03:33:46 +0000 by phpDocumentor 1.4.0