Маршрут

класс Route (Просмотр исходного кода)

Трейты

Свойства

строка	$uri	Шаблон URI, к которому реагирует маршрут.
массив	$methods	HTTP-методы, к которым реагирует маршрут.
массив	$action	Массив действий маршрута.
смешанный	$controller	Экземпляр контроллера.
массив	$defaults	Значения по умолчанию для маршрута.
массив	$wheres	Требования к регулярным выражениям.
массив	$parameters	Массив сопоставленных параметров.
массив\|null	$parameterNames	Имена параметров маршрута.
массив\|null	$computedMiddleware	Вычисленный собранный middleware.
CompiledRoute	$compiled	Компилированная версия маршрута.
защищённый Router	$router	Экземпляр маршрутизатора, используемый маршрутом.
защищённый Container	$container	Экземпляр контейнера, используемый маршрутом.
статический массив	$validators	Валидаторы, используемые маршрутами.

Методы

массив	resolveClassMethodDependencies(массив $parameters, объект $instance, строка $method) Разрешить зависимости метода объекта, указанные через type hinting.	из RouteDependencyResolverTrait
массив	resolveMethodDependencies(массив $parameters, ReflectionFunctionAbstract $reflector) Разрешить зависимости указанного метода через type hinting.	из RouteDependencyResolverTrait
смешанный	transformDependency(ReflectionParameter $parameter, массив $parameters) Попытаться преобразовать заданный параметр в экземпляр класса.	из RouteDependencyResolverTrait
булево	alreadyInParameters(строка $class, массив $parameters) Определить, находится ли объект заданного класса в списке параметров.	из RouteDependencyResolverTrait
пустое значение	spliceIntoParameters(массив $parameters, строка $offset, смешанный $value) Вставить заданное значение в список параметров.	из RouteDependencyResolverTrait
пустое значение	__construct(массив\|строка $methods, строка $uri, Closure\|массив $action) Создать новый экземпляр маршрута.
массив	parseAction(вызываемый\|массив\|null $action) Разбить действие маршрута на стандартный массив.
смешанный	run() Выполнить действие маршрута и вернуть ответ.
булево	isControllerAction() Проверка, является ли действие маршрута контроллером.
смешанный	runCallable() Выполнить действие маршрута и вернуть ответ.
смешанный	runController() Выполнить действие маршрута и вернуть ответ.
смешанный	getController() Получить экземпляр контроллера для маршрута.
строка	getControllerMethod() Получить метод контроллера, используемый для маршрута.
массив	parseControllerCallback() Обработать контроллер.
булево	matches(Request $request, булево $includingMethod = true) Определить, соответствует ли маршрут данному запросу.
пустое значение	compileRoute() Скомпилировать маршрут в экземпляр Symfony CompiledRoute.
$this	bind(Request $request) Связать маршрут с заданным запросом для выполнения.
булево	hasParameters() Определить, имеет ли маршрут параметры.
булево	hasParameter(строка $name) Определить, существует ли заданный параметр в маршруте.
строка\|объект	parameter(строка $name, смешанный $default = null) Получить заданный параметр из маршрута.
пустое значение	setParameter(строка $name, смешанный $value) Установить параметр со значением.
пустое значение	forgetParameter(строка $name) Удалить параметр из маршрута, если он установлен.
массив	parameters() Получить список параметров маршрута.
массив	parametersWithoutNulls() Получить список параметров маршрута без нулевых значений.
массив	parameterNames() Получить все имена параметров маршрута.
массив	compileParameterNames() Получить имена параметров маршрута.
массив	signatureParameters(строка\|null $subClass = null) Получить параметры, перечисленные в сигнатуре маршрута/контроллера.
$this	defaults(строка $key, смешанный $value) Установить значение по умолчанию для маршрута.
$this	where(массив\|строка $name, строка $expression = null) Установить регулярное выражение для маршрута.
массив	parseWhere(массив\|строка $name, строка $expression) Обработать аргументы метода where в массив.
$this	whereArray(массив $wheres) Установить список регулярных выражений для маршрута.
массив	methods() Получить HTTP-методы, к которым отвечает маршрут.
булево	httpOnly() Определить, отвечает ли маршрут только на HTTP-запросы.
булево	httpsOnly() Определить, отвечает ли маршрут только на HTTPS-запросы.
булево	secure() Определить, отвечает ли маршрут только на HTTPS-запросы.
строка\|null	domain() Получить домен, определённый для маршрута.
строка	getPrefix() Получить префикс экземпляра маршрута.
$this	prefix(строка $prefix) Добавить префикс к URI маршрута.
строка	uri() Получить URI, связанный с маршрутом.
$this	setUri(строка $uri) Установить URI, к которому отвечает маршрут.
строка	getName() Получить имя экземпляра маршрута.
$this	name(строка $name) Добавить или изменить имя маршрута.
булево	named(строка $name) Определить, совпадает ли имя маршрута с заданным.
$this	uses(Closure\|строка $action) Установить обработчик для маршрута.

строка	addGroupNamespaceToStringUses(строка $action) Разбор строки действия для флюэнт-метода «uses».
строка	getActionName() Получение имени действия для маршрута.
строка	getActionMethod() Получение имени метода действия маршрута.
массив	getAction() Получение массива действий для маршрута.
$this	setAction(массив $action) Установка массива действий для маршрута.
массив	gatherMiddleware() Получение всех мидлваров, включая те, что из контроллера.
$this\|массив	middleware(массив\|строка\|null $middleware = null) Получение или установка мидлваров, прикрепленных к маршруту.
массив	controllerMiddleware() Получение мидлваров для контроллера маршрута.
статический массив	getValidators() Получение валидаторов маршрута для экземпляра.
CompiledRoute	getCompiled() Получение скомпилированной версии маршрута.
$this	setRouter(Router $router) Установка экземпляра роутера на маршрут.
$this	setContainer(Container $container) Установка экземпляра контейнера на маршрут.
void	prepareForSerialization() Подготовка экземпляра маршрута для сериализации.
смешанный тип	__get(строка $key) Динамический доступ к параметрам маршрута.

