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

Class: Pager_HtmlWidgets

Source Location: /Pager-2.4.8/HtmlWidgets.php

Class Overview


Pager_HtmlWidgets


Author(s):

Copyright:

  • 2003-2007 Lorenzo Alberton

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 49]
Pager_HtmlWidgets


[ Top ]


Class Variables

$pager =  null

[line 51]


Type:   mixed


[ Top ]



Method Detail

Pager_HtmlWidgets (Constructor)   [line 60]

Pager_HtmlWidgets Pager_HtmlWidgets( object &$pager)

Constructor

Parameters:

object   &$pager     Pager instance

[ Top ]

getPageSelectBox   [line 221]

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
  • Return: xhtml select box
  • Access: public

Parameters:

array   $params     
    • 'autoSubmit': if TRUE, add some js code to submit the form on the onChange event
    string   $extraAttributes     (html attributes) Tag attributes or HTML attributes (id="foo" pairs), will be inserted in the <select> tag

    [ Top ]

    getPerPageSelectBox   [line 93]

    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.

    • Return: xhtml select box
    • Access: public

    Parameters:

    integer   $start     starting value for the select menu
    integer   $end     ending value for the select menu
    integer   $step     step between values in the select menu
    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
    • 'checkMaxLimit': if true, Pager checks if $end is bigger than $totalItems, and doesn't show the extra select options
    • 'autoSubmit': if TRUE, add some js code to submit the form on the onChange event

    [ Top ]


    Documentation generated on Tue, 21 Apr 2009 23:00:06 +0000 by phpDocumentor 1.4.2. PEAR Logo Copyright © PHP Group 2004.