Class: TTK_TKNode

Source Location: Program_Root/ticatk/tknode.inc

Class Overview

TTK_TKNode

TicaTK node container

Author(s):

Version:

  • $Revision: 1.10 $

Copyright:

  • © 2001, 2002, 2003 Coleebris

Variables

Methods


Inherited Variables

Inherited Methods



Class Details

TicaTK node container

Tags:

[ Top ]


Class Variables


Class Methods

append_child

void &append_child ( $obj )

Append a node

Tags:

Parameters:

  • object $obj - The node to append (TTK_TKNode or subclass instance)

[ Top ]

close

void close ( )

Delete the node
Note : the object is unsetted and can't be used after this method call

Tags:

Parameters:

[ Top ]

get_attr

string get_attr ( $attr )

Get value of a node attribute

Tags:

Parameters:

  • string $attr - The attribute name

[ Top ]

get_bool_attr

boolean get_bool_attr ( $attr )

Get boolean value of a node attribute

Tags:

Parameters:

  • string $attr - The attribute name

[ Top ]

get_child

object &get_child ( $id )

Get a child by id.
The returned object is not necessary a direct node child.
If the child can't be found, return NULL

Tags:

Parameters:

  • string $id - id Searched child id

[ Top ]

get_childs

array(TTK_TKNode) get_childs ( )

Get node's childs
If the node haven't any childs, return NULL

Tags:

Parameters:

[ Top ]

get_id

string get_id ( )

Get the node's id

Tags:

Parameters:

[ Top ]

get_id_attr

mixed get_id_attr ( $attr, [$return_object = true] )

Get value of a node attribute with optional automatic from value to an instance of TTK_TKNode (or subclass)

Tags:

Parameters:

  • string $attr - The attribute name
  • boolean $return_object - If set to false, the id will be returned

[ Top ]

get_parent

object &get_parent ( )

Get the parent node
If the node haven't a parent, return NULL

Tags:

Parameters:

[ Top ]

get_ttk_object

null &get_ttk_object ( $node, $ticatk )

Map and return a TTK object from a DomNode
Static method
If called on an instance and instance record change in an actiondef,
the returned object will record change too.

Tags:

  • Return - on failure

Parameters:

  • DomNode $node - Node to map
  • TTK_TicaTK $ticatk -

[ Top ]

remove

void remove ( )

Remove the node from parent

Tags:

Parameters:

[ Top ]

set_attr

void set_attr ( $attr, $value, [$local = false] )

Set value of a node attribute

Tags:

Parameters:

  • string $attr - The attribute name
  • string $value - The attribute value
  • boolean $local - The change must not be reflected on the client side

[ Top ]

set_bool_attr

void set_bool_attr ( $attr, $value, [$local = false] )

Set boolean value of a node attribute

Tags:

Parameters:

  • string $attr - The attribute name
  • boolean $value - The attribute value
  • boolean $local - The change must not be reflected on the client side

[ Top ]

set_id_attr

void set_id_attr ( $attr, $value, [$local = false] )

Set value of a node attribute with automatic conversion of value to id if value is an instance of TTK_TKNode (or subclass)

Tags:

Parameters:

  • string $attr - The attribute name
  • mixed $value - The attribute value
  • boolean $local - The change must not be reflected on the client side

[ Top ]

constructor TTK_TKNode

void constructor TTK_TKNode ( &$ticatk, &$doc, [$id = false] )

TTK_TKNode Constructor

Tags:

Parameters:

  • object $ticatk - @see TTK_TicaTK
  • object $doc - DomDocument from which the node must be created
  • string $id - node identity - If not set, an unique id will be generated

[ Top ]

_associate

void _associate ( $ticatk, $domnode )

Associate a DomNode to this node

Tags:

Parameters:

[ Top ]


Documention generated on Mon, 17 Feb 2003 16:18:27 +0100 by phpDocumentor 1.1.0