PHP Class PagerModule, vanilla

Inheritance: extends Module
Exibir arquivo Open project: vanilla/vanilla Class Usage Examples

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'.
$CurrentRecords The number of records in the current page.
$DefaultPageSize The default number of records per page.
$LessCode Translation code to be used for "less" link.
$Limit The number of records being displayed on a single page of data. Default is 30.
$MoreCode Translation code to be used for "Next Page" 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 The total number of records in the dataset.
$Url The string to contain the record offset. ie. /controller/action/%s/
$UrlCallBack string
$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.

Protected Properties

Property Type Description
$_CurrentPager PagerModule
$_Totalled A boolean value indicating if the total number of records is known or not. Retrieving this number can be a costly database query, so sometimes it is not retrieved and simple "next/previous" links are displayed instead. Default is FALSE, meaning that the simple pager is displayed.

Public Methods

Method Description
__construct ( string $Sender = '' )
assetTarget ( ) : boolean
configure ( $Offset, $Limit, $TotalRecords, $Url, boolean $ForceConfigure = false ) Define all required parameters to create the Pager and PagerDetails.
controller ( ) : Gdn_Controller. Gets the controller this pager is for.
current ( null $Value = null ) : null | PagerModule
details ( string $FormatString = '' ) : boolean | 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, $Page, 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.
pageUrl ( $Page ) : mixed | string
rel ( $Page, $CurrentPage ) : null | string
toString ( string $Type = 'more' ) : string Builds page navigation links.
toStringPrevNext ( string $Type = 'more' ) : string
write ( array $Options = [] )

Private Methods

Method Description
_GetCssClass ( $ThisPage, $HighlightPage ) : string

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, boolean $ForceConfigure = false )
$Offset
$Limit
$TotalRecords
$Url
$ForceConfigure boolean

controller() public method

Gets the controller this pager is for.
public controller ( ) : Gdn_Controller.
return Gdn_Controller.

current() public static method

public static current ( null $Value = null ) : null | PagerModule
$Value null
return null | PagerModule

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 = '' ) : boolean | string
$FormatString string
return boolean | 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, $Page, string $Limit = '' ) : mixed | string
$Url
$Page
$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.

pageUrl() public method

public pageUrl ( $Page ) : mixed | string
$Page
return mixed | string

rel() public static method

public static rel ( $Page, $CurrentPage ) : null | string
$Page
$CurrentPage
return null | string

toString() public method

Builds page navigation links.
public toString ( string $Type = 'more' ) : string
$Type string Type of link to return: 'more' or 'less'.
return string HTML page navigation links.

toStringPrevNext() public method

public toStringPrevNext ( string $Type = 'more' ) : string
$Type string
return string

write() public static method

public static write ( array $Options = [] )
$Options array

Property Details

$ClientID public_oe property

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

$CssClass public_oe property

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

$CurrentRecords public_oe property

The number of records in the current page.
public $CurrentRecords

$DefaultPageSize public_oe static_oe property

The default number of records per page.
public static $DefaultPageSize

$LessCode public_oe property

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

$Limit public_oe property

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

$MoreCode public_oe property

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

$Offset public_oe property

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

$PagerEmpty public_oe 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_oe property

The total number of records in the dataset.
public $TotalRecords

$Url public_oe property

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

$UrlCallBack public_oe property

public string $UrlCallBack
return string

$Wrapper public_oe 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

$_CurrentPager protected_oe static_oe property

protected static PagerModule $_CurrentPager
return PagerModule

$_Totalled protected_oe property

A boolean value indicating if the total number of records is known or not. Retrieving this number can be a costly database query, so sometimes it is not retrieved and simple "next/previous" links are displayed instead. Default is FALSE, meaning that the simple pager is displayed.
protected $_Totalled