自動完成 · 文檔規范示例

# 自動完成 [上一頁](# "上一頁")[下一頁](# "下一頁") 自動完成是ThinkPHP提供用來完成數據自動處理和過濾的方法，使用create方法創建數據對象的時候會自動完成數據處理。因此，在ThinkPHP使用create方法來創建數據對象是更加安全的方式，而不是直接通過add或者save方法實現數據寫入。 ### 規則定義自動完成通常用來完成默認字段寫入，安全字段過濾以及業務邏輯的自動處理等，和自動驗證的定義方式類似，自動完成的定義也支持靜態定義和動態定義兩種方式。 1. 靜態方式：在模型類里面通過$_auto屬性定義處理規則。 1. 動態方式：使用模型類的auto方法動態創建自動處理規則。兩種方式的定義規則都采用： ~~~ array( array(完成字段1,完成規則,[完成條件,附加規則]), array(完成字段2,完成規則,[完成條件,附加規則]), ...... ); ~~~ 說明 ##### 完成字段（必須）需要進行處理的數據表實際字段名稱。 ##### 完成規則（必須）需要處理的規則，配合附加規則完成。 ##### 完成時間（可選）設置自動完成的時間，包括： | 設置 | 說明 | |-----|-----| | self::MODEL_INSERT或者1 | 新增數據的時候處理（默認） | | self::MODEL_UPDATE或者2 | 更新數據的時候處理 | | self::MODEL_BOTH或者3 | 所有情況都進行處理 | ##### 附加規則（可選）包括： | 規則 | 說明 | |-----|-----| | function | 使用函數，表示填充的內容是一個函數名 | | callback | 回調方法，表示填充的內容是一個當前模型的方法 | | field | 用其它字段填充，表示填充的內容是一個其他字段的值 | | string | 字符串（默認方式） | | ignore | 為空則忽略（3.1.2新增） | ### 靜態定義預先在模型類里面定義好自動完成的規則，我們稱之為靜態定義。例如，我們在模型類定義`_auto`屬性： ~~~ namespace Home\Model; use Think\Model; class UserModel extends Model{ protected $_auto = array ( array('status','1'), // 新增的時候把status字段設置為1 array('password','md5',3,'function') , // 對password字段在新增和編輯的時候使md5函數處理 array('name','getName',3,'callback'), // 對name字段在新增和編輯的時候回調getName方法 array('update_time','time',2,'function'), // 對update_time字段在更新的時候寫入當前時間戳 ); } ~~~ 然后，就可以在使用create方法創建數據對象的時候自動處理： ~~~ $User = D("User"); // 實例化User對象 if (!$User->create()){ // 創建數據對象 // 如果創建失敗表示驗證沒有通過輸出錯誤提示信息 exit($User->getError()); }else{ // 驗證通過寫入新增數據 $User->add(); } ~~~ 如果你沒有定義任何自動驗證規則的話，則不需要判斷create方法的返回值： ~~~ $User = D("User"); // 實例化User對象 $User->create(); // 生成數據對象 $User->add(); // 新增用戶數據 ~~~ 或者更簡單的使用： ~~~ $User = D("User"); // 實例化User對象 $User->create()->add(); // 生成數據對象并寫入數據 ~~~ create方法默認情況下是根據表單提交的post數據生成數據對象，我們也可以根據其他的數據源來生成數據對象，你也可以明確指定當前創建的數據對象自動處理的時間是新增還是編輯數據，例如： ~~~ $User = D("User"); // 實例化User對象 $userData = getUserData(); // 通過方法獲取用戶數據 $User->create($userData,2); // 根據userData數據創建數據對象，并指定為更新數據 $User->add(); ~~~ create方法的第二個參數就用于指定自動完成規則中的完成時間，也就是說create方法的自動處理規則只會處理符合完成時間的自動完成規則。create方法在創建數據的時候，已經自動過濾了非數據表字段數據信息，因此不需要擔心表單會提交其他的非法字段信息而導致數據對象寫入出錯，甚至還可以自動過濾不希望用戶在表單提交的字段信息（詳見字段合法性過濾）。 3.1.2版本開始新增了ignore完成規則，這一規則表示某個字段如果留空的話則忽略，通常可用于修改用戶資料時候密碼的輸入，定義如下： ~~~ array('password','',2,'ignore') ~~~ 表示password字段編輯的時候留空則忽略。 ### 動態完成除了靜態定義之外，我們也可以采用動態完成的方式來解決不同的處理規則。 ~~~ $rules = array ( array('status','1'), // 新增的時候把status字段設置為1 array('password','md5',3,'function') , // 對password字段在新增和編輯的時候使md5函數處理 array('update_time','time',2,'function'), // 對update_time字段在更新的時候寫入當前時間戳 ); $User = M('User'); $User->auto($rules)->create()->add(); ~~~ ### 修改數據對象在使用create方法創建好數據對象之后，此時的數據對象保存在內存中，因此仍然可以操作數據對象，包括修改或者增加數據對象的值，例如： ~~~ $User = D("User"); // 實例化User對象 $User->create(); // 生成數據對象 $User->status = 2; // 修改數據對象的status屬性 $User->register_time = NOW_TIME; // 增加register_time屬性 $User->add(); // 新增用戶數據 ~~~ 一旦調用了add方法（或者save方法），創建在內存中的數據對象就會失效，如果希望創建好的數據對象在后面的數據處理中再次調用，可以保存數據對象先，例如： ~~~ $User = D("User"); // 實例化User對象 $data = $User->create(); // 保存生成的數據對象 $User->add(); ~~~ 不過要記得，如果你修改了內存中的數據對象并不會自動更新保存的數據對象，因此下面的用法是錯誤的： ~~~ $User = D("User"); // 實例化User對象 $data = $User->create(); // 保存生成的數據對象 $User->status = 2; // 修改數據對象的status屬性 $User->register_time = NOW_TIME; // 增加register_time屬性 $User->add($data); ~~~ 上面的代碼我們修改了數據對象，但是仍然寫入的是之前保存的數據對象，因此對數據對象的更改操作將會無效。 [上一頁](# "上一頁")[下一頁](# "下一頁")