Маршрутизатор
класс Маршрутизатор реализует 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, callable $macro) Зарегистрировать пользовательскую макрокоманду. | из Macroable |
| static bool | hasMacro(string $name) Проверить, зарегистрирована ли макрокоманда. | из Macroable |
| static mixed | __callStatic(string $method, array $parameters) Динамически обработать вызовы к классу. | из 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 | match(array|string $methods, string $uri, Closure|array|string $action = null) Зарегистрировать новый маршрут с указанными типами запросов. | |
| void | resources(array $resources) Зарегистрировать массив контроллеров ресурсов. | |
| void | resource(string $name, string $controller, array $options = []) Маршрутизировать ресурс к контроллеру. | |
| void | 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) Объединить стек группы с действием контроллера. | |
| Response | dispatch(Request $request) Передать запрос приложению. | |
| mixed | dispatchToRoute(Request $request) Передать запрос маршруту и вернуть ответ. | |
| Route | findRoute(Request $request) Найти маршрут, соответствующий заданному запросу. | |
| mixed | runRouteWithinStack(Route $route, Request $request) Выполнить данный маршрут внутри экземпляра стека. | |
| array | gatherRouteMiddleware(Route $route) Собрать middleware для данного маршрута с разрешенными именами классов. | |
| array | sortMiddleware(Collection $middlewares) Отсортировать заданные middleware по приоритету. | |
| Response | prepareResponse(Request $request, mixed $response) Создать экземпляр ответа из заданного значения. |
| Маршрут | substituteBindings(Маршрут $route) Заменить привязки маршрута на маршрут. | |
| void | substituteImplicitBindings(Маршрут $route) Заменить неявные привязки модели Eloquent для маршрута. | |
| 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. | |
| $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) Зарегистрировать binder модели для подстановки. | |
| Closure | getBindingCallback(string $key) Получить callback привязки для заданной привязки. | |
| 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() Псевдоним для метода "currentRouteNamed". | |
| bool | currentRouteNamed(string $name) Определить, соответствует ли текущий маршрут заданному имени. | |
| string|null | currentRouteAction() Получить текущее действие маршрута. | |
| bool | uses() Псевдоним для метода "currentRouteUses". | |
| bool | currentRouteUses(string $action) Определить, соответствует ли текущее действие маршрута заданному действию. | |
| void | auth() Зарегистрировать типичные маршруты аутентификации для приложения. | |
| void | singularResourceParameters(bool $singular = true) Установить неотображенные глобальные параметры ресурса в единственном числе. | |
| void | resourceParameters(array $parameters = []) Установить глобальное отображение параметров ресурса. | |
| array|null | resourceVerbs(array $verbs = []) Получить или установить глаголы, используемые в ресурсных URI. | |
| КоллекцияМаршрутов | getRoutes() Получить базовую коллекцию маршрутов. | |
| void | setRoutes(КоллекцияМаршрутов $routes) Установить экземпляр коллекции маршрутов. |
Подробности
static void macro(string $name, callable $macro)
Зарегистрировать пользовательский макрос.
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)
Создать новый экземпляр маршрутизатора.
Маршрут get(string $uri, Closure|array|string $action = null)
Зарегистрировать новый маршрут GET в маршрутизаторе.
Маршрут post(string $uri, Closure|array|string $action = null)
Зарегистрировать новый маршрут POST в маршрутизаторе.
Маршрут put(string $uri, Closure|array|string $action = null)
Зарегистрировать новый маршрут PUT в маршрутизаторе.
Маршрут patch(string $uri, Closure|array|string $action = null)
Зарегистрировать новый маршрут PATCH в маршрутизаторе.
Маршрут delete(string $uri, Closure|array|string $action = null)
Зарегистрировать новый маршрут DELETE в маршрутизаторе.
Маршрут options(string $uri, Closure|array|string $action = null)
Зарегистрировать новый маршрут OPTIONS в маршрутизаторе.
Маршрут any(string $uri, Closure|array|string|null $action = null)
Зарегистрировать маршрут, реагирующий на все глаголы.
Маршрут match(array|string $methods, string $uri, Closure|array|string $action = null)
Зарегистрировать маршрут с указанными глаголами.
void resources(array $resources)
Зарегистрировать массив контроллеров ресурсов.
void resource(string $name, string $controller, array $options = [])
Маршрутизировать ресурс к контроллеру.
void 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()
Получить префикс из последней группы в стеке.
protected Маршрут addRoute(array|string $methods, string $uri, Closure|array|string|null $action)
Добавить маршрут в основную коллекцию маршрутов.
protected Маршрут createRoute(array|string $methods, string $uri, mixed $action)
Создать новый экземпляр маршрута.
protected bool actionReferencesController(array $action)
Определить, если действие маршрутизируется на контроллер.
protected array convertToControllerAction(array|string $action)
Добавить действие маршрута, основанное на контроллере, в массив действия.
protected string prependGroupNamespace(string $class)
Добавить последний групповой префикс к имени класса.
protected Маршрут newRoute(array|string $methods, string $uri, mixed $action)
Создать новый объект Route.
protected string prefix(string $uri)
Добавить префикс к заданному URI.
protected Маршрут addWhereClausesToRoute(Маршрут $route)
Добавить необходимые условия where к маршруту на основе его первоначальной регистрации.
protected void mergeGroupAttributesIntoRoute(Маршрут $route)
Объединить стек групп с действием контроллера.
mixed dispatchToRoute(Запрос $request)
Обработать запрос по маршруту и вернуть ответ.
protected mixed runRouteWithinStack(Маршрут $route, Запрос $request)
Выполнить заданный маршрут внутри экземпляра стека.
array gatherRouteMiddleware(Маршрут $route)
Собрать middleware для данного маршрута с разрешенными именами классов.
protected array sortMiddleware(Коллекция $middlewares)
Сортировать заданный middleware по приоритету.
Ответ prepareResponse(Request $request, mixed $response)
Создать экземпляр ответа из заданного значения.
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)
Добавить новый 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()
Псевдоним для метода «currentRouteNamed».
bool currentRouteNamed(string $name)
Определить, соответствует ли текущий маршрут заданному имени.
string|null currentRouteAction()
Получить текущее действие маршрута.
bool uses()
Псевдоним для метода «currentRouteUses».
bool currentRouteUses(string $action)
Определить, соответствует ли текущее действие маршрута заданному действию.
void auth()
Регистрация типичных маршрутов аутентификации для приложения.
void singularResourceParameters(bool $singular = true)
Установить параметры глобальных ресурсов для единственного числа.
void resourceParameters(array $parameters = [])
Установить глобальное отображение параметров ресурсов.
array|null resourceVerbs(array $verbs = [])
Получить или установить глаголы, используемые в URI ресурсов.
КоллекцияМаршрутов getRoutes()
Получить базовую коллекцию маршрутов.
void setRoutes(КоллекцияМаршрутов $routes)
Установить экземпляр коллекции маршрутов.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.4/Illuminate/Routing/Router.html
