1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
<?php
/**
* @author Bart Visscher <bartv@thisnet.nl>
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
* @author Lukas Reschke <lukas@owncloud.com>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Robin Appelman <icewind@owncloud.com>
* @author Roeland Jago Douma <rullzer@owncloud.com>
*
* @copyright Copyright (c) 2016, ownCloud, Inc.
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
namespace OCP\Route;
/**
* Interface IRouter
*
* @package OCP\Route
* @since 7.0.0
* @deprecated 9.0.0
*/
interface IRouter {
/**
* Get the files to load the routes from
*
* @return string[]
* @since 7.0.0
* @deprecated 9.0.0
*/
public function getRoutingFiles();
/**
* @return string
* @since 7.0.0
* @deprecated 9.0.0
*/
public function getCacheKey();
/**
* Loads the routes
*
* @param null|string $app
* @since 7.0.0
* @deprecated 9.0.0
*/
public function loadRoutes($app = null);
/**
* Sets the collection to use for adding routes
*
* @param string $name Name of the collection to use.
* @return void
* @since 7.0.0
* @deprecated 9.0.0
*/
public function useCollection($name);
/**
* returns the current collection name in use for adding routes
*
* @return string the collection name
* @since 8.0.0
* @deprecated 9.0.0
*/
public function getCurrentCollection();
/**
* 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
* @since 7.0.0
* @deprecated 9.0.0
*/
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
* @return void
* @since 7.0.0
* @deprecated 9.0.0
*/
public function match($url);
/**
* Get the url generator
*
* @since 7.0.0
* @deprecated 9.0.0
*/
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
* @since 7.0.0
* @deprecated 9.0.0
*/
public function generate($name, $parameters = array(), $absolute = false);
}
|
