Class: I2CE Stub

This article desrcibes the class I2CE_Stub which extends the class I2CE_Module It is contained in the module stub in the package I2CE

The class is defined in the file: modules/Pages/modules/Stub/I2CE_Stub.php

I2CE_Stub

@package I2CE

@subpackage Core

@author Carl Leitner <litlfred@ibiblio.org>

@version 2.1

@access public

Methods

__construct()

• Signature: public function __construct()

addAjaxCompleteFunction()

This fuzzy method takes two arguments. The first arguement is the id of a tag for which there is an event given by addAjaxUpdate. The second argument is a javascript function to call. Once the addAjaxUpdate request has been competed this function is evaled.

• Signature: public function addAjaxCompleteFunction($obj,$id,$func)

Parameters:

• $obj
• $id
• $func

addAjaxFunction()

• Signature: protected function addAjaxFunction($obj,$id,$func,$state)

Parameters:

• $obj
• $id
• $func
• $state

addAjaxRequestFunction()

This fuzzy method takes two arguments. The first arguement is the id of a tag for which there is an event given by addAjaxUpdate. The second argument is a javascript function to call. Once the addAjaxUpdate request has been initiated this function is evaled. Though to be honest, this function may be evaled just before the request has been initiated -- mootools in none to clear on this detail.

• Signature: public function addAjaxRequestFunction($obj,$id,$func)

Parameters:

• $obj
• $id
• $func

addAjaxToggle()

@param_string $id_content is the id of the node we wish to pull the content from in the requested page. @param boolean $js_node boolean -- if true, we will include any javascript generated by the I2CE_Stub in the $request. $param string $form_id -- if set a the id of form we will pull varaibles from. if it is a string or an array of strings it will concatenate all javascript nodes with id given by the strings and include in the request. defaults to false meaning do not return any javascript.

• Signature: public function addAjaxToggle($obj,$id_replace,$id_action,$event,$requested_page,$id_content,$js_nodes,$form_id,$remove_events,$open)

Parameters:

• $obj
• strig $id_replace
  is the id of the node we wish to replace in the page
• string $id_action
  is the id of the node in the page we wish to add the event to
• string $event
  is the event we wish to add on
• string $requested_page
  is the page we wish to make the ajax request from
• $id_content
• $js_nodes
  • Default Value: false
• $form_id
  • Default Value:
• boolean $remove_events
  defaults to false. if true, we remove all events from the action element
  • Default Value: false
• boolean $open
  defaults to false. if true, we remove all event listeners from the action element on the request
  • Default Value: false

addAjaxToggleOffFunction()

This fuzzy method takes two arguments. The first arguement is the id of a tag for which there is an event given by addAjaxUpdate. The second argument is a javascript function to call. on a toggle off starts

• Signature: public function addAjaxToggleOffFunction($obj,$id,$func)

Parameters:

• $obj
• $id
• $func

addAjaxToggleOnFunction()

This fuzzy method takes two arguments. The first arguement is the id of a tag for which there is an event given by addAjaxUpdate. The second argument is a javascript function to call. on a toggle on starts

• Signature: public function addAjaxToggleOnFunction($obj,$id,$func)

Parameters:

• $obj
• $id
• $func

addAjaxUpdate()

@param_string $id_content is the id of the node we wish to pull the content from in the requested page. @param boolean $js_node boolean -- if true, we will include any javascript generated by the I2CE_Stub in the $request. $param string $form_id -- if set a the id of form we will pull varaibles from. if it is a string or an array of strings it will concatenate all javascript nodes with id given by the strings and include in the request. defaults to false meaning do not return any javascript.

• Signature: public function addAjaxUpdate($obj,$id_replace,$id_action,$event,$requested_page,$id_content,$js_nodes,$form_id,$remove_events,$open,$toggle)

Parameters:

• $obj
• strig $id_replace
  is the id of the node we wish to replace in the page
• string $id_action
  is the id of the node in the page we wish to add the event to
• string $event
  is the event we wish to add on
• string $requested_page
  is the page we wish to make the ajax request from
• $id_content
• $js_nodes
  • Default Value: false
• $form_id
  • Default Value:
• boolean $remove_events
  defaults to false. if true, we remove all events from the action element
  • Default Value: false
• boolean $open
  defaults to false. if true, and not a toggle, we remove all event listeners from the action element on the request
  • Default Value: false
• boolean $toggle
  Defaults to false.
  • Default Value: false

ajaxTest()

• Signature: public function ajaxTest($page)

Parameters:

• $page

getHooks()

• Signature: static public function getHooks()

getMethods()

• Signature: static public function getMethods()

hasAjax()

• Signature: static public function hasAjax()

hasAjaxFuzzy()

• Signature: public function hasAjaxFuzzy($obj)

Parameters:

• $obj

writeOutJS()

• Signature: public function writeOutJS($page)

Parameters:

• $page

Inherited Fuzzy Methods

launchBackgroundProcess()

This method is inherited from I2CE_Module->launchBackgroundProcess()

launchBackgroundPHPScript()

This method is inherited from I2CE_Module->launchBackgroundPHPScript()

launchBackgroundPage()

This method is inherited from I2CE_Module->launchBackgroundPage()

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()