Маршрутизатор
класс Маршрутизатор реализует BindingRegistrar, Registrar mixin 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 void | flushMacros()
Очистить существующие макрокоманды. | 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)
Зарегистрировать новый Fallback маршрут. | |
| 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 = [], int|array $status = 200, array $headers = [])
Зарегистрировать новый маршрут, который возвращает представление. | |
| 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)
Добавить префикс пространства имен последней группы к инструкции использования. | |
| string | prependGroupController(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) Передать запрос приложению. | |
| Response | dispatchToRoute(Request $request) Передать запрос на маршрут и вернуть ответ. | |
| Route | findRoute(Request $request) Найти маршрут, соответствующий заданному запросу. | |
| Response | runRoute(Request $request, Route $route) Возвращает ответ для заданного маршрута. | |
| mixed | runRouteWithinStack(Route $route, Request $request) Выполнить заданный маршрут в экземпляре стека "луковицы". | |
| array | gatherRouteMiddleware(Route $route) Собрать middleware для заданного маршрута с разрешёнными именами классов. | |
| array | sortMiddleware(Collection $middlewares) Отсортировать заданный middleware по приоритету. | |
| Response | prepareResponse(Request $request, mixed $response) Создать экземпляр ответа из заданного значения. | |
| static Response | 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) Проверить, существует ли группа middleware с заданным именем. | |
| 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. | |
| $this | flushMiddlewareGroups() Очистить группы 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|null | 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 из заданного массива. | |
| $this | setContainer(Container $container)
Установить экземпляр контейнера, используемого маршрутизатором. |
Подробности
static void macro(string $name, object|callable $macro)
Зарегистрировать пользовательское макро.
static void mixin(object $mixin, bool $replace = true)
Смешать другой объект в класс.
static bool hasMacro(string $name)
Проверяет, зарегистрировано ли макро.
static void flushMacros()
Очистить существующие макросы.
static mixed __callStatic(string $method, array $parameters)
Динамически обработать вызовы к классу.
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)
Зарегистрировать новый Fallback маршрут в маршрутизаторе.
Маршрут redirect(string $uri, string $destination, int $status = 302)
Создать перенаправление с одного URI на другой.
Маршрут permanentRedirect(string $uri, string $destination)
Создать постоянное перенаправление с одного URI на другой.
Маршрут view(string $uri, string $view, array $data = [], int|array $status = 200, array $headers = [])
Зарегистрировать новый маршрут, возвращающий представление.
Маршрут 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)
Создать группу маршрутов с общими атрибутами.
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)
Добавить действие маршрута, основанное на контроллере, в массив action.
protected string prependGroupNamespace(string $class)
Добавить пространство имён последней группы к предложению use.
protected string prependGroupController(string $class)
Добавить последний контроллер группы к предложению use.
Маршрут newRoute(array|string $methods, string $uri, mixed $action)
Создать новый объект Route.
protected string prefix(string $uri)
Добавить к заданному URI последний префикс.
protected Маршрут addWhereClausesToRoute(Маршрут $route)
Добавить необходимые условия where к маршруту на основе его первоначальной регистрации.
protected void mergeGroupAttributesIntoRoute(Маршрут $route)
Объединить стек групп с действием контроллера.
Ответ respondWithRoute(string $name)
Возвратить ответ, возвращённый заданным маршрутом.
Ответ dispatch(Запрос $request)
Передать запрос приложению.
Ответ dispatchToRoute(Запрос $request)
Передать запрос на маршрут и вернуть ответ.
protected mixed runRouteWithinStack(Маршрут $route, Запрос $request)
Выполнить данный маршрут внутри экземпляра Stack "луковицы".
array gatherRouteMiddleware(Маршрут $route)
Собрать ПОСРЕДНИКОВ для данного маршрута с разрешенными именами классов.
protected array sortMiddleware(Коллекция $middlewares)
Отсортировать заданные ПОСРЕДНИКИ по приоритету.
Ответ prepareResponse(Request $request, mixed $response)
Создать экземпляр ответа из заданного значения.
static Ответ 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()
Получите все определенные имена средних значений.
$this aliasMiddleware(string $name, string $class)
Зарегистрируйте сокращенное имя для среднего значения.
bool hasMiddlewareGroup(string $name)
Проверьте, существует ли группа средних значений с заданным именем.
array getMiddlewareGroups()
Получить все определенные группы средних значений.
$this middlewareGroup(string $name, array $middleware)
Зарегистрировать группу средних значений.
$this prependMiddlewareToGroup(string $group, string $middleware)
Добавить среднее значение в начало группы средних значений.
Если среднее значение уже есть в группе, оно не будет добавлено снова.
$this pushMiddlewareToGroup(string $group, string $middleware)
Добавить среднее значение в конец группы средних значений.
Если среднее значение уже есть в группе, оно не будет добавлено снова.
$this flushMiddlewareGroups()
Очистить группы средних значений маршрутизатора.
void bind(string $key, string|callable $binder)
Добавить новый параметр маршрута связующего.
void model(string $key, string $class, Closure $callback = null)
Зарегистрировать связующий для модели для подстановки.
Closure getBindingCallback(string $key)
Получить обратный вызов для связывания заданного связывания.
array getPatterns()
Получить глобальные шаблоны "где".
void pattern(string $key, string $pattern)
Установить глобальный шаблон "где" для всех маршрутов.
void patterns(array $patterns)
Установить группу глобальных шаблонов "где" для всех маршрутов.
bool hasGroupStack()
Определить, есть ли у маршрутизатора текущая стек групп.
array getGroupStack()
Получить текущий стек групп для маршрутизатора.
mixed input(string $key, string|null $default = null)
Получить параметр маршрута для текущего маршрута.
Request getCurrentRequest()
Получить запрос, который в данный момент обрабатывается.
Маршрут|null getCurrentRoute()
Получить текущий маршрут.
Маршрут|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 ресурсов.
ИнтерфейсRouteCollection getRoutes()
Получить базовую коллекцию маршрутов.
void setRoutes(RouteCollection $routes)
Установить экземпляр коллекции маршрутов.
void setCompiledRoutes(array $routes)
Установить скомпилированный экземпляр коллекции маршрутов.
static array uniqueMiddleware(array $middleware)
Удалить дублирующиеся middleware из массива.
$this setContainer(Контейнер $container)
Установить контейнер, используемый маршрутизатором.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Routing/Router.html
