API:EPrints/Paginate
EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects
Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki
Contents
- 1 NAME
- 2 DESCRIPTION
- 2.1 $xhtml = EPrints::Paginate->paginate_list( $session, $basename, $list, %opts )
- 2.2 page_size
- 2.3 pagejumps
- 2.4 params
- 2.5 controls_before, controls_after
- 2.6 container
- 2.7 render_result, render_result_params
- 2.8 phrase
- 2.9 controls
- 2.10 searchdesc
- 2.11 matches
- 2.12 results
- 2.13 controls_if_matches
- 2.14 pins
NAME
EPrints::Paginate - Methods for rendering a paginated List
DESCRIPTION
$xhtml = EPrints::Paginate->paginate_list( $session, $basename, $list, %opts )
Render a "paginated" view of the list i.e. display a "page" of items with links to navigate through the list.
$basename is the basename to use for pagination-specific CGI parameters, to avoid clashes.
%opts is a hash of options which can be used to customise the behaviour and/or rendering of the paginated list. See EPrints::Search for a good example!
Behaviour options:
page_size
The maximum number of items to display on a page.
pagejumps
The maximum number of page jump links to display.
params
A hashref of parameters to include in the prev/next/jump URLs, e.g. to maintain the state of other controls on the page between jumps.
controls_before, controls_after
Additional links to display before/after the page navigation controls.
container
A containing XML DOM element for the list of items on the current page.
render_result, render_result_params
A custom subroutine for rendering an individual item on the current page. The subroutine will be called with $session, $item, and the parameter specified by the render_result_params option. The rendered item should be returned.
phrase
The phrase to use to render the entire "page". Can make use of the following pins:
controls
prev/next/jump links
searchdesc
description of list e.g. what search parameters produced it
matches
total number of items in list, range of items displayed on current page
results
list of rendered items
controls_if_matches
prev/next/jump links (only if list contains >0 items)
pins
Named "pins" to render on the page. These may override the default "pins" (see above), or specify new "pins" (although you would need to define a custom phrase in order to make use of them).
