summaryrefslogtreecommitdiffstats
path: root/lib/public/search/pagedprovider.php
diff options
context:
space:
mode:
authorMorris Jobke <hey@morrisjobke.de>2015-04-16 17:00:08 +0200
committerMorris Jobke <hey@morrisjobke.de>2015-04-16 17:00:08 +0200
commit7644950b48b094bfe5675348aefb7cf5747d325b (patch)
treea1792e21239a86f471da99b454134a5d8533ef77 /lib/public/search/pagedprovider.php
parent8653da6c16597959c7bd0f0b202747ff96204575 (diff)
downloadnextcloud-server-7644950b48b094bfe5675348aefb7cf5747d325b.tar.gz
nextcloud-server-7644950b48b094bfe5675348aefb7cf5747d325b.zip
Add @since tags to all methods in public namespace
* enhance the app development experience - you can look up the method introduction right inside the code without searching via git blame * easier to write apps for multiple versions
Diffstat (limited to 'lib/public/search/pagedprovider.php')
-rw-r--r--lib/public/search/pagedprovider.php7
1 files changed, 6 insertions, 1 deletions
diff --git a/lib/public/search/pagedprovider.php b/lib/public/search/pagedprovider.php
index 1ba1459604a..7452bbd47bb 100644
--- a/lib/public/search/pagedprovider.php
+++ b/lib/public/search/pagedprovider.php
@@ -23,18 +23,21 @@
namespace OCP\Search;
/**
- * Provides a template for search functionality throughout ownCloud;
+ * Provides a template for search functionality throughout ownCloud;
+ * @since 8.0.0
*/
abstract class PagedProvider extends Provider {
/**
* show all results
+ * @since 8.0.0
*/
const SIZE_ALL = 0;
/**
* Constructor
* @param array $options
+ * @since 8.0.0
*/
public function __construct($options) {
$this->options = $options;
@@ -44,6 +47,7 @@ abstract class PagedProvider extends Provider {
* Search for $query
* @param string $query
* @return array An array of OCP\Search\Result's
+ * @since 8.0.0
*/
public function search($query) {
// old apps might assume they get all results, so we use SIZE_ALL
@@ -56,6 +60,7 @@ abstract class PagedProvider extends Provider {
* @param int $page pages start at page 1
* @param int $size, 0 = SIZE_ALL
* @return array An array of OCP\Search\Result's
+ * @since 8.0.0
*/
abstract public function searchPaged($query, $page, $size);
}