PaginationOptions
in package
Table of Contents
Properties
- $activeClass : string
- $disabledClass : string
- $firstMarkup : string
- $lastMarkup : string
- $navLength : int
- $nextMarkup : string
- $paginationClass : string
- $previousMarkup : string
- $querystring : string
- $rewriteExtension : string
- $rewriteLinks : bool
- $rewriteTransition : string
Methods
- __construct() : mixed
- Constructor for the PaginationOptions class.
- set() : void
- Set the pagination options.
Properties
$activeClass
public
string
$activeClass
= 'active'
The CSS class for the active page.
$disabledClass
public
string
$disabledClass
= 'disabled'
The CSS class for the disabled page.
$firstMarkup
public
string
$firstMarkup
= '<i class="fas fa-angle-double-left"></i>'
The markup for the "First" button.
$lastMarkup
public
string
$lastMarkup
= '<i class="fas fa-angle-double-right"></i>'
The markup for the "Last" button.
$navLength
public
int
$navLength
= 2
The number of pages to display in the navigation.
$nextMarkup
public
string
$nextMarkup
= '<i class="fas fa-angle-right"></i>'
The markup for the "Next" button.
$paginationClass
public
string
$paginationClass
= 'pagination pagination-flat'
The CSS class for the pagination container.
$previousMarkup
public
string
$previousMarkup
= '<i class="fas fa-angle-left"></i>'
The markup for the "Previous" button.
$querystring
public
string
$querystring
= 'p'
The query string to append to the pagination links. E.g.: 'p' for page.
$rewriteExtension
public
string
$rewriteExtension
= ''
The file extension used for rewriting the pagination links.
$rewriteLinks
public
bool
$rewriteLinks
= false
Indicates whether to rewrite the pagination links.
$rewriteTransition
public
string
$rewriteTransition
= '&'
The transition string used for rewriting the pagination links.
Methods
__construct()
Constructor for the PaginationOptions class.
public
__construct([array<string, bool|string> $options = [] ]) : mixed
Parameters
- $options : array<string, bool|string> = []
-
An array of options to initialize the PaginationOptions object.
set()
Set the pagination options.
public
set(array<string, bool|string> $options) : void
Parameters
- $options : array<string, bool|string>
-
The pagination options.