Class XCube_PageNavigator
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.
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
protected
|
|
public
|
|
public
string
|
#
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. |
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
public
Array
|
$mAttributes | array() |
#
Array for extra informations. |
public
integer
|
$mStart | 0 |
#
Offset. |
public
integer
|
$mTotalItems | 0 |
#
The max number of items which this navigator handles. |
public
integer
|
$mPerpage | XCUBE_PAGENAVI_DEFAULT_PERPAGE |
#
Per page. |
public
boolean
|
$mPerpageFreeze | false |
#
Flag indicating whether this class receives the perpage value specified by the request. |
public
Array
|
$mSort | array() |
#
Array for sort. |
public
string
|
$mUrl | "" |
#
The base url for this navigator. |
public
|
$mPrefix | null |
#
A prefix for variable names fetched by this navigator. If two independent navigators are used, this property is must. |
public
array
|
$mExtra | array() |
#
Array of string for re-building the query strings. |
public
integer
|
$mFlags | 0 |
#
Options indicating what this navigator fetches automatically. |
public
|
$mFetch | null |
|
public
boolean
|
$_mIsSpecifedTotalItems | false |
#
The value indicating whether the mTotal property already has been specified. |
public
|
$mGetTotalItems | null |
#
This delegate is used in only case which mTotal isn't set yet. |