* @author Rolf 'Red' Ochsenbein * @copyright 2004-2007 Lorenzo Alberton, Rolf 'Red' Ochsenbein * @license http://www.debian.org/misc/bsd.license BSD License (3 Clause) * @version CVS: $Id$ * @link http://pear.php.net/package/Translation2 */ /** * Load Translation2 decorator base class */ require_once 'Translation2/Decorator.php'; /** * Decorator to provide a fallback text for empty strings. * * If the string is empty, return the defaultText parameter. * If the defaultText parameter is empty too, then return * "$emptyPostfix.$outputString.$emptyPrefix", the three variables * being class properties you can set to a custom string. * * @category Internationalization * @package Translation2 * @author Lorenzo Alberton * @author Rolf 'Red' Ochsenbein * @copyright 2004-2007 Lorenzo Alberton, Rolf 'Red' Ochsenbein * @license http://www.debian.org/misc/bsd.license BSD License (3 Clause) * @version CVS: $Id$ * @link http://pear.php.net/package/Translation2 */ class Translation2_Decorator_DefaultText extends Translation2_Decorator { // {{{ class vars /** * String appended to the returned string when the string is empty * and it's replaced by its $stringID. It can be used to mark unreplaced * strings. * @var string * @access protected */ var $emptyPostfix = ''; /** * String prepended to the returned string when the string is empty * and it's replaced by its $stringID. It can be used to mark unreplaced * strings. * @var string * @access protected */ var $emptyPrefix = ''; /** * String to output when there was no translation * %stringID% will be replaced with the stringID * %stringID_url% will replaced with a urlencoded stringID * %url% will be replaced with the targeted url * @var string * @access protected */ //var $outputString = '%stringID%(T)'; var $outputString = '%stringID%'; /** * Targeted URL of strings without translations * @var string * @access protected */ var $url = '#'; // }}} // {{{ get() /** * Get translated string * * If the string is empty, return the $defaultText if not empty, * the $stringID otherwise. * * @param string $stringID string ID * @param string $pageID page/group ID * @param string $langID language ID * @param string $defaultText Text to display when the string is empty * * @return string */ function get($stringID, $pageID = TRANSLATION2_DEFAULT_PAGEID, $langID = null, $defaultText = '') { if ($pageID == TRANSLATION2_DEFAULT_PAGEID) { $pageID = $this->translation2->currentPageID; } $str = $this->translation2->get($stringID, $pageID, $langID); if (!empty($str)) { return $str; } if (!empty($defaultText)) { return $this->_replaceParams($defaultText); } $search = array( '%stringID%', '%stringID_url%', '%pageID_url%', '%url%' ); $replace = array( $stringID, urlencode($stringID), urlencode($pageID), $this->url ); return $this->_replaceParams( $this->emptyPrefix .str_replace($search, $replace, $this->outputString) .$this->emptyPostfix ); //$str = (empty($defaultText) ? $this->emptyPrefix.$stringID.$this->emptyPostfix : $defaultText); } // }}} // {{{ getPage() /** * Replace empty strings with their $stringID * * @param string $pageID page/group ID * @param string $langID language ID * * @return array */ function getPage($pageID = TRANSLATION2_DEFAULT_PAGEID, $langID = null) { $data = $this->translation2->getPage($pageID, $langID); return $this->replaceEmptyStringsWithKeys($data); } // }}} // {{{ getStringID /** * Get the stringID for the given string. This method is the reverse of get(). * If the requested string is unknown to the system, * the requested string will be returned. * * @param string $string This is NOT the stringID, this is a real string. * The method will search for its matching stringID, * and then it will return the associate string in the * selected language. * @param string $pageID page/group ID * * @return string */ function &getStringID($string, $pageID = TRANSLATION2_DEFAULT_PAGEID) { if ($pageID == TRANSLATION2_DEFAULT_PAGEID) { $pageID = $this->translation2->currentPageID; } $stringID = $this->storage->getStringID($string, $pageID); if (empty($stringID)) { $stringID = $string; } return $stringID; } } ?>