ISearch
in
Small Interface for Search
Tags
Table of Contents
Methods
- clearProviders() : mixed
- Remove all registered search providers
- registerProvider() : mixed
- Register a new search provider to search with
- removeProvider() : mixed
- Remove one existing search provider
- searchPaged() : array<string|int, mixed>
- Search all providers for $query
Methods
clearProviders()
Remove all registered search providers
public
clearProviders() : mixed
Tags
registerProvider()
Register a new search provider to search with
public
registerProvider(string $class[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $class : string
-
class name of a OCP\Search\Provider
- $options : array<string|int, mixed> = []
-
optional
Tags
removeProvider()
Remove one existing search provider
public
removeProvider(string $provider) : mixed
Parameters
- $provider : string
-
class name of a OCP\Search\Provider
Tags
searchPaged()
Search all providers for $query
public
searchPaged(string $query[, array<string|int, string> $inApps = [] ][, int $page = 1 ][, int $size = 30 ]) : array<string|int, mixed>
Parameters
- $query : string
- $inApps : array<string|int, string> = []
-
optionally limit results to the given apps
- $page : int = 1
-
pages start at page 1
- $size : int = 30
Tags
Return values
array<string|int, mixed> —An array of OCP\Search\Result's