Smarty緩衝處理函數


Cache Handler Function

緩衝處理函數

作爲一個可選擇使用的默認基於文本的緩衝機制,你可以定製或者自定義緩衝處理函數來進行讀、寫、清除緩衝文件。

 

如果要在應用程序下建立一個函數,SMARTY將會使用一個緩衝處理。設置這個函數名爲 $cache handler func 中類變量名。Smarty將使用這個函數來處理緩衝數據。第一個參數不管是‘讀’,‘寫’,‘清除’,都是動態的。第二個參數是 Smarty 對象。第三個參數是緩衝的內容。在進行寫操作之前,Smarty 傳遞這些緩衝內容給這些參量。在進行讀操作之前,Smarty預處理那些緩衝數據相關或者封裝好了的函數。在進行清除操作之前,從他沒有使用起,就傳遞一個虛擬變量。第四個參數是模板文件名(需要讀和寫的文件),第五個函數是緩衝ID(額外選項),然後第六個參數是編譯的ID(額外選項)。

Note: The last parameter ($exp_time) was added in Smarty-2.6.0.

注意:最新的參數名 ($exp_time) 在Smarty-2.6.0中才加入的。

<?php
/*

example usage:
// wwww.yiibai.com
include('Smarty.class.php');
include('mysql_cache_handler.php');

$smarty = new Smarty;
$smarty->cache_handler_func = 'mysql_cache_handler';

$smarty->display('index.tpl');


mysql database is expected in this format:
	
create database SMARTY_CACHE;

create table CACHE_PAGES(
CacheID char(32) PRIMARY KEY,
CacheContents MEDIUMTEXT NOT NULL
);

*/

function mysql_cache_handler($action, &$smarty_obj, &$cache_content, $tpl_file=null, $cache_id=null, $compile_id=null, $exp_time=null)
{
	// set db host, user and pass here
	$db_host = 'localhost';
	$db_user = 'myuser';
	$db_pass = 'mypass';
	$db_name = 'SMARTY_CACHE';
	$use_gzip = false;
	
	// create unique cache id
	$CacheID = md5($tpl_file.$cache_id.$compile_id);
	
	if(! $link = mysql_pconnect($db_host, $db_user, $db_pass)) {
		$smarty_obj->_trigger_error_msg("cache_handler: could not connect to database");
		return false;
	}
	mysql_select_db($db_name);

	switch ($action) {
		case 'read':
			// save cache to database
			$results = mysql_query("select CacheContents from CACHE_PAGES where CacheID='$CacheID'");
			if(!$results) {
				$smarty_obj->_trigger_error_msg("cache_handler: query failed.");			
			}
			$row = mysql_fetch_array($results,MYSQL_ASSOC);
			
			if($use_gzip && function_exists("gzuncompress")) {
				$cache_contents = gzuncompress($row["CacheContents"]);
			} else {
				$cache_contents = $row["CacheContents"];
			}
			$return = $results;
			break;
		case 'write':
			// save cache to database
			
			if($use_gzip && function_exists("gzcompress")) {
				// compress the contents for storage efficiency
				$contents = gzcompress($cache_content);
			} else {
				$contents = $cache_content;
			}
			$results = mysql_query("replace into CACHE_PAGES values(
							'$CacheID',
							'".addslashes($contents)."')
						");
			if(!$results) {
				$smarty_obj->_trigger_error_msg("cache_handler: query failed.");			
			}
			$return = $results;
			break;
		case 'clear':
			// clear cache info
			if(empty($cache_id) && empty($compile_id) && empty($tpl_file)) {
				// clear them all
				$results = mysql_query("delete from CACHE_PAGES");			
			} else {
				$results = mysql_query("delete from CACHE_PAGES where CacheID='$CacheID'");			
			}
			if(!$results) {
				$smarty_obj->_trigger_error_msg("cache_handler: query failed.");			
			}
			$return = $results;
			break;
		default:
			// error, unknown action
			$smarty_obj->_trigger_error_msg("cache_handler: unknown action "$action"");
			$return = false;
			break;
	}
	mysql_close($link);
	return $return;
	
}

?>