Documentation

Menu

## PaginationOptions
in package

PaginationOptions.php : 7

### 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

PaginationOptions.php : 18
`public string $activeClass = 'active'`

The CSS class for the active page.

#### $disabledClass

PaginationOptions.php : 23
`public string $disabledClass = 'disabled'`

The CSS class for the disabled page.

#### $firstMarkup

PaginationOptions.php : 33
`public string $firstMarkup = '<i class="fas fa-angle-double-left"></i>'`

The markup for the "First" button.

#### $lastMarkup

PaginationOptions.php : 48
`public string $lastMarkup = '<i class="fas fa-angle-double-right"></i>'`

The markup for the "Last" button.

#### $navLength

PaginationOptions.php : 53
`public int $navLength = 2`

The number of pages to display in the navigation.

#### $nextMarkup

PaginationOptions.php : 43
`public string $nextMarkup = '<i class="fas fa-angle-right"></i>'`

The markup for the "Next" button.

#### $paginationClass

PaginationOptions.php : 28
`public string $paginationClass = 'pagination pagination-flat'`

The CSS class for the pagination container.

#### $previousMarkup

PaginationOptions.php : 38
`public string $previousMarkup = '<i class="fas fa-angle-left"></i>'`

The markup for the "Previous" button.

#### $querystring

PaginationOptions.php : 59
`public string $querystring = 'p'`

The query string to append to the pagination links. E.g.: 'p' for page.

#### $rewriteExtension

PaginationOptions.php : 74
`public string $rewriteExtension = ''`

The file extension used for rewriting the pagination links.

#### $rewriteLinks

PaginationOptions.php : 64
`public bool $rewriteLinks = false`

Indicates whether to rewrite the pagination links.

#### $rewriteTransition

PaginationOptions.php : 69
`public string $rewriteTransition = '&'`

The transition string used for rewriting the pagination links.

### Methods

#### __construct()

PaginationOptions.php : 81

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()

PaginationOptions.php : 91

Set the pagination options.

`public set(array<string, bool|string> $options) : void`

##### Parameters

$options : array<string, bool|string>

  The pagination options.

## Search results