Маршрутизатор
класс Router реализует BindingRegistrar, Registrar mixin RouteRegistrar (Просмотреть исходный код)
Трейты
| Macroable | |
| Tappable |
Свойства
| статический защищённый массив | $macros | Зарегистрированные строковые макросы. | из Macroable |
| защищённый Dispatcher | $events | Экземпляр диспетчера событий. | |
| защищённый Container | $container | Экземпляр контейнера IoC. | |
| защищённый RouteCollectionInterface | $routes | Экземпляр коллекции маршрутов. | |
| защищённый Route|null | $current | Текущий экземпляр обработанного маршрута. | |
| защищённый Request | $currentRequest | Запрос, который в данный момент обрабатывается. | |
| защищённый массив | $middleware | Все сокращенные ключи для middleware. | |
| защищённый массив | $middlewareGroups | Все группы middleware. | |
| массив | $middlewarePriority | Отсортированный по приоритету список middleware. | |
| защищённый массив | $binders | Зарегистрированные связующие значения маршрутов. | |
| защищённый массив | $patterns | Глобально доступные шаблоны параметров. | |
| защищённый массив | $groupStack | Стек атрибутов группы маршрутов. | |
| защищённый массив | $implicitBindingCallback | Зарегистрированный пользовательский обратный вызов для неявной привязки. | |
| статический массив строк | $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)
Динамически обрабатывать вызовы в экземпляр маршрутизатора. | |
| tap($callback = null)
Вызвать данный Closure с этим экземпляром, затем вернуть экземпляр. | from Tappable | |
| void | __construct(Dispatcher $events, Container|null $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 = [], 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 | singletons(array $singletons, array $options = [])
Зарегистрировать массив одиночных контроллеров ресурсов. | |
| PendingSingletonResourceRegistration | singleton(string $name, string $controller, array $options = [])
Проложить маршрут одиночного ресурса к контроллеру. | |
| void | apiSingletons(array $singletons, array $options = [])
Зарегистрировать массив одиночных контроллеров ресурсов API. | |
| PendingSingletonResourceRegistration | apiSingleton(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)
Добавить пространство имён последней группы в начало предложения use. |
| string | prependGroupController(string $class)
Добавить последний контроллер группы в предложение use. | |
| 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)
Запустить данный маршрут внутри экземпляра Stack "onion". | |
| array | gatherRouteMiddleware(Route $route)
Собрать middleware для данного маршрута с разрешенными именами классов. | |
| array | resolveMiddleware(array $middleware, array $excluded = [])
Разрешить плоский массив классов 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)
Подставить неявные привязки маршрута для данного маршрута. | |
| $this | substituteImplicitBindingsUsing(callable $callback)
Зарегистрировать обратный вызов для выполнения после подстановки неявных привязок. | |
| 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)
Проверить, существует ли middlewareGroup с заданным именем. | |
| 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 | removeMiddlewareFromGroup(string $group, string $middleware)
Удалить заданный middleware из указанной группы. | |
| $this | flushMiddlewareGroups()
Очистить группы middleware маршрутизатора. | |
| void | bind(string $key, string|callable $binder)
Добавить новый параметр привязки маршрута. | |
| void | model(string $key, string $class, Closure|null $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|array $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)
Удалить дублирующиеся посредники из заданного массива. | |
| $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)
Динамически обрабатывает вызовы в экземпляр маршрутизатора.
tap($callback = null)
Вызвать заданный замыкание с этим экземпляром, а затем вернуть экземпляр.
void __construct(Dispatcher $events, Container|null $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 в маршрутизаторе.
Маршрут delete(string $uri, array|string|callable $action = null)
Регистрация нового маршрута DELETE в маршрутизаторе.
Маршрут options(string $uri, array|string|callable $action = null)
Регистрация нового маршрута OPTIONS в маршрутизаторе.
Маршрут any(string $uri, array|string|callable|null $action = null)
Регистрация нового маршрута, обрабатывающего все глаголы.
Маршрут fallback(array|string|callable|null $action)
Регистрация нового маршрута по умолчанию в маршрутизаторе.
Маршрут 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 = [])
Регистрация массива контроллеров ресурсов.
Запись о регистрации ресурса resource(string $name, string $controller, array $options = [])
Маршрутизация ресурса к контроллеру.
void apiResources(array $resources, array $options = [])
Регистрация массива контроллеров API-ресурсов.
Запись о регистрации ресурса apiResource(string $name, string $controller, array $options = [])
Маршрутизация API-ресурса к контроллеру.
void singletons(array $singletons, array $options = [])
Регистрация массива синглтон-контроллеров ресурсов.
Запись о регистрации синглтона ресурса singleton(string $name, string $controller, array $options = [])
Маршрутизация синглтон-ресурса к контроллеру.
void apiSingletons(array $singletons, array $options = [])
Регистрация массива синглтон-контроллеров API-ресурсов.
Запись о регистрации синглтона ресурса apiSingleton(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()
Получить префикс из последней группы в стеке.
Route addRoute(array|string $methods, string $uri, array|string|callable|null $action)
Добавить маршрут в основную коллекцию маршрутов.
protected Route createRoute(array|string $methods, string $uri, mixed $action)
Создать новый экземпляр маршрута.
protected bool actionReferencesController(mixed $action)
Определить, ссылается ли действие на контроллер.
protected array convertToControllerAction(array|string $action)
Добавить действие маршрута, основанное на контроллере, в массив действий.
protected string prependGroupNamespace(string $class)
Добавить пространство имён последней группы к имени класса.
protected string prependGroupController(string $class)
Добавить имя контроллера последней группы к имени класса.
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)
Объединить атрибуты группы со действием контроллера.
Response respondWithRoute(string $name)
Возвратить ответ, возвращённый данным маршрутом.
Response dispatch(Request $request)
Отправить запрос в приложение.
Response dispatchToRoute(Request $request)
Отправить запрос на маршрут и вернуть ответ.
protected Response runRoute(Запрос $request, Маршрут $route)
Возвращает ответ для заданного маршрута.
protected mixed runRouteWithinStack(Маршрут $route, Запрос $request)
Выполняет заданный маршрут внутри экземпляра стека "луковицы".
array gatherRouteMiddleware(Маршрут $route)
Собрать промежуточное ПО для заданного маршрута с разрешенными именами классов.
array resolveMiddleware(array $middleware, array $excluded = [])
Разрешить плоский массив классов промежуточного ПО из предоставленного массива.
protected array sortMiddleware(Коллекция $middlewares)
Сортировать заданное промежуточное ПО по приоритету.
Response prepareResponse(Request $request, mixed $response)
Создать экземпляр ответа из заданного значения.
static Response toResponse(Request $request, mixed $response)
Статическая версия prepareResponse.
void substituteImplicitBindings(Маршрут $route)
Подставить неявные привязки маршрута для данного маршрута.
$this substituteImplicitBindingsUsing(callable $callback)
Зарегистрировать обратный вызов для выполнения после подстановки неявных привязок.
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 removeMiddlewareFromGroup(string $group, string $middleware)
Удалить заданную мидлварь из указанной группы.
$this flushMiddlewareGroups()
Очистить группы мидлвар маршрутизатора.
void bind(string $key, string|callable $binder)
Добавить новый связующий элемент параметра маршрута.
void model(string $key, string $class, Closure|null $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|array $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)
Установить экземпляр контейнера, используемый маршрутизатором.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Routing/Router.html
