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