RouteCollection
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.
Methods
No description
Gets the current RouteCollection as an Iterator that includes all routes.
Gets the number of Routes in this collection.
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.
Adds a prefix to the name of all the routes within in the collection.
Sets the host pattern on all routes.
Sets a condition on all routes.
Adds defaults to all routes.
Adds requirements to all routes.
Adds options to all routes.
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. If the resource already exists it is not added.
Details
ArrayIterator|Route[]
getIterator()
Gets the current RouteCollection as an Iterator that includes all routes.
It implements \IteratorAggregate.
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.
Existing conditions will be overridden.
addDefaults(array $defaults)
Adds defaults to all routes.
An existing default value under the same name in a route will be overridden.
addRequirements(array $requirements)
Adds requirements to all routes.
An existing requirement under the same name in a route will be overridden.
addOptions(array $options)
Adds options to all routes.
An existing option value under the same name in a route will be overridden.
setSchemes(string|string[] $schemes)
Sets the schemes (e.g. 'https') all child routes are restricted to.
setMethods(string|string[] $methods)
Sets the HTTP methods (e.g. 'POST') all child routes are restricted to.
addResource(ResourceInterface $resource)
Adds a resource for this collection. If the resource already exists it is not added.