• Главная
• Pop
• Paginator
• Paginator

PHP Класс Pop\Paginator\Paginator

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$bookendKey	integer	Page bookend key
$bookends	array	Page bookends
$classOff	string	Class 'off' name for page link tags
$classOn	string	Class 'on' name for page link tags
$dateFormat	string	Date format for handle date strings
$end	integer	Current page end index property
$footer	string	Footer template
$header	string	Header template
$items	array	Content items
$links	array	Page links property
$numPages	integer	Number of pages property
$output	string	Page ouput
$perPage	integer	Items per page property
$range	integer	Page range property
$rem	integer	Remainder property
$rowTemplate	string	Row template
$separator	string	Bookend separator
$start	integer	Current page start index property
$total	integer	Total item count property

Открытые методы

Метод	Описание
__construct ( array $items, integer $perPage = 10, integer $range = 10, integer $total = null ) : Paginator	Constructor
__toString ( ) : string	Output the rendered page
factory ( array $items, integer $perPage = 10, integer $range = 10, integer $total = null ) : Paginator	Static method to instantiate the paginator object and return itself to facilitate chaining methods together.
getClassOff ( ) : string	Method to get the class 'off' name.
getClassOn ( ) : string	Method to get the class 'on' name.
getDateFormat ( ) : string	Method to get the date format.
getFooter ( ) : string	Method to get the footer template.
getHeader ( ) : string	Method to get the header template.
getItemCount ( ) : integer	Method to get the number of content items.
getItems ( ) : array	Method to get the content items.
getLinks ( integer $pg = null ) : string	Method to get the page links.
getPerPage ( ) : integer	Method to get the page range.
getRange ( ) : integer	Method to get the page range.
getRowTemplate ( ) : string	Method to get the row template.
getSeparator ( ) : string	Method to get the bookend separator.
getTotal ( ) : integer	Method to get the content items total
render ( integer | string $pg, boolean $ret = false ) : mixed	Method to render the current page.
setBookend ( integer $key = Paginator::SINGLE_ARROWS ) : Paginator	Method to set the bookend key.
setClassOff ( string $cls ) : Paginator	Method to set the class 'off' name.
setClassOn ( string $cls ) : Paginator	Method to set the class 'on' name.
setDateFormat ( string $date = null ) : Paginator	Method to set the date format.
setFooter ( string $ftr ) : Paginator	Method to set the footer template.
setHeader ( string $hdr ) : Paginator	Method to set the header template.
setItems ( array $items ) : Paginator	Method to set the content items.
setPerPage ( integer $perPage = 10 ) : Paginator	Method to set the page range.
setRange ( integer $range = 10 ) : Paginator	Method to set the page range.
setRowTemplate ( string $tmpl ) : Paginator	Method to set the row template.
setSeparator ( string $sep = ' | ' ) : Paginator	Method to set the bookend separator.
setTotal ( integer $total = null ) : Paginator	Method to set the content items total

Защищенные методы

Метод	Описание
calcItems ( integer | string $p ) : void	Method to calculate the page items.
calcRange ( integer | string $pg ) : array	Method to calculate the page range.
createLinks ( integer $pg = null ) : void	Method to create links.

Описание методов

Описание свойств