Helper 是 CodeIgniter 裡最沒有心理負擔的功能之一:它就是一堆為特定任務準備好的普通函數,不需要理解類別繼承,也不需要物件導向思維,載入之後直接呼叫即可。本文把它的運作機制、載入方式與擴展技巧一次講清楚。
顧名思義,helper 就是幫你完成各類特定任務的一系列函數。每個 helper 檔案都是一組功能相近的函數集合,例如負責產生連結的 URL Helper、生成表單的 Form Helper、處理文字輸出的 Text Helper、讀寫 cookie 的 Cookie Helper,以及操作檔案的 File Helper。
和大多數框架不同,CodeIgniter 的 helper 並不是用類別實作的,而是最樸素的程序式函數。每個 helper 專司一項任務,彼此之間不互相依賴,也不需要被實例化。
預設情況下 CodeIgniter 不會主動載入任何 helper 檔案,所以使用前必須先載入。載入之後,這些函數即在全域可用,不論在 controller 還是 view 裡都能直接呼叫。
helper 檔案通常放在 system/helpers 或 application/helpers。CodeIgniter 會先在 application/helpers 尋找同名檔案,找不到才回頭載入 system/helpers 下的版本——這個優先順序正是你能覆寫系統函數的原因。
載入方式相當直觀:
$this->load->helper('name');
其中 name 是 helper 檔案的名稱,不含 .php 副檔名,也不含 helper 這個字尾。舉例來說,要載入 url_helper.php:
$this->load->helper('url');
你可以在 controller 的任何位置載入 helper,技術上甚至在 view 檔案裡也行(但並不建議)。實務上的建議是:在 controller 的建構子中一次載入,讓後續所有方法都能直接使用;或者更精簡一些,在真正要用到的那個方法裡才載入。
要注意的是,載入函數本身沒有回傳值。別把它指派給變數,直接呼叫就對了。
需要多個 helper 時,傳入陣列即可:
$this->load->helper(array('helper1', 'helper2', 'helper3'));
如果某些 helper 幾乎每個請求都會用到,可以讓 CodeIgniter 自動載入。開啟 application/config/autoload.php,把名稱加進 $autoload['helper'] 陣列即可。
不過自動載入清單不宜過長——每個常駐的 helper 都會增加每個請求的執行成本。
載入之後,就像呼叫任何普通函數一樣使用它們。以 anchor() 產生連結為例:
<?php echo anchor('blog/comments', 'Click Here'); ?>
這裡 'Click Here' 是連結文字,'blog/comments' 是目標 URI。
這裡有個容易忽略的陷阱:helper 中的函數位於全域命名空間,因此命名必須有足夠的辨識度。如果同時載入多個 helper,而其中出現了同名函數,PHP 會直接抛出語法錯誤,頁面的表現就是一片空白——這是 PHP 的致命錯誤,不會有友善的提示。
當你只想在既有 helper 上新增一兩個函數,或修改其中某個函數的行為時,重寫一整個 helper 顯然不划算。CodeIgniter 提供了一種約定式的擴展機制:在 application/helpers/ 下建立一個新檔案,檔名在被擴展的 helper 名稱前加上 MY_ 前綴。
嚴格說來,「擴展」這個詞用在這裡並不精確——helper 的函數是程序式且彼此獨立的,在傳統物件導向語境下無所謂擴展。但在 CodeIgniter 的載入機制下,只要你的 application/helpers 裡有同名檔案,它就會優先被載入,於是你實際上達到了新增與覆寫的效果。
舉例來說,要擴展 Array Helper,建立 application/helpers/MY_array_helper.php:
<?php
// any_in_array() 原本不存在於 Array Helper,這裡是新增函數
function any_in_array($needle, $haystack) {
$needle = (is_array($needle)) ? $needle : array($needle);
foreach ($needle as $item) {
if (in_array($item, $haystack)) {
return TRUE;
}
}
return FALSE;
}
// random_element() 原本已存在,這裡是覆寫原生實作
function random_element($array) {
shuffle($array);
return array_pop($array);
}
一個實務上的注意點:如果你覆寫了某個系統函數,記得在自訂實作裡保留原本的行為契約(參數順序、回傳型別),否則框架其他部分呼叫它時可能出錯。
MY_ 並非硬性規定,而是可設定的。這個前綴同時也用於擴展自訂函式庫與核心類別。開啟 application/config/config.php,找到這一行:
$config['subclass_prefix'] = 'MY_';
改成你想要的字串即可。
但有一條紅線:所有 CodeIgniter 自帶的函式庫都以 CI_ 作為前綴,因此千萬不要把自己的前綴設成 CI_,否則會與系統命名空間碰撞,引發難以追查的衝突。
Helper 的設計哲學其實很 CodeIgniter:不做過度抽象,用最少的機制解決問題。理解三件事就能用得順手——載入方式、檔案搜尋的優先順序(application 先於 system),以及前綴約定。掌握這幾點,你就能在完全不動核心程式碼的前提下,把框架調整成自己順手的樣子。