Spec-Zone.ru › Laravel 7

Сборник маршрутов

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

Свойства

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

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

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

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

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

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

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

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

Методы

Route обработатьСопоставленныйМаршрут(Request $request, Route|null $route)

Обработать сопоставленный маршрут.

из AbstractRouteCollection
массив проверитьАльтернативныеГлаголы(Request $request)

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

из AbstractRouteCollection
Route|null сопоставитьСМаршрутами(массив $routes, Request $request, bool $includingMethod = true)

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

из AbstractRouteCollection
Route получитьМаршрутДляМетодов(Request $request, массив $methods)

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

из AbstractRouteCollection
void методНеРазрешён(массив $others, строка $method)

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

из AbstractRouteCollection
массив скомпилировать()

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

из AbstractRouteCollection
CompiledUrlMatcherDumper dumper()

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

из AbstractRouteCollection
RouteCollection вSymfonyRouteCollection()

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

RouteCollection добавитьВSymfonyRoutesCollection(RouteCollection $symfonyRoutes, Route $route)

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

из AbstractRouteCollection
строка сгенерироватьИмяМаршрута()

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

из AbstractRouteCollection
ArrayIterator получитьИтератор()

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

из AbstractRouteCollection
целое число подсчитать()

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

из AbstractRouteCollection
Route добавить(Route $route)

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

void добавитьВСборники(Route $route)

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

void добавитьПросмотры(Route $route)

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

void добавитьВСписокДействий(массив $action, Route $route)

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

void обновитьПросмотрыИмен()

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

void обновитьПросмотрыДействий()

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

Route сопоставить(Request $request)

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

Route[] получить(строка|null $method = null)

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

bool имеетИменованныйМаршрут(строка $name)

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

Route|null получитьПоИмени(строка $name)

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

Route|null получитьПоДействию(строка $action)

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

Route[] получитьМаршруты()

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

массив получитьМаршрутыПоМетоду()

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

Route[] получитьМаршрутыПоИмени()

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

CompiledRouteCollection вCompiledRouteCollection(Router $router, Container $container)

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

Подробности

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

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

Параметры

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

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

Маршрут

Исключения

NotFoundHttpException

protected массив checkForAlternateVerbs(Запрос $request)

Определение соответствия маршрутов с другими HTTP-методами.

Параметры

Запрос $request

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

массив

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

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

Параметры

массив $routes
Запрос $request
bool $includingMethod

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

Маршрут|null

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

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

Параметры

Запрос $request
массив $methods

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

Маршрут

Исключения

MethodNotAllowedHttpException

protected void methodNotAllowed(массив $others, string $method)

Выбрасывание исключения Method Not Allowed (Метод не разрешен).

Параметры

массив $others
строка $method

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

void

Исключения

MethodNotAllowedHttpException

массив compile()

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

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

массив

CompiledUrlMatcherDumper dumper()

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

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

CompiledUrlMatcherDumper

RouteCollection toSymfonyRouteCollection()

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

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

RouteCollection

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

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

Параметры

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

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

RouteCollection

protected строка generateRouteName()

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

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

строка

ArrayIterator getIterator()

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

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

ArrayIterator

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

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

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

целое число

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

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

Параметры

Маршрут $route

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

Маршрут

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

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

Параметры

Маршрут $route

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

void

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

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

Параметры

Маршрут $route

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

void

protected void addToActionList(массив $action, Маршрут $route)

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

Параметры

массив $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/7.x/Illuminate/Routing/RouteCollection.html

Spec-Zone.ru

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