[ Index ]

PHP Cross Reference of Joomla 1.5.26 DE

title

Body

[close]

/libraries/joomla/html/ -> pagination.php (summary)

(no description)

Copyright: Copyright (C) 2005 - 2010 Open Source Matters. All rights reserved.
License: GNU/GPL, see LICENSE.php
Version: $Id: pagination.php 14401 2010-01-26 14:10:00Z louis $
File Size: 550 lines (15 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 2 classes

JPagination:: (15 methods):
  __construct()
  getRowOffset()
  getData()
  getPagesCounter()
  getResultsCounter()
  getPagesLinks()
  getListFooter()
  getLimitBox()
  orderUpIcon()
  orderDownIcon()
  _list_footer()
  _list_render()
  _item_active()
  _item_inactive()
  _buildDataObject()

JPaginationObject:: (1 method):
  __construct()


Class: JPagination  - X-Ref

Pagination Class.  Provides a common interface for content pagination for the
Joomla! Framework

__construct($total, $limitstart, $limit)   X-Ref
Constructor

param: int        The total number of items
param: int        The offset of the item to start at
param: int        The number of items to display per page

getRowOffset($index)   X-Ref
Return the rationalised offset for a row with a given index.

param: int        $index The row index
return: int        Rationalised offset for a row with a given index

getData()   X-Ref
Return the pagination data object, only creating it if it doesn't already exist

return: object    Pagination data object

getPagesCounter()   X-Ref
Create and return the pagination pages counter string, ie. Page 2 of 4

return: string    Pagination pages counter string

getResultsCounter()   X-Ref
Create and return the pagination result set counter string, ie. Results 1-10 of 42

return: string    Pagination result set counter string

getPagesLinks()   X-Ref
Create and return the pagination page list string, ie. Previous, Next, 1 2 3 ... x

return: string    Pagination page list string

getListFooter()   X-Ref
Return the pagination footer

return: string    Pagination footer

getLimitBox()   X-Ref
Creates a dropdown box for selecting how many records to show per page

return: string    The html for the limit # input box

orderUpIcon($i, $condition = true, $task = 'orderup', $alt = 'Move Up', $enabled = true)   X-Ref
Return the icon to move an item UP

param: int        $i The row index
param: boolean    $condition True to show the icon
param: string    $task The task to fire
param: string    $alt The image alternate text string
return: string    Either the icon to move an item up or a space

orderDownIcon($i, $n, $condition = true, $task = 'orderdown', $alt = 'Move Down', $enabled = true)   X-Ref
Return the icon to move an item DOWN

param: int        $i The row index
param: int        $n The number of items in the list
param: boolean    $condition True to show the icon
param: string    $task The task to fire
param: string    $alt The image alternate text string
return: string    Either the icon to move an item down or a space

_list_footer($list)   X-Ref
No description

_list_render($list)   X-Ref
No description

_item_active(&$item)   X-Ref
No description

_item_inactive(&$item)   X-Ref
No description

_buildDataObject()   X-Ref
Create and return the pagination data object

return: object    Pagination data object

Class: JPaginationObject  - X-Ref

Pagination object representing a particular item in the pagination lists

__construct($text, $base=null, $link=null)   X-Ref
No description



Generated: Wed Mar 28 15:54:07 2012 Cross-referenced by PHPXref 0.7.1