Маршрут

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

Трейты

Свойства

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

Методы

static void	macro(string $name, object\|callable $macro) Зарегистрировать пользовательское макро.	из Macroable
static void	mixin(object $mixin, bool $replace = true) Смешать другой объект в класс.	из Macroable
static bool	hasMacro(string $name) Проверить, зарегистрировано ли макро.	из Macroable
static mixed	__callStatic(string $method, array $parameters) Динамически обработать вызовы к классу.	из Macroable
mixed	__call(string $method, array $parameters) Динамически обработать вызовы к классу.	из Macroable
array	resolveClassMethodDependencies(array $parameters, object $instance, string $method) Разрешить зависимости, указанные в типе объекта для метода.	из RouteDependencyResolverTrait
array	resolveMethodDependencies(array $parameters, ReflectionFunctionAbstract $reflector) Разрешить зависимости, указанные в типе для данного метода.	из RouteDependencyResolverTrait
mixed	transformDependency(ReflectionParameter $parameter, array $parameters) Попытка преобразовать данный параметр в экземпляр класса.	из RouteDependencyResolverTrait
bool	alreadyInParameters(string $class, array $parameters) Определить, есть ли объект данного класса в списке параметров.	из RouteDependencyResolverTrait
void	spliceIntoParameters(array $parameters, string $offset, mixed $value) Вставить данное значение в список параметров.	из RouteDependencyResolverTrait
void	__construct(array\|string $methods, string $uri, Closure\|array $action) Создать новый экземпляр маршрута.
array	parseAction(callable\|array\|null $action) Разбор действия маршрута в стандартный массив.
mixed	run() Запустить действие маршрута и вернуть ответ.
bool	isControllerAction() Проверить, является ли действие маршрута контроллером.
mixed	runCallable() Запустить действие маршрута и вернуть ответ.
mixed	runController() Запустить действие маршрута и вернуть ответ.
mixed	getController() Получить экземпляр контроллера для маршрута.
string	getControllerMethod() Получить метод контроллера, используемый для маршрута.
array	parseControllerCallback() Разбор контроллера.
bool	matches(Request $request, bool $includingMethod = true) Определить, соответствует ли маршрут заданному запросу.
CompiledRoute	compileRoute() Скомпилировать маршрут в экземпляр Symfony CompiledRoute.
$this	bind(Request $request) Привязать маршрут к заданному запросу для выполнения.
bool	hasParameters() Определить, имеет ли маршрут параметры.
bool	hasParameter(string $name) Определить, существует ли данный параметр в маршруте.
string\|object	parameter(string $name, mixed $default = null) Получить заданный параметр из маршрута.
string	originalParameter(string $name, mixed $default = null) Получить исходное значение заданного параметра из маршрута.
void	setParameter(string $name, mixed $value) Установить параметр со значением.
void	forgetParameter(string $name) Удалить параметр из маршрута, если он установлен.
array	parameters() Получить список параметров маршрута.
array	originalParameters() Получить список исходных параметров маршрута.
array	parametersWithoutNulls() Получить список параметров маршрута без нулевых значений.
array	parameterNames() Получить все имена параметров для маршрута.
array	compileParameterNames() Получить имена параметров для маршрута.
array	signatureParameters(string\|null $subClass = null) Получить параметры, указанные в сигнатуре маршрута/контроллера.
$this	defaults(string $key, mixed $value) Установить значение по умолчанию для маршрута.
$this	where(array\|string $name, string\|null $expression = null) Установить регулярное выражение для маршрута.
array	parseWhere(array\|string $name, string $expression) Разбор аргументов метода where в массив.
$this	whereArray(array $wheres) Установить список регулярных выражений для маршрута.
$this	fallback() Отметить данный маршрут как резервный.
array	methods() Получить HTTP-глаголы, на которые отвечает маршрут.
bool	httpOnly() Определить, отвечает ли маршрут только на HTTP-запросы.

bool	httpsOnly() Определить, отвечает ли маршрут только на запросы HTTPS.
bool	secure() Определить, отвечает ли маршрут только на запросы HTTPS.
$this\|string\|null	domain(string\|null $domain = null) Получить или установить домен для маршрута.
string\|null	getDomain() Получить домен, определённый для маршрута.
string	getPrefix() Получить префикс экземпляра маршрута.
$this	prefix(string $prefix) Добавить префикс к URI маршрута.
string	uri() Получить URI, связанный с маршрутом.
$this	setUri(string $uri) Установить URI, на который отвечает маршрут.
string	getName() Получить имя экземпляра маршрута.
$this	name(string $name) Добавить или изменить имя маршрута.
bool	named(mixed ...$patterns) Определить, соответствует ли имя маршрута заданным шаблонам.
$this	uses(Closure\|string $action) Установить обработчик для маршрута.
string	addGroupNamespaceToStringUses(string $action) Разбор строки действия для флюэнт-метода «uses».
string	getActionName() Получить имя действия для маршрута.
string	getActionMethod() Получить имя метода действия маршрута.
mixed	getAction(string\|null $key = null) Получить массив действия или одну из его свойств для маршрута.
$this	setAction(array $action) Установить массив действия для маршрута.
array	gatherMiddleware() Получить весь middleware, включая middleware из контроллера.
$this\|array	middleware(array\|string\|null $middleware = null) Получить или установить middleware, прикреплённые к маршруту.
array	controllerMiddleware() Получить middleware для контроллера маршрута.
ControllerDispatcher	controllerDispatcher() Получить диспетчер для контроллера маршрута.
static array	getValidators() Получить валидаторы маршрута для экземпляра.
CompiledRoute	getCompiled() Получить скомпилированную версию маршрута.
$this	setRouter(Router $router) Установить экземпляр маршрутизатора для маршрута.
$this	setContainer(Container $container) Установить экземпляр контейнера для маршрута.
void	prepareForSerialization() Подготовить экземпляр маршрута для сериализации.
mixed	__get(string $key) Динамический доступ к параметрам маршрута.

