Difference between revisions of "API:EPrints/Paginate"
| Line 8: | Line 8: | ||
'''EPrints::Paginate''' - Methods for rendering a paginated List | '''EPrints::Paginate''' - Methods for rendering a paginated List | ||
| − | |||
| − | |||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| − | |||
<!-- Pod2Wiki=head_description --> | <!-- Pod2Wiki=head_description --> | ||
==DESCRIPTION== | ==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. | ||
| − | + | : '''Rendering options:''' | |
| − | |||
| − | |||
| + | ** 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) | ||
| − | + | :: These can be overridden in the "pins" option (below). | |
| − | |||
| − | |||
| − | |||
| − | + | ** 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). | ||
| − | + | <!-- Pod2Wiki=head_copyright --> | |
| − | + | ==COPYRIGHT== | |
| − | + | : Copyright 2000-2011 University of Southampton. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | <!-- Pod2Wiki= | ||
| − | === | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | : This file is part of EPrints http://www.eprints.org/. | |
| − | + | : EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. | |
| − | |||
| − | |||
| + | : EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. | ||
| − | + | : You should have received a copy of the GNU Lesser General Public License along with EPrints. If not, see http://www.gnu.org/licenses/. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| − | + | <!-- Pod2Wiki=_postamble_ --> | |
| − | <!-- Pod2Wiki= | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 09:56, 22 January 2013
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
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.
- Rendering options:
- 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)
- These can be overridden in the "pins" option (below).
- 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).
COPYRIGHT
- Copyright 2000-2011 University of Southampton.
- This file is part of EPrints http://www.eprints.org/.
- EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
- EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
- You should have received a copy of the GNU Lesser General Public License along with EPrints. If not, see http://www.gnu.org/licenses/.
