Класс Router

_applyUrlFilters()source protected static

_applyUrlFilters( array $url )

Применяет все подключенные фильтры URL к URL.

Параметры

массив $url

Массив URL, который изменяется.

Возвращает

массив
Изменённый URL.

См. также

\Cake\Routing\Router::url()
\Cake\Routing\Router::addUrlFilter()

_loadRoutes()source protected static

_loadRoutes( )

Загружает конфигурацию маршрутов

Устарело

3.5.0 Маршруты будут загружаться через хук Application::routes() в 4.0.0

addUrlFilter()source public static

addUrlFilter( callable $function )

Добавляет фильтр URL в маршрутизатор.

Функции фильтра URL применяются к каждому массиву $url, предоставленному Router::url(), перед отправкой URL в коллекцию маршрутов.

Функции обратного вызова должны ожидать следующие параметры:

• $params Обрабатываемые параметры URL.
• $request Текущий запрос.

Функция фильтра URL всегда должна возвращать параметры, даже если они не изменены.

Использование

Фильтры URL позволяют легко реализовывать такие функции, как постоянные параметры.

Router::addUrlFilter(function ($params, $request) {
 if ($request->getParam('lang') && !isset($params['lang'])) {
   $params['lang'] = $request->getParam('lang');
 }
 return $params;
});

Параметры

вызов $function

Функция, которую нужно добавить

connect()source public static

connect( string $route , array $defaults [] , array $options [] )

Подключает новый маршрут в маршрутизатор.

Провайдер совместимости для \Cake\Routing\RouteBuilder::connect() в области /.

Параметры

строка $route

Строка, описывающая шаблон маршрута

массив $defaults необязательно []

Массив, описывающий параметры маршрута по умолчанию. Эти параметры будут использоваться по умолчанию и могут предоставить параметры маршрутизации, которые не являются динамическими. См. выше.

массив $options необязательно []

Массив, сопоставляющий именованные элементы в маршруте с регулярными выражениями, которым этот элемент должен соответствовать. Также содержит дополнительные параметры, такие как маршрутизация параметров, шаблоны для параметров маршрутизации и имя пользовательского класса маршрутизации.

Исключения

Cake\Core\Exception\Exception

См. также

\Cake\Routing\RouteBuilder::connect()
\Cake\Routing\Router::scope()

createRouteBuilder()source public static

createRouteBuilder( string $path , array $options [] )

Создаёт RouteBuilder для указанного пути.

Параметры

строка $path

Путь, для которого необходимо установить билдер.

массив $options необязательно []

Параметры билдера

Возвращает

Cake\Routing\RouteBuilder

defaultRouteClass()source public static

defaultRouteClass( string|null $routeClass null )

Получение или установка по умолчанию класса маршрута.

Параметры

строка|null $routeClass необязательно null

Имя класса.

Возвращает

строка|null

extensions()source public static

extensions( array|string|null $extensions null , boolean $merge true )

Получить или установить допустимые расширения для всех маршрутов, подключённых позже.

Инструктирует маршрутизатор извлекать расширения файлов из URL. Например, http://example.com/posts.rss даст расширение файла "rss". Само расширение файла становится доступным в контроллере как $this->request->getParam('_ext'), и используется компонентом RequestHandler для автоматического переключения на альтернативные макеты и шаблоны, а также для загрузки помощников, соответствующих данному содержимому, например, RssHelper. Для переключения макетов и помощников необходимо, чтобы выбранное расширение имело определённый MIME-тип в Cake\Http\Response.

В этот метод можно передать строку или массив допустимых расширений. Если метод вызывается без параметров, он вернёт текущий список установленных расширений.

Параметры

array|string|null $extensions опционально null

Список расширений, которые нужно добавить.

boolean $merge опционально true

Флаг, определяющий, нужно ли объединить с существующими расширениями или переопределить их. По умолчанию true.

Возвращает

array
Массив расширений, с которыми настроен маршрутизатор.

