-
-
Notifications
You must be signed in to change notification settings - Fork 2k
/
RouterInterface.zep
236 lines (203 loc) · 6.5 KB
/
RouterInterface.zep
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
/**
* This file is part of the Phalcon Framework.
*
* (c) Phalcon Team <team@phalcon.io>
*
* For the full copyright and license information, please view the LICENSE.txt
* file that was distributed with this source code.
*/
namespace Phalcon\Mvc;
use Phalcon\Mvc\Router\RouteInterface;
use Phalcon\Mvc\Router\GroupInterface;
/**
* Interface for Phalcon\Mvc\Router
*/
interface RouterInterface
{
/**
* Adds a route to the router on any HTTP method
*
* @param string pattern
* @param array|string|null paths
* @param array|string|null httpMethods
*
* @return RouteInterface
*/
public function add(string! pattern, var paths = null, var httpMethods = null, int position = Router::POSITION_LAST) -> <RouteInterface>;
/**
* Adds a route to the router that only match if the HTTP method is CONNECT
*
* @param string pattern
* @param array|string|null paths
*
* @return RouteInterface
*/
public function addConnect(string! pattern, var paths = null, int position = Router::POSITION_LAST) -> <RouteInterface>;
/**
* Adds a route to the router that only match if the HTTP method is DELETE
*
* @param string pattern
* @param array|string|null paths
*
* @return RouteInterface
*/
public function addDelete(string! pattern, var paths = null, int position = Router::POSITION_LAST) -> <RouteInterface>;
/**
* Adds a route to the router that only match if the HTTP method is HEAD
*
* @param string pattern
* @param array|string|null paths
*
* @return RouteInterface
*/
public function addHead(string! pattern, var paths = null, int position = Router::POSITION_LAST) -> <RouteInterface>;
/**
* Adds a route to the router that only match if the HTTP method is GET
*
* @param string pattern
* @param array|string|null paths
*
* @return RouteInterface
*/
public function addGet(string! pattern, var paths = null, int position = Router::POSITION_LAST) -> <RouteInterface>;
/**
* Add a route to the router that only match if the HTTP method is OPTIONS
*
* @param string pattern
* @param array|string|null paths
*
* @return RouteInterface
*/
public function addOptions(string! pattern, var paths = null, int position = Router::POSITION_LAST) -> <RouteInterface>;
/**
* Adds a route to the router that only match if the HTTP method is PATCH
*
* @param string pattern
* @param array|string|null paths
*
* @return RouteInterface
*/
public function addPatch(string! pattern, var paths = null, int position = Router::POSITION_LAST) -> <RouteInterface>;
/**
* Adds a route to the router that only match if the HTTP method is POST
*
* @param string pattern
* @param array|string|null paths
*
* @return RouteInterface
*/
public function addPost(string! pattern, var paths = null, int position = Router::POSITION_LAST) -> <RouteInterface>;
/**
* Adds a route to the router that only match if the HTTP method is PURGE
* (Squid and Varnish support)
*
* @param string pattern
* @param array|string|null paths
*
* @return RouteInterface
*/
public function addPurge(string! pattern, var paths = null, int position = Router::POSITION_LAST) -> <RouteInterface>;
/**
* Adds a route to the router that only match if the HTTP method is PUT
*
* @param string pattern
* @param array|string|null paths
*
* @return RouteInterface
*/
public function addPut(string! pattern, var paths = null, int position = Router::POSITION_LAST) -> <RouteInterface>;
/**
* Adds a route to the router that only match if the HTTP method is TRACE
*
* @param string pattern
* @param array|string|null paths
*
* @return RouteInterface
*/
public function addTrace(string! pattern, var paths = null, int position = Router::POSITION_LAST) -> <RouteInterface>;
/**
* Attach Route object to the routes stack.
*
* @param RouteInterface route
* @param int position
*
* @return RouterInterface
*/
public function attach(<RouteInterface> route, int position = Router::POSITION_LAST) -> <RouterInterface>;
/**
* Removes all the defined routes
*/
public function clear() -> void;
/**
* Returns processed action name
*/
public function getActionName() -> string;
/**
* Returns processed controller name
*/
public function getControllerName() -> string;
/**
* Returns the route that matches the handled URI
*/
public function getMatchedRoute() -> <RouteInterface> | null;
/**
* Return the sub expressions in the regular expression matched
*/
public function getMatches() -> array;
/**
* Returns processed module name
*/
public function getModuleName() -> string;
/**
* Returns processed namespace name
*/
public function getNamespaceName() -> string;
/**
* Returns processed extra params
*/
public function getParams() -> array;
/**
* Return all the routes defined in the router
*/
public function getRoutes() -> <RouteInterface[]>;
/**
* Returns a route object by its id
*
* @return RouteInterface|bool
*/
public function getRouteById(var id) -> <RouteInterface> | bool;
/**
* Returns a route object by its name
*
* @return RouteInterface|bool
*/
public function getRouteByName(string! name) -> <RouteInterface> | bool;
/**
* Handles routing information received from the rewrite engine
*/
public function handle(string! uri) -> void;
/**
* Mounts a group of routes in the router
*/
public function mount(<GroupInterface> group) -> <RouterInterface>;
/**
* Sets the default action name
*/
public function setDefaultAction(string! actionName) -> <RouterInterface>;
/**
* Sets the default controller name
*/
public function setDefaultController(string! controllerName) -> <RouterInterface>;
/**
* Sets the name of the default module
*/
public function setDefaultModule(string! moduleName) -> <RouterInterface>;
/**
* Sets an array of default paths
*/
public function setDefaults(array! defaults) -> <RouterInterface>;
/**
* Check if the router matches any of the defined routes
*/
public function wasMatched() -> bool;
}