Spec-Zone.ru › CakePHP 4.2

Класс PluginShortRoute

Сокращённый маршрут плагина, копирующий параметр плагина в параметры контроллера. Используется для поддержки маршрутов /:plugin.

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

    Список 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

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

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

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

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

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

Исключения

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

__set_state() public static 

__set_state(array $fields): static

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

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

Параметры

array $fields

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

Возвращает

static

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

_matchMethod(array $url): bool

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

Параметры

array $url

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

Возвращает

bool

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

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

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

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

Параметры

string $args

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

array $context

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

Возвращает

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

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

Возвращает

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. Если URL не соответствует параметрам маршрута, возвращается false. Этот метод обрабатывает обратный маршрутизацию или преобразование массивов URL в строки URL.

Параметры

array $url

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

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

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

Возвращает

string|null

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

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

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

Устанавливает шаблоны regexp для параметров маршрута

Если какие-либо из ваших шаблонов содержат многобайтовые значения, режим 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

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

$_compiledRoute protected

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

Тип

string|null

$_extensions protected

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

Тип

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

Spec-Zone.ru

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