Spec-Zone.ru › Laravel 5.8

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

класс RouteCollection реализует Countable, IteratorAggregate (Просмотреть исходный код)

Свойства

защищённый массив $routes Массив маршрутов, индексированный методом.
защищённый массив $allRoutes Распакованный массив всех маршрутов.
защищённый массив $nameList Таблица поиска маршрутов по имени.
защищённый массив $actionList Таблица поиска маршрутов по действию контроллера.

Методы

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

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

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

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

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

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

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

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

void refreshNameLookups()

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

void refreshActionLookups()

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

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

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

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

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

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

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

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

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

void methodNotAllowed(array $others, string $method)

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

массив get(string|null $method = null)

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

bool hasNamedRoute(string $name)

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

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

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

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

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

массив getRoutes()

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

массив getRoutesByMethod()

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

массив getRoutesByName()

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

ArrayIterator getIterator()

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

int count()

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

Подробности

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

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

Параметры

Маршрут $route

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

Маршрут

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

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

Параметры

Маршрут $route

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

void

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

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

Параметры

Маршрут $route

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

void

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

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

Параметры

массив $action
Маршрут $route

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

void

void refreshNameLookups()

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

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

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

void

void refreshActionLookups()

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

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

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

void

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

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

Параметры

Запрос $request

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

Маршрут

Исключения

NotFoundHttpException

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, запрещающее метод.

Параметры

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/5.8/Illuminate/Routing/RouteCollection.html

Spec-Zone.ru

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