PaginationElement
extends Element
in package
Element responsible for drawing the sequence of available pages for search results.
Tags
Table of Contents
- $view : object
- The View on which this Element is drawn
- __construct() : mixed
- constructor stores a reference to the view this element will reside on
- formatHref() : string
- Used to slightly clean up hypertext links before drawing them (get rid of empty queries, avoid double encoding)
- render() : mixed
- Draws the sequence of available pages for search results. (next prev links and, group of pages)
Properties
$view
The View on which this Element is drawn
public
object
$view
Methods
__construct()
constructor stores a reference to the view this element will reside on
public
__construct([object $view = null ]) : mixed
Parameters
- $view : object = null
-
object this element will reside on
Return values
mixed —formatHref()
Used to slightly clean up hypertext links before drawing them (get rid of empty queries, avoid double encoding)
public
formatHref(string $url) : string
Parameters
- $url : string
-
to clean up
Return values
string —cleaned url
render()
Draws the sequence of available pages for search results. (next prev links and, group of pages)
public
render(array<string|int, mixed> $data) : mixed
Parameters
- $data : array<string|int, mixed>
-
containing fields with info about thhe total number of search results for the query, the subsearch the query is is for, the desired number of results per page, which page we are on, etc.