| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Source view] [Print] [Project Stats]
Class for a set of entries for translation and their associated headers
| Version: | $Id: translations.php 1157 2015-11-20 04:30:11Z dd32 $ |
| File Size: | 546 lines (13 kb) |
| Included or required: | 2 times |
| Referenced: | 0 times |
| Includes or requires: | 2 files wp-includes/pomo/plural-forms.php wp-includes/pomo/entry.php |
Translations:: (12 methods):
add_entry()
add_entry_or_merge()
set_header()
set_headers()
get_header()
translate_entry()
translate()
select_plural_form()
get_plural_forms_count()
translate_plural()
merge_with()
merge_originals_with()
Gettext_Translations:: (6 methods):
gettext_select_plural_form()
nplurals_and_expression_from_header()
make_plural_form_function()
parenthesize_plural_exression()
make_headers()
set_header()
NOOP_Translations:: (10 methods):
add_entry()
set_header()
set_headers()
get_header()
translate_entry()
translate()
select_plural_form()
get_plural_forms_count()
translate_plural()
merge_with()
Class: Translations - X-Ref
Translations class.| add_entry( $entry ) X-Ref |
| Adds an entry to the PO structure. return: bool True on success, false if the entry doesn't have a key. param: array|Translation_Entry $entry |
| add_entry_or_merge( $entry ) X-Ref |
| Adds or merges an entry to the PO structure. return: bool True on success, false if the entry doesn't have a key. param: array|Translation_Entry $entry |
| set_header( $header, $value ) X-Ref |
| Sets $header PO header to $value If the header already exists, it will be overwritten TODO: this should be out of this class, it is gettext specific param: string $header header name, without trailing : param: string $value header value, without trailing \n |
| set_headers( $headers ) X-Ref |
| Sets translation headers. param: array $headers Associative array of headers. |
| get_header( $header ) X-Ref |
| Returns a given translation header. return: string|false Header if it exists, false otherwise. param: string $header |
| translate_entry( &$entry ) X-Ref |
| Returns a given translation entry. return: Translation_Entry|false Translation entry if it exists, false otherwise. param: Translation_Entry $entry Translation entry. |
| translate( $singular, $context = null ) X-Ref |
| Translates a singular string. return: string param: string $singular param: string $context |
| select_plural_form( $count ) X-Ref |
| Given the number of items, returns the 0-based index of the plural form to use 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. return: int Plural form to use. param: int $count Number of items. |
| get_plural_forms_count() X-Ref |
| Returns the plural forms count. return: int Plural forms count. |
| translate_plural( $singular, $plural, $count, $context = null ) X-Ref |
| Translates a plural string. return: string param: string $singular param: string $plural param: int $count param: string $context |
| merge_with( &$other ) X-Ref |
| Merges other translations into the current one. param: Translations $other Another Translation object, whose translations will be merged in this one (passed by reference). |
| merge_originals_with( &$other ) X-Ref |
| Merges originals with existing entries. param: Translations $other |
Class: Gettext_Translations - X-Ref
Gettext_Translations class.| gettext_select_plural_form( $count ) X-Ref |
| The gettext implementation of select_plural_form. It lives in this class, because there are more than one descendant, which will use it and they can't share it effectively. return: int Plural form to use. param: int $count Plural forms count. |
| nplurals_and_expression_from_header( $header ) X-Ref |
| Returns the nplurals and plural forms expression from the Plural-Forms header. return: array{0: int, 1: string} param: string $header |
| make_plural_form_function( $nplurals, $expression ) X-Ref |
| Makes a function, which will return the right translation index, according to the plural forms header. return: callable param: int $nplurals param: string $expression |
| parenthesize_plural_exression( $expression ) X-Ref |
| Adds parentheses to the inner parts of ternary operators in plural expressions, because PHP evaluates ternary operators from left to right return: string the expression with parentheses added param: string $expression the expression without parentheses |
| make_headers( $translation ) X-Ref |
| Prepare translation headers. return: array<string, string> Translation headers param: string $translation |
| set_header( $header, $value ) X-Ref |
| Sets translation headers. param: string $header param: string $value |
Class: NOOP_Translations - X-Ref
Provides the same interface as Translations, but doesn't do anything.| add_entry( $entry ) X-Ref |
| List of translation headers. |
| set_header( $header, $value ) X-Ref |
| Sets a translation header. param: string $header param: string $value |
| set_headers( $headers ) X-Ref |
| Sets translation headers. param: array $headers |
| get_header( $header ) X-Ref |
| Returns a translation header. return: false param: string $header |
| translate_entry( &$entry ) X-Ref |
| Returns a given translation entry. return: false param: Translation_Entry $entry |
| translate( $singular, $context = null ) X-Ref |
| Translates a singular string. param: string $singular param: string $context |
| select_plural_form( $count ) X-Ref |
| Returns the plural form to use. return: int param: int $count |
| get_plural_forms_count() X-Ref |
| Returns the plural forms count. return: int |
| translate_plural( $singular, $plural, $count, $context = null ) X-Ref |
| Translates a plural string. return: string param: string $singular param: string $plural param: int $count param: string $context |
| merge_with( &$other ) X-Ref |
| Merges other translations into the current one. param: Translations $other |
| Generated : Sat Dec 21 08:20:01 2024 | Cross-referenced by PHPXref |