Spec-Zone.ru › Laravel 4.2

Маршрут

класс Маршрут (Просмотреть исходный код)

Свойства

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)

Создать новый экземпляр маршрута.

Параметры

массив $methods
строка $uri
Closure|массив $action

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

void

смешанный run()

Выполнить действие маршрута и вернуть ответ.

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

смешанный

bool matches(Request $request, bool $includingMethod = true)

Определить, соответствует ли маршрут данному запросу.

Параметры

Request $request
bool $includingMethod

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

bool

protected void compileRoute()

Скомпилировать маршрут в экземпляр Symfony CompiledRoute.

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

void

protected массив extractOptionalParameters()

Получить необязательные параметры для маршрута.

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

массив

массив beforeFilters()

Получить фильтры "перед" для маршрута.

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

массив

массив afterFilters()

Получить фильтры "после" для маршрута.

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

массив

static массив parseFilters(строка $filters)

Проанализировать заданную строку фильтров.

Параметры

строка $filters

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

массив

static protected массив explodeFilters(массив|строка $filters)

Преобразовать фильтры в массив, если они не являются таковыми.

Параметры

массив|строка $filters

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

массив

static protected массив explodeArrayFilters(массив $filters)

Распаковать массив объявлений фильтров.

Параметры

массив $filters

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

массив

static массив parseFilter(строка $filter)

Проанализировать заданный фильтр на имя и параметры.

Параметры

строка $filter

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

массив

static protected массив parseParameterFilter(строка $filter)

Проанализировать фильтр с параметрами.

Параметры

строка $filter

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

массив

строка getParameter(строка $name, смешанный $default = null)

Получить заданный параметр из маршрута.

Параметры

строка $name
смешанный $default

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

строка

строка parameter(строка $name, смешанный $default = null)

Получить заданный параметр из маршрута.

Параметры

строка $name
смешанный $default

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

строка

void setParameter(строка $name, смешанный $value)

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

Параметры

строка $name
смешанный $value

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

void

void forgetParameter(строка $name)

Удалить параметр из маршрута, если он установлен.

Параметры

строка $name

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

void

массив parameters()

Получить список параметров маршрута.

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

массив

Исключения

LogicException

массив parametersWithoutNulls()

Получить список параметров без нулевых значений.

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

массив

массив parameterNames()

Получить все имена параметров маршрута.

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

массив

protected массив compileParameterNames()

Получить имена параметров маршрута.

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

массив

$this bind(Request $request)

Привязать маршрут к заданному запросу для выполнения.

Параметры

Request $request

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

$this

массив bindParameters(Запрос $request)

Извлечь список параметров из запроса.

Параметры

Запрос $request

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

массив

protected массив bindPathParameters(Запрос $request)

Получить соответствия параметров для части пути URI.

Параметры

Запрос $request

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

массив

protected массив bindHostParameters(Запрос $request, массив $parameters)

Извлечь список параметров из части хоста запроса.

Параметры

Запрос $request
массив $parameters

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

массив

protected массив matchToKeys(массив $matches)

Объединить набор соответствий параметров с ключами маршрута.

Параметры

массив $matches

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

массив

protected массив replaceDefaults(массив $parameters)

Заменить нулевые параметры их значениями по умолчанию.

Параметры

массив $parameters

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

массив

protected массив parseAction(вызов|массив $action)

Разделить действие маршрута на стандартный массив.

Параметры

вызов|массив $action

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

массив

protected Closure findClosure(массив $action)

Найти замыкание в массиве действий.

Параметры

массив $action

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

Closure

static массив getValidators()

Получить валидаторы маршрута для экземпляра.

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

массив

$this before(строка $filters)

Добавить фильтры перед маршрутом.

Параметры

строка $filters

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

$this

$this after(строка $filters)

Добавить фильтры после маршрута.

Параметры

строка $filters

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

$this

protected $this addFilters(строка $type, строка $filters)

Добавить заданные фильтры в маршрут по типу.

Параметры

строка $type
строка $filters

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

$this

$this defaults(строка $key, смешанное $value)

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

Параметры

строка $key
смешанное $value

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

$this

$this where(массив|строка $name, строка $expression = null)

Установить требование регулярного выражения для маршрута.

Параметры

массив|строка $name
строка $expression

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

$this

protected массив parseWhere(массив|строка $name, строка $expression)

Обработать аргументы метода where в массив.

Параметры

массив|строка $name
строка $expression

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

массив

protected $this whereArray(массив $wheres)

Установить список требований регулярных выражений для маршрута.

Параметры

массив $wheres

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

$this

$this prefix(строка $prefix)

Добавить префикс к URI маршрута.

Параметры

строка $prefix

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

$this

строка getPath()

Получить URI, связанный с маршрутом.

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

строка

строка uri()

Получить URI, связанный с маршрутом.

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

строка

массив getMethods()

Получить HTTP-глаголы, на которые реагирует маршрут.

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

массив

массив methods()

Получить HTTP-глаголы, на которые реагирует маршрут.

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

массив

логическое httpOnly()

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

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

логическое

логическое httpsOnly()

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

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

логическое

логическое secure()

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

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

логическое

строка|null domain()

Получить определённый для маршрута домен.

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

строка|null

string getUri()

Получить URI, к которому отвечает маршрут.

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

string

Route setUri(string $uri)

Установить URI, к которому отвечает маршрут.

Параметры

string $uri

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

Route

string getPrefix()

Получить префикс экземпляра маршрута.

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

string

string getName()

Получить имя экземпляра маршрута.

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

string

string getActionName()

Получить имя действия для маршрута.

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

string

array getAction()

Получить массив действий для маршрута.

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

array

$this setAction(array $action)

Установить массив действий для маршрута.

Параметры

array $action

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

$this

CompiledRoute getCompiled()

Получить скомпилированную версию маршрута.

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

CompiledRoute

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/4.2/Illuminate/Routing/Route.html

Spec-Zone.ru

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