Class: TTK_TicaTK

Source Location: Program_Root/ticatk/ticatk.inc

Class Overview

TTK_TicaTK

TicaTK Manager

Author(s):

Version:

  • $Revision: 1.6 $

Copyright:

  • © 2001, 2002, 2003 Coleebris

Variables

Methods


Child classes:

Inherited Variables

Inherited Methods



Class Details

TicaTK Manager

Tags:

[ Top ]


Class Variables


Class Methods

build_execute_from_xml

void build_execute_from_xml ( $xml )

Create the Execute from a xml stream

Tags:

Parameters:

  • string $xml - xml The xml stream

[ Top ]

build_interface_from_xml

void build_interface_from_xml ( $xml )

Create the Interface from a xml stream

Tags:

Parameters:

  • string $xml - xml The xml stream

[ Top ]

flush_execute

void flush_execute ( )

Reset the Execute

Tags:

Parameters:

[ Top ]

flush_interface

void flush_interface ( )

Reset the Interface

Tags:

Parameters:

[ Top ]

gen_uniq_id

string gen_uniq_id ( )

Generate an unique id

Tags:

Parameters:

[ Top ]

get_ccr_actiondef

TTK_ActionDef get_ccr_actiondef ( )

Get the ActionDef which triggered the current client request

Tags:

  • Return - NULL if undefined

Parameters:

[ Top ]

get_ccr_dest_object

NULL get_ccr_dest_object ( )

Get the targeted object (if any)

Tags:

  • Return - if undefined

Parameters:

[ Top ]

get_ccr_source_object

NULL get_ccr_source_object ( )

Get the object (if any) which triggered the ActionDef

Tags:

  • Return - if undefined

Parameters:

[ Top ]

get_execute

TTK_Execute get_execute ( )

Return current Execute

Tags:

Parameters:

[ Top ]

get_execute_xml

string get_execute_xml ( )

Get a xml stream from the current Execute

Tags:

Parameters:

[ Top ]

get_interface

TTK_Interface get_interface ( [$now_in_init = false] )

Return current Interface

Tags:

Parameters:

  • boolean $now_in_init - now_in_init (optional = false) Internal use

[ Top ]

get_interface_xml

string get_interface_xml ( )

Get a xml stream from the current Interface

Tags:

Parameters:

[ Top ]

handle_event

void handle_event ( )

Lauch callback if required after the handling of the Execute

Tags:

Parameters:

[ Top ]

handle_execute

boolean handle_execute ( )

Handle client Interface modification

Tags:

  • Return - true on success

Parameters:

[ Top ]

register_event_callback

void register_event_callback ( $actiondefid, $callback )

Register a callback for an TTK_ActionDef

Tags:

Parameters:

  • $actiondefid $actiondefid - string The id of the ActionDef
  • $callback $callback - mixed The callback (function name or array(& object, "method name"))

[ Top ]

send_execute

void send_execute ( )

Print out the Execute for the client and flush the Execute

Tags:

Parameters:

[ Top ]

send_interface

void send_interface ( )

Print out the Interface for the client and flush the Execute

Tags:

Parameters:

[ Top ]

send_xml

void send_xml ( $xml )

Print out the xml in the required way to be handled by the client
Static method

Tags:

Parameters:

  • $xml $xml - string The xml to send

[ Top ]

session_end

void session_end ( )

Add an AcExitTTK to the current Execute

Tags:

Parameters:

[ Top ]

constructor TTK_TicaTK

void constructor TTK_TicaTK ( $name, [$basepath = false], [$interface = false] )

Constructor
Create a new TTK application

Tags:

Parameters:

  • string $name - name application name (Informative only)
  • string $basepath - basepath (optional = false) define the base path (server view) of relative path (needed to extract image size). Default to dirname($_SERVER["PATH_TRANSLATED"]) . "/"
  • string $interface - interface (optional = false) xml definition of the TTK interface

[ Top ]

__sleep

array __sleep ( )

Handle serialization of the object

Tags:

Parameters:

[ Top ]

__wakeup

void __wakeup ( )

Handle unserialization of the object

Tags:

Parameters:

[ Top ]


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