Viewing file:  Decorator.php (10.55 KB) -rw-rw-rw-
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
/**
* Contains the Translation2_Decorator base class
*
* PHP versions 4 and 5
*
* LICENSE: Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. The name of the author may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE FREEBSD PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* @category Internationalization
* @package Translation2
* @author Lorenzo Alberton <l.alberton@quipo.it>
* @copyright 2004-2005 Lorenzo Alberton
* @license http://www.debian.org/misc/bsd.license BSD License (3 Clause)
* @version CVS: $Id: Decorator.php 305985 2010-12-05 22:55:33Z clockwerx $
* @link http://pear.php.net/package/Translation2
*/
/**
* Translation2_Decorator. Base Decorator class for Translation2
*
* Extend this class to provide custom decorators.
* Some decorators are already bundled with the package.
*
* @category Internationalization
* @package Translation2
* @author Lorenzo Alberton <l.alberton@quipo.it>
* @copyright 2004-2005 Lorenzo Alberton
* @license http://www.debian.org/misc/bsd.license BSD License (3 Clause)
* @link http://pear.php.net/package/Translation2
* @abstract
*/
class Translation2_Decorator extends Translation2
{
// {{{ class vars
/**
* Translation2 object being decorated
* @var object
* @access protected
*/
var $translation2;
/**
* @var object
* @access protected
*/
var $storage;
/**
* @var array
* @access protected
*/
var $lang;
/**
* @var string
* @access protected
*/
var $currentPageID;
// }}}
// {{{ Constructor
/**
* Constructor
* Constructs the Translation2_Decorator
*
* @param object &$translation2 Translation2 object to decorate
*/
function Translation2_Decorator(& $translation2)
{
$this->translation2 = & $translation2;
//used for debug only
$this->storage = & $translation2->storage;
$this->currentPageID = & $translation2->currentPageID;
$this->lang = & $translation2->lang;
}
// }}}
// {{{ setOptions()
/**
* set Decorator options
*
* @param array $options decorator options
*
* @return self
*/
function setOptions($options=array())
{
if (is_array($options)) {
foreach ($options as $option => $value) {
$this->setOption($option, $value);
}
}
return $this;
}
// }}}
// {{{ setOption()
/**
* set Decorator option
*
* @param string $option option name
* @param mixed $value option value
*
* @return self
*/
function setOption($option, $value=null)
{
if (isset($this->$option)) {
$this->$option = $value;
} elseif (is_a($this->translation2, 'Translation2_Decorator')) {
$this->translation2->setOption($option, $value);
}
return $this;
}
// }}}
// {{{ setContainerOptions()
/**
* Set some storage driver options
*
* @param array $options storage driver options
*
* @return void
* @access protected
*/
function setContainerOptions($options)
{
$this->storage->_parseOptions($options);
}
// }}}
// {{{ getDecorator()
/**
* Return an instance of a decorator
*
* @param string $decorator Name of the decorator
* @param object $object instance [optional]
*
* @return object Decorator object reference
* @access public
*/
function & getDecorator($decorator)
{
if (func_num_args() > 1) {
$obj = func_get_arg(1);
$new_decorator =& $this->translation2->getDecorator($decorator, $obj);
} else {
$new_decorator =& $this->translation2->getDecorator($decorator, $this);
}
return $new_decorator;
}
// }}}
// {{{ setCharset()
/**
* Set charset used to read/store the translations
*
* @param string $charset character set (encoding)
*
* @return PEAR_Error on failure
*/
function setCharset($charset)
{
return $this->translation2->setCharset($charset);
}
// }}}
// {{{ setLang()
/**
* Set default language
*
* @param string $langID language ID
*
* @return true|PEAR_Error
*/
function setLang($langID)
{
return $this->translation2->setLang($langID);
}
// }}}
// {{{ setPageID($pageID)
/**
* Set default page
*
* @param string $pageID page/group ID
*
* @return void
*/
function setPageID($pageID = null)
{
$this->translation2->setPageID($pageID);
}
// }}}
// {{{ getLang()
/**
* Get language info
*
* @param string $langID language ID
* @param string $format ['name', 'meta', 'error_text', 'array']
*
* @return mixed [string | array], depending on $format
*/
function getLang($langID=null, $format='name')
{
return $this->translation2->getLang($langID, $format);
}
// }}}
// {{{ getLangs()
/**
* Get languages
*
* @param string $format ['ids', 'names', 'array']
*
* @return array
*/
function getLangs($format='name')
{
return $this->translation2->getLangs($format);
}
// }}}
// {{{ setParams()
/**
* Set parameters for next string
*
* @param array $params array of replacement parameters
*
* @return void
*/
function setParams($params = null)
{
$this->translation2->setParams($params);
}
// }}}
// {{{ getRaw()
/**
* Get translated string
*
* No filter is applied.
*
* @param string $stringID string ID
* @param string $pageID page/group ID
* @param string $langID language ID
* @param string $defaultText Text to display when the strings in both
* the default and the fallback lang are empty
*
* @return string
*/
function getRaw($stringID, $pageID = TRANSLATION2_DEFAULT_PAGEID, $langID = null, $defaultText = '')
{
return $this->translation2->getRaw($stringID, $pageID, $langID, $defaultText);
}
// }}}
// {{{ get()
/**
* Get translated string
*
* All the filters are applied.
*
* @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
* NB: This parameter is only used in the DefaultText decorator
*
* @return string
*/
function get($stringID, $pageID = TRANSLATION2_DEFAULT_PAGEID, $langID = null, $defaultText = '')
{
return $this->translation2->get($stringID, $pageID, $langID, $defaultText);
}
// }}}
// {{{ getRawPage()
/**
* Get the array of strings in a page
*
* Fetch the strings from the container, without any replacing
*
* @param string $pageID page/group ID
* @param string $langID language ID
*
* @return array
*/
function getRawPage($pageID = TRANSLATION2_DEFAULT_PAGEID, $langID = null)
{
return $this->translation2->getRawPage($pageID, $langID);
}
// }}}
// {{{ getPage()
/**
* Same as getRawPage, but resort to fallback language and
* replace parameters when needed
*
* @param string $pageID page/group ID
* @param string $langID language ID
*
* @return array
*/
function getPage($pageID = TRANSLATION2_DEFAULT_PAGEID, $langID = null)
{
$this->translation2->getPage($pageID, $langID);
}
// }}}
// {{{ _replaceParams()
/**
* Replace parameters in strings
*
* @param mixed $strings strings where the replacements must occur
*
* @return mixed
* @access protected
*/
function _replaceParams($strings)
{
return $this->translation2->_replaceParams($strings);
}
// }}}
// {{{ replaceEmptyStringsWithKeys()
/**
* Replace empty strings with their stringID
*
* @param array $strings array of strings to be replaced if empty
*
* @return array
* @access public
*/
function replaceEmptyStringsWithKeys($strings)
{
return $this->translation2->replaceEmptyStringsWithKeys($strings);
}
// }}}
// {{{ getStringID()
/**
* Get the stringID for the given string. This method is the reverse of get().
*
* @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)
{
return $this->translation2->getStringID($string, $pageID);
}
// }}}
// {{{ __clone()
/**
* Clone internal object references
*
* This method is called automatically by PHP5
*
* @return void
* @access protected
*/
function __clone()
{
$this->translation2 = clone($this->translation2);
}
// }}}
}
?>
|