Маршрут
класс Route (Просмотр исходного кода)
Трейты
| Macroable | |
| RouteDependencyResolverTrait |
Свойства
| static protected массив | $macros | Зарегистрированные строковые макросы. | из Macroable |
| строка | $uri | Шаблон URI, к которому реагирует маршрут. | |
| массив | $methods | HTTP-методы, на которые реагирует маршрут. | |
| массив | $action | Массив действий маршрута. | |
| логическое значение | $isFallback | Указывает, является ли маршрут маршрутом по умолчанию. | |
| смешанный тип | $controller | Экземпляр контроллера. | |
| массив | $defaults | Значения по умолчанию для маршрута. | |
| массив | $wheres | Требования к регулярным выражениям. | |
| массив|null | $parameters | Массив сопоставленных параметров. | |
| массив|null | $parameterNames | Имена параметров маршрута. | |
| protected массив | $originalParameters | Массив исходных значений сопоставленных параметров. | |
| protected целое число|null | $lockSeconds | Указывает максимальное количество секунд, на которое маршрут должен захватить блокировку сессии. | |
| protected целое число|null | $waitSeconds | Указывает максимальное количество секунд, которое маршрут должен ждать при попытке захватить блокировку сессии. | |
| массив|null | $computedMiddleware | Вычисленные собранные средства защиты. | |
| CompiledRoute | $compiled | Скомпилированная версия маршрута. | |
| protected Router | $router | Экземпляр маршрутизатора, используемый маршрутом. | |
| protected Container | $container | Экземпляр контейнера, используемый маршрутом. | |
| protected массив | $bindingFields | Поля, которые неявное связывание должно использовать для данного параметра. | |
| static массив | $validators | Валидаторы, используемые маршрутами. |
Методы
| static void | macro(string $name, object|callable $macro)
Зарегистрировать пользовательскую макрокоманду. | from Macroable |
| static void | mixin(object $mixin, bool $replace = true)
Добавить другой объект в класс. | 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, object $skippableValue)
Попытаться преобразовать данный параметр в экземпляр класса. | 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|null | parameter(string $name, string|object|null $default = null)
Получить указанный параметр из маршрута. | |
| string|null | originalParameter(string $name, string|null $default = null)
Получить исходное значение указанного параметра из маршрута. | |
| void | setParameter(string $name, string|object|null $value)
Установить параметр для данного значения. | |
| void | forgetParameter(string $name)
Удалить параметр из маршрута, если он установлен. | |
| array | parameters()
Получить список параметров ключа/значения для маршрута. | |
| array | originalParameters()
Получить список параметров исходного ключа/значения для маршрута. | |
| array | parametersWithoutNulls()
Получить список параметров без нулевых значений. | |
| array | parameterNames()
Получить все имена параметров для маршрута. | |
| array | compileParameterNames()
Получить имена параметров для маршрута. | |
| array | signatureParameters(string|null $subClass = null)
Получить параметры, указанные в сигнатуре маршрута/контроллера. | |
| string|null | bindingFieldFor(string|int $parameter)
Получить поле привязки для данного параметра. | |
| array | bindingFields()
Получить поля привязки для маршрута. | |
| $this | setBindingFields(array $bindingFields)
Установить поля привязки для маршрута. | |
| string | parentOfParameter(string $parameter)
Получить родительский параметр данного параметра. | |
| $this | defaults(string $key, mixed $value)
Установить значение по умолчанию для маршрута. | |
| $this | setDefaults(array $defaults)
Установить значения по умолчанию для маршрута. |
| $this | where(array|string $name, string|null $expression = null)
Установите требование регулярного выражения для маршрута. | |
| array | parseWhere(array|string $name, string $expression)
Разбор аргументов метода where в массив. | |
| $this | setWheres(array $wheres)
Установите список требований регулярных выражений для маршрута. | |
| $this | fallback()
Отметить этот маршрут как маршрут по умолчанию. | |
| $this | setFallback(bool $isFallback)
Установить значение по умолчанию. | |
| array | methods()
Получить HTTP-глаголы, к которым реагирует маршрут. | |
| bool | httpOnly()
Определить, отвечает ли маршрут только на HTTP-запросы. | |
| bool | httpsOnly()
Определить, отвечает ли маршрут только на HTTPS-запросы. | |
| bool | secure()
Определить, отвечает ли маршрут только на HTTPS-запросы. | |
| $this|string|null | domain(string|null $domain = null)
Получить или установить домен для маршрута. | |
| string|null | getDomain()
Получить домен, определённый для маршрута. | |
| string|null | getPrefix()
Получить префикс экземпляра маршрута. | |
| $this | prefix(string $prefix)
Добавить префикс к URI маршрута. | |
| void | updatePrefixOnAction(string $prefix)
Обновить атрибут «префикс» в массиве действия. | |
| string | uri()
Получить URI, связанный с маршрутом. | |
| $this | setUri(string $uri)
Установить URI, к которому реагирует маршрут. | |
| string | parseUri(string $uri)
Разбор URI маршрута и нормализация/хранение любых неявных полей связывания. | |
| string|null | 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()
Получить все посредники, включая те, которые из контроллера. | |
| $this|array | middleware(array|string|null $middleware = null)
Получить или установить посредники, присоединённые к маршруту. | |
| array | controllerMiddleware()
Получить посредников для контроллера маршрута. | |
| $this|array | withoutMiddleware(array|string $middleware)
Указать посредники, которые нужно удалить из данного маршрута. | |
| array | excludedMiddleware()
Получить посредников, которые нужно удалить из маршрута. | |
| $this | block(int|null $lockSeconds = 10, int|null $waitSeconds = 10)
Указать, что маршрут не должен разрешать одновременные запросы из одной сессии. | |
| $this | withoutBlocking()
Указать, что маршрут должен разрешать одновременные запросы из одной сессии. | |
| int|null | locksFor()
Получить максимальное количество секунд, в течение которых должна удерживаться блокировка сессии маршрута. | |
| int|null | waitsFor()
Получить максимальное количество секунд ожидания при попытке получить блокировку сессии. | |
| ControllerDispatcher | controllerDispatcher()
Получить диспетчер для контроллера маршрута. | |
| static array | getValidators()
Получить валидаторы маршрута для экземпляра. | |
| Route | toSymfonyRoute()
Преобразовать маршрут в маршрут Symfony. | |
| array | getOptionalParameterNames()
Получить имена необязательных параметров для маршрута. | |
| CompiledRoute | getCompiled()
Получить скомпилированную версию маршрута. | |
| $this | setRouter(Router $router)
Установить экземпляр маршрутизатора на маршруте. | |
| $this | setContainer(Container $container)
Установить экземпляр контейнера на маршруте. | |
| void | prepareForSerialization()
Подготовить экземпляр маршрута для сериализации. | |
| mixed | __get(string $key)
Динамический доступ к параметрам маршрута. |
Подробности
static void macro(string $name, object|callable $macro)
Зарегистрировать пользовательское макро.
static void mixin(object $mixin, bool $replace = true)
Смешать другой объект в класс.
static bool hasMacro(string $name)
Проверяет, зарегистрирован ли макрос.
static mixed __callStatic(string $method, array $parameters)
Динамически обрабатывает вызовы к классу.
mixed __call(string $method, array $parameters)
Динамически обрабатывает вызовы к классу.
protected array resolveClassMethodDependencies(array $parameters, object $instance, string $method)
Разрешает зависимости, указанные типом для метода объекта.
array resolveMethodDependencies(array $parameters, ReflectionFunctionAbstract $reflector)
Разрешает зависимости, указанные типом для данного метода.
protected mixed transformDependency(ReflectionParameter $parameter, array $parameters, object $skippableValue)
Попытка преобразовать заданный параметр в экземпляр класса.
protected bool alreadyInParameters(string $class, array $parameters)
Определяет, есть ли объект заданного класса в списке параметров.
protected void spliceIntoParameters(array $parameters, string $offset, mixed $value)
Вставить заданное значение в список параметров.
void __construct(array|string $methods, string $uri, Closure|array $action)
Создать новый экземпляр Route.
protected array parseAction(callable|array|null $action)
Разбор действия маршрута в стандартный массив.
mixed run()
Выполнить действие маршрута и вернуть ответ.
protected bool isControllerAction()
Проверяет, является ли действие маршрута контроллером.
protected mixed runCallable()
Выполнить действие маршрута и вернуть ответ.
protected mixed runController()
Выполнить действие маршрута и вернуть ответ.
mixed getController()
Получить экземпляр контроллера для маршрута.
protected string getControllerMethod()
Получить метод контроллера, используемый для маршрута.
protected array parseControllerCallback()
Разбор контроллера.
bool matches(Request $request, bool $includingMethod = true)
Определить, соответствует ли маршрут заданному запросу.
protected CompiledRoute compileRoute()
Компилировать маршрут в экземпляр Symfony CompiledRoute.
$this bind(Request $request)
Связать маршрут с заданным запросом для выполнения.
bool hasParameters()
Определить, содержит ли маршрут параметры.
bool hasParameter(string $name)
Определить, существует ли заданный параметр в маршруте.
string|object|null parameter(string $name, string|object|null $default = null)
Получить заданный параметр из маршрута.
string|null originalParameter(string $name, string|null $default = null)
Получить исходное значение заданного параметра из маршрута.
void setParameter(string $name, string|object|null $value)
Установить параметр заданному значению.
void forgetParameter(string $name)
Удалить параметр в маршруте, если он задан.
array parameters()
Получить список параметров маршрута (ключ/значение).
array originalParameters()
Получить список исходных параметров маршрута (ключ/значение).
array parametersWithoutNulls()
Получить список параметров маршрута без нулевых значений.
array parameterNames()
Получить все имена параметров маршрута.
protected array compileParameterNames()
Получить имена параметров маршрута.
array signatureParameters(string|null $subClass = null)
Получить параметры, указанные в сигнатуре маршрута/контроллера.
string|null bindingFieldFor(string|int $parameter)
Получить поле связи для заданного параметра.
array bindingFields()
Получить поля связи для маршрута.
$this setBindingFields(array $bindingFields)
Установить поля связи для маршрута.
string parentOfParameter(string $parameter)
Получить родительский параметр заданного параметра.
$this defaults(string $key, mixed $value)
Установить значение по умолчанию для маршрута.
$this setDefaults(array $defaults)
Установить значения по умолчанию для маршрута.
$this where(array|string $name, string|null $expression = null)
Установить требование к регулярному выражению для маршрута.
protected array parseWhere(array|string $name, string $expression)
Обработать аргументы метода where в массив.
$this setWheres(array $wheres)
Установить список требований к регулярным выражениям для маршрута.
$this fallback()
Отметить этот маршрут как резервный.
$this setFallback(bool $isFallback)
Установить значение резервного варианта.
array methods()
Получить HTTP-глаголы, на которые реагирует маршрут.
bool httpOnly()
Определить, отвечает ли маршрут только на HTTP-запросы.
bool httpsOnly()
Определить, отвечает ли маршрут только на HTTPS-запросы.
bool secure()
Определить, отвечает ли маршрут только на HTTPS-запросы.
$this|string|null domain(string|null $domain = null)
Получить или установить домен для маршрута.
string|null getDomain()
Получить домен, определённый для маршрута.
string|null getPrefix()
Получить префикс экземпляра маршрута.
$this prefix(string $prefix)
Добавить префикс к URI маршрута.
protected void updatePrefixOnAction(string $prefix)
Обновить атрибут "prefix" в массиве действий.
string uri()
Получить URI, связанный с маршрутом.
$this setUri(string $uri)
Установить URI, на который отвечает маршрут.
protected string parseUri(string $uri)
Обработать URI маршрута и нормализовать/сохранить все неявные поля привязки.
string|null getName()
Получить имя экземпляра маршрута.
$this name(string $name)
Добавить или изменить имя маршрута.
bool named(mixed ...$patterns)
Определить, соответствует ли имя маршрута заданным шаблонам.
$this uses(Closure|string $action)
Установить обработчик для маршрута.
protected 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 для контроллера маршрута.
$this|array withoutMiddleware(array|string $middleware)
Указать middleware, которые должны быть удалены из данного маршрута.
array excludedMiddleware()
Получить middleware, которые должны быть удалены из маршрута.
$this block(int|null $lockSeconds = 10, int|null $waitSeconds = 10)
Укажите, что маршрут не должен допускать одновременных запросов от одной и той же сессии.
$this withoutBlocking()
Укажите, что маршрут должен допускать одновременные запросы от одной и той же сессии.
int|null locksFor()
Получить максимальное количество секунд, на которое должно удерживаться блокировка сессии маршрута.
int|null waitsFor()
Получить максимальное количество секунд ожидания при попытке получить блокировку сессии.
ControllerDispatcher controllerDispatcher()
Получить диспетчер для контроллера маршрута.
static array getValidators()
Получить валидаторы маршрута для экземпляра.
Route toSymfonyRoute()
Преобразовать маршрут в маршрут Symfony.
protected array getOptionalParameterNames()
Получить необязательные имена параметров для маршрута.
CompiledRoute getCompiled()
Получить скомпилированную версию маршрута.
$this setRouter(Router $router)
Установить экземпляр маршрутизатора в маршруте.
$this setContainer(Container $container)
Установить экземпляр контейнера в маршруте.
void prepareForSerialization()
Подготовить экземпляр маршрута к сериализации.
mixed __get(string $key)
Динамический доступ к параметрам маршрута.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/7.x/Illuminate/Routing/Route.html
