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

__clone()

ArrayIterator|Маршрут[] getIterator()

Возвращает текущую коллекцию маршрутов как итератор, содержащий все маршруты.

Реализует \IteratorAggregate.

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

ArrayIterator|Маршрут[]

Объект \ArrayIterator для итерирования по маршрутам

См. также

all()

int count()

Возвращает количество маршрутов в этой коллекции.

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

int	Количество маршрутов

add(string $name, Маршрут $route)

Добавляет маршрут.

Параметры

string	$name	Имя маршрута
Маршрут	$route	Экземпляр Route

Маршрут[] all()

Возвращает все маршруты в этой коллекции.

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

Маршрут[]

Массив маршрутов

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

Возвращает маршрут по имени.

Параметры

string

$name

Имя маршрута

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

Маршрут|null

Экземпляр Route или null, если не найден

remove(string|array $name)

Удаляет маршрут или массив маршрутов по имени из коллекции.

Параметры

string|array

$name

Имя маршрута или массив имён маршрутов

addCollection(RouteCollection $collection)

Добавляет коллекцию маршрутов в конец текущего набора, добавляя все маршруты добавленной коллекции.

Параметры

RouteCollection

$collection

Экземпляр RouteCollection

addPrefix(string $prefix, array $defaults = array(), array $requirements = array())

Добавляет префикс к пути всех дочерних маршрутов.

Параметры

string	$prefix	Необязательный префикс, добавляемый перед каждым шаблоном маршрута в коллекции
array	$defaults	Массив значений по умолчанию
array	$requirements	Массив требований

setHost(string $pattern, array $defaults = array(), array $requirements = array())

Устанавливает шаблон хоста для всех маршрутов.

Параметры

string	$pattern	Шаблон
array	$defaults	Массив значений по умолчанию
array	$requirements	Массив требований

setCondition(string $condition)

Устанавливает условие для всех маршрутов.

Существующие условия будут перезаписаны.

Параметры

string

$condition

Условие

addDefaults(array $defaults)

Добавляет значения по умолчанию для всех маршрутов.

Существующее значение по умолчанию с тем же именем в маршруте будет перезаписано.

Параметры

array

$defaults

Массив значений по умолчанию

addRequirements(array $requirements)

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

Существующее требование с тем же именем в маршруте будет перезаписано.

Параметры

array

$requirements

Массив требований

addOptions(array $options)

Добавляет параметры для всех маршрутов.

Существующее значение параметра с тем же именем в маршруте будет перезаписано.

Параметры

array

$options

Массив параметров

setSchemes(string|array $schemes)

Устанавливает схемы (например, 'https'), к которым ограничены все дочерние маршруты.

Параметры

string|array

$schemes

Схема или массив схем

setMethods(string|array $methods)

Устанавливает HTTP-методы (например, 'POST'), к которым ограничены все дочерние маршруты.

Параметры

string|array

$methods

Метод или массив методов

Интерфейс ресурса[] getResources()

Возвращает массив загруженных ресурсов для построения этой коллекции.

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

Интерфейс ресурса[]

Массив ресурсов

addResource(Интерфейс ресурса $resource)

Добавляет ресурс для этой коллекции.

Параметры

Интерфейс ресурса

$resource

Экземпляр ресурса