Spec-Zone.ru › Laravel 10

Коллекция маршрутов

класс RouteCollection расширяет AbstractRouteCollection (Просмотр исходного кода)

Свойства

защищённый массив $routes

Массив маршрутов, индексированный по методу.

защищённый Route[] $allRoutes

Расширенный массив всех маршрутов.

защищённый Route[] $nameList

Таблица поиска маршрутов по их именам.

защищённый Route[] $actionList

Таблица поиска маршрутов по действиям контроллера.

Методы

Route handleMatchedRoute(Request $request, Route|null $route)

Обработка сопоставленного маршрута.

из AbstractRouteCollection
массив checkForAlternateVerbs(Request $request)

Определение, есть ли маршруты, соответствующие другому HTTP-методу.

из AbstractRouteCollection
Route|null matchAgainstRoutes(array $routes, Request $request, bool $includingMethod = true)

Определение, соответствует ли маршрут в массиве запросу.

из AbstractRouteCollection
Route getRouteForMethods(Request $request, array $methods)

Получение маршрута (при необходимости), отвечающего, когда присутствуют другие доступные методы.

из AbstractRouteCollection
void requestMethodNotAllowed(Request $request, array $others, string $method)

Выброс исключения HTTP "Метод не разрешён".

из AbstractRouteCollection
void methodNotAllowed(array $others, string $method) deprecated

Выброс исключения HTTP "Метод не разрешён".

из AbstractRouteCollection
массив compile()

Компиляция маршрутов для кэширования.

из AbstractRouteCollection
CompiledUrlMatcherDumper dumper()

Возврат экземпляра CompiledUrlMatcherDumper для коллекции маршрутов.

из AbstractRouteCollection
RouteCollection toSymfonyRouteCollection()

Преобразование коллекции в экземпляр Symfony RouteCollection.

RouteCollection addToSymfonyRoutesCollection(RouteCollection $symfonyRoutes, Route $route)

Добавление маршрута к экземпляру SymfonyRouteCollection.

из AbstractRouteCollection
строка generateRouteName()

Получение случайно сгенерированного имени маршрута.

из AbstractRouteCollection
Traversable getIterator()

Получение итератора для элементов.

из AbstractRouteCollection
целое число count()

Подсчёт количества элементов в коллекции.

из AbstractRouteCollection
Route add(Route $route)

Добавление экземпляра Route в коллекцию.

void addToCollections(Route $route)

Добавление заданного маршрута в массивы маршрутов.

void addLookups(Route $route)

Добавление маршрута в таблицы поиска, если необходимо.

void addToActionList(array $action, Route $route)

Добавление маршрута в словарь действий контроллера.

void refreshNameLookups()

Обновление таблицы поиска по имени.

void refreshActionLookups()

Обновление таблицы поиска по действиям.

Route match(Request $request)

Поиск первого маршрута, соответствующего заданному запросу.

Route[] get(string|null $method = null)

Получение маршрутов из коллекции по методу.

bool hasNamedRoute(string $name)

Определение, содержит ли коллекция маршрутов маршрут с заданным именем.

Route|null getByName(string $name)

Получение экземпляра маршрута по его имени.

Route|null getByAction(string $action)

Получение экземпляра маршрута по его действию контроллера.

Route[] getRoutes()

Получение всех маршрутов в коллекции.

массив getRoutesByMethod()

Получение всех маршрутов, индексированных по их HTTP-методу.

Route[] getRoutesByName()

Получение всех маршрутов, индексированных по их имени.

CompiledRouteCollection toCompiledRouteCollection(Router $router, Container $container)

Преобразование коллекции в экземпляр CompiledRouteCollection.

Подробности

protected Маршрут handleMatchedRoute(Запрос $request, Маршрут|null $route)

Обработать соответствующий маршрут.

Параметры

Запрос $request
Маршрут|null $route

Возвращаемое значение

Маршрут

Исключения

NotFoundHttpException

protected array checkForAlternateVerbs(Запрос $request)

Определить, соответствуют ли какие-либо маршруты другому HTTP-глаголу.

Параметры

Запрос $request

Возвращаемое значение

array

protected Маршрут|null matchAgainstRoutes(array $routes, Запрос $request, bool $includingMethod = true)

Определить, соответствует ли маршрут в массиве запросу.

Параметры

array $routes
Запрос $request
bool $includingMethod

Возвращаемое значение

Маршрут|null

protected Маршрут getRouteForMethods(Запрос $request, array $methods)

