GridPager Class Reference

Provides paginator calculations and rendering of the grid pager. More...

Inheritance diagram for GridPager:

Public Member Functions
	__construct ($length, $baseUrl)
	Create pager. More...
	setPage ($page)
	Set active (selected) page. More...
	setLength ($length)
	Set total number of rows. More...
	setPageLen ($pageLen)
	Set number of rows of the page. More...
	getValue ($id)
	Return value of the pager item. More...
	getUrl ($page)
	Return pager url for the $page. More...
	getHtml ($id, $cssClass='page-item', $pattern=null)
	Return HTML for the pager link or other item. More...
	html ()
	Return pager html. More...
Public Member Functions inherited from BaseObject
	loadDefaults ($className=null)
	Load default parameters of class $className into object instance.
	setProperties (array $defaults)
	Set public properties of object from the array. More...
	toArray ()
	Convert object to array. More...

Data Fields
	$linkNumber = 10
	Number of page-links shown in pager.
	$baseUrl = '/?'
	Base url for pager links.
	$pattern = '%s | %s | %s'
	Pattern for rendering. More...
	$patternItem = '<span class="%s">%s</span>'
	Pattern for rendering of the pager item.
	$translator
	var Translator
Data Fields inherited from BaseObject
	$serviceLocator
	var function() Return service object when requested with service().

Protected Member Functions
	clamp ($num, $min, $max)
	Shift $num value into interval <$min, $max>. More...
	getPagesHtml ()
	Return links to all pages. More...
	pagerRange ($page, $size)
	Return array of page numbers arround active page. More...
Protected Member Functions inherited from BaseObject
	service ($service, $default=null)
	Try acquire $service and load it into property $this->$service. More...

Additional Inherited Members
Static Public Member Functions inherited from BaseObject
static	defaults (... $args)
	Set or retireve default parameters of the object. More...

Detailed Description

Provides paginator calculations and rendering of the grid pager.

Constructor & Destructor Documentation

__construct()

__construct	(		$length,
			$baseUrl
	)

Create pager.

Parameters

int	$length	Total number of rows.
string	$baseUrl

Member Function Documentation

clamp()

clamp (   $num,   $min,   $max  )

protected

Shift $num value into interval <$min, $max>.

Returns

int $num Value in specified interval.

getHtml()

getHtml	(		$id,
			$cssClass = 'page-item',
			$pattern = null
	)

Return HTML for the pager link or other item.

Parameters

string	$id	Id of pager item
string	$cssClass

Returns

string $html

getPagesHtml()

getPagesHtml ( )

protected

Return links to all pages.

Returns

string $html

getUrl()

getUrl

(

$page

)

Return pager url for the $page.

Parameters

int

$page

Returns

string $url

getValue()

getValue

(

$id

)

Return value of the pager item.

Parameters

string

$id

Id of pager item

html()

html

(

)

Return pager html.

Returns

string $html

pagerRange()

pagerRange (   $page,   $size  )

protected

Return array of page numbers arround active page.

Parameters

int	$page	Active page
int	$size	Size of returned array

Returns

array Page numbers

setLength()

setLength

(

$length

)

Set total number of rows.

Parameters

int

$length

setPage()

setPage

(

$page

)

Set active (selected) page.

Parameters

int

$page

setPageLen()

setPageLen

(

$pageLen

)

Set number of rows of the page.

Parameters

int

$pageLen

Field Documentation

$pattern

$pattern = '%s | %s | %s'

Pattern for rendering.

"first | last | pages" by default.

---

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

• GridPager.php