Класс DashedRoute

Этот класс маршрута будет прозрачно склонять параметры маршрута контроллера, действия и плагина, так что запрос /my-plugin/my-controller/my-action будет разобран как ['plugin' => 'MyPlugin', 'controller' => 'MyController', 'action' => 'myAction']

Пространство имён: Cake\Routing\Route

Постоянные значения

array

VALID_METHODS

['GET', 'PUT', 'POST', 'PATCH', 'DELETE', 'OPTIONS', 'HEAD']

Допустимые HTTP-методы.

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

$_compiledRoute protected

string|null

Компилированное регулярное выражение маршрута
$_extensions protected

string[]

Список подключенных расширений для этого маршрута.
$_greedy protected

bool

Является ли этот маршрут жадным? Жадные маршруты имеют /* в их шаблоне
$_inflectedDefaults protected

bool

Флаг для отслеживания того, были ли значения склонены или нет.
$_name protected

string|null

Имя маршрута. Получить с помощью Route::getName();
$braceKeys protected

bool

Отслеживание того, использовались ли фигурные скобки {var}.
$defaults public

array

Параметры по умолчанию для маршрута
$keys public

array

Массив именованных сегментов в маршруте. /{controller}/{action}/{id} имеет 3 ключевых элемента
$middleware protected

array

Список промежуточного программного обеспечения, которое должно быть применено.
$options public

array

Массив дополнительных параметров для маршрута.
$template public

string

Строка шаблона маршрута.

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

__construct() public

Конструктор для маршрута
__set_state() public static

Магический метод установки состояния для поддержки var_export
_camelizePlugin() protected

Приводит к верхнему регистру имя плагина, ранее записанного с дефисом, учитывая поставщиков плагинов
_dasherize() protected

Вспомогательный метод для преобразования ключей в массиве URL в дефисный формат.
_matchMethod() protected

Проверка соответствия HTTP-метода URL.
_parseArgs() protected

Разбор переданных параметров в список переданных аргументов.
_parseExtension() protected

Удаляет расширение из $url, если оно содержит зарегистрированное расширение. Если зарегистрированное расширение не найдено, расширение не возвращается, и URL возвращается без изменений.
_persistParams() protected

Применение параметров сохранения к массиву URL. Параметры сохранения — это специальный ключ, используемый во время создания маршрута, чтобы принудительно сохранить параметры маршрута при их отсутствии в массиве URL.
_writeRoute() protected

Создание регулярного выражения маршрута.
_writeUrl() protected

Преобразование соответствующего массива маршрута в строку URL.
compile() public

Компиляция регулярного выражения маршрута.
compiled() public

Проверка того, был ли маршрут скомпилирован в регулярное выражение.
getExtensions() public

Получение поддерживаемых расширений для этого маршрута.
getMiddleware() public

Получение имён промежуточного программного обеспечения, которое должно быть применено к этому маршруту.
getName() public

Получение стандартизированного имени плагина.контроллер:действие для маршрута.
hostMatches() public

Проверка соответствия хоста требованиям маршрута
match() public

Приводит контроллер, действие и параметры плагина к дефисному формату перед передачей в родительский класс.
normalizeAndValidateMethods() protected

Приведение имён методов к верхнему регистру и проверка на то, что они являются допустимыми HTTP-методами.
parse() public

Разбор строки URL в массив. Если он соответствует, он преобразует ключи контроллера и плагина в их верблюжьи формы, а ключ действия — в верблюжью форму.
parseRequest() public

Проверка возможности разбора данного URL-адреса этим маршрутом.
setExtensions() public

Установка поддерживаемых расширений для этого маршрута.
setHost() public

Установка требования к хосту
setMethods() public

Установка допустимых HTTP-методов для этого маршрута.
setMiddleware() public

Установка имён промежуточного программного обеспечения, которое должно быть применено к этому маршруту.
setPass() public

Установка имён параметров, которые будут преобразованы в переданные параметры
setPatterns() public

Установка регулярных выражений для параметров маршрутизации
setPersist() public

Установка имён параметров, которые будут автоматически сохранены
staticPath() public

Получение статической части пути для этого маршрута.

END_OF_DOCUMENT_MARKER

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

__construct() public

__construct(string $template, array $defaults = [], array $options = [])

Конструктор для маршрута

Параметры

_ext - Определяет расширения, используемые для этого маршрута.
_middleware - Определяет имена промежуточного ПО для этого маршрута.
pass - Копирует указанные параметры в params['pass'].
_method - Определяет HTTP-метод(ы), к которым применяется маршрут. Может быть строкой или массивом допустимых имен HTTP-методов.
_host - Определяет шаблон имени хоста, если вы хотите, чтобы этот маршрут соответствовал только определенным именам хостов. Вы можете использовать .* и для создания подстановочных поддоменов/хостов, например, *.example.com соответствует всем поддоменам на example.com.
'_port` - Определяет порт, если вы хотите, чтобы этот маршрут соответствовал только определенному номеру порта.

Параметры

string $template: Строка шаблона с заполнителями параметров
array $defaults optional: Значения по умолчанию для маршрута.
array $options optional: Массив дополнительных параметров для маршрута

Исключения

InvalidArgumentException
Когда `$options['_method']` не входят в список `VALID_METHODS`.

__set_state() public static

__set_state(array $fields): static

Магический метод установки состояния для поддержки var_export

Этот метод полезен для приложений, которые хотят реализовать кэширование маршрутизатора.

Параметры

array $fields: Ключ/Значение атрибутов объекта

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

static

_camelizePlugin() protected

_camelizePlugin(string $plugin): string

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

Параметры

string $plugin: Имя плагина

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

string

_dasherize() protected

_dasherize(array $url): array

Вспомогательный метод для преобразования ключей в массиве URL в формат с тире.

Параметры

array $url: Массив ключей URL.

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

array

_matchMethod() protected

_matchMethod(array $url): bool

Проверяет, соответствует ли HTTP-метод URL.

Параметры

array $url: Массив для генерируемого URL.

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

bool

_parseArgs() protected

_parseArgs(string $args, array $context): string[]

Разбирает переданные параметры в список переданных аргументов.

Возвращает true, если значение $val заданного именованного параметра $param соответствует заданному правилу $rule в зависимости от $context. В настоящее время реализованные типы правил — это controller, action и match, которые можно комбинировать друг с другом.

Параметры

string $args: Строка с переданными параметрами. Например, /1/foo
array $context: Текущий контекст маршрута, который должен содержать ключи controller/action.

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

string[]

_parseExtension() protected

_parseExtension(string $url): array

Удаляет расширение из $url, если оно содержит зарегистрированное расширение. Если зарегистрированное расширение не найдено, расширение не возвращается, и URL возвращается без изменений.

Параметры

string $url: URL для анализа.

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

array

_persistParams() protected

_persistParams(array $url, array $params): array

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

Параметры

array $url: Массив, к которому нужно применить постоянные параметры.
array $params: Массив постоянных значений для замены существующих постоянных значений.

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

array

_writeRoute() protected

_writeRoute(): void

Создает регулярное выражение маршрута.

Использует свойства template, defaults и options для компиляции регулярного выражения, которое может использоваться для анализа строковых запросов.

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

void

_writeUrl() protected

_writeUrl(array $params, array $pass = [], array $query = []): string

Преобразует совпадающий массив маршрутов в строку URL.

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

Параметры

array $params: Параметры для преобразования в строку URL
array $pass optional: Дополнительные переданные аргументы
array $query optional: Массив параметров

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

string

compile() public

compile(): string

hostMatches(string $host): bool

Проверяет, соответствует ли хост требованиям маршрута

Параметры

string $host: Имя хоста запроса

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

bool

match() public

match(array $url, array $context = []): string|null

Преобразует параметры controller, action и plugin в формат с тире, прежде чем передавать их родительскому классу.

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

Параметры

array $url: Массив параметров для преобразования в строку.
array $context optional: Массив текущего контекста запроса. Содержит информацию, такую как текущий хост, схема, порт и базовый каталог.

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

string|null

normalizeAndValidateMethods() protected

normalizeAndValidateMethods(string|string[] $methods): string|string[]

Нормализует имена методов в верхний регистр и проверяет, являются ли они допустимыми HTTP-методами.

Параметры

string|string[] $methods: Методы.

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

string|string[]

Исключения

InvalidArgumentException
Когда методы не входят в список `VALID_METHODS`.

parse() public

parse(string $url, string $method = ''): array|null

Парсит строку URL в массив. Если совпадает, преобразует ключи контроллера и плагина в CamelCase, а ключ действия — в camelBacked.

Если маршрут может быть распарсен, возвращается массив параметров; в противном случае — false. Строковые URL-адреса парсятся, если они соответствуют регулярному выражению маршрута.

Параметры

string $url: URL для парсинга
string $method optional: Метод HTTP.

Возвращает

array|null

parseRequest() public

parseRequest(Psr\Http\Message\ServerRequestInterface $request): array|null

Проверяет, может ли данный URL быть распарсен этим маршрутом.

Если маршрут может быть распарсен, возвращается массив параметров; в противном случае — false.

Параметры

Psr\Http\Message\ServerRequestInterface $request: URL для попытки парсинга.

Возвращает

array|null

setExtensions() public

setExtensions(string[] $extensions): $this

Устанавливает поддерживаемые расширения для этого маршрута.

Параметры

string[] $extensions: Расширения для установки.

Возвращает

$this

setHost() public

setHost(string $host): $this

Устанавливает требование к хосту

Параметры

string $host: Имя хоста, к которому привязан этот маршрут

Возвращает

$this

setMethods() public

setMethods(string[] $methods): $this

Устанавливает принимаемые методы HTTP для этого маршрута.

Параметры

string[] $methods: Методы HTTP для принятия.

Возвращает

$this

Исключения

InvalidArgumentException
Когда методы не находятся в списке `VALID_METHODS`.

setMiddleware() public

setMiddleware(array $middleware): $this

Устанавливает имена middleware, которые должны применяться к этому маршруту.

Параметры

array $middleware: Список имён middleware, которые нужно применить к этому маршруту. Имена middleware не будут проверены до тех пор, пока маршрут не будет сопоставлен.

Возвращает

$this

setPass() public

setPass(string[] $names): $this

Устанавливает имена параметров, которые будут преобразованы в параметры, передаваемые в обработчик.

Параметры

string[] $names: Имена параметров, которые должны передаваться.

Возвращает

$this

setPatterns() public

setPatterns(string[] $patterns): $this

Устанавливает регулярные выражения для параметров маршрута.

Если какой-либо из ваших шаблонов содержит многобайтовые значения, режим multibytePattern будет включён.

Параметры

string[] $patterns: Шаблоны, применяемые к элементам маршрута

Возвращает

$this

setPersist() public

setPersist(array $names): $this

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

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

// remove a persistent 'date' parameter
Router::url(['date' => false', ...]);

Параметры

array $names: Имена параметров, которые должны передаваться.

Возвращает

$this

staticPath() public

staticPath(): string

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

Возвращает

string

Подробности свойств

`$_inflectedDefaults` protected

Тип

string

© 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.Route.DashedRoute.html