Spec-Zone.ru › CakePHP 4.3

Класс Router

Разбирает URL-адрес запроса на контроллер, действие и параметры. Использует подключенные маршруты для сопоставления входящей строки URL с параметрами, которые позволят отправить запрос. Также обрабатывает преобразование списков параметров в строки URL, используя подключенные маршруты. Маршрутизация позволяет вам отделить способ взаимодействия мира с вашим приложением (URL-адреса) и реализацию (контроллеры и действия).

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

Подключение маршрутов осуществляется с помощью Router::connect(). При разборе входящих запросов или обратного сопоставления параметров маршруты перечисляются в порядке их подключения. Для получения дополнительной информации о маршрутах и ​​способах их подключения см. Router::connect().

Namespace: Cake\Routing

Константы

  • string
    ACTION 
    'index|show|add|create|edit|update|remove|del|delete|view|item'

    Регулярное выражение для имен действий

  • string
    DAY 
    '0[1-9]|[12][0-9]|3[01]'

    Регулярное выражение для дней

  • string
    ID 
    '[0-9]+'

    Регулярное выражение для автоинкрементных ID

  • string
    MONTH 
    '0[1-9]|1[012]'

    Регулярное выражение для месяцев

  • string
    UUID 
    '[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}'

    Регулярное выражение для UUID

  • string
    YEAR 
    '[12][0-9]{3}'

    Регулярное выражение для годов

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

  • $_collection protected static
    Cake\Routing\RouteCollection

    Коллекция маршрутов, к которым будут добавляться маршруты.

  • $_defaultExtensions protected static
    array<string>

    Расширения по умолчанию, определенные с помощью Router::extensions()

  • $_defaultRouteClass protected static
    string

    Класс маршрута по умолчанию.

  • $_fullBaseUrl protected static
    string|null

    Содержит базовую строку, которая будет применена ко всем сгенерированным URL-адресам. Например https://example.com

  • $_initialState protected static
    array

    Начальное состояние заполняется при первом вызове reload(), который находится в нижней части этого файла. Это обман, так как get_class_vars() возвращает значение статических переменных, даже если они изменились.

  • $_namedExpressions protected static
    array<string, string>

    Именованные выражения

  • $_request protected static
    Cake\Http\ServerRequest

    Сохраняет ссылку на объект запроса.

  • $_requestContext protected static
    array

    Хэш данных контекста запроса.

  • $_routePaths protected static
    array

    Кэш разобранных путей маршрутов

  • $_urlFilters protected static
    array<callable>

    Стек фильтров URL, которые применяются к URL-адресам маршрутизации перед передачей параметров в коллекцию маршрутов.

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

  • _applyUrlFilters() protected static

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

  • addUrlFilter() public static

    Добавляет URL-фильтр в Router.

  • connect() public static deprecated

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

  • createRouteBuilder() public static

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

  • defaultRouteClass() public static

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

  • extensions() public static

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

  • fullBaseUrl() public static

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

  • getNamedExpressions() public static

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

  • getRequest() public static

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

  • getRouteCollection() public static

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

  • normalize() public static

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

  • parseRequest() public static

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

  • parseRoutePath() public static

    Разбирает строковый путь маршрута

  • pathUrl() public static

    Генерирует URL для пути маршрута.

  • plugin() public static deprecated

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

  • prefix() public static deprecated

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

  • reload() public static

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

  • resetRoutes() public static

    Сбрасывает маршруты и связанное состояние.

  • reverse() public static

    Преобразует разобранный массив параметров в строку.

  • reverseToArray() public static

    Преобразует разобранный массив параметров в массив.

  • routeExists() public static

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

  • routes() public static

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

  • scope() public static deprecated

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

  • setRequest() public static

    Устанавливает текущий экземпляр запроса.

  • setRouteCollection() public static

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

  • unwrapShortString() protected static

    Внедряет значения по умолчанию для маршрута из ключа _path

  • url() public static

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

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

_applyUrlFilters() protected static 

