Маршрут
класс Маршрут (Просмотреть исходный код)
Трейты
| Macroable |
| RouteDependencyResolverTrait |
Свойства
| статический защищённый массив | $macros | Зарегистрированные строковые макросы. | из Macroable |
| строка | $uri | Шаблон URI, к которому отвечает маршрут. | |
| массив | $methods | HTTP-методы, к которым отвечает маршрут. | |
| массив | $action | Массив действий маршрута. | |
| логическое значение | $isFallback | Указывает, является ли маршрут маршрутом по умолчанию. | |
| смешанный тип | $controller | Экземпляр контроллера. | |
| массив | $defaults | Значения по умолчанию для маршрута. | |
| массив | $wheres | Требования к регулярным выражениям. | |
| массив | $parameters | Массив сопоставленных параметров. | |
| массив или null | $parameterNames | Имена параметров маршрута. | |
| массив или null | $computedMiddleware | Вычисленные собранные посредники. | |
| 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) Создать новый экземпляр маршрута. | |
| 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() Получить список параметров без значений null. | |
| 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(mixed ...$patterns) Определить, соответствует ли имя маршрута заданным шаблонам. | |
| $this | uses(Closure|string $action) Установить обработчик для маршрута. | |
| string | addGroupNamespaceToStringUses(string $action) Разбирать строковый action для флуэнт-метода "uses". | |
| string | getActionName() Получить имя действия для маршрута. | |
| string | getActionMethod() Получить имя метода действия маршрута. | |
| mixed | getAction(string|null $key = null) Получить массив действия или одно из его свойств для маршрута. | |
| $this | setAction(array $action) Установить массив действий для маршрута. | |
| array | gatherMiddleware() Получить все middleware, включая те, что из контроллера. | |
| $this|array | middleware(array|string|null $middleware = null) Получить или установить middleware, прикреплённые к маршруту. | |
| array | controllerMiddleware() Получить middleware для контроллера маршрута. | |
| 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)
Зарегистрировать пользовательское макро.
static void mixin(object $mixin)
Смешать другой объект в класс.
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)
Попытка преобразовать указанный параметр в экземпляр класса.
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 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 parameter(string $name, mixed $default = null)
Получить заданный параметр из маршрута.
void setParameter(string $name, mixed $value)
Установить параметр со значением.
void forgetParameter(string $name)
Удалить параметр из маршрута, если он установлен.
array parameters()
Получить список параметров маршрута.
array parametersWithoutNulls()
Получить список параметров без нулевых значений.
array parameterNames()
Получить все имена параметров маршрута.
protected array compileParameterNames()
Получить имена параметров маршрута.
массив signatureParameters(string|null $subClass = null)
Получить параметры, указанные в сигнатуре маршрута/контроллера.
$this defaults(string $key, mixed $value)
Установить значение по умолчанию для маршрута.
$this where(array|string $name, string $expression = null)
Установить требование регулярного выражения для маршрута.
protected массив parseWhere(array|string $name, string $expression)
Разбор аргументов метода where в массив.
protected $this whereArray(array $wheres)
Установить список требований регулярных выражений для маршрута.
$this fallback()
Отметить этот маршрут как маршрут по умолчанию.
массив methods()
Получить HTTP-глаголы, к которым реагирует маршрут.
bool httpOnly()
Определить, отвечает ли маршрут только на HTTP-запросы.
bool httpsOnly()
Определить, отвечает ли маршрут только на HTTPS-запросы.
bool secure()
Определить, отвечает ли маршрут только на HTTPS-запросы.
$this|string|null domain(string|null $domain = null)
Получить или установить домен для маршрута.
string|null getDomain()
Получить домен, определённый для маршрута.
строка getPrefix()
Получить префикс экземпляра маршрута.
$this prefix(string $prefix)
Добавить префикс к URI маршрута.
строка uri()
Получить URI, связанный с маршрутом.
$this setUri(string $uri)
Установить URI, к которому реагирует маршрут.
строка getName()
Получить имя экземпляра маршрута.
$this name(string $name)
Добавить или изменить имя маршрута.
bool named(mixed ...$patterns)
Определить, соответствует ли имя маршрута заданным шаблонам.
$this uses(Closure|string $action)
Установить обработчик для маршрута.
protected строка addGroupNamespaceToStringUses(string $action)
Разбор строкового действия для флюэнт-метода «uses».
строка getActionName()
Получить имя действия для маршрута.
строка getActionMethod()
Получить имя метода действия маршрута.
смешанный тип getAction(string|null $key = null)
Получить массив действий или одну из его свойств для маршрута.
$this setAction(array $action)
Установить массив действий для маршрута.
массив gatherMiddleware()
Получить все middleware, включая middleware из контроллера.
$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)
Динамический доступ к параметрам маршрута.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.7/Illuminate/Routing/Route.html
