Маршрутизатор
класс Маршрутизатор реализует Registrar (Просмотреть исходный код)
Трейты
| Macroable |
Свойства
| статический защищённый массив | $macros | Зарегистрированные строковые макросы. | из Macroable |
| защищённый Dispatcher | $events | Экземпляр диспетчера событий. | |
| защищённый Container | $container | Экземпляр контейнера IoC. | |
| защищённый RouteCollection | $routes | Экземпляр коллекции маршрутов. | |
| защищённый Route | $current | Экземпляр текущего маршрута. | |
| защищённый Request | $currentRequest | Запрос, который в настоящее время обрабатывается. | |
| защищённый массив | $middleware | Все псевдонимы для middleware. | |
| защищённый массив | $patternFilters | Зарегистрированные фильтры, основанные на шаблонах. | |
| защищённый массив | $regexFilters | Зарегистрированные фильтры, основанные на регулярных выражениях. | |
| защищённый массив | $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) Динамически обработать вызовы класса. | из Macroable |
| void | __construct(Dispatcher $events, Container $container = null) Создать новый экземпляр Router. | |
| void | get(string $uri, Closure|array|string $action) Зарегистрировать новый маршрут GET. | |
| void | post(string $uri, Closure|array|string $action) Зарегистрировать новый маршрут POST. | |
| void | put(string $uri, Closure|array|string $action) Зарегистрировать новый маршрут PUT. | |
| void | patch(string $uri, Closure|array|string $action) Зарегистрировать новый маршрут PATCH. | |
| void | delete(string $uri, Closure|array|string $action) Зарегистрировать новый маршрут DELETE. | |
| void | options(string $uri, Closure|array|string $action) Зарегистрировать новый маршрут OPTIONS. | |
| Route | any(string $uri, Closure|array|string $action) Зарегистрировать новый маршрут, обрабатывающий все HTTP-методы. | |
| void | match(array|string $methods, string $uri, Closure|array|string $action) Зарегистрировать новый маршрут с указанными методами. | |
| void | controllers(array $controllers) Зарегистрировать массив контроллеров с маршрутизацией по шаблонам. | |
| void | controller(string $uri, string $controller, array $names = []) Маршрутизировать контроллер на URI с использованием шаблонов. | |
| void | registerInspected(array $route, string $controller, string $method, array $names) Зарегистрировать маршрут контроллера с проверкой. | |
| void | addFallthroughRoute(string $controller, string $uri) Добавить маршрут прохода для контроллера. | |
| void | resources(array $resources) Зарегистрировать массив контроллеров ресурсов. | |
| void | resource(string $name, string $controller, array $options = []) Маршрутизировать ресурс к контроллеру. | |
| void | group(array $attributes, Closure $callback) Создать группу маршрутов с общими атрибутами. | |
| void | updateGroupStack(array $attributes) Обновить стек групп заданными атрибутами. | |
| array | mergeWithLastGroup(array $new) Объединить заданный массив с последним стеком групп. | |
| static array | mergeGroup(array $new, array $old) Объединить заданные атрибуты группы. | |
| static string|null | formatUsesPrefix(array $new, array $old) Отформатировать префикс uses для новых атрибутов группы. | |
| static string|null | formatGroupPrefix(array $new, array $old) Отформатировать префикс для новых атрибутов группы. | |
| string | getLastGroupPrefix() Получить префикс из последней группы в стеке. | |
| Route | addRoute(array|string $methods, string $uri, Closure|array|string $action) Добавить маршрут в базовую коллекцию маршрутов. | |
| Route | createRoute(array|string $methods, string $uri, mixed $action) Создать новый экземпляр маршрута. | |
| Route | newRoute(array|string $methods, string $uri, mixed $action) Создать новый объект Route. | |
| string | prefix(string $uri) Добавить префикс к заданному URI с использованием последнего префикса. | |
| Route | addWhereClausesToRoute(Route $route) Добавить необходимые условия where к маршруту на основе его первоначальной регистрации. | |
| void | mergeGroupAttributesIntoRoute(Route $route) Объединить стек групп с действием контроллера. | |
| bool | actionReferencesController(array $action) Определить, ссылается ли действие на контроллер. | |
| array | convertToControllerAction(array|string $action) Добавить действие маршрута, основанное на контроллере, в массив действий. | |
| string | prependGroupUses(string $uses) Добавить префикс использования последней группы к предложению использования. | |
| Response | dispatch(Request $request) Отправить запрос в приложение. | |
| mixed | dispatchToRoute(Request $request) Отправить запрос на маршрут и вернуть ответ. | |
| mixed | runRouteWithinStack(Route $route, Request $request) Выполнить данный маршрут в экземпляре Stack. | |
| array | gatherRouteMiddlewares(Route $route) Собрать middleware для данного маршрута. |
| string | resolveMiddlewareClassName(string $name) Решить имя middleware в имя класса, сохраняя переданные параметры. | |
| Route | findRoute(Request $request) Найти маршрут, соответствующий заданному запросу. | |
| Route | substituteBindings(Route $route) Заменить привязки маршрута на маршрут. | |
| mixed | performBinding(string $key, string $value, Route $route) Вызвать обратный вызов привязки для данного ключа. | |
| void | matched(string|callable $callback) Зарегистрировать слушателя события сопоставленного маршрута. | |
| void | before(string|callable $callback) deprecated Зарегистрировать новый фильтр «перед» с маршрутизатором. | |
| void | after(string|callable $callback) deprecated Зарегистрировать новый фильтр «после» с маршрутизатором. | |
| void | addGlobalFilter(string $filter, string|callable $callback) Зарегистрировать новый глобальный фильтр с маршрутизатором. | |
| array | getMiddleware() Получить все определённые имена middleware в сокращённой форме. | |
| $this | middleware(string $name, string $class) Зарегистрировать краткое имя для middleware. | |
| void | filter(string $name, string|callable $callback) deprecated Зарегистрировать новый фильтр с маршрутизатором. | |
| mixed | parseFilter(callable|string $callback) Проанализировать зарегистрированный фильтр. | |
| void | when(string $pattern, string $name, array|null $methods = null) deprecated Зарегистрировать фильтр на основе шаблона с маршрутизатором. | |
| void | whenRegex(string $pattern, string $name, array|null $methods = null) deprecated Зарегистрировать фильтр на основе регулярного выражения с маршрутизатором. | |
| void | model(string $key, string $class, Closure $callback = null) Зарегистрировать связующий элемент модели для подстановки. | |
| void | bind(string $key, string|callable $binder) Добавить новый связующий элемент параметра маршрута. | |
| Closure | createClassBinding(string $binding) Создать привязку на основе класса, используя контейнер IoC. | |
| void | pattern(string $key, string $pattern) Установить глобальный шаблон where для всех маршрутов. | |
| void | patterns(array $patterns) Установить группу глобальных шаблонов where для всех маршрутов. | |
| mixed | callFilter(string $filter, Request $request, Response $response = null) Вызвать заданный фильтр с запросом и ответом. | |
| mixed | callRouteBefore(Route $route, Request $request) Вызвать фильтры «перед» заданного маршрута. | |
| mixed | callPatternFilters(Route $route, Request $request) Вызвать фильтры на основе шаблона для запроса. | |
| array | findPatternFilters(Request $request) deprecated Найти фильтры по шаблону, соответствующие запросу. | |
| array | patternsByMethod(string $method, array $filters) Фильтровать фильтры по шаблону, которые не применяются к глаголу запроса. | |
| bool | filterSupportsMethod(array $filter, array $method) Определить, применяется ли данный фильтр по шаблону к заданному методу. | |
| mixed | callAttachedBefores(Route $route, Request $request) Вызвать фильтры «перед» (не по шаблону) заданного маршрута. | |
| mixed | callRouteAfter(Route $route, Request $request, Response $response) deprecated Вызвать фильтры «после» заданного маршрута. | |
| mixed | callRouteFilter(string $filter, array $parameters, Route $route, Request $request, Response|null $response = null) deprecated Вызвать заданный фильтр маршрута. | |
| array | cleanFilterParameters(array $parameters) Очистить параметры, передаваемые в обратный вызов фильтра. | |
| Response | prepareResponse(Request $request, mixed $response) Создать экземпляр ответа из заданного значения. | |
| bool | hasGroupStack() Определить, есть ли в настоящее время стек групп маршрутизатора. | |
| array | getGroupStack() Получить текущий стек групп маршрутизатора. | |
| mixed | input(string $key, string $default = null) Получить параметр маршрута для текущего маршрута. | |
| Route | getCurrentRoute() Получить текущий экземпляр обработанного маршрута. | |
| Route | 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) Определить, совпадает ли текущее действие маршрута с заданным действием. | |
| Request | getCurrentRequest() Получить запрос, который в данный момент обрабатывается. | |
| RouteCollection | getRoutes() Получить базовую коллекцию маршрутов. | |
| void | setRoutes(RouteCollection $routes) Установить экземпляр коллекции маршрутов. | |
| array | getPatterns() Получить глобальные шаблоны "where". |
Подробности
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)
Создать новый экземпляр Router.
void get(string $uri, Closure|array|string $action)
Зарегистрировать новый маршрут GET.
void post(string $uri, Closure|array|string $action)
Зарегистрировать новый маршрут POST.
void put(string $uri, Closure|array|string $action)
Зарегистрировать новый маршрут PUT.
void patch(string $uri, Closure|array|string $action)
Зарегистрировать новый маршрут PATCH.
void delete(string $uri, Closure|array|string $action)
Зарегистрировать новый маршрут DELETE.
void options(string $uri, Closure|array|string $action)
Зарегистрировать новый маршрут OPTIONS.
Маршрут any(string $uri, Closure|array|string $action)
Зарегистрировать новый маршрут, обрабатывающий все HTTP-методы.
void match(array|string $methods, string $uri, Closure|array|string $action)
Зарегистрировать новый маршрут с заданными HTTP-методами.
void controllers(array $controllers)
Зарегистрировать массив контроллеров с маршрутизацией по умолчанию.
void controller(string $uri, string $controller, array $names = [])
Маршрутизировать контроллер к URI с использованием подстановочных значений.
protected void registerInspected(array $route, string $controller, string $method, array $names)
Зарегистрировать маршрут контроллера, подлежащий проверке.
protected void addFallthroughRoute(string $controller, string $uri)
Добавить сквозной маршрут для контроллера.
void resources(array $resources)
Зарегистрировать массив контроллеров ресурсов.
void resource(string $name, string $controller, array $options = [])
Маршрутизировать ресурс к контроллеру.
void group(array $attributes, Closure $callback)
Создать группу маршрутов с общими атрибутами.
protected void updateGroupStack(array $attributes)
Обновить стек групп заданными атрибутами.
array mergeWithLastGroup(array $new)
Объединить заданный массив со стеком последней группы.
static array mergeGroup(array $new, array $old)
Объединить атрибуты данной группы.
static protected string|null formatUsesPrefix(array $new, array $old)
Форматировать префикс uses для новых атрибутов группы.
static protected string|null formatGroupPrefix(array $new, array $old)
Форматировать префикс для новых атрибутов группы.
string getLastGroupPrefix()
Получить префикс из последней группы в стеке.
protected Route addRoute(array|string $methods, string $uri, Closure|array|string $action)
Добавить маршрут в базовый набор маршрутов.
protected Route createRoute(array|string $methods, string $uri, mixed $action)
Создать новый экземпляр маршрута.
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)
Объединить стек групп с действием контроллера.
protected bool actionReferencesController(array $action)
Определить, ссылается ли действие на контроллер.
protected array convertToControllerAction(array|string $action)
Добавить действие маршрута контроллера в массив действий.
protected string prependGroupUses(string $uses)
Добавить последнюю группу uses к клаузу uses.
mixed dispatchToRoute(Request $request)
Обработать запрос по маршруту и вернуть ответ.
protected mixed runRouteWithinStack(Route $route, Request $request)
Выполнить данный маршрут внутри экземпляра Stack.
array gatherRouteMiddlewares(Route $route)
Получить middleware для данного маршрута.
string resolveMiddlewareClassName(string $name)
Разрешить имя middleware в имя класса, сохраняя переданные параметры.
protected mixed performBinding(string $key, string $value, Route $route)
Вызвать коллбэк привязки для данного ключа.
void matched(string|callable $callback)
Зарегистрировать обработчик события совпадения маршрута.
void before(string|callable $callback) deprecated
deprecated
Зарегистрировать новый фильтр «before» в маршрутизаторе.
void after(string|callable $callback) deprecated
deprecated
Зарегистрировать новый фильтр «after» в маршрутизаторе.
protected void addGlobalFilter(string $filter, string|callable $callback)
Зарегистрировать новый глобальный фильтр в маршрутизаторе.
array getMiddleware()
Получить все определённые middleware.
$this middleware(string $name, string $class)
Зарегистрировать сокращённое имя middleware.
void filter(string $name, string|callable $callback) deprecated
deprecated
Зарегистрировать новый фильтр в маршрутизаторе.
protected mixed parseFilter(callable|string $callback)
Обработать зарегистрированный фильтр.
void when(string $pattern, string $name, array|null $methods = null) deprecated
deprecated
Зарегистрировать фильтр на основе шаблона в маршрутизаторе.
void whenRegex(string $pattern, string $name, array|null $methods = null) deprecated
deprecated
Зарегистрировать фильтр на основе регулярного выражения в маршрутизаторе.
void model(string $key, string $class, Closure $callback = null)
Зарегистрировать связыватель модели для подстановки.
void bind(string $key, string|callable $binder)
Добавить новый связыватель параметров маршрута.
Closure createClassBinding(string $binding)
Создать привязку на основе класса, используя контейнер IoC.
void pattern(string $key, string $pattern)
Установить глобальный шаблон where для всех маршрутов.
void patterns(array $patterns)
Установить группу глобальных шаблонов where для всех маршрутов.
protected mixed callFilter(string $filter, Request $request, Response $response = null)
Вызвать заданный фильтр с запросом и ответом.
protected mixed callPatternFilters(Маршрут $route, Запрос $request)
Вызвать фильтры на основе шаблона для запроса.
array findPatternFilters(Запрос $request) deprecated
deprecated
Найти фильтры по шаблону, соответствующие запросу.
protected array patternsByMethod(string $method, array $filters)
Отфильтровать шаблоны фильтров, которые не применимы к глаголу запроса.
protected bool filterSupportsMethod(array $filter, array $method)
Определить, применим ли данный фильтр шаблона к заданному методу.
protected mixed callAttachedBefores(Маршрут $route, Запрос $request)
Вызвать прикрепленные передние (не по шаблону) фильтры маршрута.
mixed callRouteAfter(Маршрут $route, Запрос $request, Ответ $response) deprecated
deprecated
Вызвать фильтры после маршрута.
смешанный callRouteFilter(строка $filter, массив $parameters, Маршрут $route, Запрос $request, Ответ|null $response = null) устарело
устарело
Вызвать заданный фильтр маршрута.
защищенный массив cleanFilterParameters(массив $parameters)
Очистить параметры, передаваемые в обратный вызов фильтра.
Ответ prepareResponse(Запрос $request, смешанный $response)
Создать экземпляр ответа из заданного значения.
логический тип hasGroupStack()
Определить, содержит ли маршрутизатор текущий стек групп.
массив getGroupStack()
Получить текущий стек групп для маршрутизатора.
смешанный input(строка $key, строка $default = null)
Получить параметр маршрута для текущего маршрута.
Маршрут getCurrentRoute()
Получить текущий экземпляр маршрута, который был обработан.
Маршрут current()
Получить текущий экземпляр маршрута, который был обработан.
логический тип has(строка $name)
Проверить, существует ли маршрут с заданным именем.
строка|null currentRouteName()
Получить текущее имя маршрута.
логический тип is()
Псевдоним для метода «currentRouteNamed».
логический тип currentRouteNamed(строка $name)
Определить, соответствует ли текущий маршрут заданному имени.
строка|null currentRouteAction()
Получить текущее действие маршрута.
логический тип uses()
Псевдоним для метода «currentRouteUses».
логический тип currentRouteUses(строка $action)
Определить, соответствует ли текущее действие маршрута заданному действию.
Запрос getCurrentRequest()
Получить запрос, который в настоящее время обрабатывается.
КоллекцияМаршрутов getRoutes()
Получить базовую коллекцию маршрутов.
пустое значение setRoutes(КоллекцияМаршрутов $routes)
Установить экземпляр коллекции маршрутов.
массив getPatterns()
Получить глобальные шаблоны «where».
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.1/Illuminate/Routing/Router.html
