API Documentation » \Gettext

Methods

Gettext_Translations class.

since	2.8.0
package	pomo
inherited_from	\Translations

Methods

Adds an entry to the PO structure.

add_entry(array|\Translation_Entry $entry) : boolean

Inherited

since	2.8.0

Parameters

$entry

array\Translation_Entry

Returns

booleanTrue on success, false if the entry doesn't have a key.

Adds or merges an entry to the PO structure.

add_entry_or_merge(array|\Translation_Entry $entry) : boolean

Inherited

since	2.8.0

Parameters

$entry

array\Translation_Entry

Returns

booleanTrue on success, false if the entry doesn't have a key.

Returns a given translation header.

get_header(string $header) : string | false

Inherited

since	2.8.0

Parameters

$header

string

Returns

stringfalseHeader if it exists, false otherwise.

Returns the plural forms count.

get_plural_forms_count() : integer

Inherited

since	2.8.0

Returns

integerPlural forms count.

The gettext implementation of select_plural_form.

gettext_select_plural_form(integer $count) : integer

It lives in this class, because there are more than one descendant, which will use it and they can't share it effectively.

since	2.8.0

Parameters

$count

integer

Plural forms count.

Returns

integerPlural form to use.

Prepare translation headers.

make_headers(string $translation) : \array<string,

since	2.8.0

Parameters

$translation

string

Returns

\array<string,string> Translation headers

Makes a function, which will return the right translation index, according to the plural forms header.

make_plural_form_function(integer $nplurals, string $expression) : callable

since	2.8.0

Parameters

$nplurals

integer

$expression

string

Returns

callable

Merges originals with existing entries.

merge_originals_with(\Translations $other)

Inherited

since	2.8.0

Parameters

$other

\Translations

Merges other translations into the current one.

merge_with(\Translations $other)

Inherited

since	2.8.0

Parameters

$other

\Translations

Another Translation object, whose translations will be merged in this one (passed by reference).

Returns the nplurals and plural forms expression from the Plural-Forms header.

nplurals_and_expression_from_header(string $header) : \array{0:

since	2.8.0

Parameters

$header

string

Returns

\array{0:int, 1: string}

Adds parentheses to the inner parts of ternary operators in plural expressions, because PHP evaluates ternary operators from left to right

parenthesize_plural_exression(string $expression) : string

since	2.8.0
deprecated	6.5.0 Use the Plural_Forms class instead.
see

Parameters

$expression

string

the expression without parentheses

Returns

stringthe expression with parentheses added

Given the number of items, returns the 0-based index of the plural form to use

select_plural_form(integer $count) : integer

Inherited

Here, in the base Translations class, the common logic for English is implemented: 0 if there is one element, 1 otherwise

This function should be overridden by the subclasses. For example MO/PO can derive the logic from their headers.

since	2.8.0

Parameters

$count

integer

Number of items.

Returns

integerPlural form to use.

Sets translation headers.

set_header(string $header, string $value)

If the header already exists, it will be overwritten

TODO: this should be out of this class, it is gettext specific

since	2.8.0
inherited_from	\Translations::set_header()

Parameters

$header

string

$value

string

Sets $header PO header to $value

set_header(string $header, string $value)

Inherited

If the header already exists, it will be overwritten

TODO: this should be out of this class, it is gettext specific

since	2.8.0

Parameters

$header

string

header name, without trailing :

$value

string

header value, without trailing \n

Sets translation headers.

set_headers(array $headers)

Inherited

since	2.8.0

Parameters

$headers

array

Associative array of headers.

Translates a singular string.

translate(string $singular, string $context = null) : string

Inherited

since	2.8.0

Parameters

$singular

string

$context

string

Returns

string

Returns a given translation entry.

translate_entry(\Translation_Entry $entry) : \Translation_Entry | false

Inherited

since	2.8.0

Parameters

$entry

\Translation_Entry

Translation entry.

Returns

\Translation_EntryfalseTranslation entry if it exists, false otherwise.

Translates a plural string.

translate_plural(string $singular, string $plural, integer $count, string $context = null) : string

Inherited

since	2.8.0

Parameters

$singular

string

$plural

string

$count

integer

$context

string

Returns

string

Properties

Callback to retrieve the plural form.

$_gettext_select_plural_form : callable

Default

since	2.8.0

Number of plural forms.

$_nplurals : integer

Default

since	2.8.0

List of translation entries.

$entries : array<mixed,\Translation_Entry>

Default

array()

since	2.8.0

List of translation headers.

$headers : \array<string,

Default

array()

since	2.8.0