QubitSearchPager
in package
Table of Contents
Methods
- __construct() : mixed
- getFirstIndice() : int
- getLastIndice() : int
- getLastPage() : int
- Get the total number of pages.
- getLinks() : array<string|int, mixed>
- Get links for pager navigation.
- getMaxPerPage() : int
- getNbResults() : int
- getNextPage() : int
- getPage() : int
- getPreviousPage() : int
- getQuery() : mixed
- Get the search query.
- getResults() : array<string|int, mixed>
- Get the current page results.
- getResultSet() : object|null
- Get the raw Elastica ResultSet.
- haveToPaginate() : bool
- init() : mixed
- Initialize/execute the search.
- isFirstPage() : bool
- isLastPage() : bool
- setMaxPerPage() : mixed
- setPage() : mixed
- setQuery() : mixed
- Set the search query.
Methods
__construct()
public
__construct([object $search = null ]) : mixed
Parameters
- $search : object = null
-
Elastica search or QubitSearch index object
getFirstIndice()
public
getFirstIndice() : int
Return values
intgetLastIndice()
public
getLastIndice() : int
Return values
intgetLastPage()
Get the total number of pages.
public
getLastPage() : int
Return values
intgetLinks()
Get links for pager navigation.
public
getLinks([int $nbLinks = 5 ]) : array<string|int, mixed>
Parameters
- $nbLinks : int = 5
-
Number of links to show
Return values
array<string|int, mixed>getMaxPerPage()
public
getMaxPerPage() : int
Return values
intgetNbResults()
public
getNbResults() : int
Return values
intgetNextPage()
public
getNextPage() : int
Return values
intgetPage()
public
getPage() : int
Return values
intgetPreviousPage()
public
getPreviousPage() : int
Return values
intgetQuery()
Get the search query.
public
getQuery() : mixed
getResults()
Get the current page results.
public
getResults() : array<string|int, mixed>
Return values
array<string|int, mixed>getResultSet()
Get the raw Elastica ResultSet.
public
getResultSet() : object|null
Return values
object|nullhaveToPaginate()
public
haveToPaginate() : bool
Return values
boolinit()
Initialize/execute the search.
public
init() : mixed
isFirstPage()
public
isFirstPage() : bool
Return values
boolisLastPage()
public
isLastPage() : bool
Return values
boolsetMaxPerPage()
public
setMaxPerPage(int $maxPerPage) : mixed
Parameters
- $maxPerPage : int
setPage()
public
setPage(int $page) : mixed
Parameters
- $page : int
setQuery()
Set the search query.
public
setQuery(mixed $query) : mixed
Parameters
- $query : mixed
-
Elastica query