Класс EntityRoute

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

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

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

Константы

array

VALID_METHODS

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

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

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

$_compiledRoute protected

string|null

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

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

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

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

Возвращает true, если значение переданного параметра $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

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

Если ключ маршрутизации определен как в $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 этим маршрутом.

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

Параметры

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

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

array|null

Исключения

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

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

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.EntityRoute.html