Class: I2CE Stub (Development)

From IHRIS Wiki
For other versions, see Class: I2CE_Stub (versions) .


This article describes the class I2CE_Stub .

I2CE_Stub

Methods

__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.

addAjaxFunction()

addAjaxLoad()

@param boolean $js_node boolean -- if true, we will include any javascript generated by the I2CE_Stub in the $request.

  • Defined in i2ce/modules/Pages/modules/Stub/I2CE_Stub.php on line 209
  • Signature: public function addAjaxLoad($obj,$id_replace,$requested_page,$id_content,$js_nodes,$form_id)
  • Parameters:
    • $obj
    • string $id_replace
      is the id of the node we wish to replace in the page
    • string $requested_page
      is the page we wish to make the ajax request from @param_string $id_content is the id of the node we wish to pull the content from in the requested page.
    • $id_content
    • $js_nodes
      • Default Value: false
    • 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.
      • Default Value:

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.

addAjaxToggle()

@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.

  • Defined in i2ce/modules/Pages/modules/Stub/I2CE_Stub.php on line 137
  • 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 @param_string $id_content is the id of the node we wish to pull the content from in the requested page.
    • $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

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

addAjaxUpdate()

@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.

  • Defined in i2ce/modules/Pages/modules/Stub/I2CE_Stub.php on line 158
  • 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 @param_string $id_content is the id of the node we wish to pull the content from in the requested page.
    • $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()

getHooks()

getMethods()

hasAjax()

hasAjaxFuzzy()

writeOutJS()

Inherited Methods

action_configure()

This public method is inherited from I2CE_Module->action_configure()

action_disable()

This public method is inherited from I2CE_Module->action_disable()

action_enable()

This public method is inherited from I2CE_Module->action_enable()

action_initialize()

This public method is inherited from I2CE_Module->action_initialize()

getCLIMethods()

This public method is inherited from I2CE_Module->getCLIMethods()

getConfig()

This public method is inherited from I2CE_Module->getConfig()

post_update()

This public method is inherited from I2CE_Module->post_update()

pre_upgrade()

This public method is inherited from I2CE_Module->pre_upgrade()

upgrade()

This public method is inherited from I2CE_Module->upgrade()

_hasMethod()

This public method is inherited from I2CE_Fuzzy->_hasMethod()

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()

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_I2CE_Stub_(Development)&oldid=54002"