Маршрутизатор
класс Маршрутизатор реализует 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) Зарегистрировать пользовательское макрокоманду. | из Macroable |
| static void | mixin(object $mixin) Смешать другой объект в класс. | из 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 | fallback(Closure|array|string|null $action) Зарегистрировать новый маршрут Fallback в маршрутизаторе. | |
| Route | redirect(string $uri, string $destination, int $status = 301) Создать перенаправление с одного 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) Зарегистрировать массив контроллеров ресурсов. | |
| PendingResourceRegistration | resource(string $name, string $controller, array $options = []) Маршрутизировать ресурс к контроллеру. | |
| void | apiResources(array $resources) Зарегистрировать массив контроллеров 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) Добавить префикс пространства имен последней группы к инструкции 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) Объединить стек групп с действием контроллера. | |
| 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) Выполнить указанный маршрут в экземпляре стека "луковицы". | |
| 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) Зарегистрировать binder модели для подстановки. | |
| 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(dynamic $patterns) Псевдоним для метода «currentRouteNamed». | |
| bool | currentRouteNamed(dynamic $patterns) Определить, соответствует ли текущий маршрут шаблону. | |
| string|null | currentRouteAction() Получить действие текущего маршрута. | |
| bool | uses(array $patterns) Псевдоним для метода «currentRouteUses». | |
| bool | currentRouteUses(string $action) Определить, соответствует ли действие текущего маршрута заданному действию. | |
| void | auth() Зарегистрировать типичные маршруты аутентификации для приложения. | |
| 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 redirect(string $uri, string $destination, int $status = 301)
Создать перенаправление с одного URI на другой.
Маршрут view(string $uri, string $view, array $data = [])
Регистрация нового маршрута, возвращающего представление.
Маршрут match(array|string $methods, string $uri, Closure|array|string $action = null)
Регистрация нового маршрута с указанными глаголами.
void resources(array $resources)
Регистрация массива контроллеров ресурсов.
PendingResourceRegistration resource(string $name, string $controller, array $options = [])
Маршрутизация ресурса к контроллеру.
void apiResources(array $resources)
Регистрация массива контроллеров API-ресурсов.
PendingResourceRegistration 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()
Получение префикса от последней группы в стеке.
Маршрут 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 respondWithRoute(string $name)
Возвратить ответ, возвращённый данным маршрутом.
mixed dispatchToRoute(Запрос $request)
Отправить запрос на маршрут и вернуть ответ.
protected mixed runRouteWithinStack(Маршрут $route, Запрос $request)
Выполнить данный маршрут в экземпляре стека "луковица".
array gatherRouteMiddleware(Маршрут $route)
Собрать миддлварь для данного маршрута с разрешёнными именами классов.
protected array sortMiddleware(Коллекция $middlewares)
Отсортировать заданную миддлварь по приоритету.
Ответ|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)
Добавить новый параметр маршрута binder.
void model(string $key, string $class, Closure $callback = null)
Зарегистрировать model binder для подстановочного знака.
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.
Route current()
Получить текущую маршрутизированную инстанцию Route.
bool has(string $name)
Проверить, существует ли маршрут с заданным именем.
string|null currentRouteName()
Получить имя текущего маршрута.
bool is(dynamic $patterns)
Псевдоним для метода "currentRouteNamed".
bool currentRouteNamed(dynamic $patterns)
Определить, соответствует ли текущий маршрут шаблону.
string|null currentRouteAction()
Получить действие текущего маршрута.
bool uses(array $patterns)
Псевдоним для метода "currentRouteUses".
bool currentRouteUses(string $action)
Определить, соответствует ли действие текущего маршрута заданному действию.
void auth()
Зарегистрировать типичные маршруты аутентификации для приложения.
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.6/Illuminate/Routing/Router.html
