Маршрутизатор
класс Router реализует BindingRegistrar, Registrar смесь RouteRegistrar (Просмотр исходного кода)
Трейты
| Macroable |
Свойства
| статический защищенный массив | $macros | Зарегистрированные строковые макросы. | из Macroable |
| защищенный Dispatcher | $events | Экземпляр диспетчера событий. | |
| защищенный Container | $container | Экземпляр контейнера IoC. | |
| защищенный RouteCollectionInterface | $routes | Экземпляр коллекции маршрутов. | |
| защищенный Route|null | $current | Экземпляр текущего маршрута, который обрабатывается. | |
| защищенный Request | $currentRequest | Запрос, который в данный момент обрабатывается. | |
| защищенный массив | $middleware | Все сокращенные ключи для middleware. | |
| защищенный массив | $middlewareGroups | Все группы middleware. | |
| массив | $middlewarePriority | Список middleware, отсортированный по приоритету. | |
| защищенный массив | $binders | Зарегистрированные связующие значения маршрутов. | |
| защищенный массив | $patterns | Глобально доступные шаблоны параметров. | |
| защищенный массив | $groupStack | Стек атрибутов группы маршрутов. | |
| статический массив | $verbs | Все поддерживаемые маршрутизатором глаголы. |
Методы
| static void | macro(string $name, object|callable $macro)
Зарегистрировать пользовательскую макрокоманду. | from Macroable |
| static void | mixin(object $mixin, bool $replace = true)
Смешать другой объект в класс. | from Macroable |
| static bool | hasMacro(string $name)
Проверить, зарегистрирована ли макрокоманда. | from Macroable |
| static mixed | __callStatic(string $method, array $parameters)
Динамически обработать вызовы к классу. | from Macroable |
| mixed | __call(string $method, array $parameters)
Динамически обработать вызовы в экземпляр маршрутизатора. | |
| void | __construct(Dispatcher $events, Container $container = null)
Создать новый экземпляр маршрутизатора. | |
| Route | get(string $uri, array|string|callable $action = null)
Зарегистрировать новый маршрут GET в маршрутизаторе. | |
| Route | post(string $uri, array|string|callable $action = null)
Зарегистрировать новый маршрут POST в маршрутизаторе. | |
| Route | put(string $uri, array|string|callable $action = null)
Зарегистрировать новый маршрут PUT в маршрутизаторе. | |
| Route | patch(string $uri, array|string|callable $action = null)
Зарегистрировать новый маршрут PATCH в маршрутизаторе. | |
| Route | delete(string $uri, array|string|callable $action = null)
Зарегистрировать новый маршрут DELETE в маршрутизаторе. | |
| Route | options(string $uri, array|string|callable $action = null)
Зарегистрировать новый маршрут OPTIONS в маршрутизаторе. | |
| Route | any(string $uri, array|string|callable|null $action = null)
Зарегистрировать новый маршрут, обрабатывающий все глаголы. | |
| Route | fallback(array|string|callable|null $action)
Зарегистрировать новый маршрут по умолчанию в маршрутизаторе. | |
| Route | redirect(string $uri, string $destination, int $status = 302)
Создать перенаправление с одного URI на другой. | |
| Route | permanentRedirect(string $uri, string $destination)
Создать постоянное перенаправление с одного URI на другой. | |
| Route | view(string $uri, string $view, array $data = [])
Зарегистрировать новый маршрут, возвращающий представление. | |
| Route | match(array|string $methods, string $uri, array|string|callable $action = null)
Зарегистрировать новый маршрут с указанными глаголами. | |
| void | resources(array $resources, array $options = [])
Зарегистрировать массив контроллеров ресурсов. | |
| PendingResourceRegistration | resource(string $name, string $controller, array $options = [])
Направить ресурс на контроллер. | |
| void | apiResources(array $resources, array $options = [])
Зарегистрировать массив контроллеров 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, bool $prependExistingPrefix = true)
Объединить заданный массив со стеком последней группы. | |
| void | loadRoutes(Closure|string $routes)
Загрузить предоставленные маршруты. | |
| string | getLastGroupPrefix()
Получить префикс из последней группы в стеке. | |
| Route | addRoute(array|string $methods, string $uri, array|string|callable|null $action)
Добавить маршрут в базовую коллекцию маршрутов. | |
| Route | createRoute(array|string $methods, string $uri, mixed $action)
Создать новый экземпляр маршрута. | |
| bool | actionReferencesController(mixed $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 | respondWithRoute(string $name)
Вернуть ответ, возвращённый данным маршрутом. | |
| Response | dispatch(Request $request)
Отправить запрос приложению. |
| Ответ | dispatchToRoute(Запрос $request)
Передать запрос маршруту и вернуть ответ. | |
| Маршрут | findRoute(Запрос $request)
Найти маршрут, соответствующий данному запросу. | |
| Ответ | runRoute(Запрос $request, Маршрут $route)
Возвратить ответ для данного маршрута. | |
| смешанный тип | runRouteWithinStack(Маршрут $route, Запрос $request)
Выполнить данный маршрут внутри экземпляра Stack "луковицы". | |
| массив | gatherRouteMiddleware(Маршрут $route)
Собрать middleware для данного маршрута с разрешенными именами классов. | |
| массив | sortMiddleware(Коллекция $middlewares)
Отсортировать указанный middleware по приоритету. | |
| Ответ | prepareResponse(Запрос $request, смешанный тип $response)
Создать экземпляр ответа из данного значения. | |
| статический Ответ | toResponse(Запрос $request, смешанный тип $response)
Статическая версия prepareResponse. | |
| Маршрут | substituteBindings(Маршрут $route)
Заменить привязки маршрута на маршрут. | |
| void | substituteImplicitBindings(Маршрут $route)
Заменить неявные привязки модели Eloquent для маршрута. | |
| смешанный тип | performBinding(строка $key, строка $value, Маршрут $route)
Вызвать обратный вызов привязки для данного ключа. | |
| void | matched(строка|вызываемая функция $callback)
Зарегистрировать обработчик события сопоставления маршрута. | |
| массив | getMiddleware()
Получить все определенные имена middleware в сокращенном виде. | |
| $this | aliasMiddleware(строка $name, строка $class)
Зарегистрировать сокращенное имя для middleware. | |
| bool | hasMiddlewareGroup(строка $name)
Проверить, существует ли middlewareGroup с данным именем. | |
| массив | getMiddlewareGroups()
Получить все определенные группы middleware. | |
| $this | middlewareGroup(строка $name, массив $middleware)
Зарегистрировать группу middleware. | |
| $this | prependMiddlewareToGroup(строка $group, строка $middleware)
Добавить middleware в начало группы middleware. | |
| $this | pushMiddlewareToGroup(строка $group, строка $middleware)
Добавить middleware в конец группы middleware. | |
| void | bind(строка $key, строка|вызываемая функция $binder)
Добавить новый binder параметров маршрута. | |
| void | model(строка $key, строка $class, Closure $callback = null)
Зарегистрировать binder модели для подстановки. | |
| Closure | getBindingCallback(строка $key)
Получить обратный вызов привязки для данной привязки. | |
| массив | getPatterns()
Получить глобальные шаблоны "where". | |
| void | pattern(строка $key, строка $pattern)
Установить глобальный шаблон "where" для всех маршрутов. | |
| void | patterns(массив $patterns)
Установить группу глобальных шаблонов "where" для всех маршрутов. | |
| bool | hasGroupStack()
Определить, имеет ли маршрутизатор текущую стек группы. | |
| массив | getGroupStack()
Получить текущий стек группы маршрутизатора. | |
| смешанный тип | input(строка $key, строка|null $default = null)
Получить параметр маршрута для текущего маршрута. | |
| Запрос | getCurrentRequest()
Получить запрос, который в данный момент обрабатывается. | |
| Маршрут | getCurrentRoute()
Получить текущий экземпляр обрабатываемого маршрута. | |
| Маршрут|null | current()
Получить текущий экземпляр обрабатываемого маршрута. | |
| bool | has(строка $name)
Проверить, существует ли маршрут с заданным именем. | |
| строка|null | currentRouteName()
Получить имя текущего маршрута. | |
| bool | is(смешанный тип ...$patterns)
Псевдоним метода "currentRouteNamed". | |
| bool | currentRouteNamed(смешанный тип ...$patterns)
Определить, соответствует ли текущий маршрут шаблону. | |
| строка|null | currentRouteAction()
Получить действие текущего маршрута. | |
| bool | uses(массив ...$patterns)
Псевдоним метода "currentRouteUses". | |
| bool | currentRouteUses(строка $action)
Определить, соответствует ли действие текущего маршрута заданному действию. | |
| void | singularResourceParameters(bool $singular = true)
Установить глобальные параметры ресурса без сопоставления в единственном числе. | |
| void | resourceParameters(массив $parameters = [])
Установить глобальное сопоставление параметров ресурсов. | |
| массив|null | resourceVerbs(массив $verbs = [])
Получить или установить глаголы, используемые в ресурсных URI. | |
| Интерфейс RouteCollection | getRoutes()
Получить базовую коллекцию маршрутов. | |
| void | setRoutes(RouteCollection $routes)
Установить экземпляр коллекции маршрутов. | |
| void | setCompiledRoutes(массив $routes)
Установить экземпляр скомпилированной коллекции маршрутов. |
| статический массив | uniqueMiddleware(массив $middleware)
Удаляет любые дублирующиеся средства промежуточного программного обеспечения из данного массива. |
Подробности
статический void macro(строка $name, объект|вызываемый $macro)
Регистрирует пользовательское макро.
статический void mixin(объект $mixin, bool $replace = true)
Смешивает другой объект в класс.
статический bool hasMacro(строка $name)
Проверяет, зарегистрировано ли макро.
статический смешанный __callStatic(строка $method, массив $parameters)
Динамически обрабатывает вызовы класса.
смешанный __call(строка $method, массив $parameters)
Динамически обрабатывает вызовы в экземпляр маршрутизатора.
void __construct(Dispatcher $events, Container $container = null)
Создает новый экземпляр маршрутизатора.
Маршрут get(строка $uri, массив|строка|вызываемый $action = null)
Регистрирует новый маршрут GET в маршрутизаторе.
Маршрут post(строка $uri, массив|строка|вызываемый $action = null)
Регистрирует новый маршрут POST в маршрутизаторе.
Маршрут put(строка $uri, массив|строка|вызываемый $action = null)
Регистрирует новый маршрут PUT в маршрутизаторе.
Маршрут patch(строка $uri, массив|строка|вызываемый $action = null)
Регистрирует новый маршрут PATCH в маршрутизаторе.
Маршрут delete(строка $uri, массив|строка|вызываемый $action = null)
Регистрирует новый маршрут DELETE в маршрутизаторе.
Маршрут options(строка $uri, массив|строка|вызываемый $action = null)
Регистрирует новый маршрут OPTIONS в маршрутизаторе.
Маршрут any(строка $uri, массив|строка|вызываемый|null $action = null)
Регистрирует новый маршрут, отвечающий на все глаголы.
Маршрут fallback(массив|строка|вызываемый|null $action)
Регистрирует новый маршрут по умолчанию в маршрутизаторе.
Маршрут redirect(строка $uri, строка $destination, целое число $status = 302)
Создает перенаправление с одного URI на другой.
Маршрут permanentRedirect(строка $uri, строка $destination)
Создает постоянное перенаправление с одного URI на другой.
Маршрут view(строка $uri, строка $view, массив $data = [])
Регистрирует новый маршрут, который возвращает представление.
Маршрут match(array|string $methods, string $uri, array|string|callable $action = null)
Регистрирует новый маршрут с заданными HTTP-методами.
void resources(array $resources, array $options = [])
Регистрирует массив контроллеров ресурсов.
PendingResourceRegistration resource(string $name, string $controller, array $options = [])
Назначает ресурс контроллеру.
void apiResources(array $resources, array $options = [])
Регистрирует массив контроллеров 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, bool $prependExistingPrefix = true)
Объединяет заданный массив со стеком последней группы.
protected void loadRoutes(Closure|string $routes)
Загружает предоставленные маршруты.
string getLastGroupPrefix()
Возвращает префикс последней группы в стеке.
Маршрут addRoute(array|string $methods, string $uri, array|string|callable|null $action)
Добавляет маршрут в коллекцию маршрутов.
protected Маршрут createRoute(array|string $methods, string $uri, mixed $action)
Создаёт новый экземпляр маршрута.
protected bool actionReferencesController(mixed $action)
Определяет, ссылается ли действие на контроллер.
protected array convertToControllerAction(array|string $action)
Добавляет действие контроллера к массиву действия.
protected string prependGroupNamespace(string $class)
Добавляет префикс последней группы пространства имён к предложению использования.
Маршрут newRoute(array|string $methods, string $uri, mixed $action)
Создаёт новый объект маршрута.
protected string prefix(string $uri)
Добавляет префикс к заданному URI с помощью последнего префикса.
protected Маршрут addWhereClausesToRoute(Маршрут $route)
Добавляет необходимые условия where к маршруту на основе его первоначальной регистрации.
protected void mergeGroupAttributesIntoRoute(Route $route)
Объединить стек групповых атрибутов с действием контроллера.
Response respondWithRoute(string $name)
Возвратить ответ, возвращённый заданным маршрутом.
Response dispatch(Request $request)
Передать запрос в приложение.
Response dispatchToRoute(Request $request)
Передать запрос на маршрут и вернуть ответ.
protected mixed runRouteWithinStack(Route $route, Request $request)
Выполнить заданный маршрут внутри экземпляра Stack.
array gatherRouteMiddleware(Route $route)
Собрать миддлварь для заданного маршрута с разрешёнными именами классов.
protected array sortMiddleware(Collection $middlewares)
Отсортировать заданный миддлварь по приоритету.
Response prepareResponse(Request $request, mixed $response)
Создать экземпляр ответа из заданного значения.
static Response toResponse(Request $request, mixed $response)
Статическая версия prepareResponse.
void substituteImplicitBindings(Route $route)
Подставить неявные привязки Eloquent модели для маршрута.
protected mixed performBinding(string $key, string $value, Route $route)
Вызвать коллбек привязки для заданного ключа.
void matched(string|callable $callback)
Зарегистрировать обработчик события сопоставленного маршрута.
array getMiddleware()
Получить все определённые миддлварь сокращённые имена.
$this aliasMiddleware(string $name, string $class)
Зарегистрировать сокращённое имя для миддлвари.
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)
Добавить новый связыватель параметров маршрута.
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|null $default = null)
Получить параметр маршрута для текущего маршрута.
Request getCurrentRequest()
Получить запрос, который в настоящее время обрабатывается.
Route getCurrentRoute()
Получить экземпляр текущего обрабатываемого маршрута.
Route|null current()
Получить экземпляр текущего обрабатываемого маршрута.
bool has(string $name)
Проверить, существует ли маршрут с заданным именем.
string|null currentRouteName()
Получить имя текущего маршрута.
bool is(mixed ...$patterns)
Псевдоним для метода "currentRouteNamed".
bool currentRouteNamed(mixed ...$patterns)
Определить, соответствует ли текущий маршрут шаблону.
string|null currentRouteAction()
Получить действие текущего маршрута.
bool uses(array ...$patterns)
Псевдоним для метода "currentRouteUses".
bool currentRouteUses(string $action)
Определить, соответствует ли текущий маршрут заданному действию.
void singularResourceParameters(bool $singular = true)
Установить неотображенные глобальные параметры ресурса в единственном числе.
void resourceParameters(array $parameters = [])
Установить отображение глобальных параметров ресурса.
array|null resourceVerbs(array $verbs = [])
Получить или установить глаголы, используемые в URI ресурса.
RouteCollectionInterface getRoutes()
Получить базовую коллекцию маршрутов.
void setRoutes(RouteCollection $routes)
Установить экземпляр коллекции маршрутов.
void setCompiledRoutes(array $routes)
Установить скомпилированный экземпляр коллекции маршрутов.
static array uniqueMiddleware(array $middleware)
Удалить дублирующие middleware из заданного массива.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/7.x/Illuminate/Routing/Router.html
