* * For the full copyright and license information, please view * the LICENSE file that was distributed with this source code. */ namespace CodeIgniter\Commands\Utilities; use CodeIgniter\CLI\BaseCommand; use CodeIgniter\CLI\CLI; use CodeIgniter\Commands\Utilities\Routes\AutoRouteCollector; use CodeIgniter\Commands\Utilities\Routes\AutoRouterImproved\AutoRouteCollector as AutoRouteCollectorImproved; use CodeIgniter\Commands\Utilities\Routes\FilterCollector; use CodeIgniter\Commands\Utilities\Routes\SampleURIGenerator; use CodeIgniter\Router\DefinedRouteCollector; use Config\Feature; use Config\Routing; use Config\Services; /** * Lists all the routes. This will include any Routes files * that can be discovered, and will include routes that are not defined * in routes files, but are instead discovered through auto-routing. */ class Routes extends BaseCommand { /** * The group the command is lumped under * when listing commands. * * @var string */ protected $group = 'CodeIgniter'; /** * The Command's name * * @var string */ protected $name = 'routes'; /** * the Command's short description * * @var string */ protected $description = 'Displays all routes.'; /** * the Command's usage * * @var string */ protected $usage = 'routes'; /** * the Command's Arguments * * @var array */ protected $arguments = []; /** * the Command's Options * * @var array */ protected $options = [ '-h' => 'Sort by Handler.', '--host' => 'Specify hostname in request URI.', ]; /** * Displays the help for the spark cli script itself. */ public function run(array $params) { $sortByHandler = array_key_exists('h', $params); $host = $params['host'] ?? null; // Set HTTP_HOST if ($host) { $request = Services::request(); $_SERVER = $request->getServer(); $_SERVER['HTTP_HOST'] = $host; $request->setGlobal('server', $_SERVER); } $collection = Services::routes()->loadRoutes(); // Reset HTTP_HOST if ($host) { unset($_SERVER['HTTP_HOST']); } $methods = [ 'get', 'head', 'post', 'patch', 'put', 'delete', 'options', 'trace', 'connect', 'cli', ]; $tbody = []; $uriGenerator = new SampleURIGenerator(); $filterCollector = new FilterCollector(); $definedRouteCollector = new DefinedRouteCollector($collection); foreach ($definedRouteCollector->collect() as $route) { $sampleUri = $uriGenerator->get($route['route']); $filters = $filterCollector->get($route['method'], $sampleUri); $routeName = ($route['route'] === $route['name']) ? '»' : $route['name']; $tbody[] = [ strtoupper($route['method']), $route['route'], $routeName, $route['handler'], implode(' ', array_map('class_basename', $filters['before'])), implode(' ', array_map('class_basename', $filters['after'])), ]; } if ($collection->shouldAutoRoute()) { $autoRoutesImproved = config(Feature::class)->autoRoutesImproved ?? false; if ($autoRoutesImproved) { $autoRouteCollector = new AutoRouteCollectorImproved( $collection->getDefaultNamespace(), $collection->getDefaultController(), $collection->getDefaultMethod(), $methods, $collection->getRegisteredControllers('*') ); $autoRoutes = $autoRouteCollector->get(); // Check for Module Routes. if ($routingConfig = config(Routing::class)) { foreach ($routingConfig->moduleRoutes as $uri => $namespace) { $autoRouteCollector = new AutoRouteCollectorImproved( $namespace, $collection->getDefaultController(), $collection->getDefaultMethod(), $methods, $collection->getRegisteredControllers('*'), $uri ); $autoRoutes = [...$autoRoutes, ...$autoRouteCollector->get()]; } } } else { $autoRouteCollector = new AutoRouteCollector( $collection->getDefaultNamespace(), $collection->getDefaultController(), $collection->getDefaultMethod() ); $autoRoutes = $autoRouteCollector->get(); foreach ($autoRoutes as &$routes) { // There is no `auto` method, but it is intentional not to get route filters. $filters = $filterCollector->get('auto', $uriGenerator->get($routes[1])); $routes[] = implode(' ', array_map('class_basename', $filters['before'])); $routes[] = implode(' ', array_map('class_basename', $filters['after'])); } } $tbody = [...$tbody, ...$autoRoutes]; } $thead = [ 'Method', 'Route', 'Name', $sortByHandler ? 'Handler ↓' : 'Handler', 'Before Filters', 'After Filters', ]; // Sort by Handler. if ($sortByHandler) { usort($tbody, static fn ($handler1, $handler2) => strcmp($handler1[3], $handler2[3])); } if ($host) { CLI::write('Host: ' . $host); } CLI::table($tbody, $thead); } }