Class: GLOOObject

Source Location: /engine/lib/gloo/gloobject.php

Class GLOOObject

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/gloo/gloobject.php [line 45]

GLDataset
   |
   --GLDOMElement
      |
      --GLOOObject

Author(s):

API Tags:

Example:

An example of how to extend a GLOOObject

Information Tags:

Version:

1.0

Properties

Methods

[ Top ]

Descendants

Child Class	Description
GLDOMStage	GLOO Stage Element This class provides the root stage that wrapes every class around it.
GLMap	GloryLands Map Object
GLMapBackground	GloryLands Map Background Object
GLMapElement	GloryLands Map Element Object
GLUICore	In-Game User Interface core unit
GLUIPanel	In-Game Panel unit

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From GLDOMElement

GLDOMElement::$children

GLDOMElement::$classname

GLDOMElement::$id

GLDOMElement::$next

GLDOMElement::$parent

GLDOMElement::$previous

GLDOMElement::$root

Inherited From GLDataset

GLDataset::$vars

Inherited From GLDOMElement

GLDOMElement::__construct()

GLDOMElement::add_child()

GLDOMElement::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.

GLDOMElement::find_children()

Return all the matching elements

GLDOMElement::remove_child()

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

array	$config	The Unit configuration, as obtained from the config.
int	$linkID	The Link synchronization number between PHP and Javscript object
GLModule	$module	A reference to the root module object
bool	$synced	A flag that defines that objec variables are synced with the JS

[ Top ]

Method Summary

GLOOObject	__construct()
void	object_added()	An inheritable function to notify an object attachment
void	object_removed()	An inheritable function to notify an object detachment
void	var_changed()	An inheritable function to notify a variable update
void	var_removed()	An inheritable function to notify a variable removal
void	_bind()	Bind the object into the rendering template
void	_call()	Perform a call to the JS interface
void	_vars()	Prepare the variables that will be sent to the JS interface
void	__sleep()
void	__wakeup()

[ Top ]

Properties

array $config [line 63]

The Unit configuration, as obtained from the config.

The Unit configuration, as obtained from the config.xml

API Tags:

Access:

protected

[ Top ]

int $linkID [line 57]

The Link synchronization number between PHP and Javscript object

The Link synchronization number between PHP and Javscript object

API Tags:

Access:

public

[ Top ]

GLModule $module [line 51]

A reference to the root module object

A reference to the root module object

API Tags:

Access:

protected

[ Top ]

bool $synced [line 69]

A flag that defines that objec variables are synced with the JS

A flag that defines that objec variables are synced with the JS

API Tags:

Access:

public

[ Top ]

Methods

Constructor __construct [line 85]

GLOOObject __construct(
[
$id = NULL] 
)

Parameters:

$id:

API Tags:

Access:

public

Redefinition of:

GLDOMElement::__construct()

[ Top ]

object_added [line 162]

void object_added(
string
$name, 
&$object, object
$object 
)

An inheritable function to notify an object attachment

An inheritable function to notify an object attachment [INHERITED FROM GLDataset]

Parameters:

string	$name:	The variable name that was updated
object	$object:	The object that was added
	&$object:

API Tags:

Access:

protected

Redefinition of:

GLDataset::object_added(): An inheritable function to notify an object attachment

[ Top ]

object_removed [line 175]

void object_removed(
string
$name, 
&$object, object
$object 
)

An inheritable function to notify an object detachment

An inheritable function to notify an object detachment [INHERITED FROM GLDataset]

Parameters:

string	$name:	The variable name that was updated
object	$object:	The object that was removed
	&$object:

API Tags:

Access:

protected

Redefinition of:

GLDataset::object_removed(): An inheritable function to notify an object detachment

[ Top ]

var_changed [line 137]

void var_changed(
string
$name, 
&$value, mixed
$value 
)

An inheritable function to notify a variable update

An inheritable function to notify a variable update [INHERITED FROM GLDataset]

Parameters:

string	$name:	The variable name that was updated
mixed	$value:	The variable value
	&$value:

API Tags:

Access:

protected

Redefinition of:

GLDataset::var_changed(): An inheritable function to notify a variable update

[ Top ]

var_removed [line 149]

void var_removed(
string
$name 
)

An inheritable function to notify a variable removal

An inheritable function to notify a variable removal [INHERITED FROM GLDataset]

Parameters:

string

$name:

The variable name that was removed

API Tags:

Access:

protected

Redefinition of:

GLDataset::var_removed(): An inheritable function to notify a variable removal

[ Top ]

_bind [line 191]

void _bind(

$template 
)

Bind the object into the rendering template

Bind the object into the rendering template

Parameters:

$template:

API Tags:

Access:

public

[ Top ]

_call [line 198]

void _call(

$call 
)

Perform a call to the JS interface

Perform a call to the JS interface

Parameters:

$call:

API Tags:

Access:

public

[ Top ]

_vars [line 184]

void _vars(
)

Prepare the variables that will be sent to the JS interface

Prepare the variables that will be sent to the JS interface

API Tags:

Access:

public

[ Top ]

__sleep [line 71]

void __sleep(
)

API Tags:

Access:

public

[ Top ]

__wakeup [line 80]

void __wakeup(
)

API Tags:

Access:

public

[ Top ]

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

	GloryLands GLOO

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