API Documentation
Back to top  

package pomo
inherited_from \Translations

 Methods

Add entry to the PO structure

add_entry(array|\Translation_Entry $entry) : boolean
Inherited

Parameters

$entry

array\Translation_Entry

Returns

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

add_entry_or_merge() 

add_entry_or_merge(array|\Translation_Entry $entry) : boolean
Inherited

Parameters

$entry

array\Translation_Entry

Returns

boolean

get_header() 

get_header(string $header) 
Inherited

Parameters

$header

string

get_plural_forms_count() 

get_plural_forms_count() : integer
Inherited

Returns

integer

The gettext implementation of select_plural_form.

gettext_select_plural_form(integer $count) 

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

Parameters

$count

integer

make_headers() 

make_headers(string $translation) : array

Parameters

$translation

string

Returns

array

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

make_plural_form_function(integer $nplurals, string $expression) 

Parameters

$nplurals

integer

$expression

string

merge_originals_with() 

merge_originals_with(object $other) 
Inherited

Parameters

$other

object

Merge $other in the current object.

merge_with(Object $other) : void
Inherited

Parameters

$other

Object

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

nplurals_and_expression_from_header() 

nplurals_and_expression_from_header(string $header) : array

Parameters

$header

string

Returns

array

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

parenthesize_plural_exression(string $expression) : string

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

Parameters

$count

integer

number of items

Sets $header PO header to $value

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

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

Parameters

$header

string

header name, without trailing :

$value

string

header value, without trailing \n

set_headers() 

set_headers(array $headers) 
Inherited

Parameters

$headers

array

translate() 

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

Parameters

$singular

string

$context

string

Returns

string

translate_entry() 

translate_entry(\Translation_Entry $entry) 
Inherited

Parameters

$entry

\Translation_Entry

translate_plural() 

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

Parameters

$singular

string

$plural

string

$count

integer

$context

string

 Properties

 

$entries

$entries 

Default

array()
 

$headers

$headers 

Default

array()