summaryrefslogtreecommitdiffstats
path: root/lib/public/route/irouter.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/route/irouter.php')
-rw-r--r--lib/public/route/irouter.php15
1 files changed, 15 insertions, 0 deletions
diff --git a/lib/public/route/irouter.php b/lib/public/route/irouter.php
index fbbcdcbb1af..3f5b58ac416 100644
--- a/lib/public/route/irouter.php
+++ b/lib/public/route/irouter.php
@@ -24,23 +24,32 @@
namespace OCP\Route;
+/**
+ * Interface IRouter
+ *
+ * @package OCP\Route
+ * @since 7.0.0
+ */
interface IRouter {
/**
* Get the files to load the routes from
*
* @return string[]
+ * @since 7.0.0
*/
public function getRoutingFiles();
/**
* @return string
+ * @since 7.0.0
*/
public function getCacheKey();
/**
* loads the api routes
* @return void
+ * @since 7.0.0
*/
public function loadRoutes($app = null);
@@ -49,6 +58,7 @@ interface IRouter {
*
* @param string $name Name of the collection to use.
* @return void
+ * @since 7.0.0
*/
public function useCollection($name);
@@ -56,6 +66,7 @@ interface IRouter {
* returns the current collection name in use for adding routes
*
* @return string the collection name
+ * @since 8.0.0
*/
public function getCurrentCollection();
@@ -67,6 +78,7 @@ interface IRouter {
* @param array $defaults An array of default parameter values
* @param array $requirements An array of requirements for parameters (regexes)
* @return \OCP\Route\IRoute
+ * @since 7.0.0
*/
public function create($name, $pattern, array $defaults = array(), array $requirements = array());
@@ -76,12 +88,14 @@ interface IRouter {
* @param string $url The url to find
* @throws \Exception
* @return void
+ * @since 7.0.0
*/
public function match($url);
/**
* Get the url generator
*
+ * @since 7.0.0
*/
public function getGenerator();
@@ -92,6 +106,7 @@ interface IRouter {
* @param array $parameters Parameters for the route
* @param bool $absolute
* @return string
+ * @since 7.0.0
*/
public function generate($name, $parameters = array(), $absolute = false);