Маршрут

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

Трейты

Свойства

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	Компилированная версия маршрута.
protected Router	$router	Экземпляр маршрутизатора, используемый маршрутом.
protected Container	$container	Экземпляр контейнера, используемый маршрутом.
static array	$validators	Валидаторы, используемые маршрутами.

Методы

mixed	callWithDependencies(object $instance, string $method) Вызов метода класса с разрешенными зависимостями.	from RouteDependencyResolverTrait
array	resolveClassMethodDependencies(array $parameters, object $instance, string $method) Разрешение зависимостей, типизированных по типу, для метода объекта.	from RouteDependencyResolverTrait
array	resolveMethodDependencies(array $parameters, ReflectionFunctionAbstract $reflector) Разрешение зависимостей, типизированных по типу, для данного метода.	from RouteDependencyResolverTrait
mixed	transformDependency(ReflectionParameter $parameter, array $parameters, array $originalParameters) Попытка преобразовать данный параметр в экземпляр класса.	from RouteDependencyResolverTrait
bool	alreadyInParameters(string $class, array $parameters) Определение, присутствует ли объект указанного класса в списке параметров.	from RouteDependencyResolverTrait
void	spliceIntoParameters(array $parameters, string $key, mixed $instance) Вставка данного значения в список параметров.	from RouteDependencyResolverTrait
void	__construct(array\|string $methods, string $uri, Closure\|array $action) Создание нового экземпляра маршрута.
mixed	run(Request $request) Выполнение действия маршрута и возврат ответа.
mixed	runCallable(Request $request) Выполнение действия маршрута и возврат ответа.
mixed	runController(Request $request) Выполнение действия маршрута и возврат ответа.
bool	matches(Request $request, bool $includingMethod = true) Определение соответствия маршрута данному запросу.
void	compileRoute() Компиляция маршрута в экземпляр Symfony CompiledRoute.
array	extractOptionalParameters() Получение необязательных параметров для маршрута.
$this\|array	middleware(array\|string\|null $middleware = null) Получение или установка middleware, присоединенных к маршруту.
array	controllerMiddleware() Получение middleware контроллера для маршрута.
array	signatureParameters(string\|null $subClass = null) Получение параметров, указанных в сигнатуре маршрута/контроллера.
bool	hasParameters() Определение наличия параметров у маршрута.
bool	hasParameter(string $name) Определение существования заданного параметра в маршруте.
string\|object	getParameter(string $name, mixed $default = null) Получение заданного параметра из маршрута.
string\|object	parameter(string $name, mixed $default = null) Получение заданного параметра из маршрута.
void	setParameter(string $name, mixed $value) Установление параметра в заданное значение.
void	forgetParameter(string $name) Удаление параметра из маршрута, если он задан.
array	parameters() Получение списка параметров маршрута в формате ключ / значение.
array	parametersWithoutNulls() Получение списка параметров маршрута без значений null.
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) Замена параметров null на их значения по умолчанию.
array	parseAction(callable\|array\|null $action) Разбор действия маршрута в стандартный массив.
callable	findCallable(array $action) Поиск вызываемого объекта в массиве действия.
static array	getValidators() Получение валидаторов маршрута для экземпляра.
$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, к которому реагирует маршрут.
$this	setUri(string $uri) Установить URI, к которому реагирует маршрут.
string	getPrefix() Получить префикс экземпляра маршрута.
string	getName() Получить имя экземпляра маршрута.
$this	name(string $name) Добавить или изменить имя маршрута.
$this	uses(Closure\|string $action) Установить обработчик для маршрута.
string	addGroupNamespaceToStringUses(string $action) Разбор строки действия для метода «uses».
string	getActionName() Получить имя действия для маршрута.
array	getAction() Получить массив действий для маршрута.
$this	setAction(array $action) Установить массив действий для маршрута.
CompiledRoute	getCompiled() Получить скомпилированную версию маршрута.
$this	setRouter(Router $router) Установить экземпляр маршрутизатора для маршрута.
$this	setContainer(Container $container) Установить экземпляр контейнера для маршрута.
void	prepareForSerialization() Подготовить экземпляр маршрута для сериализации.
mixed	__get(string $key) Динамически получить параметры маршрута.

