XCube_PageNavigator Class Reference

Public Member Functions
	__construct ( $url, $flags=XCUBE_PAGENAVI_START)
	XCube_PageNavigator ( $url, $flags=XCUBE_PAGENAVI_START)
	fetch ()
	fetchNaviControl (&$navi)
	addExtra ( $key, $value)
	removeExtra ( $key)
	getRenderBaseUrl ( $mask=null)
	getRenderUrl ( $mask=null)
	renderUrlForSort ()
	renderUrlForPage ( $page=null)
	renderSortUrl ( $mask=null)
	setStart ( $start)
	getStart ()
	setTotalItems ( $total)
	getTotalItems ()
	getTotalPages ()
	setPerpage ( $perpage)
	freezePerpage ()
	getPerpage ()
	setPrefix ( $prefix)
	getPrefix ()
	getStartKey ()
	getPerpageKey ()
	getCurrentPage ()
	hasPrivPage ()
	getPrivStart ()
	hasNextPage ()
	getNextStart ()

Data Fields
	$mAttributes = []
	$mStart = 0
	$mTotalItems = 0
	$mPerpage = XCUBE_PAGENAVI_DEFAULT_PERPAGE
	$mPerpageFreeze = false
	$mSort = []
	$mUrl = ''
	$mPrefix
	$mExtra = []
	$mFlags = 0
	$mFetch
	$_mIsSpecifedTotalItems = false
	$mGetTotalItems
	$_mIsSpecifiedTotal
	$mTotal

Protected Member Functions
	_renderExtra ($key, $extra, &$query)

Constructor & Destructor Documentation

__construct()

__construct	(		$url,
			$flags = XCUBE_PAGENAVI_START )

Constructor.

Parameters

string	$url
int	$flags

Member Function Documentation

_renderExtra()

_renderExtra ( $key, $extra, & $query )

protected

Parameters

$key	* string **
$extra	* mixed **
$query	* string[] **

fetch()

fetch

(

)

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

getRenderUrl()

getRenderUrl

(

$mask = null

)

Returns url string for navigation. The return value has lost the starting value. The user need to add a start value. For example, It is "$navi->getRenderUrl().'20'". NOTE : This method name is bad. This must be renamed!

Returns

string

renderSortUrl()

renderSortUrl

(

$mask = null

)

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

Parameters

null

$mask

Returns

string

Deprecated

Field Documentation

$mAttributes

$mAttributes = []

Array for extra information.

$mExtra

$mExtra = []

Array of string for re-building the query strings.

$mFetch

$mFetch

@XCube_Delegate

$mFlags

$mFlags = 0

Options indicating what this navigator fetches automatically.

$mPrefix

$mPrefix

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

$mSort

$mSort = []

Array for sort.

---

The documentation for this class was generated from the following file:

• C:/Ampps/www/legacy250/html/core/XCube_PageNavigator.class.php