Deprecate \OCP\ISearch

Signed-off-by: Christoph Wurst <[email protected]>

lib/private/Search/Provider/File.php

@@ -32,13 +32,15 @@
 
 /**
  * Provide search results from the 'files' app
+ * @deprecated 20.0.0
  */
 class File extends \OCP\Search\Provider {
 
 	/**
 	 * Search for files and folders matching the given query
 	 * @param string $query
 	 * @return \OCP\Search\Result
+	 * @deprecated 20.0.0
 	 */
 	public function search($query) {
 		$files = Filesystem::search($query);

lib/private/Search/Result/Audio.php

@@ -27,15 +27,17 @@
 
 /**
  * A found audio file
+ * @deprecated 20.0.0
  */
 class Audio extends File {
 
 	/**
 	 * Type name; translated in templates
 	 * @var string
+	 * @deprecated 20.0.0
 	 */
 	public $type = 'audio';
-	
+
 	/**
 	 * @TODO add ID3 information
 	 */

lib/private/Search/Result/File.php

@@ -31,49 +31,57 @@
 
 /**
  * A found file
+ * @deprecated 20.0.0
  */
 class File extends \OCP\Search\Result {
 
 	/**
 	 * Type name; translated in templates
 	 * @var string
+	 * @deprecated 20.0.0
 	 */
 	public $type = 'file';
 
 	/**
 	 * Path to file
 	 * @var string
+	 * @deprecated 20.0.0
 	 */
 	public $path;
 
 	/**
 	 * Size, in bytes
 	 * @var int
+	 * @deprecated 20.0.0
 	 */
 	public $size;
 
 	/**
 	 * Date modified, in human readable form
 	 * @var string
+	 * @deprecated 20.0.0
 	 */
 	public $modified;
 
 	/**
 	 * File mime type
 	 * @var string
+	 * @deprecated 20.0.0
 	 */
 	public $mime_type;
 
 	/**
 	 * File permissions:
 	 *
 	 * @var string
+	 * @deprecated 20.0.0
 	 */
 	public $permissions;
 
 	/**
 	 * Create a new file search result
 	 * @param FileInfo $data file data given by provider
+	 * @deprecated 20.0.0
 	 */
 	public function __construct(FileInfo $data) {
 		$path = $this->getRelativePath($data->getPath());
@@ -97,6 +105,7 @@ public function __construct(FileInfo $data) {
 
 	/**
 	 * @var Folder $userFolderCache
+	 * @deprecated 20.0.0
 	 */
 	protected static $userFolderCache = null;
 
@@ -105,6 +114,7 @@ public function __construct(FileInfo $data) {
 	 * eg /user/files/foo.txt -> /foo.txt
 	 * @param string $path
 	 * @return string relative path
+	 * @deprecated 20.0.0
 	 */
 	protected function getRelativePath($path) {
 		if (!isset(self::$userFolderCache)) {

lib/private/Search/Result/Folder.php

@@ -27,12 +27,14 @@
 
 /**
  * A found folder
+ * @deprecated 20.0.0
  */
 class Folder extends File {
 
 	/**
 	 * Type name; translated in templates
 	 * @var string
+	 * @deprecated 20.0.0
 	 */
 	public $type = 'folder';
 }

lib/private/Search/Result/Image.php

@@ -27,15 +27,17 @@
 
 /**
  * A found image file
+ * @deprecated 20.0.0
  */
 class Image extends File {
 
 	/**
 	 * Type name; translated in templates
 	 * @var string
+	 * @deprecated 20.0.0
 	 */
 	public $type = 'image';
-	
+
 	/**
 	 * @TODO add EXIF information
 	 */

lib/public/ISearch.php

@@ -29,6 +29,7 @@
 /**
  * Small Interface for Search
  * @since 7.0.0
+ * @deprecated 20.0.0
  */
 interface ISearch {
 
@@ -40,6 +41,7 @@ interface ISearch {
 	 * @param int $size
 	 * @return array An array of OCP\Search\Result's
 	 * @since 8.0.0
+	 * @deprecated 20.0.0
 	 */
 	public function searchPaged($query, array $inApps = [], $page = 1, $size = 30);
 
@@ -48,19 +50,22 @@ public function searchPaged($query, array $inApps = [], $page = 1, $size = 30);
 	 * @param string $class class name of a OCP\Search\Provider
 	 * @param array $options optional
 	 * @since 7.0.0
+	 * @deprecated 20.0.0
 	 */
 	public function registerProvider($class, array $options = []);
 
 	/**
 	 * Remove one existing search provider
 	 * @param string $provider class name of a OCP\Search\Provider
 	 * @since 7.0.0
+	 * @deprecated 20.0.0
 	 */
 	public function removeProvider($provider);
 
 	/**
 	 * Remove all registered search providers
 	 * @since 7.0.0
+	 * @deprecated 20.0.0
 	 */
 	public function clearProviders();
 }

lib/public/IServerContainer.php

@@ -359,6 +359,7 @@ public function getRouter();
 	 *
 	 * @return \OCP\ISearch
 	 * @since 7.0.0
+	 * @deprecated 20.0.0
 	 */
 	public function getSearch();
 

lib/public/Search/PagedProvider.php

@@ -30,19 +30,22 @@
 /**
  * Provides a template for search functionality throughout ownCloud;
  * @since 8.0.0
+ * @deprecated 20.0.0
  */
 abstract class PagedProvider extends Provider {
 
 	/**
 	 * show all results
 	 * @since 8.0.0
+	 * @deprecated 20.0.0
 	 */
 	public const SIZE_ALL = 0;
 
 	/**
 	 * Constructor
 	 * @param array $options
 	 * @since 8.0.0
+	 * @deprecated 20.0.0
 	 */
 	public function __construct($options) {
 		parent::__construct($options);
@@ -53,6 +56,7 @@ public function __construct($options) {
 	 * @param string $query
 	 * @return array An array of OCP\Search\Result's
 	 * @since 8.0.0
+	 * @deprecated 20.0.0
 	 */
 	public function search($query) {
 		// old apps might assume they get all results, so we use SIZE_ALL
@@ -66,6 +70,7 @@ public function search($query) {
 	 * @param int $size 0 = SIZE_ALL
 	 * @return array An array of OCP\Search\Result's
 	 * @since 8.0.0
+	 * @deprecated 20.0.0
 	 */
 	abstract public function searchPaged($query, $page, $size);
 }

lib/public/Search/Provider.php

@@ -30,25 +30,29 @@
 /**
  * Provides a template for search functionality throughout ownCloud;
  * @since 7.0.0
+ * @deprecated 20.0.0
  */
 abstract class Provider {
 
 	/**
 	 * @since 8.0.0
+	 * @deprecated 20.0.0
 	 */
 	public const OPTION_APPS = 'apps';
 
 	/**
 	 * List of options
 	 * @var array
 	 * @since 7.0.0
+	 * @deprecated 20.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
+	 * @deprecated 20.0.0
 	 */
 	public function __construct($options = []) {
 		$this->options = $options;
@@ -59,6 +63,7 @@ public function __construct($options = []) {
 	 * @param string $key
 	 * @return mixed
 	 * @since 8.0.0
+	 * @deprecated 20.0.0
 	 */
 	public function getOption($key) {
 		if (is_array($this->options) && isset($this->options[$key])) {
@@ -76,6 +81,7 @@ public function getOption($key) {
 	 * @param string[] $apps
 	 * @return bool
 	 * @since 8.0.0
+	 * @deprecated 20.0.0
 	 */
 	public function providesResultsFor(array $apps = []) {
 		$forApps = $this->getOption(self::OPTION_APPS);
@@ -87,6 +93,7 @@ public function providesResultsFor(array $apps = []) {
 	 * @param string $query
 	 * @return array An array of OCP\Search\Result's
 	 * @since 7.0.0
+	 * @deprecated 20.0.0
 	 */
 	abstract public function search($query);
 }

lib/public/Search/Result.php

@@ -29,6 +29,7 @@
 /**
  * The generic result of a search
  * @since 7.0.0
+ * @deprecated 20.0.0
  */
 class Result {
 
@@ -37,6 +38,7 @@ class Result {
 	 * corresponding application.
 	 * @var string
 	 * @since 7.0.0
+	 * @deprecated 20.0.0
 	 */
 	public $id;
 
@@ -45,13 +47,15 @@ class Result {
 	 * results.
 	 * @var string
 	 * @since 7.0.0
+	 * @deprecated 20.0.0
 	 */
 	public $name;
 
 	/**
 	 * URL to the application item.
 	 * @var string
 	 * @since 7.0.0
+	 * @deprecated 20.0.0
 	 */
 	public $link;
 
@@ -60,6 +64,7 @@ class Result {
 	 * as the class name (e.g. \OC\Search\File -> 'file') in lowercase.
 	 * @var string
 	 * @since 7.0.0
+	 * @deprecated 20.0.0
 	 */
 	public $type = 'generic';
 
@@ -69,6 +74,7 @@ class Result {
 	 * @param string $name displayed text of result
 	 * @param string $link URL to the result within its app
 	 * @since 7.0.0
+	 * @deprecated 20.0.0
 	 */
 	public function __construct($id = null, $name = null, $link = null) {
 		$this->id = $id;