Documentation

UrlWindow
in package

Table of Contents

$paginator  : LengthAwarePaginator
The paginator implementation.
__construct()  : void
Create a new URL window instance.
get()  : array<string|int, mixed>
Get the window of URLs to be shown.
getAdjacentUrlRange()  : array<string|int, mixed>
Get the page range for the current page window.
getFinish()  : array<string|int, mixed>
Get the ending URLs of a pagination slider.
getStart()  : array<string|int, mixed>
Get the starting URLs of a pagination slider.
hasPages()  : bool
Determine if the underlying paginator being presented has pages to show.
make()  : array<string|int, mixed>
Create a new URL window instance.
currentPage()  : int
Get the current page from the paginator.
getFullSlider()  : array<string|int, mixed>
Get the slider of URLs when a full slider can be made.
getSliderTooCloseToBeginning()  : array<string|int, mixed>
Get the slider of URLs when too close to beginning of window.
getSliderTooCloseToEnding()  : array<string|int, mixed>
Get the slider of URLs when too close to ending of window.
getSmallSlider()  : array<string|int, mixed>
Get the slider of URLs there are not enough pages to slide.
getUrlSlider()  : array<string|int, mixed>
Create a URL slider links.
lastPage()  : int
Get the last page from the paginator.

Properties

Methods

get()

Get the window of URLs to be shown.

public get([int $onEachSide = 3 ]) : array<string|int, mixed>
Parameters
$onEachSide : int = 3
Return values
array<string|int, mixed>

getAdjacentUrlRange()

Get the page range for the current page window.

public getAdjacentUrlRange(int $onEachSide) : array<string|int, mixed>
Parameters
$onEachSide : int
Return values
array<string|int, mixed>

getFinish()

Get the ending URLs of a pagination slider.

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

getStart()

Get the starting URLs of a pagination slider.

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

hasPages()

Determine if the underlying paginator being presented has pages to show.

public hasPages() : bool
Return values
bool

make()

Create a new URL window instance.

public static make(LengthAwarePaginator $paginator[, int $onEachSide = 3 ]) : array<string|int, mixed>
Parameters
$paginator : LengthAwarePaginator
$onEachSide : int = 3
Return values
array<string|int, mixed>

currentPage()

Get the current page from the paginator.

protected currentPage() : int
Return values
int

getFullSlider()

Get the slider of URLs when a full slider can be made.

protected getFullSlider(int $onEachSide) : array<string|int, mixed>
Parameters
$onEachSide : int
Return values
array<string|int, mixed>

getSliderTooCloseToBeginning()

Get the slider of URLs when too close to beginning of window.

protected getSliderTooCloseToBeginning(int $window) : array<string|int, mixed>
Parameters
$window : int
Return values
array<string|int, mixed>

getSliderTooCloseToEnding()

Get the slider of URLs when too close to ending of window.

protected getSliderTooCloseToEnding(int $window) : array<string|int, mixed>
Parameters
$window : int
Return values
array<string|int, mixed>

getSmallSlider()

Get the slider of URLs there are not enough pages to slide.

protected getSmallSlider() : array<string|int, mixed>
Return values
array<string|int, mixed>

getUrlSlider()

Create a URL slider links.

protected getUrlSlider(int $onEachSide) : array<string|int, mixed>
Parameters
$onEachSide : int
Return values
array<string|int, mixed>

lastPage()

Get the last page from the paginator.

protected lastPage() : int
Return values
int

Search results