Symfony\Component\Routing\Route

class Route implements Serializable

Methods

	__construct(string $path, array $defaults = array(), array $requirements = array(), array $options = array(), string $host = '', string|array $schemes = array(), string|array $methods = array(), string $condition = '') Constructor.
	serialize() {@inheritdoc}
	unserialize($serialized) {@inheritdoc}
string	getPath() Returns the pattern for the path.
Route	setPath(string $pattern) Sets the pattern for the path.
string	getHost() Returns the pattern for the host.
Route	setHost(string $pattern) Sets the pattern for the host.
array	getSchemes() Returns the lowercased schemes this route is restricted to.
Route	setSchemes(string|array $schemes) Sets the schemes (e.g.
bool	hasScheme(string $scheme) Checks if a scheme requirement has been set.
array	getMethods() Returns the uppercased HTTP methods this route is restricted to.
Route	setMethods(string|array $methods) Sets the HTTP methods (e.g.
array	getOptions() Returns the options.
Route	setOptions(array $options) Sets the options.
Route	addOptions(array $options) Adds options.
Route	setOption(string $name, mixed $value) Sets an option value.
mixed	getOption(string $name) Get an option value.
bool	hasOption(string $name) Checks if an option has been set.
array	getDefaults() Returns the defaults.
Route	setDefaults(array $defaults) Sets the defaults.
Route	addDefaults(array $defaults) Adds defaults.
mixed	getDefault(string $name) Gets a default value.
bool	hasDefault(string $name) Checks if a default value is set for the given variable.
Route	setDefault(string $name, mixed $default) Sets a default value.
array	getRequirements() Returns the requirements.
Route	setRequirements(array $requirements) Sets the requirements.
Route	addRequirements(array $requirements) Adds requirements.
string|null	getRequirement(string $key) Returns the requirement for the given key.
bool	hasRequirement(string $key) Checks if a requirement is set for the given key.
Route	setRequirement(string $key, string $regex) Sets a requirement for the given key.
string	getCondition() Returns the condition.
Route	setCondition(string $condition) Sets the condition.
CompiledRoute	compile() Compiles the route.

Details

public __construct(string $path, array $defaults = array(), array $requirements = array(), array $options = array(), string $host = '', string|array $schemes = array(), string|array $methods = array(), string $condition = '')

Constructor.

Available options:

• compiler_class: A class name able to compile this route instance (RouteCompiler by default)

public serialize()

{@inheritdoc}

public unserialize($serialized)

{@inheritdoc}

public string getPath()

Returns the pattern for the path.

public Route setPath(string $pattern)

Sets the pattern for the path.

This method implements a fluent interface.

public string getHost()

Returns the pattern for the host.

public Route setHost(string $pattern)

Sets the pattern for the host.

This method implements a fluent interface.

public array getSchemes()

Returns the lowercased schemes this route is restricted to.

So an empty array means that any scheme is allowed.

public Route setSchemes(string|array $schemes)

Sets the schemes (e.g.

'https') this route is restricted to. So an empty array means that any scheme is allowed.

This method implements a fluent interface.

public bool hasScheme(string $scheme)

Checks if a scheme requirement has been set.

public array getMethods()

Returns the uppercased HTTP methods this route is restricted to.

So an empty array means that any method is allowed.

public Route setMethods(string|array $methods)

Sets the HTTP methods (e.g.

'POST') this route is restricted to. So an empty array means that any method is allowed.

This method implements a fluent interface.

public array getOptions()

Returns the options.

public Route setOptions(array $options)

Sets the options.

This method implements a fluent interface.

public Route addOptions(array $options)

Adds options.

This method implements a fluent interface.

public Route setOption(string $name, mixed $value)

Sets an option value.

This method implements a fluent interface.

public mixed getOption(string $name)

Get an option value.

public bool hasOption(string $name)

Checks if an option has been set.

public array getDefaults()

Returns the defaults.

public Route setDefaults(array $defaults)

Sets the defaults.

This method implements a fluent interface.

public Route addDefaults(array $defaults)

Adds defaults.

This method implements a fluent interface.

public mixed getDefault(string $name)

Gets a default value.

public bool hasDefault(string $name)

Checks if a default value is set for the given variable.

public Route setDefault(string $name, mixed $default)

Sets a default value.

public array getRequirements()

Returns the requirements.

public Route setRequirements(array $requirements)

Sets the requirements.

This method implements a fluent interface.

public Route addRequirements(array $requirements)

Adds requirements.

This method implements a fluent interface.

public string|null getRequirement(string $key)

Returns the requirement for the given key.

public bool hasRequirement(string $key)

Checks if a requirement is set for the given key.

public Route setRequirement(string $key, string $regex)

Sets a requirement for the given key.

public string getCondition()

Returns the condition.

public Route setCondition(string $condition)

Sets the condition.

This method implements a fluent interface.

public CompiledRoute compile()

Compiles the route.