class Factory (View source)

Properties

protected Request $request The request instance.
protected Factory $view The view factory instance.
protected TranslatorInterface $trans The translator implementation.
protected string $viewName The name of the pagination view.
protected int $currentPage The number of the current page.
protected string $locale The locale to be used by the translator.
protected string $baseUrl The base URL in use by the paginator.
protected string $pageName The input parameter used for the current page.

Methods

void
__construct(Request $request, Factory $view, TranslatorInterface $trans, string $pageName = 'page')

Create a new pagination factory.

void
setupPaginationEnvironment()

Setup the pagination environment.

make(array $items, int $total, int|null $perPage = null)

Get a new paginator instance.

getPaginationView(Paginator $paginator, string $view = null)

Get the pagination view.

int
getCurrentPage()

Get the number of the current page.

void
setCurrentPage(int $number)

Set the number of the current page.

string
getCurrentUrl()

Get the root URL for the request.

void
setBaseUrl(string $baseUrl)

Set the base URL in use by the paginator.

void
setPageName(string $pageName)

Set the input page parameter name used by the paginator.

string
getPageName()

Get the input page parameter name used by the paginator.

string
getViewName(string $view = null)

Get the name of the pagination view.

void
setViewName(string $viewName)

Set the name of the pagination view.

string
getLocale()

Get the locale of the paginator.

void
setLocale(string $locale)

Set the locale of the paginator.

Request
getRequest()

Get the active request instance.

void
setRequest(Request $request)

Set the active request instance.

getViewFactory()

Get the current view factory.

void
setViewFactory(Factory $view)

Set the current view factory.

TranslatorInterface
getTranslator()

Get the translator instance.

Details

void __construct(Request $request, Factory $view, TranslatorInterface $trans, string $pageName = 'page')

Create a new pagination factory.

Parameters

Request $request
Factory $view
TranslatorInterface $trans
string $pageName

Return Value

void

protected void setupPaginationEnvironment()

Setup the pagination environment.

Return Value

void

Paginator make(array $items, int $total, int|null $perPage = null)

Get a new paginator instance.

Parameters

array $items
int $total
int|null $perPage

Return Value

Paginator

View getPaginationView(Paginator $paginator, string $view = null)

Get the pagination view.

Parameters

Paginator $paginator
string $view

Return Value

View

int getCurrentPage()

Get the number of the current page.

Return Value

int

void setCurrentPage(int $number)

Set the number of the current page.

Parameters

int $number

Return Value

void

string getCurrentUrl()

Get the root URL for the request.

Return Value

string

void setBaseUrl(string $baseUrl)

Set the base URL in use by the paginator.

Parameters

string $baseUrl

Return Value

void

void setPageName(string $pageName)

Set the input page parameter name used by the paginator.

Parameters

string $pageName

Return Value

void

string getPageName()

Get the input page parameter name used by the paginator.

Return Value

string

string getViewName(string $view = null)

Get the name of the pagination view.

Parameters

string $view

Return Value

string

void setViewName(string $viewName)

Set the name of the pagination view.

Parameters

string $viewName

Return Value

void

string getLocale()

Get the locale of the paginator.

Return Value

string

void setLocale(string $locale)

Set the locale of the paginator.

Parameters

string $locale

Return Value

void

Request getRequest()

Get the active request instance.

Return Value

Request

void setRequest(Request $request)

Set the active request instance.

Parameters

Request $request

Return Value

void

Factory getViewFactory()

Get the current view factory.

Return Value

Factory

void setViewFactory(Factory $view)

Set the current view factory.

Parameters

Factory $view

Return Value

void

TranslatorInterface getTranslator()

Get the translator instance.

Return Value

TranslatorInterface