Interface CodeIgniter\Pager\PagerInterface


					
	public

links(string $group = 'default', string $template = 'default'): string

Handles creating and displaying the

Parameters

$template

The output template alias to render.

#


					
	public

simpleLinks(string $group = 'default', string $template = 'default'): string

Creates simple Next/Previous links, instead of full pagination.

#


					
	public

makeLinks(int $page, int $perPage, int $total, string $template = 'default'): string

Allows for a simple, manual, form of pagination where all of the data is provided by the user. The URL is the current…

Allows for a simple, manual, form of pagination where all of the data is provided by the user. The URL is the current URI.

Parameters

$template

The output template alias to render.

#


					
	public

store(string $group, int $page, int $perPage, int $total): $this

Stores a set of pagination data for later display. Most commonly used by the model to automate the process.

#


					
	public

setPath(string $path, string $group = 'default'): $this

Sets the path that an aliased group of links will use.

#


					
	public

getPageCount(string $group = 'default'): int

Returns the total number of pages.

#


					
	public

getCurrentPage(string $group = 'default'): int

Returns the number of the current page of results.

#


					
	public

getPageURI(?int $page = null, string $group = 'default', bool $returnObject = false): string|URI

Returns the URI for a specific page for the specified group.

#


					
	public

hasMore(string $group = 'default'): bool

Tells whether this group of results has any more pages of results.

#


					
	public

getFirstPage(string $group = 'default'): int

Returns the first page.

#


					
	public

getLastPage(string $group = 'default'): int|null

Returns the last page, if we have a total that we can calculate with.

#


					
	public

getNextPageURI(string $group = 'default'): string|null

Returns the full URI to the next page of results, or null.

#


					
	public

getPreviousPageURI(string $group = 'default'): string|null

Returns the full URL to the previous page of results, or null.

#


					
	public

getPerPage(string $group = 'default'): int

Returns the number of results per page that should be shown.

#


					
	public

getDetails(string $group = 'default'): array

Returns an array with details about the results, including total, per_page, current_page, last_page, next_url, prev_url…

Returns an array with details about the results, including total, per_page, current_page, last_page, next_url, prev_url, from, to. Does not include the actual data. This data is suitable for adding a 'data' object to with the result set and converting to JSON.

#

Namespaces

Interfaces

Interface CodeIgniter\Pager\PagerInterface

Parameters

Parameters