class SymfonyMessageProvider implements MessageProvider (View source)

Implement message localisation using a symfony/translate backend

Traits

A class that can be instantiated or replaced via DI

Provides extensions to this object to integrate it with standard config API methods.

Methods

static Injectable
create(array ...$args)

An implementation of the factory method, allows you to create an instance of a class

static Injectable
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

static Config_ForClass
config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

mixed
stat(string $name) deprecated

Get inherited config value

mixed
uninherited(string $name)

Gets the uninherited value for the given config option

$this
set_stat(string $name, mixed $value) deprecated

Update the config value for a given property

Translator
getTranslator()

No description

$this
setTranslator(Translator $translator)

No description

string
translate(string $entity, string $default, array $injection)

Localise this message

string
pluralise(string $entity, array|string $default, array $injection, int $count)

Pluralise a message

array
getSourceDirs()

Get the list of /lang dirs to load localisations from

$this
setSourceDirs(array $sourceDirs)

Set the list of /lang dirs to load localisations from

Details

static Injectable create(array ...$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();

Parameters

array ...$args

Return Value

Injectable

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).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

static Config_ForClass config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

Return Value

Config_ForClass

mixed stat(string $name) deprecated

deprecated 5.0 Use ->config()->get() instead

Get inherited config value

Parameters

string $name

Return Value

mixed

mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

$this set_stat(string $name, mixed $value) deprecated

deprecated 5.0 Use ->config()->set() instead

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

Translator getTranslator()

Return Value

Translator

$this setTranslator(Translator $translator)

Parameters

Translator $translator

Return Value

$this

string translate(string $entity, string $default, array $injection)

Localise this message

Parameters

string $entity

Identifier for this message in Namespace.key format

string $default

Default message

array $injection

List of injection variables

Return Value

string

Localised string

string pluralise(string $entity, array|string $default, array $injection, int $count)

Pluralise a message

Parameters

string $entity

Identifier for this message in Namespace.key format

array|string $default

Default message with pipe-separated delimiters, or array

array $injection

List of injection variables

int $count

Number to pluralise against

Return Value

string

Localised string

array getSourceDirs()

Get the list of /lang dirs to load localisations from

Return Value

array

$this setSourceDirs(array $sourceDirs)

Set the list of /lang dirs to load localisations from

Parameters

array $sourceDirs

Return Value

$this