PHP Class MorePagerModule, vanilla

Inheritance: extends Gdn_Module
Show file Open project: vanilla/vanilla

Public Properties

Property Type Description
$ClientID The id applied to the div tag that contains the pager.
$CssClass The name of the stylesheet class to be applied to the pager. Default is 'Pager'.
$LessCode Translation code to be used for "less" link.
$Limit number of records being displayed on a single page of data. Default is 30.
$MoreCode Translation code to be used for "more" link.
$Offset The first record of the current page (the dataset offset).
$PagerEmpty If there are no pages to page through, this string will be returned in place of the pager. Default is an empty string.
$TotalRecords total number of records in the dataset.
$Url The string to contain the record offset. ie. /controller/action/%s/
$Wrapper The xhtml code that should wrap around the pager link. ie. '
%2$s
'; where %1$s represents id and class attributes (if defined by $this->ClientID and $this->CssClass) and %2$s represents the pager link.

Public Methods

Method Description
__construct ( string $Sender = '' )
assetTarget ( ) : boolean
configure ( $Offset, $Limit, $TotalRecords, $Url, $ForceConfigure = false ) Define all required parameters to create the Pager and PagerDetails.
details ( string $formatString = '' ) : string Builds a string with information about the page list's current position (ie. "1 to 15 of 56").
firstPage ( ) : boolean Whether or not this is the first page of the pager.
formatUrl ( $Url, $Offset, string $Limit = '' ) : mixed | string
hasMorePages ( ) Are there more pages after the current one?
lastPage ( ) : boolean Whether or not this is the last page of the pager.
toString ( $Type = 'more' ) Returns the "show x more (or less) items" link.

Method Details

__construct() public method

public __construct ( string $Sender = '' )
$Sender string

assetTarget() public method

public assetTarget ( ) : boolean
return boolean

configure() public method

Define all required parameters to create the Pager and PagerDetails.
public configure ( $Offset, $Limit, $TotalRecords, $Url, $ForceConfigure = false )

details() public method

Builds a string with information about the page list's current position (ie. "1 to 15 of 56").
public details ( string $formatString = '' ) : string
$formatString string Not used.
return string Built string.

firstPage() public method

Whether or not this is the first page of the pager.
public firstPage ( ) : boolean
return boolean True if this is the first page.

formatUrl() public static method

public static formatUrl ( $Url, $Offset, string $Limit = '' ) : mixed | string
$Url
$Offset
$Limit string
return mixed | string

hasMorePages() public method

Are there more pages after the current one?
public hasMorePages ( )

lastPage() public method

Whether or not this is the last page of the pager.
public lastPage ( ) : boolean
return boolean True if this is the last page.

toString() public method

Returns the "show x more (or less) items" link.
public toString ( $Type = 'more' )

Property Details

$ClientID public property

The id applied to the div tag that contains the pager.
public $ClientID

$CssClass public property

The name of the stylesheet class to be applied to the pager. Default is 'Pager'.
public $CssClass

$LessCode public property

Translation code to be used for "less" link.
public $LessCode

$Limit public property

number of records being displayed on a single page of data. Default is 30.
public $Limit

$MoreCode public property

Translation code to be used for "more" link.
public $MoreCode

$Offset public property

The first record of the current page (the dataset offset).
public $Offset

$PagerEmpty public property

If there are no pages to page through, this string will be returned in place of the pager. Default is an empty string.
public $PagerEmpty

$TotalRecords public property

total number of records in the dataset.
public $TotalRecords

$Url public property

The string to contain the record offset. ie. /controller/action/%s/
public $Url

$Wrapper public property

The xhtml code that should wrap around the pager link. ie. '
%2$s
'; where %1$s represents id and class attributes (if defined by $this->ClientID and $this->CssClass) and %2$s represents the pager link.
public $Wrapper