ThinkPHP:模型三大利器之二(修改器)

雨丽君_3244

雨丽君_3244

2019-12-16

3011人浏览

转载

修改器是模型的三大利「器」之一,本篇我们来总结下修改器的用法,以及一些注意事项。

定义修改器

修改器的作用是在模型对象数据写入数据库之前进行一些必要的数据处理,修改器的标准定义如下:

public function setFieldNameAttr($value, $data)
{
    // 对value值进行处理 data参数是当前全部数据
    // 返回值就是实际要写入数据库的值
    return $value;
}

其中FieldName对应数据表的field_name字段(注意数据表字段的规范和修改器方法定义规范,否则会导致错误)。

原则上,每个修改器应当仅处理对应字段的数据,但在必要的情况下允许同时处理多个字段。

下面是一个例子

public function setBirthdayAttr($value, $data)
{
    // 格式化生日数据
    $birthday = strtotime($value);
    // 根据生日判断年龄
    $age = getAgeByBirthday($birthday);
    // 赋值年龄数据
    $this->setAttr('age', $age);
    return $birthday;
}
public function setAgeAttr($value,$data)
{
    return floor($value);
}

之所以使用setAttr方法是确保年龄赋值操作仍然可以走单独的修改器。如果你没有额外的修改器,那么也可以写成

public function setBirthdayAttr($value, $data)
{
    // 格式化生日数据
    $birthday = strtotime($value);
    // 根据生日判断年龄
    $age = getAgeByBirthday($birthday);
    // 赋值年龄数据
    $this->data['age'] = $age;
    return $birthday;
}

注意一定不能写成

$this->age = $age;

因为在模型内部进行数据对象的赋值,会因为和模型内部属性混淆而导致不可预知的后果。

如果你在某个修改器中可能会对其它字段进行修改,务必记得你需要额外修改的字段修改器必须已经经过赋值操作(或者已经触发过修改器)。

如何调用

修改器方法不需要手动调用,按照定义规范定义好后,系统会在下面的情况下自动调用:

    ·模型对象赋值;

    ·调用模型的data方法,并且第二个参数传入true;

    ·调用模型的save方法,并且传入数组数据;

    ·显式调用模型的setAttr方法;

    ·定义了该字段的自动完成;

例如User模型定义了setPasswordAttr修改器方法。

public function setPasswordAttr($value, $data)
{
    return md5($value);
}

当下面这样使用的时候,保存到数据库的password字段的值就会变成md5('think')后的值。

ThinkPHP5.1企业站点快速开发-源码课件
ThinkPHP5.1企业站点快速开发-源码课件

ThinkPHP5.1企业站点快速开发

下载
$user = User::get(1);
$user->password = 'think';
$user->save();

如果你在一些情况下,不希望使用修改器而是想要手动控制数据,可以尝试使用下面的方法。

$user = User::get(1);
$user->data('password', md5('think'));
$user->save();

这个时候就不会经过修改器处理。

避免冲突

很多开发者喜欢给修改器定义自动完成auto(包括insert和update)。

protected $auto = ['password'];

这在V5.1.27版本之前是一个看似聪明却非常致命的错误,要尽量避免,因为根据我们之前给出的修改器触发条件,会导致该修改器被执行两次。这会是一个灾难性的错误,将导致所有的用户注册后都无法正常登录。

解决办法取消password字段的自动完成设置,因为修改器会在每次赋值的时候自动触发,如果没有赋值说明密码没有被修改,也谈不上自动完成。

自动完成的字段通常是不在表单里面的字段,一般是由系统自动处理的字段。

V5.1.27版本改进了这个问题,所有的修改器只允许执行一次,上面的问题就不复存在了。但好像又带来了一个新的问题,很多时候,你也许想在模型的事件中对数据进行修改。

User::beforeUpdate(function($user) {
    $user->password = md5('think');
});

会发现,在模型beforeUpdate事件中,数据的值怎么都修改不了,原因是模型的修改器之前在第一次赋值的时候已经执行了,第二次再赋值的时候已经无效了(不会再执行)。

解决办法就是我前面提过的使用data方法不调用修改器进行数据赋值操作。

User::beforeUpdate(function($user) {
    $user->data('password', md5('think'));
});

当然,更好的建议是规划好修改器、自动完成和模型事件的数据处理机制,不要对一个字段同时使用多重机制修改数据,并且写入数据库的数据应该并且只有修改器这一个途径进行数据修改操作。

类型自动转化

如果你的修改器仅仅是对数据做类型转换处理的话,可以无需定义修改器,而是直接定义字段类型就可以了。

public function setScoreAttr($value, $data)
{
    return (float) $score;
}

上面的修改器方法可以直接改成

protected $type = [
    'score'    =>    'float',
];

如果你同时对一个字段定义了修改器和类型的话,修改器是优先的。

类型定义不仅能定义简单的数据类型,还有一些额外的用途,例如:json 类型、array类型和object 类型会进行JSON序列化,serialize类型则会把数据进行serialize序列化。

PHP中文网,有大量免费的ThinkPHP入门教程,欢迎大家学习!

本文转自:https://blog.thinkphp.cn/817548

php免费学习视频:立即使用
踏上前端学习之旅,开启通往精通之路!从前端基础到项目实战,循序渐进,一步一个脚印,迈向巅峰!

相关文章

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

thinkphp 修改器

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

2026.10.28

40

16

Vite 如何搭配 Vue.js
Vite 如何搭配 Vue.js

Vite搭配Vue.js专题汇集创建Vue 3项目、配置开发环境、路径别名、Vue插件、代理、多环境构建与调试的已审核文章,帮助读者完成从初始化到日常开发的配置。

2026.10.28

20

15

Vite 项目目录怎么看
Vite 项目目录怎么看

Vite项目目录专题汇集入口文件、src源码、public静态资源、路径别名、项目根目录和构建输出目录相关的已审核文章,帮助读者理解各文件夹的用途与引用方式。

2026.10.28

40

10

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

2026.10.22

120

11

Gradle Wrapper配置教程
Gradle Wrapper配置教程

本专题介绍Gradle Wrapper的基本作用,涵盖文件组成、生成方法、版本配置和任务调用,帮助你理解项目如何使用指定的Gradle版本,减少不同开发环境带来的构建差异。

2026.10.22

80

10

Golangci-lint检查器使用教程
Golangci-lint检查器使用教程

本专题整理Golangci-lint常用Linters的用途与配置方法,覆盖错误处理、无效代码、安全、复杂度、命名和依赖检查,帮助项目合理选规则。

2026.10.22

80

15

Gradle怎么构建Java项目
Gradle怎么构建Java项目

本专题介绍Gradle Java项目构建方法,涵盖Java插件配置、依赖声明、源码编译、测试执行和打包检查,帮助你理解各阶段的任务关系,逐步完成项目构建。

2026.10.22

40

10

PHP时间戳漏洞修复教程
PHP时间戳漏洞修复教程

本专题汇总PHP常见时间戳漏洞,包括2038年溢出、时区漂移、时间戳伪造、重放攻击、时间盲注与日志审计失效等,并给出升级64位环境、使用 DateTimeImmutable、统一UTC、严格超时校验、预处理绑定、hash_equals 比对等修复方案,帮助开发者快速排查和加固时间相关代码。

2026.10.22

80

25

Golangci-lint配置文件与规则设置
Golangci-lint配置文件与规则设置

本专题聚焦Golangci-lint YAML配置文件,讲清运行参数、规则启停、目录排除、问题过滤及严重级别设置,便于团队统一检查标准。

2026.10.22

40

15

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程