Маршрут

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

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

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

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

Параметры

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

serialize()

{@inheritdoc}

unserialize($serialized)

{@inheritdoc}

Параметры

$serialized

string getPath()

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

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

string

Шаблон пути

Route setPath(string $pattern)

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

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

Параметры

string

$pattern

Шаблон пути

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

Route

Текущий экземпляр Route

string getHost()

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

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

string

Шаблон хоста

Route setHost(string $pattern)

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

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

Параметры

string

$pattern

Шаблон хоста

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

Route

Текущий экземпляр Route

array getSchemes()

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

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

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

array

Схемы

Route setSchemes(string|array $schemes)

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

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

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

Параметры

string|array

$schemes

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

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

Route

Текущий экземпляр Route

bool hasScheme(string $scheme)

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

Параметры

string

$scheme

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

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

array getMethods()

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

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

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

array

Методы

Route setMethods(string|array $methods)

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

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

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

Параметры

string|array

$methods

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

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

Route

Текущий экземпляр Route

array getOptions()

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

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

array

Опции

Route setOptions(array $options)

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

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

Параметры

array

$options

Опции

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

Route

Текущий экземпляр Route

Route addOptions(array $options)

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

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

Параметры

array

$options

Опции

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

Route

Текущий экземпляр Route

Route setOption(string $name, mixed $value)

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

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

Параметры

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

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

Route

Текущий экземпляр Route

mixed getOption(string $name)

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

Параметры

string

$name

Имя опции

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

mixed

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

bool hasOption(string $name)

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

Параметры

string

$name

Имя опции

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

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

array getDefaults()

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

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

array

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

Route setDefaults(array $defaults)

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

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

Параметры

array

$defaults

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

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

Route

Текущий экземпляр Route

Route addDefaults(array $defaults)

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

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

Параметры

array

$defaults

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

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

Route

Текущий экземпляр Route

mixed getDefault(string $name)

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

Параметры

string

$name

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

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

mixed

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

bool hasDefault(string $name)

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

Параметры

string

$name

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

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

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

Route setDefault(string $name, mixed $default)

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

Параметры

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

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

Route

Текущий экземпляр Route

array getRequirements()

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

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

array

Требования

Route setRequirements(array $requirements)

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

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

Параметры

array

$requirements

Требования

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

Маршрут

Текущий экземпляр Route

Маршрут addRequirements(array $requirements)

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

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

Параметры

array

$requirements

Требования

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

Маршрут

Текущий экземпляр Route

string|null getRequirement(string $key)

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

Параметры

string

$key

Ключ

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

string|null

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

bool hasRequirement(string $key)

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

Параметры

string

$key

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

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

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

Маршрут setRequirement(string $key, string $regex)

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

Параметры

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

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

Маршрут

Текущий экземпляр Route

string getCondition()

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

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

string

Условие

Маршрут setCondition(string $condition)

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

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

Параметры

string

$condition

Условие

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

Маршрут

Текущий экземпляр Route

СкомпилированныйМаршрут compile()

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

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

СкомпилированныйМаршрут

Экземпляр CompiledRoute

Исключения

LogicException

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

См. также

RouteCompiler

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