i18n

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

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

This method first for strong class overloads (singletons & DB interaction), then custom class overloads. If an overload is found, an instance of this is returned rather than the original class. To overload a class, use {@link Object::useCustomClass()}

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

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

Create an object from a string representation. It treats it as a PHP constructor without the 'new' keyword. It also manages to construct the object without the use of eval().

Construction itself is done with Object::create(), so that Object::useCustomClass() calls are respected.

Object::create_from_string("Versioned('Stage','Live')") will return the result of Versioned::create('Stage', 'Live);

It is designed for simple, clonable objects. The first time this method is called for a given string it is cached, and clones of that object are returned.

If you pass the $firstArg argument, this will be prepended to the constructor arguments. It's impossible to pass null as the firstArg argument.

Object::create_from_string("Varchar(50)", "MyField") will return the result of Vachar::create('MyField', '50');

Arguments are always strings, although this is a quirk of the current implementation rather than something that can be relied upon.

Parses a class-spec, such as "Versioned('Stage','Live')", as passed to create_from_string().

Returns a 2-elemnent array, with classname and arguments

Similar to {@link Object::create()}, except that classes are only overloaded if you set the $strong parameter to TRUE when using {@link Object::useCustomClass()}

This class allows you to overload classes with other classes when they are constructed using the factory method {@link Object::create()}

If a class has been overloaded, get the class name it has been overloaded with - otherwise return the class name

Get the value of a static property of a class, even in that property is declared protected (but not private), without any inheritance, merging or parent lookup if it doesn't exist on the given class.

Return TRUE if a class has a specified extension.

This supports backwards-compatible format (static Object::has_extension($requiredExtension)) and new format ($object->has_extension($class, $requiredExtension))

Add an extension to a specific class.

The preferred method for adding extensions is through YAML config, since it avoids autoloading the class, and is easier to override in more specific configurations.

As an alternative, extensions can be added to a specific class directly in the {@link Object::$extensions} array. See {@link SiteTree::$extensions} for examples. Keep in mind that the extension will only be applied to new instances, not existing ones (including all instances created through {@link singleton()}).

Remove an extension from a class.

Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any {@link Object} instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through {@link singleton()} to avoid side-effects from stale extension information.

Attemps to locate and call a method dynamically added to a class at runtime if a default cannot be located

You can add extra methods to a class using {@link Extensions}, {@link Object::createMethod()} or {@link Object::addWrapperMethod()}

Return TRUE if a method exists on this object

This should be used rather than PHP's inbuild method_exists() as it takes into account methods added via extensions

Return the names of all the methods available on this object

Return true if this object "exists" i.e. has a sensible value

This method should be overriden in subclasses to provide more context about the classes state. For example, a {@link DataObject} class could return false when it is deleted from the database

Check if this class is an instance of a specific class, or has that class as one of its parents

Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array

Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed

Currently returns an array, with an index resulting every time the function is called. Only adds returns if they're not NULL, to avoid bogus results from methods just defined on the parent extension. This is important for permission-checks through extend, as they use min() to determine if any of the returns is FALSE. As min() doesn't do type checking, an included NULL return would fail the permission checks.

The extension methods are defined during {@link __construct()} in {@link defineMethods()}.

Get an extension instance attached to this object by name.

Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.

Caution: Don't use singleton()->hasExtension() as it will give you inconsistent results based on when the singleton was first accessed.

Get all extension instances for this specific object instance.

See {@link get_extensions()} to get all applied extension classes for this class (not the instance).

Cache the results of an instance method in this object to a file, or if it is already cache return the cached results

Clears the cache for the given cacheToFile call

Triggered early in the request when someone requests a flush.

Return an instance of the cache used for i18n data.

Use javascript i18n through the ss.i18n class (enabled by default).

If set to TRUE, includes javascript requirements for the base library (framework/javascript/i18n.js) and all necessary lang files (e.g. framework/lang/de_DE.js) plus fallbacks to the default locale (e.g. framework/lang/en_US.js). If set to FALSE, only includes a stub implementation which is necessary. Mainly disabled to save bandwidth in a frontend context when website is in single language.

Caution: This flag gets overwritten in {@link LeftAndMain::init()} to enforce javascript i18n for the CMS interfaces.

This is the main translator function. Returns the string defined by $class and $entity according to the currently set locale.

Get a list of commonly used languages

Get a list of commonly used locales

Get a list of locales (code => language and country)

Matches a given locale with the closest translation available in the system

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

Get a name from a language code (two characters, e.g. "en").

Get a name from a locale code (xx_YY).

Get a code from an English language name

Get the current tinyMCE language

Searches the root-directory for module-directories (identified by having a _config.php on their first directory-level and a language-file with the default locale in the /lang-subdirectory).

Returns the "short" language name from a locale, e.g. "en_US" would return "en".

Provides you "likely locales" for a given "short" language code. This is a guess, as we can't disambiguate from e.g. "en" to "en_US" - it could also mean "en_UK". Based on the Unicode CLDR project.

Gets a RFC 1766 compatible language code, e.g. "en-US".

Given a PHP class name, finds the module where it's located.

Validates a "long" locale format (e.g. "en_US") by checking it against {@link $all_locales}.

To add a locale to {@link $all_locales}, use the following example in your mysite/_config.php: i18n::$allowed_locales['xx_XX'] = '';

Note: Does not check for {@link $allowed_locales}.

Set the current locale, used as the default for any localized classes, such as {@link FormField} or {@link DBField} instances. Locales can also be persisted in {@link Member->Locale}, for example in the {@link CMSMain} interface the Member locale overrules the global locale value set here.

Get the current locale.

Used by {@link Member::populateDefaults()}

This is the "fallback locale", in case resources with the "current locale" (set through {@link set_locale()}) can't be found.

If you just want to globally read/write a different locale (e.g. in a CMS interface), please use {@link get_locale()} and {@link set_locale()} instead.

For example, {@link Requirements::add_i18n_javascript()} and {@link i18n::include_by_class()} use this "fallback locale" value to include fallback language files.

See {@link default_locale()} for usage.

Returns the script direction in format compatible with the HTML "dir" attribute.

Includes all available language files for a certain defined locale.

Given a class name (a "locale namespace"), will search for its module and, if available, will load the resources for the currently defined locale.

If not available, the original English resource will be loaded instead (to avoid blanks)

Called by SSViewer to get a list of global variables to expose to the template, the static method to call on this class to get the value for those variables, and the class to use for casting the returned value for use in a template

If the method to call is not included for a particular template variable, a method named the same as the template variable will be called

If the casting class is not specified for a particular template variable, ViewableData::$default_cast is used

The first letter of the template variable is case-insensitive. However the method name is always case sensitive.