Documentation

Form extends AbstractPaginator
in package

Paginator form class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

Copyright (c) 2009-2023 NOLA Interactive, LLC. (http://www.nolainteractive.com)

license

http://www.popphp.org/license New BSD License

version
3.1.0

Table of Contents

$bookends  : array<string|int, mixed>
Page bookends
$currentPage  : int
Current page property
$end  : int
Current page end index property
$form  : string
Page form property
$inputSeparator  : string
Input separator
$numberOfPages  : int
Number of pages property
$perPage  : int
Number of items per page
$queryKey  : string
Query key
$range  : int
Range of pages per page
$start  : int
Current page start index property
$total  : int
Total number of items
__construct()  : mixed
Constructor
__toString()  : string
Output the rendered page links
calculateRange()  : array<string|int, mixed>
Calculate the page range
getBookend()  : string
Get a bookend
getBookends()  : array<string|int, mixed>
Get the bookends
getCurrentPage()  : int
Get the current page
getFormString()  : string
Get the page form string
getInputSeparator()  : string
Get input separator
getNumberOfPages()  : int
Get the number of pages
getPerPage()  : int
Get the per page
getQueryKey()  : int
Get the query key
getRange()  : int
Get the page range
getTotal()  : int
Get the content items total
setBookends()  : AbstractPaginator
Set the bookends
setInputSeparator()  : Form
Set input separator
setQueryKey()  : AbstractPaginator
Set the query key
createForm()  : void
Create links

Properties

$bookends

Page bookends

protected array<string|int, mixed> $bookends = ['start' => '&laquo;', 'previous' => '&lsaquo;', 'next' => '&rsaquo;', 'end' => '&raquo;']

$form

Page form property

protected string $form = null

$inputSeparator

Input separator

protected string $inputSeparator = 'of'

Methods

__construct()

Constructor

public __construct(int $total[, int $perPage = 10 ]) : mixed

Instantiate the paginator object

Parameters
$total : int
$perPage : int = 10
Return values
mixed

__toString()

Output the rendered page links

public __toString() : string
Return values
string

calculateRange()

Calculate the page range

public calculateRange([int $page = 1 ]) : array<string|int, mixed>
Parameters
$page : int = 1
Return values
array<string|int, mixed>

getBookend()

Get a bookend

public getBookend(string $key) : string
Parameters
$key : string
Return values
string

getBookends()

Get the bookends

public getBookends() : array<string|int, mixed>
Return values
array<string|int, mixed>

getCurrentPage()

Get the current page

public getCurrentPage() : int
Return values
int

getFormString()

Get the page form string

public getFormString([int $page = null ]) : string
Parameters
$page : int = null
Return values
string

getInputSeparator()

Get input separator

public getInputSeparator() : string
Return values
string

getNumberOfPages()

Get the number of pages

public getNumberOfPages() : int
Return values
int

getPerPage()

Get the per page

public getPerPage() : int
Return values
int

getQueryKey()

Get the query key

public getQueryKey() : int
Return values
int

getRange()

Get the page range

public getRange() : int
Return values
int

getTotal()

Get the content items total

public getTotal() : int
Return values
int

setInputSeparator()

Set input separator

public setInputSeparator(string $separator) : Form
Parameters
$separator : string
Return values
Form

createForm()

Create links

protected createForm([int $page = 1 ]) : void
Parameters
$page : int = 1
Return values
void

Search results