Class Symfony\Component\Routing\Route


					
	public

__construct(
	string $path,
	array $defaults = [],
	array<string|Stringable> $requirements = [],
	array $options = [],
	string|null $host = '',
	string|string[] $schemes = [],
	string|string[] $methods = [],
	string|null $condition = '',
)

Constructor.

Available options:

compiler_class: A class name able to compile this route instance (RouteCompiler by default)
utf8: Whether UTF-8 matching is enforced or not

Parameters

`$path`	The path pattern to match
`$defaults`	An array of default parameter values
`$requirements`	An array of requirements for parameters (regexes)
`$options`	An array of options
`$host`	The host pattern to match
`$schemes`	A required URI scheme or an array of restricted schemes
`$methods`	A required HTTP method or an array of restricted methods
`$condition`	A condition that should evaluate to true for the route to match

#


					
	public

__serialize(): array

#


					
	public

__unserialize(array $data): void

#


					
	public

getPath(): string

#


					
	public

setPath(string $pattern): $this

#


					
	public

getHost(): string

#


					
	public

setHost(?string $pattern): $this

#


					
	public

getSchemes(): string[]

Returns the lowercased schemes this route is restricted to. So an empty array means that any scheme is allowed.

#


					
	public

setSchemes(string|string[] $schemes): $this

Sets the schemes (e.g. 'https') this route is restricted to. So an empty array means that any scheme is allowed.

Parameters

$schemes

The scheme or an array of schemes

#


					
	public

hasScheme(string $scheme): bool

Checks if a scheme requirement has been set.

#


					
	public

getMethods(): string[]

Returns the uppercased HTTP methods this route is restricted to. So an empty array means that any method is allowed.

#


					
	public

setMethods(string|string[] $methods): $this

Sets the HTTP methods (e.g. 'POST') this route is restricted to. So an empty array means that any method is allowed.

Parameters

$methods

The method or an array of methods

#


					
	public

getOptions(): array

#


					
	public

setOptions(array $options): $this

#


					
	public

addOptions(array $options): $this

#


					
	public

setOption(string $name, mixed $value): $this

Sets an option value.

#


					
	public

getOption(string $name): mixed

Returns the option value or null when not found.

#


					
	public

hasOption(string $name): bool

#


					
	public

getDefaults(): array

#


					
	public

setDefaults(array $defaults): $this

#


					
	public

addDefaults(array $defaults): $this

#


					
	public

getDefault(string $name): mixed

#


					
	public

hasDefault(string $name): bool

#


					
	public

setDefault(string $name, mixed $default): $this

#


					
	public

getRequirements(): array

#


					
	public

setRequirements(array $requirements): $this

#


					
	public

addRequirements(array $requirements): $this

#


					
	public

getRequirement(string $key): ?string

#


					
	public

hasRequirement(string $key): bool

#


					
	public

setRequirement(string $key, string $regex): $this

#


					
	public

getCondition(): string

#


					
	public

setCondition(?string $condition): $this

#


					
	public

compile(): CompiledRoute

Compiles the route.

Throws

LogicException

If the Route cannot be compiled because the path or host pattern is invalid

#

Namespaces

Classes

Class Symfony\Component\Routing\Route

Parameters

Parameters

Parameters

Throws