Подробности

protected mixed callWithDependencies(object $instance, string $method)

Вызвать метод класса с разрешёнными зависимостями.

Parameters

объект	$instance
строка	$method

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

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

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

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

Parameters

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

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

массив

array resolveMethodDependencies(array $parameters, ReflectionFunctionAbstract $reflector)

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

Parameters

массив	$parameters
ReflectionFunctionAbstract	$reflector

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

массив

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

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

Parameters

ReflectionParameter	$parameter
массив	$parameters
массив	$originalParameters

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

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

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

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

Parameters

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

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

булево

protected void spliceIntoParameters(array $parameters, string $key, mixed $instance)

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

Parameters

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

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

пусто

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

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

Parameters

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

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

пусто

mixed run(Request $request)

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

Parameters

Request

$request

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

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

protected mixed runCallable(Request $request)

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

Parameters

Request

$request

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

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

protected mixed runController(Request $request)

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

Parameters

Request

$request

Return Value

mixed

Exceptions

NotFoundHttpException

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

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

Parameters

Request	$request
bool	$includingMethod

Return Value

bool

protected void compileRoute()

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

Return Value

void

protected array extractOptionalParameters()

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

Return Value

array

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

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

Parameters

array|string|null

$middleware

Return Value

$this|array

protected array controllerMiddleware()

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

Return Value

array

array signatureParameters(string|null $subClass = null)

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

Parameters

string|null

$subClass

Return Value

array

bool hasParameters()

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

Return Value

bool

bool hasParameter(string $name)

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

Parameters

string

$name

Return Value

bool

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

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

Parameters

string	$name
mixed	$default

Return Value

string|object

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

$this bind(Request $request)

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

Parameters

Request

$request

Return Value

$this

array bindParameters(Request $request)

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

Parameters

Request

$request

Return Value

array

protected array bindPathParameters(Request $request)

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

Parameters

Request

$request

Return Value

array

protected array bindHostParameters(Request $request, array $parameters)

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

Parameters

Request	$request
array	$parameters

Return Value

array

protected array matchToKeys(array $matches)

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

Parameters

array

$matches

Return Value

array

protected array replaceDefaults(array $parameters)

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

Parameters

array

$parameters

Return Value

array

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

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

Parameters

callable|array|null

$action

Return Value

array

Exceptions

UnexpectedValueException

protected callable findCallable(array $action)

Найти вызываемый объект в массиве действий.

Parameters

array

$action

Return Value

callable

static array getValidators()

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

Return Value

array

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

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

Parameters

string	$key
mixed	$value

Return Value

$this

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

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

Parameters

array\|string	$name
string	$expression

Return Value

$this

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

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

Parameters

array\|string	$name
string	$expression

Return Value

array

protected $this whereArray(array $wheres)

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

Parameters

array

$wheres

Return Value

$this

$this prefix(string $prefix)

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

Parameters

string

$prefix

Return Value

$this

string getPath()

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

Return Value

string

string uri()

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

Return Value

string

array getMethods()

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

Return Value

array

array methods()

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

Return Value

array

bool httpOnly()

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

Return Value

bool

bool httpsOnly()

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

Return Value

bool

bool secure()

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

Return Value

bool

string|null domain()

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

Return Value

string|null

string getUri()

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

Return Value

string

$this setUri(string $uri)

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

Parameters

string

$uri

Return Value

$this

string getPrefix()

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

Return Value

string

string getName()

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

Return Value

string

$this name(string $name)

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

Parameters

string

$name

Return Value

$this

$this uses(Closure|string $action)

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

Parameters

Closure|string

$action

Return Value

$this

protected string addGroupNamespaceToStringUses(string $action)

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

Parameters

string

$action

Return Value

string

string getActionName()

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

Return Value

string

array getAction()

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

Return Value

array

$this setAction(array $action)

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

Параметры

array

$action

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

$this

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