Класс RoutingMiddleware
Применяет правила маршрутизации к запросу и создаёт экземпляр контроллера, если это возможно.
Константы
-
stringROUTE_COLLECTION_CACHE_KEY'routeCollection'
Ключ, используемый для хранения коллекции маршрутов в кэше.
Краткое описание свойств
- $app protected
Cake\Routing\RoutingApplicationInterfaceПриложение, для которого будут вызваны маршрутизационные методы.
- $cacheConfig protected
string|nullИмя конфигурации кэша для кэширования коллекции маршрутов; null для отключения кэширования.
Краткое описание методов
-
__construct() public
Конструктор
-
buildRouteCollection() protected
Проверяет, включен ли кэш маршрутов, и использует настроенный кэш для запоминания коллекции маршрутов.
-
loadRoutes() protected
Вызывает хук routes() приложения, если приложение существует и Router не инициализирован. Использует кэш маршрутов, если он включён через параметр конфигурации "Router.cache".
Если middleware создан без Application, маршруты будут загружены через автоматическую загрузку маршрутов, предшествующую хуку routes().
-
prepareRouteCollection() protected
Генерирует коллекцию маршрутов с помощью билдера.
-
process() public
Применяет маршрутизацию и обновляет запрос.
Любой middleware, специфичный для маршрута/пути, будет обернут вокруг $next, а затем будет вызван новый стек middleware.
Подробное описание методов
__construct() public
__construct(Cake\Routing\RoutingApplicationInterface $app, string|null $cacheConfig = null)
Конструктор
Параметры
-
Cake\Routing\RoutingApplicationInterface$app Экземпляр приложения, на котором определены маршруты.
-
string|null$cacheConfig optional Имя конфигурации кэша для использования или null для отключения кэширования маршрутов.
buildRouteCollection() protected
buildRouteCollection(): Cake\Routing\RouteCollection
Проверяет, включен ли кэш маршрутов, и использует настроенный кэш для запоминания коллекции маршрутов.
Возвращает
Cake\Routing\RouteCollectionloadRoutes() protected
loadRoutes(): void
Вызывает хук routes() приложения, если приложение существует и Router не инициализирован. Использует кэш маршрутов, если он включён через параметр конфигурации "Router.cache".
Если middleware создан без Application, маршруты будут загружены через автоматическую загрузку маршрутов, предшествующую хуку routes().
Возвращает
voidprepareRouteCollection() protected
prepareRouteCollection(): Cake\Routing\RouteCollection
Генерирует коллекцию маршрутов с помощью билдера.
Возвращает
Cake\Routing\RouteCollectionprocess() public
process(ServerRequestInterface $request, RequestHandlerInterface $handler): Psr\Http\Message\ResponseInterface
Применяет маршрутизацию и обновляет запрос.
Любой middleware, специфичный для маршрута/пути, будет обернут вокруг $next, а затем будет вызван новый стек middleware.
Параметры
-
ServerRequestInterface$request Запрос.
-
RequestHandlerInterface$handler Обработчик запроса.
Возвращает
Psr\Http\Message\ResponseInterfaceПодробное описание свойств
$app protected
Приложение, для которого будут вызваны маршрутизационные методы.
Тип
Cake\Routing\RoutingApplicationInterface$cacheConfig protected
Имя конфигурации кэша для кэширования коллекции маршрутов; null для отключения кэширования.
Тип
string|null
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.2/class-Cake.Routing.Middleware.RoutingMiddleware.html
