Маршрутизатор
класс Маршрутизатор реализует Регистратор (Просмотреть исходный код)
Трейты
| Macroable |
Свойства
| статический защищенный массив | $macros | Зарегистрированные строковые макросы. | из Macroable |
| защищенный Диспечер событий | $events | Экземпляр диспечера событий. | |
| защищенный Контейнер | $container | Экземпляр контейнера IoC. | |
| защищенный Коллекция маршрутов | $routes | Экземпляр коллекции маршрутов. | |
| защищенный Маршрут | $current | Текущий обработанный экземпляр маршрута. | |
| защищенный Запрос | $currentRequest | Запрос, который в данный момент обрабатывается. | |
| защищенный массив | $middleware | Все псевдонимы ключей для middleware. | |
| защищенный массив | $middlewareGroups | Все группы 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) Динамически обрабатывает вызовы класса. | из Macroable |
| void | __construct(Dispatcher $events, Container $container = null) Создать новый экземпляр маршрутизатора. | |
| 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 | controllers(array $controllers) deprecated Зарегистрировать массив контроллеров с маршрутизацией с использованием подстановочных знаков. | |
| void | controller(string $uri, string $controller, array $names = []) deprecated Проложить маршрут к контроллеру с использованием подстановочных знаков. | |
| void | registerInspected(array $route, string $controller, string $method, array $names) deprecated Зарегистрировать проверенный маршрут контроллера. | |
| void | addFallthroughRoute(string $controller, string $uri) deprecated Добавить маршрут для контроллера. | |
| void | singularResourceParameters() Установить несопоставленные глобальные параметры ресурса как единственные. | |
| void | resourceParameters(array $parameters = []) Установить глобальное соответствие параметров ресурса. | |
| 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) Отформатировать префикс uses для новых атрибутов группы. | |
| 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 | gatherRouteMiddlewares(Route $route) Собрать middleware для данного маршрута. | |
| string|array | resolveMiddlewareClassName(string $name) Разрешить имя middleware до имени(имён) класса, сохраняя переданные параметры. | |
| array | parseMiddlewareGroup(string $name) Обработать группу middleware и отформатировать её для использования. | |
| Route | findRoute(Request $request) Найти маршрут, соответствующий данному запросу. | |
| 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 | middleware(string $name, string $class) Зарегистрировать сокращенное имя для 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 | 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 для всех маршрутов. | |
| 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() Псевдоним для метода "currentRouteName". | |
| 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. |
Details
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)
Создает новый экземпляр маршрутизатора.
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)
Регистрирует новый маршрут с заданными 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 singularResourceParameters()
Устанавливает глобальные параметры ресурса в единственное число.
void resourceParameters(array $parameters = [])
Установить сопоставление глобальных параметров ресурса.
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)
Обновить стек групп заданными атрибутами.
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|null $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)
Добавить действие маршрута, основанное на контроллере, в массив 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|array resolveMiddlewareClassName(string $name)
Разрешить имя middleware до имени(имён) класса, сохраняя переданные параметры.
protected array parseMiddlewareGroup(string $name)
Разбирать группу middleware и форматировать её для использования.
protected void substituteImplicitBindings(Route $route)
Подставить неявные привязки Eloquent моделей для маршрута.
protected mixed performBinding(string $key, string $value, Route $route)
Вызвать коллбэк привязки для данного ключа.
void matched(string|callable $callback)
Зарегистрировать слушатель события совпадения маршрута.
array getMiddleware()
Получить все определенные имена middleware в сокращенном формате.
$this middleware(string $name, string $class)
Зарегистрировать имя в сокращенном формате для 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 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)
Установить глобальный шаблон для всех маршрутов.
void patterns(array $patterns)
Установить группу глобальных шаблонов для всех маршрутов.
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()
Псевдоним для метода "currentRouteName".
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".
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.2/Illuminate/Routing/Router.html
