class i18n extends Object implements TemplateGlobalProvider, Flushable

Base-class for storage and retrieval of translated entities.

Please see the 'translatable' module for managing translations of database-content.

Usage

PHP: _t('MyNamespace.MYENTITY', 'My default natural language value'); _t('MyNamespace.MYENTITY', 'My default natural language value', 'My explanatory context'); sprintf(_t('MyNamespace.MYENTITY', 'Counting %s things'), 42);

Templates: <%t MyNamespace.MYENTITY 'My default natural language value' %> <%t MyNamespace.MYENTITY 'Counting %s things' s=$ThingsCount %> <%t MyNamespace.MYENTITY 'Counting {count} things' count=$ThingsCount %>

Javascript (see framework/javascript/i18n.js): ss.i18n._t('MyEntity.MyNamespace','My default natural language value');

File-based i18n-translations always have a "locale" (e.g. 'en_US'). Common language names (e.g. 'en') are mainly used in the 'translatable' module database-entities.

Text Collection

Features a "textcollector-mode" that parses all files with a certain extension (currently *.php and *.ss) for new translatable strings. Textcollector will write updated string-tables to their respective folders inside the module, and automatically namespace entities to the classes/templates they are found in (e.g. $lang['en_US']['AssetAdmin']['UPLOADFILES']).

Caution: Does not apply any character-set conversion, it is assumed that all content is stored and represented in UTF-8 (Unicode). Please make sure your files are created with the correct character-set, and your HTML-templates render UTF-8.

Caution: The language file has to be stored in the same module path as the "filename namespaces" on the entities. So an entity stored in $lang['en_US']['AssetAdmin']['DETAILSTAB'] has to in the language file cms/lang/en_US.php, as the referenced file (AssetAdmin.php) is stored in the "cms" module.

Locales

For the i18n class, a "locale" consists of a language code plus a region code separated by an underscore, for example "de_AT" for German language ("de") in the region Austria ("AT"). See http://www.w3.org/International/articles/language-tags/ for a detailed description.

Properties

string $class from Object
protected array $extension_instances from Object
protected array[callable] $beforeExtendCallbacks List of callbacks to call prior to extensions having extend called on them, each grouped by methodName. from Object
protected array[callable] $afterExtendCallbacks List of callbacks to call after extensions having extend called on them, each grouped by methodName. from Object
static protected $current_locale This static variable is used to store the current defined locale.
static protected array $translators

Methods

static Config_ForClass|null
config()

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

from Object
beforeExtending(string $method, callable $callback)

Allows user code to hook into Object::extend prior to control being delegated to extensions. Each callback will be reset once called.

from Object
afterExtending(string $method, callable $callback)

Allows user code to hook into Object::extend after control being delegated to extensions. Each callback will be reset once called.

from Object
static Object
create()

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

from Object
static Object
singleton()

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

from Object
static 
create_from_string($classSpec, $firstArg = null)

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

from Object
static 
parse_class_spec($classSpec)

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

from Object
static Object
strong_create()

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

from Object
static 
useCustomClass(string $oldClass, string $newClass, bool $strong = false)

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

from Object
static string
getCustomClass(string $class)

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

from Object
static any
static_lookup($class, $name, null $default = null)

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.

from Object
static 
get_static($class, $name, $uncached = false) deprecated

No description

from Object
static 
set_static($class, $name, $value) deprecated

No description

from Object
static 
uninherited_static($class, $name, $uncached = false) deprecated

No description

from Object
static 
combined_static($class, $name, $ceiling = false) deprecated

No description

from Object
static 
addStaticVars($class, $properties, $replace = false) deprecated

No description

from Object
static 
add_static_var($class, $name, $value, $replace = false) deprecated

No description

from Object
static 
has_extension(string $classOrExtension, string $requiredExtension = null, boolean $strict = false)

Return TRUE if a class has a specified extension.

from Object
static 
add_extension(string $classOrExtension, string $extension = null)

Add an extension to a specific class.

from Object
static 
remove_extension(string $extension)

Remove an extension from a class.

from Object
static array
get_extensions(string $class, bool $includeArgumentString = false)

No description

from Object
static 
get_extra_config_sources($class = null)

No description

from Object
__construct()

No description

from Object
mixed
__call(string $method, array $arguments)

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

from Object
bool
hasMethod(string $method)

Return TRUE if a method exists on this object

from Object
array
allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

from Object
defineMethods()

Adds any methods from {@link Extension} instances attached to this object.

from Object
array
findMethodsFromExtension(object $extension)

No description

from Object
addMethodsFrom(string $property, string|int $index = null)

