\OCP\SearchPagedProvider

Provides a template for search functionality throughout ownCloud;

Summary

Methods
Properties
Constants
__construct()
getOption()
providesResultsFor()
search()
searchPaged()
No public properties found
OPTION_APPS
SIZE_ALL
No protected methods found
$options
N/A
No private methods found
No private properties found
N/A

Constants

OPTION_APPS

OPTION_APPS

SIZE_ALL

SIZE_ALL

show all results

Properties

$options

$options : array

List of options

Type

array

Methods

__construct()

__construct(array  $options) 

Constructor

Parameters

array $options

as key => value

getOption()

getOption(string  $key) : mixed

get a value from the options array or null

Parameters

string $key

Returns

mixed

providesResultsFor()

providesResultsFor(array<mixed,string>  $apps = array()) : boolean

checks if the given apps and the apps this provider has results for intersect returns true if the given array is empty (all apps) or if this provider does not have a list of apps it provides results for (legacy search providers) or if the two above arrays have elements in common (intersect)

Parameters

array<mixed,string> $apps

Returns

boolean

search()

search(string  $query) : array

Search for $query

Parameters

string $query

Returns

array —

An array of OCP\Search\Result's

searchPaged()

searchPaged(string  $query, integer  $page, integer  $size) : array

Search for $query

Parameters

string $query
integer $page

pages start at page 1

integer $size

0 = SIZE_ALL

Returns

array —

An array of OCP\Search\Result's