获取器

版本 更新功能
5.0.10 获取器方法增加第三个参数传入关联数据

获取器

获取器的作用是在获取数据的字段值后自动进行处理,例如,我们需要对状态值进行转换,可以使用:

class User extends Model 
{
    public function getStatusAttr($value)
    {
        $status = [-1=>'删除',0=>'禁用',1=>'正常',2=>'待审核'];
        return $status[$value];
    }
}

数据表的字段会自动转换为驼峰法,一般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']];
    }
}

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

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

$user = User::get(1);
echo $user->status_text; // 例如输出“正常”

获取器只有当获取某个数据属性的时候自动触发,如果你要获取包含获取器处理的全部数据属性的话,可以使用下面的方法:

$user = User::get(1);
// 获取全部获取器数据
dump($user->toArray());

获取原始数据

如果你定义了获取器的情况下,希望获取数据表中的原始数据,可以使用:

$user = User::get(1);
// 通过获取器获取字段
echo $user->status;
// 获取原始字段数据
echo $user->getData('status');
// 获取全部原始数据
dump($user->getData());