Class: mosPageNav

Source Location: /plugins/system/legacy/pagination.php

Class mosPageNav

Class Overview

Legacy class, derive from JPagination instead

Located in /plugins/system/legacy/pagination.php [line 27]

JObject
   |
   --JPagination
      |
      --mosPageNav

Author(s):

API Tags:

Deprecated:

As of version 1.5

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From JPagination

JPagination::$limit

JPagination::$limitstart

JPagination::$total

JPagination::$_viewall

Inherited From JObject

JObject::$_errors

Inherited From JPagination

JPagination::__construct()

Constructor

JPagination::getData()

Return the pagination data object, only creating it if it doesn't already exist

JPagination::getLimitBox()

Creates a dropdown box for selecting how many records to show per page

JPagination::getListFooter()

Return the pagination footer

JPagination::getPagesCounter()

Create and return the pagination pages counter string, ie. Page 2 of 4

JPagination::getPagesLinks()

Create and return the pagination page list string, ie. Previous, Next, 1 2 3 ... x

JPagination::getResultsCounter()

Create and return the pagination result set counter string, ie. Results 1-10 of 42

JPagination::getRowOffset()

Return the rationalised offset for a row with a given index.

JPagination::orderDownIcon()

Return the icon to move an item DOWN

JPagination::orderUpIcon()

Return the icon to move an item UP

JPagination::_buildDataObject()

Create and return the pagination data object

JPagination::_item_active()

JPagination::_item_inactive()

JPagination::_list_footer()

JPagination::_list_render()

Inherited From JObject

JObject::JObject()

A hack to support __construct() on PHP 4

JObject::__construct()

Class constructor, overridden in descendant classes.

JObject::get()

Returns a property of the object or the default value if the property is not set.

JObject::getError()

Get the most recent error message

JObject::getErrors()

Return all errors, if any

JObject::getProperties()

Returns an associative array of object properties

JObject::getPublicProperties()

Legacy Method, use JObject::getProperties() instead

JObject::set()

Modifies a property of the object, creating it if it does not already exist.

JObject::setError()

Add an error message

JObject::setProperties()

Set the object properties based on a named array/hash

JObject::toString()

Object-to-string conversion.

[ Top ]

Method Summary

mosPageNav	mosPageNav()
void	orderDownIcon2()	Return the icon to move an item DOWN
void	orderUpIcon2()	Return the icon to move an item UP
void	rowNumber()	Returns the pagination offset at an index Use: $pagination->getRowOffset($index); instead
void	writeLeafsCounter()	Writes the html for the leafs counter, eg, Page 1 of x Use: print $pagination->getPagesCounter();
void	writeLimitBox()	Writes the dropdown select list for number of rows to show per page Use: print $pagination->getLimitBox();
void	writePagesCounter()	Writes the counter string Use: print $pagination->getLimitBox();
void	writePagesLinks()	Writes the page list string Use: print $pagination->getPagesLinks();

[ Top ]

Properties

Methods

Constructor mosPageNav [line 29]

mosPageNav mosPageNav(

$total, 
$limitstart, 
$limit 
)

Parameters:

	$total:
	$limitstart:
	$limit:

[ Top ]

orderDownIcon2 [line 115]

void orderDownIcon2(

$id, 
$order, [
$condition = true], [
$task = 'orderdown'], [
$alt = '#'] 
)

Return the icon to move an item DOWN

Parameters:

	$id:
	$order:
	$condition:
	$task:
	$alt:

API Tags:

Deprecated:

as of 1.5

[ Top ]

orderUpIcon2 [line 88]

void orderUpIcon2(

$id, 
$order, [
$condition = true], [
$task = 'orderup'], [
$alt = '#'] 
)

Return the icon to move an item UP

Parameters:

	$id:
	$order:
	$condition:
	$task:
	$alt:

API Tags:

Deprecated:

as of 1.5

[ Top ]

rowNumber [line 79]

void rowNumber(

$index 
)

Returns the pagination offset at an index Use: $pagination->getRowOffset($index); instead

Parameters:

$index:

API Tags:

Deprecated:

as of 1.5

[ Top ]

writeLeafsCounter [line 69]

void writeLeafsCounter(
)

Writes the html for the leafs counter, eg, Page 1 of x Use: print $pagination->getPagesCounter();

API Tags:

Deprecated:

as of 1.5

[ Top ]

writeLimitBox [line 39]

void writeLimitBox(
[
$link = null] 
)

Writes the dropdown select list for number of rows to show per page Use: print $pagination->getLimitBox();

Parameters:

$link:

API Tags:

Deprecated:

as of 1.5

[ Top ]

writePagesCounter [line 49]

void writePagesCounter(
)

Writes the counter string Use: print $pagination->getLimitBox();

API Tags:

Deprecated:

as of 1.5

[ Top ]

writePagesLinks [line 59]

void writePagesLinks(
[
$link = null] 
)

Writes the page list string Use: print $pagination->getPagesLinks();

Parameters:

$link:

API Tags:

Deprecated:

as of 1.5

[ Top ]

The site fititnt.org is not affiliated with or endorsed by the Joomla! Project or Open Source Matters. If you are looking for official documentation, visit api.joomla.org and docs.joomla.org.

Documentation generated on Mon, 26 Oct 2009 22:14:17 -0200 by phpDocumentor 1.4.3

Visit fititnt.org, and look for some extension or more Joomla Framework info	Joomla-Legacy 1-5

[ class tree: Joomla-Legacy ] [ index: Joomla-Legacy ] [ all elements ]