FluentState
class FluentState (View source)
Stores the current fluent state
Traits
A class that can be instantiated or replaced via DI
Properties
| protected | string | $locale | Current locale |
|
| protected | string|null | $domain | Current domain, if set |
|
| protected | bool | $isDomainMode | Whether the website is running in domain segmentation mode |
|
| protected | bool | $isFrontend | Whether the request is for the frontend website |
Methods
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Set whether the website is in domain segmentation mode
Set whether a request is for the frontend website or not
Details
static Injectable
create(mixed ...$args)
An implementation of the factory method, allows you to create an instance of a class
This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.
This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();
static Injectable
singleton(string $class = null)
Creates a class instance by the "singleton" design pattern.
It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).
string
getLocale()
Get the currently active locale code
$this
setLocale(string $locale)
Set the currently active locale code
string|null
getDomain()
Get the current domain code
$this
setDomain(string|null $domain)
Set the current domain code
bool
getIsDomainMode()
Get whether the website is in domain segmentation mode
$this
setIsDomainMode(bool $isDomainMode)
Set whether the website is in domain segmentation mode
bool
getIsFrontend()
Get whether a request is for the frontend website or not
$this
setIsFrontend(bool $isFrontend)
Set whether a request is for the frontend website or not
mixed
withState(callable $callback)
Perform the given operation in an isolated state.
On return, the state will be restored, so any modifications are temporary.