/
Router.php
1127 lines (1032 loc) · 38 KB
/
Router.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
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 0.2.9
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Routing;
use Cake\Core\Configure;
use Cake\Http\ServerRequest;
use Cake\Routing\Exception\MissingRouteException;
use Cake\Utility\Inflector;
use Psr\Http\Message\ServerRequestInterface;
/**
* Parses the request URL into controller, action, and parameters. Uses the connected routes
* to match the incoming URL string to parameters that will allow the request to be dispatched. Also
* handles converting parameter lists into URL strings, using the connected routes. Routing allows you to decouple
* the way the world interacts with your application (URLs) and the implementation (controllers and actions).
*
* ### Connecting routes
*
* Connecting routes is done using Router::connect(). When parsing incoming requests or reverse matching
* parameters, routes are enumerated in the order they were connected. For more information on routes and
* how to connect them see Router::connect().
*/
class Router
{
/**
* Have routes been loaded
*
* @var bool
* @deprecated 3.5.0 Routes will be loaded via the Application::routes() hook in 4.0.0
*/
public static $initialized = false;
/**
* Default route class.
*
* @var string
*/
protected static $_defaultRouteClass = 'Cake\Routing\Route\Route';
/**
* Contains the base string that will be applied to all generated URLs
* For example `https://example.com`
*
* @var string
*/
protected static $_fullBaseUrl;
/**
* Regular expression for action names
*
* @var string
*/
const ACTION = 'index|show|add|create|edit|update|remove|del|delete|view|item';
/**
* Regular expression for years
*
* @var string
*/
const YEAR = '[12][0-9]{3}';
/**
* Regular expression for months
*
* @var string
*/
const MONTH = '0[1-9]|1[012]';
/**
* Regular expression for days
*
* @var string
*/
const DAY = '0[1-9]|[12][0-9]|3[01]';
/**
* Regular expression for auto increment IDs
*
* @var string
*/
const ID = '[0-9]+';
/**
* Regular expression for UUIDs
*
* @var string
*/
const UUID = '[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}';
/**
* The route collection routes would be added to.
*
* @var \Cake\Routing\RouteCollection
*/
protected static $_collection;
/**
* A hash of request context data.
*
* @var array
*/
protected static $_requestContext = [];
/**
* Named expressions
*
* @var array
*/
protected static $_namedExpressions = [
'Action' => Router::ACTION,
'Year' => Router::YEAR,
'Month' => Router::MONTH,
'Day' => Router::DAY,
'ID' => Router::ID,
'UUID' => Router::UUID
];
/**
* Maintains the request object stack for the current request.
* This will contain more than one request object when requestAction is used.
*
* @var array
*/
protected static $_requests = [];
/**
* Initial state is populated the first time reload() is called which is at the bottom
* of this file. This is a cheat as get_class_vars() returns the value of static vars even if they
* have changed.
*
* @var array
*/
protected static $_initialState = [];
/**
* The stack of URL filters to apply against routing URLs before passing the
* parameters to the route collection.
*
* @var callable[]
*/
protected static $_urlFilters = [];
/**
* Default extensions defined with Router::extensions()
*
* @var array
*/
protected static $_defaultExtensions = [];
/**
* Get or set default route class.
*
* @param string|null $routeClass Class name.
* @return string|null
*/
public static function defaultRouteClass($routeClass = null)
{
if ($routeClass === null) {
return static::$_defaultRouteClass;
}
static::$_defaultRouteClass = $routeClass;
}
/**
* Gets the named route patterns for use in config/routes.php
*
* @return array Named route elements
* @see \Cake\Routing\Router::$_namedExpressions
*/
public static function getNamedExpressions()
{
return static::$_namedExpressions;
}
/**
* Connects a new Route in the router.
*
* Compatibility proxy to \Cake\Routing\RouteBuilder::connect() in the `/` scope.
*
* @param string $route A string describing the template of the route
* @param array $defaults An array describing the default route parameters. These parameters will be used by default
* and can supply routing parameters that are not dynamic. See above.
* @param array $options An array matching the named elements in the route to regular expressions which that
* element should match. Also contains additional parameters such as which routed parameters should be
* shifted into the passed arguments, supplying patterns for routing parameters and supplying the name of a
* custom routing class.
* @return void
* @throws \Cake\Core\Exception\Exception
* @see \Cake\Routing\RouteBuilder::connect()
* @see \Cake\Routing\Router::scope()
*/
public static function connect($route, $defaults = [], $options = [])
{
static::$initialized = true;
static::scope('/', function ($routes) use ($route, $defaults, $options) {
$routes->connect($route, $defaults, $options);
});
}
/**
* Connects a new redirection Route in the router.
*
* Compatibility proxy to \Cake\Routing\RouteBuilder::redirect() in the `/` scope.
*
* @param string $route A string describing the template of the route
* @param array $url A URL to redirect to. Can be a string or a Cake array-based URL
* @param array $options An array matching the named elements in the route to regular expressions which that
* element should match. Also contains additional parameters such as which routed parameters should be
* shifted into the passed arguments. As well as supplying patterns for routing parameters.
* @return void
* @see \Cake\Routing\RouteBuilder::redirect()
* @deprecated 3.3.0 Use Router::scope() and RouteBuilder::redirect() instead.
*/
public static function redirect($route, $url, $options = [])
{
if (is_string($url)) {
$url = ['redirect' => $url];
}
if (!isset($options['routeClass'])) {
$options['routeClass'] = 'Cake\Routing\Route\RedirectRoute';
}
static::connect($route, $url, $options);
}
/**
* Generate REST resource routes for the given controller(s).
*
* Compatibility proxy to \Cake\Routing\RouteBuilder::resources(). Additional, compatibility
* around prefixes and plugins and prefixes is handled by this method.
*
* A quick way to generate a default routes to a set of REST resources (controller(s)).
*
* ### Usage
*
* Connect resource routes for an app controller:
*
* ```
* Router::mapResources('Posts');
* ```
*
* Connect resource routes for the Comment controller in the
* Comments plugin:
*
* ```
* Router::mapResources('Comments.Comment');
* ```
*
* Plugins will create lower_case underscored resource routes. e.g
* `/comments/comment`
*
* Connect resource routes for the Posts controller in the
* Admin prefix:
*
* ```
* Router::mapResources('Posts', ['prefix' => 'admin']);
* ```
*
* Prefixes will create lower_case underscored resource routes. e.g
* `/admin/posts`
*
* ### Options:
*
* - 'id' - The regular expression fragment to use when matching IDs. By default, matches
* integer values and UUIDs.
* - 'prefix' - Routing prefix to use for the generated routes. Defaults to ''.
* Using this option will create prefixed routes, similar to using Routing.prefixes.
* - 'only' - Only connect the specific list of actions.
* - 'actions' - Override the method names used for connecting actions.
* - 'map' - Additional resource routes that should be connected. If you define 'only' and 'map',
* make sure that your mapped methods are also in the 'only' list.
* - 'path' - Change the path so it doesn't match the resource name. E.g ArticlesController
* is available at `/posts`
*
* @param string|array $controller A controller name or array of controller names (i.e. "Posts" or "ListItems")
* @param array $options Options to use when generating REST routes
* @see \Cake\Routing\RouteBuilder::resources()
* @deprecated 3.3.0 Use Router::scope() and RouteBuilder::resources() instead.
* @return void
*/
public static function mapResources($controller, $options = [])
{
foreach ((array)$controller as $name) {
list($plugin, $name) = pluginSplit($name);
$prefix = $pluginUrl = false;
if (!empty($options['prefix'])) {
$prefix = $options['prefix'];
unset($options['prefix']);
}
if ($plugin) {
$pluginUrl = Inflector::underscore($plugin);
}
$callback = function ($routes) use ($name, $options) {
$routes->resources($name, $options);
};
if ($plugin && $prefix) {
$path = '/' . implode('/', [$prefix, $pluginUrl]);
$params = ['prefix' => $prefix, 'plugin' => $plugin];
static::scope($path, $params, $callback);
return;
}
if ($prefix) {
static::prefix($prefix, $callback);
return;
}
if ($plugin) {
static::plugin($plugin, $callback);
return;
}
static::scope('/', $callback);
return;
}
}
/**
* Parses given URL string. Returns 'routing' parameters for that URL.
*
* @param string $url URL to be parsed.
* @param string $method The HTTP method being used.
* @return array Parsed elements from URL.
* @throws \Cake\Routing\Exception\MissingRouteException When a route cannot be handled
* @deprecated 3.4.0 Use Router::parseRequest() instead.
*/
public static function parse($url, $method = '')
{
if (!static::$initialized) {
static::_loadRoutes();
}
if (strpos($url, '/') !== 0) {
$url = '/' . $url;
}
return static::$_collection->parse($url, $method);
}
/**
* Get the routing parameters for the request is possible.
*
* @param \Psr\Http\Message\ServerRequestInterface $request The request to parse request data from.
* @return array Parsed elements from URL.
* @throws \Cake\Routing\Exception\MissingRouteException When a route cannot be handled
*/
public static function parseRequest(ServerRequestInterface $request)
{
if (!static::$initialized) {
static::_loadRoutes();
}
return static::$_collection->parseRequest($request);
}
/**
* Takes parameter and path information back from the Dispatcher, sets these
* parameters as the current request parameters that are merged with URL arrays
* created later in the request.
*
* Nested requests will create a stack of requests. You can remove requests using
* Router::popRequest(). This is done automatically when using Object::requestAction().
*
* Will accept either a Cake\Http\ServerRequest object or an array of arrays. Support for
* accepting arrays may be removed in the future.
*
* @param \Cake\Http\ServerRequest|array $request Parameters and path information or a Cake\Http\ServerRequest object.
* @return void
*/
public static function setRequestInfo($request)
{
if ($request instanceof ServerRequest) {
static::pushRequest($request);
} else {
$requestData = $request;
$requestData += [[], []];
$requestData[0] += [
'controller' => false,
'action' => false,
'plugin' => null
];
$request = new ServerRequest();
$request->addParams($requestData[0])->addPaths($requestData[1]);
static::pushRequest($request);
}
}
/**
* Push a request onto the request stack. Pushing a request
* sets the request context used when generating URLs.
*
* @param \Cake\Http\ServerRequest $request Request instance.
* @return void
*/
public static function pushRequest(ServerRequest $request)
{
static::$_requests[] = $request;
static::setRequestContext($request);
}
/**
* Store the request context for a given request.
*
* @param \Psr\Http\Message\ServerRequestInterface $request The request instance.
* @return void
* @throws InvalidArgumentException When parameter is an incorrect type.
*/
public static function setRequestContext(ServerRequestInterface $request)
{
$uri = $request->getUri();
static::$_requestContext = [
'_base' => $request->getAttribute('base'),
'_port' => $uri->getPort(),
'_scheme' => $uri->getScheme(),
'_host' => $uri->getHost(),
];
}
/**
* Pops a request off of the request stack. Used when doing requestAction
*
* @return \Cake\Http\ServerRequest The request removed from the stack.
* @see \Cake\Routing\Router::pushRequest()
* @see \Cake\Routing\RequestActionTrait::requestAction()
*/
public static function popRequest()
{
$removed = array_pop(static::$_requests);
$last = end(static::$_requests);
if ($last) {
static::setRequestContext($last);
reset(static::$_requests);
}
return $removed;
}
/**
* Get the current request object, or the first one.
*
* @param bool $current True to get the current request, or false to get the first one.
* @return \Cake\Http\ServerRequest|null
*/
public static function getRequest($current = false)
{
if ($current) {
$request = end(static::$_requests);
return $request ?: null;
}
return isset(static::$_requests[0]) ? static::$_requests[0] : null;
}
/**
* Reloads default Router settings. Resets all class variables and
* removes all connected routes.
*
* @return void
*/
public static function reload()
{
if (empty(static::$_initialState)) {
static::$_collection = new RouteCollection();
static::$_initialState = get_class_vars(get_called_class());
return;
}
foreach (static::$_initialState as $key => $val) {
if ($key !== '_initialState') {
static::${$key} = $val;
}
}
static::$_collection = new RouteCollection();
}
/**
* Add a URL filter to Router.
*
* URL filter functions are applied to every array $url provided to
* Router::url() before the URLs are sent to the route collection.
*
* Callback functions should expect the following parameters:
*
* - `$params` The URL params being processed.
* - `$request` The current request.
*
* The URL filter function should *always* return the params even if unmodified.
*
* ### Usage
*
* URL filters allow you to easily implement features like persistent parameters.
*
* ```
* Router::addUrlFilter(function ($params, $request) {
* if ($request->getParam('lang') && !isset($params['lang'])) {
* $params['lang'] = $request->getParam('lang');
* }
* return $params;
* });
* ```
*
* @param callable $function The function to add
* @return void
*/
public static function addUrlFilter(callable $function)
{
static::$_urlFilters[] = $function;
}
/**
* Applies all the connected URL filters to the URL.
*
* @param array $url The URL array being modified.
* @return array The modified URL.
* @see \Cake\Routing\Router::url()
* @see \Cake\Routing\Router::addUrlFilter()
*/
protected static function _applyUrlFilters($url)
{
$request = static::getRequest(true);
foreach (static::$_urlFilters as $filter) {
$url = $filter($url, $request);
}
return $url;
}
/**
* Finds URL for specified action.
*
* Returns a URL pointing to a combination of controller and action.
*
* ### Usage
*
* - `Router::url('/posts/edit/1');` Returns the string with the base dir prepended.
* This usage does not use reverser routing.
* - `Router::url(['controller' => 'posts', 'action' => 'edit']);` Returns a URL
* generated through reverse routing.
* - `Router::url(['_name' => 'custom-name', ...]);` Returns a URL generated
* through reverse routing. This form allows you to leverage named routes.
*
* There are a few 'special' parameters that can change the final URL string that is generated
*
* - `_base` - Set to false to remove the base path from the generated URL. If your application
* is not in the root directory, this can be used to generate URLs that are 'cake relative'.
* cake relative URLs are required when using requestAction.
* - `_scheme` - Set to create links on different schemes like `webcal` or `ftp`. Defaults
* to the current scheme.
* - `_host` - Set the host to use for the link. Defaults to the current host.
* - `_port` - Set the port if you need to create links on non-standard ports.
* - `_full` - If true output of `Router::fullBaseUrl()` will be prepended to generated URLs.
* - `#` - Allows you to set URL hash fragments.
* - `_ssl` - Set to true to convert the generated URL to https, or false to force http.
* - `_name` - Name of route. If you have setup named routes you can use this key
* to specify it.
*
* @param string|array|null $url An array specifying any of the following:
* 'controller', 'action', 'plugin' additionally, you can provide routed
* elements or query string parameters. If string it can be name any valid url
* string.
* @param bool $full If true, the full base URL will be prepended to the result.
* Default is false.
* @return string Full translated URL with base path.
* @throws \Cake\Core\Exception\Exception When the route name is not found
*/
public static function url($url = null, $full = false)
{
if (!static::$initialized) {
static::_loadRoutes();
}
$params = [
'plugin' => null,
'controller' => null,
'action' => 'index',
'_ext' => null,
];
$here = $base = $output = $frag = null;
// In 4.x this should be replaced with state injected via setRequestContext
$request = static::getRequest(true);
if ($request) {
$params = $request->params;
$here = $request->here;
$base = $request->getAttribute('base');
} else {
$base = Configure::read('App.base');
if (isset(static::$_requestContext['_base'])) {
$base = static::$_requestContext['_base'];
}
}
if (empty($url)) {
$output = isset($here) ? $here : $base . '/';
if ($full) {
$output = static::fullBaseUrl() . $output;
}
return $output;
}
if (is_array($url)) {
if (isset($url['_full']) && $url['_full'] === true) {
$full = true;
unset($url['_full']);
}
if (isset($url['#'])) {
$frag = '#' . $url['#'];
unset($url['#']);
}
if (isset($url['_ssl'])) {
$url['_scheme'] = ($url['_ssl'] === true) ? 'https' : 'http';
unset($url['_ssl']);
}
$url = static::_applyUrlFilters($url);
if (!isset($url['_name'])) {
// Copy the current action if the controller is the current one.
if (empty($url['action']) &&
(empty($url['controller']) || $params['controller'] === $url['controller'])
) {
$url['action'] = $params['action'];
}
// Keep the current prefix around if none set.
if (isset($params['prefix']) && !isset($url['prefix'])) {
$url['prefix'] = $params['prefix'];
}
$url += [
'plugin' => $params['plugin'],
'controller' => $params['controller'],
'action' => 'index',
'_ext' => null
];
}
$output = static::$_collection->match($url, static::$_requestContext + ['params' => $params]);
} else {
$plainString = (
strpos($url, 'javascript:') === 0 ||
strpos($url, 'mailto:') === 0 ||
strpos($url, 'tel:') === 0 ||
strpos($url, 'sms:') === 0 ||
strpos($url, '#') === 0 ||
strpos($url, '?') === 0 ||
strpos($url, '//') === 0 ||
strpos($url, '://') !== false
);
if ($plainString) {
return $url;
}
$output = $base . $url;
}
$protocol = preg_match('#^[a-z][a-z0-9+\-.]*\://#i', $output);
if ($protocol === 0) {
$output = str_replace('//', '/', '/' . $output);
if ($full) {
$output = static::fullBaseUrl() . $output;
}
}
return $output . $frag;
}
/**
* Finds URL for specified action.
*
* Returns a bool if the url exists
*
* ### Usage
*
* @see Router::url()
*
* @param string|array|null $url An array specifying any of the following:
* 'controller', 'action', 'plugin' additionally, you can provide routed
* elements or query string parameters. If string it can be name any valid url
* string.
* @param bool $full If true, the full base URL will be prepended to the result.
* Default is false.
* @return bool
*/
public static function routeExists($url = null, $full = false)
{
try {
$route = static::url($url, $full);
return true;
} catch (MissingRouteException $e) {
return false;
}
}
/**
* Sets the full base URL that will be used as a prefix for generating
* fully qualified URLs for this application. If not parameters are passed,
* the currently configured value is returned.
*
* ### Note:
*
* If you change the configuration value `App.fullBaseUrl` during runtime
* and expect the router to produce links using the new setting, you are
* required to call this method passing such value again.
*
* @param string|null $base the prefix for URLs generated containing the domain.
* For example: `http://example.com`
* @return string
*/
public static function fullBaseUrl($base = null)
{
if ($base !== null) {
static::$_fullBaseUrl = $base;
Configure::write('App.fullBaseUrl', $base);
}
if (empty(static::$_fullBaseUrl)) {
static::$_fullBaseUrl = Configure::read('App.fullBaseUrl');
}
return static::$_fullBaseUrl;
}
/**
* Reverses a parsed parameter array into an array.
*
* Works similarly to Router::url(), but since parsed URL's contain additional
* 'pass' as well as 'url.url' keys. Those keys need to be specially
* handled in order to reverse a params array into a string URL.
*
* This will strip out 'autoRender', 'bare', 'requested', and 'return' param names as those
* are used for CakePHP internals and should not normally be part of an output URL.
*
* @param \Cake\Http\ServerRequest|array $params The params array or
* Cake\Http\ServerRequest object that needs to be reversed.
* @return array The URL array ready to be used for redirect or HTML link.
*/
public static function reverseToArray($params)
{
$url = [];
if ($params instanceof ServerRequest) {
$url = $params->query;
$params = $params->params;
} elseif (isset($params['url'])) {
$url = $params['url'];
}
$pass = isset($params['pass']) ? $params['pass'] : [];
unset(
$params['pass'],
$params['paging'],
$params['models'],
$params['url'],
$url['url'],
$params['autoRender'],
$params['bare'],
$params['requested'],
$params['return'],
$params['_Token'],
$params['_matchedRoute']
);
$params = array_merge($params, $pass);
if (!empty($url)) {
$params['?'] = $url;
}
return $params;
}
/**
* Reverses a parsed parameter array into a string.
*
* Works similarly to Router::url(), but since parsed URL's contain additional
* 'pass' as well as 'url.url' keys. Those keys need to be specially
* handled in order to reverse a params array into a string URL.
*
* This will strip out 'autoRender', 'bare', 'requested', and 'return' param names as those
* are used for CakePHP internals and should not normally be part of an output URL.
*
* @param \Cake\Http\ServerRequest|array $params The params array or
* Cake\Network\Request object that needs to be reversed.
* @param bool $full Set to true to include the full URL including the
* protocol when reversing the URL.
* @return string The string that is the reversed result of the array
*/
public static function reverse($params, $full = false)
{
$params = static::reverseToArray($params);
return static::url($params, $full);
}
/**
* Normalizes a URL for purposes of comparison.
*
* Will strip the base path off and replace any double /'s.
* It will not unify the casing and underscoring of the input value.
*
* @param array|string $url URL to normalize Either an array or a string URL.
* @return string Normalized URL
*/
public static function normalize($url = '/')
{
if (is_array($url)) {
$url = static::url($url);
}
if (preg_match('/^[a-z\-]+:\/\//', $url)) {
return $url;
}
$request = static::getRequest();
if (!empty($request->base) && stristr($url, $request->base)) {
$url = preg_replace('/^' . preg_quote($request->base, '/') . '/', '', $url, 1);
}
$url = '/' . $url;
while (strpos($url, '//') !== false) {
$url = str_replace('//', '/', $url);
}
$url = preg_replace('/(?:(\/$))/', '', $url);
if (empty($url)) {
return '/';
}
return $url;
}
/**
* Get or set valid extensions for all routes connected later.
*
* Instructs the router to parse out file extensions
* from the URL. For example, http://example.com/posts.rss would yield a file
* extension of "rss". The file extension itself is made available in the
* controller as `$this->request->getParam('_ext')`, and is used by the RequestHandler
* component to automatically switch to alternate layouts and templates, and
* load helpers corresponding to the given content, i.e. RssHelper. Switching
* layouts and helpers requires that the chosen extension has a defined mime type
* in `Cake\Http\Response`.
*
* A string or an array of valid extensions can be passed to this method.
* If called without any parameters it will return current list of set extensions.
*
* @param array|string|null $extensions List of extensions to be added.
* @param bool $merge Whether to merge with or override existing extensions.
* Defaults to `true`.
* @return array Array of extensions Router is configured to parse.
*/
public static function extensions($extensions = null, $merge = true)
{
$collection = static::$_collection;
if ($extensions === null) {
if (!static::$initialized) {
static::_loadRoutes();
}
return array_unique(array_merge(static::$_defaultExtensions, $collection->getExtensions()));
}
$extensions = (array)$extensions;
if ($merge) {
$extensions = array_unique(array_merge(static::$_defaultExtensions, $extensions));
}
return static::$_defaultExtensions = $extensions;
}
/**
* Provides legacy support for named parameters on incoming URLs.
*
* Checks the passed parameters for elements containing `$options['separator']`
* Those parameters are split and parsed as if they were old style named parameters.
*
* The parsed parameters will be moved from params['pass'] to params['named'].
*
* ### Options
*
* - `separator` The string to use as a separator. Defaults to `:`.
*
* @param \Cake\Http\ServerRequest $request The request object to modify.
* @param array $options The array of options.
* @return \Cake\Http\ServerRequest The modified request
* @deprecated 3.3.0 Named parameter backwards compatibility will be removed in 4.0.
*/
public static function parseNamedParams(ServerRequest $request, array $options = [])
{
$options += ['separator' => ':'];
if (empty($request->params['pass'])) {
$request->params['named'] = [];
return $request;
}
$named = [];
foreach ($request->getParam('pass') as $key => $value) {
if (strpos($value, $options['separator']) === false) {
continue;
}
unset($request->params['pass'][$key]);
list($key, $value) = explode($options['separator'], $value, 2);
if (preg_match_all('/\[([A-Za-z0-9_-]+)?\]/', $key, $matches, PREG_SET_ORDER)) {
$matches = array_reverse($matches);
$parts = explode('[', $key);
$key = array_shift($parts);
$arr = $value;
foreach ($matches as $match) {
if (empty($match[1])) {
$arr = [$arr];
} else {
$arr = [
$match[1] => $arr
];
}
}
$value = $arr;
}
$named = array_merge_recursive($named, [$key => $value]);
}
$request->params['named'] = $named;
return $request;
}
/**
* Create a RouteBuilder for the provided path.
*
* @param string $path The path to set the builder to.
* @param array $options The options for the builder
* @return \Cake\Routing\RouteBuilder
*/
public static function createRouteBuilder($path, array $options = [])
{
$defaults = [
'routeClass' => static::defaultRouteClass(),
'extensions' => static::$_defaultExtensions,
];
$options += $defaults;
return new RouteBuilder(static::$_collection, $path, [], [
'routeClass' => $options['routeClass'],
'extensions' => $options['extensions'],
]);
}
/**
* Create a routing scope.
*
* Routing scopes allow you to keep your routes DRY and avoid repeating
* common path prefixes, and or parameter sets.
*
* Scoped collections will be indexed by path for faster route parsing. If you
* re-open or re-use a scope the connected routes will be merged with the
* existing ones.
*
* ### Options
*
* The `$params` array allows you to define options for the routing scope.
* The options listed below *are not* available to be used as routing defaults
*
* - `routeClass` The route class to use in this scope. Defaults to
* `Router::defaultRouteClass()`
* - `extensions` The extensions to enable in this scope. Defaults to the globally
* enabled extensions set with `Router::extensions()`
*
* ### Example
*
* ```
* Router::scope('/blog', ['plugin' => 'Blog'], function ($routes) {
* $routes->connect('/', ['controller' => 'Articles']);
* });
* ```
*
* The above would result in a `/blog/` route being created, with both the
* plugin & controller default parameters set.
*
* You can use `Router::plugin()` and `Router::prefix()` as shortcuts to creating
* specific kinds of scopes.
*
* @param string $path The path prefix for the scope. This path will be prepended
* to all routes connected in the scoped collection.
* @param array|callable $params An array of routing defaults to add to each connected route.
* If you have no parameters, this argument can be a callable.