diff options
Diffstat (limited to 'lib/public/search/provider.php')
| -rw-r--r-- | lib/public/search/provider.php | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/lib/public/search/provider.php b/lib/public/search/provider.php index 6746bf14824..2f2cd03eb6a 100644 --- a/lib/public/search/provider.php +++ b/lib/public/search/provider.php @@ -26,21 +26,27 @@ namespace OCP\Search; /** - * Provides a template for search functionality throughout ownCloud; + * Provides a template for search functionality throughout ownCloud; + * @since 7.0.0 */ abstract class Provider { + /** + * @since 8.0.0 + */ const OPTION_APPS = 'apps'; /** * List of options * @var array + * @since 7.0.0 */ protected $options; /** * Constructor * @param array $options as key => value + * @since 7.0.0 - default value for $options was added in 8.0.0 */ public function __construct($options = array()) { $this->options = $options; @@ -50,6 +56,7 @@ abstract class Provider { * get a value from the options array or null * @param string $key * @return mixed + * @since 8.0.0 */ public function getOption($key) { if (is_array($this->options) && isset($this->options[$key])) { @@ -66,6 +73,7 @@ abstract class Provider { * or if the two above arrays have elements in common (intersect) * @param string[] $apps * @return bool + * @since 8.0.0 */ public function providesResultsFor(array $apps = array()) { $forApps = $this->getOption(self::OPTION_APPS); @@ -76,6 +84,7 @@ abstract class Provider { * Search for $query * @param string $query * @return array An array of OCP\Search\Result's + * @since 7.0.0 */ abstract public function search($query); } |