eloquent mutator——迹忆客-ag捕鱼王app官网
简介
访问器和修改器允许你在获取模型属性或设置其值时格式化 eloquent 属性。例如,我们可能想要使用 laravel 加密器对存储在数据库中的数据进行加密,并且在 eloquent 模型中访问时自动进行解密。
除了自定义访问器和修改器,eloquent 还可以自动转换日期字段为 carbon 实例甚至将文本转换为json。
访问器 & 修改器
定义访问器
要定义一个访问器,需要在模型中创建一个 getfooattribute 方法,其中 foo 是我们想要访问的字段名(使用驼峰式命名规则)。在本例中,我们将会为 first_name 属性定义一个访问器,该访问器在获取 first_name 的值时被 eloquent 自动调用:
正如我们所看到的,该字段的原生值被传递给访问器,然后返回处理过的值。要访问该值只需要简单访问 first_name 即可:
$user = app\user::find(1);
$firstname = $user->first_name;
当然,我们也可以使用访问器将已存在的属性转化为全新的、经过处理的值:
/**
* get the user's full name.
*
* @return string
*/
public function getfullnameattribute()
{
return "{$this->first_name} {$this->last_name}";
}
注:如果你想要把这些计算值添加到以数组/json格式表示的模型,需要手动追加它们。
定义修改器
要定义一个修改器,需要在模型中定义 setfooattribute 方法,其中 foo 是我们想要访问的字段(使用驼峰式命名规则)。接下来让我们为 first_name 属性定义一个修改器,当我们为模型上的 first_name 赋值时该修改器会被自动调用:
attributes['first_name'] = strtolower($value);
}
}
该修改器获取要被设置的属性值,允许你操纵该值并设置 eloquent 模型内部属性值为操作后的值。例如,如果你尝试设置 sally 的 first_name 属性:
$user = app\user::find(1);
$user->first_name = 'sally';
在本例中,setfirstnameattribute
方法会被调用,传入参数为 sally,修改器会对其调用 strtolower
函数并将处理后的值设置为内部属性的值。
日期修改器
默认情况下,eloquent 将会转化 created_at 和 updated_at 列的值为 carbon 实例,该类继承自 php 原生的 datetime
类,并提供了各种有用的方法。我们可以自定义哪些字段被自动调整修改,甚至可以通过重写模型中的 $dates 属性完全禁止调整:
注:我们可以通过设置模型的公共属性 $timestamps
值为 false 来禁止默认的 created_at 和 updated_at 时间戳。
如果字段是日期格式时,我们可以将其值设置为 unix 时间戳,日期字符串(y-m-d),日期-时间字符串,datetime/carbon 实例,日期的值将会自动以正确格式存储到数据库中:
$user = app\user::find(1);
$user->disabled_at = carbon::now();
$user->save();
正如上面提到的,当获取被罗列在 $dates
数组中的属性时,它们会被自动转化为 carbon
实例,并允许你在属性上使用任何 carbon
类的方法:
$user = app\user::find(1);
return $user->disabled_at->gettimestamp();
日期格式化
默认情况下,时间戳的格式是 'y-m-d h:i:s',如果我们需要自定义时间戳格式,在模型中设置 $dateformat
属性,该属性决定日期属性存储在数据库以及序列化为数组或 json 时的格式:
属性转换
模型中的 $casts
属性为属性字段转换到通用数据类型提供了便利方法 。$casts
属性是数组格式,其键是要被转换的属性名称,其值时你想要转换的类型。目前支持的转换类型包括:integer, real, float, double, decimal:
, string, boolean, object,array,collection,date,datetime 和 timestamp。转化为 decimal 时,必须定义数字的位数(decimal:2)。
例如,让我们转换 is_admin 属性,将其由 integer 值(0或1)转换为 boolean 值:
'boolean',
];
}
现在,is_admin
属性在被访问时总是被转换为 boolean,即使底层存储在数据库中的值是 integer:
$user = app\user::find(1);
if ($user->is_admin) {
//
}
null
不会被转换的属性。此外,我们永远不应定义与关系同名的强制转换(或属性)。
自定义转化
laravel 提供了多种内置的、有用的转化类型,不过,有时候你可能需要自定义自己的类型,这可以通过定义一个实现 castsattributes 接口的类来完成。
实现该接口的类必须定义 get 和 set 方法,get 方法负责将数据库原生值转化为转化值,而 set 方法会将转化值转化为可以存储到数据库的值。例如,我们通过自定义转化类型来重新实现内置的 json 转化类型:
定义好自定义转化类型后,可以通过类名将其应用到模型属性使其生效:
json::class,
];
}
值对象转化
我们可以将值转化为原生类型,也可以将其转化为对象。定义值与对象的自定义转化和原生类型类似,不过,set
方法这个时候应该返回键值对数组,用于定义存储到数据库的字段与值的映射关系。
举个例子,我们来定义一个自定义的转化类,将多个模型属性值转化为单个 address
值对象,假设 address 值有两个公共属性 —— lineone 和 linetwo:
$value->lineone,
'address_line_two' => $value->linetwo,
];
}
}
当转化为值对象时,任何对值对象的修改都会在模型保存之前自动同步到模型实例:
$user = app\user::find(1);
$user->address->lineone = 'updated address value';
$user->save();
如果打算将包含值对象的 eloquent 模型序列化为 json 或数组,应该在值对象上实现illuminate\contracts\support\arrayable
和jsonserializable
接口。
写入转化
有时候,你可能需要编写一个这样的自定义转化:只有在保存模型到数据库时才应用类型转化,从数据库初始化模型实例时不做任何操作,我们姑且将其称作「写入转化」。一个典型的写入转化例子就是「哈希」转化,自定义的写入转化类需要实现 castsinboundattributes 接口,并且只需要实现 set 方法即可:
algorithm = $algorithm;
}
/**
* prepare the given value for storage.
*
* @param \illuminate\database\eloquent\model $model
* @param string $key
* @param array $value
* @param array $attributes
* @return string
*/
public function set($model, $key, $value, $attributes)
{
return is_null($this->algorithm)
? bcrypt($value)
: hash($this->algorithm, $value);
}
}
转化参数
将自定义转换附加到模型时,指定转换参数。参数将传递给强制转换类的构造函数:
当应用自定以转化到模型时,转化参数可以通过使用:
字符和逗号,
分隔多个参数将它们与类名称分开来。
/**
* the attributes that should be cast.
*
* @var array
*/
protected $casts = [
'secret' => hash::class.':sha256',
];
转化类
除了将自定义转换附加到我们的模型之外,还可以附加一个实现illuminate\contracts\database\eloquent\castable
接口的类:
protected $casts = [
'address' => \app\address::class,
];
实现castable
接口的对象必须定义一个castusing
方法,该方法返回 负责在类之间进行转换的自定义 caster 类的castable
类名:
使用castable
类时,仍然可以在$casts
中提供参数。参数将直接传递给 caster
类:
protected $casts = [
'address' => \app\address::class.':argument',
];
数组 & json 转换
array 类型转换在处理被存储为序列化 json 格式的字段时特别有用,例如,如果数据库有一个 json 或 text 字段类型包含了序列化 json,添加 array 类型转换到该属性将会在 eloquent 模型中访问其值时自动将其反序列化为 php 数组:
'array',
];
}
类型转换被定义后,访问 options 属性将会自动从 json 反序列化为 php 数组,反之,当设置 options 属性的值时,给定数组将会自动转化为 json 以供存储:
$user = app\user::find(1);
$options = $user->options;
$options['key'] = 'value';
$user->options = $options;
$user->save();
日期转换
当使用 date 或 datetime 转换类型时,可以指定日期的格式,这个格式会在模型序列化为数组或json时使用:
/**
* the attributes that should be cast to native types.
*
* @var array
*/
protected $casts = [
'created_at' => 'datetime:y-m-d',
];
查询期间时间转化
有时候,我们可能需要在执行数据库操作时应用类型转化,比如从数据表获取原始值时。考虑下面这个示例:
use app\post;
use app\user;
$users = user::select([
'users.*',
'last_posted_at' => post::selectraw('max(created_at)')
->wherecolumn('user_id', 'users.id')
])->get();
查询结果集的 last_posted_at
属性值时一个原始字符串,如果能在执行查询时在该属性上应用 date 类型转化将会非常方便。要实现这个功能,可以使用 withcasts
方法:
$users = user::select([
'users.*',
'last_posted_at' => post::selectraw('max(created_at)')
->wherecolumn('user_id', 'users.id')
])->withcasts([
'last_posted_at' => 'date'
])->get();
查看笔记