<?php
/**
 * patTemplate Template cache that stores data i18n aware on filesystem
 *
 * $Id$
 *
 * @package		patTemplate
 * @subpackage	Caches
 * @author gERD Schaufelberger <gerd@exit0.net>
 */

/**
 * patTemplate Template cache that stores data i18n aware on filesystem
 *
 * "FileLocale" is pretty much the same as "File", it simply appends the current language 
 * name to the cache file's name.
 *
 * Possible parameters for the cache are:
 * - cacheFolder : set the folder from which to load the cache
 * - lifetime : seconds for which the cache is valid, if set to auto, it will check
 *   whether the cache is older than the original file (if the reader supports this)
 * - prefix for the filenames
 *
 * @package		patTemplate
 * @subpackage	Caches
 * @author gERD Schaufelberger <gerd@exit0.net>
 */
class patTemplate_TemplateCache_FileLocale extends patTemplate_TemplateCache
{
   /**
	* parameters of the cache
	*
	* @access	private
	* @var		array
	*/
	var $_params = array(
						 'cacheFolder' => './cache',
						 'lifetime'	   => 'auto',
						 'prefix'	   => '',
						 'filemode'    => null
						);


   /**
	* load template from cache
	*
	* @access	public
	* @param	string			cache key
	* @param	integer			modification time of original template
	* @return	array|boolean	either an array containing the templates or false cache could not be loaded
	*/
	function load($key, $modTime = -1)
	{
		$filename = $this->_getCachefileName( $key );
		if (!file_exists($filename) || !is_readable($filename)) {
			return false;
		}

		$generatedOn = filemtime( $filename );
		$ttl		 = $this->getParam('lifetime');
		if ($ttl == 'auto') {
			if ($modTime < 1) {
				return false;
			}
			if ($modTime > $generatedOn) {
				return false;
			}
			return unserialize( wbFile::load( $filename ) );
		} elseif(is_int( $ttl)) {
			if ($generatedOn + $ttl < time()) {
				return false;
			}
			return unserialize( wbFile::load( $filename ) );
		}
		
		return false;
	}
	
   /**
	* write template to cache
	*
	* @access	public
	* @param	string		cache key
	* @param	array		templates to store
	* @return	boolean		true on success
	*/
	function write( $key, $templates )
	{
        $cacheFile = $this->_getCachefileName($key);
        wbFile::save( $cacheFile, serialize( $templates ) );
		return true;
	}

   /**
	* get the cache filename
	*
	* @access	private
	* @param	string		cache key
	* @return	string		cache file name
	*/
	function _getCachefileName( $key )
	{
        $lang   =   'C';
        $sess   =   patSession::singleton();
        if( $sess->has( 'wb:lang' ) ) {
            $lang   =   $sess->get( 'wb:lang' );
            $lang   =   $lang['lang'];
        }
		return $this->getParam( 'cacheFolder' ) . '/' . $this->getParam( 'prefix' ).$key . '.' . $lang;
	}
}
?>