1. class
  2. Symfony
  3. \
  4. Component
  5. \
  6. Routing
  7. \
  8. Loader
  9. \
  10. Configurator
  11. \
  12. CollectionConfigurator

CollectionConfigurator

class CollectionConfigurator

Traits

AddTrait
RouteTrait

Methods

RouteConfigurator
add(string $name, $path)

Adds a route.

from AddTrait
RouteConfigurator
__invoke(string $name, $path)

Adds a route.

from AddTrait
$this
defaults(array $defaults)

Adds defaults.

from RouteTrait
$this
requirements(array $requirements)

Adds requirements.

from RouteTrait
$this
options(array $options)

Adds options.

from RouteTrait
$this
condition(string $condition)

Sets the condition.

from RouteTrait
$this
host(string $pattern)

Sets the pattern for the host.

from RouteTrait
$this
schemes(array $schemes)

Sets the schemes (e.g. 'https') this route is restricted to.

from RouteTrait
$this
methods(array $methods)

Sets the HTTP methods (e.g. 'POST') this route is restricted to.

from RouteTrait
$this
controller(callable|string $controller)

Adds the "_controller" entry to defaults.

from RouteTrait
__construct(RouteCollection $parent, string $name, CollectionConfigurator $parentConfigurator = null, array $parentPrefixes = null)

No description

__destruct()

No description

CollectionConfigurator
collection($name = '')

Creates a sub-collection.

$this
prefix(string|array $prefix)

Sets the prefix to add to the path of all child routes.

Details

final RouteConfigurator add(string $name, $path)

Adds a route.

Parameters

string $name
$path

Return Value

RouteConfigurator

final RouteConfigurator __invoke(string $name, $path)

Adds a route.

Parameters

string $name
$path

Return Value

RouteConfigurator

final $this defaults(array $defaults)

Adds defaults.

Parameters

array $defaults

Return Value

$this

final $this requirements(array $requirements)

Adds requirements.

Parameters

array $requirements

Return Value

$this

final $this options(array $options)

Adds options.

Parameters

array $options

Return Value

$this

final $this condition(string $condition)

Sets the condition.

Parameters

string $condition

Return Value

$this

final $this host(string $pattern)

Sets the pattern for the host.

Parameters

string $pattern

Return Value

$this

final $this schemes(array $schemes)

Sets the schemes (e.g. 'https') this route is restricted to.

So an empty array means that any scheme is allowed.

Parameters

array $schemes

Return Value

$this

final $this methods(array $methods)

Sets the HTTP methods (e.g. 'POST') this route is restricted to.

So an empty array means that any method is allowed.

Parameters

array $methods

Return Value

$this

final $this controller(callable|string $controller)

Adds the "_controller" entry to defaults.

Parameters

callable|string $controller a callable or parseable pseudo-callable

Return Value

$this

__construct(RouteCollection $parent, string $name, CollectionConfigurator $parentConfigurator = null, array $parentPrefixes = null)

Parameters

RouteCollection $parent
string $name
CollectionConfigurator $parentConfigurator
array $parentPrefixes

__destruct()

final CollectionConfigurator collection($name = '')

Creates a sub-collection.

Parameters

$name

Return Value

CollectionConfigurator

final $this prefix(string|array $prefix)

Sets the prefix to add to the path of all child routes.

Parameters

string|array $prefix the prefix, or the localized prefixes

Return Value

$this