core/str

Fetch and return language strings.

Source:
Since:
  • 2.9
Copyright:
  • 2015 Damyon Wiese
License:
  • http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Methods

(protected, inner) cache_strings(strings)

Source:

Add a list of strings to the caches.

This function should typically only be called from core APIs to pre-cache values.

Parameters:
Name Type Description
strings Array.<Object>

List of strings to fetch

Properties
Name Type Attributes Default Description
key string

The string identifer to fetch
value string

The string value
component string <optional>
 'core'

The componet to fetch from
lang string <optional>

The language to fetch a string for. Defaults to current page language.

(inner) get_string(key, component, param, lang) → {Promise}

Source:

Return a Promise that resolves to a string.

If the string has previously been cached, then the Promise will be resolved immediately, otherwise it will be fetched from the server and resolved when available.

Example

Fetching a string

import {get_string as getString} from 'core/str';
get_string('cannotfindteacher', 'error')
.then(str => {
    window.console.log(str); // Cannot find teacher
})
.catch();
Parameters:
Name Type Description
key string

The language string key
component string

The language string component
param string

The param for variable expansion in the string.
lang string

The users language - if not passed it is deduced.
Returns:
Type
Promise

(inner) get_strings(requests) → {Array.<Promise>}

Source:

Make a batch request to load a set of strings.

Any missing string will be fetched from the server. The Promise will only be resolved once all strings are available, or an attempt has been made to fetch them.

Example

Fetching a set of strings

import {get_strings as getStrings} from 'core/str';
get_strings([
    {
        key: 'cannotfindteacher',
        component: 'error',
    },
    {
        key: 'yes',
        component: 'core',
    },
    {
        key: 'no',
        component: 'core',
    },
])
.then((cannotFindTeacher, yes, no) => {
    window.console.log(cannotFindTeacher); // Cannot find teacher
    window.console.log(yes); // Yes
    window.console.log(no); // No
})
.catch();
Parameters:
Name Type Description
requests Array.<Object>

List of strings to fetch

Properties
Name Type Attributes Default Description
key string

The string identifer to fetch
component string <optional>
 'core'

The componet to fetch from
lang string <optional>

The language to fetch a string for. Defaults to current page language.
param object | string <optional>

The param for variable expansion in the string.
Returns:
Type
Array.<Promise>