fullBaseUrl()source public static

fullBaseUrl( string|null $base null )

Устанавливает полный базовый URL, который будет использоваться в качестве префикса для генерации полных URL-адресов для данного приложения. Если не переданы параметры, возвращается текущее значение.

Примечание:

Если вы изменяете значение конфигурации App.fullBaseUrl во время выполнения и ожидаете, что маршрутизатор будет генерировать ссылки с использованием нового значения, необходимо повторно вызвать этот метод, передав это значение.

Параметры

string|null $base опционально null

Префикс для URL-адресов, генерируемых, содержащий домен. Например: http://example.com

Возвращает

string

getNamedExpressions()source public static

getNamedExpressions( )

Получает именованные шаблоны маршрутов для использования в config/routes.php

Возвращает

array
Элементы именованных маршрутов

См. также

\Cake\Routing\Router::$_namedExpressions

getRequest()source public static

getRequest( boolean $current false )

Получить текущий объект запроса или первый.

Параметры

boolean $current опционально false

True, чтобы получить текущий запрос, или false, чтобы получить первый.

Возвращает

Cake\Http\ServerRequest|null

getRouteCollection()source public static

getRouteCollection( )

Получить RouteCollection внутри Router

Возвращает

Cake\Routing\RouteCollection

mapResources()source public static

mapResources( string|array $controller , array $options [] )

Генерировать маршруты REST-ресурсов для заданного(ых) контроллера(ов).

Продвинутый прокси-сервер для \Cake\Routing\RouteBuilder::resources(). Дополнительная совместимость по поводу префиксов, плагинов и префиксов обрабатывается этим методом.

Быстрый способ сгенерировать стандартные маршруты для набора REST-ресурсов (контроллера(ов)).

Использование

Подключить маршруты ресурсов для контроллера приложения:

Router::mapResources('Posts');

Подключить маршруты ресурсов для контроллера Comment в плагине Comments:

Router::mapResources('Comments.Comment');

Плагины создают маршруты ресурсов с нижним регистром и подчеркиванием. Например /comments/comment

Подключить маршруты ресурсов для контроллера Posts в префиксе Admin:

Router::mapResources('Posts', ['prefix' => 'admin']);

Префиксы создают маршруты ресурсов с нижним регистром и подчеркиванием. Например /admin/posts

Параметры:

• 'id' - Часть регулярного выражения для сопоставления идентификаторов. По умолчанию соответствует целочисленным значениям и UUID.
• 'prefix' - Префикс маршрутизации для используемых сгенерированных маршрутов. По умолчанию ''. Используя этот параметр, будут созданы префиксные маршруты, аналогично использованию Routing.prefixes.
• 'only' - Подключать только указанный список действий.
• 'actions' - Переопределить имена методов, используемые для подключения действий.
• 'map' - Дополнительные маршруты ресурсов, которые нужно подключить. Если вы определяете 'only' и 'map', убедитесь, что ваши сопоставленные методы также находятся в списке 'only'.
• 'path' - Изменить путь так, чтобы он не соответствовал имени ресурса. Например, ArticlesController доступен по адресу /posts

Устаревший

3.3.0 Используйте Router::scope() и RouteBuilder::resources() вместо этого.

Параметры

string|array $controller

Имя контроллера или массив имён контроллеров (например, "Posts" или "ListItems")

array $options опционально []

Параметры для использования при генерации маршрутов REST

См. также

\Cake\Routing\RouteBuilder::resources()

normalize()source public static

normalize( array|string $url '/' )

Нормализует URL для сравнения.

Удалит базовый путь и заменит все двойные слэши. Не будет унифицировать регистр и подчеркивание входного значения.

Параметры

array|string $url опционально '/'

URL для нормализации. Может быть массивом или строкой URL.

Возвращает

string
Нормализованный URL

parse()source public static

parse( string $url , string $method '' )

Парсит заданную строку URL. Возвращает параметры 'routing' для этого URL.

Устаревший

