Class: I2CE Stub: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
| Line 12: | Line 12: | ||
*Signature: public function addAjaxCompleteFunction($obj,$id,$func) | *Signature: public function addAjaxCompleteFunction($obj,$id,$func) | ||
*Parameters: | *Parameters: | ||
*$obj | **$obj | ||
*$id | **$id | ||
*$func | **$func | ||
===addAjaxFunction()=== | ===addAjaxFunction()=== | ||
*Signature: protected function addAjaxFunction($obj,$id,$func,$state) | *Signature: protected function addAjaxFunction($obj,$id,$func,$state) | ||
*Parameters: | *Parameters: | ||
*$obj | **$obj | ||
*$id | **$id | ||
*$func | **$func | ||
*$state | **$state | ||
===addAjaxRequestFunction()=== | ===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. | 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) | *Signature: public function addAjaxRequestFunction($obj,$id,$func) | ||
*Parameters: | *Parameters: | ||
*$obj | **$obj | ||
*$id | **$id | ||
*$func | **$func | ||
===addAjaxToggle()=== | ===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. | @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) | *Signature: public function addAjaxToggle($obj,$id_replace,$id_action,$event,$requested_page,$id_content,$js_nodes,$form_id,$remove_events,$open) | ||
*Parameters: | *Parameters: | ||
*$obj | **$obj | ||
** strig $id_replace <br/>is the id of the node we wish to replace in the page | ** strig $id_replace <br/>is the id of the node we wish to replace in the page | ||
** [http://www.php.net/manual/en/language.types.string.php string ] $id_action <br/>is the id of the node in the page we wish to add the event to | ** [http://www.php.net/manual/en/language.types.string.php string ] $id_action <br/>is the id of the node in the page we wish to add the event to | ||
** [http://www.php.net/manual/en/language.types.string.php string ] $event <br/>is the event we wish to add on | ** [http://www.php.net/manual/en/language.types.string.php string ] $event <br/>is the event we wish to add on | ||
** [http://www.php.net/manual/en/language.types.string.php string ] $requested_page <br/>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. | ** [http://www.php.net/manual/en/language.types.string.php string ] $requested_page <br/>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 | **$id_content | ||
*$js_nodes | **$js_nodes | ||
***Default Value: false | ***Default Value: false | ||
*$form_id | **$form_id | ||
***Default Value: '' | ***Default Value: '' | ||
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $remove_events <br/>defaults to false. if true, we remove all events from the action element | ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $remove_events <br/>defaults to false. if true, we remove all events from the action element | ||
| Line 51: | Line 51: | ||
*Signature: public function addAjaxToggleOffFunction($obj,$id,$func) | *Signature: public function addAjaxToggleOffFunction($obj,$id,$func) | ||
*Parameters: | *Parameters: | ||
*$obj | **$obj | ||
*$id | **$id | ||
*$func | **$func | ||
===addAjaxToggleOnFunction()=== | ===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 | 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) | *Signature: public function addAjaxToggleOnFunction($obj,$id,$func) | ||
*Parameters: | *Parameters: | ||
*$obj | **$obj | ||
*$id | **$id | ||
*$func | **$func | ||
===addAjaxUpdate()=== | ===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. | @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) | *Signature: public function addAjaxUpdate($obj,$id_replace,$id_action,$event,$requested_page,$id_content,$js_nodes,$form_id,$remove_events,$open,$toggle) | ||
*Parameters: | *Parameters: | ||
*$obj | **$obj | ||
** strig $id_replace <br/>is the id of the node we wish to replace in the page | ** strig $id_replace <br/>is the id of the node we wish to replace in the page | ||
** [http://www.php.net/manual/en/language.types.string.php string ] $id_action <br/>is the id of the node in the page we wish to add the event to | ** [http://www.php.net/manual/en/language.types.string.php string ] $id_action <br/>is the id of the node in the page we wish to add the event to | ||
** [http://www.php.net/manual/en/language.types.string.php string ] $event <br/>is the event we wish to add on | ** [http://www.php.net/manual/en/language.types.string.php string ] $event <br/>is the event we wish to add on | ||
** [http://www.php.net/manual/en/language.types.string.php string ] $requested_page <br/>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. | ** [http://www.php.net/manual/en/language.types.string.php string ] $requested_page <br/>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 | **$id_content | ||
*$js_nodes | **$js_nodes | ||
***Default Value: false | ***Default Value: false | ||
*$form_id | **$form_id | ||
***Default Value: '' | ***Default Value: '' | ||
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $remove_events <br/>defaults to false. if true, we remove all events from the action element | ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $remove_events <br/>defaults to false. if true, we remove all events from the action element | ||
| Line 84: | Line 84: | ||
*Signature: public function ajaxTest($page) | *Signature: public function ajaxTest($page) | ||
*Parameters: | *Parameters: | ||
*$page | **$page | ||
===getHooks()=== | ===getHooks()=== | ||
*Signature: static public function getHooks() | *Signature: static public function getHooks() | ||
| Line 94: | Line 94: | ||
*Signature: public function hasAjaxFuzzy($obj) | *Signature: public function hasAjaxFuzzy($obj) | ||
*Parameters: | *Parameters: | ||
*$obj | **$obj | ||
===writeOutJS()=== | ===writeOutJS()=== | ||
*Signature: public function writeOutJS($page) | *Signature: public function writeOutJS($page) | ||
*Parameters: | *Parameters: | ||
*$page | **$page | ||
==Inherited Fuzzy Methods== | ==Inherited Fuzzy Methods== | ||
===launchBackgroundProcess()=== | ===launchBackgroundProcess()=== | ||
Revision as of 12:10, 17 October 2009
This article desrcibes the class I2CE_Stub.
- Extends the class: I2CE_Module.
- Location: Part of the module stub in the package I2CE
- Source: Defined in the file modules/Pages/modules/Stub/I2CE_Stub.php
- Author: Carl Leitner <litlfred@ibiblio.org>
I2CE_Stub
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 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 @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
- 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 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 @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()
- 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()
