DESKTOP-DH6BVPV\chiefsoft
139 lines
4.0 KiB
PHP
139 lines
4.0 KiB
PHP
<?php
|
|
|
|
/**
|
|
* This file is part of CodeIgniter 4 framework.
|
|
*
|
|
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
|
*
|
|
* For the full copyright and license information, please view
|
|
* the LICENSE file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace CodeIgniter\Commands\Utilities\Routes\AutoRouterImproved;
|
|
|
|
use CodeIgniter\Commands\Utilities\Routes\ControllerFinder;
|
|
use CodeIgniter\Commands\Utilities\Routes\FilterCollector;
|
|
|
|
/**
|
|
* Collects data for Auto Routing Improved.
|
|
*/
|
|
final class AutoRouteCollector
|
|
{
|
|
/**
|
|
* @var string namespace to search
|
|
*/
|
|
private string $namespace;
|
|
|
|
private string $defaultController;
|
|
private string $defaultMethod;
|
|
private array $httpMethods;
|
|
|
|
/**
|
|
* List of controllers in Defined Routes that should not be accessed via Auto-Routing.
|
|
*
|
|
* @var class-string[]
|
|
*/
|
|
private array $protectedControllers;
|
|
|
|
/**
|
|
* @param string $namespace namespace to search
|
|
*/
|
|
public function __construct(
|
|
string $namespace,
|
|
string $defaultController,
|
|
string $defaultMethod,
|
|
array $httpMethods,
|
|
array $protectedControllers
|
|
) {
|
|
$this->namespace = $namespace;
|
|
$this->defaultController = $defaultController;
|
|
$this->defaultMethod = $defaultMethod;
|
|
$this->httpMethods = $httpMethods;
|
|
$this->protectedControllers = $protectedControllers;
|
|
}
|
|
|
|
/**
|
|
* @return array<int, array<int, string>>
|
|
* @phpstan-return list<list<string>>
|
|
*/
|
|
public function get(): array
|
|
{
|
|
$finder = new ControllerFinder($this->namespace);
|
|
$reader = new ControllerMethodReader($this->namespace, $this->httpMethods);
|
|
|
|
$tbody = [];
|
|
|
|
foreach ($finder->find() as $class) {
|
|
// Exclude controllers in Defined Routes.
|
|
if (in_array('\\' . $class, $this->protectedControllers, true)) {
|
|
continue;
|
|
}
|
|
|
|
$routes = $reader->read(
|
|
$class,
|
|
$this->defaultController,
|
|
$this->defaultMethod
|
|
);
|
|
|
|
if ($routes === []) {
|
|
continue;
|
|
}
|
|
|
|
$routes = $this->addFilters($routes);
|
|
|
|
foreach ($routes as $item) {
|
|
$tbody[] = [
|
|
strtoupper($item['method']) . '(auto)',
|
|
$item['route'] . $item['route_params'],
|
|
$item['handler'],
|
|
$item['before'],
|
|
$item['after'],
|
|
];
|
|
}
|
|
}
|
|
|
|
return $tbody;
|
|
}
|
|
|
|
private function addFilters($routes)
|
|
{
|
|
$filterCollector = new FilterCollector(true);
|
|
|
|
foreach ($routes as &$route) {
|
|
// Search filters for the URI with all params
|
|
$sampleUri = $this->generateSampleUri($route);
|
|
$filtersLongest = $filterCollector->get($route['method'], $route['route'] . $sampleUri);
|
|
|
|
// Search filters for the URI without optional params
|
|
$sampleUri = $this->generateSampleUri($route, false);
|
|
$filtersShortest = $filterCollector->get($route['method'], $route['route'] . $sampleUri);
|
|
|
|
// Get common array elements
|
|
$filters['before'] = array_intersect($filtersLongest['before'], $filtersShortest['before']);
|
|
$filters['after'] = array_intersect($filtersLongest['after'], $filtersShortest['after']);
|
|
|
|
$route['before'] = implode(' ', array_map('class_basename', $filters['before']));
|
|
$route['after'] = implode(' ', array_map('class_basename', $filters['after']));
|
|
}
|
|
|
|
return $routes;
|
|
}
|
|
|
|
private function generateSampleUri(array $route, bool $longest = true): string
|
|
{
|
|
$sampleUri = '';
|
|
|
|
if (isset($route['params'])) {
|
|
$i = 1;
|
|
|
|
foreach ($route['params'] as $required) {
|
|
if ($longest && ! $required) {
|
|
$sampleUri .= '/' . $i++;
|
|
}
|
|
}
|
|
}
|
|
|
|
return $sampleUri;
|
|
}
|
|
}
|