Маршрут

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

Трейты

Свойства

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

Методы

static void	macro(string $name, object\|callable $macro) Зарегистрировать пользовательское макро.	from Macroable
static void	mixin(object $mixin) Смешать другой объект в класс.	from Macroable
static bool	hasMacro(string $name) Проверяет, зарегистрировано ли макро.	from Macroable
static mixed	__callStatic(string $method, array $parameters) Динамически обработать вызовы к классу.	from Macroable
mixed	__call(string $method, array $parameters) Динамически обработать вызовы к классу.	from Macroable
array	resolveClassMethodDependencies(array $parameters, object $instance, string $method) Разрешить зависимости типа объекта метода.	from RouteDependencyResolverTrait
array	resolveMethodDependencies(array $parameters, ReflectionFunctionAbstract $reflector) Разрешить зависимости указанного метода.	from RouteDependencyResolverTrait
mixed	transformDependency(ReflectionParameter $parameter, array $parameters) Попробовать преобразовать указанный параметр в экземпляр класса.	from RouteDependencyResolverTrait
bool	alreadyInParameters(string $class, array $parameters) Определить, находится ли объект заданного класса в списке параметров.	from RouteDependencyResolverTrait
void	spliceIntoParameters(array $parameters, string $offset, mixed $value) Вставить заданное значение в список параметров.	from 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) Получить указанный параметр из маршрута.
void	setParameter(string $name, mixed $value) Установить параметр в заданное значение.
void	forgetParameter(string $name) Удалить параметр в маршруте, если он установлен.
array	parameters() Получить список параметров ключа/значения для маршрута.
array	parametersWithoutNulls() Получить список параметров ключа/значения без нулевых значений.
array	parameterNames() Получить все имена параметров для маршрута.
array	compileParameterNames() Получить имена параметров для маршрута.
array	signatureParameters(string\|null $subClass = null) Получить параметры, указанные в сигнатуре маршрута/контроллера.
$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	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(dynamic $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() Получить весь мидлваэр, включая тот, что из контроллера.
$this\|array	middleware(array\|string\|null $middleware = null) Получить или установить мидлваэр, прикреплённый к маршруту.
array	controllerMiddleware() Получить мидлваэр для контроллера маршрута.
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)

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

Parameters

object

$mixin

Return Value

void

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

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

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

Parameters

ReflectionParameter	$parameter
array	$parameters

Return Value

mixed

END_OF_DOCUMENT_MARKER

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)

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

Параметры

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

void setParameter(string $name, mixed $value)

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

Параметры

string	$name
mixed	$value

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

void

void forgetParameter(string $name)

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

Параметры

string

$name

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

void

array parameters()

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

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

array

Исключения

LogicException

array parametersWithoutNulls()

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

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

array

array parameterNames()

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

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

array

protected array compileParameterNames()

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

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

array

массив signatureParameters(строка|null $subClass = null)

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

Параметры

строка|null

$subClass

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

массив

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

Отметить этот маршрут как маршрут по умолчанию.

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

$this

массив methods()

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

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

массив

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

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

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

логическое

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

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

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

логическое

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

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

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

логическое

$this|строка|null domain(строка|null $domain = null)

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

Параметры

строка|null

$domain

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

$this|строка|null

строка|null getDomain()

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

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

строка|null

строка getPrefix()

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

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

строка

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

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

Параметры

строка

$prefix

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

$this

строка uri()

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

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

строка

$this setUri(строка $uri)

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

Параметры

строка

$uri

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

$this

строка getName()

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

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

строка

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

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

Параметры

строка

$name

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

$this

логическое named(динамический $patterns)

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

Параметры

динамический

$patterns

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

логическое

$this uses(Closure|строка $action)

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

Параметры

Closure|строка

$action

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

$this

protected строка addGroupNamespaceToStringUses(строка $action)

Разбор действия, заданного строкой, для флюэнт-метода «uses».

Параметры

строка

$action

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

строка

строка getActionName()

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

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

строка

строка getActionMethod()

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

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

строка

смешанный getAction(строка|null $key = null)

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

Параметры

строка|null

$key

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

смешанный

$this setAction(массив $action)

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

Параметры

массив

$action

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

$this

массив gatherMiddleware()

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

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

массив

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

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

Параметры

array|string|null

$middleware

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

$this|array

array controllerMiddleware()

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

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

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