快速入门 20:自动完成
最后更新于:2022-04-01 00:18:59
# 快速入门(二十):自动完成
自动完成是ThinkPHP提供用来完成数据自动处理和过滤的方法,使用create方法创建数据对象的时候会自动完成数据处理。
## 规则定义
自动完成通常用来完成默认字段写入,安全字段过滤以及业务逻辑的自动处理等,和自动验证的定义方式类似,自动完成的定义也支持静态定义和动态定义两种方式。
1. 静态方式:在模型类里面通过$_auto属性定义处理规则。
2. 动态方式:使用模型类的auto方法动态创建自动处理规则。
两种方式的定义规则都采用:
~~~
array(
array(完成字段1,完成规则,[完成条件,附加规则]),
array(完成字段2,完成规则,[完成条件,附加规则]),
......
);
~~~
说明
**完成字段(必须)**
需要进行处理的数据表实际字段名称。
**完成规则(必须)**
需要处理的规则,配合附加规则完成。
**完成时间(可选)**
设置自动完成的时间,包括:
| 设置 | 说明 |
| --- | --- |
| self::MODEL_INSERT或者1 | 新增数据的时候处理(默认) |
| self::MODEL_UPDATE或者2 | 更新数据的时候处理 |
| self::MODEL_BOTH或者3 | 所有情况都进行处理 |
**附加规则(可选)**
设置自动完成的附加规则,包括:
| 规则 | 说明 |
| --- | --- |
| function | 使用函数,表示填充的内容是一个函数名 |
| callback | 回调方法 ,表示填充的内容是一个当前模型的方法 |
| field | 用其它字段填充,表示填充的内容是一个其他字段的值 |
| string | 字符串(默认方式) |
| ignore | 为空则忽略(3.1.2新增) |
预先在模型类里面定义好自动完成的规则,我们称之为静态定义。例如,我们在模型类定义`_auto`属性:
~~~
namespace Home\Model;
use Think\Model;
class UserModel extends Model{
protected $_auto = array (
array('status','1'), // 新增的时候把status字段设置为1
array('password','md5',3,'function') , // 对password字段在新增和编辑的时候使md5函数处理
array('name','getName',3,'callback'), // 对name字段在新增和编辑的时候回调getName方法
array('update_time','time',2,'function'), // 对update_time字段在更新的时候写入当前时间戳
);
}
~~~
然后,就可以在使用create方法创建数据对象的时候自动处理:
~~~
$User = D("User"); // 实例化User对象
if (!$User->create()){ // 创建数据对象
// 如果创建失败 表示验证没有通过 输出错误提示信息
exit($User->getError());
}else{
// 验证通过 写入新增数据
$User->add();
}
~~~
如果你没有定义任何自动验证规则的话,则不需要判断create方法的返回值:
~~~
$User = D("User"); // 实例化User对象
$User->create(); // 生成数据对象
$User->add(); // 新增用户数据
~~~
或者更简单的使用:
~~~
$User = D("User"); // 实例化User对象
$User->create(); // 生成数据对象
$User->add(); // 写入数据
~~~
create方法默认情况下是根据表单提交的post数据生成数据对象,我们也可以根据其他的数据源来生成数据对象,你也可以明确指定当前创建的数据对象自动处理的时间是新增还是编辑数据,例如:
~~~
$User = D("User"); // 实例化User对象
$userData = getUserData(); // 通过方法获取用户数据
$User->create($userData,2); // 根据userData数据创建数据对象,并指定为更新数据
$User->add();
~~~
create方法的第二个参数就用于指定自动完成规则中的完成时间,也就是说create方法的自动处理规则只会处理符合完成时间的自动完成规则。 create方法在创建数据的时候,已经自动过滤了非数据表字段数据信息,因此不需要担心表单会提交其他的非法字段信息而导致数据对象写入出错,甚至还可以自动过滤不希望用户在表单提交的字段信息(详见字段合法性过滤)。
3.1.2版本开始新增了ignore完成规则,这一规则表示某个字段如果留空的话则忽略,通常可用于修改用户资料时候密码的输入,定义如下:
~~~
array('password','',2,'ignore')
~~~
表示password字段编辑的时候留空则忽略。
## 动态完成
除了静态定义之外,我们也可以采用动态设置自动完成规则的方式来解决不同的处理规则。
~~~
$rules = array (
array('status','1'), // 新增的时候把status字段设置为1
array('password','md5',3,'function') , // 对password字段在新增和编辑的时候使md5函数处理
array('update_time','time',2,'function'), // 对update_time字段在更新的时候写入当前时间戳
);
$User = M('User');
$User->auto($rules)->create();
$User->add();
~~~
## 修改数据对象
在使用create方法创建好数据对象之后,此时的数据对象保存在内存中,因此仍然可以操作数据对象,包括修改或者增加数据对象的值,例如:
~~~
$User = D("User"); // 实例化User对象
$User->create(); // 生成数据对象
$User->status = 2; // 修改数据对象的status属性
$User->register_time = NOW_TIME; // 增加register_time属性
$User->add(); // 新增用户数据
~~~
一旦调用了add方法(或者save方法),创建在内存中的数据对象就会失效,如果希望创建好的数据对象在后面的数据处理中再次调用,可以保存数据对象先,例如:
~~~
$User = D("User"); // 实例化User对象
$data = $User->create(); // 保存生成的数据对象
$User->add();
~~~
不过要记得,如果你修改了内存中的数据对象并不会自动更新保存的数据对象,因此下面的用法是错误的:
~~~
$User = D("User"); // 实例化User对象
$data = $User->create(); // 保存生成的数据对象
$User->status = 2; // 修改数据对象的status属性
$User->register_time = NOW_TIME; // 增加register_time属性
$User->add($data);
~~~
上面的代码我们修改了数据对象,但是仍然写入的是之前保存的数据对象,因此对数据对象的更改操作将会无效。