1. class
  2. SilverStripe
  3. \
  4. i18n
  5. \
  6. Messages
  7. \
  8. Symfony
  9. \
  10. SymfonyMessageProvider

SymfonyMessageProvider

class SymfonyMessageProvider implements MessageProvider

Implement message localisation using a symfony/translate backend

Traits

Injectable
A class that can be instantiated or replaced via DI
Configurable
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

from Injectable
static Injectable
singleton(string $class = null)

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

from Injectable
static Config_ForClass
config()

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

from Configurable
mixed
stat(string $name) deprecated

Get inherited config value

from Configurable
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

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

Update the config value for a given property

from Configurable
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

in Injectable at line 26
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'); $list = SiteTree::get();

Parameters

array $args

Return Value

Injectable

in Injectable at line 43
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

in Configurable at line 20
static Config_ForClass config()

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

....).

Return Value

Config_ForClass

in Configurable at line 32
mixed stat(string $name) deprecated

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

Get inherited config value

Parameters

string $name

Return Value

mixed

in Configurable at line 44
mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

in Configurable at line 57
$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

at line 41
Translator getTranslator()

Return Value

Translator

at line 50
$this setTranslator(Translator $translator)

Parameters

Translator $translator

Return Value

$this

at line 87
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

at line 107
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

at line 139
array getSourceDirs()

Get the list of /lang dirs to load localisations from

Return Value

array

at line 153
$this setSourceDirs(array $sourceDirs)

Set the list of /lang dirs to load localisations from

Parameters

array $sourceDirs

Return Value

$this