-
-
Notifications
You must be signed in to change notification settings - Fork 2k
/
Collection.zep
236 lines (201 loc) · 5.39 KB
/
Collection.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\Micro;
/**
* Phalcon\Mvc\Micro\Collection
*
* Groups Micro-Mvc handlers as controllers
*
*```php
* $app = new \Phalcon\Mvc\Micro();
*
* $collection = new Collection();
*
* $collection->setHandler(
* new PostsController()
* );
*
* $collection->get("/posts/edit/{id}", "edit");
*
* $app->mount($collection);
*```
*/
class Collection implements CollectionInterface
{
protected handler;
protected handlers = [];
protected lazy;
protected prefix;
/**
* Maps a route to a handler that only matches if the HTTP method is DELETE.
*
* @param callable|string handler
*/
public function delete(string! routePattern, var handler, string name = null) -> <CollectionInterface>
{
this->addMap("DELETE", routePattern, handler, name);
return this;
}
/**
* Maps a route to a handler that only matches if the HTTP method is GET.
*
* @param callable|string handler
*/
public function get(string! routePattern, var handler, string name = null) -> <CollectionInterface>
{
this->addMap("GET", routePattern, handler, name);
return this;
}
/**
* Returns the main handler
*/
public function getHandler() -> var
{
return this->handler;
}
/**
* Returns the registered handlers
*/
public function getHandlers() -> array
{
return this->handlers;
}
/**
* Returns the collection prefix if any
*/
public function getPrefix() -> string
{
return this->prefix;
}
/**
* Maps a route to a handler that only matches if the HTTP method is HEAD.
*
* @param callable|string handler
*/
public function head(string! routePattern, var handler, string name = null) -> <CollectionInterface>
{
this->addMap("HEAD", routePattern, handler, name);
return this;
}
/**
* Returns if the main handler must be lazy loaded
*/
public function isLazy() -> bool
{
return this->lazy;
}
/**
* Maps a route to a handler.
*
* @param callable|string handler
*/
public function map(string! routePattern, var handler, string name = null) -> <CollectionInterface>
{
this->addMap(null, routePattern, handler, name);
return this;
}
/**
* Maps a route to a handler via methods.
*
* ```php
* $collection->mapVia(
* "/test",
* "indexAction",
* ["POST", "GET"],
* "test"
* );
* ```
*
* @param callable handler
* @param string|array method
*/
public function mapVia(string! routePattern, var handler, var method, string name = null) -> <CollectionInterface>
{
this->addMap(method, routePattern, handler, name);
return this;
}
/**
* Maps a route to a handler that only matches if the HTTP method is
* OPTIONS.
*
* @param callable|string handler
*/
public function options(string! routePattern, var handler, string name = null) -> <CollectionInterface>
{
this->addMap("OPTIONS", routePattern, handler, name);
return this;
}
/**
* Maps a route to a handler that only matches if the HTTP method is PATCH.
*
* @param callable|string handler
*/
public function patch(string! routePattern, var handler, string name = null) -> <CollectionInterface>
{
this->addMap("PATCH", routePattern, handler, name);
return this;
}
/**
* Maps a route to a handler that only matches if the HTTP method is POST.
*
* @param callable|string handler
*/
public function post(string! routePattern, var handler, string name = null) -> <CollectionInterface>
{
this->addMap("POST", routePattern, handler, name);
return this;
}
/**
* Maps a route to a handler that only matches if the HTTP method is PUT.
*
* @param callable|string handler
*/
public function put(string! routePattern, var handler, string name = null) -> <CollectionInterface>
{
this->addMap("PUT", routePattern, handler, name);
return this;
}
/**
* Sets the main handler.
*
* @param callable|string handler
*/
public function setHandler(var handler, bool lazy = false) -> <CollectionInterface>
{
let this->handler = handler,
this->lazy = lazy;
return this;
}
/**
* Sets if the main handler must be lazy loaded
*/
public function setLazy(bool! lazy) -> <CollectionInterface>
{
let this->lazy = lazy;
return this;
}
/**
* Sets a prefix for all routes added to the collection
*/
public function setPrefix(string! prefix) -> <CollectionInterface>
{
let this->prefix = prefix;
return this;
}
/**
* Internal function to add a handler to the group.
*
* @param string|array method
* @param callable|string handler
*/
protected function addMap(var method, string! routePattern, var handler, string name)
{
let this->handlers[] = [method, routePattern, handler, name];
}
}