Получить маршрут (при необходимости), который отвечает, когда присутствуют другие доступные методы.

Параметры

Запрос $request
array $methods

Возвращаемое значение

Маршрут

Исключения

MethodNotAllowedHttpException

protected void requestMethodNotAllowed(Запрос $request, array $others, string $method)

Выбросить исключение HTTP «Метод не разрешен».

Параметры

Запрос $request
array $others
string $method

Возвращаемое значение

void

Исключения

MethodNotAllowedHttpException

protected void methodNotAllowed(array $others, string $method) устаревший

устаревший

используйте requestMethodNotAllowed

Выбросить исключение HTTP «Метод не разрешен».

Параметры

array $others
string $method

Возвращаемое значение

void

Исключения

MethodNotAllowedHttpException

array compile()

Компилировать маршруты для кэширования.

Возвращаемое значение

array

CompiledUrlMatcherDumper dumper()

Возвратить экземпляр CompiledUrlMatcherDumper для коллекции маршрутов.

Возвращаемое значение

CompiledUrlMatcherDumper

RouteCollection toSymfonyRouteCollection()

Преобразовать коллекцию в экземпляр Symfony RouteCollection.

Возвращаемое значение

RouteCollection

protected RouteCollection addToSymfonyRoutesCollection(RouteCollection $symfonyRoutes, Маршрут $route)

Добавить маршрут к экземпляру SymfonyRouteCollection.

Параметры

RouteCollection $symfonyRoutes
Маршрут $route

Возвращаемое значение

RouteCollection

Исключения

LogicException

protected string generateRouteName()

Получить случайное имя маршрута.

Возвращаемое значение

string

Итерируемый объект getIterator()

Получить итератор для элементов.

Возвращаемое значение

Итерируемый объект

int count()

Подсчитать количество элементов в коллекции.

Возвращаемое значение

int

Маршрут add(Маршрут $route)

Добавить экземпляр Route в коллекцию.

Параметры

Маршрут $route

Возвращаемое значение

Маршрут

protected void addToCollections(Маршрут $route)

Добавить указанный маршрут в массивы маршрутов.

Параметры

Маршрут $route

Возвращаемое значение

void

protected void addLookups(Маршрут $route)

Добавить маршрут в таблицы поиска, если необходимо.

Параметры

Маршрут $route

Возвращаемое значение

void

protected void addToActionList(array $action, Маршрут $route)

Добавить маршрут в словарь действий контроллера.

Параметры

array $action
Маршрут $route

Возвращаемое значение

void

void refreshNameLookups()

Обновить таблицу поиска по именам.

Это делается в случае, если какие-либо имена определены динамически или маршруты перезаписаны.

Значение возврата

void

void refreshActionLookups()

Обновить таблицу поиска по действиям.

Это делается в случае, если какие-либо действия перезаписаны новыми контроллерами.

Значение возврата

void

Маршрут match(Запрос $request)

Найти первый маршрут, соответствующий данному запросу.

Параметры

Запрос $request

Значение возврата

Маршрут

Исключения

MethodNotAllowedHttpException
NotFoundHttpException

Маршрут[] get(string|null $method = null)

Получить маршруты из коллекции по методу.

Параметры

string|null $method

Значение возврата

Маршрут[]

bool hasNamedRoute(string $name)

Определить, содержит ли коллекция маршрутов указанный именованный маршрут.

Параметры

string $name

Значение возврата

bool

Маршрут|null getByName(string $name)

Получить экземпляр маршрута по его имени.

Параметры

string $name

Значение возврата

Маршрут|null

Маршрут|null getByAction(string $action)

Получить экземпляр маршрута по его действию контроллера.

Параметры

string $action

Значение возврата

Маршрут|null

Маршрут[] getRoutes()

Получить все маршруты в коллекции.

Значение возврата

Маршрут[]

array getRoutesByMethod()

Получить все маршруты, индексированные по HTTP-методу.

Значение возврата

array

Маршрут[] getRoutesByName()

Получить все маршруты, индексированные по имени.

Значение возврата

Маршрут[]

СкомпилированнаяКоллекцияМаршрутов toCompiledRouteCollection(Маршрутизатор $router, Контейнер $container)

Преобразовать коллекцию в экземпляр CompiledRouteCollection.

Параметры

Маршрутизатор $router
Контейнер $container

Значение возврата

СкомпилированнаяКоллекцияМаршрутов

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Routing/RouteCollection.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API