_applyUrlFilters(array $url): array

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

Parameters

array $url

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

Returns

array

See Also

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

addUrlFilter() public static 

addUrlFilter(callable $function): void

Добавить фильтр URL в Router.

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

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

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

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

Usage

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

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

Parameters

callable $function

Функция для добавления

Returns

void

connect() public static 

connect(Cake\Routing\Route\Route|string $route, array|string $defaults = [], array<string, mixed> $options = []): void

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

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

Parameters

Cake\Routing\Route\Route|string $route

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

array|string $defaults optional

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

array<string, mixed> $options optional

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

Returns

void

Throws

Cake\Core\Exception\CakeException

See Also

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

createRouteBuilder() public static 

createRouteBuilder(string $path, array<string, mixed> $options = []): Cake\Routing\RouteBuilder

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

Parameters

string $path

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

array<string, mixed> $options optional

Параметры для генератора

Returns

Cake\Routing\RouteBuilder

defaultRouteClass() public static 

defaultRouteClass(string|null $routeClass = null): string|null

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

Parameters

string|null $routeClass optional

Имя класса.

Returns

string|null

extensions() public static 

extensions(array<string>|string|null $extensions = null, bool $merge = true): array<string>

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

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

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

Parameters

array<string>|string|null $extensions optional

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

bool $merge optional

Объединять или переопределять существующие расширения. Значение по умолчанию true.

Returns

array<string>

fullBaseUrl() public static 

fullBaseUrl(string|null $base = null): string

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

Note:

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

Parameters

string|null $base optional

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

Returns

string

getNamedExpressions() public static 

getNamedExpressions(): array<string, string>

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

Returns

array<string, string>

See Also

\Cake\Routing\Router::$_namedExpressions

getRequest() public static 

getRequest(): Cake\Http\ServerRequest|null

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

Returns

Cake\Http\ServerRequest|null

getRouteCollection() public static 

getRouteCollection(): Cake\Routing\RouteCollection

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

Returns

Cake\Routing\RouteCollection

normalize() public static 

normalize(array|string $url = '/'): string

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

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

Parameters

array|string $url optional

URL для нормализации. Либо массив, либо строка URL.

Returns

string

parseRequest() public static 

parseRequest(Cake\Http\ServerRequest $request): array

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

Parameters

Cake\Http\ServerRequest $request

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

Returns

array

Throws

Cake\Routing\Exception\MissingRouteException
Когда маршрут не может быть обработан

parseRoutePath() public static 

parseRoutePath(string $url): array<string, string>

Разбор строкового пути маршрута

Примеры строк:

  • Bookmarks::view
  • Admin/Bookmarks::view
  • Cms.Articles::edit
  • Vendor/Cms.Management/Admin/Articles::view

Parameters

string $url

Путь маршрута в формате [Plugin.][Prefix/]Controller::action

Returns

array<string, string>

pathUrl() public static 

pathUrl(string $path, array $params = [], bool $full = false): string

Генерировать URL для пути маршрута.

Примеры пути маршрута:

  • Bookmarks::view
  • Admin/Bookmarks::view
  • Cms.Articles::edit
  • Vendor/Cms.Management/Admin/Articles::view

Parameters

string $path

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

array $params optional

Массив, указывающий любые дополнительные параметры. Может быть также любыми специальными параметрами, поддерживаемыми Router::url().

bool $full optional

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

Returns

string

plugin() public static 

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

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

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

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

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

Параметры

string $name

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

callable|array $options optional

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

callable|null $callback optional

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

Возвращает

void

prefix() public static 

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

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

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

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

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

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

Параметры

string $name

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

callable|array $params optional

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

callable|null $callback optional

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

Возвращает

void

reload() public static 

reload(): void

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

Возвращает

void

resetRoutes() public static 

resetRoutes(): void

Сброс маршрутов и связанного состояния.

Аналогично reload(), за исключением того, что это не сбрасывает все глобальное состояние, так как это приводит к неправильному поведению в некоторых сценариях тестирования плагинов.

