Класс RoutingMiddleware

Применяет правила маршрутизации к запросу и создаёт экземпляр контроллера, если это возможно.

Пространство имён: Cake\Routing\Middleware
Расположение: Routing/Middleware/RoutingMiddleware.php

Краткое описание констант

string

ROUTE_COLLECTION_CACHE_KEY

'routeCollection'

Краткое описание свойств

$app protected

Cake\Http\BaseApplication|null
Приложение, для которого будет вызван хук маршрутизации.
$cacheConfig protected

string|null

Имя конфигурации кэша для кеширования коллекции маршрутов, null — для отключения кэширования

Краткое описание методов

__construct() public
Конструктор
__invoke() public
Применение маршрутизации и обновление запроса.
buildRouteCollection() protected
Проверка включения кеша маршрутов и использование конфигурированного кэша для «запоминания» коллекции маршрутов
loadRoutes() protected

Вызывает хук routes() приложения, если приложение существует и Router не инициализирован. Использует кэш маршрутов, если он включён параметром конфигурации «Router.cache».
prepareRouteCollection() protected
Генерация коллекции маршрутов с помощью билдера

Подробное описание методов

__construct()source public

__construct( Cake\Http\BaseApplication $app = null , string|null $cacheConfig = null )

Конструктор

Параметры

Cake\Http\BaseApplication $app необязательно null: Экземпляр приложения, на котором определены маршруты.
string|null $cacheConfig необязательно null: Имя конфигурации кэша для использования или null для отключения кэша маршрутов

__invoke()source public

__invoke( Psr\Http\Message\ServerRequestInterface $request , Psr\Http\Message\ResponseInterface $response , callable $next )

Применение маршрутизации и обновление запроса.

Любой специфичный для маршрута/пути мидлвар будет обернут вокруг $next, а затем будет вызван новый стек мидлвар.

Параметры

Psr\Http\Message\ServerRequestInterface $request: Запрос.
Psr\Http\Message\ResponseInterface $response: Ответ.
callable $next: Следующий мидлвар для вызова.

Возвращаемое значение

Psr\Http\Message\ResponseInterface
Ответ.

buildRouteCollection()source protected

buildRouteCollection( )

Проверка включения кеша маршрутов и использование конфигурированного кэша для «запоминания» коллекции маршрутов

Возвращаемое значение

Cake\Routing\RouteCollection

loadRoutes()source protected

loadRoutes( )

Вызывает хук routes() приложения, если приложение существует и Router не инициализирован. Использует кэш маршрутов, если он включён параметром конфигурации «Router.cache».

Если мидлвар создаётся без приложения, маршруты будут загружаться через автоматическую загрузку маршрутов, которая предшествует хуку routes().

prepareRouteCollection()source protected

prepareRouteCollection( )

Генерация коллекции маршрутов с помощью билдера

Возвращаемое значение

Cake\Routing\RouteCollection

Подробное описание свойств

$appsource

protected Cake\Http\BaseApplication|null

Приложение, для которого будет вызван хук маршрутизации.

$cacheConfigsource

protected string|null

Имя конфигурации кэша для кеширования коллекции маршрутов, 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/3.6/class-Cake.Routing.Middleware.RoutingMiddleware.html