RouteCollection
class RouteCollection implements IteratorAggregate, Countable
RouteCollection представляет собой набор экземпляров Route.
При добавлении маршрута в конец коллекции, существующий маршрут с таким же именем сначала удаляется. Таким образом, может быть только один маршрут с заданным именем.
Методы
| __clone() | ||
| ArrayIterator|Route[] | getIterator() Возвращает текущую RouteCollection в виде итератора, включающего все маршруты. | |
| int | count() Возвращает количество маршрутов в этой коллекции. | |
| add(string $name, Route $route) Добавляет маршрут. | ||
| Route[] | all() Возвращает все маршруты в этой коллекции. | |
| Route|null | get(string $name) Возвращает маршрут по имени. | |
| remove(string|string[] $name) Удаляет маршрут или массив маршрутов по имени из коллекции. | ||
| addCollection(RouteCollection $collection) Добавляет коллекцию маршрутов в конец текущего набора, добавляя все маршруты добавленной коллекции. | ||
| addPrefix(string $prefix, array $defaults = array(), array $requirements = array()) Добавляет префикс к пути всех дочерних маршрутов. | ||
| setHost(string $pattern, array $defaults = array(), array $requirements = array()) Устанавливает шаблон хоста для всех маршрутов. | ||
| setCondition(string $condition) Устанавливает условие для всех маршрутов. | ||
| addDefaults(array $defaults) Добавляет значения по умолчанию для всех маршрутов. | ||
| addRequirements(array $requirements) Добавляет требования для всех маршрутов. | ||
| addOptions(array $options) Добавляет параметры для всех маршрутов. | ||
| setSchemes(string|string[] $schemes) Устанавливает схемы (например, 'https'), к которым ограничены все дочерние маршруты. | ||
| setMethods(string|string[] $methods) Устанавливает HTTP-методы (например, 'POST'), к которым ограничены все дочерние маршруты. | ||
| ResourceInterface[] | getResources() Возвращает массив загруженных ресурсов для построения этой коллекции. | |
| addResource(ResourceInterface $resource) Добавляет ресурс для этой коллекции. Если ресурс уже существует, он не добавляется. |
Подробное описание
__clone()
ArrayIterator|Route[] getIterator()
Возвращает текущую RouteCollection в виде итератора, включающего все маршруты.
Реализует \IteratorAggregate.
Значение результата
| ArrayIterator|Route[] | Объект \ArrayIterator для итерации по маршрутам |
См. также
| all() |
int count()
Возвращает количество маршрутов в этой коллекции.
Значение результата
| int | Количество маршрутов |
add(string $name, Route $route)
Добавляет маршрут.
Параметры
| string | $name | Имя маршрута |
| Route | $route | Экземпляр Route |
Route[] all()
Возвращает все маршруты в этой коллекции.
Значение результата
| Route[] | Массив маршрутов |
Route|null get(string $name)
Возвращает маршрут по имени.
Параметры
| string | $name | Имя маршрута |
Значение результата
| Route|null | Экземпляр Route или null, если не найден |
remove(string|string[] $name)
Удаляет маршрут или массив маршрутов по имени из коллекции.
Параметры
| string|string[] | $name | Имя маршрута или массив имён маршрутов |
addCollection(RouteCollection $collection)
Добавляет коллекцию маршрутов в конец текущего набора, добавляя все маршруты добавленной коллекции.
Параметры
| RouteCollection | $collection |
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|string[] $schemes)
Устанавливает схемы (например, 'https'), к которым ограничены все дочерние маршруты.
Параметры
| string|string[] | $schemes | Схема или массив схем |
setMethods(string|string[] $methods)
Устанавливает HTTP-методы (например, 'POST'), к которым ограничены все дочерние маршруты.
Параметры
| string|string[] | $methods | Метод или массив методов |
ResourceInterface[] getResources()
Возвращает массив загруженных ресурсов для построения этой коллекции.
Значение результата
| ResourceInterface[] | Массив ресурсов |
addResource(ResourceInterface $resource)
Добавляет ресурс для этой коллекции. Если ресурс уже существует, он не добавляется.
Параметры
| ResourceInterface | $resource |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.4/Symfony/Component/Routing/RouteCollection.html
