拋磚引玉系列 -- smarty緩存控制

 拋磚引玉系列 -- smarty緩存控制

smarty提供了強大的緩存功能。但有時我們並不希望整篇文檔都被緩存，而是有選擇的緩存某一部分內容或某一部分內容不被緩存。例如你在頁面上端使用一個帶有廣告條位置的模板，廣告條可以包含任何HTML、圖象、FLASH等混合信息. 因此這裏不能使用一個靜態的鏈接，同時我們也不希望該廣告條被緩存. 這就需要在 insert 函數指定，同時需要一個函數取廣告條的內容信息。smarty也提供了這種緩存控制能力。

我們可以使用{insert}使模板的一部分不被緩存
可以使用$smarty->register_function($params,&$smarty)阻止插件從緩存中輸出，
還可以使用$smarty->register_block($params,&$smarty)使整篇頁面中的某一塊不被緩存。

下面我們真對一個簡單需求，分別說明這三種控制緩存輸出的方法。

需求：被緩存的文檔中當前時間不被緩存，隨每次刷新而變化。

1、使用insert函數使模板的一部分不被緩存
index.tpl:
<div>{insert name="get_current_time"}</div>

index.php
function insert_get_current_time(){
        return date("Y-m-d H:m:s");
}

$smarty=new smarty();
$smarty->caching = true;
if(!$smarty->is_cached()){
        .......
}
$smarty->display('index.tpl');

註解：
定義一個函數，函數名格式爲：inser_name(array $params, object &$smarty),
函數參數可選的，如果在模板的insert方法中需要加入其他屬性，就會作爲數組傳遞給用戶定義的函數。
如：{insert name='get_current_time' local='zh'}
在get_current_time函數中我們就可以通過$params['local']來獲得屬性值。
如果在get_current_time函數中需要用到當前smarty對象的方法或屬性，就可以通過第二個參數獲得。

這時你會發現index.tpl已被緩存，但當前時間卻隨每次刷新在不斷變化。

2、使用register_function阻止插件從緩存中輸出
index.tpl:
<div>{current_time}{/div}

index.php:
function smarty_function_current_time($params, &$smarty){
        return date("Y-m-d H:m:s");
}

$smarty=new smarty();
$smarty->caching = true;
$smarty->register_function('current_time','smarty_function_current_time',false);
if(!$smarty->is_cached()){
        .......
}
$smarty->display('index.tpl');

註解：
定義一個函數，函數名格式爲：smarty_type_name($params, &$smarty)
type爲function
name爲用戶自定義標籤名稱，在這裏是{current_time}
兩個參數是必須的，即使在函數中沒有使用也要寫上。兩個參數的功能同上。

3、使用register_block使整篇頁面中的某一塊不被緩存
index.tpl:
<div align='center'>
Page created: {"0"|date_format:"%D %H:%M:%S"}

{dynamic}
Now is: {"0"|date_format:"%D %H:%M:%S"}
... do other stuff ...
{/dynamic}

</div>

index.php:
function smarty_block_dynamic($param, $content, &$smarty) {
return $content;
}
$smarty = new Smarty;
$smarty->caching = true;
$smarty->register_block('dynamic', 'smarty_block_dynamic', false);
if(!$smarty->is_cached()){
        .......
}
$smarty->display('index.tpl');

註解：
定義一個函數，函數名格式爲：smarty_type_name($params, &$smarty)
type爲block
name爲用戶自定義標籤名稱,在這裏是{dynamic}
兩個參數是必須的，即使在函數中沒有使用也要寫上。兩個參數的功能同上。

4、總結
（1）對緩存的控制能力：
使用register_function和register_block能夠方便的控制插件輸出的緩衝能力，可以通過第三個參數控制是否緩存，默認是緩存的，需要我們顯示設置爲false，正如我們試驗中的所做的那樣“$smarty->register_function('current_time','smarty_function_current_time',false);”
但insert函數默認是不緩存的。並且這個屬性不能修改。從這個意義上講insert函數對緩存的控制能力似乎不如register_function和register_block強。
（2）使用方便性：
但是insert函數使用非常方便。不用顯示註冊，只要在當前請求過程中包含這個函數smarty就會自動在當前請求的過程中查找指定的函數。
當然register_function也可以做到不在運行時顯示註冊。但是那樣做的效果跟其他模版函數一樣，統統被緩存，並且不能控制。
如果你使用在運行時顯示調用register_function註冊自定義函數，那麼一定要在調用is_cached()方法前完成函數的註冊工作。
否則在is_cached()這一步緩存文檔將因爲找不到註冊函數而導致smarty錯誤。