<?php
/*=====================================================================*\
|| ###################################################################
|| # Blue Static ISSO Framework
|| # Copyright Š2002-[#]year[#] Blue Static
|| #
|| # This program is free software; you can redistribute it and/or modify
|| # it under the terms of the GNU General Public License as published by
|| # the Free Software Foundation; version [#]gpl[#] of the License.
|| #
|| # This program is distributed in the hope that it will be useful, but
|| # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|| # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|| # more details.
|| #
|| # You should have received a copy of the GNU General Public License along
|| # with this program; if not, write to the Free Software Foundation, Inc.,
|| # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|| ###################################################################
\*=====================================================================*/

/**
* File System Template System (TemplateFs.php)
*
* @package	ISSO
*/

require_once('ISSO/Template.php');
require_once('ISSO/Functions.php');

/**
* File System Template System
*
* This framework merely replaces the template loading functions with
* file-system based ones.
*
* @author		Blue Static
* @copyright	Copyright Š2002 - [#]year[#], Blue Static
* @version		$Revision$
* @package		ISSO
* 
*/
class BSTemplateFs extends BSTemplate
{
	/**
	* The path, from the path of the application, where templates are stored
	* @var	string
	*/
	private $templateDir = '';
	
	/**
	* The extension all the template files have
	* @var	string
	*/
	private $extension = 'tpl';
	
	// ###################################################################
	/**
	* Sets the template directory name
	*
	* @param	string	Template directory name
	*/
	public function setTemplateDirectory($dir)
	{
		$this->templateDir = BSFunctions::FetchSourcePath($dir);
	}
	
	// ###################################################################
	/**
	* Sets the file extension for the templates
	*
	* @param	string	File extension
	*/
	public function setExtension($ext)
	{
		$this->extension = $ext;
	}
	
	// ###################################################################
	/**
	* Takes an array of template names, loads them, and then stores a
	* parsed version for optimum speed.
	*
	* @param	array	List of template names to be cached
	*/
	public function cache($namearray)
	{
		if (sizeof($this->cache) > 0)
		{
			trigger_error('You cannot cache templates more than once per initialization');
		}
		else
		{
			foreach ($namearray AS $name)
			{
				$template = $this->_loadTemplate($name);
				$template = $this->_parseTemplate($template);
				$this->cache["$name"] = $template;
				$this->usage["$name"] = 0;
			}
		}
	}
	
	// ###################################################################
	/**
	* Loads a template from the file system from the specified
	* $templatedir with the file extension $extension
	*
	* @param	string	The name of the template call
	*/
	private function _loadTemplate($name)
	{
		$path = BSRegister::GetAppPath() . $this->templateDir . $name . '.' . $this->extension;
		if (is_file($path))
		{
			if (($template = @file_get_contents($path)) !== false)
			{
				return $template;
			}
			else
			{
				trigger_error("Could not load the template '$path'");
				exit;
			}
		}
		else
		{
			trigger_error("Could not load the template '$path'");
			exit;
		}
	}
}

/*=====================================================================*\
|| ###################################################################
|| # $HeadURL$
|| # $Id$
|| ###################################################################
\*=====================================================================*/
?>