Spec-Zone.ru › Laravel 6

RouteCollection

class RouteCollection implements Countable, IteratorAggregate (View source)

Свойства

protected array $routes

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

protected array $allRoutes

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

protected array $nameList

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

protected array $actionList

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

Методы

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|null matchAgainstRoutes(array $routes, Request $request, bool $includingMethod = true)

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

array checkForAlternateVerbs(Request $request)

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

Route getRouteForMethods(Request $request, array $methods)

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

void methodNotAllowed(array $others, string $method)

Выбросить исключение HTTP, запрещающее метод.

array get(string|null $method = null)

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

bool hasNamedRoute(string $name)

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

Route|null getByName(string $name)

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

Route|null getByAction(string $action)

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

array getRoutes()

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

array getRoutesByMethod()

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

array getRoutesByName()

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

ArrayIterator getIterator()

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

int count()

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

Подробности

Route add(Route $route)

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

Параметры

Route $route

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

Route

protected void addToCollections(Route $route)

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

Параметры

Route $route

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

void

protected void addLookups(Route $route)

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

Параметры

Route $route

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

void

protected void addToActionList(array $action, Route $route)

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

Параметры

array $action
Route $route

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

void

void refreshNameLookups()

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

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

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

void

void refreshActionLookups()

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

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

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

void

Route match(Request $request)

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

Параметры

Request $request

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

Route

Исключения

NotFoundHttpException
END_OF_DOCUMENT_MARKER

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

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

Параметры

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

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

Маршрут|null

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

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

Параметры

Запрос $request

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

array

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

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

Параметры

Запрос $request
array $methods

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

Маршрут

Исключения

MethodNotAllowedHttpException

protected void methodNotAllowed(array $others, string $method)

Выбросить исключение HTTP MethodNotAllowed.

Параметры

array $others
string $method

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

void

Исключения

MethodNotAllowedHttpException

array get(string|null $method = null)

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

Параметры

string|null $method

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

array

bool hasNamedRoute(string $name)

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

Параметры

string $name

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

bool

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

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

Параметры

string $name

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

Маршрут|null

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

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

Параметры

string $action

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

Маршрут|null

array getRoutes()

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

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

array

array getRoutesByMethod()

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

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

array

array getRoutesByName()

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

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

array

Итератор массива getIterator()

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

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

Итератор массива

int count()

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

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

int

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

Spec-Zone.ru

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