Add all the methods from an object property (which is an {@link Extension}) to this object.

from Object
removeMethodsFrom(string $property, string|int $index = null)

Add all the methods from an object property (which is an {@link Extension}) to this object.

from Object
addWrapperMethod(string $method, string $wrap)

Add a wrapper method - a method which points to another method with a different name. For example, Thumbnail(x) can be wrapped to generateThumbnail(x)

from Object
createMethod(string $method, string $code)

Add an extra method using raw PHP code passed as a string

from Object
stat($name, $uncached = false)

No description

from Object
set_stat($name, $value)

No description

from Object
uninherited($name)

No description

from Object
bool
exists()

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

from Object
string
parentClass()

No description

from Object
bool
is_a(string $class)

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

from Object
string
__toString()

No description

from Object
mixed
invokeWithExtensions(string $method, mixed $argument = null)

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

from Object
array
extend($method, $a1 = null, $a2 = null, $a3 = null, $a4 = null, $a5 = null, $a6 = null, $a7 = null)

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

from Object
getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

from Object
bool
hasExtension(string $extension)

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.

from Object
array
getExtensionInstances()

Get all extension instances for this specific object instance.

from Object
mixed
cacheToFile(string $method, int $lifetime = 3600, string $ID = false, array $arguments = array())

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

from Object
clearCache($method, $ID = false, $arguments = array())

Clears the cache for the given cacheToFile call

from Object
mixed
loadCache(string $cache, int $lifetime = 3600)

Loads a cache from the filesystem if a valid on is present and within the specified lifetime

from Object
saveCache(string $cache, mixed $data)

Save a piece of cached data to the file system

from Object
string
sanitiseCachename(string $name)

Strip a file name of special characters so it is suitable for use as a cache file name

from Object
static 
flush()

Triggered early in the request when someone requests a flush.

static Zend_Cache
get_cache()

Return an instance of the cache used for i18n data.

static 
set_js_i18n(bool $bool) deprecated

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

static bool
get_js_i18n() deprecated

No description

static 
set_date_format(string $format) deprecated

No description

static string
get_date_format() deprecated

No description

static 
set_time_format(string $format) deprecated

No description

static string
get_time_format() deprecated

No description

static string
_t(string $entity, string $string = "", string $context = "", array $injection = array())

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

static array
get_translators()

No description

static Zend_Translate
get_translator(String $name)

No description

static 
register_translator(Zend_Translate $translator, String $name, Int $priority = 10)

No description

static 
unregister_translator(String $name)

No description

static list
get_common_languages(boolean $native = false)

Get a list of commonly used languages

static list
get_common_locales(boolean $native = false)

Get a list of commonly used locales

static list
get_locale_list() deprecated

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

static string
get_closest_translation(string $locale)

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

static array
get_existing_translations()

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

static Name
get_language_name(mixed $code, boolean $native = false)

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

static Name
get_locale_name(mixed $code)

Get a name from a locale code (xx_YY).

static Language
get_language_code(mixed $name)

Get a code from an English language name

static Language
get_tinymce_lang()

Get the current tinyMCE language

static array
get_translatable_modules()

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

static string
get_lang_from_locale(string $locale)

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

static string
get_locale_from_lang(string $lang)

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.

static string
convert_rfc1766(string $locale)

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

static string
get_owner_module(string $name)

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

static boolean
validate_locale($locale)

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

static 
set_locale(string $locale)

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.

static string
get_locale()

Get the current locale.

static String
default_locale() deprecated

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

static 
set_default_locale(String $locale) deprecated

See {@link default_locale()} for usage.

static String
get_script_direction(String $locale = null)

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

static 
include_by_locale(string $locale, Boolean $clean = false)

Includes all available language files for a certain defined locale.

static 
include_by_class(string $class)

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

static array
get_template_global_variables()

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

Details

in Object at line 60
static Config_ForClass|null config()

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

....).

Return Value

Config_ForClass|null

in Object at line 85
protected beforeExtending(string $method, callable $callback)

Allows user code to hook into Object::extend prior to control being delegated to extensions. Each callback will be reset once called.

Parameters

string $method The name of the method to hook into
callable $callback The callback to execute

in Object at line 108
protected afterExtending(string $method, callable $callback)

Allows user code to hook into Object::extend after control being delegated to extensions. Each callback will be reset once called.

Parameters

string $method The name of the method to hook into
callable $callback The callback to execute

in Object at line 132
static Object create()

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

Return Value

Object

in Object at line 155
static Object singleton()

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

Return Value

Object The singleton instance

in Object at line 190
static create_from_string($classSpec, $firstArg = null)

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.

