class RouteCollection implements IteratorAggregate, Countable
A RouteCollection represents a set of Route instances.
When adding a route at the end of the collection, an existing route with the same name is removed first. So there can only be one route with a given name.
| __clone() | ||
| ArrayIterator | getIterator() Gets the current RouteCollection as an Iterator that includes all routes. | |
| int | count() Gets the number of Routes in this collection. | |
| add(string $name, Route $route) Adds a route. | ||
| Route[] | all() Returns all routes in this collection. | |
| Route|null | get(string $name) Gets a route by name. | |
| remove(string|array $name) Removes a route or an array of routes by name from the collection. | ||
| addCollection(RouteCollection $collection) Adds a route collection at the end of the current set by appending all routes of the added collection. | ||
| addPrefix(string $prefix, array $defaults = array(), array $requirements = array()) Adds a prefix to the path of all child routes. | ||
| setHost(string $pattern, array $defaults = array(), array $requirements = array()) Sets the host pattern on all routes. | ||
| setCondition(string $condition) Sets a condition on all routes. | ||
| addDefaults(array $defaults) Adds defaults to all routes. | ||
| addRequirements(array $requirements) Adds requirements to all routes. | ||
| addOptions(array $options) Adds options to all routes. | ||
| setSchemes(string|array $schemes) Sets the schemes (e.g. | ||
| setMethods(string|array $methods) Sets the HTTP methods (e.g. | ||
| ResourceInterface[] | getResources() Returns an array of resources loaded to build this collection. | |
| addResource(ResourceInterface $resource) Adds a resource for this collection. |
Gets the current RouteCollection as an Iterator that includes all routes.
It implements \IteratorAggregate.
Gets the number of Routes in this collection.
Adds a route.
Returns all routes in this collection.
Gets a route by name.
Removes a route or an array of routes by name from the collection.
Adds a route collection at the end of the current set by appending all routes of the added collection.
Adds a prefix to the path of all child routes.
Sets the host pattern on all routes.
Sets a condition on all routes.
Existing conditions will be overridden.
Adds defaults to all routes.
An existing default value under the same name in a route will be overridden.
Adds requirements to all routes.
An existing requirement under the same name in a route will be overridden.
Adds options to all routes.
An existing option value under the same name in a route will be overridden.
Sets the schemes (e.g.
'https') all child routes are restricted to.
Sets the HTTP methods (e.g.
'POST') all child routes are restricted to.
Returns an array of resources loaded to build this collection.
Adds a resource for this collection.
© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Routing/RouteCollection.html