documentation/manual/en/module_specs/Zend_Paginator-Configuration.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect1 id="zend.paginator.configuration">
   4     <title>Configuration</title>
   5
   6     <para>
   7         <classname>Zend_Paginator</classname> has several configuration methods that can
   8         be called:
   9     </para>
  10
  11     <table id="zend.paginator.configuration.table">
  12         <title>Configuration methods for Zend_Paginator</title>
  13
  14         <tgroup cols="2">
  15             <thead>
  16                 <row>
  17                     <entry>Method</entry>
  18                     <entry>Description</entry>
  19                 </row>
  20             </thead>
  21
  22             <tbody>
  23                 <row>
  24                     <entry>setCurrentPageNumber</entry>
  25                     <entry>Sets the current page number (default 1).</entry>
  26                 </row>
  27
  28                 <row>
  29                     <entry>setItemCountPerPage</entry>
  30
  31                     <entry>
  32                         Sets the maximum number of items to display on a page (default 10).
  33                     </entry>
  34                 </row>
  35
  36                 <row>
  37                     <entry>setPageRange</entry>
  38
  39                     <entry>
  40                         Sets the number of items to display in the pagination
  41                         control (default 10). Note: Most of the time this
  42                         number will be adhered to exactly, but scrolling styles
  43                         do have the option of only using it as a guideline or
  44                         starting value (e.g., Elastic).
  45                     </entry>
  46                 </row>
  47
  48                 <row>
  49                     <entry>setView</entry>
  50                     <entry>Sets the view instance, for rendering convenience.</entry>
  51                 </row>
  52             </tbody>
  53         </tgroup>
  54     </table>
  55 </sect1>
  56 <!--
  57 vim:se ts=4 sw=4 et:
  58 -->