Class RouteConfig

Base "Route" configuration.

Charcoal\Config\AbstractConfig

Extended by

Charcoal\App\Route\RouteConfig

Direct known subclasses

Charcoal\App\Route\ActionRouteConfig, Charcoal\App\Route\ScriptRouteConfig, Charcoal\App\Route\TemplateRouteConfig

Namespace: Charcoal\App\Route
Located at Charcoal/App/Route/RouteConfig.php

Methods summary
`public Charcoal\App\Route\RouteConfig`	# `setIdent( string $ident )` Set route identifier Set route identifier Parameters `$ident` Route identifier. Returns `Charcoal\App\Route\RouteConfig` Chainable Throws InvalidArgumentException If the identifier is not a string.
`public string`	# `ident( )` Get route identifier Get route identifier Returns string
`public Charcoal\App\Route\RouteConfig`	# `setRoute( string $pattern )` Set route pattern. Set route pattern. Parameters `$pattern` Route pattern. Returns `Charcoal\App\Route\RouteConfig` Chainable Throws InvalidArgumentException If the pattern argument is not a string.
`public string`	# `route( )` Get route pattern Get route pattern Returns string
`public Charcoal\App\Route\RouteConfig`	# `setGroups( array $groups )` Set parent route groups Set parent route groups Parameters `$groups` The parent route groups. Returns `Charcoal\App\Route\RouteConfig` Chainable
`public Charcoal\App\Route\RouteConfig`	# `addGroup( string\|RouteGroup $group )` Add parent route group Add parent route group Parameters `$group` The parent route group. Returns `Charcoal\App\Route\RouteConfig` Chainable Throws InvalidArgumentException If the group is invalid.
`public array`	# `groups( )` Get parent route groups Get parent route groups Returns array
`public Charcoal\App\Route\RouteConfig`	# `setController( string $controller )` Set route view controller classname Set route view controller classname Parameters `$controller` Route controller name. Returns `Charcoal\App\Route\RouteConfig` Chainable Throws InvalidArgumentException If the route view controller is not a string.
`public string`	# `controller( )` Get the view controller classname Get the view controller classname If not set, the `self::ident()` will be used by default. Returns string
`public Charcoal\App\Route\RouteConfig`	# `setMethods( array $methods )` Set route methods Set route methods Parameters `$methods` The route's supported HTTP methods. Returns `Charcoal\App\Route\RouteConfig` Chainable
`public Charcoal\App\Route\RouteConfig`	# `addMethod( string $method )` Add route HTTP method. Add route HTTP method. Parameters `$method` The route's supported HTTP method. Returns `Charcoal\App\Route\RouteConfig` Chainable Throws InvalidArgumentException If the HTTP method is invalid.
`public string[]`	# `methods( )` Get route methods Get route methods Returns string[]