Difference between revisions of "API:EPrints/Paginate"

From EPrints Documentation
Jump to: navigation, search
(New page: <!-- 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. -...)
 
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
<!-- Pod2Wiki=_preamble_  
 
<!-- 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.
+
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.
−
  -->{{Pod2Wiki}}{{API:Source|file=EPrints/Paginate.pm|package_name=EPrints::Paginate}}[[Category:API|Paginate]]<!-- End of Pod2Wiki -->
+
  -->{{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 -->
−
<!-- 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-&gt;paginate_list( $session, $basename, $list, %opts )
+
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
−
 
+
==NAME==
−
Render a "paginated" view of the list i.e. display a "page" of items  with links to navigate through the list.
+
'''EPrints::Paginate''' - Methods for rendering a paginated 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
+
<!-- Edit below this comment -->
  
−
The maximum number of items to display on a page.
 
  
−
<!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki= -->
−
<!-- Pod2Wiki=item_pagejumps -->==pagejumps==
+
<!-- Pod2Wiki=head_description -->
 +
==DESCRIPTION==
 +
* $xhtml = EPrints::Paginate-&gt;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.
  
−
The maximum number of page jump links to display.
+
: $basename is the basename to use for pagination-specific CGI parameters, to avoid clashes.
  
−
<!-- End of Pod2Wiki -->
+
: %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!
−
<!-- 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.
+
: '''Behaviour options:'''
  
−
<!-- End of Pod2Wiki -->
+
** page_size
−
<!-- Pod2Wiki=item_controls_before_controls_after -->==controls_before_controls_after==
+
:: The maximum number of items to display on a page.
  
−
  controls_before, controls_after
+
** pagejumps
 +
:: The maximum number of page jump links to display.
  
−
Additional links to display before/after the page navigation controls.
+
** 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 -->
+
: '''Rendering options:'''
−
<!-- Pod2Wiki=item_container -->==container==
 
  
−
A containing XML DOM element for the list of items on the current page.
+
** controls_before, controls_after
 +
:: Additional links to display before/after the page navigation controls.
  
−
<!-- End of Pod2Wiki -->
+
** container
−
<!-- Pod2Wiki=item_render_result_render_result_params -->==render_result_render_result_params==
+
:: A containing XML DOM element for the list of items on the current page.
  
−
  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.
  
−
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:
  
−
<!-- End of Pod2Wiki -->
+
*** controls
−
<!-- Pod2Wiki=item_phrase -->==phrase==
+
::: prev/next/jump links
  
−
The phrase to use to render the entire "page". Can make use of the following pins:
+
*** searchdesc
 +
::: description of list e.g. what search parameters produced it
  
−
<!-- End of Pod2Wiki -->
+
*** matches
−
<!-- Pod2Wiki=item_controls -->==controls==
+
::: total number of items in list, range of items displayed on current page
  
−
prev/next/jump links
+
*** results
 +
::: list of rendered items
  
−
<!-- End of Pod2Wiki -->
+
*** controls_if_matches
−
<!-- Pod2Wiki=item_searchdesc -->==searchdesc==
+
::: prev/next/jump links (only if list contains &gt;0 items)
  
−
description of list e.g. what search parameters produced it
+
:: These can be overridden in the "pins" option (below).
  
−
<!-- End of Pod2Wiki -->
+
** pins
−
<!-- Pod2Wiki=item_matches -->==matches==
+
:: 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).
  
−
total number of items in list, range of items displayed on current page
+
<!-- Pod2Wiki=head_copyright -->
 +
==COPYRIGHT==
 +
: Copyright 2000-2011 University of Southampton.
  
−
<!-- End of Pod2Wiki -->
+
: This file is part of EPrints http://www.eprints.org/.
−
<!-- Pod2Wiki=item_results -->==results==
 
  
−
list of rendered items
+
: 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.
  
−
<!-- End of Pod2Wiki -->
+
: 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.
−
<!-- Pod2Wiki=item_controls_if_matches -->==controls_if_matches==
 
  
−
prev/next/jump links (only if list contains &gt;0 items)
+
: You should have received a copy of the GNU Lesser General Public License along with EPrints.  If not, see http://www.gnu.org/licenses/.
  
−
<!-- End of Pod2Wiki -->
+
<!-- Edit below this comment -->
−
<!-- 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= -->
−
<!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki=_postamble_ -->
 +
<!-- 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

API: Core API

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



Retrieved from ‘https://wiki.eprints.org/w/index.php?title=API:EPrints/Paginate&oldid=10693’