Маршрут
класс Маршрут (Просмотр исходного кода)
Трейты
| СоздаётОграниченияМаршрутаПоРегулярнымВыражениям | |
| Macroable | |
| ТрейтРазрешенияЗависимостейМаршрута |
Свойства
| static protected массив | $macros | Зарегистрированные строковые макросы. | из Macroable |
| строка | $uri | Шаблон URI, к которому реагирует маршрут. | |
| массив | $methods | HTTP-методы, к которым реагирует маршрут. | |
| массив | $action | Массив действия маршрута. | |
| bool | $isFallback | Указывает, является ли маршрут резервным. | |
| mixed | $controller | Экземпляр контроллера. | |
| массив | $defaults | Значения по умолчанию для маршрута. | |
| массив | $wheres | Требования к регулярным выражениям. | |
| массив|null | $parameters | Массив сопоставленных параметров. | |
| массив|null | $parameterNames | Имена параметров для маршрута. | |
| protected массив | $originalParameters | Массив исходных значений сопоставленных параметров. | |
| protected bool | $withTrashedBindings | Указывает, могут ли быть получены модели «удалённые» при разрешении неявных привязок моделей для этого маршрута. | |
| protected int|null | $lockSeconds | Указывает максимальное количество секунд, в течение которых маршрут должен захватывать блокировку сессии. | |
| protected int|null | $waitSeconds | Указывает максимальное количество секунд, в течение которых маршрут должен ждать, пытаясь захватить блокировку сессии. | |
| массив|null | $computedMiddleware | Вычисленные собранные промежуточные программные компоненты. | |
| CompiledRoute | $compiled | Компилированная версия маршрута. | |
| protected Router | $router | Экземпляр маршрутизатора, используемый маршрутом. | |
| protected Container | $container | Экземпляр контейнера, используемый маршрутом. | |
| protected массив | $bindingFields | Поля, которые должны использоваться неявной привязкой для данного параметра. | |
| static массив | $validators | Валидаторы, используемые маршрутами. |
Методы
| $this | whereAlpha(array|string $parameters) Укажите, что заданные параметры маршрута должны быть буквенными. | from CreatesRegularExpressionRouteConstraints |
| $this | whereAlphaNumeric(array|string $parameters) Укажите, что заданные параметры маршрута должны быть буквенно-цифровыми. | from CreatesRegularExpressionRouteConstraints |
| $this | whereNumber(array|string $parameters) Укажите, что заданные параметры маршрута должны быть числовыми. | from CreatesRegularExpressionRouteConstraints |
| $this | whereUlid(array|string $parameters) Укажите, что заданные параметры маршрута должны быть ULID. | from CreatesRegularExpressionRouteConstraints |
| $this | whereUuid(array|string $parameters) Укажите, что заданные параметры маршрута должны быть UUID. | from CreatesRegularExpressionRouteConstraints |
| $this | whereIn(array|string $parameters, array $values) Укажите, что заданные параметры маршрута должны быть одним из указанных значений. | 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 | getControllerClass() Получить класс контроллера, используемый для маршрута. | |
| 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(array $conditions = [])
Получить параметры, указанные в сигнатуре маршрута/контроллера. | |
| 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)
Обновить атрибут "префикс" в массиве действий. | |
| 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()
Получить весь middleware, включая middleware из контроллера. |
| $this|array | middleware(array|string|null $middleware = null)
Получить или установить установленные на маршрут посредники. | |
| $this | can(string $ability, array|string $models = [])
Указать, что посредник "Authorize" / "can" должен быть применён к маршруту с заданными параметрами. | |
| array | controllerMiddleware()
Получить посредники для контроллера маршрута. | |
| array | staticallyProvidedControllerMiddleware(string $class, string $method)
Получить статически заданные посредники контроллера для данного класса и метода. | |
| $this | withoutMiddleware(array|string $middleware)
Указать посредники, которые следует удалить из данного маршрута. | |
| array | excludedMiddleware()
Получить посредники, которые следует удалить из маршрута. | |
| $this | scopeBindings()
Указать, что маршрут должен применять области видимости для нескольких неявных Eloquent связей. | |
| $this | withoutScopedBindings()
Указать, что маршрут не должен применять области видимости для нескольких неявных Eloquent связей. | |
| bool | enforcesScopedBindings()
Определить, должен ли маршрут применять области видимости для нескольких неявных Eloquent связей. | |
| bool | preventsScopedBindings()
Определить, должен ли маршрут предотвращать применение областей видимости для нескольких неявных 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 whereUlid(array|string $parameters)
Указать, что указанные параметры маршрута должны быть ULID.
$this whereUuid(array|string $parameters)
Указать, что указанные параметры маршрута должны быть UUID.
$this whereIn(array|string $parameters, array $values)
Указать, что указанные параметры маршрута должны быть одним из заданных значений.
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)
Создать новый экземпляр маршрута.
protected array parseAction(callable|array|null $action)
Распарсить действие маршрута в стандартный массив.
mixed run()
Выполнить действие маршрута и вернуть ответ.
protected bool isControllerAction()
Проверяет, является ли действие маршрута контроллером.
protected mixed runCallable()
Выполнить действие маршрута и вернуть ответ.
protected bool isSerializedClosure()
Определяет, является ли действие маршрута сериализованным замыканием.
protected mixed runController()
Выполнить действие маршрута и вернуть ответ.
mixed getController()
Получить экземпляр контроллера для маршрута.
string getControllerClass()
Получить класс контроллера, используемый для маршрута.
protected string getControllerMethod()
Получить метод контроллера, используемый для маршрута.
protected array parseControllerCallback()
Обработать контроллер.
void flushController()
Очистить кэшированный экземпляр контейнера маршрута.
bool matches(Запрос $request, bool $includingMethod = true)
Определить, соответствует ли маршрут данному запросу.
protected CompiledRoute compileRoute()
Компилировать маршрут в экземпляр Symfony CompiledRoute.
$this bind(Запрос $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()
Получить список параметров без значений null.
array parameterNames()
Получить все имена параметров маршрута.
protected array compileParameterNames()
Получить имена параметров маршрута.
array signatureParameters(array $conditions = [])
Получить параметры, указанные в подписи маршрута/контроллера.
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 для контроллера маршрута.
protected array staticallyProvidedControllerMiddleware(string $class, string $method)
Получить статически предоставленный middleware контроллера для заданного класса и метода.
$this withoutMiddleware(array|string $middleware)
Укажите middleware, который нужно удалить из данного маршрута.
array excludedMiddleware()
Получить middleware, которые нужно удалить из маршрута.
$this scopeBindings()
Укажите, что маршрут должен обеспечить ограничение нескольких неявных связываний Eloquent.
$this withoutScopedBindings()
Укажите, что маршрут не должен обеспечивать ограничение нескольких неявных связываний Eloquent.
bool enforcesScopedBindings()
Определите, должен ли маршрут обеспечивать ограничение нескольких неявных связываний Eloquent.
bool preventsScopedBindings()
Определите, должен ли маршрут предотвратить ограничение нескольких неявных связываний 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/9.x/Illuminate/Routing/Route.html
