72 lines
1.5 KiB
PHP
72 lines
1.5 KiB
PHP
|
<?php
|
||
|
|
/**
|
||
|
|
* Copyright (c) 2012 Bart Visscher <bartv@thisnet.nl>
|
||
|
|
* This file is licensed under the Affero General Public License version 3 or
|
||
|
|
* later.
|
||
|
|
* See the COPYING-README file.
|
||
|
|
*/
|
||
|
|
|
||
|
|
namespace OCP\Route;
|
||
|
|
|
||
|
|
interface IRouter {
|
||
|
|
|
||
|
|
public function __construct();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the files to load the routes from
|
||
|
|
*
|
||
|
|
* @return string[]
|
||
|
|
*/
|
||
|
|
public function getRoutingFiles();
|
||
|
|
|
||
|
|
public function getCacheKey();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* loads the api routes
|
||
|
|
*/
|
||
|
|
public function loadRoutes();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets the collection to use for adding routes
|
||
|
|
*
|
||
|
|
* @param string $name Name of the collection to use.
|
||
|
|
*/
|
||
|
|
public function useCollection($name);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Create a \OCP\Route\IRoute.
|
||
|
|
*
|
||
|
|
* @param string $name Name of the route to create.
|
||
|
|
* @param string $pattern The pattern to match
|
||
|
|
* @param array $defaults An array of default parameter values
|
||
|
|
* @param array $requirements An array of requirements for parameters (regexes)
|
||
|
|
* @return \OCP\Route\IRoute
|
||
|
|
*/
|
||
|
|
public function create($name, $pattern, array $defaults = array(), array $requirements = array());
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Find the route matching $url.
|
||
|
|
*
|
||
|
|
* @param string $url The url to find
|
||
|
|
* @throws \Exception
|
||
|
|
*/
|
||
|
|
public function match($url);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the url generator
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
public function getGenerator();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Generate url based on $name and $parameters
|
||
|
|
*
|
||
|
|
* @param string $name Name of the route to use.
|
||
|
|
* @param array $parameters Parameters for the route
|
||
|
|
* @param bool $absolute
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function generate($name, $parameters = array(), $absolute = false);
|
||
|
|
|
||
|
|
}
|