RoutingConfigurator
in package
Uses
AddTrait
Tags
Table of Contents
- $collection : RouteCollection
- $name : mixed
- $prefixes : mixed
- $env : mixed
- $file : mixed
- $loader : mixed
- $path : mixed
- __construct() : mixed
- __invoke() : RouteConfigurator
- Adds a route.
- add() : RouteConfigurator
- Adds a route.
- alias() : AliasConfigurator
- collection() : CollectionConfigurator
- env() : string|null
- Get the current environment to be able to write conditional configuration.
- import() : ImportConfigurator
- withPath() : static
Properties
$collection
protected
RouteCollection
$collection
$name
protected
mixed
$name
= ''
$prefixes
protected
mixed
$prefixes
$env
private
mixed
$env
$file
private
mixed
$file
$loader
private
mixed
$loader
$path
private
mixed
$path
Methods
__construct()
public
__construct(RouteCollection $collection, PhpFileLoader $loader, string $path, string $file[, string|null $env = null ]) : mixed
Parameters
- $collection : RouteCollection
- $loader : PhpFileLoader
- $path : string
- $file : string
- $env : string|null = null
Return values
mixed —__invoke()
Adds a route.
public
__invoke(string $name, string|array<string|int, mixed> $path) : RouteConfigurator
Parameters
- $name : string
- $path : string|array<string|int, mixed>
-
the path, or the localized paths of the route
Return values
RouteConfigurator —add()
Adds a route.
public
add(string $name, string|array<string|int, mixed> $path) : RouteConfigurator
Parameters
- $name : string
- $path : string|array<string|int, mixed>
-
the path, or the localized paths of the route
Return values
RouteConfigurator —alias()
public
alias(string $name, string $alias) : AliasConfigurator
Parameters
- $name : string
- $alias : string
Return values
AliasConfigurator —collection()
public
final collection([string $name = '' ]) : CollectionConfigurator
Parameters
- $name : string = ''
Return values
CollectionConfigurator —env()
Get the current environment to be able to write conditional configuration.
public
final env() : string|null
Return values
string|null —import()
public
final import(mixed $resource[, string|null $type = null ][, bool $ignoreErrors = false ][, string|array<string|int, string>|null $exclude = null ]) : ImportConfigurator
Parameters
- $resource : mixed
- $type : string|null = null
- $ignoreErrors : bool = false
- $exclude : string|array<string|int, string>|null = null
-
Glob patterns to exclude from the import
Return values
ImportConfigurator —withPath()
public
final withPath(string $path) : static
Parameters
- $path : string