Repository navigation
Expand file tree
/
Copy pathRoutesShell.php
More file actions
127 lines (120 loc) · 3.71 KB
/
Copy pathRoutesShell.php
File metadata and controls
127 lines (120 loc) · 3.71 KB
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
<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://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. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since 3.1.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Shell;
use Cake\Console\Shell;
use Cake\Core\Configure;
use Cake\Routing\Exception\MissingRouteException;
use Cake\Routing\Router;
/**
* Provides interactive CLI tools for routing.
*
*/
class RoutesShell extends Shell
{
/**
* Override main() to handle action
* Displays all routes in an application.
*
* @return void
*/
public function main()
{
$output = [
['Route name', 'URI template', 'Defaults']
];
foreach (Router::routes() as $route) {
$output[] = [$route->getName(), $route->template, json_encode($route->defaults)];
}
$this->helper('table')->output($output);
}
/**
* Checks a url for the route that will be applied.
*
* @param string $url The URL to parse
* @return null|false
*/
public function check($url)
{
try {
$route = Router::parse($url);
$output = [
['Route name', 'URI template', 'Defaults'],
['', $url, json_encode($route)]
];
$this->helper('table')->output($output);
} catch (MissingRouteException $e) {
$this->err("<warning>'$url' did not match any routes.</warning>");
return false;
}
}
/**
* Generate a URL based on a set of parameters
*
* Takes variadic arguments of key/value pairs.
* @return null|false
*/
public function generate()
{
try {
$args = $this->_splitArgs($this->args);
$url = Router::url($args);
$this->out("> $url");
} catch (MissingRouteException $e) {
$this->err("<warning>The provided parameters do not match any routes.</warning>");
return false;
}
}
/**
* Get the option parser.
*
* @return \Cake\Console\ConsoleOptionParser
*/
public function getOptionParser()
{
$parser = parent::getOptionParser();
$parser->description(
'Get the list of routes connected in this application. ' .
'This tool also lets you test URL generation and URL parsing.'
)->addSubcommand('check', [
'help' => 'Check a URL string against the routes. ' .
'Will output the routing parameters the route resolves to.'
])->addSubcommand('generate', [
'help' => 'Check a routing array against the routes. ' .
"Will output the URL if there is a match.\n\n" .
"Routing parameters should be supplied in a key:value format. " .
"For example `controller:Articles action:view 2`"
]);
return $parser;
}
/**
* Split the CLI arguments into a hash.
*
* @param array $args The arguments to split.
* @return array
*/
protected function _splitArgs($args)
{
$out = [];
foreach ($args as $arg) {
if (strpos($arg, ':') !== false) {
list($key, $value) = explode(':', $arg);
$out[$key] = $value;
} else {
$out[] = $arg;
}
}
return $out;
}
}