Класс 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 в Router.

Функции фильтров 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 optional []

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

массив $options optional []

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

Исключения

Cake\Core\Exception\Exception

См. также

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

createRouteBuilder()source public static

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

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

Параметры

строка $path

Путь, для которого задаётся билдер.

массив $options optional []

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

Возвращает

Cake\Routing\RouteBuilder

defaultRouteClass()source public static

defaultRouteClass( string|null $routeClass null )

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

Параметры

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

Параметры

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

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

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

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

Возвращает

строка
Полный переведенный 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