1. class
  2. Hypervel
  3. \
  4. Inertia
  5. \
  6. ScrollMetadata

ScrollMetadata

class ScrollMetadata implements Arrayable, ProvidesScrollMetadata

Methods

__construct(string $pageName, int|string|null $previousPage = null, int|string|null $nextPage = null, int|string|null $currentPage = null)

Create a new scroll metadata instance.

static ScrollMetadata
fromPaginator(mixed $value)

Create a scroll metadata instance from a paginator.

string
getPageName()

Get the page name parameter.

int|string|null
getPreviousPage()

Get the previous page identifier.

int|string|null
getNextPage()

Get the next page identifier.

int|string|null
getCurrentPage()

Get the current page identifier.

array
toArray()

Convert the scroll metadata instance to an array.

Details

at line 22
__construct(string $pageName, int|string|null $previousPage = null, int|string|null $nextPage = null, int|string|null $currentPage = null)

Create a new scroll metadata instance.

Parameters

string $pageName
int|string|null $previousPage
int|string|null $nextPage
int|string|null $currentPage

at line 33
static ScrollMetadata fromPaginator(mixed $value)

Create a scroll metadata instance from a paginator.

Parameters

mixed $value

Return Value

ScrollMetadata

at line 61
string getPageName()

Get the page name parameter.

Return Value

string

at line 69
int|string|null getPreviousPage()

Get the previous page identifier.

Return Value

int|string|null

at line 77
int|string|null getNextPage()

Get the next page identifier.

Return Value

int|string|null

at line 85
int|string|null getCurrentPage()

Get the current page identifier.

Return Value

int|string|null

at line 93
array toArray()

Convert the scroll metadata instance to an array.

Return Value

array