3.4.0 Используйте Router::parseRequest() вместо этого.

Параметры

string $url

URL для парсинга.

string $method опционально ''

Метод HTTP, используемый.

Возвращает

array
Разбор элементов из URL.

Выбрасывает

Cake\Routing\Exception\MissingRouteException
При невозможности обработки маршрута

parseNamedParams()source public static

parseNamedParams( Cake\Http\ServerRequest $request , array $options [] )

Обеспечивает обратную совместимость с именованными параметрами в входящих URL.

Проверяет переданные параметры на наличие элементов, содержащих $options['separator']. Эти параметры разбиваются и анализируются так, как будто они были именованными параметрами старого стиля.

Анализируемые параметры будут перемещены из params['pass'] в params['named'].

Параметры

• separator Строка, используемая в качестве разделителя. По умолчанию :.

Устаревший

3.3.0 Обратная совместимость с именованными параметрами будет удалена в версии 4.0.

Параметры

Cake\Http\ServerRequest $request

Объект запроса для модификации.

array $options опционально []

Массив параметров.

Возвращает

Cake\Http\ServerRequest
Модифицированный запрос

parseRequest()source public static

parseRequest( Psr\Http\Message\ServerRequestInterface $request )

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

Параметры

Psr\Http\Message\ServerRequestInterface $request

Запрос для парсинга данных запроса.

Возвращает

array
Разбор элементов из URL.

Выбрасывает

Cake\Routing\Exception\MissingRouteException
При невозможности обработки маршрута

plugin()source public static

plugin( string $name , array|callable $options [] , callable|null $callback null )

Добавить маршруты плагина.

Этот метод создаёт ограниченный набор маршрутов, включающий релевантную информацию о плагине.

Имя плагина будет переведено в нижний регистр и соединён с символами подчеркивания для создания пути маршрутизации. Если вам нужен пользовательский путь, используйте параметр path.

Маршруты, подключённые в ограниченном наборе, будут иметь соответствующий префикс пути, а также соответствующий ключ маршрутизации плагина.

Параметры

string $name

Имя плагина для создания маршрутов

array|callable $options опционально []

Либо параметры для использования, либо обратный вызов.

callable|null $callback опционально null

Обратный вызов, который необходимо вызвать для построения маршрутов плагина. Требуется только если $options определены

popRequest()source public static

popRequest( )

Извлекает запрос из стека запросов. Используется при вызове requestAction

Возвращает

Cake\Http\ServerRequest
Запрос, удалённый из стека.

См. также

\Cake\Routing\Router::pushRequest()
\Cake\Routing\RequestActionTrait::requestAction()

prefix()source public static

prefix( string $name , array|callable $params [] , callable|null $callback null )

Создать маршруты с префиксом.

Этот метод создаёт ограниченную коллекцию маршрутов, которая включает информацию о соответствующем префиксе.

Параметр path используется для генерации имени параметра маршрутизации. Например, путь admin приведет к применению 'prefix' => 'admin' ко всем связанным маршрутам.

Имя префикса будет склонено к нижнему регистру с подчёркиваниями для создания пути маршрутизации. Если вам нужно пользовательское имя пути, используйте опцию path.

Вы можете повторно открыть префикс любое количество раз, а также вкладывать префиксы. Вложенные префиксы приведут к значениям префиксов, таким как admin/api, что соответствует пространству имён Controller\Admin\Api\.

Параметры

строка $name

Имя префикса для использования.

массив|вызов $params опционально []

Массив значений по умолчанию для маршрутизации, добавляемых к каждому связанному маршруту. Если параметров нет, этот аргумент может быть вызовом.

вызов|null $callback опционально null

Обратный вызов для вызова, который строит маршруты с префиксом.

pushRequest()source public static

pushRequest( Cake\Http\ServerRequest $request )

Добавляет запрос в стек запросов. Добавление запроса устанавливает контекст запроса, используемый при генерации URL-адресов.

Параметры