Parameters

$classSpec
$firstArg

in Object at line 215
static parse_class_spec($classSpec)

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

Returns a 2-elemnent array, with classname and arguments

Parameters

$classSpec

in Object at line 341
static Object strong_create()

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

Return Value

Object

in Object at line 361
static useCustomClass(string $oldClass, string $newClass, bool $strong = false)

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

Parameters

string $oldClass the class to replace
string $newClass the class to replace it with
bool $strong allows you to enforce a certain class replacement under all circumstances. This is used in singletons and DB interaction classes

in Object at line 375
static string getCustomClass(string $class)

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

Parameters

string $class the class to check

Return Value

string the class that would be created if you called {@link Object::create()} with the class

in Object at line 396
static any static_lookup($class, $name, null $default = null)

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.

Parameters

$class
  • The class to get the static from
$name
  • The property to get from the class
null $default
  • The value to return if property doesn't exist on class

Return Value

any
  • The value of the static property $name on class $class, or $default if that property is not defined

in Object at line 436
static get_static($class, $name, $uncached = false) deprecated

deprecated

Parameters

$class
$name
$uncached

in Object at line 444
static set_static($class, $name, $value) deprecated

deprecated

Parameters

$class
$name
$value

in Object at line 452
static uninherited_static($class, $name, $uncached = false) deprecated

deprecated

Parameters

$class
$name
$uncached

in Object at line 460
static combined_static($class, $name, $ceiling = false) deprecated

deprecated

Parameters

$class
$name
$ceiling

in Object at line 470
static addStaticVars($class, $properties, $replace = false) deprecated

deprecated

Parameters

$class
$properties
$replace

in Object at line 478
static add_static_var($class, $name, $value, $replace = false) deprecated

deprecated

Parameters

$class
$name
$value
$replace

in Object at line 494
static has_extension(string $classOrExtension, string $requiredExtension = null, boolean $strict = false)

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

Parameters

string $classOrExtension if 1 argument supplied, the class name of the extension to check for; if 2 supplied, the class name to test
string $requiredExtension used only if 2 arguments supplied
boolean $strict if the extension has to match the required extension and not be a subclass

in Object at line 536
static add_extension(string $classOrExtension, string $extension = null)

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

Parameters

string $classOrExtension Class that should be extended - has to be a subclass of {@link Object}
string $extension Subclass of {@link Extension} with optional parameters as a string, e.g. "Versioned" or "Translatable('Param')"

See also

http://doc.silverstripe.org/framework/en/trunk/reference/dataextension

in Object at line 601
static remove_extension(string $extension)

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.

Parameters

string $extension Classname of an {@link Extension} subclass, without parameters

in Object at line 640
static array get_extensions(string $class, bool $includeArgumentString = false)

Parameters

string $class
bool $includeArgumentString Include the argument string in the return array, FALSE would return array("Versioned"), TRUE returns array("Versioned('Stage','Live')").

Return Value

array Numeric array of either {@link DataExtension} classnames, or eval'ed classname strings with constructor arguments.

in Object at line 658
static get_extra_config_sources($class = null)

Parameters

$class

in Object at line 697
__construct()

in Object at line 728
mixed __call(string $method, array $arguments)

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

Parameters

string $method
array $arguments

Return Value

mixed

in Object at line 795
bool hasMethod(string $method)

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

Parameters

string $method

Return Value

bool

in Object at line 805
array allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

Parameters

bool $custom include methods added dynamically at runtime

Return Value

array

in Object at line 825
protected defineMethods()

Adds any methods from {@link Extension} instances attached to this object.

All these methods can then be called directly on the instance (transparently mapped through {@link __call()}), or called explicitly through {@link extend()}.

in Object at line 846
protected array findMethodsFromExtension(object $extension)

Parameters

object $extension

Return Value

array

in Object at line 867
protected addMethodsFrom(string $property, string|int $index = null)

Add all the methods from an object property (which is an {@link Extension}) to this object.

Parameters

string $property the property name
string|int $index an index to use if the property is an array

in Object at line 902
protected removeMethodsFrom(string $property, string|int $index = null)

Add all the methods from an object property (which is an {@link Extension}) to this object.

Parameters

string $property the property name
string|int $index an index to use if the property is an array

in Object at line 934
protected addWrapperMethod(string $method, string $wrap)

Add a wrapper method - a method which points to another method with a different name. For example, Thumbnail(x) can be wrapped to generateThumbnail(x)

Parameters

string $method the method name to wrap
string $wrap the method name to wrap to

in Object at line 949
protected createMethod(string $method, string $code)

