Blame | Letzte Änderung | Log anzeigen | RSS feed
<?php/*** File translation.class.php** @package Translation*//*** require dependencies*/require_once 'PEAR.php';require_once 'DB.php';/*** Translation class** Class allows storing and retrieving all the strings on multilingual site* in a database.* The class connects to any database using PEAR::DB extension - so it needs* PEAR to be installed to work correctly.* The object should be created for every page. While creation all the strings* connected with specific page and the strings connected with all the pages* on the site are loaded into variable, so accessing them is quite fast and* does not overload database server connection.* The class can reuse existing DB connections. To do so just pass to the* constructor the handle for the connection instead of DSN.** @author Wojciech Zieliñski <voyteck@caffe.com.pl>* @version 1.2.3* @access public* @package Translation*/class Translation extends PEAR {/*** The translations are retrieved from this class object* @see Translation(), gstr(), getLangName(), getOtherLangs(), getMetaTags*//*** Strings of the given page array** This one is for fast access to cached strings for specified page** @var array string $Strings*/var $Strings = array();/*** Page identifier** @var string $PageName*/var $PageName = '';/*** Language identifier** @var string $LanguageID*/var $LanguageID = '';/*** Connection to database** @var object DB $db*/var $db;/*** Is true if the connection was reused, not made from the class** @var int $ConnectionReused*/var $ConnectionReused;/*** The string that will be displayed, if no string has been found in the* DB for specified string_id* @var string $ErrorText*/var $ErrorText;/*** The array with table and column names** The table may have following items:** 'langsavail' - table, in which all the information of the possible languages* is kept. This array item may be the string - then the structure of the table* remains as original, but the name is specified here; or the array with the* following items:* 'name' - the name of the table - default is 'tr_langsavail'* 'lang_id' - the column that stores the language identifier - default* is 'lang_id'* 'lang_name' - the column that stores the language name - default* is 'name'* 'metatags' - the column that stores meta tags for the pages in specified* language - default is 'metatags'* 'errortext' - the column that stores the text that will be displayed in case* if some text will not be found in the DB - default is 'errortext'** 'strings_XX' - table, in which the strings of language "XX" (the* corresponding lang_id) are kept. This array item may be the string - then* the structure of the table remains as original, but the name is specified* here; or the array with the following items:* 'name' - the name of the table - default is 'tr_strings_XX'* 'page_id' - the page identifier - default is 'page_id'.* 'string_id' - the string indetifier - default is 'string_id'.* 'string' - the string itself - default is 'string'.** This parameter in fact has impact only if the DB is used as the strings* repository. The defaults are set in the way that the method is compatible* with lower versions.** @var array $CustomTables*/var $TableDefinitions;/*** Class constructor** @param string $PageName the page identifier. It identifies* strings connected with specific page on the site* @param string $LanguageID language id. All the languages* are stored on the database on specific ID's.* @since version 1.2.1* @param string $pear_DSN This might be 3 types: the PEAR DSN* string form making the connection; the PEAR DB connection handle;* the string has the following format:* gettext://LOCALE:LANG:BINDTXTDOMAIN:TXTDOMAINFILE:TXTDOMAIN:CFGFILE* for using the native PHP gettext support.* @param array $CustomTables This is the array of the names of the tables and* optionally the names of columns. It contains the following elements:*/function Translation($PageName, $LanguageID, $pear_DSN, $CustomTables = 0){$this->PageName = $PageName;$this->LanguageID = $LanguageID;if (!DB::isConnection($pear_DSN)) {$this->db = DB::connect($pear_DSN);$this->ConnectionReused = 0;} else {$this->db = $pear_DSN;$this->ConnectionReused = 1;}if (DB::isError($this->db)) {die ($this->db->getMessage());}$this->TableDefinitions = array('langsavail' => array('name' => 'tr_langsavail','lang_id' => 'lang_id','lang_name' => 'name','metatags' => 'metatags','errortext' => 'errortext'));if (is_array($CustomTables['langsavail'])) {$this->TableDefinitions['langsavail']['name'] = isset($CustomTables['langsavail']['name']) ? $CustomTables['langsavail']['name'] : 'tr_langsavail';$this->TableDefinitions['langsavail']['lang_id'] = isset($CustomTables['langsavail']['lang_id']) ? $CustomTables['langsavail']['lang_id'] : 'lang_id';$this->TableDefinitions['langsavail']['lang_name'] = isset($CustomTables['langsavail']['lang_name']) ? $CustomTables['langsavail']['lang_name'] : 'lang_name';$this->TableDefinitions['langsavail']['metatags'] = isset($CustomTables['langsavail']['metatags']) ? $CustomTables['langsavail']['metatags'] : 'metatags';$this->TableDefinitions['langsavail']['errortext'] = isset($CustomTables['langsavail']['errortext']) ? $CustomTables['langsavail']['errortext'] : 'errortext';} elseif (!empty($CustomTables['langsavail'])) {$this->TableDefinitions['langsavail']['name'] = $CustomTables['langsavail'];}$result = $this->db->query('SELECT ' . $this->TableDefinitions['langsavail']['lang_id'] . ' FROM ' . $this->TableDefinitions['langsavail']['name']);if (DB::isError($result)) {die ($result->getMessage());}while ($row = $result->fetchRow()) {$this->TableDefinitions['strings_'.$row[0]] = array('name' => 'tr_strings_'.$row[0],'page_id' => 'page_id','string_id' => 'string_id','string' => 'string');if (is_array($CustomTables['strings_'.$row[0]])) {$this->TableDefinitions['strings_'.$row[0]]['name'] = isset($CustomTables['strings_'.$row[0]]['name']) ? $CustomTables['strings_'.$row[0]]['name'] : 'strings_'.$row[0];$this->TableDefinitions['strings_'.$row[0]]['page_id'] = isset($CustomTables['strings_'.$row[0]]['page_id']) ? $CustomTables['strings_'.$row[0]]['page_id'] : 'page_id';$this->TableDefinitions['strings_'.$row[0]]['string_id'] = isset($CustomTables['strings_'.$row[0]]['string_id']) ? $CustomTables['strings_'.$row[0]]['string_id'] : 'string_id';$this->TableDefinitions['strings_'.$row[0]]['string'] = isset($CustomTables['strings_'.$row[0]]['string']) ? $CustomTables['strings_'.$row[0]]['string'] : 'string';} elseif (!empty($CustomTables['strings_'.$row[0]])) {$this->TableDefinitions['strings_'.$row[0]]['name'] = $CustomTables['strings_'.$row[0]];}}$result = $this->db->query('SELECT ' . $this->TableDefinitions['strings_' . $LanguageID]['string_id'] . ', ' . $this->TableDefinitions['strings_' . $LanguageID]['string'] . ' FROM ' . $this->TableDefinitions['strings_' . $LanguageID]['name'] . ' WHERE ' . $this->TableDefinitions['strings_' . $LanguageID]['page_id'] . " = '$PageName' OR " . $this->TableDefinitions['strings_' . $LanguageID]['page_id'] . " = ''");if (DB::isError($result)) {die ($result->getMessage());}while ($row = $result->fetchRow()) {$this->Strings[$row[0]] = $row[1];}$this->ErrorText = $this->db->getOne('SELECT ' . $this->TableDefinitions['langsavail']['errortext'] . ' FROM ' . $this->TableDefinitions['langsavail']['name'] . ' WHERE ' . $this->TableDefinitions['langsavail']['lang_id'] . " = '$LanguageID'");}/*** Class destructor** @since version 1.2.1*/function _Translation(){if (! $this->ConnectionReused) {$this->db->disconnect();}}/*** Translated string retrieval** Retrieves the string basing on string identifier (string_id) or by* page_id.string_id. It means the strings_id may be specified in 2 ways:* - as normal string_id - then the string is retrieved from the cached version* of strings in the current page_id* - as [page_id].[string_id] - then teh strings is retrieved from the DB by getting* it from the given page_id. The additional optimization mechanism checks* if the page_id is not the same, as the current - if it is - the string will still be* retrieved from the cached version.* Also in the Params array there can be the item 'lang_id'. If not 'action' has* been given then the string from specified lang_id (in specified language)* will be retrieved. This solution is not recommended for common usage* (e.g. for the whole pages) as this will not use the cached in the constructor* strings, but will make another query to the DB for the specified query.* Another item that can be this array is 'action'. This specified special* actions that should be performed. The special actions can be the following:* 'normal' - this is default setting. It means that method will act as if this* item was not given.* 'translate' - this will couse, that the $StringName will not be the* string_id, but the string itself. This must be set only together with* 'lang_id' item. Method will try to find the specified string in the foreign* (specified in lang_id) language and will retrieve the corresponding string in* the current language. This solution is not recommended for common usage* (e.g. for the whole pages) as this will not use the cached in the constructor* strings, but will make another query to the DB for the specified query.* Item 'optimization' is used to specify the optimization of the queries -* if the main load should be performed by the PHP server (by doing more, but* less complicated queries) or DB server (PHP is sending only one, but* complicated query). This one is used only together with specified 'lang_id'* and 'action'=>'translate' - as this performs more operations, then other* queries. It can have following values:* 'php' - the default setting, cousing PHP to make 2 (or 3 if the string will* be found in some other page_id then the current) uncomplicated queries. This* is recommened if the DB server is the same machine as the PHP server.* 'db' - this couses PHP to make only 1, but comlicated query. This is* recommended if the DB server is separate machine, then PHP server. WARNING:* This will not work with MySQL DB server and Db servers, that does not* supports nested SELECTs (SELECT ... FROM ... WHERE sth = (SELECT...))* Another parameters that might be specified in the $Params array are:* 'ParameterPrefix' - is the prefix string for parameter - default is '&&'* 'ParameterPostfix' - is the postfix string for parameter - default is '&&'** @param string $StringName string identifier - unique for the page as well as for the strings, that are available on all the pages.* @param array string $Params string may be parametrized - and the paraters, that will be "inserted" into string may be typen into this array. It means, that &&1&& string will be replaced by 1st array element; string &&2&& will be replaced by 2nd array element; string &&3&& will be replaced by 3rd array element etc.* @return string retrieved string*/function gstr($StringName, $Params = array()){if (($returnstring = $this->Strings[$StringName]) == '') {$returnstring = $this->ErrorText;}if (($eregged = ereg("([_a-zA-Z]*)\.([_a-zA-Z]*)", $StringName, $regs)) && $Params['action'] != 'translate') {if ($reg[2] == $this->PageName) {if (($returnstring = $this->Strings[$StringName]) == '') {$returnstring = $this->ErrorText;}} else {$returnstring = $this->db->getOne('SELECT ' . $this->TableDefinitions['strings_' . $this->LanguageID]['string'] . ' FROM ' . $this->TableDefinitions['strings_' . $this->LanguageID]['name'] . ' WHERE ' . $this->TableDefinitions['strings_' . $this->LanguageID]['page_id'] . " = '" . $regs[1] . "' AND " . $this->TableDefinitions['strings_' . $this->LanguageID]['string_id'] . " = '" . $regs[2] . "'");if (DB::isError($returnstring)) {$returnstring = $this->ErrorText;}}}$i = 0;if (count($Params) > 0 && ! $eregged) {if (!empty($Params['lang_id']) && (empty($Params['action']) || $Params['action'] == 'normal')) {$returnstring = $this->db->getOne('SELECT ' . $this->TableDefinitions['strings_' . $Params['lang_id']]['string'] . ' FROM ' . $this->TableDefinitions['strings_' . $Params['lang_id']]['name'] . ' WHERE ' . $this->TableDefinitions['strings_' . $Params['lang_id']]['page_id'] . " = '" . $this->PageName . "' AND " . $this->TableDefinitions['strings_' . $Params['lang_id']]['string_id'] . " = '" . $StringName . "'");if (DB::isError($returnstring)) {$returnstring = $this->ErrorText;}}if (!empty($Params['lang_id']) && $Params['action'] == 'translate' && !$eregged) {if (empty($Params['optimization']) || $Params['optimization'] == 'php') {$PageID = $this->db->getOne('SELECT ' . $this->TableDefinitions['strings_' . $Params['lang_id']]['page_id'] . ' FROM ' . $this->TableDefinitions['strings_' . $Params['lang_id']]['name'] . ' WHERE ' . $this->TableDefinitions['strings_' . $Params['lang_id']]['string'] . " = '" . $StringName . "'");$StringID = $this->db->getOne('SELECT ' . $this->TableDefinitions['strings_' . $Params['lang_id']]['string_id'] . ' FROM ' . $this->TableDefinitions['strings_' . $Params['lang_id']]['name'] . ' WHERE ' . $this->TableDefinitions['strings_' . $Params['lang_id']]['string'] . " = '" . $StringName . "'");if (empty($PageID) || $PageID == $this->PageName) {if (($returnstring = $this->Strings[$StringID]) == '') {$returnstring = $this->ErrorText;}} else {$returnstring = $this->db->getOne('SELECT ' . $this->TableDefinitions['strings_' . $this->LanguageID]['string'] . ' FROM ' . $this->TableDefinitions['strings_' . $this->LanguageID]['name'] . ' WHERE ' . $this->TableDefinitions['strings_' . $this->LanguageID]['page_id'] . " = '" . $PageID . "' AND " . $this->TableDefinitions['strings_' . $this->LanguageID]['string_id'] . " = '" . $StringID . "'");if (DB::isError($returnstring)) {$returnstring = $this->ErrorText;}}} elseif ($Params['optimization'] == 'db') {$returnstring = $this->db->getOne('SELECT ' . $this->TableDefinitions['strings_' . $this->LanguageID]['string'] . ' FROM ' . $this->TableDefinitions['strings_' . $this->LanguageID]['name'] . ' WHERE ' . $this->TableDefinitions['strings_' . $this->LanguageID]['page_id'] . " = (" . "SELECT " . $this->TableDefinitions['strings_' . $Params['lang_id']]['page_id'] . ' FROM ' . $this->TableDefinitions['strings_' . $Params['lang_id']]['name'] . ' WHERE ' . $this->TableDefinitions['strings_' . $Params['lang_id']]['string'] . " = '" . $StringName . "'" . ") AND " . $this->TableDefinitions['strings_' . $this->LanguageID]['string_id'] . " = (" . "SELECT " . $this->TableDefinitions['strings_' . $Params['lang_id']]['string_id'] . ' FROM ' . $this->TableDefinitions['strings_' . $Params['lang_id']]['name'] . ' WHERE ' . $this->TableDefinitions['strings_' . $Params['lang_id']]['string'] . " = '" . $StringName . "'" . ")");if (DB::isError($returnstring)) {$returnstring = $this->ErrorText;}}}if (!isset($Params['ParameterPrefix'])) {$Params['ParameterPrefix'] = '&&';}if (!isset($Params['ParameterPostfix'])) {$Params['ParameterPostfix'] = '&&';}while(!empty($Params[$i])) {$returnstring = str_replace($Params['ParameterPrefix'] . ++$i . $Params['ParameterPostfix'], $Params[$i-1], $returnstring);}}return $returnstring;}/*** Active language name retrieval** Retrieves the name of active language** @return string current active language name or PEAR_ERROR object in case of problems*/function getLangName(){$result = $this->db->getRow('SELECT ' . $this->TableDefinitions['langsavail']['lang_name'] . ' FROM ' . $this->TableDefinitions['langsavail']['name'] . ' WHERE ' . $this->TableDefinitions['langsavail']['lang_id'] . " = '" . $this->LanguageID . "'");if (DB::isError($result)) {return $result;}return $result[0];}/*** Other languages retrieval** Retrieves names of all other languages, not the active.** @return array 2-dimensional array (0..)('id', 'name') for all the languages defined in DB but the current selected one. In case of DB error - returns PEAR_ERROR object.*/function getOtherLangs(){$result = $this->db->query('SELECT ' . $this->TableDefinitions['langsavail']['lang_id'] . ", " . $this->TableDefinitions['langsavail']['lang_name'] . ' FROM ' . $this->TableDefinitions['langsavail']['name'] . ' WHERE ' . $this->TableDefinitions['langsavail']['lang_id'] . " <> '" . $this->LanguageID . "'");if (DB::isError($result)) {return ($result->getMessage());}$i = 0;while($row = $result->fetchRow()) {$returnarray[$i]['id'] = $row[0];$returnarray[$i++]['name'] = $row[1];}return $returnarray;}/*** META tags retrieval** Retrievs the META tags that should be added on the top of translated page, so the translated characters will be correctly displayed on client's browser.** @return string with configured in DB META tags for selected language. In case of DB error - returns PEAR_ERROR object.*/function getMetaTags(){$result = $this->db->getRow('SELECT ' . $this->TableDefinitions['langsavail']['metatags'] . ' FROM ' . $this->TableDefinitions['langsavail']['name'] . ' WHERE ' . $this->TableDefinitions['langsavail']['lang_id'] . " = '" . $this->LanguageID . "'");if (DB::isError($result)) {return ($result->getMessage());}return $result[0];}}?>