XCube_PageNavigator Class Reference

List of all members.

Public Member Functions

 XCube_PageNavigator ($url, $flags=XCUBE_PAGENAVI_START)
 fetch ()
 getRenderUrl ($mask=null)
 renderSortUrl ($mask=null)

Public Attributes

 $mPrefix = null
 $mExtra = array()
 $mFlags = 0
 $mFetch = null

Detailed Description

This is a utility class which acquires page navigation informations --- sort, offset and limit --- semiautomatically. And, the base modules may offer place holders which is able to connect with interfaces of this class.


Member Function Documentation

XCube_PageNavigator::XCube_PageNavigator ( url,
flags = XCUBE_PAGENAVI_START 
)

Constructor.

Parameters:
string $url
int $total
int flag

XCube_PageNavigator::fetch (  ) 

Gets values which this navigator handles, from the request. And, sets values to this object's properties.

XCube_PageNavigator::getRenderUrl ( mask = null  ) 

Return url string for navigation. The return value is lose start value. The user need to add start value. For example, It is "$navi->getRenderUrl().'20'". This method name is bad. I must rename this.

Returns:
string

XCube_PageNavigator::renderSortUrl ( mask = null  ) 

Return url string for sort. The return value is complete style.

Deprecated:


Member Data Documentation

XCube_PageNavigator::$mPrefix = null

A prefix for variable names fetched by this navigator. If two independent navigators are used, this property is must.

XCube_PageNavigator::$mExtra = array()

Array of string for re-building the query strings.

XCube_PageNavigator::$mFlags = 0

Options indicating what this navigator fetches automatically.

XCube_PageNavigator::$mFetch = null


The documentation for this class was generated from the following file:
Generated on Thu Nov 2 00:27:23 2006 for XOOPS Cube Legacy by  doxygen 1.5.1