Difference between revisions of "API:EPrints/Paginate"

From EPrints Documentation
Jump to: navigation, search
Line 1: Line 1:
 
<!-- Pod2Wiki=_preamble_  
 
<!-- Pod2Wiki=_preamble_  
 
This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
 
This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
  -->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Paginate.pm|package_name=EPrints::Paginate}}[[Category:API|PAGINATE]][[Category:API:EPrints/Paginate|PAGINATE]]<div><!-- Edit below this comment -->
+
  -->{{API}}{{Pod2Wiki}}{{API:Source|file=perl_lib/EPrints/Paginate.pm|package_name=EPrints::Paginate}}[[Category:API|PAGINATE]][[Category:API:EPrints/Paginate|PAGINATE]]<div><!-- Edit below this comment -->
  
  

Revision as of 15:26, 16 December 2011

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


API: Core API

Latest Source Code (3.3, 3.2) | Revision Log | Before editing this page please read Pod2Wiki


NAME

EPrints::Paginate - Methods for rendering a paginated List

User Comments


DESCRIPTION

User Comments


$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:

User Comments


page_size

The maximum number of items to display on a page.

User Comments


pagejumps

The maximum number of page jump links to display.

User Comments


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.

User Comments


controls_before, controls_after

Additional links to display before/after the page navigation controls.

User Comments


container

A containing XML DOM element for the list of items on the current page.

User Comments


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.

User Comments


phrase

The phrase to use to render the entire "page". Can make use of the following pins:

User Comments


controls

prev/next/jump links

User Comments


searchdesc

description of list e.g. what search parameters produced it

User Comments


matches

total number of items in list, range of items displayed on current page

User Comments


results

list of rendered items

User Comments


controls_if_matches

prev/next/jump links (only if list contains >0 items)

User Comments


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).

User Comments


COPYRIGHT

User Comments