C隆壟脰煤脢脰潞爐脢媒 · tp5文檔

本篇匯總了系統提供的助手函數的基礎用法，更詳細的請參考相關章節。系統的助手函數大致分為下面幾個類型： - - [加載和實例化](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/211126#u52A0u8F7Du548Cu5B9Eu4F8Bu5316) - [數據操作](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/211126#u6570u636Eu64CDu4F5C) - [日志和調試](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/211126#u65E5u5FD7u548Cu8C03u8BD5) - [響應輸出](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/211126#u54CDu5E94u8F93u51FA) - [其它](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/211126#u5176u5B83) ## 加載和實例化 > ### import：導入所需的類庫同java的Import 本函數有緩存功能 ### 參數：名稱描述默認值 class 類庫命名空間字符串必須 baseUrl 起始路徑，留空為自動識別空 ext 導入的文件擴展名 EXT常量### 返回值：導入成功返回true，否則返回false。 ### 示例：注意該方法只是導入文件，和是否有命名空間和如何實例化無關。 ``` <pre class="calibre18"> ``` $result = import('org/util/Array'); ``` ``` > ### vendor：導入vendor目錄下的第三方類庫（非命名空間） ### 參數：名稱描述默認值 class 要導入的類庫必須 ext 導入的文件擴展名 EXT常量### 返回值：導入成功返回true，否則返回false。 ### 示例：注意該方法只是導入文件，和是否有命名空間和如何實例化無關。 ``` <pre class="calibre18"> ``` $result = vendor('org/util/Array'); ``` ``` > ### load\_trait：快速導入Traits PHP5.5以上無需調用 ### 參數：名稱描述默認值 class 要導入的trait庫必須 ext 類庫后綴 EXT常量### 返回值：導入成功返回true，否則返回false。 ### 示例： ``` <pre class="calibre18"> ``` load_trait('controller/Jump'); ``` ``` > ### model：實例化模型類（單例） ### 參數：名稱描述默認值 name Model名稱必須 layer 模型層名稱 model appendSuffix 是否添加類名后綴 false### 返回值：模型實例 ### 示例： ``` <pre class="calibre18"> ``` $user = model('User'); ``` ``` > ### validate：實例化驗證器類（單例） ### 參數：名稱描述默認值 name 驗證器名稱必須 layer 驗證層名稱 validate appendSuffix 是否添加類名后綴 false### 返回值：驗證器實例 ### 示例： ``` <pre class="calibre18"> ``` $validate = validate('User'); ``` ``` > ### db：實例化數據庫類 ### 參數：名稱描述默認值 name 操作的數據表名稱（不含前綴）必須 config 數據庫配置參數，數組或者字符串，留空獲取配置文件中的配置空 force 是否強制重新連接 true### 返回值：數據庫查詢對象實例 ### 示例： ``` <pre class="calibre18"> ``` $db = db('user'); ``` ``` > ### controller：實例化控制器類 ### 參數：名稱描述默認值 name 控制器資源地址 \[模塊/\]控制器必須 layer 控制器層名稱 controller appendSuffix 是否添加類名后綴 false### 返回值：控制器對象實例 ### 示例： ``` <pre class="calibre18"> ``` $user = controller('Admin/User'); ``` ``` > ### action：調用模塊的操作方法參數格式 \[模塊/控制器/\]操作 ### 參數：名稱描述默認值 url 調用地址必須 vars 調用參數支持字符串和數組空 layer 要調用的控制層名稱 controller appendSuffix 是否添加類名后綴 false### 返回值：根據方法的返回值 ### 示例： ``` <pre class="calibre18"> ``` $result = action('Admin/User/getInfo'); ``` ``` > ### request：獲取當前的請求對象實例（單例） ### 參數：無 ### 返回值： `\think\Request`對象實例 ### 示例： ``` <pre class="calibre18"> ``` request()->url(); request()->param(); ``` ``` > ### response：創建響應對象實例 ### 參數：名稱描述默認值 data 響應輸出數據空 code 輸出狀態碼 200 header 輸出HEADER信息空 type 響應輸出類型 html### 返回值： `\think\response`對象實例 ### 示例： ``` <pre class="calibre18"> ``` response($data,[],[],'json'); ``` ``` ## 數據操作 > ### session：Session操作助手函數 ### 參數：名稱描述默認值 name session名稱，如果為數組表示進行session初始化必須 value session值空 prefix session變量前綴 null### 返回值：多種情況 ### 示例： ``` <pre class="calibre18"> ``` // session初始化 session(['id'=>'think','prefix'=>'think']); // session設置 session('name','value'); // session判斷 session('?name'); // session獲取 session('name'); // session刪除 session('name',null); // session清空 session(null); ``` ``` > ### cookie：Cookie操作助手函數 ### 參數：名稱描述默認值 name cookie名稱，如果為數組表示進行cookie初始化必須 value cookie值空 option 參數 null### 返回值：多種情況 ### 示例： ``` <pre class="calibre18"> ``` // cookie初始化 cookie(['expire'=>3600,'prefix'=>'think']); // cookie設置 cookie('name','value'); // cookie判斷 cookie('?name'); // cookie獲取 cookie('name'); // cookie刪除 cookie('name',null); // cookie清空 cookie(null); ``` ``` > ### cache：緩存操作助手函數 ### 參數：名稱描述默認值 name 緩存名稱，如果為數組表示進行緩存初始化必須 value 緩存值空 options 緩存參數或者傳入數字的時候為有效期 null tag 緩存標簽 null### 返回值：多種情況 ### 示例： ``` <pre class="calibre18"> ``` // 緩存初始化 cache(['expire'=>3600,'prefix'=>'think']); // 緩存設置 cache('name','value',3600); // 緩存判斷 cache('?name'); // 緩存獲取 cache('name'); // 緩存刪除 cache('name',null); ``` ``` > ### config：設置或者獲取配置參數 ### 參數：名稱描述默認值 name 參數名如果是數組表示批量賦值必須 value 參數值空 range 作用域，留空表示當前作用域空### 返回值：根據情況 ### 示例： ``` <pre class="calibre18"> ``` config('name','value'); config('?name'); config('name'); config(['name'=>'value']); ``` ``` > ### input：獲取輸入數據支持默認值和過濾 ### 參數：名稱描述默認值 key 獲取的變量名必須 default 默認值空 filter 過濾方法空### 返回值：根據情況 ### 示例： ``` <pre class="calibre18"> ``` input('name'); input('?name'); input('get.id',0); ``` ``` ## 日志和調試 > ### dump：瀏覽器友好的變量輸出 ### 參數：名稱描述默認值 var 調試變量或者信息必須 echo 是否輸出默認為true 如果為false 則返回輸出字符串 true label 標簽空### 返回值：無 ### 示例： ``` <pre class="calibre18"> ``` dump($data); dump($data,false); dump('測試輸出'); ``` ``` > ### halt：調試變量并中止和dump函數的區別在于調試輸出后中止執行后面的程序。 ### 參數：名稱描述默認值 var 調試變量或者信息必須### 返回值：無 ### 示例： ``` <pre class="calibre18"> ``` halt($data); halt('測試輸出'); ``` ``` > ### trace：記錄日志信息 ### 參數：名稱描述默認值 log log信息支持字符串和數組 level 日志級別 log### 返回值：沒有傳任何參數的時候獲取日志信息，否則為記錄日志 ### 示例： ``` <pre class="calibre18"> ``` trace('日志錯誤信息','error'); ``` ``` > ### exception：拋出異常 ### 參數：名稱描述默認值 msg 異常消息必須 code 異常代碼 0 exception 異常類名留空拋出 `\think\Exception` 異常空### 返回值：字符串 ### 示例： ``` <pre class="calibre18"> ``` exception('錯誤'); exception('權限錯誤',10002,'\app\common\AuthException'); ``` ``` > ### debug：調試時間（微秒）和內存使用情況 ### 參數：名稱描述默認值 start 開始標簽必須 end 結束標簽空字符串 dec 小數位如果是m 表示統計內存占用 6### 返回值：根據情況 ### 示例： ``` <pre class="calibre18"> ``` debug('begin'); // ... echo debug('begin','end',6); echo debug('begin','end','m'); ``` ``` ## 響應輸出 > ### view：模板渲染輸出 ### 參數：名稱描述默認值 template 模板文件空 vars 模板變量無 replace 模板替換規則空 code 狀態碼 200### 返回值： `\think\response\View`對象實例 ### 示例： ``` <pre class="calibre18"> ``` view('index/hello',['name'=>'thinkphp']); ``` ``` > ### json：創建JSON響應對象實例 ### 參數：名稱描述默認值 data 響應輸出數據空 code 輸出狀態碼 200 header 輸出頭信息空 options 輸出參數空### 返回值： `\think\response\Json`對象實例 ### 示例： ``` <pre class="calibre18"> ``` json(['id'=>10, 'name'=>'thinkphp']); ``` ``` > ### jsonp：創建JSONP響應對象實例 ### 參數：名稱描述默認值 data 響應輸出數據空 code 輸出狀態碼 200 header 輸出頭信息空 options 輸出參數空### 返回值： `\think\response\Jsonp`對象實例 ### 示例： ``` <pre class="calibre18"> ``` jsonp(['id'=>10, 'name'=>'thinkphp']); ``` ``` > ### xml：創建XML響應對象實例 ### 參數：名稱描述默認值 data 響應輸出數據空 code 輸出狀態碼 200 header 輸出頭信息空 options 輸出參數空### 返回值： `\think\response\Xml`對象實例 ### 示例： ``` <pre class="calibre18"> ``` xml(['id'=>10, 'name'=>'thinkphp']); ``` ``` > ### redirect：創建重定向響應對象實例 ### 參數：名稱描述默認值 url 重定向地址空 params 參數，當傳入數字的時候表示狀態碼空 code 狀態碼 302### 返回值： `\think\response\Redirect`對象實例 ### 示例： ``` <pre class="calibre18"> ``` redirect('http://thinkphp.cn', ['id'=>10, 'name'=>'thinkphp'],301); redirect('http://thinkphp.cn/blog', 301); ``` ``` > ### abort：拋出HTTP異常 ### 參數：名稱描述默認值 code 狀態碼或者 Response對象實例必須 message 錯誤信息空 header 參數空### 返回值：無 ### 示例： ``` <pre class="calibre18"> ``` abort(401, '頁面不存在'); abort(500, '服務器錯誤'); ``` ``` ## 其它 > ### token：生成表單令牌（form表單項） ### 參數：名稱描述默認值 name 令牌名稱 **token** type 令牌生成方法 md5### 返回值：字符串 ### 示例： ``` <pre class="calibre18"> ``` <form action="" > <input type="text" name="name" /> {:token('__hash__')} <input type="submit" /> </form> ``` ``` > ### url：生成URL地址（支持路由反解） ### 參數：名稱描述默認值 url 路由地址空 vars 變量空 suffix 生成的URL后綴 true 表示自動識別配置 domain 是否帶域名生成 false### 返回值：字符串 ### 示例： ``` <pre class="calibre18"> ``` url('index/index/hello',['name'=>'thinkphp']); url('index/index/hello','name&thinkphp'); ``` ``` > ### lang：獲取語言變量值 ### 參數：名稱描述默認值 name 語言變量名必須 vars 動態變量值空 lang 語言留空自動識別當前語言空### 返回值：字符串 ### 示例： ``` <pre class="calibre18"> ``` lang('lang_str'); ``` ``` > ### widget：渲染輸出Widget ### 參數：名稱描述默認值 name Widget名稱必須 data 傳入的參數空### 返回值：根據情況 ### 示例：通常在模板文件中調用 ``` <pre class="calibre42"> ``` {:widget('name')} ``` ```