Spec-Zone.ru › CakePHP 4.2

Класс Route

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

Обычно не создается как самостоятельный. Используйте Router::connect() для создания маршрутов для вашего приложения.

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

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

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

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

__construct() public 

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

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

Параметры

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

_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

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

Возвращает

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

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

Возвращает

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

Исключения

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

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

$_compiledRoute protected

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

Тип

string|null

$_extensions protected

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

Тип

string[]

$_greedy protected

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

Тип

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

Spec-Zone.ru

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