Маршрут

__construct(string $path, array $defaults = array(), array $requirements = array(), array $options = array(), string|null $host = '', string|string[] $schemes = array(), string|string[] $methods = array(), string|null $condition = '')

Конструктор.

Доступные опции:

• compiler_class: Имя класса, способного скомпилировать этот экземпляр маршрута (RouteCompiler по умолчанию)
• utf8: Принудительно ли использовать соответствие UTF-8

Параметры

string	$path	Шаблон пути для сопоставления
array	$defaults	Массив значений параметров по умолчанию
array	$requirements	Массив требований к параметрам (регулярные выражения)
array	$options	Массив опций
string|null	$host	Шаблон хоста для сопоставления
string|string[]	$schemes	Требуемый URI-схем или массив ограниченных схем
string|string[]	$methods	Требуемый HTTP-метод или массив ограниченных методов
string|null	$condition	Условие, которое должно быть истинным для сопоставления маршрута

serialize()

{@inheritdoc}

unserialize($serialized)

{@inheritdoc}

Параметры

$serialized

string getPath()

Возвращает шаблон для пути.

Значение возврата

string

Шаблон пути

$this setPath(string $pattern)

Устанавливает шаблон для пути.

Этот метод реализует интерфейс fluent.

Параметры

string

$pattern

Шаблон пути

Значение возврата

$this

string getHost()

Возвращает шаблон для хоста.

Значение возврата

string

Шаблон хоста

$this setHost(string $pattern)

Устанавливает шаблон для хоста.

Этот метод реализует интерфейс fluent.

Параметры

string

$pattern

Шаблон хоста

Значение возврата

$this

string[] getSchemes()

Возвращает схемы (например, 'https') с нижним регистром, к которым ограничен данный маршрут.

Пустой массив означает, что разрешена любая схема.

Значение возврата

string[]

Схемы

$this setSchemes(string|string[] $schemes)

Устанавливает схемы (например, 'https'), к которым ограничен данный маршрут.

Пустой массив означает, что разрешена любая схема.

Этот метод реализует интерфейс fluent.

Параметры

string|string[]

$schemes

Схема или массив схем

Значение возврата

$this

bool hasScheme(string $scheme)

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

Параметры

string

$scheme

Значение возврата

bool	true, если требование по схеме существует, в противном случае false

string[] getMethods()

Возвращает HTTP-методы (например, 'POST') с верхним регистром, к которым ограничен данный маршрут.

Пустой массив означает, что разрешен любой метод.

Значение возврата

string[]

Методы

$this setMethods(string|string[] $methods)

Устанавливает HTTP-методы (например, 'POST'), к которым ограничен данный маршрут.

Пустой массив означает, что разрешен любой метод.

Этот метод реализует интерфейс fluent.

Параметры

string|string[]

$methods

Метод или массив методов

Значение возврата

$this

array getOptions()

Возвращает опции.

Значение возврата

array

Опции

$this setOptions(array $options)

Устанавливает опции.

Этот метод реализует интерфейс fluent.

Параметры

array

$options

Опции

Значение возврата

$this

$this addOptions(array $options)

Добавляет опции.

Этот метод реализует интерфейс fluent.

Параметры

array

$options

Опции

Значение возврата

$this

$this setOption(string $name, mixed $value)

Устанавливает значение опции.

Этот метод реализует интерфейс fluent.

Параметры

string	$name	Имя опции
mixed	$value	Значение опции

Значение возврата

$this

mixed getOption(string $name)

Получить значение опции.

Параметры

string

$name

Имя опции

Значение возврата

mixed

Значение опции или null, если не задано

bool hasOption(string $name)

Проверяет, установлена ли опция.

Параметры

string

$name

Имя опции

Значение возврата

bool	true, если опция установлена, в противном случае false

array getDefaults()

Возвращает значения по умолчанию.

Значение возврата

array

Значения по умолчанию

$this setDefaults(array $defaults)

Устанавливает значения по умолчанию.

Этот метод реализует интерфейс fluent.

Параметры

array

$defaults

Значения по умолчанию

Значение возврата

$this

$this addDefaults(array $defaults)

Добавляет значения по умолчанию.

Этот метод реализует интерфейс fluent.

Параметры

array

$defaults

Значения по умолчанию

Значение возврата

$this

mixed getDefault(string $name)

Получает значение по умолчанию.

Параметры

string

$name

Имя переменной

Значение возврата

mixed

Значение по умолчанию или null, если не задано

bool hasDefault(string $name)

Проверяет, установлено ли значение по умолчанию для данной переменной.

Параметры

string

$name

Имя переменной

Значение возврата

bool	true, если значение по умолчанию установлено, в противном случае false

$this setDefault(string $name, mixed $default)

Устанавливает значение по умолчанию.

Параметры

string	$name	Имя переменной
mixed	$default	Значение по умолчанию

Значение возврата

$this

array getRequirements()

Возвращает требования.

Значение возврата

array

Требования

$this setRequirements(array $requirements)

Устанавливает требования.

Этот метод реализует интерфейс fluent.

Параметры

array

$requirements

Требования

Значение возврата

$this

$this addRequirements(array $requirements)

Добавляет требования.

Этот метод реализует интерфейс fluent.

Параметры

array

$requirements

Требования

Значение возврата

$this

string|null getRequirement(string $key)

Возвращает требование для данного ключа.

Параметры

string

$key

Ключ

Значение возврата

string|null

Регулярное выражение или null, если не задано

bool hasRequirement(string $key)

Проверяет, установлено ли требование для данного ключа.

Параметры

string

$key

Имя переменной

Значение возврата

bool	true, если требование задано, иначе false

$this setRequirement(string $key, string $regex)

Устанавливает требование для заданного ключа.

Параметры

string	$key	Ключ
string	$regex	Регулярное выражение

Значение, возвращаемое функцией

$this

string getCondition()

Возвращает условие.

Значение, возвращаемое функцией

string

Условие

$this setCondition(string $condition)

Устанавливает условие.

Этот метод реализует интерфейс флюента.

Параметры

string

$condition

Условие

Значение, возвращаемое функцией

$this

CompiledRoute compile()

Компилирует маршрут.

Значение, возвращаемое функцией

CompiledRoute

Экземпляр CompiledRoute

Исключения

LogicException

Если маршрут не может быть скомпилирован из-за некорректного пути или шаблона хоста

См. также

RouteCompiler

который отвечает за процесс компиляции