Класс 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 deprecated

_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|string $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 )

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

Параметры

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

Имя класса.

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

string|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.

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

Параметры

строка $name

Имя плагина, для которого нужно сгенерировать маршруты

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

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

обратный вызов|null $callback необязательно null

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

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 )

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

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

Параметр пути используется для генерации имени параметра маршрутизации. Например, путь 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 deprecated

redirect( string $route , array|string $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\Http\ServerRequest, который нужно обратить.

булево $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-ссылки.

routeExists()source public static

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

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

Возвращает true, если URL существует.

Пример

Параметры

строка|массив|null $url необязательно null

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

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

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

Возвращает

булево

См. также

Router::url()

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|array $request

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

Устарело

3.6.0 Поддержка массивов будет удалена в 4.0.0

setRouteCollection()source public static

setRouteCollection( RouteCollection $routeCollection )

Устанавливает RouteCollection внутри Router

Параметры

RouteCollection $routeCollection

коллекция маршрутов

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

Массив, определяющий следующие параметры: «контроллер», «действие», «плагин»; дополнительно, вы можете предоставить элементы маршрута или параметры строки запроса. Если строка, это может быть любая допустимая строка 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