Class: I2CE Module Jumper

This article desrcibes the class I2CE_Module_Jumper.

• Extends the class: I2CE_Module.
• 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 associatibe array $query_fields keys are the query variables needed for the get request. values are the _unencoded_ values that the variable should have. @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
• $query_fields
• $pageVariable
  • Default Value: '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()