Class: I2CE Module Jumper: Difference between revisions
No edit summary |
No edit summary |
||
Line 2: | Line 2: | ||
*Extends the class: [[Class: I2CE_Module | I2CE_Module]]. | *Extends the class: [[Class: I2CE_Module | I2CE_Module]]. | ||
*Parent Classses: [[Class: I2CE_Module | I2CE_Module]] [[Class: I2CE_Fuzzy | I2CE_Fuzzy]] | *Parent Classses: [[Class: I2CE_Module | I2CE_Module]] [[Class: I2CE_Fuzzy | I2CE_Fuzzy]] | ||
*Location: Part of the 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.0-release/annotate/head:/modules/Jumper/I2CE_Module_Jumper.php modules/Jumper/I2CE_Module_Jumper.php] | *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/annotate/head:/modules/Jumper/I2CE_Module_Jumper.php modules/Jumper/I2CE_Module_Jumper.php] | ||
*Author: Carl Leitner <litlfred@ibiblio.org> | *Author: Carl Leitner <litlfred@ibiblio.org> | ||
Line 21: | Line 21: | ||
**$pageVariable | **$pageVariable | ||
***Default Value: 'page' | ***Default Value: 'page' | ||
[[Category:Class Documentation]] | [[Category:Class Documentation]] |
Revision as of 12:09, 19 October 2009
This article describes the class I2CE_Module_Jumper.
- Extends the class: I2CE_Module.
- Parent Classses: I2CE_Module I2CE_Fuzzy
- Location: Part of the module jumper in the package I2CE
- Source: Defined in the file modules/Jumper/I2CE_Module_Jumper.php
- Author: Carl Leitner <litlfred@ibiblio.org>
I2CE_Module_Jumper
Methods
getMethods()
- 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'
- Signature: public function makeJumper($template,$id_base,$page,$total_pages,$pageURL,$query_fields,$pageVariable)
- Parameters:
- $template
- string $id_base
the base id that should be used in identifying the node to update (e.g. 'report') - int $page
the current page number - int $total_pages
the total numnber pf pages - string $pageURL
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'