CodeIgniter4 公共函數(shù)和全局常量

CodeIgniter 你可以在任何地方使用它們，并且不需要加載任何 類庫或輔助函數(shù)。

公共函數(shù)

服務(wù)訪問器函數(shù)

cache([$key])

若 $key 不存在, 則返回緩存引擎實例. 若 $key有值存在, 則返回 $key 當(dāng)前存儲在緩存中的值，若值不存在則返回null。

Examples:

$foo = cache('foo');
$cache = cache();

env($key[, $default=null])

用于檢索事前設(shè)置在環(huán)境變量中的變量值,若無設(shè)置則返回默認(rèn)值. 若沒有找到健值則返回一個布爾值結(jié)果（false）.

在特定的運行環(huán)境中利用 .env 文件設(shè)置環(huán)境變量非常有用，例如數(shù)據(jù)庫設(shè)置，API健值等.

esc($data, $context='html'[, $encoding])

頁面中包含的輸出數(shù)據(jù), 它在防止 XSS 攻擊時很有用。 使用Laminas Escaper 庫來處理實際的數(shù)據(jù)過濾。

若 $data 為字符串, 則簡單轉(zhuǎn)義并且返回。 若 $data 為數(shù)組, 則遍歷數(shù)組，轉(zhuǎn)義 key/value 鍵值對中的 ‘value’。

有效的 context 值: html, js, css, url, attr, raw, null

helper($filename)

加載輔助類文件。

詳情參照 輔助函數(shù) 頁.

lang($line[, $args[, $locale]])

param string $line: 檢索文本的行

param array $args: 一組數(shù)組數(shù)據(jù)，用于替代占位符.

更多詳細(xì)信息請見 本地化 頁。

old($key[, $default = null[, $escape = 'html']])

param string $key: 需要使用的原有的表單提交的鍵。

param mixed $default: 如果當(dāng)$key不存在時返回的默認(rèn)值。

提供了一個簡易的方式，在表單提交時訪問 “原有的輸入數(shù)據(jù)”。

示例:

// 在控制器中查看表單提交
if (! $model->save($user))
{
    // 'withInput'方法意味著"原有的數(shù)據(jù)"需要被存儲。
    return redirect()->back()->withInput();
}


// 視圖中
<input type="email" name="email" value="<?= old('email') ?>">
// 以數(shù)組的形式
<input type="email" name="user[email]" value="<?= old('user.email') ?>">

注解

如果你正使用 form helper , 這個特性就是內(nèi)置的。只有在你不使用form helper的時候才需要手動調(diào)用。

session([$key])

提供一個訪問 session 類和檢索存儲值的便捷方法。更多信息詳見 the Sessions 頁.

timer([$name])

提供一個快速訪問 Timer class的便捷的方法。 你可以將基準(zhǔn)點的名稱作為唯一參數(shù)傳遞。這將從這一點開始計時， 如果這個名稱的計時器已經(jīng)運行，則停止計時。

示例:

// 獲取一個timer實例
$timer = timer();


// 設(shè)置計時器的開始與結(jié)束點
timer('controller_loading');    // 開始計時器
. . .
timer('controller_loading');    // 停止計時器運行

view($name[, $data[, $options]])

抓取當(dāng)前的 RendererInterface-compatible 類（界面渲染類），告訴它展示特定的視圖。給控制器、庫、路由閉包提供了一種便捷的方法。

目前，在 $options 數(shù)組里只有一個選項是可用的，saveData 指定在同一個請求中，在多次調(diào)用 view() 時數(shù)據(jù)將連續(xù)。默認(rèn)情況下， 在顯示該單一視圖文件之后，該視圖的數(shù)據(jù)被丟棄。

$option 數(shù)組主要用于與第三方庫整合，例如Twig。

Example:

$data = ['user' => $user];


echo view('user_profile', $data);

詳情參見 the Views 頁。

其他函數(shù)

csrf_token()

返回當(dāng)前 CSRF token名稱。

csrf_header()

The name of the header for current CSRF token.

csrf_hash()

返回當(dāng)前 CSRF hash 的值.

csrf_field()

返回已插入CSRF信息的隱藏input:

<input type="hidden" name="{csrf_token}" value="{csrf_hash}">

