获取器的作用是对模型实例的(原始)数据做出自动处理。一个获取器对应模型的一个特殊方法(该方法必须为public 类型),方法命名规范为:
getFieldNameAttr
FieldName 为数据表字段的驼峰转换,定义了获取器之后会在下列情况自动触发:
模型的数据对象取值操作($model->field_name );
模型的序列化输出操作( $model->toArray() 及 toJson() );
显式调用 getAttr 方法( $this->getAttr('field_name') );
获取器的场景包括:
时间日期字段的格式化输出;
集合或枚举类型的输出;
数字状态字段的输出;
组合字段的输出;
例如,我们需要对状态值进行转换,可以使用:class User extends Model
{
//获取器
//该方法必须为 public 类型
//数据库字段为 status
public function getStatusAttr($value)
{
$status = [-1 => '删除', 0 => '禁用', 1 => '正常', 2 => '待审核'];
return $status[$value];
}
//数据库字段为 add_time
//函数名中不能出现下划线
public function getAddTimeAttr($val)
{
return date('Y-m-d:H:i:s', $val);
}
}
数据表的字段会自动转换为驼峰法,一般 status 字段的值采用数值类型,我们可以通过获取器定义,自动转
换为字符串描述。$user = User::get(1);
echo $user->status; // 例如输出“正常”
获取器还可以定义数据表中不存在的字段,例如:class User extends Model
{
public function getStatusTextAttr($value, $data)
{
$status = [-1 => '删除', 0 => '禁用', 1 => '正常', 2 => '待审核'];
return $status[$data['status']];
}
}
获取器方法的第二个参数传入的是当前的所有数据数组
我们就可以直接使用statustext字段的值了,例$user = User::get(1);
echo $user->status_text; // 例如输出“正常”
如果你定义了获取器的情况下,希望获取数据表中的原始数据,可以使用:$user = User::get(1);
// 通过获取器获取字段
echo $user->status;
// 获取原始字段数据
echo $user->getData('status');
// 获取全部原始数据
dump($user->getData());