\OCPISearch

Small Interface for Search

Summary

Methods
Constants
search()
searchPaged()
registerProvider()
removeProvider()
clearProviders()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

search()

search(string  $query, array<mixed,string>  $inApps = array()) : array

Search all providers for $query

Parameters

string $query
array<mixed,string> $inApps

optionally limit results to the given apps

Returns

array —

An array of OCP\Search\Result's

searchPaged()

searchPaged(string  $query, array<mixed,string>  $inApps = array(), integer  $page = 1, integer  $size = 30) : array

Search all providers for $query

Parameters

string $query
array<mixed,string> $inApps

optionally limit results to the given apps

integer $page

pages start at page 1

integer $size

Returns

array —

An array of OCP\Search\Result's

registerProvider()

registerProvider(string  $class, array  $options = array()) 

Register a new search provider to search with

Parameters

string $class

class name of a OCP\Search\Provider

array $options

optional

removeProvider()

removeProvider(string  $provider) 

Remove one existing search provider

Parameters

string $provider

class name of a OCP\Search\Provider

clearProviders()

clearProviders() 

Remove all registered search providers