Spec-Zone.ru › Laravel 5.4

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

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

Свойства

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

Методы

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

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

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

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

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

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

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

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

void refreshNameLookups()

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

void refreshActionLookups()

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

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

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

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

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

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

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

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

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

void methodNotAllowed(array $others)

Выбросить исключение 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 в коллекцию.

Параметры

Маршрут $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 $request, bool $includingMethod = true)

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

Параметры

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

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

Маршрут|null
END_OF_DOCUMENT_MARKER

protected array checkForAlternateVerbs(Request $request)

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

Parameters

Request $request

Return Value

array

protected Route getRouteForMethods(Request $request, array $methods)

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

Parameters

Request $request
array $methods

Return Value

Route

Exceptions

MethodNotAllowedHttpException

protected void methodNotAllowed(array $others)

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

Parameters

array $others

Return Value

void

Exceptions

MethodNotAllowedHttpException

array get(string|null $method = null)

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

Parameters

string|null $method

Return Value

array

bool hasNamedRoute(string $name)

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

Parameters

string $name

Return Value

bool

Route|null getByName(string $name)

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

Parameters

string $name

Return Value

Route|null

Route|null getByAction(string $action)

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

Parameters

string $action

Return Value

Route|null

array getRoutes()

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

Return Value

array

array getRoutesByMethod()

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

Return Value

array

array getRoutesByName()

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

Return Value

array

ArrayIterator getIterator()

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

Return Value

ArrayIterator

int count()

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

Return Value

int

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

Spec-Zone.ru

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