Маршрут
класс Route (Просмотреть исходный код)
Трейты
| СоздаетОграниченияМаршрутаРегулярныхВыражений | |
| Macroable | |
| ТрейтРазрешенияЗависимостейМаршрута |
Свойства
| статический защищенный массив | $macros | Зарегистрированные строковые макросы. | из Macroable |
| строка | $uri | Шаблон URI, к которому реагирует маршрут. | |
| массив | $methods | HTTP-методы, на которые реагирует маршрут. | |
| массив | $action | Массив действий маршрута. | |
| логическое значение | $isFallback | Указывает, является ли маршрут маршрутом по умолчанию. | |
| смешанное | $controller | Экземпляр контроллера. | |
| массив | $defaults | Значения по умолчанию для маршрута. | |
| массив | $wheres | Требования к регулярным выражениям. | |
| массив или null | $parameters | Массив сопоставленных параметров. | |
| массив или null | $parameterNames | Имена параметров маршрута. | |
| защищенный массив | $originalParameters | Массив исходных значений сопоставленных параметров. | |
| защищенный булево значение | $withTrashedBindings | Указывает, могут ли быть получены модели "удаленные" при разрешении неявных привязок модели для данного маршрута. | |
| защищенный целое число или null | $lockSeconds | Указывает максимальное количество секунд, в течение которых маршрут должен захватывать блокировку сессии. | |
| защищенный целое число или null | $waitSeconds | Указывает максимальное количество секунд, которые маршрут должен ждать при попытке захватить блокировку сессии. | |
| массив или null | $computedMiddleware | Вычисленный собранный middleware. | |
| CompiledRoute | $compiled | Скомпилированная версия маршрута. | |
| защищенный Router | $router | Экземпляр маршрутизатора, используемый маршрутом. | |
| защищенный Container | $container | Экземпляр контейнера, используемый маршрутом. | |
| защищенный массив | $bindingFields | Поля, которые неявная привязка должна использовать для данного параметра. | |
| статический массив | $validators | Ва́лидаторы, используемые маршрутами. |
Методы
| $this | whereAlpha(array|string $parameters)
Укажите, что указанные параметры маршрута должны быть буквенными. | from CreatesRegularExpressionRouteConstraints |
| $this | whereAlphaNumeric(array|string $parameters)
Укажите, что указанные параметры маршрута должны быть буквенно-цифровыми. | from CreatesRegularExpressionRouteConstraints |
| $this | whereNumber(array|string $parameters)
Укажите, что указанные параметры маршрута должны быть числовыми. | from CreatesRegularExpressionRouteConstraints |
| $this | whereUuid(array|string $parameters)
Укажите, что указанные параметры маршрута должны быть UUID. | from CreatesRegularExpressionRouteConstraints |
| $this | assignExpressionToParameters(array|string $parameters, string $expression)
Примените заданное регулярное выражение к заданным параметрам. | from CreatesRegularExpressionRouteConstraints |
| 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 void | flushMacros()
Очистить существующие макросы. | 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()
Выполнить действие маршрута и вернуть ответ. | |
| bool | isSerializedClosure()
Определить, является ли действие маршрута сериализованным замыканием. | |
| mixed | runController()
Выполнить действие маршрута и вернуть ответ. | |
| mixed | getController()
Получить экземпляр контроллера для маршрута. | |
| string | getControllerMethod()
Получить метод контроллера, используемый для маршрута. | |
| array | parseControllerCallback()
Обработать контроллер. | |
| void | flushController()
Очистить кэшированный экземпляр контейнера на маршруте. | |
| 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 | withTrashed(bool $withTrashed = true)
Разрешить получение "удалённых" моделей при разрешении неявных привязок моделей для этого маршрута. | |
| bool | allowsTrashedBindings()
Определяет, разрешает ли маршрут получение "удалённых" моделей при разрешении неявных привязок моделей. | |
| $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)
Обновить атрибут "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|array|string $action)
Установить обработчик для маршрута. | |
| string | addGroupNamespaceToStringUses(string $action)
Разбор действия, заданного строкой, для флуент-метода "uses". | |
| string | getActionName()
Получить имя действия для маршрута. | |
| string | getActionMethod()
Получить имя метода действия маршрута. | |
| mixed | getAction(string|null $key = null)
Получить массив действий или одно из его свойств для маршрута. | |
| $this | setAction(array $action)
Установить массив действий для маршрута. | |
| Closure|null | getMissing()
Получить значение действия, которое должно быть выполнено при исключении отсутствия модели. | |
| $this | missing(Closure $missing)
Определить вызываемую функцию, которая должна быть вызвана при возникновении исключения отсутствия модели. | |
| array | gatherMiddleware()
Получить все промежуточное ПО, включая промежуточное ПО из контроллера. | |
| $this|array | middleware(array|string|null $middleware = null)
Получить или установить промежуточное ПО, присоединённое к маршруту. | |
| $this | can(string $ability, array|string $models = [])
Указать, что промежуточное ПО "Authorize" / "can" должно быть применено к маршруту с заданными параметрами. | |
| array | controllerMiddleware()
Получить промежуточное ПО для контроллера маршрута. | |
| $this|array | withoutMiddleware(array|string $middleware)
Указать промежуточное ПО, которое следует удалить из данного маршрута. | |
| array | excludedMiddleware()
Получить промежуточное ПО, которое следует удалить из маршрута. |
| bool | scopeBindings()
Указать, что маршрут должен принудительно ограничить область действия нескольких неявных связываний Eloquent. | |
| bool | enforcesScopedBindings()
Определить, должен ли маршрут принудительно ограничить область действия нескольких неявных связываний Eloquent. | |
| $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)
Динамический доступ к параметрам маршрута. |
Подробности
$this whereAlpha(array|string $parameters)
Указать, что заданные параметры маршрута должны быть алфавитными.
$this whereAlphaNumeric(array|string $parameters)
Указать, что заданные параметры маршрута должны быть алфавитно-цифровыми.
$this whereNumber(array|string $parameters)
Указать, что заданные параметры маршрута должны быть числовыми.
$this whereUuid(array|string $parameters)
Указать, что заданные параметры маршрута должны быть UUID.
protected $this assignExpressionToParameters(array|string $parameters, string $expression)
Применить заданное регулярное выражение к заданным параметрам.
static void macro(string $name, object|callable $macro)
Регистрация пользовательского макроса.
static void mixin(object $mixin, bool $replace = true)
Смешивание другого объекта в класс.
static bool hasMacro(string $name)
Проверка наличия зарегистрированного макроса.
static void flushMacros()
Очистка существующих макросов.
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 bool isSerializedClosure()
Определить, является ли действие маршрута сериализованным замыканием.
protected mixed runController()
Запуск действия маршрута и возврат ответа.
mixed getController()
Получить экземпляр контроллера для маршрута.
protected string getControllerMethod()
Получить метод контроллера, используемый для маршрута.
protected array parseControllerCallback()
Разбор контроллера.
void flushController()
Очистить кэшированный экземпляр контейнера на маршруте.
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 withTrashed(bool $withTrashed = true)
Разрешить получение "удалённых" моделей при разрешении неявных привязок моделей для этого маршрута.
bool allowsTrashedBindings()
Определяет, разрешает ли маршрут получение "удалённых" моделей при разрешении неявных привязок моделей.
$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)
Обновить атрибут "префикс" в массиве действий.
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|array|string $action)
Установить обработчик для маршрута.
protected string addGroupNamespaceToStringUses(string $action)
Обработать строку-действие для флюэнт-метода "uses".
string getActionName()
Получить имя действия для маршрута.
string getActionMethod()
Получить имя метода действия маршрута.
mixed getAction(string|null $key = null)
Получить массив действий или одну из его свойств для маршрута.
$this setAction(array $action)
Установить массив действий для маршрута.
Closure|null getMissing()
Получить значение действия, которое должно быть выполнено при исключении отсутствия модели.
$this missing(Closure $missing)
Определить вызываемый объект, который должен быть вызван при исключении отсутствия модели.
array gatherMiddleware()
Получить все middleware, включая middleware из контроллера.
$this|array middleware(array|string|null $middleware = null)
Получить или установить middleware, присоединённые к маршруту.
$this can(string $ability, array|string $models = [])
Указать, что middleware "Authorize" / "can" должен быть применён к маршруту с данными параметрами.
array controllerMiddleware()
Получить middleware для контроллера маршрута.
$this|array withoutMiddleware(array|string $middleware)
Указать middleware, которые необходимо удалить из данного маршрута.
array excludedMiddleware()
Получить middleware, которые необходимо удалить из маршрута.
bool scopeBindings()
Указать, что маршрут должен применять ограничение к нескольким неявным связываниям Eloquent.
bool enforcesScopedBindings()
Определить, должен ли маршрут применять ограничение к нескольким неявным связываниям Eloquent.
$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/8.x/Illuminate/Routing/Route.html
