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)

Detailed Description

Definition at line 24 of file XCube_PageNavigator.class.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$url,
			$flags = XCUBE_PAGENAVI_START )

Constructor.

Parameters

string	$url
int	$flags

Definition at line 123 of file XCube_PageNavigator.class.php.

Member Function Documentation

_renderExtra()

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

protected

Parameters

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

Definition at line 177 of file XCube_PageNavigator.class.php.

addExtra()

addExtra	(		$key,
			$value )

Definition at line 166 of file XCube_PageNavigator.class.php.

fetch()

fetch

(

)

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

Definition at line 141 of file XCube_PageNavigator.class.php.

fetchNaviControl()

fetchNaviControl

(

&

$navi

)

Definition at line 145 of file XCube_PageNavigator.class.php.

freezePerpage()

freezePerpage

(

)

Definition at line 331 of file XCube_PageNavigator.class.php.

getCurrentPage()

getCurrentPage

(

)

Definition at line 355 of file XCube_PageNavigator.class.php.

getNextStart()

getNextStart

(

)

Definition at line 373 of file XCube_PageNavigator.class.php.

getPerpage()

getPerpage

(

)

Definition at line 335 of file XCube_PageNavigator.class.php.

getPerpageKey()

getPerpageKey

(

)

Definition at line 351 of file XCube_PageNavigator.class.php.

getPrefix()

getPrefix

(

)

Definition at line 343 of file XCube_PageNavigator.class.php.

getPrivStart()

getPrivStart

(

)

Definition at line 363 of file XCube_PageNavigator.class.php.

getRenderBaseUrl()

getRenderBaseUrl

(

$mask = null

)

Definition at line 187 of file XCube_PageNavigator.class.php.

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

Definition at line 224 of file XCube_PageNavigator.class.php.

getStart()

getStart

(

)

Definition at line 301 of file XCube_PageNavigator.class.php.

getStartKey()

getStartKey

(

)

Definition at line 347 of file XCube_PageNavigator.class.php.

getTotalItems()

getTotalItems

(

)

Definition at line 310 of file XCube_PageNavigator.class.php.

getTotalPages()

getTotalPages

(

)

Definition at line 319 of file XCube_PageNavigator.class.php.

hasNextPage()

hasNextPage

(

)

Definition at line 369 of file XCube_PageNavigator.class.php.

hasPrivPage()

hasPrivPage

(

)

Definition at line 359 of file XCube_PageNavigator.class.php.

removeExtra()

removeExtra

(

$key

)

Definition at line 170 of file XCube_PageNavigator.class.php.

renderSortUrl()

renderSortUrl

(

$mask = null

)

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

Parameters

null

$mask

Returns

string

Deprecated

Definition at line 293 of file XCube_PageNavigator.class.php.

renderUrlForPage()

renderUrlForPage

(

$page = null

)

Definition at line 260 of file XCube_PageNavigator.class.php.

renderUrlForSort()

renderUrlForSort

(

)

Definition at line 239 of file XCube_PageNavigator.class.php.

setPerpage()

setPerpage

(

$perpage

)

Definition at line 327 of file XCube_PageNavigator.class.php.

setPrefix()

setPrefix

(

$prefix

)

Definition at line 339 of file XCube_PageNavigator.class.php.

setStart()

setStart

(

$start

)

Definition at line 297 of file XCube_PageNavigator.class.php.

setTotalItems()

setTotalItems

(

$total

)

Definition at line 305 of file XCube_PageNavigator.class.php.

XCube_PageNavigator()

XCube_PageNavigator	(		$url,
			$flags = XCUBE_PAGENAVI_START )

Definition at line 133 of file XCube_PageNavigator.class.php.

Field Documentation

$_mIsSpecifedTotalItems

$_mIsSpecifedTotalItems = false

Definition at line 94 of file XCube_PageNavigator.class.php.

$_mIsSpecifiedTotal

$_mIsSpecifiedTotal

Definition at line 107 of file XCube_PageNavigator.class.php.

$mAttributes

$mAttributes = []

Array for extra information.

Definition at line 29 of file XCube_PageNavigator.class.php.

$mExtra

$mExtra = []

Array of string for re-building the query strings.

Definition at line 77 of file XCube_PageNavigator.class.php.

$mFetch

$mFetch

@XCube_Delegate

Definition at line 87 of file XCube_PageNavigator.class.php.

$mFlags

$mFlags = 0

Options indicating what this navigator fetches automatically.

Definition at line 82 of file XCube_PageNavigator.class.php.

$mGetTotalItems

$mGetTotalItems

Definition at line 103 of file XCube_PageNavigator.class.php.

$mPerpage

$mPerpage = XCUBE_PAGENAVI_DEFAULT_PERPAGE

Definition at line 47 of file XCube_PageNavigator.class.php.

$mPerpageFreeze

$mPerpageFreeze = false

Definition at line 54 of file XCube_PageNavigator.class.php.

$mPrefix

$mPrefix

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

Definition at line 72 of file XCube_PageNavigator.class.php.

$mSort

$mSort = []

Array for sort.

Definition at line 60 of file XCube_PageNavigator.class.php.

$mStart

$mStart = 0

Definition at line 35 of file XCube_PageNavigator.class.php.

$mTotal

$mTotal

Definition at line 111 of file XCube_PageNavigator.class.php.

$mTotalItems

$mTotalItems = 0

Definition at line 41 of file XCube_PageNavigator.class.php.

$mUrl

$mUrl = ''

Definition at line 66 of file XCube_PageNavigator.class.php.

---

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

• html/core/XCube_PageNavigator.class.php