Merge pull request #22169 from owncloud/cache-interface-fixes

Cache interface cleanup/phpdoc

lib/public/files/cache/icache.php

@@ -59,6 +59,8 @@ interface ICache {
 	/**
 	 * get the metadata of all files stored in $folder
 	 *
+	 * Only returns files one level deep, no recursion
+	 *
 	 * @param string $folder
 	 * @return ICacheEntry[]
 	 * @since 9.0.0
@@ -68,6 +70,8 @@ interface ICache {
 	/**
 	 * get the metadata of all files stored in $folder
 	 *
+	 * Only returns files one level deep, no recursion
+	 *
 	 * @param int $fileId the file id of the folder
 	 * @return ICacheEntry[]
 	 * @since 9.0.0
@@ -187,11 +191,12 @@ interface ICache {
 	public function getStatus($file);
 
 	/**
-	 * search for files matching $pattern
+	 * search for files matching $pattern, files are matched if their filename matches the search pattern
 	 *
 	 * @param string $pattern the search pattern using SQL search syntax (e.g. '%searchstring%')
 	 * @return ICacheEntry[] an array of cache entries where the name matches the search pattern
 	 * @since 9.0.0
+	 * @deprecated 9.0.0 due to lack of pagination, not all backends might implement this
 	 */
 	public function search($pattern);
 
@@ -202,6 +207,7 @@ interface ICache {
 	 *        where it will search for all mimetypes in the group ('image/*')
 	 * @return ICacheEntry[] an array of cache entries where the mimetype matches the search
 	 * @since 9.0.0
+	 * @deprecated 9.0.0 due to lack of pagination, not all backends might implement this
 	 */
 	public function searchByMime($mimetype);
 
@@ -214,6 +220,7 @@ interface ICache {
 	 * @param string $userId owner of the tags
 	 * @return ICacheEntry[] file data
 	 * @since 9.0.0
+	 * @deprecated 9.0.0 due to lack of pagination, not all backends might implement this
 	 */
 	public function searchByTag($tag, $userId);
 

lib/public/files/storage/istorage.php

@@ -303,15 +303,6 @@ interface IStorage {
 	 */
 	public function free_space($path);
 
-	/**
-	 * search for occurrences of $query in file names
-	 *
-	 * @param string $query
-	 * @return array|false
-	 * @since 9.0.0
-	 */
-	public function search($query);
-
 	/**
 	 * see http://php.net/manual/en/function.touch.php
 	 * If the backend does not support the operation, false should be returned