Маршрут
класс Route реализует Serializable
Маршрут описывает маршрут и его параметры.
Методы
| __construct(string $path, array $defaults = array(), array $requirements = array(), array $options = array(), string $host = '', string|string[] $schemes = array(), string|string[] $methods = array(), string $condition = '') Доступные параметры: | ||
| serialize() {@inheritdoc} | ||
| unserialize($serialized) {@inheritdoc} | ||
| строка | getPattern() устарело Возвращает шаблон для пути. | |
| $this | setPattern(string $pattern) устарело Устанавливает шаблон для пути. | |
| строка | getPath() Возвращает шаблон для пути. | |
| $this | setPath(string $pattern) Устанавливает шаблон для пути. | |
| строка | getHost() Возвращает шаблон для хоста. | |
| $this | setHost(string $pattern) Устанавливает шаблон для хоста. | |
| строка[] | getSchemes() Возвращает схемы (в нижнем регистре), к которым ограничен данный маршрут. | |
| $this | setSchemes(string|string[] $schemes) Устанавливает схемы (например, 'https'), к которым ограничен данный маршрут. | |
| булево | hasScheme(string $scheme) Проверяет, установлено ли ограничение по схеме. | |
| строка[] | getMethods() Возвращает HTTP-методы (в верхнем регистре), к которым ограничен данный маршрут. | |
| $this | setMethods(string|string[] $methods) Устанавливает HTTP-методы (например, 'POST'), к которым ограничен данный маршрут. | |
| массив | getOptions() Возвращает параметры. | |
| $this | setOptions(array $options) Устанавливает параметры. | |
| $this | addOptions(array $options) Добавляет параметры. | |
| $this | setOption(string $name, mixed $value) Устанавливает значение параметра. | |
| смешанный | getOption(string $name) Получить значение параметра. | |
| булево | hasOption(string $name) Проверяет, установлен ли параметр. | |
| массив | getDefaults() Возвращает значения по умолчанию. | |
| $this | setDefaults(array $defaults) Устанавливает значения по умолчанию. | |
| $this | addDefaults(array $defaults) Добавляет значения по умолчанию. | |
| смешанный | getDefault(string $name) Получает значение по умолчанию. | |
| булево | hasDefault(string $name) Проверяет, установлено ли значение по умолчанию для данной переменной. | |
| $this | setDefault(string $name, mixed $default) Устанавливает значение по умолчанию. | |
| массив | getRequirements() Возвращает требования. | |
| $this | setRequirements(array $requirements) Устанавливает требования. | |
| $this | addRequirements(array $requirements) Добавляет требования. | |
| строка|null | getRequirement(string $key) Возвращает требование для данного ключа. | |
| булево | hasRequirement(string $key) Проверяет, установлено ли требование для данного ключа. | |
| $this | setRequirement(string $key, string $regex) Устанавливает требование для данного ключа. | |
| строка | getCondition() Возвращает условие. | |
| $this | setCondition(string $condition) Устанавливает условие. | |
| CompiledRoute | compile() Компилирует маршрут. |
Подробности
__construct(string $path, array $defaults = array(), array $requirements = array(), array $options = array(), string $host = '', string|string[] $schemes = array(), string|string[] $methods = array(), string $condition = '')
Доступные параметры:
- compiler_class: Имя класса, способного скомпилировать этот маршрут (RouteCompiler по умолчанию)
Параметры
| string | $path | Шаблон пути для сопоставления |
| array | $defaults | Массив значений параметров по умолчанию |
| array | $requirements | Массив требований к параметрам (регулярные выражения) |
| array | $options | Массив параметров |
| string | $host | Шаблон хоста для сопоставления |
| string|string[] | $schemes | Требуемый URI-схему или массив ограниченных схем |
| string|string[] | $methods | Требуемый HTTP-метод или массив ограниченных методов |
| string | $condition | Условие, которое должно быть истинным для соответствия маршруту |
serialize()
{@inheritdoc}
unserialize($serialized)
{@inheritdoc}
Параметры
| $serialized |
string getPattern() устаревший
устаревший
Возвращает шаблон пути.
Возвращаемое значение
| string | Шаблон |
$this setPattern(string $pattern) устаревший
устаревший
Устанавливает шаблон пути.
Этот метод реализует интерфейс fluent.
Параметры
| string | $pattern | Шаблон пути |
Возвращаемое значение
| $this |
string getPath()
Возвращает шаблон пути.
Возвращаемое значение
| string | Шаблон пути |
$this setPath(string $pattern)
Устанавливает шаблон пути.
Этот метод реализует интерфейс fluent.
Параметры
| string | $pattern | Шаблон пути |
Возвращаемое значение
| $this |
string getHost()
Возвращает шаблон хоста.
Возвращаемое значение
| string | Шаблон хоста |
$this setHost(string $pattern)
Устанавливает шаблон хоста.
Этот метод реализует интерфейс fluent.
Параметры
| string | $pattern | Шаблон хоста |
Возвращаемое значение
| $this |
string[] getSchemes()
Возвращает схему маршрута в нижнем регистре.
Пустой массив означает, что разрешена любая схема.
Возвращаемое значение
| string[] | Схемы |
$this setSchemes(string|string[] $schemes)
Устанавливает схемы (например, 'https') для этого маршрута.
Пустой массив означает, что разрешена любая схема.
Этот метод реализует интерфейс fluent.
Параметры
| string|string[] | $schemes | Схема или массив схем |
Возвращаемое значение
| $this |
bool hasScheme(string $scheme)
Проверяет, задано ли требование к схеме.
Параметры
| string | $scheme |
Возвращаемое значение
| bool | true, если требование к схеме существует, иначе false |
string[] getMethods()
Возвращает заглавные HTTP-методы, к которым ограничен этот маршрут.
Пустой массив означает, что разрешен любой метод.
Возвращаемое значение
| 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)
Добавляет требования.
Этот метод реализует интерфейс цепочки вызовов.
Параметры
| массив | $requirements | Требования |
Возвращаемое значение
| $this |
string|null getRequirement(string $key)
Возвращает требование для данного ключа.
Параметры
| строка | $key | Ключ |
Возвращаемое значение
| string|null | Регулярное выражение или null, если не задано |
bool hasRequirement(string $key)
Проверяет, задано ли требование для данного ключа.
Параметры
| строка | $key | Имя переменной |
Возвращаемое значение
| bool | true, если требование указано, иначе false |
$this setRequirement(string $key, string $regex)
Устанавливает требование для данного ключа.
Параметры
| строка | $key | Ключ |
| строка | $regex | Регулярное выражение |
Возвращаемое значение
| $this |
string getCondition()
Возвращает условие.
Возвращаемое значение
| строка | Условие |
$this setCondition(string $condition)
Устанавливает условие.
Этот метод реализует интерфейс цепочки вызовов.
Параметры
| строка | $condition | Условие |
Возвращаемое значение
| $this |
CompiledRoute compile()
Компилирует маршрут.
Возвращаемое значение
| CompiledRoute | Экземпляр CompiledRoute |
Исключения
| LogicException | Если маршрут не может быть скомпилирован из-за некорректного шаблона пути или хоста |
См. также
| RouteCompiler | который отвечает за процесс компиляции |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/Routing/Route.html
