全域函數與常數¶
CodeIgniter 提供了一些全域函數與變數讓你在任何時候都可以使用，這些函數和變數不需要載入任何額外的程式庫或輔助函數。
全域函數¶
服務存取器¶
-
cache([$key])¶ 參數: - $key (string) – 想要從快取項目中取出的快取名稱。（可選）
傳回: 單獨指定的快取項目，或者是整個快取物件。
傳回型態: mixed
如果沒有提供 $key ，將會回傳快取引擎的實體。如果提供了 $key ，則會回傳現在儲存在快取中的 $key 的值，如果沒有找到，則會回傳 null 。
範例：
$foo = cache('foo'); $cache = cache();
參數: - $name (string) – Cookie name
- $value (string) – Cookie value
- $options (array) – Cookie options
傳回型態: Cookie傳回: CookieinstanceThrows: CookieExceptionSimpler way to create a new Cookie instance.
參數: - $cookies (array) – If
getGlobalisfalse, this is passed toCookieStore’s constructor. - $getGlobal (bool) – If
false, creates a new instance ofCookieStore.
傳回型態: CookieStore傳回: Instance of
CookieStoresaved in the currentResponse, or a newCookieStoreinstance.Fetches the global
CookieStoreinstance held byResponse.- $cookies (array) – If
-
env($key[, $default=null])¶ 參數: - $key (string) – 需要檢索的環境變數名稱
- $default (mixed) – 如果沒有找到值，預設回傳的值。
傳回: 環境變數，預設值或為 null 。
傳回型態: mixed
用於檢索已經被設定過的環境變數，如果沒有找到，則會回傳一個預設值。將會是實際的布林值，而不是以字串表示。
當與 .env 檔案結合使用時，這個函數會特別有用。用於設定環境本身的特定值，如資料庫設定、API 金鑰等等。
-
esc($data, $context='html'[, $encoding])¶ 參數: - $data (string|array) – 預計被跳脫的資訊。
- $context (string) – 轉譯的內容，預設是 html 。
- $encoding (string) – 字串的編碼格式。
傳回: 跳脫後的資料。
傳回型態: mixed
在你的網頁中使用跳脫後的資訊，將可以防止 XSS 攻擊。這個函數使用 Laminas Escaper 程式庫來處理實際的資料過濾。
如果 $data 是一個字串，那麼就會被轉譯後回傳。如果 $data 是一個陣列，那麼它就會針對陣列做循環，轉換調每個鍵/值的「值」。
支援的內容值： html 、 js 、 css 、 url 、 attr 、 raw 、 null 。
-
helper($filename)¶ 參數: - $filename (string|array) – 要載入的輔助函數名稱，或者是含有多個輔助函數名稱的陣列。
載入一個輔助函數檔案。
詳情請參閱 輔助函數 頁面。
-
lang($line[, $args[, $locale]])¶ 參數: - $line (string) – 要檢索的文字行數。
- $args (array) – 替代置換符號的資料陣列。
- $locale (string) – 指定要使用的語言環境，而非預設的語言環境。
根據別名字串檢索特定的語言環境檔案。
更多資訊，請參閱 Localization 頁面。
-
model($name[, $getShared = true[, &$conn = null]])¶ 參數: - $name (string) –
- $getShared (boolean) –
- $conn (ConnectionInterface|null) –
傳回: More simple way of getting model instances
傳回型態: mixed
-
old($key[, $default = null[, $escape = 'html']])¶ 參數: - $key (string) – 需要檢查的舊表單資料。
- $default (mixed) – 如果 $key 不存在，則回傳預設值。
- $escape (mixed) – 轉譯 內容或使用 false 禁用。
傳回: 定義 key 的值，或者使用預設值。
傳回型態: mixed
提供一個簡單的方法，可以從已經提交的表單中造訪「舊的輸入資料」。
範例：
// in controller, checking form submittal if (! $model->save($user)) { // 'withInput' is what specifies "old data" // should be saved. return redirect()->back()->withInput(); } // In the view <input type="email" name="email" value="<?= old('email') ?>"> // Or with arrays <input type="email" name="user[email]" value="<?= old('user.email') ?>">
備註
這個功能內建在 表單輔助函數 之中，若是你不使用表單輔助函數，你才會需要用到這個功能。
-
session([$key])¶ 參數: - $key (string) – 需要檢查的 Session 項目名稱。
傳回: 如果沒有傳入 $key ，則會回傳 Session 物件的實體；如果有傳入 $key ，則尋找 Session 中是否有這個值後回傳，若找不到則為 null。
傳回型態: mixed
提供一個存取 Session 類別和檢索儲存值的便捷方法，更多訊息請參閱 Sessions 頁面。
-
timer([$name])¶ 參數: - $name (string) – 基準點的名稱。
傳回: Timer 實體。
傳回型態: CodeIgniterDebugTimer
提供快速造訪 Timer 類別的方法，你可以傳遞一個基準點名稱做為唯一引數。方法將從這個基準點開始計時，如果已經有一個帶有這個名子的 Timer 再執行，則會停止執行。
範例:
// Get an instance $timer = timer(); // Set timer start and stop points timer('controller_loading'); // Will start the timer . . . timer('controller_loading'); // Will stop the running timer
-
view($name[, $data[, $options]])¶ 參數: - $name (string) – 要載入的檔案名稱。
- $data (array) – 傳遞給視圖的 鍵/值 陣列。
- $options (array) – 將會傳遞給渲染類別的選項陣列。
傳回: 輸出視圖。
傳回型態: string
抓取目前的 RendererInterface 相容類別，並告訴它渲染所指定的視圖。提供便捷的方法，可以在控制器、程式庫與路由閉包中使用。
在 $options 陣列中有一個選項可以使用，即 saveData 。它指定的資料將保持在同一請求多次呼叫的 View() 之中。在預設的情況下，這個視圖的資料將在顯示視圖後被棄用。
提供 $option 陣列是為了方便第三方與 Twig 等程式庫的集成。
範例:
$data = ['user' => $user]; echo view('user_profile', $data);
更多詳情，請閱讀 視圖 頁面。
-
view_cell($library[, $params = null[, $ttl = 0[, $cacheName = null]]])¶ 參數: - $library (string) –
- $params (null) –
- $ttl (integer) –
- $cacheName (string|null) –
傳回: View cells are used within views to insert HTML chunks that are managed by other classes.
傳回型態: string
For more details, see the View Cells page.
其他功能¶
-
app_timezone()¶ 傳回: The timezone the application has been set to display dates in. 傳回型態: string Returns the timezone the application has been set to display dates in.
-
csrf_token()¶ 傳回: 當前 CSRF 權杖的名稱。 傳回型態: string 回傳當前 CSRF 權杖的名稱。
-
csrf_header()¶ 傳回: 當前 CSRF 權杖的 header 名稱。 傳回型態: string 當前 CSRF 權杖的 header 名稱。
-
csrf_hash()¶ 傳回: 當前 CSRF 的雜湊值。 傳回型態: string 當前 CSRF 的雜湊值。
-
csrf_field()¶ 傳回: 一個帶有隱藏輸入的 HTML 字串，包含所有需要的 CSRF 訊息。 傳回型態: string 回傳已經插入 CSRF 訊息的隱藏輸入：
<input type="hidden" name="{csrf_token}" value="{csrf_hash}">
-
csrf_meta()¶ 傳回: 一個包含 meta 標籤的 HTML 字串，包含所有需要的 CSRF 訊息。 傳回型態: string 回傳一個已經插入了 CSRF 訊息的 meta 標籤：
<meta name="{csrf_header}" content="{csrf_hash}">
-
force_https($duration = 31536000[, $request = null[, $response = null]])¶ 參數: - $duration (int) – 瀏覽器將連接到這個資源轉換成 HTTPS 的秒數。
- $request (RequestInterface) – 目前 Request 物件的實體。
- $response (ResponseInterface) – 目前 Response 物件的實體。
檢查目前是否透過 HTTPS 造訪該頁面。如果是，將不動作。若否，則該使用者將會以 HTTPS 的形式被重新導向到當前 URL 。將會設定 HTTP Strict-Transport-Security 標頭，它將讓現代瀏覽器自動把 $duration 的所有 HTTP 請求修改為 HTTPS 請求。
-
function_usable($function_name)¶ 參數: - $function_name (string) – Function to check for
傳回: TRUE if the function exists and is safe to call, FALSE otherwise.
傳回型態: bool
-
is_cli()¶ 傳回: 如果該腳本是從命令列中執行，則回傳 TRUE 否則回傳 FALSE 。 傳回型態: bool
-
is_really_writable($file)¶ 參數: - $file (string) – The filename being checked.
傳回: TRUE if you can write to the file, FALSE otherwise.
傳回型態: bool
-
log_message($level, $message[, $context])¶ 參數: - $level (string) – 嚴重程度。
- $message (string) – 要記錄的訊息。
- $context (array) – 包含標籤與值的關聯陣列，在 $message 中被替換。
傳回: 如果紀錄成功則為 TRUE ；如果紀錄失敗則為 FALSE 。
傳回型態: bool
使用 app/Config/Logger.php 中定義的日誌處理程式來記錄訊息。
級別可能是以下值之一： emergency （緊急） 、 alert （提示） 、 critical （重要） 、 error （錯誤） 、 warning （警告） 、 notice （通知） 、 info （訊息），與 debug （除錯）.
$context 可以用來替代訊息字串中的值，有關詳細資訊，請參閱 日誌資訊 頁面。
-
redirect(string $uri)¶ 參數: - $uri (string) – 使用者將被重新導向的目標 URL 。
回傳一個 RedirectResponse 實體，允許使用者輕鬆創建重新定向：
// 返回上一頁 return redirect()->back(); // 前往特定的 URI return redirect()->to('/admin'); // 前往 named/reverse-routed 的 URI return redirect()->route('named_route'); // 在重新定向時保留舊的輸入值，這樣他們就可以被 `old()` 函數使用。 return redirect()->back()->withInput(); // 設定快閃訊息（Flash message） return redirect()->back()->with('foo', 'message'); // Copies all cookies from global response instance return redirect()->back()->withCookies();
// Copies all headers from the global response instance return redirect()->back()->withHeaders();
當傳遞 URL 到函數中時，它會被視為反向路由請求，而不是 relative/full 的 URI ，處理方式與使用 redirect()->route() 相同 ：
// 前往 named/reverse-routed 的 URI return redirect('named_route');
-
remove_invisible_characters($str[, $urlEncoded = TRUE])¶ 參數: - $str (string) – 輸入字串
- $urlEncoded (bool) – 是否要清除 URL 編碼的字元
傳回: Sanitized string
傳回型態: string
這個函數可以防止在 ASCII 字元間插入 NULL 字元，就像 Java\0script 。
範例：
remove_invisible_characters('Java\\0script'); // 最後會輸出: 'Javascript' 字串
-
route_to($method[, ...$params])¶ 參數: - $method (string) – 命名路由的別名，或是要匹配的 控制器／方法 的名稱。
- $params (mixed) – 在路由中傳遞一個或多個要匹配的引數。
根據命名的路由別名以及 控制器::方法 ，生成一個相對的 URI 組合。如果提供了引數，則引數將會生效。
有關更多訊息，請見 URI 路由設定 頁面.
-
service($name[, ...$params])¶ 參數: - $name (string) – 要被載入的服務名稱。
- $params (mixed) – 傳遞給方法的一個或多個的引數。
傳回: 指定的服務類別的實體。
傳回型態: mixed
提供了對系統中定義的任何 Services 的方便存取。這將始終回傳一個共享的類別實體，因此無論在一次的請求中呼叫多少次，都只會創建一個類別實體。
範例：
$logger = service('logger'); $renderer = service('renderer', APPPATH.'views/');
-
single_service($name[, ...$params])¶ 參數: - $name (string) – 要載入的服務名稱。
- $params (mixed) – 一個或多個要傳遞給服務方法的引數。
傳回: 指定的服務類別的實體。
傳回型態: mixed
與上面描述的 service() 函數相同，但呼叫這個函數每次都會回傳一個新的類別實體，而 service 每次的回傳則是相同的實體。
-
slash_item($item)¶ 參數: - $item (string) – Config item name
傳回: The configuration item or NULL if the item doesn’t exist
傳回型態: string|null
Fetch a config file item with slash appended (if not empty)
-
stringify_attributes($attributes[, $js])¶ 參數: - $attributes (mixed) – 字串、鍵值陣列或物件。
- $js (boolean) – 如果值不需要引號，則為 TRUE （ Javascript 風格 ）。
傳回: 含有屬性 鍵／值 的字串，以逗號分開。
傳回型態: string
輔助函數用於將字串、陣列或物件屬性串換成字串。