-
Notifications
You must be signed in to change notification settings - Fork 74
/
Route.php
549 lines (511 loc) · 10.8 KB
/
Route.php
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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
<?php
/**
*
* This file is part of Aura for PHP.
*
* @license http://opensource.org/licenses/bsd-license.php BSD
*
*/
namespace Aura\Router;
/**
*
* An individual route with a name, path, attributes, defaults, etc.
*
* @package Aura.Router
*
* @property-read string $name The route name.
*
* @property-read string $path The route path.
*
* @property-read string $namePrefix
*
* @property-read string $pathPrefix
*
* @property-read string $host
*
* @property-read array $defaults Default values for attributes.
*
* @property-read array $attributes Attribute values added by the rules.
*
* @property-read array $tokens Placeholder token names and regexes.
*
* @property-read string $wildcard The name of the wildcard token.
*
* @property-read array $accepts
*
* @property-read mixed $auth The auth value.
*
* @property-read array $extras
*
* @property-read bool $secure
*
* @property-read array $allows
*
* @property-read bool $isRoutable
*
* @property-read callable $special
*
* @property-read string $failedRule
*
* @property-read mixed $handler
*
*/
class Route
{
/**
*
* Accepts these content types.
*
* @var array
*
*/
protected $accepts = [];
/**
*
* Allows these HTTP methods.
*
* @var array
*
*/
protected $allows = [];
/**
*
* Attribute values added by the rules.
*
* @var array
*
*/
protected $attributes = [];
/**
*
* Authentication/authorization values.
*
* @var mixed
*
*/
protected $auth;
/**
*
* Default attribute values.
*
* @var array
*
*/
protected $defaults = [];
/**
*
* Extra key-value pairs to attach to the route; intended for use by
* custom matching rules.
*
* @var array
*
*/
protected $extras = [];
/**
*
* The rule that failed, if any, during matching.
*
* @var string|null
*
*/
protected $failedRule;
/**
*
* The action, controller, callable, closure, etc. this route points to.
*
* @var mixed
*
*/
protected $handler;
/**
*
* The host string this route responds to.
*
* @var string
*
*/
protected $host;
/**
*
* The name for this route.
*
* @var string|null
*
*/
protected $name;
/**
*
* Prefix the route name with this string.
*
* @var string
*
*/
protected $namePrefix;
/**
*
* The path for this route.
*
* @var string|null
*
*/
protected $path;
/**
*
* Prefix the route path with this string.
*
* @var string
*
*/
protected $pathPrefix;
/**
*
* Should this route be used for matching?
*
* @var bool
*
*/
protected $isRoutable = true;
/**
*
* Should this route respond on a secure protocol?
*
* @var bool|null
*
*/
protected $secure = null;
/**
*
* A callable to use for special matching logic on this individual Route.
*
* @var callable|null
*
*/
protected $special;
/**
*
* Placeholder token names and regexes.
*
* @var array
*
*/
protected $tokens = [];
/**
*
* Wildcard token name, if any.
*
* @var string|null
*
*/
protected $wildcard = null;
/**
*
* When cloning the Route, reset the `$attributes` to defaults, and
* clear the `$failedRule`.
*
*/
public function __clone()
{
// $this is the cloned instance, not the original
$this->attributes = $this->defaults;
$this->failedRule = null;
}
/**
*
* Magic read-only for all properties.
*
* @param string $key The property to read from.
*
* @return mixed
*
*/
public function __get($key)
{
return $this->$key;
}
/**
*
* Merges with the existing content types.
*
* @param string|array $accepts The content types.
*
* @return $this
*
*/
public function accepts($accepts)
{
$this->accepts = array_merge($this->accepts, (array) $accepts);
return $this;
}
/**
*
* Merges with the existing allowed methods.
*
* @param string|array $allows The allowed HTTP methods.
*
* @return $this
*
*/
public function allows($allows)
{
$this->allows = array_merge($this->allows, (array) $allows);
return $this;
}
/**
*
* Merges with the existing attributes.
*
* @param array $attributes The attributes to add.
*
* @return $this
*
*/
public function attributes(array $attributes)
{
$this->attributes = array_merge($this->attributes, $attributes);
return $this;
}
/**
*
* Sets the auth value.
*
* @param mixed $auth The auth value to set.
*
* @return $this
*
*/
public function auth($auth)
{
$this->auth = $auth;
return $this;
}
/**
*
* Merges with the existing default values for attributes.
*
* @param array $defaults Default values for attributes.
*
* @return $this
*
*/
public function defaults(array $defaults)
{
$this->defaults = array_merge($this->defaults, $defaults);
return $this;
}
/**
*
* Merges with the existing extra key-value pairs; this merge is recursive,
* so the values can be arbitrarily deep.
*
* @param array $extras The extra key-value pairs.
*
* @return $this
*
*/
public function extras(array $extras)
{
$this->extras = array_merge_recursive($this->extras, $extras);
return $this;
}
/**
*
* Sets the failed rule.
*
* @param mixed $failedRule The failed rule.
*
* @return $this
*
*/
public function failedRule($failedRule)
{
$this->failedRule = $failedRule;
return $this;
}
/**
*
* The route leads to this handler.
*
* @param mixed $handler The handler for this route; if null, uses the
* route name.
*
* @return $this
*
*/
public function handler($handler)
{
if ($handler === null) {
$handler = $this->name;
}
$this->handler = $handler;
return $this;
}
/**
*
* Sets the host.
*
* @param mixed $host The host.
*
* @return $this
*
*/
public function host($host)
{
$this->host = $host;
return $this;
}
/**
*
* Sets whether or not this route should be used for matching.
*
* @param bool $isRoutable If true, this route can be matched; if not, it
* can be used only to generate a path.
*
* @return $this
*
*/
public function isRoutable($isRoutable = true)
{
$this->isRoutable = (bool) $isRoutable;
return $this;
}
/**
*
* Sets the route name; immutable once set.
*
* @param string $name The route name.
*
* @return $this
*
* @throws Exception\ImmutableProperty when the name has already been set.
*
*/
public function name($name)
{
if ($this->name !== null) {
$message = __CLASS__ . '::$name is immutable once set';
throw new Exception\ImmutableProperty($message);
}
$this->name = $this->namePrefix . $name;
return $this;
}
/**
*
* Appends to the existing name prefix; immutable once $name is set.
*
* @param string $namePrefix The name prefix to append.
*
* @return $this
*
* @throws Exception\ImmutableProperty when the name has already been set.
*
*/
public function namePrefix($namePrefix)
{
if ($this->name !== null) {
$message = __CLASS__ . '::$namePrefix is immutable once $name is set';
throw new Exception\ImmutableProperty($message);
}
$this->namePrefix = $namePrefix;
return $this;
}
/**
*
* Sets the route path; immutable once set.
*
* @param string $path The route path.
*
* @return $this
*
* @throws Exception\ImmutableProperty when the name has already been set.
*
*/
public function path($path)
{
if ($this->path !== null) {
$message = __CLASS__ . '::$path is immutable once set';
throw new Exception\ImmutableProperty($message);
}
$this->path = $this->pathPrefix . $path;
return $this;
}
/**
*
* Appends to the existing path prefix; immutable once $path is set.
*
* @param string $pathPrefix The path prefix to append.
*
* @return $this
*
* @throws Exception\ImmutableProperty when the path has already been set.
*
*/
public function pathPrefix($pathPrefix)
{
if ($this->path !== null) {
$message = __CLASS__ . '::$pathPrefix is immutable once $path is set';
throw new Exception\ImmutableProperty($message);
}
$this->pathPrefix = $pathPrefix;
return $this;
}
/**
*
* Sets whether or not the route must be secure.
*
* @param bool|null $secure If true, the server must indicate an HTTPS request;
* if false, it must *not* be HTTPS; if null, it doesn't matter.
*
* @return $this
*
*/
public function secure($secure = true)
{
$this->secure = ($secure === null) ? null : (bool) $secure;
return $this;
}
/**
*
* A callable to use for special matching logic on this individual Route.
*
* @param callable|null $special A callable to invoke for special matching
* logic on this individiual route. The callable should have the signature
* `function ($request, $route) : bool`. (Use null or another empty value
* to indicate there is no special matching logic.)
*
* @return $this
*
*/
public function special($special)
{
$this->special = $special;
return $this;
}
/**
*
* Merges with the existing tokens.
*
* @param array $tokens The tokens.
*
* @return $this
*
*/
public function tokens(array $tokens)
{
$this->tokens = array_merge($this->tokens, $tokens);
return $this;
}
/**
*
* Sets the name of the wildcard token, if any.
*
* @param string $wildcard The name of the wildcard token, if any.
*
* @return $this
*
*/
public function wildcard($wildcard)
{
$this->wildcard = $wildcard;
return $this;
}
}