* Class for a set of entries for translation and their associated headers
* @version $Id: translations.php 1157 2015-11-20 04:30:11Z dd32 $
* @subpackage translations
require_once __DIR__ . '/plural-forms.php';
require_once __DIR__ . '/entry.php';
if ( ! class_exists( 'Translations', false ) ) :
public $entries = array();
public $headers = array();
* Add entry to the PO structure
* @param array|Translation_Entry $entry
* @return bool true on success, false if the entry doesn't have a key
function add_entry( $entry ) {
if ( is_array( $entry ) ) {
$entry = new Translation_Entry( $entry );
$this->entries[ $key ] = &$entry;
* @param array|Translation_Entry $entry
function add_entry_or_merge( $entry ) {
if ( is_array( $entry ) ) {
$entry = new Translation_Entry( $entry );
if ( isset( $this->entries[ $key ] ) ) {
$this->entries[ $key ]->merge_with( $entry );
$this->entries[ $key ] = &$entry;
* 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
function set_header( $header, $value ) {
$this->headers[ $header ] = $value;
function set_headers( $headers ) {
foreach ( $headers as $header => $value ) {
$this->set_header( $header, $value );
function get_header( $header ) {
return isset( $this->headers[ $header ] ) ? $this->headers[ $header ] : false;
* @param Translation_Entry $entry
function translate_entry( &$entry ) {
return isset( $this->entries[ $key ] ) ? $this->entries[ $key ] : false;
* @param string $singular
function translate( $singular, $context = null ) {
$entry = new Translation_Entry(
$translated = $this->translate_entry( $entry );
return ( $translated && ! empty( $translated->translations ) ) ? $translated->translations[0] : $singular;
* 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
* @param int $count number of items
function select_plural_form( $count ) {
return 1 == $count ? 0 : 1;
function get_plural_forms_count() {
* @param string $singular
function translate_plural( $singular, $plural, $count, $context = null ) {
$entry = new Translation_Entry(
$translated = $this->translate_entry( $entry );
$index = $this->select_plural_form( $count );
$total_plural_forms = $this->get_plural_forms_count();
if ( $translated && 0 <= $index && $index < $total_plural_forms &&
is_array( $translated->translations ) &&
isset( $translated->translations[ $index ] ) ) {
return $translated->translations[ $index ];
return 1 == $count ? $singular : $plural;
* Merge $other in the current object.
* @param Object $other Another Translation object, whose translations will be merged in this one (passed by reference).
function merge_with( &$other ) {
foreach ( $other->entries as $entry ) {
$this->entries[ $entry->key() ] = $entry;
function merge_originals_with( &$other ) {
foreach ( $other->entries as $entry ) {
if ( ! isset( $this->entries[ $entry->key() ] ) ) {
$this->entries[ $entry->key() ] = $entry;
$this->entries[ $entry->key() ]->merge_with( $entry );
class Gettext_Translations extends Translations {
* The gettext implementation of select_plural_form.
* It lives in this class, because there are more than one descendand, which will use it and
* they can't share it effectively.
function gettext_select_plural_form( $count ) {
if ( ! isset( $this->_gettext_select_plural_form ) || is_null( $this->_gettext_select_plural_form ) ) {
list( $nplurals, $expression ) = $this->nplurals_and_expression_from_header( $this->get_header( 'Plural-Forms' ) );
$this->_nplurals = $nplurals;
$this->_gettext_select_plural_form = $this->make_plural_form_function( $nplurals, $expression );
return call_user_func( $this->_gettext_select_plural_form, $count );
function nplurals_and_expression_from_header( $header ) {
if ( preg_match( '/^\s*nplurals\s*=\s*(\d+)\s*;\s+plural\s*=\s*(.+)$/', $header, $matches ) ) {
$nplurals = (int) $matches[1];
$expression = trim( $matches[2] );
return array( $nplurals, $expression );
return array( 2, 'n != 1' );
* Makes a function, which will return the right translation index, according to the
* @param string $expression
function make_plural_form_function( $nplurals, $expression ) {
$handler = new Plural_Forms( rtrim( $expression, ';' ) );
return array( $handler, 'get' );
} catch ( Exception $e ) {
// Fall back to default plural-form function.
return $this->make_plural_form_function( 2, 'n != 1' );
* Adds parentheses to the inner parts of ternary operators in
* plural expressions, because PHP evaluates ternary oerators from left to right
* @param string $expression the expression without parentheses
* @return string the expression with parentheses added
function parenthesize_plural_exression( $expression ) {
for ( $i = 0; $i < strlen( $expression ); ++$i ) {
$char = $expression[ $i ];
$res .= str_repeat( ')', $depth ) . ';';
return rtrim( $res, ';' );
* @param string $translation
function make_headers( $translation ) {
// Sometimes \n's are used instead of real new lines.
$translation = str_replace( '\n', "\n", $translation );
$lines = explode( "\n", $translation );
foreach ( $lines as $line ) {
$parts = explode( ':', $line, 2 );
if ( ! isset( $parts[1] ) ) {
$headers[ trim( $parts[0] ) ] = trim( $parts[1] );
function set_header( $header, $value ) {
parent::set_header( $header, $value );
if ( 'Plural-Forms' === $header ) {
list( $nplurals, $expression ) = $this->nplurals_and_expression_from_header( $this->get_header( 'Plural-Forms' ) );
$this->_nplurals = $nplurals;
$this->_gettext_select_plural_form = $this->make_plural_form_function( $nplurals, $expression );
if ( ! class_exists( 'NOOP_Translations', false ) ) :
* Provides the same interface as Translations, but doesn't do anything
class NOOP_Translations {
public $entries = array();
public $headers = array();
function add_entry( $entry ) {
function set_header( $header, $value ) {
function set_headers( $headers ) {
function get_header( $header ) {
* @param Translation_Entry $entry
function translate_entry( &$entry ) {
* @param string $singular
function translate( $singular, $context = null ) {
function select_plural_form( $count ) {
return 1 == $count ? 0 : 1;
function get_plural_forms_count() {
* @param string $singular
function translate_plural( $singular, $plural, $count, $context = null ) {
return 1 == $count ? $singular : $plural;
function merge_with( &$other ) {
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
