Pager
[ class tree: Pager ] [ index: Pager ] [ all elements ]

Class: Pager_HtmlWidgets

Source Location: /main/inc/lib/pear/Pager/HtmlWidgets.php

Class Overview


Two constants used to guess the path- and file-name of the page


Variables

Methods



Class Details

[line 43]
Two constants used to guess the path- and file-name of the page

when the user doesn't set any other value




[ Top ]


Class Variables

$pager =  null

[line 45]


Type:   mixed


[ Top ]



Class Methods


constructor Pager_HtmlWidgets [line 49]

Pager_HtmlWidgets Pager_HtmlWidgets( &$pager)



Parameters:

   &$pager  

[ Top ]

method getPageSelectBox [line 155]

string getPageSelectBox( [array $params = array()], [string $extraAttributes = ''])

Returns a string with a XHTML SELECT menu with the page numbers, useful as an alternative to the links



Tags:

return:  xhtml select box
access:  public


Parameters:

string   $extraAttributes   (html attributes) Tag attributes or HTML attributes (id="foo" pairs), will be inserted in the <select> tag
array   $params   - 'optionText': text to show in each option. Use '%d' where you want to see the number of pages selected.
  • 'autoSubmit': if TRUE, add some js code to submit the form on the onChange event

[ Top ]

method getPerPageSelectBox [line 77]

string getPerPageSelectBox( [integer $start = 5], [integer $end = 30], [integer $step = 5], [boolean $showAllData = false], [array $extraParams = array()])

Returns a string with a XHTML SELECT menu,

useful for letting the user choose how many items per page should be displayed. If parameter useSessions is TRUE, this value is stored in a session var. The string isn't echoed right now so you can use it with template engines.




Tags:

return:  xhtml select box
access:  public


Parameters:

integer   $start  
integer   $end  
integer   $step  
boolean   $showAllData   If true, perPage is set equal to totalItems.
array   $extraParams   (or string $optionText for BC reasons)
  • 'optionText': text to show in each option. Use '%d' where you want to see the number of pages selected.
  • 'attributes': (html attributes) Tag attributes or HTML attributes (id="foo" pairs), will be inserted in the <select> tag

[ Top ]


Documentation generated on Thu, 12 Jun 2008 13:39:55 -0500 by phpDocumentor 1.4.1