3 * Contains Translation_Entry class
5 * @version $Id: entry.php 406 2010-02-07 11:10:24Z nbachiyski $
10 if ( !class_exists( 'Translation_Entry' ) ):
12 * Translation_Entry class encapsulates a translatable string
14 class Translation_Entry {
17 * Whether the entry contains a string and its plural form, default is false
21 var $is_plural = false;
26 var $translations = array();
27 var $translator_comments = '';
28 var $extracted_comments = '';
29 var $references = array();
33 * @param array $args associative array, support following keys:
34 * - singular (string) -- the string to translate, if omitted and empty entry will be created
35 * - plural (string) -- the plural form of the string, setting this will set {@link $is_plural} to true
36 * - translations (array) -- translations of the string and possibly -- its plural forms
37 * - context (string) -- a string differentiating two equal strings used in different contexts
38 * - translator_comments (string) -- comments left by translators
39 * - extracted_comments (string) -- comments left by developers
40 * - references (array) -- places in the code this strings is used, in relative_to_root_path/file.php:linenum form
41 * - flags (array) -- flags like php-format
43 function Translation_Entry($args=array()) {
44 // if no singular -- empty object
45 if (!isset($args['singular'])) {
48 // get member variable values from args hash
49 foreach ($args as $varname => $value) {
50 $this->$varname = $value;
52 if (isset($args['plural'])) $this->is_plural = true;
53 if (!is_array($this->translations)) $this->translations = array();
54 if (!is_array($this->references)) $this->references = array();
55 if (!is_array($this->flags)) $this->flags = array();
59 * Generates a unique key for this entry
61 * @return string|bool the key or false if the entry is empty
64 if (is_null($this->singular)) return false;
65 // prepend context and EOT, like in MO files
66 return is_null($this->context)? $this->singular : $this->context.chr(4).$this->singular;