ISearchQuery
in
Tags
Table of Contents
Methods
- getLimit() : int
- Get the maximum number of results to return
- getOffset() : int
- Get the offset for returned results
- getOrder() : array<string|int, ISearchOrder>
- The fields and directions to order by
- getSearchOperation() : ISearchOperator
- getSelectFields() : array<int, string>
- The fields to include in the search results
- getUser() : IUser|null
- The user that issued the search
- limitToHome() : bool
- Whether or not the search should be limited to the users home storage
Methods
getLimit()
Get the maximum number of results to return
public
getLimit() : int
Tags
Return values
intgetOffset()
Get the offset for returned results
public
getOffset() : int
Tags
Return values
intgetOrder()
The fields and directions to order by
public
getOrder() : array<string|int, ISearchOrder>
Tags
Return values
array<string|int, ISearchOrder>getSearchOperation()
public
getSearchOperation() : ISearchOperator
Tags
Return values
ISearchOperatorgetSelectFields()
The fields to include in the search results
public
getSelectFields() : array<int, string>
Tags
Return values
array<int, string>getUser()
The user that issued the search
public
getUser() : IUser|null
Tags
Return values
IUser|nulllimitToHome()
Whether or not the search should be limited to the users home storage
public
limitToHome() : bool