ISearch

interface OCP\ISearch
Small Interface for Search
Implemented by:OC\Search
Source:lib/public/ISearch.php#34

Methods

public OCP\ISearch::searchPaged($query, $inApps=array(), $page=1, $size=30)
Search all providers for $query
Source:

lib/public/ISearch.php#45

Parameters:
  • $query (string)
  • $inApps (string[]) optionally limit results to the given apps
  • $page (int) pages start at page 1
  • $size (int)
Returns:

array An array of OCP\Search\Result’s

Since:

8.0.0

public OCP\ISearch::registerProvider($class, $options=array())
Register a new search provider to search with
Source:

lib/public/ISearch.php#53

Parameters:
  • $class (string) class name of a OCPSearchProvider
  • $options (array) optional
Since:

7.0.0

public OCP\ISearch::removeProvider($provider)
Remove one existing search provider
Source:

lib/public/ISearch.php#60

Parameters:
  • $provider (string) class name of a OCPSearchProvider
Since:

7.0.0

public OCP\ISearch::clearProviders()
Remove all registered search providers
Source:lib/public/ISearch.php#66
Since:7.0.0