Subversion-Projekte lars-tiefland.php_share

<?php

/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */

/**

 * Contains the Translation2_Decorator_CacheMemory 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-2007 Lorenzo Alberton

 * @license   http://www.debian.org/misc/bsd.license  BSD License (3 Clause)

 * @version   CVS: $Id: CacheMemory.php 305985 2010-12-05 22:55:33Z clockwerx $

 * @link      http://pear.php.net/package/Translation2

 */

/**

 * Load Translation2 decorator base class

 */

require_once 'Translation2/Decorator.php';

/**

 * Allows redefinition of alternate key for empty pageID

 */

if (!defined('TRANSLATION2_EMPTY_PAGEID_KEY')) {

    define('TRANSLATION2_EMPTY_PAGEID_KEY', 'array_key_4_empty_pageID');

}

/**

 * Allows redefinition of alternate key for null pageID

 */

if (!defined('TRANSLATION2_NULL_PAGEID_KEY')) {

    define('TRANSLATION2_NULL_PAGEID_KEY', 'array_key_4_null_pageID');

}

/**

 * Decorator to cache fetched data in memory

 *

 * @category  Internationalization

 * @package   Translation2

 * @author    Lorenzo Alberton <l.alberton@quipo.it>

 * @copyright 2004-2007 Lorenzo Alberton

 * @license   http://www.debian.org/misc/bsd.license  BSD License (3 Clause)

 * @version   CVS: $Id: CacheMemory.php 305985 2010-12-05 22:55:33Z clockwerx $

 * @link      http://pear.php.net/package/Translation2

 */

class Translation2_Decorator_CacheMemory extends Translation2_Decorator

{

    // {{{ class vars

    /**

     * Translated strings array

     * Used for cache purposes.

     * No parameter substitution or fallback langs here.

     * @var array

     * @access protected

     */

    var $rawData = array();

    /**

     * set prefetch on/off

     * @var boolean

     * @access protected

     */

    var $prefetch = true;

    // }}}

    // {{{ _getPageIDKey()

    /**

     * return a valid array key based on pageID value

     *

     * @param mixed $pageID (string or null)

     *

     * @return string

     * @access private

     */

    function _getPageIDKey($pageID)

    {

        if (is_null($pageID)) {

            return TRANSLATION2_NULL_PAGEID_KEY;

        }

        if (empty($pageID)) {

            return TRANSLATION2_EMPTY_PAGEID_KEY;

        }

        if ($pageID == TRANSLATION2_DEFAULT_PAGEID) {

            return $this->translation2->currentPageID;

        }

        return $pageID;

    }

    // }}}

    // {{{ getRaw()

    /**

     * Get translated string (as-is)

     *

     * First check if the string is cached, if not => fetch the page

     * from the container and cache it for later use.

     *

     * @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 = null)

    {

        $pageID_key = $this->_getPageIDKey($pageID);

        $langID_key = empty($langID) ? $this->translation2->lang['id'] : $langID;

        if (!array_key_exists($langID_key, $this->rawData)) {

            $this->rawData[$langID_key] = array();

        }

        if ($this->prefetch) {

            $this->getRawPage($pageID, $langID);

        }

        if (array_key_exists($pageID_key, $this->rawData[$langID_key])) {

            if (PEAR::isError($this->rawData[$langID_key][$pageID_key])) {

                return $this->rawData[$langID_key][$pageID_key];

            }

            $str = (isset($this->rawData[$langID_key][$pageID_key][$stringID]) ?

                    $this->rawData[$langID_key][$pageID_key][$stringID] : ''); //empty string or null value?

        } else {

            $str = $this->translation2->getRaw($stringID, $pageID, $langID, $defaultText);

        }

        return $str;

    }

    // }}}

    // {{{ get()

    /**

     * Get translated string

     *

     * First check if the string is cached, if not => fetch the page

     * from the container and cache it for later use.

     *

     * @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 get($stringID, $pageID = TRANSLATION2_DEFAULT_PAGEID, $langID = null, $defaultText = null)

    {

        $str = $this->getRaw($stringID, $pageID, $langID, $defaultText);

        return $this->_replaceParams($str);

    }

    // }}}

    // {{{ getRawPage()

    /**

     * Get the array of strings in a page

     *

     * First check if the strings are cached, if not => fetch the page

     * from the container and cache it for later use.

     *

     * @param string $pageID page/group ID

     * @param string $langID language ID

     *

     * @return array

     */

    function getRawPage($pageID = TRANSLATION2_DEFAULT_PAGEID, $langID = null)

    {

        $pageID_key = $this->_getPageIDKey($pageID);

        $langID_key = empty($langID) ? $this->translation2->lang['id'] : $langID;

        if (!array_key_exists($langID_key, $this->rawData)) {

            $this->rawData[$langID_key] = array();

        }

        if (!array_key_exists($pageID_key, $this->rawData[$langID_key])) {

            $this->rawData[$langID_key][$pageID_key] =

                $this->translation2->getRawPage($pageID, $langID);

        }

        return $this->rawData[$langID_key][$pageID_key];

    }

    // }}}

    // {{{ 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)

    {

        $pageID_key = $this->_getPageIDKey($pageID);

        $langID_key = empty($langID) ? $this->translation2->lang['id'] : $langID;

        $this->getRawPage($pageID, $langID);

        return $this->_replaceParams($this->rawData[$langID_key][$pageID_key]);

    }

    // }}}

}

?>