Маршрутизатор
класс Маршрутизатор реализует Registrar (Просмотреть исходный код)
Трейты
| 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) Зарегистрировать пользовательский макрос. | from Macroable |
| static bool | hasMacro(string $name) Проверяет, зарегистрирован ли макрос. | from Macroable |
| static mixed | __callStatic(string $method, array $parameters) Динамически обрабатывает вызовы к классу. | from Macroable |
| mixed | __call(string $method, array $parameters) Динамически обрабатывает вызовы к классу. | from Macroable |
| void | __construct(Dispatcher $events, Container $container = null) Создать новый экземпляр Router. | |
| void | get(string $uri, Closure|array|string $action = null) Зарегистрировать новый маршрут GET в маршрутизаторе. | |
| void | post(string $uri, Closure|array|string $action = null) Зарегистрировать новый маршрут POST в маршрутизаторе. | |
| void | put(string $uri, Closure|array|string $action = null) Зарегистрировать новый маршрут PUT в маршрутизаторе. | |
| void | patch(string $uri, Closure|array|string $action = null) Зарегистрировать новый маршрут PATCH в маршрутизаторе. | |
| void | delete(string $uri, Closure|array|string $action = null) Зарегистрировать новый маршрут DELETE в маршрутизаторе. | |
| void | options(string $uri, Closure|array|string $action = null) Зарегистрировать новый маршрут OPTIONS в маршрутизаторе. | |
| Route | any(string $uri, Closure|array|string|null $action = null) Зарегистрировать новый маршрут, отвечающий на все глаголы. | |
| void | match(array|string $methods, string $uri, Closure|array|string $action = null) Зарегистрировать новый маршрут с указанными глаголами. | |
| void | singularResourceParameters(bool $singular = true) Установить неотображенные глобальные параметры ресурса в единственном числе. | |
| void | resourceParameters(array $parameters = []) Установить глобальное отображение параметров ресурса. | |
| array|null | resourceVerbs(array $verbs = []) Получить или установить глаголы, используемые в URI ресурса. | |
| void | resources(array $resources) Зарегистрировать массив контроллеров ресурсов. | |
| void | resource(string $name, string $controller, array $options = []) Маршрутизировать ресурс к контроллеру. | |
| void | auth() Зарегистрировать типичные маршруты аутентификации для приложения. | |
| 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) Отформатировать префикс используемых имён для новых атрибутов группы. | |
| static string|null | formatGroupPrefix(array $new, array $old) Отформатировать префикс для новых атрибутов группы. | |
| string | getLastGroupPrefix() Получить префикс из последней группы в стеке. | |
| Route | addRoute(array|string $methods, string $uri, Closure|array|string|null $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) Добавить к клаузу uses последней группы. | |
| Response | dispatch(Request $request) Передать запрос приложению. | |
| mixed | dispatchToRoute(Request $request) Передать запрос маршруту и вернуть ответ. | |
| mixed | runRouteWithinStack(Route $route, Request $request) Выполнить данный маршрут в стеке. | |
| array | gatherRouteMiddleware(Route $route) Собрать middleware для данного маршрута. |
| строка|массив | resolveMiddlewareClassName(строка $name) Разрешить имя middleware до имени класса(ов), сохраняя переданные параметры. | |
| массив | parseMiddlewareGroup(строка $name) Разбирать группу middleware и форматировать ее для использования. | |
| массив | sortMiddleware(Collection $middlewares) Сортировать заданные middleware по приоритету. | |
| Маршрут | findRoute(Запрос $request) Найти маршрут, соответствующий данному запросу. | |
| Маршрут | substituteBindings(Маршрут $route) Заменить привязки маршрута на маршрут. | |
| void | substituteImplicitBindings(Маршрут $route) Заменить неявные привязки модели Eloquent для маршрута. | |
| смешанный | performBinding(строка $key, строка $value, Маршрут $route) Вызвать обратный вызов привязки для данного ключа. | |
| void | matched(строка|вызываемый $callback) Зарегистрировать обработчик событий сопоставленного маршрута. | |
| массив | getMiddleware() Получить все определенные имена middleware в сокращенной форме. | |
| $this | middleware(строка $name, строка $class) Зарегистрировать сокращенное имя middleware. | |
| $this | middlewareGroup(строка $name, массив $middleware) Зарегистрировать группу middleware. | |
| $this | prependMiddlewareToGroup(строка $group, строка $middleware) Добавить middleware в начало группы middleware. | |
| $this | pushMiddlewareToGroup(строка $group, строка $middleware) Добавить middleware в конец группы middleware. | |
| void | model(строка $key, строка $class, Closure $callback = null) Зарегистрировать привязку модели для подстановочного знака. | |
| void | bind(строка $key, строка|вызываемый $binder) Добавить новую привязку параметра маршрута. | |
| Closure | createClassBinding(строка $binding) Создать привязку на основе класса с использованием контейнера IoC. | |
| void | pattern(строка $key, строка $pattern) Установить глобальный шаблон where для всех маршрутов. | |
| void | patterns(массив $patterns) Установить группу глобальных шаблонов where для всех маршрутов. | |
| Ответ | prepareResponse(Запрос $request, смешанный $response) Создать экземпляр ответа из данного значения. | |
| bool | hasGroupStack() Определить, есть ли у маршрутизатора текущая стек групп. | |
| массив | getGroupStack() Получить текущий стек групп маршрутизатора. | |
| смешанный | input(строка $key, строка $default = null) Получить параметр маршрута для текущего маршрута. | |
| Маршрут | getCurrentRoute() Получить текущий экземпляр маршрута, который был обработан. | |
| Маршрут | current() Получить текущий экземпляр маршрута, который был обработан. | |
| bool | has(строка $name) Проверить, существует ли маршрут с данным именем. | |
| строка|null | currentRouteName() Получить имя текущего маршрута. | |
| bool | is() Псевдоним для метода "currentRouteNamed". | |
| bool | currentRouteNamed(строка $name) Определить, соответствует ли текущий маршрут заданному имени. | |
| строка|null | currentRouteAction() Получить текущее действие маршрута. | |
| bool | uses() Псевдоним для метода "currentRouteUses". | |
| bool | currentRouteUses(строка $action) Определить, соответствует ли текущее действие маршрута заданному действию. | |
| Запрос | getCurrentRequest() Получить запрос, который в данный момент обрабатывается. | |
| RouteCollection | getRoutes() Получить базовую коллекцию маршрутов. | |
| void | setRoutes(RouteCollection $routes) Установить экземпляр коллекции маршрутов. | |
| массив | getPatterns() Получить глобальные шаблоны "where". |
Подробности
статический void macro(строка $name, вызываемый $macro)
Зарегистрировать пользовательский макрос.
статический bool hasMacro(строка $name)
Проверяет, зарегистрирован ли макрос.
статический смешанный __callStatic(строка $method, массив $parameters)
Динамически обработать вызовы к классу.
mixed __call(string $method, array $parameters)
Динамически обрабатывает вызовы к классу.
void __construct(Dispatcher $events, Container $container = null)
Создать новый экземпляр Router.
void get(string $uri, Closure|array|string $action = null)
Регистрирует новый маршрут GET в маршрутизаторе.
void post(string $uri, Closure|array|string $action = null)
Регистрирует новый маршрут POST в маршрутизаторе.
void put(string $uri, Closure|array|string $action = null)
Регистрирует новый маршрут PUT в маршрутизаторе.
void patch(string $uri, Closure|array|string $action = null)
Регистрирует новый маршрут PATCH в маршрутизаторе.
void delete(string $uri, Closure|array|string $action = null)
Регистрирует новый маршрут DELETE в маршрутизаторе.
void options(string $uri, Closure|array|string $action = null)
Регистрирует новый маршрут OPTIONS в маршрутизаторе.
Маршрут any(string $uri, Closure|array|string|null $action = null)
Регистрирует новый маршрут, обрабатывающий все HTTP-методы.
void match(array|string $methods, string $uri, Closure|array|string $action = null)
Регистрирует новый маршрут с заданными методами.
void singularResourceParameters(bool $singular = true)
Установить глобальные параметры ресурса для единственного числа.
void resourceParameters(array $parameters = [])
Установить глобальное отображение параметров ресурса.
array|null resourceVerbs(array $verbs = [])
Получить или установить методы, используемые в URI ресурсов.
void resources(array $resources)
Регистрирует массив контроллеров ресурсов.
void resource(string $name, string $controller, array $options = [])
Маршрутизирует ресурс к контроллеру.
void auth()
Регистрирует типичные маршруты авторизации для приложения.
void group(array $attributes, Closure $callback)
Создает группу маршрутов со общими атрибутами.
protected void updateGroupStack(array $attributes)
Обновляет стек групп заданными атрибутами.
массив mergeWithLastGroup(массив $new)
Объединить заданный массив со стеком последней группы.
статический массив mergeGroup(массив $new, массив $old)
Объединить заданные атрибуты группы.
статический защищённый строка|null formatUsesPrefix(массив $new, массив $old)
Отформатировать префикс uses для новых атрибутов группы.
статический защищённый строка|null formatGroupPrefix(массив $new, массив $old)
Отформатировать префикс для новых атрибутов группы.
строка getLastGroupPrefix()
Получить префикс из последней группы в стеке.
защищённый Маршрут addRoute(массив|строка $methods, строка $uri, Closure|массив|строка|null $action)
Добавить маршрут в базовую коллекцию маршрутов.
защищённый Маршрут createRoute(массив|строка $methods, строка $uri, смешанный $action)
Создать новый экземпляр маршрута.
защищённый Маршрут newRoute(массив|строка $methods, строка $uri, смешанный $action)
Создать новый объект Route.
защищённый строка prefix(строка $uri)
Добавить заданный URI в качестве префикса к последнему префиксу.
защищённый Маршрут addWhereClausesToRoute(Маршрут $route)
Добавить необходимые условия where к маршруту на основе его первоначальной регистрации.
защищённый void mergeGroupAttributesIntoRoute(Маршрут $route)
Объединить стек групп с действием контроллера.
защищённый bool actionReferencesController(массив $action)
Определить, маршрутизирует ли действие контроллеру.
защищённый массив convertToControllerAction(массив|строка $action)
Добавить действие маршрута, основанное на контроллере, в массив action.
защищённый строка prependGroupUses(строка $uses)
Добавить uses последней группы в начало строки use.
смешанный dispatchToRoute(Запрос $request)
Отправить запрос по маршруту и вернуть ответ.
защищённый смешанный runRouteWithinStack(Маршрут $route, Запрос $request)
Выполнить заданный маршрут в экземпляре Stack "onion".
массив gatherRouteMiddleware(Маршрут $route)
Собрать middleware для заданного маршрута.
строка|массив resolveMiddlewareClassName(строка $name)
Разрешить имя мидлвара до имени класса(ов), сохраняя переданные параметры.
protected массив parseMiddlewareGroup(строка $name)
Обработать группу миддлвара и отформатировать её для использования.
protected массив sortMiddleware(Коллекция $middlewares)
Сортировать заданный миддлвар по приоритету.
пустое значение substituteImplicitBindings(Маршрут $route)
Заменить неявные привязки Eloquent модели для маршрута.
protected смешанный тип performBinding(строка $key, строка $value, Маршрут $route)
Вызвать обратный вызов привязки для данного ключа.
пустое значение matched(строка|вызов $callback)
Зарегистрировать слушатель события соответствия маршрута.
массив getMiddleware()
Получить все определенные имена миддлвара в сокращенной форме.
$this middleware(строка $name, строка $class)
Зарегистрировать имя в сокращенной форме для миддлвара.
$this middlewareGroup(строка $name, массив $middleware)
Зарегистрировать группу миддлвара.
$this prependMiddlewareToGroup(строка $group, строка $middleware)
Добавить миддлвар в начало группы миддлвара.
Если миддлвар уже в группе, он не будет добавлен снова.
$this pushMiddlewareToGroup(строка $group, строка $middleware)
Добавить миддлвар в конец группы миддлвара.
Если миддлвар уже в группе, он не будет добавлен снова.
пустое значение model(строка $key, строка $class, Замыкание $callback = null)
Зарегистрировать привязку модели для подстановочного знака.
пустое значение bind(строка $key, строка|вызов $binder)
Добавить новую привязку параметра маршрута.
Замыкание createClassBinding(строка $binding)
Создать привязку класса, используя контейнер IoC.
пустое значение pattern(строка $key, строка $pattern)
Установить глобальный шаблон where для всех маршрутов.
пустое значение patterns(массив $patterns)
Установить группу глобальных шаблонов where для всех маршрутов.
Response prepareResponse(Request $request, mixed $response)
Создать экземпляр ответа из заданного значения.
bool hasGroupStack()
Определить, есть ли в настоящее время в маршрутизаторе стек групп.
array getGroupStack()
Получить текущий стек групп для маршрутизатора.
mixed input(string $key, string $default = null)
Получить параметр маршрута для текущего маршрута.
Маршрут 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)
Определить, соответствует ли текущее действие маршрута заданному действию.
Запрос getCurrentRequest()
Получить запрос, который в данный момент обрабатывается.
СборникМаршрутов getRoutes()
Получить базовый сборник маршрутов.
void setRoutes(СборникМаршрутов $routes)
Установить экземпляр коллекции маршрутов.
array getPatterns()
Получить глобальные шаблоны «where».
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/Routing/Router.html
