Class Pagination
Provides helper methods for dealing with HTML content
-
Html
-
Pagination
Methods summary
public
|
#
__construct( array $get = array(), array $format = array() )
Sets default settings
Parameters
- $get
array $get The GET parameters for the current request
- $format
array $format Format settings to overwrite default settings with (optional)
|
public
|
#
setGet( array $get )
Set all GET parameters for this pagination instance
Set all GET parameters for this pagination instance
Parameters
- $get
array $get An array of GET parameters
|
public
|
#
setEol( string $eol )
Sets the end of line character to use
Sets the end of line character to use
Parameters
- $eol
string $eol The end of line character to use
|
public
|
#
setSettings( array $format )
Sets the format settings
Parameters
- $format
array $format The format settings to overwrite
|
public
boolean
|
#
hasPages( )
Returns whether or not pagination should be shown
Returns whether or not pagination should be shown
Returns
boolean True if pagination should be shown, false otherwise
|
public
string
|
#
build( )
Builds the content of the pagination and optionally outputs it.
Builds the content of the pagination and optionally outputs it.
Returns
string The HTML for the pagination, void if output enabled
|
public
string
|
#
getPageUri( integer $page )
Create the URI for the current page number, replacing any labels as
needed.
Create the URI for the current page number, replacing any labels as
needed.
Parameters
- $page
integer $page The page number
Returns
string The completed URI
|
public
|
#
setOutput( boolean $return )
Set whether to return $output generated by these methods, or to echo it out
instead
Set whether to return $output generated by these methods, or to echo it out
instead
Parameters
- $return
boolean $return True to return output from these form methods, false to echo results
instead
|
Methods inherited from Html
_()
,
addCondition()
,
buildAttributes()
,
concat()
,
hyperlink()
,
ifSet()
,
isUtf8()
,
safe()
Magic methods summary
Properties summary
Properties inherited from Html
$xhtml