Этот метод сбросит:

  • маршруты
  • URL-фильтры
  • свойство initialized

Расширения и классы маршрутов по умолчанию не будут изменены

Возвращает

void

reverse() public static 

reverse(Cake\Http\ServerRequest|array $params, bool $full = false): string

Преобразует разобранный массив параметров в строку.

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

Параметры

Cake\Http\ServerRequest|array $params

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

bool $full optional

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

Возвращает

string

reverseToArray() public static 

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

Преобразует разобранный массив параметров в массив.

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

Параметры

Cake\Http\ServerRequest|array $params

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

Возвращает

array

routeExists() public static 

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

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

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

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

Параметры

array|string|null $url optional

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

bool $full optional

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

Возвращает

bool

См. также

Router::url()

routes() public static 

routes(): arrayCake\Routing\Route\Route>

Получить области маршрутизации и их подключенные маршруты.

Возвращает

arrayCake\Routing\Route\Route>

scope() public static 

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

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

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

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

Параметры

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

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

Пример

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

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

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

Параметры

string $path

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

callable|array $params optional

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

callable|null $callback optional

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

Возвращает

void

Исключения

InvalidArgumentException
Когда предоставляется недопустимый вызываемый объект.

setRequest() public static 

setRequest(Cake\Http\ServerRequest $request): void

Установить текущий экземпляр запроса.

Параметры

Cake\Http\ServerRequest $request

Объект запроса.

Возвращает

void

setRouteCollection() public static 

setRouteCollection(Cake\Routing\RouteCollection $routeCollection): void

Установить RouteCollection внутри Router

Параметры

Cake\Routing\RouteCollection $routeCollection

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

Возвращает

void

unwrapShortString() protected static 

unwrapShortString(array $url): array

Внедрить параметры маршрута по умолчанию из ключа _path

Параметры

array $url

Массив маршрутов с ключом _path

Возвращает

array

url() public static 

url(Psr\Http\Message\UriInterface|array|string|null $url = null, bool $full = false): string

Находит 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, вывод Router::fullBaseUrl() будет добавлен в начало сгенерированных URL-адресов.
  • # - Позволяет устанавливать фрагменты URL-адресов.
  • _ssl - Установите в true, чтобы преобразовать сгенерированный URL в https, или в false, чтобы принудительно использовать http.
  • _name - Имя маршрута. Если вы настроили именованные маршруты, вы можете использовать этот ключ, чтобы указать его.

Параметры

Psr\Http\Message\UriInterface|array|string|null $url optional

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

bool $full optional

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

Возвращает

string

Вызывает исключение

Cake\Core\Exception\CakeException
Когда имя маршрута не найдено

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

$_collection protected static

Коллекция маршрутов, к которым будут добавлены маршруты.

Тип

Cake\Routing\RouteCollection

$_defaultExtensions protected static

Расширения по умолчанию, определенные с помощью Router::extensions()

Тип

array<string>

$_defaultRouteClass protected static

Класс маршрута по умолчанию.

Тип

string

$_fullBaseUrl protected static

Содержит базовую строку, которая будет применена ко всем сгенерированным URL-адресам. Например https://example.com

Тип

string|null

$_initialState protected static

Начальное состояние заполняется при первом вызове reload(), который находится внизу этого файла. Это обман, так как get_class_vars() возвращает значение статических переменных, даже если они изменились.

Тип

array

$_namedExpressions protected static

Именованные выражения

Тип

array<string, string>

$_request protected static

Сохраняет ссылку на объект запроса.

Тип

Cake\Http\ServerRequest

$_requestContext protected static

Хэш данных контекста запроса.

Тип

array

$_routePaths protected static

Кэш распарсенных путей маршрутов

Тип

array

$_urlFilters protected static

Стек фильтров URL, которые применяются к URL-адресам маршрутизации перед передачей параметров в коллекцию маршрутов.

Тип

array<callable>

© 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.3/class-Cake.Routing.Router.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API