mbk-lab
/
nextcloud
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Deprecate \OCP\ISearch 

Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
This commit is contained in:
Christoph Wurst 2020-06-22 10:57:40 +02:00
parent f8e08a74ba
commit 27b8637e3e
No known key found for this signature in database
GPG Key ID: CC42AC2A7F0E56D8
10 changed files with 44 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
lib/private/Search/Provider/File.php
View File

@ -32,6 +32,7 @@ use OC\Files\Filesystem;
/**
* Provide search results from the 'files' app
* @deprecated 20.0.0
*/
class File extends \OCP\Search\Provider {
@ -39,6 +40,7 @@ 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);

4
lib/private/Search/Result/Audio.php
View File

@ -27,15 +27,17 @@ namespace OC\Search\Result;
/**
* 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
*/

10
lib/private/Search/Result/File.php
View File

@ -31,36 +31,42 @@ use OCP\Files\Folder;
/**
* 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;
@ -68,12 +74,14 @@ class File extends \OCP\Search\Result {
* 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 @@ class File extends \OCP\Search\Result {
/**
* @var Folder $userFolderCache
* @deprecated 20.0.0
*/
protected static $userFolderCache = null;
@ -105,6 +114,7 @@ class File extends \OCP\Search\Result {
* 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)) {

2
lib/private/Search/Result/Folder.php
View File

@ -27,12 +27,14 @@ namespace OC\Search\Result;
/**
* 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';
}

4
lib/private/Search/Result/Image.php
View File

@ -27,15 +27,17 @@ namespace OC\Search\Result;
/**
* 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
*/

5
lib/public/ISearch.php
View File

@ -29,6 +29,7 @@ namespace OCP;
/**
* 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,6 +50,7 @@ interface ISearch {
* @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 = []);
@ -55,12 +58,14 @@ interface ISearch {
* 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();
}

1
lib/public/IServerContainer.php
View File

@ -359,6 +359,7 @@ interface IServerContainer extends IContainer {
*
* @return \OCP\ISearch
* @since 7.0.0
* @deprecated 20.0.0
*/
public function getSearch();

5
lib/public/Search/PagedProvider.php
View File

@ -30,12 +30,14 @@ namespace OCP\Search;
/**
* 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;
@ -43,6 +45,7 @@ abstract class PagedProvider extends Provider {
* Constructor
* @param array $options
* @since 8.0.0
* @deprecated 20.0.0
*/
public function __construct($options) {
parent::__construct($options);
@ -53,6 +56,7 @@ abstract class PagedProvider extends Provider {
* @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 @@ abstract class PagedProvider extends Provider {
* @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);
}

7
lib/public/Search/Provider.php
View File

@ -30,11 +30,13 @@ namespace OCP\Search;
/**
* 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';
@ -42,6 +44,7 @@ abstract class Provider {
* List of options
* @var array
* @since 7.0.0
* @deprecated 20.0.0
*/
protected $options;
@ -49,6 +52,7 @@ abstract class Provider {
* 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 @@ abstract class Provider {
* @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 @@ abstract class Provider {
* @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 @@ abstract class Provider {
* @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);
}

6
lib/public/Search/Result.php
View File

@ -29,6 +29,7 @@ namespace OCP\Search;
/**
* 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,6 +47,7 @@ class Result {
* results.
* @var string
* @since 7.0.0
* @deprecated 20.0.0
*/
public $name;
@ -52,6 +55,7 @@ class Result {
* 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;