獲取器 · ThinkORM開發指南

## 獲取器 ? 獲取器的作用是對模型實例的（原始）數據做出自動處理。一個獲取器對應模型的一個特殊方法，方法命名規范為： ? >[info] ### get`FieldName`Attr ? `FieldName`為數據表字段的駝峰轉換，定義了獲取器之后會在下列情況自動觸發： ? * 模型的數據對象取值操作（`$model->field_name`）； * 模型的序列化輸出操作（`$model->toArray()`及`toJson()`）； * 顯式調用`getAttr`方法（`$this->getAttr('field_name')`）； ? 獲取器的場景包括： ? * 時間日期字段的格式化輸出； * 集合或枚舉類型的輸出； * 數字狀態字段的輸出； * 組合字段的輸出； ? 例如，我們需要對狀態值進行轉換，可以使用： ? ~~~ <?php namespace app\model; ? use think\Model; ? class User extends Model { public function getStatusAttr($value) { $status = [-1=>'刪除',0=>'禁用',1=>'正常',2=>'待審核']; return $status[$value]; } } ~~~ ? 數據表的字段會自動轉換為駝峰法，一般`status`字段的值采用數值類型，我們可以通過獲取器定義，自動轉換為字符串描述。 ? ~~~ $user = User::find(1); echo $user->status; // 例如輸出“正常” ~~~ ? 獲取器還可以定義數據表中不存在的字段，例如： ? ~~~ <?php namespace app\model; ? use think\Model; ? class User extends Model { public function getStatusTextAttr($value,$data) { $status = [-1=>'刪除',0=>'禁用',1=>'正常',2=>'待審核']; return $status[$data['status']]; } } ~~~ ? > 獲取器方法的第二個參數傳入的是當前的所有數據數組。 ? 我們就可以直接使用status_text字段的值了，例如： ~~~ $user = User::find(1); echo $user->status_text; // 例如輸出“正常” ~~~ ? ## 獲取原始數據 ? 如果你定義了獲取器的情況下，希望獲取數據表中的原始數據，可以使用： ? ~~~ $user = User::find(1); // 通過獲取器獲取字段 echo $user->status; // 獲取原始字段數據 echo $user->getData('status'); // 獲取全部原始數據 dump($user->getData()); ~~~ ? ## 動態獲取器 ? 可以支持對模型使用動態獲取器，無需在模型類中定義獲取器方法。 ? ~~~ User::withAttr('name', function($value, $data) { return strtolower($value); })->select(); ~~~ ? > `withAttr`方法支持多次調用，定義多個字段的獲取器。另外注意，`withAttr`方法之后不能再使用模型的查詢方法，必須使用Db類的查詢方法。 ? >[danger] 如果同時還在模型里面定義了相同字段的獲取器，則動態獲取器優先，也就是可以臨時覆蓋定義某個字段的獲取器。 ? 支持對關聯模型的字段使用動態獲取器，例如： ~~~ User::with('profile')->withAttr('profile.name', function($value, $data) { return strtolower($value); })->select(); ~~~ >[danger] 注意：對于`MorphTo`關聯不支持使用動態獲取器。 ? 并且支持對`JSON`字段使用獲取器，例如在模型中定義了`JSON`字段的話： ? ~~~ <?php namespace app\index\model; ? use think\Model; ? class User extends Model { // 設置json類型字段 protected $json = ['info']; } ~~~ ? 可以使用下面的代碼定義JSON字段的獲取器。 ? ~~~ User::withAttr('info.name', function($value, $data) { return strtolower($value); })->select(); ~~~ ? 可以在查詢之后使用`withAttr`方法，例如： ? ~~~ User::select()->withAttr('name', function($value, $data) { return strtolower($value); }); ~~~