phpDocumentor GloryLands
DOM
[ class tree: GloryLands ] [ index: GloryLands ] [ all elements ]

Class: GLDOMElement

Source Location: /engine/lib/dom/gldom_element.php

Class GLDOMElement

Class Overview

Basic DOM Element This class provides the basic class that implements the DOM element.

Basic DOM Element This class provides the basic class that implements the DOM element.

Located in /engine/lib/dom/gldom_element.php [line 43]

GLDataset
   |
   --GLDOMElement
Author(s):
Information Tags:
Version:  1.0

Properties

Methods

[ Top ]
Descendants
Child Class Description
GLOOObject Basic DOM Element This class provides the basic class that implements the DOM element.

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From GLDataset

GLDataset::$vars

Inherited From GLDataset

GLDataset::__construct()
GLDataset::assign()
Assign a value into a variable
GLDataset::import()
Import variables from an array or object
GLDataset::object_added()
An inheritable function to notify an object attachment
GLDataset::object_removed()
An inheritable function to notify an object detachment
GLDataset::pop()
Pop a value from a variable
GLDataset::push()
Push a value on a variable If the variable is not an array, it is conerted to.
GLDataset::push_once()
Push a value on a variable, but make sure it's only one on the array This function checks for an existing $value on the array. exists, it is not appended twice.
GLDataset::shift()
Shift a value from a variable
GLDataset::sort()
Sort the contents of a variable
GLDataset::unshift()
Unshift a value on a variable If the variable is not an array, it is conerted to.
GLDataset::usort()
Sort the contents of a variable using a user callback
GLDataset::var_changed()
An inheritable function to notify a variable update
GLDataset::var_removed()
An inheritable function to notify a variable removal
GLDataset::__get()
Get data variables
GLDataset::__isset()
Check for defined variables
GLDataset::__set()
Set data variables
GLDataset::__unset()
Unset a variable

[ Top ]
Property Summary
mixed   $children  
mixed   $classname  
mixed   $id  
mixed   $next  
mixed   $parent  
mixed   $previous  
mixed   $root  

[ Top ]
Method Summary
GLDOMElement   __construct()  
void   add_child()  
array|bool   find_child()   Return the first matching element Find a child using the following search pattern simmilar to CSS selector on HTML DOM: [<classs>]. Both Class and ID can be ommited.
array   find_children()   Return all the matching elements
void   remove_child()  

[ Top ]
Properties
mixed   $children [line 45]
API Tags:
Access:  public


[ Top ]
mixed   $classname [line 51]
API Tags:
Access:  public


[ Top ]
mixed   $id [line 52]
API Tags:
Access:  public


[ Top ]
mixed   $next [line 47]
API Tags:
Access:  public


[ Top ]
mixed   $parent [line 46]
API Tags:
Access:  public


[ Top ]
mixed   $previous [line 48]
API Tags:
Access:  public


[ Top ]
mixed   $root [line 49]
API Tags:
Access:  public


[ Top ]
Methods
Constructor __construct  [line 54]

  GLDOMElement __construct( [ $class = NULL], [ $id = NULL]  )

Parameters:
   $class: 
   $id: 

API Tags:
Access:  public


Redefinition of:
GLDataset::__construct()

Redefined in descendants as:

[ Top ]
add_child  [line 63]

  void add_child( &$object  )

Parameters:
   &$object: 

API Tags:
Access:  public


[ Top ]
find_child  [line 171]

  array|bool find_child( string $search  )

Return the first matching element Find a child using the following search pattern simmilar to CSS selector on HTML DOM: [<classs>]. Both Class and ID can be ommited.

Return the first matching element Find a child using the following search pattern simmilar to CSS selector on HTML DOM: [<classs>].[<id>][@<index>] Both Class and ID can be ommited. If ommited, everything will be selected. Also, in contrast with find_children, you can specify a specific child instead of the first. <index> is 1-based.

Parameters:
string   $search:  The search pattern

API Tags:
Return:  Return the child objects that match the criteria
Access:  public


[ Top ]
find_children  [line 122]

  array find_children( string $search, [int $count = 0]  )

Return all the matching elements

Return all the matching elements Find a child using the following search pattern simmilar to CSS selector on HTML DOM: [<classs>].[<id>] : Both Class and ID can be ommited. If ommited, everything will be selected

Parameters:
string   $search:  The search pattern
int   $count:  [Optional] The maximum entries to return

API Tags:
Return:  Return the child objects that match the criteria
Access:  public


[ Top ]
remove_child  [line 85]

  void remove_child( $objid  )

Parameters:
   $objid: 

API Tags:
Access:  public


[ Top ]

Documentation generated on Tue, 13 Oct 2009 23:49:02 +0300 by phpDocumentor 1.4.1