Class Bjoerne_PageNode

Description
  • author: Bjoerne

Located in /classes.php (line 17)


	
			
Method Summary
node Bjoerne_PageNode ($page &$page)
void add_child (Bjoerne_PageNode &$child)
array &get_children ()
array get_metadata ()
String get_name ()
void &get_page ()
void &get_parent ()
String get_url ()
boolean is_on_selected_path ()
boolean is_selected ()
void set_metadata (array $metadata)
void set_on_selected_path ( $on_selected_path)
void set_parent ( &$parent)
void set_selected ( $selected)
String __toString ()
Methods
Constructor Bjoerne_PageNode (line 48)

Constructor to create an node for a given WordPress page data object.

  • return: with a given WordPress page object
node Bjoerne_PageNode ($page &$page)
  • $page &$page
add_child (line 106)

Adds a child node.

void add_child (Bjoerne_PageNode &$child)
get_children (line 97)

Returns the child nodes.

  • return: Array of nodes.
array &get_children ()
get_metadata (line 80)

Returns metadata of this node

  • return: Array of metadata (key => value)
array get_metadata ()
get_name (line 115)

Returns the name of this node. The name is resolved by registered resolvers.

  • return: name
String get_name ()
get_page (line 56)

Returns the WordPress page data object of this node.

void &get_page ()
get_parent (line 64)

Returns the parent node.

void &get_parent ()
get_url (line 130)

Returns the url of this node. The url is resolved by registered resolvers.

  • return: url
String get_url ()
is_on_selected_path (line 161)

Returns if this node is an descendant node of the currently displayed node.

boolean is_on_selected_path ()
is_selected (line 145)

Returns if this node is the currently displayed node.

boolean is_selected ()
set_metadata (line 89)

Sets metadata of this node.

void set_metadata (array $metadata)
  • array $metadata: Array of metadata (key => value)
set_on_selected_path (line 169)

Sets if this node is an descendant node of the currently displayed node.

void set_on_selected_path ( $on_selected_path)
  • $on_selected_path
set_parent (line 72)

Sets the parent node.

void set_parent ( &$parent)
  • &$parent
set_selected (line 153)

Sets if this node is the currently displayed node.

void set_selected ( $selected)
  • $selected
__toString (line 177)

Returns a String representation of this node.

String __toString ()

Documentation generated on Sat, 21 Jul 2012 22:00:40 +0200 by phpDocumentor 1.4.3