Маршрутизатор
класс Маршрутизатор реализует BindingRegistrar, Registrar mixin RouteRegistrar (Просмотреть исходный код)
Трейты
| Macroable |
Свойства
| статический защищенный массив | $macros | Зарегистрированные строковые макросы. | из Macroable |
| защищенный Dispatcher | $events | Экземпляр диспетчера событий. | |
| защищенный Container | $container | Экземпляр контейнера IoC. | |
| защищенный RouteCollection | $routes | Экземпляр коллекции маршрутов. | |
| защищенный Route|null | $current | Текущий экземпляр обработанного маршрута. | |
| защищенный Request | $currentRequest | Запрос, который в данный момент обрабатывается. | |
| защищенный массив | $middleware | Все сокращенные ключи для middleware. | |
| защищенный массив | $middlewareGroups | Все группы middleware. | |
| массив | $middlewarePriority | Список middleware, отсортированный по приоритету. | |
| защищенный массив | $binders | Зарегистрированные связующие значения маршрута. | |
| защищенный массив | $patterns | Глобально доступные шаблоны параметров. | |
| защищенный массив | $groupStack | Стек атрибутов группы маршрута. | |
| статический массив | $verbs | Все поддерживаемые маршрутизатором глаголы. |
Методы
| 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)
Динамически обработать вызовы в экземпляр маршрутизатора. | |
| void | __construct(Dispatcher $events, Container $container = null)
Создать новый экземпляр маршрутизатора. | |
| Route | get(string $uri, Closure|array|string|callable $action = null)
Зарегистрировать новый маршрут GET в маршрутизаторе. | |
| Route | post(string $uri, Closure|array|string|callable $action = null)
Зарегистрировать новый маршрут POST в маршрутизаторе. | |
| Route | put(string $uri, Closure|array|string|callable $action = null)
Зарегистрировать новый маршрут PUT в маршрутизаторе. | |
| Route | patch(string $uri, Closure|array|string|callable $action = null)
Зарегистрировать новый маршрут PATCH в маршрутизаторе. | |
| Route | delete(string $uri, Closure|array|string|callable $action = null)
Зарегистрировать новый маршрут DELETE в маршрутизаторе. | |
| Route | options(string $uri, Closure|array|string|callable $action = null)
Зарегистрировать новый маршрут OPTIONS в маршрутизаторе. | |
| Route | any(string $uri, Closure|array|string|callable|null $action = null)
Зарегистрировать новый маршрут, отвечающий на все глаголы. | |
| Route | fallback(Closure|array|string|callable|null $action)
Зарегистрировать новый маршрут Fallback в маршрутизаторе. | |
| Route | redirect(string $uri, string $destination, int $status = 302)
Создать переадресацию с одного URI на другой. | |
| Route | permanentRedirect(string $uri, string $destination)
Создать постоянную переадресацию с одного URI на другой. | |
| Route | view(string $uri, string $view, array $data = [])
Зарегистрировать новый маршрут, возвращающий представление. | |
| Route | match(array|string $methods, string $uri, Closure|array|string|callable $action = null)
Зарегистрировать новый маршрут с заданными глаголами. | |
| void | resources(array $resources, array $options = [])
Зарегистрировать массив контроллеров ресурсов. | |
| PendingResourceRegistration | resource(string $name, string $controller, array $options = [])
Назначить ресурс контроллеру. | |
| void | apiResources(array $resources, array $options = [])
Зарегистрировать массив контроллеров API ресурсов. | |
| PendingResourceRegistration | apiResource(string $name, string $controller, array $options = [])
Назначить API ресурс контроллеру. | |
| void | group(array $attributes, Closure|string $routes)
Создать группу маршрутов с общими атрибутами. | |
| void | updateGroupStack(array $attributes)
Обновить стек групп заданными атрибутами. | |
| array | mergeWithLastGroup(array $new)
Объединить заданный массив со стеком последней группы. | |
| void | loadRoutes(Closure|string $routes)
Загрузить предоставленные маршруты. | |
| string | getLastGroupPrefix()
Получить префикс из последней группы в стеке. | |
| Route | addRoute(array|string $methods, string $uri, Closure|array|string|callable|null $action)
Добавить маршрут в основную коллекцию маршрутов. | |
| Route | createRoute(array|string $methods, string $uri, mixed $action)
Создать новый экземпляр маршрута. | |
| bool | actionReferencesController(array $action)
Определить, ссылается ли действие на контроллер. | |
| array | convertToControllerAction(array|string $action)
Добавить действие маршрута, основанное на контроллере, в массив действий. | |
| string | prependGroupNamespace(string $class)
Добавить имя пространства имен последней группы к инструкции use. | |
| Route | newRoute(array|string $methods, string $uri, mixed $action)
Создать новый объект Route. | |
| string | prefix(string $uri)
Добавить заданный URI в качестве префикса к последнему префиксу. | |
| Route | addWhereClausesToRoute(Route $route)
Добавить необходимые условия where к маршруту на основе его первоначальной регистрации. | |
| void | mergeGroupAttributesIntoRoute(Route $route)
Объединить стек групп с действием контроллера. |
| Ответ | respondWithRoute(string $name)
Возвращает ответ, возвращённый заданным маршрутом. | |
| Ответ | dispatch(Запрос $request)
Отправляет запрос в приложение. | |
| Ответ | dispatchToRoute(Запрос $request)
Отправляет запрос на маршрут и возвращает ответ. | |
| Маршрут | findRoute(Запрос $request)
Находит маршрут, соответствующий заданному запросу. | |
| Ответ | runRoute(Запрос $request, Маршрут $route)
Возвращает ответ для заданного маршрута. | |
| mixed | runRouteWithinStack(Маршрут $route, Запрос $request)
Выполняет заданный маршрут внутри экземпляра стека "луковицы". | |
| массив | gatherRouteMiddleware(Маршрут $route)
Собрать middleware для заданного маршрута с разрешёнными именами классов. | |
| массив | sortMiddleware(Коллекция $middlewares)
Сортировать заданный middleware по приоритету. | |
| Ответ | prepareResponse(Запрос $request, mixed $response)
Создать экземпляр ответа из данного значения. | |
| static Ответ | toResponse(Запрос $request, mixed $response)
Статическая версия prepareResponse. | |
| Маршрут | substituteBindings(Маршрут $route)
Заменить привязки маршрута в маршруте. | |
| void | substituteImplicitBindings(Маршрут $route)
Заменить неявные привязки Eloquent модели для маршрута. | |
| mixed | performBinding(string $key, string $value, Маршрут $route)
Вызвать обработчик привязки для данного ключа. | |
| void | matched(string|callable $callback)
Зарегистрировать слушатель события совпадения маршрута. | |
| массив | getMiddleware()
Получить все определённые middleware с сокращёнными именами. | |
| $this | aliasMiddleware(string $name, string $class)
Зарегистрировать сокращённое имя middleware. | |
| bool | hasMiddlewareGroup(string $name)
Проверить, существует ли middlewareGroup с данным именем. | |
| массив | getMiddlewareGroups()
Получить все определённые группы middleware. | |
| $this | middlewareGroup(string $name, array $middleware)
Зарегистрировать группу middleware. | |
| $this | prependMiddlewareToGroup(string $group, string $middleware)
Добавить middleware в начало группы middleware. | |
| $this | pushMiddlewareToGroup(string $group, string $middleware)
Добавить middleware в конец группы middleware. | |
| void | bind(string $key, string|callable $binder)
Добавить новый привязыватель параметров маршрута. | |
| void | model(string $key, string $class, Closure $callback = null)
Зарегистрировать привязыватель модели для подстановки. | |
| Closure | getBindingCallback(string $key)
Получить обработчик привязки для заданной привязки. | |
| массив | getPatterns()
Получить глобальные шаблоны "где". | |
| void | pattern(string $key, string $pattern)
Установить глобальный шаблон "где" для всех маршрутов. | |
| void | patterns(array $patterns)
Установить группу глобальных шаблонов "где" для всех маршрутов. | |
| bool | hasGroupStack()
Определить, есть ли у маршрутизатора текущая стопка групп. | |
| массив | getGroupStack()
Получить текущую стопку групп маршрутизатора. | |
| mixed | input(string $key, string|null $default = null)
Получить параметр маршрута для текущего маршрута. | |
| Запрос | getCurrentRequest()
Получить запрос, который в данный момент обрабатывается. | |
| Маршрут | getCurrentRoute()
Получить текущий экземпляр маршрута. | |
| Маршрут|null | current()
Получить текущий экземпляр маршрута. | |
| bool | has(string $name)
Проверить, существует ли маршрут с заданным именем. | |
| string|null | currentRouteName()
Получить текущее имя маршрута. | |
| bool | is(mixed ...$patterns)
Псевдоним для метода "currentRouteNamed". | |
| bool | currentRouteNamed(mixed ...$patterns)
Определить, соответствует ли текущий маршрут шаблону. | |
| string|null | currentRouteAction()
Получить текущее действие маршрута. | |
| bool | uses(array ...$patterns)
Псевдоним для метода "currentRouteUses". | |
| bool | currentRouteUses(string $action)
Определить, соответствует ли текущее действие маршрута заданному действию. | |
| void | auth(array $options = [])
Зарегистрировать типичные маршруты аутентификации для приложения. | |
| void | resetPassword()
Зарегистрировать типичные маршруты сброса пароля для приложения. | |
| void | confirmPassword()
Зарегистрировать типичные маршруты подтверждения пароля для приложения. | |
| void | emailVerification()
Зарегистрировать типичные маршруты проверки электронной почты для приложения. |
| void | singularResourceParameters(bool $singular = true)
Установить неотображённые глобальные параметры ресурса в единственное число. | |
| void | resourceParameters(array $parameters = [])
Установить сопоставление глобальных параметров ресурса. | |
| array|null | resourceVerbs(array $verbs = [])
Получить или установить глаголы, используемые в URI ресурсов. | |
| RouteCollection | getRoutes()
Получить базовую коллекцию маршрутов. | |
| void | setRoutes(RouteCollection $routes)
Установить экземпляр коллекции маршрутов. | |
| static array | uniqueMiddleware(array $middleware)
Удалить дублирующиеся посредники из заданного массива. |
Подробности
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)
Динамически обрабатывает вызовы в экземпляр маршрутизатора.
void __construct(Dispatcher $events, Container $container = null)
Создать новый экземпляр маршрутизатора.
Route get(string $uri, Closure|array|string|callable $action = null)
Зарегистрировать новый маршрут GET в маршрутизаторе.
Route post(string $uri, Closure|array|string|callable $action = null)
Зарегистрировать новый маршрут POST в маршрутизаторе.
Route put(string $uri, Closure|array|string|callable $action = null)
Зарегистрировать новый маршрут PUT в маршрутизаторе.
Route patch(string $uri, Closure|array|string|callable $action = null)
Зарегистрировать новый маршрут PATCH в маршрутизаторе.
Route delete(string $uri, Closure|array|string|callable $action = null)
Зарегистрировать новый маршрут DELETE в маршрутизаторе.
Route options(string $uri, Closure|array|string|callable $action = null)
Зарегистрировать новый маршрут OPTIONS в маршрутизаторе.
Route any(string $uri, Closure|array|string|callable|null $action = null)
Зарегистрировать новый маршрут, обрабатывающий все глаголы.
Маршрут fallback(Closure|array|string|callable|null $action)
Регистрация нового маршрута по умолчанию.
Маршрут redirect(string $uri, string $destination, int $status = 302)
Создание перенаправления с одного URI на другой.
Маршрут permanentRedirect(string $uri, string $destination)
Создание постоянного перенаправления с одного URI на другой.
Маршрут view(string $uri, string $view, array $data = [])
Регистрация нового маршрута, возвращающего представление.
Маршрут match(array|string $methods, string $uri, Closure|array|string|callable $action = null)
Регистрация нового маршрута с указанными методами.
void resources(array $resources, array $options = [])
Регистрация набора контроллеров ресурсов.
РегистрацияРесурса resource(string $name, string $controller, array $options = [])
Маршрутизация ресурса к контроллеру.
void apiResources(array $resources, array $options = [])
Регистрация набора контроллеров API ресурсов.
РегистрацияРесурса apiResource(string $name, string $controller, array $options = [])
Маршрутизация API ресурса к контроллеру.
void group(array $attributes, Closure|string $routes)
Создать группу маршрутов со свойствами.
protected void updateGroupStack(array $attributes)
Обновить стек группы с заданными свойствами.
array mergeWithLastGroup(array $new)
Объединить заданный массив со стеком последней группы.
protected void loadRoutes(Closure|string $routes)
Загрузить предоставленные маршруты.
string getLastGroupPrefix()
Получить префикс из последней группы в стеке.
Route addRoute(array|string $methods, string $uri, Closure|array|string|callable|null $action)
Добавить маршрут в базовую коллекцию маршрутов.
protected Route createRoute(array|string $methods, string $uri, mixed $action)
Создать новый экземпляр маршрута.
protected bool actionReferencesController(array $action)
Определить, ссылается ли действие на контроллер.
protected array convertToControllerAction(array|string $action)
Добавить действие маршрута, основанное на контроллере, в массив действий.
protected string prependGroupNamespace(string $class)
Добавить пространство имен последней группы к клаузу use.
protected Route newRoute(array|string $methods, string $uri, mixed $action)
Создать новый объект Route.
protected string prefix(string $uri)
Добавить префикс к заданному URI с последним префиксом.
protected Route addWhereClausesToRoute(Route $route)
Добавить необходимые условия where к маршруту на основе его первоначальной регистрации.
protected void mergeGroupAttributesIntoRoute(Route $route)
Объединить стек групп с действием контроллера.
Response respondWithRoute(string $name)
Возвратить ответ, возвращенный заданным маршрутом.
Response dispatch(Request $request)
Отправить запрос в приложение.
Response dispatchToRoute(Request $request)
Отправить запрос на маршрут и вернуть ответ.
protected mixed runRouteWithinStack(Route $route, Request $request)
Выполнить заданный маршрут внутри экземпляра Stack "луковицы".
array gatherRouteMiddleware(Route $route)
Собрать middleware для заданного маршрута с разрешенными именами классов.
protected array sortMiddleware(Collection $middlewares)
Отсортировать заданный middleware по приоритету.
Response prepareResponse(Request $request, mixed $response)
Создать экземпляр ответа из заданного значения.
static Response toResponse(Request $request, mixed $response)
Статическая версия prepareResponse.
void substituteImplicitBindings(Маршрут $route)
Заменить неявные привязки модели Eloquent для маршрута.
protected mixed performBinding(string $key, string $value, Маршрут $route)
Вызвать обратный вызов привязки для заданного ключа.
void matched(string|callable $callback)
Зарегистрировать обработчик события совпадения маршрута.
array getMiddleware()
Получить все определенные сокращенные имена middleware.
$this aliasMiddleware(string $name, string $class)
Зарегистрировать сокращенное имя для middleware.
bool hasMiddlewareGroup(string $name)
Проверить, существует ли middlewareGroup с заданным именем.
array getMiddlewareGroups()
Получить все определенные группы middleware.
$this middlewareGroup(string $name, array $middleware)
Зарегистрировать группу middleware.
$this prependMiddlewareToGroup(string $group, string $middleware)
Добавить middleware в начало группы middleware.
Если middleware уже в группе, он не будет добавлен снова.
$this pushMiddlewareToGroup(string $group, string $middleware)
Добавить middleware в конец группы middleware.
Если middleware уже в группе, он не будет добавлен снова.
void bind(string $key, string|callable $binder)
Добавить новый привязыватель параметров маршрута.
void model(string $key, string $class, Closure $callback = null)
Зарегистрировать привязыватель модели для подстановочного знака.
Closure getBindingCallback(string $key)
Получить обратный вызов привязки для заданной привязки.
array getPatterns()
Получить глобальные шаблоны «where».
void pattern(string $key, string $pattern)
Установить глобальный шаблон «where» для всех маршрутов.
void patterns(array $patterns)
Установить группу глобальных шаблонов «where» для всех маршрутов.
bool hasGroupStack()
Определить, есть ли в настоящее время у маршрутизатора стек групп.
array getGroupStack()
Получить текущий стек групп для маршрутизатора.
mixed input(string $key, string|null $default = null)
Получить параметр маршрута для текущего маршрута.
Запрос getCurrentRequest()
Получить запрос, который в настоящее время обрабатывается.
Маршрут getCurrentRoute()
Получить текущую обрабатываемую экземпляр маршрута.
Маршрут|null current()
Получить текущий экземпляр маршрута.
bool has(string $name)
Проверить, существует ли маршрут с заданным именем.
string|null currentRouteName()
Получить имя текущего маршрута.
bool is(mixed ...$patterns)
Псевдоним метода «currentRouteNamed».
bool currentRouteNamed(mixed ...$patterns)
Определить, соответствует ли текущий маршрут шаблону.
string|null currentRouteAction()
Получить действие текущего маршрута.
bool uses(array ...$patterns)
Псевдоним метода «currentRouteUses».
bool currentRouteUses(string $action)
Определить, соответствует ли действие текущего маршрута заданному действию.
void auth(array $options = [])
Регистрация типичных маршрутов аутентификации для приложения.
void resetPassword()
Регистрация типичных маршрутов сброса пароля для приложения.
void confirmPassword()
Регистрация типичных маршрутов подтверждения пароля для приложения.
void emailVerification()
Регистрация типичных маршрутов подтверждения электронной почты для приложения.
void singularResourceParameters(bool $singular = true)
Установить неотображенные глобальные параметры ресурса в единственном числе.
void resourceParameters(array $parameters = [])
Установить отображение глобальных параметров ресурса.
array|null resourceVerbs(array $verbs = [])
Получить или установить глаголы, используемые в URI ресурсов.
Коллекция маршрутов getRoutes()
Получить базовую коллекцию маршрутов.
void setRoutes(Коллекция маршрутов $routes)
Установить экземпляр коллекции маршрутов.
static array uniqueMiddleware(array $middleware)
Удалить дублирующиеся middleware из заданного массива.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/6.x/Illuminate/Routing/Router.html
