Spec-Zone.ru › Laravel 5.2

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

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

Свойства

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

Методы

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

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

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

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

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

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

void refreshNameLookups()

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

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

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

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

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

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

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

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

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

void methodNotAllowed(массив $others)

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

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

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

массив get(строка|null $method = null)

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

bool hasNamedRoute(строка $name)

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

Маршрут|null getByName(строка $name)

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

Маршрут|null getByAction(строка $action)

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

массив getRoutes()

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

массив getRoutesByMethod()

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

ArrayIterator getIterator()

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

целое count()

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

ПодробноеОписание

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

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

Параметры

Маршрут $route

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

Маршрут

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

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

Параметры

Маршрут $route

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

void

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

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

Параметры

Маршрут $route

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

void

void refreshNameLookups()

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

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

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

void

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

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

Параметры

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

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

void

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

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

Параметры

Запрос $request

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

Маршрут

Исключения

NotFoundHttpException

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

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

Параметры

Запрос $request

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

массив

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

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

Параметры

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

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

Маршрут

Исключения

MethodNotAllowedHttpException

protected void methodNotAllowed(array $others)

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

Параметры

array $others

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

void

Исключения

MethodNotAllowedHttpException

protected Route|null check(array $routes, Request $request, bool $includingMethod = true)

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

Параметры

array $routes
Request $request
bool $includingMethod

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

Route|null

array get(string|null $method = null)

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

Параметры

string|null $method

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

array

bool hasNamedRoute(string $name)

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

Параметры

string $name

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

bool

Route|null getByName(string $name)

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

Параметры

string $name

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

Route|null

Route|null getByAction(string $action)

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

Параметры

string $action

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

Route|null

array getRoutes()

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

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

array

array getRoutesByMethod()

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

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

array

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

Spec-Zone.ru

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