Маршрут

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

Трейты

Свойства

статический защищённый массив	$macros	Зарегистрированные строковые макросы.	из Macroable
строка	$uri	Шаблон URI, на который реагирует маршрут.
массив	$methods	HTTP-методы, на которые реагирует маршрут.
массив	$action	Массив действий маршрута.
логический тип	$isFallback	Указывает, является ли маршрут маршрутом по умолчанию.
смешанный тип	$controller	Экземпляр контроллера.
массив	$defaults	Значения по умолчанию для маршрута.
массив	$wheres	Требования регулярных выражений.
массив	$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) Создать новый экземпляр Route.
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, включая тот, что из контроллера.
$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)

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

Параметры

string	$name
object\|callable	$macro

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

void

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

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

Параметры

object	$mixin
bool	$replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

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

Параметры

string

$name

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

bool

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

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

Параметры

string	$method
array	$parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Параметры

string	$method
array	$parameters

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

mixed

Исключения

BadMethodCallException

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

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

Параметры

array	$parameters
object	$instance
string	$method

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

array

array resolveMethodDependencies(array $parameters, ReflectionFunctionAbstract $reflector)

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

Параметры

array	$parameters
ReflectionFunctionAbstract	$reflector

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

array

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

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

Параметры

ReflectionParameter	$parameter
array	$parameters

Значение результата

mixed

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

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

Параметры

string	$class
array	$parameters

Значение результата

bool

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

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

Параметры

array	$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()

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

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

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

string getActionName()

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

Значение возвращаемого значения

string

string getActionMethod()

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

Значение возвращаемого значения

string

mixed getAction(string|null $key = null)

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

Параметры

string|null

$key

Значение возвращаемого значения

mixed

$this setAction(array $action)

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

Параметры

array

$action

Значение возвращаемого значения

$this

array gatherMiddleware()

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

Значение возвращаемого значения

array

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

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

Параметры

array|string|null

$middleware

Значение возвращаемого значения

$this|array

array controllerMiddleware()

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

Значение возвращаемого значения

array

ControllerDispatcher controllerDispatcher()

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

Значение возвращаемого значения

ControllerDispatcher

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.8/Illuminate/Routing/Route.html