Cake\Http\ServerRequest $request

Экземпляр запроса.

redirect()source public static

redirect( string $route , array $url , array $options [] )

Подключает новый маршрут перенаправления в маршрутизатор.

Провайдер совместимости для \Cake\Routing\RouteBuilder::redirect() в области /.

Устарело

3.3.0 Используйте Router::scope() и RouteBuilder::redirect() вместо этого.

Параметры

строка $route

Строка, описывающая шаблон маршрута

массив $url

URL для перенаправления. Может быть строкой или URL на основе массива Cake

массив $options опционально []

Массив, сопоставляющий именованные элементы в маршруте с регулярными выражениями, которым этот элемент должен соответствовать. Также содержит дополнительные параметры, такие как маршрутизируемые параметры, которые должны быть смещены в переданные аргументы. А также предоставляет шаблоны для параметров маршрутизации.

См. также

\Cake\Routing\RouteBuilder::redirect()

reload()source public static

reload( )

Перезагружает настройки маршрутизатора по умолчанию. Сбрасывает все переменные класса и удаляет все подключенные маршруты.

reverse()source public static

reverse( Cake\Http\ServerRequest|array $params , boolean $full false )

Обращает массив параметров в строку.

Работает аналогично Router::url(), но так как обработанные URL содержат дополнительные ключи «pass» и «url.url», для обратного преобразования массива параметров в строку URL-адреса необходимо обработать эти ключи.

Это уберёт параметры «autoRender», «bare», «requested» и «return», так как они используются в CakePHP для внутренних целей и обычно не должны быть частью выходного URL-адреса.

Параметры

Cake\Http\ServerRequest|массив $params

Массив параметров или объект Cake\Network\Request, который требуется обратить.

логическое $full опционально false

Установите в значение true, чтобы включить полный URL, включая протокол, при обратном преобразовании URL.

Возвращает

строка
Строка, являющаяся результатом обратного преобразования массива

reverseToArray()source public static

reverseToArray( Cake\Http\ServerRequest|array $params )

Обращает массив параметров в массив.

Работает аналогично Router::url(), но так как обработанные URL содержат дополнительные ключи «pass» и «url.url», для обратного преобразования массива параметров в строку URL-адреса необходимо обработать эти ключи.

Это уберёт параметры «autoRender», «bare», «requested» и «return», так как они используются в CakePHP для внутренних целей и обычно не должны быть частью выходного URL-адреса.

Параметры

Cake\Http\ServerRequest|массив $params

Массив параметров или объект Cake\Http\ServerRequest, который требуется обратить.

Возвращает

массив
Массив URL, готовый для перенаправления или HTML-ссылки.

routes()source public static

routes( )

Получить области маршрутов и связанные с ними маршруты.

Возвращает

Cake\Routing\Route\Route[]

scope()source public static

scope( string $path , array|callable $params [] , callable|null $callback null )

Создать область маршрутизации.

Области маршрутизации позволяют сохранять DRY-маршрутизацию и избегать повторения общих префиксов путей и/или наборов параметров.

Ограниченные коллекции будут индексироваться по пути для более быстрого анализа маршрутов. Если вы повторно открываете или используете область, подключенные маршруты будут объединены с существующими.

Опции

Массив $params позволяет определять опции для области маршрутизации. Перечисленные ниже опции недоступны для использования в качестве значений по умолчанию для маршрутизации

• routeClass Класс маршрута для использования в этой области. По умолчанию Router::defaultRouteClass()
• extensions Расширения для включения в этой области. По умолчанию совпадают с глобально включёнными расширениями, установленными с помощью Router::extensions()

Пример

Router::scope('/blog', ['plugin' => 'Blog'], function ($routes) {
   $routes->connect('/', ['controller' => 'Articles']);
});

Это приведет к созданию маршрута /blog/, с установленными параметрами по умолчанию для плагина и контроллера.

Вы можете использовать Router::plugin() и Router::prefix() в качестве сокращений для создания определённых типов областей.