Add an extra method using raw PHP code passed as a string

Parameters

string $method the method name
string $code the PHP code - arguments will be in an array called $args, while you can access this object by using $obj. Note that you cannot call protected methods, as the method is actually an external function

in Object at line 960
stat($name, $uncached = false)

Parameters

$name
$uncached

See also

Object::get_static()

in Object at line 967
set_stat($name, $value)

Parameters

$name
$value

See also

Object::set_static()

in Object at line 974
uninherited($name)

Parameters

$name

See also

Object::uninherited_static()

in Object at line 988
bool exists()

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

Return Value

bool

in Object at line 995
string parentClass()

Return Value

string this classes parent class

in Object at line 1005
bool is_a(string $class)

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

Parameters

string $class

Return Value

bool

in Object at line 1012
string __toString()

Return Value

string the class name

in Object at line 1027
mixed invokeWithExtensions(string $method, mixed $argument = null)

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

Parameters

string $method the method name to call
mixed $argument a single argument to pass

Return Value

mixed

in Object at line 1049
array extend($method, $a1 = null, $a2 = null, $a3 = null, $a4 = null, $a5 = null, $a6 = null, $a7 = null)

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

Parameters

$method
$a1
$a2
$a3
$a4
$a5
$a6
$a7

Return Value

array

in Object at line 1088
Extension getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

Parameters

string $extension

Return Value

Extension

in Object at line 1106
bool hasExtension(string $extension)

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.

Parameters

string $extension Classname of an {@link Extension} subclass without parameters

Return Value

bool

in Object at line 1117
array getExtensionInstances()

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

Return Value

array Map of {@link DataExtension} instances, keyed by classname.

in Object at line 1133
mixed cacheToFile(string $method, int $lifetime = 3600, string $ID = false, array $arguments = array())

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

Parameters

string $method the method name to cache
int $lifetime the cache lifetime in seconds
string $ID custom cache ID to use
array $arguments an optional array of arguments

Return Value

mixed the cached data

in Object at line 1162
clearCache($method, $ID = false, $arguments = array())

Clears the cache for the given cacheToFile call

Parameters

$method
$ID
$arguments

in Object at line 1181
protected mixed loadCache(string $cache, int $lifetime = 3600)

Loads a cache from the filesystem if a valid on is present and within the specified lifetime

Parameters

string $cache the cache name
int $lifetime the lifetime (in seconds) of the cache before it is invalid

Return Value

mixed

in Object at line 1199
protected saveCache(string $cache, mixed $data)

Save a piece of cached data to the file system

Parameters

string $cache the cache name
mixed $data data to save (must be serializable)

in Object at line 1210
protected string sanitiseCachename(string $name)

Strip a file name of special characters so it is suitable for use as a cache file name

Parameters

string $name

Return Value

string the name with all special cahracters replaced with underscores

at line 104
static flush()

Triggered early in the request when someone requests a flush.

at line 123
static Zend_Cache get_cache()

Return an instance of the cache used for i18n data.

Return Value

Zend_Cache

at line 144
static set_js_i18n(bool $bool) deprecated

deprecated 4.0 Use the "i18n.js_i18n" config setting instead

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.

Parameters

bool $bool

See also

Requirements::process_i18n_javascript()

at line 153
static bool get_js_i18n() deprecated

deprecated 4.0 Use the "i18n.js_i18n" config setting instead

Return Value

bool

at line 162
static set_date_format(string $format) deprecated

deprecated 4.0 Use the "i18n.date_format" config setting instead

Parameters

string $format ISO date format

at line 171
static string get_date_format() deprecated

deprecated since version 4.0

Return Value

string ISO date format

at line 180
static set_time_format(string $format) deprecated

deprecated 4.0 Use the "i18n.time_format" config setting instead

Parameters

string $format ISO time format

at line 189
static string get_time_format() deprecated

deprecated since version 4.0

Return Value

string ISO time format

at line 2037
static string _t(string $entity, string $string = "", string $context = "", array $injection = array())

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

Parameters

string $entity Entity that identifies the string. It must be in the form "Namespace.Entity" where Namespace will be usually the class name where this string is used and Entity identifies the string inside the namespace.
string $string The original string itself. In a usual call this is a mandatory parameter, but if you are reusing a string which has already been "declared" (using another call to this function, with the same class and entity), you can omit it.
string $context (optional) If the string can be difficult to translate by any reason, you can help translators with some more info using this param
array $injection (optional) array of key value pairs that are used to replace corresponding expressions in {curly brackets} in the $string. The injection array can also be used as the their argument to the _t() function. The injection array can be the second, third or fourth parameter. The function will use the first parameter that is an array