csrf_meta()

Returns a meta tag with the CSRF information already inserted:

<meta name="{csrf_header}" content="{csrf_hash}">

force_https($duration = 31536000[, $request = null[, $response = null]])

檢查頁面當(dāng)前是否通過HTTPS訪問，如果不是，則用戶通過HTTPS重定向回當(dāng)前URI。 將設(shè)置 HTTP 嚴(yán)格的傳輸安全標(biāo)頭，該命令指示現(xiàn)代瀏覽器自動將HTTP請求修改為 $duration 參數(shù)時間的HTTPS請求。

is_cli()

log_message($level, *$message[, $context*])

使用 app/Config/Logger.php 中定義的日志處理程序記錄日志。

級別可為以下值: emergency, alert, critical, error, warning, notice, info, or debug.

Context 可用于替換 message 字符串中的值。詳情參見 Logging Information 頁。

redirect(string $uri)

返回以后RedirectResponse的實例以便創(chuàng)建重定向:

        // 回到上一個頁面Go back to the previous page
        return redirect()->back();


        // 跳轉(zhuǎn)至具體的URI
        return redirect()->to('/admin');


        // 跳轉(zhuǎn)到一個命名路由或反向路由 URI
        return redirect()->route('named_route');


        // 在跳轉(zhuǎn)中保持原有的輸入值，使得它們可以被 `old()` 函數(shù)調(diào)用。
        return redirect()->back()->withInput();


        // 顯示一個消息
        return redirect()->back()->with('foo', 'message');


當(dāng)將URI傳給這個函數(shù)時。它將會被作為一個反向路由請求，而不是一個完整的URI，就像使用 redirect()->route()一樣::


// 跳轉(zhuǎn)到一個命名路由或反向路由 URI
        return redirect('named_route');

redirect_with_input($uri[, ...$params])

跟redirect()方法等同, 該session刷新的請求中的 $_GET 和 $POST的值除外。 在下一頁的請求, 表單輔助類的 `set*` 方法將首先檢查舊的輸入數(shù)據(jù), 若沒發(fā)現(xiàn), 則當(dāng)前的 GET/POST 將被檢查。

注意

為了取回舊的值, session必須被啟用，優(yōu)先調(diào)用函數(shù).

remove_invisible_characters($str[, $urlEncoded = TRUE])

這個函數(shù)防止在 ASCII 字符之間插入空字符(NULL)，例如 Java\0script。

范例:

remove_invisible_characters('Java\\0script');
// 返回: 'Javascript'

route_to($method[, ...$params])

以指定的路由別名或 controller::method 組合為依據(jù)生成一個相對 URI 。如果提供參數(shù)，將執(zhí)行參數(shù)。

詳情參見 the URI 路由 頁。

service($name[, ...$params])

提供簡易訪問任何在系統(tǒng)中定義的服務(wù)，詳見the Services 。 這將總是返回類的共享實例，因此不管在單個請求中調(diào)用多少次，都只會創(chuàng)建一個類實例。

范例:

$logger = service('logger');
$renderer = service('renderer', APPPATH.'views/');

single_service($name[, ...$params])

等同于前面所描述的 service() 函數(shù), 除了所有調(diào)用該函數(shù)將返回一個類的新實例。

service 返回的是相同的實例。

stringify_attributes($attributes[, $js])

輔助函數(shù)用于轉(zhuǎn)換字符串, 數(shù)組, 或者字符串的對象屬性。

全局常量

以下的常量在你的應(yīng)用中的任何地方有效。

核心常量

constantAPPPATH

app 目錄的路徑。

constantROOTPATH

項目根目錄，APPPATH 目錄的上層目錄。

constantSYSTEMPATH

system 目錄的路徑。

constantFCPATH

保存的前端控制器目錄的路徑。

constantSELF

前端控制器的路徑, index.php.

constantWRITEPATH

writable 目錄的路徑。

時間常量

constantSECOND

等于 1.

constantMINUTE

等于 60.

constantHOUR

等于 3600.

constantDAY

等于 86400.

constantWEEK

等于 604800.

constantMONTH

等于 2592000.

constantYEAR

等于 31536000.

constantDECADE

等于 315360000.