Детали

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательское макро.

Parameters

string	$name
object\|callable	$macro

Return Value

void

static void mixin(object $mixin, bool $replace = true)

Добавить другой объект в класс.

Parameters

object	$mixin
bool	$replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Проверка регистрации макро.

Parameters

string

$name

Return Value

bool

static mixed __callStatic(string $method, array $parameters)

Динамическая обработка вызовов класса.

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамическая обработка вызовов класса.

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

protected array resolveClassMethodDependencies(array $parameters, object $instance, string $method)

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

Parameters

array	$parameters
object	$instance
string	$method

Return Value

array

array resolveMethodDependencies(array $parameters, ReflectionFunctionAbstract $reflector)

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

Parameters

array	$parameters
ReflectionFunctionAbstract	$reflector

Return Value

array

END_OF_DOCUMENT_MARKER

protected mixed transformDependency(ReflectionParameter $parameter, array $parameters)

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

Параметры

ReflectionParameter	$parameter
массив	$parameters

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

mixed

protected bool alreadyInParameters(string $class, array $parameters)

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

Параметры

string	$class
массив	$parameters

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

bool

protected void spliceIntoParameters(array $parameters, string $offset, mixed $value)

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

Параметры

массив	$parameters
string	$offset
mixed	$value

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

void

void __construct(array|string $methods, string $uri, Closure|array $action)

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

Параметры

array\|string	$methods
string	$uri
Closure\|array	$action

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

void

protected array parseAction(callable|array|null $action)

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

Параметры

callable|array|null

$action

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

array

Исключения

UnexpectedValueException

mixed run()

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

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

mixed

protected bool isControllerAction()

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

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

bool

protected mixed runCallable()

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

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

mixed

protected mixed runController()

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

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

mixed

Исключения

NotFoundHttpException

mixed getController()

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

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

mixed

protected string getControllerMethod()

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

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

string

protected array parseControllerCallback()

Обработать контроллер.

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

array

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

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

Параметры

Request	$request
bool	$includingMethod

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

bool

protected CompiledRoute compileRoute()

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

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

CompiledRoute

$this bind(Request $request)

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

Параметры

Request

$request

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

$this

bool hasParameters()

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

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

bool

bool hasParameter(string $name)

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

Параметры

string

$name

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

bool

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

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

Параметры

string	$name
mixed	$default

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

string|object

string originalParameter(string $name, mixed $default = null)

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

Параметры

string	$name
mixed	$default

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

string

void setParameter(string $name, mixed $value)

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

Параметры

string	$name
mixed	$value

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

void

void forgetParameter(string $name)

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

Параметры

string

$name

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

void

array parameters()

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

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

array

Исключения

LogicException

array originalParameters()

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

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

array

Исключения

LogicException

array parametersWithoutNulls()

Получить список параметров ключи/значения без значений null.

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

array

array parameterNames()

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

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

array

protected array compileParameterNames()

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

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

array

array signatureParameters(string|null $subClass = null)

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

Параметры

string|null

$subClass

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

array

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

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

Параметры

string	$key
mixed	$value

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

$this

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

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

Параметры

array\|string	$name
string\|null	$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

$this fallback()

Отметить этот маршрут как резервный маршрут.

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

$this

array methods()

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

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

array

bool httpOnly()

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

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

bool

bool httpsOnly()

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

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

bool

bool secure()

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

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

bool

$this|string|null domain(string|null $domain = null)

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

Параметры

string|null

$domain

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

$this|string|null

string|null getDomain()

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

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

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(mixed ...$patterns)

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

Параметры

mixed

...$patterns

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

bool

$this uses(Closure|string $action)

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

Параметры

Closure|string

$action

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

$this

protected string addGroupNamespaceToStringUses(string $action)

Разбирать строковое действие для флуэнт-метода "uses".

Параметры

string

$action

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

string

строка getActionName()

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

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

строка

строка getActionMethod()

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

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

строка

смешанный тип getAction(string|null $key = null)

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

Параметры

string|null

$key

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

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

$this setAction(array $action)

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

Параметры

массив

$action

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

$this

массив gatherMiddleware()

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

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

массив

$this|массив middleware(array|string|null $middleware = null)

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

Параметры

массив|строка|null

$middleware

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

$this|массив

массив controllerMiddleware()

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

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

массив

ControllerDispatcher controllerDispatcher()

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

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

ControllerDispatcher

статический массив getValidators()

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

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

массив

CompiledRoute getCompiled()

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

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

CompiledRoute

$this setRouter(Router $router)

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

Параметры

Router

$router

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

$this

$this setContainer(Container $container)

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

Параметры

Container

$container

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

$this

void prepareForSerialization()

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

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

void

Исключения

LogicException

смешанный тип __get(string $key)

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

Параметры

строка

$key

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

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

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