Return Value

string The translated string, according to the currently set locale {@link i18n::set_locale()}

at line 2144
static array get_translators()

Return Value

array Array of priority keys to instances of Zend_Translate, mapped by name.

at line 2170
static Zend_Translate get_translator(String $name)

Parameters

String $name

Return Value

Zend_Translate

at line 2182
static register_translator(Zend_Translate $translator, String $name, Int $priority = 10)

Parameters

Zend_Translate $translator Needs to implement {@link i18nTranslateAdapterInterface}
String $name If left blank will override the default translator.
Int $priority

at line 2202
static unregister_translator(String $name)

Parameters

String $name

at line 2214
static list get_common_languages(boolean $native = false)

Get a list of commonly used languages

Parameters

boolean $native Use native names for languages instead of English ones

Return Value

list of languages in the form 'code' => 'name'

at line 2228
static list get_common_locales(boolean $native = false)

Get a list of commonly used locales

Parameters

boolean $native Use native names for locale instead of English ones

Return Value

list of languages in the form 'code' => 'name'

at line 2242
static list get_locale_list() deprecated

deprecated since version 4.0

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

Return Value

list of languages in the form 'code' => 'name'

at line 2253
static string get_closest_translation(string $locale)

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

Parameters

string $locale locale code

Return Value

string Locale of closest available translation, if available

at line 2272
static array get_existing_translations()

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

at line 2314
static Name get_language_name(mixed $code, boolean $native = false)

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

Parameters

mixed $code Language code
boolean $native If true, the native name will be returned

Return Value

Name of the language

See also

get_locale_name()

at line 2331
static Name get_locale_name(mixed $code)

Get a name from a locale code (xx_YY).

Parameters

mixed $code locale code

Return Value

Name of the locale

See also

get_language_name()

at line 2342
static Language get_language_code(mixed $name)

Get a code from an English language name

Parameters

mixed $name Name of the language

Return Value

Language code (if the name is not found, it'll return the passed name)

at line 2352
static Language get_tinymce_lang()

Get the current tinyMCE language

Return Value

Language

at line 2368
static array get_translatable_modules()

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

Return Value

array

at line 2394
static string get_lang_from_locale(string $locale)

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

Parameters

string $locale E.g. "en_US"

Return Value

string Short language code, e.g. "en"

at line 2409
static string get_locale_from_lang(string $lang)

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.

Parameters

string $lang Short language code, e.g. "en"

Return Value

string Long locale, e.g. "en_US"

See also

http://www.unicode.org/cldr/data/charts/supplemental/likely_subtags.html

at line 2430
static string convert_rfc1766(string $locale)

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

Parameters

string $locale

Return Value

string

See also

http://www.ietf.org/rfc/rfc1766.txt
http://tools.ietf.org/html/rfc2616#section-3.10

at line 2440
static string get_owner_module(string $name)

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

Parameters

string $name

Return Value

string

at line 2469
static boolean validate_locale($locale)

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

Parameters

$locale

Return Value

boolean

at line 2486
static set_locale(string $locale)

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.

Parameters

string $locale Locale to be set. See http://unicode.org/cldr/data/diff/supplemental/languages_and_territories.html for a list of possible locales.

at line 2496
static string get_locale()

Get the current locale.

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

Return Value

string Current locale in the system

at line 2513
static String default_locale() deprecated

deprecated since version 4.0; Use the "i18n.default_locale" config setting instead

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.

Return Value

String

at line 2524
static set_default_locale(String $locale) deprecated

deprecated since version 4.0; Use the "i18n.default_locale" config setting instead

See {@link default_locale()} for usage.

Parameters

String $locale

at line 2536
static String get_script_direction(String $locale = null)

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

Parameters

String $locale Optional locale incl. region (underscored)

Return Value

String "rtl" or "ltr"

See also

http://www.w3.org/International/tutorials/bidi-xhtml/

at line 2554
static include_by_locale(string $locale, Boolean $clean = false)

Includes all available language files for a certain defined locale.

Parameters

string $locale All resources from any module in locale $locale will be loaded
Boolean $clean Clean old caches?

at line 2644
static include_by_class(string $class)

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)

Parameters

string $class Resources for this class will be included, according to the set locale.

at line 2662
static array get_template_global_variables()

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.

Return Value

array Returns an array of items. Each key => value pair is one of three forms: - template name (no key) - template name => method name - template name => array(), where the array can contain these key => value pairs - "method" => method name - "casting" => casting class to use (i.e., Varchar, HTMLText, etc)