Класс EntityRoute

Сопоставляет сущности с маршрутами

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

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

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

string

PLACEHOLDER_REGEX
```
'#\\{([a-z][a-z0-9-_]*)\\}#i'
```
Регулярное выражение для сопоставления зарезервированных замен в шаблоне маршрута.
array<string>

VALID_METHODS
```
['GET', 'PUT', 'POST', 'PATCH', 'DELETE', 'OPTIONS', 'HEAD']
```
Допустимые HTTP-методы.

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

$_compiledRoute protected

string|null

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

array<string>

Список подключенных расширений для этого маршрута.
$_greedy 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
_checkEntity() protected

Проверяет, что мы действительно имеем дело с объектом сущности
_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

Сопоставление по сущности и отображение ее полей на шаблон URL путем сравнения имен полей со значениями шаблона.
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<string, mixed> $options = [])

Конструктор маршрута

Параметры

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

Параметры

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

Исключения

InvalidArgumentException
При несоответствии `$options['_method']` списку `VALID_METHODS`.

__set_state() public static

__set_state(array<string, mixed> $fields): static

Метод для управления состоянием, поддерживающий var_export

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

Параметры

array<string, mixed> $fields: Ключи/значения атрибутов объекта

Возвращает

static

_checkEntity() protected

_checkEntity(ArrayAccess|array $entity): void

Проверяет, что мы действительно работаем с объектом сущности

Параметры

ArrayAccess|array $entity: Значение сущности из параметров URL

Возвращает

void

Исключения

RuntimeException

_matchMethod() protected

_matchMethod(array $url): bool

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

Параметры

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

Возвращает

bool

_parseArgs() protected

_parseArgs(string $args, array $context): array<string>

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

Возвращает true, если заданное имя параметра $param и его значение $val соответствуют заданному правилу $rule в зависимости от контекста $context. В настоящее время реализованы типы правил: контроллер, действие и сопоставление, которые могут быть объединены друг с другом.

Параметры

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

Возвращает

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

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

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

Возвращает

void

_writeUrl() protected

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

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

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

Параметры

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

Возвращает

string

compile() public

compile(): string

hostMatches(string $host): bool

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

Параметры

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

Возвращает

bool

match() public

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

Сопоставление по сущности и отображение её полей в шаблоне URL путём сравнения имён полей с переменными шаблона.

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

Параметры

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

Возвращает

string|null

normalizeAndValidateMethods() protected

normalizeAndValidateMethods(array<string>|string $methods): array<string>|string

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

Параметры

array<string>|string $methods: Методы.

Возвращает

array<string>|string

Исключения

InvalidArgumentException
При несоответствии методов списку `VALID_METHODS`.

parse() public

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

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

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

Параметры

string $url: URL-адрес, который необходимо обработать.
string $method: Метод HTTP запроса, который обрабатывается.

Возвращает

array|null

Исключения

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

parseRequest() public

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

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

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

Параметры

Psr\Http\Message\ServerRequestInterface $request: URL-адрес, который необходимо обработать.

Возвращает

array|null

setExtensions() public

setExtensions(array<string> $extensions): $this

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

Параметры

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

Возвращает

$this

setHost() public

setHost(string $host): $this

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

Параметры

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

Возвращает

$this

setMethods() public

setMethods(array<string> $methods): $this

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

Параметры

array<string> $methods: Методы HTTP, которые принимаются.

Возвращает

$this

Исключения

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

setMiddleware() public

setMiddleware(array $middleware): $this

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

Параметры

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

Возвращает

$this

setPass() public

setPass(array<string> $names): $this

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

Параметры

array<string> $names: Имена параметров, которые должны быть переданы.

Возвращает

$this

setPatterns() public

setPatterns(array<string> $patterns): $this

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

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

Параметры

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

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.3/class-Cake.Routing.Route.EntityRoute.html