Подробности

protected массив resolveClassMethodDependencies(массив $parameters, объект $instance, строка $method)

Разрешение зависимостей типа объекта для метода.

Параметры

массив	$parameters
объект	$instance
строка	$method

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

массив

массив resolveMethodDependencies(массив $parameters, ReflectionFunctionAbstract $reflector)

Разрешение зависимостей типа для данного метода.

Параметры

массив	$parameters
ReflectionFunctionAbstract	$reflector

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

массив

protected смешанный тип transformDependency(ReflectionParameter $parameter, массив $parameters)

Попытка преобразовать данный параметр в экземпляр класса.

Параметры

ReflectionParameter	$parameter
массив	$parameters

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

смешанный тип

protected булево alreadyInParameters(строка $class, массив $parameters)

Определение, является ли объект данного класса частью списка параметров.

Параметры

строка	$class
массив	$parameters

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

булево

protected void spliceIntoParameters(массив $parameters, строка $offset, смешанный тип $value)

Вставка заданного значения в список параметров.

Параметры

массив	$parameters
строка	$offset
смешанный тип	$value

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

void

void __construct(массив|строка $methods, строка $uri, Closure|массив $action)

Создание нового экземпляра Route.

Параметры

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

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

void

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

Разбор действия маршрута в стандартный массив.

Параметры

вызов|массив|null

$action

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

массив

Исключения

UnexpectedValueException

смешанный тип run()

Запуск действия маршрута и возврат ответа.

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

смешанный тип

protected булево isControllerAction()

Проверка, является ли действие маршрута контроллером.

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

булево

protected смешанный тип runCallable()

Запуск действия маршрута и возврат ответа.

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

смешанный тип

protected смешанный тип runController()

Запуск действия маршрута и возврат ответа.

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

смешанный тип

Исключения

NotFoundHttpException

смешанный тип getController()

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

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

смешанный тип

protected строка getControllerMethod()

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

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

строка

protected массив parseControllerCallback()

Разбор контроллера.

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

массив

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

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

Parameters

Request	$request
bool	$includingMethod

Return Value

bool

protected void compileRoute()

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

Return Value

void

$this bind(Request $request)

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

Parameters

Request

$request

Return Value

$this

bool hasParameters()

Определить, содержит ли маршрут параметры.

Return Value

bool

bool hasParameter(string $name)

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

Parameters

string

$name

Return Value

bool

string|object parameter(string $name, mixed $default = null)

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

Parameters

string	$name
mixed	$default

Return Value

string|object

void setParameter(string $name, mixed $value)

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

Parameters

string	$name
mixed	$value

Return Value

void

void forgetParameter(string $name)

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

Parameters

string

$name

Return Value

void

array parameters()

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

Return Value

array

Exceptions

LogicException

array parametersWithoutNulls()

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

Return Value

array

array parameterNames()

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

Return Value

array

protected array compileParameterNames()

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

Return Value

array

array signatureParameters(string|null $subClass = null)

Получить параметры, указанные в сигнатуре маршрута / контроллера.

Parameters

string|null

$subClass

Return Value

array

$this defaults(string $key, mixed $value)

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

Параметры

string	$key
mixed	$value

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

$this

$this where(array|string $name, string $expression = null)

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

Параметры

array\|string	$name
string	$expression

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

$this

protected array parseWhere(array|string $name, string $expression)

Разбор аргументов метода where в массив.

Параметры

array\|string	$name
string	$expression

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

array

protected $this whereArray(array $wheres)

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

Параметры

array

$wheres

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

$this

array methods()

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

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

array

bool httpOnly()

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

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

bool

bool httpsOnly()

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

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

bool

bool secure()

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

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

bool

string|null domain()

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

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

string|null

string getPrefix()

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

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

string

$this prefix(string $prefix)

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

Параметры

string

$prefix

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

$this

string uri()

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

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

string

$this setUri(string $uri)

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

Параметры

string

$uri

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

$this

string getName()

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

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

string

$this name(string $name)

Добавить или изменить имя маршрута.

Параметры

string

$name

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

$this

bool named(string $name)

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

Параметры

string

$name

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

bool

$this uses(Closure|string $action)

Установить обработчик для маршрута.

Параметры

Closure|string

$action

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

$this

protected string addGroupNamespaceToStringUses(string $action)

Обработать строковый параметр действия для метода «uses».

Параметры

string

$action

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

string

string getActionName()

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

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

string

string getActionMethod()

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

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

string

array getAction()

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

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

array

$this setAction(array $action)

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

Параметры

array

$action

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

$this

array gatherMiddleware()

Получить весь middleware, включая middleware из контроллера.

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

array

$this|array middleware(array|string|null $middleware = null)

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

Параметры

array|string|null

$middleware

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

$this|array

array controllerMiddleware()

Получить middleware для контроллера маршрута.

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

array

static array getValidators()

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

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

array

CompiledRoute getCompiled()

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

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

CompiledRoute

$this setRouter(Router $router)

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

Параметры

Router

$router

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

$this

$this setContainer(Container $container)

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

Параметры

Container

$container

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

$this

void prepareForSerialization()

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

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

void

Исключения

LogicException

mixed __get(string $key)

Динамический доступ к параметрам маршрута.

Параметры

string

$key

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

mixed

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