Spec-Zone.ru › CakePHP 4.3

Класс InflectedRoute

Этот класс маршрута будет прозрачно изменять параметры маршрутизации контроллера и плагина, так что запрос /my_controller будет разобран как ['controller' => 'MyController']

Пространство имен: 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

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

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

    Список middleware, который должен быть применён.

  • $options public
    array

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

  • $template public
    string

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

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

  • __construct() public

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

  • __set_state() public static

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

  • _matchMethod() protected

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

  • _parseArgs() protected

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

  • _parseExtension() protected

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

  • _persistParams() protected

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

  • _underscore() protected

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

  • _writeRoute() protected

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

  • _writeUrl() protected

    Преобразование соответствия маршрута в строку URL.

  • compile() public

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

  • compiled() public

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

  • getExtensions() public

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

  • getMiddleware() public

    Получение имён middleware, которые должны быть применены к этому маршруту.

  • getName() public

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

  • hostMatches() public

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

  • match() public

    Преобразование префикса, контроллера и параметров плагина в нижний регистр с подчеркиванием перед передачей в родительский класс

  • normalizeAndValidateMethods() protected

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

  • parse() public

    Разбор строки URL в массив. Если соответствует, преобразует ключи префикса, контроллера и плагина в их камеллизированную форму.

  • parseRequest() public

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

  • setExtensions() public

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

  • setHost() public

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

  • setMethods() public

    Указание принятых HTTP-методов для данного маршрута.

  • setMiddleware() public

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

  • setPass() public

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

  • setPatterns() public

    Установка regexp-шаблонов для параметров маршрутизации

  • setPersist() public

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

  • staticPath() public

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

END_OF_DOCUMENT_MARKER

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

__construct() public 

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

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

Параметры

  • _ext - Определяет расширения, используемые для этого маршрута.
  • _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

_matchMethod() защищённый 

_matchMethod(array $url): bool

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

Параметры

array $url

Массив для URL, который генерируется.

Возвращает

bool

_parseArgs() защищённый 

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

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

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

Параметры

string $args

Строка с переданными параметрами. Например, /1/foo

array $context

Текущий контекст маршрута, который должен содержать ключи контроллер/действие.

Возвращает

array<string>

_parseExtension() защищённый 

_parseExtension(string $url): array

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

Параметры

string $url

URL для анализа.

Возвращает

array

_persistParams() защищённый 

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

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

Параметры

array $url

Массив, к которому нужно применить постоянные параметры.

array $params

Массив постоянных значений, которые нужно заменить постоянными.

Возвращает

array

_underscore() защищённый 

_underscore(array $url): array

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

Параметры

array $url

Массив ключей URL.

Возвращает

array

_writeRoute() защищённый 

_writeRoute(): void

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

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

Возвращает

void

_writeUrl() защищённый 

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

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

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

Параметры

array $params

Параметры для преобразования в строку URL

array $pass необязательно

Дополнительные переданные аргументы

array $query необязательно

Массив параметров

Возвращает

string

compile() public 

compile(): string

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

Изменяет свойство defaults, чтобы все необходимые ключи были установлены, и заполняет $this->names именованными элементами маршрутизации.

Возвращает

string

compiled() public 

compiled(): bool

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

Возвращает

bool

getExtensions() public 

getExtensions(): array<string>

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

Возвращает

array<string>

getMiddleware() public 

getMiddleware(): array

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

Возвращает

array

getName() public 

getName(): string

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

Возвращает

string

hostMatches() public 

hostMatches(string $host): bool

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

Параметры

string $host

Имя хоста запроса

Возвращает

bool

match() public 

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

Преобразует префикс, контроллер и параметры плагина в нижний регистр с подчёркиванием перед передачей их родительскому классу

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

Параметры

array $url

Массив параметров для преобразования в строку.

array $context необязательно

Массив текущего контекста запроса. Содержит информацию, такую как текущий хост, схема, порт и базовая директория.

Возвращает

string|null

normalizeAndValidateMethods() защищённый 

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

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

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

$_compiledRoute protected

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

Тип

string|null

$_extensions protected

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

Тип

array<string>

$_greedy protected

Является ли этот маршрут жадным? Жадные маршруты содержат /* в своём шаблоне.

Тип

bool

$_inflectedDefaults protected

Флаг, указывающий, были ли значения по умолчанию склонены.

Значения по умолчанию необходимо склонять, чтобы они соответствовали склонениям, которые создаёт match().

Тип

bool

$_name protected

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

Тип

string|null

$braceKeys protected

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

Тип

bool

$defaults public

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

Тип

array

$keys public

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

Тип

array

$middleware protected

Список middleware, которые должны быть применены.

Тип

array

$options public

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

Тип

array

$template public

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

Тип

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

Spec-Zone.ru

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