Параметры

строка $path

Префикс пути для области. Этот путь будет предварять все маршруты, подключённые в области.

массив|вызов $params опционально []

Массив значений по умолчанию для маршрутизации, добавляемых к каждому связанному маршруту. Если параметров нет, этот аргумент может быть вызовом.

вызов|null $callback опционально null

Обратный вызов для вызова с областью.

Исключения

InvalidArgumentException
При передаче недействительного вызова.

setRequestContext()source public static

setRequestContext( Psr\Http\Message\ServerRequestInterface $request )

Сохранение контекста запроса для заданного запроса.

Параметры

Psr\Http\Message\ServerRequestInterface $request

Экземпляр запроса.

Исключения

InvalidArgumentException
При неправильном типе параметра.

setRequestInfo()source public static

setRequestInfo( Cake\Http\ServerRequest|array $request )

Принимает информацию о параметрах и путях от диспетчера, устанавливает эти параметры как текущие параметры запроса, которые объединяются с массивами URL, созданными позже в запросе.

Вложенные запросы создают стек запросов. Вы можете удалить запросы с помощью Router::popRequest(). Это делается автоматически при использовании Object::requestAction().

Принимает либо объект Cake\Http\ServerRequest, либо массив массивов. Поддержка приёма массивов может быть удалена в будущем.

Параметры

Cake\Http\ServerRequest|массив $request

Информация о параметрах и пути или объект Cake\Http\ServerRequest.

url()source public static

url( string|array|null $url null , boolean $full false )

Находит URL для указанного действия.

Возвращает URL, указывающий на сочетание контроллера и действия.

Использование

• Router::url('/posts/edit/1'); Возвращает строку с добавленным базовым каталогом. Это использование не использует обратный маршрутизацию.
• Router::url(['controller' => 'posts', 'action' => 'edit']); Возвращает URL, сгенерированный с помощью обратной маршрутизации.
• Router::url(['_name' => 'custom-name', ...]); Возвращает URL, сгенерированный с помощью обратной маршрутизации. Эта форма позволяет использовать именованные маршруты.

Существует несколько «специальных» параметров, которые могут изменить конечную строку URL, которая генерируется

• _base - Установите в значение false, чтобы удалить базовый путь из сгенерированного URL. Если ваше приложение не находится в корневом каталоге, это можно использовать для генерации URL, которые являются «cake относительными». Cake-относительные URL необходимы при использовании requestAction.
• _scheme - Установите для создания ссылок на разных схемах, таких как webcal или ftp. По умолчанию используется текущая схема.
• _host - Установите хост для использования в ссылке. По умолчанию используется текущий хост.
• _port - Установите порт, если вам нужно создать ссылки на нестандартных портах.
• _full - Если true, вывод Router::fullBaseUrl() будет добавлен к сгенерированным URL.
• # - Позволяет установить фрагменты хэша URL.
• _ssl - Установите в значение true, чтобы преобразовать сгенерированный URL в https, или в значение false, чтобы принудительно использовать http.
• _name - Имя маршрута. Если вы настроили именованные маршруты, вы можете использовать этот ключ, чтобы указать его.

Параметры

string|array|null $url необязательно null

Массив, определяющий следующие параметры: «controller», «action», «plugin». Кроме того, вы можете указать маршрутизированные элементы или параметры строки запроса. Если строка, она может быть любым допустимым URL.

boolean $full необязательно false

Если true, полный базовый URL будет добавлен к результату. По умолчанию значение false.

Возвращает

string
Полный URL с базовым путем.

Выбрасывает

Cake\Core\Exception\Exception
Если имя маршрута не найдено

[]

'Cake\Routing\Route\Route'

[]

[
    'Action' => Router::ACTION,
    'Year' => Router::YEAR,
    'Month' => Router::MONTH,
    'Day' => Router::DAY,
    'ID' => Router::ID,
    'UUID' => Router::UUID
]

[]

[]

[]

false