WordPress/wp-includes/pomo/entry.php

71 lines
2.2 KiB
PHP

<?php
/**
* Contains Translation_Entry class
*
* @version $Id: entry.php 115 2009-05-11 18:56:15Z nbachiyski $
* @package pomo
* @subpackage entry
*/
/**
* Translation_Entry class encapsulates a translatable string
*/
class Translation_Entry {
/**
* Whether the entry contains a string and its plural form, default is false
*
* @var boolean
*/
var $is_plural = false;
var $context = null;
var $singular = null;
var $plural = null;
var $translations = array();
var $translator_comments = '';
var $extracted_comments = '';
var $references = array();
var $flags = array();
/**
* @param array $args associative array, support following keys:
* - singular (string) -- the string to translate, if omitted and empty entry will be created
* - plural (string) -- the plural form of the string, setting this will set {@link $is_plural} to true
* - translations (array) -- translations of the string and possibly -- its plural forms
* - context (string) -- a string differentiating two equal strings used in different contexts
* - translator_comments (string) -- comments left by translators
* - extracted_comments (string) -- comments left by developers
* - references (array) -- places in the code this strings is used, in relative_to_root_path/file.php:linenum form
* - flags (array) -- flags like php-format
*/
function Translation_Entry($args=array()) {
// if no singular -- empty object
if (!isset($args['singular'])) {
return;
}
// get member variable values from args hash
$object_varnames = array_keys(get_object_vars($this));
foreach ($args as $varname => $value) {
$this->$varname = $value;
}
if (isset($args['plural'])) $this->is_plural = true;
if (!is_array($this->translations)) $this->translations = array();
if (!is_array($this->references)) $this->references = array();
if (!is_array($this->flags)) $this->flags = array();
}
/**
* Generates a unique key for this entry
*
* @return string|bool the key or false if the entry is empty
*/
function key() {
if (is_null($this->singular)) return false;
// prepend context and EOT, like in MO files
return is_null($this->context)? $this->singular : $this->context.chr(4).$this->singular;
}
}
?>