获取器的作用是对模型实例的(原始)数据做出自动处理。一个获取器对应模型的一个特殊方法(该方法必须为public类型),方法命名规范为:

简单说就是处理字段用的,这个功能非常有用

规范为:

getFieldNameAttr

FieldName 为数据表字段的驼峰转换,定义了获取器之后会在下列情况自动触发:

  1. 模型的数据对象取值操作($model->field_name);
  2. 模型的序列化输出操作($model->toArray()及toJson());
  3. 显式调用getAttr方法($this->getAttr(‘field_name’));

1. 字段转换

如我在模型中添加对 gender 这个字段的处理:

  1. <?php
  2. // 数据转化 转换性别
  3. public function getGenderAttr($value)
  4. {
  5. $gender = [1 => '男', 2 => '女'];
  6. return $gender[$value];
  7. }

postman 测试:
image.png


2. 设置不存在的字段(使用较少)

我自己暂时没有发现好的应用场景

获取器还可以定义数据表中不存在的字段,例如:

  1. <?php
  2. class User extends Model
  3. {
  4. public function getStatusTextAttr($value,$data)
  5. {
  6. $status = [-1=>'删除',0=>'禁用',1=>'正常',2=>'待审核'];
  7. return $status[$data['status']];
  8. }
  9. }

获取器方法的第二个参数传入的是当前的所有数据数组。

我们就可以直接使用status_text字段的值了,例如:

  1. <?php
  2. $user = User::get(1);
  3. echo $user->status_text; // 例如输出“正常”

3. 获取原始数据

getData() 获取原始数据

  1. <?php
  2. // 获取器
  3. public function getter1($id)
  4. {
  5. $user = UserModel::get($id);
  6. // 通过获取器获取字段
  7. echo $user->gender;
  8. // 获取原始字段数据
  9. echo $user->getData('gender');
  10. // 获取全部原始数据
  11. dump($user->getData());
  12. }

4. 动态获取器(了解)

感觉我不会使用这个麻烦

V5.1.20+版本开始,可以支持对模型使用动态获取器,无需在模型类中定义获取器方法。

  1. <?php
  2. User::withAttr('name', function($value, $data) {
  3. return strtolower($value);
  4. })->select();

withAttr方法支持多次调用,定义多个字段的获取器。另外注意,withAttr方法之后不能再使用模型的查询方法,必须使用Db类的查询方法。