Spec-Zone.ru › CakePHP 4.2

Класс Router

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

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

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

Пространство имён: 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]+'

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

  • 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
    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

    Имена выражений

  • $_request protected static
    Cake\Http\ServerRequest

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

  • $_requestContext protected static
    array

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

  • $_routePaths protected static
    array

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

  • $_urlFilters protected static
    callable[]

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

END_OF_DOCUMENT_MARKER

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

  • _applyUrlFilters() protected static

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

  • addUrlFilter() public static

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

  • connect() public static

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

  • 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 внутри маршрутизатора

  • normalize() public static

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

  • parseRequest() public static

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

  • parseRoutePath() public static

    Обработать строку пути маршрута

  • pathUrl() public static

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

  • plugin() public static

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

  • prefix() public static

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

  • reload() public static

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

  • resetRoutes() public static

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

  • reverse() public static

    Инвертирует массив обработанных параметров в строку.

  • reverseToArray() public static

    Инвертирует массив обработанных параметров в массив.

  • routeExists() public static

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

  • routes() public static

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

  • scope() public static

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

  • setRequest() public static

    Установить текущую инстанцию запроса.

  • setRouteCollection() public static

    Установить RouteCollection внутри маршрутизатора

  • 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(stringCake\Routing\Route\Route $route, array|string $defaults = [], array $options = []): void

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

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

Parameters

stringCake\Routing\Route\Route $route

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

array|string $defaults optional

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

array $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 $options = []): Cake\Routing\RouteBuilder

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

Parameters

string $path

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

array $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(string[]|string|null $extensions = null, bool $merge = true): string[]

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

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

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

Parameters

string[]|string|null $extensions optional

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

bool $merge optional

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

Returns

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

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

Returns

array

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): string[]

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

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

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

Parameters

string $url

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

Returns

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, array|callable $options = [], callable|null $callback = null): void

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

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

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

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

Параметры

string $name

Имя плагина, для которого создаются маршруты

array|callable $options необязательно

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

callable|null $callback необязательно

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

Возвращает

void

prefix() public static 

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

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

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

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

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

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

Параметры

string $name

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

array|callable $params необязательно

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

callable|null $callback необязательно

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

Возвращает

void

reload() public static 

reload(): void

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

Возвращает

void

resetRoutes() public static 

resetRoutes(): void

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

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

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

  • маршруты
  • фильтры URL
  • свойство инициализации

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

Возвращает

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 необязательно

Установите в значение 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(string|array|null $url = null, bool $full = false): bool

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

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

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

Параметры

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

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

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

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

Возвращает

bool

См. также

Router::url()

routes() public static 

routes(): Cake\Routing\Route\Route[]

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

Возвращает

Cake\Routing\Route\Route[]

scope() public static 

scope(string $path, array|callable $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

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

array|callable $params необязательно

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

callable|null $callback необязательно

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

Возвращает

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(string|arrayPsr\Http\Message\UriInterface|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 - Имя маршрута. Если вы настроили именованные маршруты, вы можете использовать этот ключ для его указания.

Параметры

string|arrayPsr\Http\Message\UriInterface|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()

Тип

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

$_request protected static

Поддерживает ссылку на объект запроса.

Тип

Cake\Http\ServerRequest

$_requestContext protected static

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

Тип

array

$_routePaths protected static

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

Тип

array

$_urlFilters protected static

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

Тип

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

Spec-Zone.ru

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