|
|
| Line 1: |
Line 1: |
| This article describes the class ''I2CE_Module_Jumper''.
| | #REDIRECT [[Class: I2CE_Module_Jumper (4.0.3)]] |
| *Extends the class: [[Class: I2CE_Module | I2CE_Module]].
| |
| *Location: Part of the module [[I2CE Module List#jumper|jumper]] in the package [https://launchpad.net/i2ce I2CE]
| |
| *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Jumper/I2CE_Module_Jumper.php#L29 modules/Jumper/I2CE_Module_Jumper.php] on line 29
| |
| *Author: Carl Leitner <litlfred@ibiblio.org>
| |
| I2CE_Module_Jumper
| |
| ==Methods==
| |
| ===getMethods()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Jumper/I2CE_Module_Jumper.php#L30 i2ce/modules/Jumper/I2CE_Module_Jumper.php] on line 30
| |
| *Signature: static public function getMethods()
| |
| ===makeJumper()===
| |
| Shows the jumper. This jumper works for pages that process a get request. The page must put the all results in the node with id "{$id_base}_results". The jumper is placed in the node with id "{$id_base}_pager_display". It is expected that the node with id "{$id_base}_pager_display" is a sub-node of the node with id "{$id_base}_results". Note: there will be several nodes created with id's of the form "{$id_base}_pager_$something" so with the exception of $something='display' you should not use id's of this form. This fuzzy method can be called either from an I2CE_Page or an I2CE_Template. @param string $pageVaraiable the get variable to store the requested page number in. Defaults to 'page'
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Jumper/I2CE_Module_Jumper.php#L52 i2ce/modules/Jumper/I2CE_Module_Jumper.php] on line 52
| |
| *Signature: public function makeJumper($template,$id_base,$page,$total_pages,$pageURL,$query_fields,$pageVariable)
| |
| *Parameters:
| |
| **$template
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $id_base <br/>the base id that should be used in identifying the node to update (e.g. 'report')
| |
| ** [http://www.php.net/manual/en/language.types.integer.php int ] $page <br/>the current page number
| |
| ** [http://www.php.net/manual/en/language.types.integer.php int ] $total_pages <br/>the total numnber pf pages
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $pageURL <br/>the url of the page we will make the request from @param associatibe array $query_fields keys are the query variables needed for the get request. values are the _unencoded_ values that the variable should have.
| |
| **$query_fields
| |
| **$pageVariable
| |
| ***Default Value: 'page'
| |
| ==Inherited Methods==
| |
| ===__construct()===
| |
| This public method is inherited from [[Class: I2CE_Module#__construct() | I2CE_Module->__construct()]]
| |
| | |
| ===action_configure()===
| |
| This public method is inherited from [[Class: I2CE_Module#action_configure() | I2CE_Module->action_configure()]]
| |
| | |
| ===action_disable()===
| |
| This public method is inherited from [[Class: I2CE_Module#action_disable() | I2CE_Module->action_disable()]]
| |
| | |
| ===action_enable()===
| |
| This public method is inherited from [[Class: I2CE_Module#action_enable() | I2CE_Module->action_enable()]]
| |
| | |
| ===action_initialize()===
| |
| This public method is inherited from [[Class: I2CE_Module#action_initialize() | I2CE_Module->action_initialize()]]
| |
| | |
| ===conflict_external()===
| |
| This public method is inherited from [[Class: I2CE_Module#conflict_external() | I2CE_Module->conflict_external()]]
| |
| | |
| ===getCLIHooks()===
| |
| This public method is inherited from [[Class: I2CE_Module#getCLIHooks() | I2CE_Module->getCLIHooks()]]
| |
| | |
| ===getCLIMethods()===
| |
| This public method is inherited from [[Class: I2CE_Module#getCLIMethods() | I2CE_Module->getCLIMethods()]]
| |
| | |
| ===getConfig()===
| |
| This public method is inherited from [[Class: I2CE_Module#getConfig() | I2CE_Module->getConfig()]]
| |
| | |
| ===getHooks()===
| |
| This public method is inherited from [[Class: I2CE_Module#getHooks() | I2CE_Module->getHooks()]]
| |
| | |
| ===post_update()===
| |
| This public method is inherited from [[Class: I2CE_Module#post_update() | I2CE_Module->post_update()]]
| |
| | |
| ===pre_upgrade()===
| |
| This public method is inherited from [[Class: I2CE_Module#pre_upgrade() | I2CE_Module->pre_upgrade()]]
| |
| | |
| ===requirement_external()===
| |
| This public method is inherited from [[Class: I2CE_Module#requirement_external() | I2CE_Module->requirement_external()]]
| |
| | |
| ===upgrade()===
| |
| This public method is inherited from [[Class: I2CE_Module#upgrade() | I2CE_Module->upgrade()]]
| |
| | |
| ===_hasMethod()===
| |
| This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
| |
| ==Inherited Fuzzy Methods==
| |
| ===launchBackgroundProcess()===
| |
| This method is inherited from [[Class: I2CE_Module#launchBackgroundProcess() | I2CE_Module->launchBackgroundProcess()]]
| |
| | |
| ===launchBackgroundPHPScript()===
| |
| This method is inherited from [[Class: I2CE_Module#launchBackgroundPHPScript() | I2CE_Module->launchBackgroundPHPScript()]]
| |
| | |
| ===launchBackgroundPage()===
| |
| This method is inherited from [[Class: I2CE_Module#launchBackgroundPage() | I2CE_Module->launchBackgroundPage()]]
| |
| | |
| ===userMessage()===
| |
| This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
