Stud.IP
5.4
|
Public Member Functions | |
__construct (\User $user=null) | |
getError () | |
getFilter () | |
getUser () | |
getOffset () | |
getPage () | |
getQuery () | |
getResultsPerPage () | |
getSort () | |
hasError () | |
setFilter (Filter $filter) | |
setPage ($page) | |
setQuery ($query) | |
setResultsPerPage ($resultsPerPage) | |
setSort ($sort) | |
Data Fields | |
const | MIN_LENGTH = 4 |
const | SORT_RELEVANCE = 'relevance' |
const | SORT_CHDATE = 'chdate' |
Simple class to hold everything about a files search query.
GPL2 or any later version
__construct | ( | \User | $user = null | ) |
Creates an empty search query.
(PHPMD.Superglobals)
getError | ( | ) |
Returns a possible error.
getFilter | ( | ) |
Returns the associated filter.
getOffset | ( | ) |
Returns the offset of the first result using the current page and the setting of results per page.
getPage | ( | ) |
Returns the current page.
getQuery | ( | ) |
Returns the search query term.
getResultsPerPage | ( | ) |
Returns the current number of results per page.
getSort | ( | ) |
Returns the sorting type.
getUser | ( | ) |
Returns the user performing the search.
hasError | ( | ) |
Has the query an error?
setFilter | ( | Filter | $filter | ) |
setPage | ( | $page | ) |
setQuery | ( | $query | ) |
Set the search query term.
string | $query | the search query term |
$this
for chaining setResultsPerPage | ( | $resultsPerPage | ) |
Set the number of results per page.
int | $resultsPerPage | the number of results per page |
$this
for chaining setSort | ( | $sort | ) |
Set the sort order.
string | $sort | either one of the two symbols Query::SORT_CHDATE or Query:SORT_RELEVANCE |
$this
for chaining const MIN_LENGTH = 4 |
const SORT_CHDATE = 'chdate' |
const SORT_RELEVANCE = 'relevance' |