|
|
| Line 1: |
Line 1: |
| − | <!-- Pod2Wiki=_preamble_
| |
| − | This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost.
| |
| − | -->{{Pod2Wiki}}{{API:Source|file=EPrints/Paginate.pm|package_name=EPrints::Paginate}}[[Category:API|Paginate]]<!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=head_name -->=NAME=
| |
| − | '''EPrints::Paginate''' - Methods for rendering a paginated List
| |
| | | | |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=head_description -->=DESCRIPTION=
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_paginate_list -->==paginate_list==
| |
| − |
| |
| − | $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:'''
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_page_size -->==page_size==
| |
| − |
| |
| − | page_size
| |
| − |
| |
| − | The maximum number of items to display on a page.
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_pagejumps -->==pagejumps==
| |
| − |
| |
| − | The maximum number of page jump links to display.
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_params -->==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.
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_controls_before_controls_after -->==controls_before_controls_after==
| |
| − |
| |
| − | controls_before, controls_after
| |
| − |
| |
| − | Additional links to display before/after the page navigation controls.
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_container -->==container==
| |
| − |
| |
| − | A containing XML DOM element for the list of items on the current page.
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_render_result_render_result_params -->==render_result_render_result_params==
| |
| − |
| |
| − | 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.
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_phrase -->==phrase==
| |
| − |
| |
| − | The phrase to use to render the entire "page". Can make use of the following pins:
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_controls -->==controls==
| |
| − |
| |
| − | prev/next/jump links
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_searchdesc -->==searchdesc==
| |
| − |
| |
| − | description of list e.g. what search parameters produced it
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_matches -->==matches==
| |
| − |
| |
| − | total number of items in list, range of items displayed on current page
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_results -->==results==
| |
| − |
| |
| − | list of rendered items
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_controls_if_matches -->==controls_if_matches==
| |
| − |
| |
| − | prev/next/jump links (only if list contains >0 items)
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=item_pins -->==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).
| |
| − |
| |
| − | <!-- End of Pod2Wiki -->
| |
| − | <!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->
| |
