Маршрут
класс Маршрут (Просмотреть исходный код)
Трейты
| СоздаётОграниченияМаршрутаРегулярныхВыражений | |
| ФильтрыСредствОпосредованияКонтроллера | |
| Макрообъект | |
| РазрешаетЗависимостиМаршрута |
Свойства
| статический защищённый массив | $macros | Зарегистрированные строковые макросы. | из Макрообъекта |
| строка | $uri | Шаблон URI, к которому отвечает маршрут. | |
| массив | $methods | HTTP-методы, к которым отвечает маршрут. | |
| массив | $action | Массив действия маршрута. | |
| булево | $isFallback | Указывает, является ли маршрут резервным маршрутом. | |
| смешанный | $controller | Экземпляр контроллера. | |
| массив | $defaults | Значения по умолчанию для маршрута. | |
| массив | $wheres | Требования регулярных выражений. | |
| массив|null | $parameters | Массив сопоставленных параметров. | |
| массив|null | $parameterNames | Имена параметров для маршрута. | |
| защищённый массив | $originalParameters | Массив исходных значений сопоставленных параметров. | |
| защищённый булево | $withTrashedBindings | Указывает, могут ли быть извлечены модели «удалённые» при разрешении неявных привязок моделей для этого маршрута. | |
| защищённый целое|null | $lockSeconds | Указывает максимальное количество секунд, на которые маршрут должен захватывать блокировку сеанса. | |
| защищённый целое|null | $waitSeconds | Указывает максимальное количество секунд, которые маршрут должен ждать при попытке захватить блокировку сеанса. | |
| массив|null | $computedMiddleware | Вычисленные собранные средства опосредования. | |
| CompiledRoute | $compiled | Скомпилированная версия маршрута. | |
| защищённый Маршрутизатор | $router | Экземпляр маршрутизатора, используемый маршрутом. | |
| защищённый Контейнер | $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 | whereUlid(array|string $parameters)
Укажите, что заданные параметры маршрута должны быть ULIDs. | 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 bool | methodExcludedByOptions(string $method, array $options)
Определите, исключают ли заданные опции определенный метод. | from FiltersControllerMiddleware |
| 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 ResolvesRouteDependencies |
| array | resolveMethodDependencies(array $parameters, ReflectionFunctionAbstract $reflector)
Разрешить зависимости, указанные через тип для данного метода. | from ResolvesRouteDependencies |
| mixed | transformDependency(ReflectionParameter $parameter, array $parameters, object $skippableValue)
Попытка преобразовать заданный параметр в экземпляр класса. | from ResolvesRouteDependencies |
| bool | alreadyInParameters(string $class, array $parameters)
Определить, присутствует ли объект данного класса в списке параметров. | from ResolvesRouteDependencies |
| void | spliceIntoParameters(array $parameters, string $offset, mixed $value)
Вставить заданное значение в список параметров. | from ResolvesRouteDependencies |
| 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|null | 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|null | 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)
Определить вызываемый объект, который должен быть вызван при исключении отсутствия модели. |
| массив | gatherMiddleware()
Получить все middleware, включая те, которые из контроллера. | |
| $this|массив | middleware(массив|строка|null $middleware = null)
Получить или установить middleware, прикрепленные к маршруту. | |
| $this | can(строка $ability, массив|строка $models = [])
Указать, что middleware "Authorize" / "can" должен быть применён к маршруту с указанными параметрами. | |
| массив | controllerMiddleware()
Получить middleware для контроллера маршрута. | |
| массив | staticallyProvidedControllerMiddleware(строка $class, строка $method)
Получить статически предоставленный middleware контроллера для данного класса и метода. | |
| $this | withoutMiddleware(массив|строка $middleware)
Указать middleware, которые должны быть удалены из данного маршрута. | |
| массив | excludedMiddleware()
Получить middleware, которые должны быть удалены из маршрута. | |
| $this | scopeBindings()
Указать, что маршрут должен применять ограничение для нескольких неявных Eloquent связей. | |
| $this | withoutScopedBindings()
Указать, что маршрут не должен применять ограничение для нескольких неявных Eloquent связей. | |
| bool | enforcesScopedBindings()
Определить, должен ли маршрут применять ограничение для нескольких неявных Eloquent связей. | |
| bool | preventsScopedBindings()
Определить, должен ли маршрут предотвратить применение ограничения для нескольких неявных Eloquent связей. | |
| $this | block(целое|null $lockSeconds = 10, целое|null $waitSeconds = 10)
Указать, что маршрут не должен допускать одновременных запросов из одной сессии. | |
| $this | withoutBlocking()
Указать, что маршрут должен допускать одновременные запросы из одной сессии. | |
| целое|null | locksFor()
Получить максимальное количество секунд, на которое блокировка сессии маршрута должна сохраняться. | |
| целое|null | waitsFor()
Получить максимальное количество секунд ожидания при попытке получить блокировку сессии. | |
| ControllerDispatcher | controllerDispatcher()
Получить диспетчер для контроллера маршрута. | |
| статический массив | getValidators()
Получить валидаторы маршрута для экземпляра. | |
| Маршрут | toSymfonyRoute()
Преобразовать маршрут в маршрут Symfony. | |
| массив | getOptionalParameterNames()
Получить имена необязательных параметров маршрута. | |
| CompiledRoute | getCompiled()
Получить скомпилированную версию маршрута. | |
| $this | setRouter(Router $router)
Установить экземпляр маршрутизатора на маршруте. | |
| $this | setContainer(Container $container)
Установить экземпляр контейнера на маршруте. | |
| void | prepareForSerialization()
Подготовить экземпляр маршрута для сериализации. | |
| смешанный | __get(строка $key)
Динамический доступ к параметрам маршрута. |
Подробности
$this whereAlpha(массив|строка $parameters)
Указать, что заданные параметры маршрута должны быть буквенными.
$this whereAlphaNumeric(массив|строка $parameters)
Указать, что заданные параметры маршрута должны быть буквенно-цифровыми.
$this whereNumber(массив|строка $parameters)
Указать, что заданные параметры маршрута должны быть числовыми.
$this whereUlid(массив|строка $parameters)
Указать, что заданные параметры маршрута должны быть ULIDs.
$this whereUuid(массив|строка $parameters)
Указать, что заданные параметры маршрута должны быть UUID.
$this whereIn(массив|строка $parameters, массив $values)
Указать, что заданные параметры маршрута должны быть одним из заданных значений.
protected $this assignExpressionToParameters(массив|строка $parameters, строка $expression)
Применить заданный регулярное выражение к заданным параметрам.
static bool methodExcludedByOptions(строка $method, массив $options)
Определить, исключают ли заданные параметры определённый метод.
static void macro(строка $name, объект|вызываемый $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()
Получить экземпляр контроллера для маршрута.
string|null 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|null 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)
Обновить атрибут "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()
Получить все промежуточное ПО, включая промежуточное ПО из контроллера.
$this|array middleware(array|string|null $middleware = null)
Получить или установить промежуточное ПО, прикрепленное к маршруту.
$this can(string $ability, array|string $models = [])
Указать, что промежуточное ПО «Authorize»/«can» должно быть применено к маршруту с заданными параметрами.
array controllerMiddleware()
Получить промежуточное ПО для контроллера маршрута.
protected 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.
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/10.x/Illuminate/Routing/Route.html
