Spec-Zone.ru › Laravel 5.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)

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

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

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

Параметры

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

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

Маршрут|null

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

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

Параметры

Запрос $request

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

массив

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

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

Параметры

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

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

Маршрут

Исключения

MethodNotAllowedHttpException

protected void methodNotAllowed(array $others)

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

Параметры

массив $others

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

void

Исключения

MethodNotAllowedHttpException

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

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

Параметры

string|null $method

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

массив

bool hasNamedRoute(string $name)

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

Параметры

строка $name

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

bool

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

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

Параметры

строка $name

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

Маршрут|null

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

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

Параметры

строка $action

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

Маршрут|null

массив getRoutes()

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

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

массив

массив getRoutesByMethod()

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

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

массив

массив getRoutesByName()

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

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

массив

ArrayIterator getIterator()

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

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

ArrayIterator

int count()

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

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

int

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

Spec-Zone.ru

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