1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
/** |
4
|
|
|
* Platine Framework |
5
|
|
|
* |
6
|
|
|
* Platine Framework is a lightweight, high-performance, simple and elegant |
7
|
|
|
* PHP Web framework |
8
|
|
|
* |
9
|
|
|
* This content is released under the MIT License (MIT) |
10
|
|
|
* |
11
|
|
|
* Copyright (c) 2020 Platine Framework |
12
|
|
|
* |
13
|
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy |
14
|
|
|
* of this software and associated documentation files (the "Software"), to deal |
15
|
|
|
* in the Software without restriction, including without limitation the rights |
16
|
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
17
|
|
|
* copies of the Software, and to permit persons to whom the Software is |
18
|
|
|
* furnished to do so, subject to the following conditions: |
19
|
|
|
* |
20
|
|
|
* The above copyright notice and this permission notice shall be included in all |
21
|
|
|
* copies or substantial portions of the Software. |
22
|
|
|
* |
23
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
24
|
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
25
|
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
26
|
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
27
|
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
28
|
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
29
|
|
|
* SOFTWARE. |
30
|
|
|
*/ |
31
|
|
|
|
32
|
|
|
/** |
33
|
|
|
* @file RouteCommand.php |
34
|
|
|
* |
35
|
|
|
* The Route management command class |
36
|
|
|
* |
37
|
|
|
* @package Platine\Framework\Console\Command |
38
|
|
|
* @author Platine Developers team |
39
|
|
|
* @copyright Copyright (c) 2020 |
40
|
|
|
* @license http://opensource.org/licenses/MIT MIT License |
41
|
|
|
* @link https://www.platine-php.com |
42
|
|
|
* @version 1.0.0 |
43
|
|
|
* @filesource |
44
|
|
|
*/ |
45
|
|
|
|
46
|
|
|
declare(strict_types=1); |
47
|
|
|
|
48
|
|
|
namespace Platine\Framework\Console\Command; |
49
|
|
|
|
50
|
|
|
use Platine\Config\Config; |
51
|
|
|
use Platine\Console\Command\Command; |
52
|
|
|
use Platine\Framework\App\Application; |
53
|
|
|
use Platine\Framework\Service\ServiceProvider; |
54
|
|
|
use Platine\Route\Route; |
55
|
|
|
use Platine\Route\Router; |
56
|
|
|
use Platine\Stdlib\Helper\Arr; |
57
|
|
|
use Platine\Stdlib\Helper\Str; |
58
|
|
|
|
59
|
|
|
/** |
60
|
|
|
* @class RouteCommand |
61
|
|
|
* @package Platine\Framework\Console\Command |
62
|
|
|
* @template T |
63
|
|
|
*/ |
64
|
|
|
class RouteCommand extends Command |
65
|
|
|
{ |
66
|
|
|
/** |
67
|
|
|
* Create new instance |
68
|
|
|
* @param Application $application |
69
|
|
|
* @param Config<T> $config |
70
|
|
|
* @param Router $router |
71
|
|
|
*/ |
72
|
|
|
public function __construct( |
73
|
|
|
protected Application $application, |
74
|
|
|
protected Config $config, |
75
|
|
|
protected Router $router |
76
|
|
|
) { |
77
|
|
|
parent::__construct('route', 'Command to manage route'); |
78
|
|
|
|
79
|
|
|
$this->addOption('-l|--list', 'Show route list', null, false); |
80
|
|
|
} |
81
|
|
|
|
82
|
|
|
/** |
83
|
|
|
* {@inheritdoc} |
84
|
|
|
*/ |
85
|
|
|
public function execute(): mixed |
86
|
|
|
{ |
87
|
|
|
if ($this->getOptionValue('list')) { |
88
|
|
|
$this->showRouteList(); |
89
|
|
|
} |
90
|
|
|
|
91
|
|
|
return true; |
92
|
|
|
} |
93
|
|
|
|
94
|
|
|
/** |
95
|
|
|
* Show the route list |
96
|
|
|
* @return void |
97
|
|
|
*/ |
98
|
|
|
protected function showRouteList(): void |
99
|
|
|
{ |
100
|
|
|
$writer = $this->io()->writer(); |
101
|
|
|
|
102
|
|
|
$writer->boldGreen('ROUTE LIST', true)->eol(); |
103
|
|
|
$routeList = $this->config->get('routes', []); |
104
|
|
|
$routeList[0]($this->router); |
105
|
|
|
|
106
|
|
|
//Load providers routes |
107
|
|
|
/** @var ServiceProvider[] $providers */ |
108
|
|
|
$providers = $this->application->getProviders(); |
109
|
|
|
foreach ($providers as $provider) { |
110
|
|
|
$provider->addRoutes($this->router); |
111
|
|
|
} |
112
|
|
|
|
113
|
|
|
$routes = $this->router->routes()->all(); |
114
|
|
|
$rows = []; |
115
|
|
|
foreach ($routes as /** @var Route $route */ $route) { |
116
|
|
|
$handler = Str::stringify($route->getHandler()); |
117
|
|
|
$rows[] = [ |
118
|
|
|
'name' => $route->getName(), |
119
|
|
|
'method' => implode('|', $route->getMethods()), |
120
|
|
|
'path' => $route->getPattern(), |
121
|
|
|
'handler' => $handler, |
122
|
|
|
]; |
123
|
|
|
} |
124
|
|
|
|
125
|
|
|
Arr::multisort($rows, 'path'); |
126
|
|
|
$writer->table($rows); |
127
|
|
|
|
128
|
|
|
$writer->green('Command finished successfully')->eol(); |
129
|
|
|
} |
130
|
|
|
} |
131
|
|
|
|