Маршрут
класс Маршрут (Просмотреть исходный код)
Свойства
| protected string | $uri | Шаблон URI, к которому отвечает маршрут. | |
| protected array | $methods | HTTP-методы, к которым отвечает маршрут. | |
| protected array | $action | Массив действия маршрута. | |
| protected array | $defaults | Значения по умолчанию для маршрута. | |
| protected array | $wheres | Требования к регулярным выражениям. | |
| protected array | $parameters | Массив сопоставленных параметров. | |
| protected array|null | $parameterNames | Имена параметров маршрута. | |
| protected CompiledRoute | $compiled | Компилированная версия маршрута. | |
| static protected array | $validators | Ва́лидаторы, используемые маршрутами. |
Методы
| void | __construct(array $methods, string $uri, Closure|array $action) Создать новый экземпляр Route. | |
| mixed | run() Выполнить действие маршрута и вернуть ответ. | |
| bool | matches(Request $request, bool $includingMethod = true) Определить, соответствует ли маршрут данному запросу. | |
| void | compileRoute() Скомпилировать маршрут в экземпляр Symfony CompiledRoute. | |
| array | extractOptionalParameters() Получить необязательные параметры для маршрута. | |
| array | beforeFilters() Получить фильтры "перед" для маршрута. | |
| array | afterFilters() Получить фильтры "после" для маршрута. | |
| static array | parseFilters(string $filters) Проанализировать заданную строку фильтров. | |
| static array | explodeFilters(array|string $filters) Преобразовать фильтры в массив, если это не массив. | |
| static array | explodeArrayFilters(array $filters) Распаковать массив объявлений фильтров. | |
| static array | parseFilter(string $filter) Проанализировать заданный фильтр на имя и параметры. | |
| static array | parseParameterFilter(string $filter) Проанализировать фильтр с параметрами. | |
| string | getParameter(string $name, mixed $default = null) Получить заданный параметр из маршрута. | |
| string | parameter(string $name, mixed $default = null) Получить заданный параметр из маршрута. | |
| void | setParameter(string $name, mixed $value) Установить параметр в заданное значение. | |
| void | forgetParameter(string $name) Удалить параметр в маршруте, если он установлен. | |
| array | parameters() Получить список параметров маршрута. | |
| array | parametersWithoutNulls() Получить список параметров без нулевых значений. | |
| array | parameterNames() Получить все имена параметров маршрута. | |
| array | compileParameterNames() Получить имена параметров маршрута. | |
| $this | bind(Request $request) Связать маршрут с заданным запросом для выполнения. | |
| array | bindParameters(Request $request) Извлечь список параметров из запроса. | |
| array | bindPathParameters(Request $request) Получить соответствия параметров для пути URI. | |
| array | bindHostParameters(Request $request, array $parameters) Извлечь список параметров из части хоста запроса. | |
| array | matchToKeys(array $matches) Объединить набор соответствий параметров с ключами маршрута. | |
| array | replaceDefaults(array $parameters) Заменить нулевые параметры их значениями по умолчанию. | |
| array | parseAction(callable|array $action) Проанализировать действие маршрута в стандартный массив. | |
| Closure | findClosure(array $action) Найти Closure в массиве действий. | |
| static array | getValidators() Получить валидаторы маршрута для экземпляра. | |
| $this | before(string $filters) Добавить фильтры "перед" к маршруту. | |
| $this | after(string $filters) Добавить фильтры "после" к маршруту. | |
| $this | addFilters(string $type, string $filters) Добавить заданные фильтры к маршруту по типу. | |
| $this | defaults(string $key, mixed $value) Установить значение по умолчанию для маршрута. | |
| $this | where(array|string $name, string $expression = null) Установить требование регулярного выражения для маршрута. | |
| array | parseWhere(array|string $name, string $expression) Проанализировать аргументы метода where в массив. | |
| $this | whereArray(array $wheres) Установить список требований регулярных выражений для маршрута. | |
| $this | prefix(string $prefix) Добавить префикс к URI маршрута. | |
| string | getPath() Получить URI, связанный с маршрутом. | |
| string | uri() Получить URI, связанный с маршрутом. | |
| array | getMethods() Получить HTTP-глаголы, к которым реагирует маршрут. | |
| array | methods() Получить HTTP-глаголы, к которым реагирует маршрут. | |
| bool | httpOnly() Определить, реагирует ли маршрут только на HTTP-запросы. | |
| bool | httpsOnly() Определить, реагирует ли маршрут только на HTTPS-запросы. | |
| bool | secure() Определить, реагирует ли маршрут только на HTTPS-запросы. | |
| string|null | domain() Получить домен, определённый для маршрута. | |
| string | getUri() Получить URI, на который реагирует маршрут. | |
| Route | setUri(string $uri) Установить URI, на который реагирует маршрут. | |
| string | getPrefix() Получить префикс экземпляра маршрута. |
| строка | getName() Получить имя экземпляра маршрута. | |
| строка | getActionName() Получить имя действия для маршрута. | |
| массив | getAction() Получить массив действий для маршрута. | |
| $this | setAction(массив $action) Установить массив действий для маршрута. | |
| CompiledRoute | getCompiled() Получить скомпилированную версию маршрута. |
Подробности
void __construct(массив $methods, строка $uri, Closure|массив $action)
Создать новый экземпляр маршрута.
смешанный run()
Выполнить действие маршрута и вернуть ответ.
bool matches(Request $request, bool $includingMethod = true)
Определить, соответствует ли маршрут данному запросу.
protected void compileRoute()
Скомпилировать маршрут в экземпляр Symfony CompiledRoute.
protected массив extractOptionalParameters()
Получить необязательные параметры для маршрута.
массив beforeFilters()
Получить фильтры "перед" для маршрута.
массив afterFilters()
Получить фильтры "после" для маршрута.
static массив parseFilters(строка $filters)
Проанализировать заданную строку фильтров.
static protected массив explodeFilters(массив|строка $filters)
Преобразовать фильтры в массив, если они не являются таковыми.
static protected массив explodeArrayFilters(массив $filters)
Распаковать массив объявлений фильтров.
static массив parseFilter(строка $filter)
Проанализировать заданный фильтр на имя и параметры.
static protected массив parseParameterFilter(строка $filter)
Проанализировать фильтр с параметрами.
строка getParameter(строка $name, смешанный $default = null)
Получить заданный параметр из маршрута.
строка parameter(строка $name, смешанный $default = null)
Получить заданный параметр из маршрута.
void setParameter(строка $name, смешанный $value)
Установить параметр заданному значению.
void forgetParameter(строка $name)
Удалить параметр из маршрута, если он установлен.
массив parameters()
Получить список параметров маршрута.
массив parametersWithoutNulls()
Получить список параметров без нулевых значений.
массив parameterNames()
Получить все имена параметров маршрута.
protected массив compileParameterNames()
Получить имена параметров маршрута.
$this bind(Request $request)
Привязать маршрут к заданному запросу для выполнения.
массив bindParameters(Запрос $request)
Извлечь список параметров из запроса.
protected массив bindPathParameters(Запрос $request)
Получить соответствия параметров для части пути URI.
protected массив bindHostParameters(Запрос $request, массив $parameters)
Извлечь список параметров из части хоста запроса.
protected массив matchToKeys(массив $matches)
Объединить набор соответствий параметров с ключами маршрута.
protected массив replaceDefaults(массив $parameters)
Заменить нулевые параметры их значениями по умолчанию.
protected массив parseAction(вызов|массив $action)
Разделить действие маршрута на стандартный массив.
protected Closure findClosure(массив $action)
Найти замыкание в массиве действий.
static массив getValidators()
Получить валидаторы маршрута для экземпляра.
$this before(строка $filters)
Добавить фильтры перед маршрутом.
$this after(строка $filters)
Добавить фильтры после маршрута.
protected $this addFilters(строка $type, строка $filters)
Добавить заданные фильтры в маршрут по типу.
$this defaults(строка $key, смешанное $value)
Установить значение по умолчанию для маршрута.
$this where(массив|строка $name, строка $expression = null)
Установить требование регулярного выражения для маршрута.
protected массив parseWhere(массив|строка $name, строка $expression)
Обработать аргументы метода where в массив.
protected $this whereArray(массив $wheres)
Установить список требований регулярных выражений для маршрута.
$this prefix(строка $prefix)
Добавить префикс к URI маршрута.
строка getPath()
Получить URI, связанный с маршрутом.
строка uri()
Получить URI, связанный с маршрутом.
массив getMethods()
Получить HTTP-глаголы, на которые реагирует маршрут.
массив methods()
Получить HTTP-глаголы, на которые реагирует маршрут.
логическое httpOnly()
Определить, отвечает ли маршрут только на HTTP-запросы.
логическое httpsOnly()
Определить, отвечает ли маршрут только на HTTPS-запросы.
логическое secure()
Определить, отвечает ли маршрут только на HTTPS-запросы.
строка|null domain()
Получить определённый для маршрута домен.
string getUri()
Получить URI, к которому отвечает маршрут.
Route setUri(string $uri)
Установить URI, к которому отвечает маршрут.
string getPrefix()
Получить префикс экземпляра маршрута.
string getName()
Получить имя экземпляра маршрута.
string getActionName()
Получить имя действия для маршрута.
array getAction()
Получить массив действий для маршрута.
$this setAction(array $action)
Установить массив действий для маршрута.
CompiledRoute getCompiled()
Получить скомпилированную версию маршрута.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/4.2/Illuminate/Routing/Route.html