API Documentation
Back to top  

Gettext_Translations class.

package pomo
inherited_from \Gettext_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.

export() 

export() : string | false

Returns

stringfalse

export_headers() 

export_headers() : string

Returns

string

export_original() 

export_original(\Translation_Entry $entry) : string

Parameters

$entry

\Translation_Entry

Returns

string

export_to_file() 

export_to_file(string $filename) : boolean

Parameters

$filename

string

Returns

boolean

export_to_file_handle() 

export_to_file_handle(resource $fh) : true

Parameters

$fh

resource

Returns

true

export_translations() 

export_translations(\Translation_Entry $entry) : string

Parameters

$entry

\Translation_Entry

Returns

string

get_byteorder() 

get_byteorder(integer $magic) : string | false

Parameters

$magic

integer

Returns

stringfalse

Returns the loaded MO file.

get_filename() : string

Returns

stringThe loaded MO file.

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.

get_plural_forms_count() 

get_plural_forms_count() : integer

Returns

integer

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
Inherited

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.

Fills up with the entries from MO file $filename

import_from_file(string $filename) : boolean

Parameters

$filename

string

MO file to load

Returns

booleanTrue if the import from file was successful, otherwise false.

import_from_reader() 

import_from_reader(\POMO_FileReader $reader) : boolean

Parameters

$reader

\POMO_FileReader

Returns

booleanTrue if the import was successful, otherwise false.

is_entry_good_for_export() 

is_entry_good_for_export(\Translation_Entry $entry) : boolean

Parameters

$entry

\Translation_Entry

Returns

boolean

Build a Translation_Entry from original string and translation strings, found in a MO file

make_entry(string $original, string $translation) : \Translation_Entry
Static
static

Parameters

$original

string

original string to translate from MO file. Might contain 0x04 as context separator or 0x00 as singular/plural separator

$translation

string

translation string from MO file. Might contain 0x00 as a plural translations separator

Returns

\Translation_EntryEntry instance.

Prepare translation headers.

make_headers(string $translation) : \array<string,
Inherited
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
Inherited
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:
Inherited
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
Inherited
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

select_plural_form() 

select_plural_form(integer $count) : string

Parameters

$count

integer

Returns

string

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

2
inherited_from \Gettext_Translations::_nplurals
 

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
 

Loaded MO file.

$filename : string

Default

''