-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
RoutesGenerateCommand.php
104 lines (94 loc) · 3 KB
/
RoutesGenerateCommand.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
<?php
declare(strict_types=1);
/**
* 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 3.1.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Command;
use Cake\Console\Arguments;
use Cake\Console\ConsoleIo;
use Cake\Console\ConsoleOptionParser;
use Cake\Routing\Exception\MissingRouteException;
use Cake\Routing\Router;
/**
* Provides interactive CLI tools for URL generation
*/
class RoutesGenerateCommand extends Command
{
/**
* @inheritDoc
*/
public static function defaultName(): string
{
return 'routes generate';
}
/**
* Display all routes in an application
*
* @param \Cake\Console\Arguments $args The command arguments.
* @param \Cake\Console\ConsoleIo $io The console io
* @return int|null The exit code or null for success
*/
public function execute(Arguments $args, ConsoleIo $io): ?int
{
try {
$args = $this->_splitArgs($args->getArguments());
$url = Router::url($args);
$io->out("> $url");
$io->out();
} catch (MissingRouteException) {
$io->err('<warning>The provided parameters do not match any routes.</warning>');
$io->out();
return static::CODE_ERROR;
}
return static::CODE_SUCCESS;
}
/**
* Split the CLI arguments into a hash.
*
* @param list<string> $args The arguments to split.
* @return array<string|bool>
*/
protected function _splitArgs(array $args): array
{
$out = [];
foreach ($args as $arg) {
if (str_contains($arg, ':')) {
[$key, $value] = explode(':', $arg);
if (in_array($value, ['true', 'false'], true)) {
$value = $value === 'true';
}
$out[$key] = $value;
} else {
$out[] = $arg;
}
}
return $out;
}
/**
* Get the option parser.
*
* @param \Cake\Console\ConsoleOptionParser $parser The option parser to update
* @return \Cake\Console\ConsoleOptionParser
*/
public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser
{
$parser->setDescription(
'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;
}
}