class Sources implements Resettable (View source)

Data sources for localisation strings. I.e. yml files stored within the /lang folder in any installed module.

Traits

A class that can be instantiated or replaced via DI

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

Config options

module_priority array

List of prioritised modules, in lowest to highest priority.

Properties

protected static array $cache_lang_dirs

Cache of found lang dirs

protected static array $cache_lang_files

Cache of found lang files

Methods

public static 
create(mixed ...$args)

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

public static 
singleton(string $class = null)

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

public static 
config()

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

public
mixed
stat(string $name) deprecated

Get inherited config value

public
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

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

Update the config value for a given property

public
array
getSortedModules()

Get sorted modules

public
array
getLangDirs()

Find the list of prioritised /lang folders in this application

protected
array
getLangFiles()

Search directories for list of distinct locale filenames

public
array
getKnownLocales()

Searches the root-directory for module-directories (identified by having a _config.php on their first directory-level).

public static 
reset()

Reset the local cache of this object

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();

Parameters

mixed ...$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

array getSortedModules()

Get sorted modules

Return Value

array

Array of module names -> path

array getLangDirs()

Find the list of prioritised /lang folders in this application

Return Value

array

protected array getLangFiles()

Search directories for list of distinct locale filenames

Return Value

array

Map of locale key => key of all distinct localisation file names

array getKnownLocales()

Searches the root-directory for module-directories (identified by having a _config.php on their first directory-level).

Finds locales by filename convention (".", e.g. "de_AT.yml").

Return Value

array

Map of locale codes to names (localised)

static reset()

Reset the local cache of this object