## 获取器
获取器的作用是对模型实例的(原始)数据做出自动处理。一个获取器对应模型的一个特殊方法(该方法必须为`public`类型),方法命名规范为:
>[info] ### get`FieldName`Attr
`FieldName`为数据表字段的驼峰转换,定义了获取器之后会在下列情况自动触发:
* 模型的数据对象取值操作(`$model->field_name`);
* 模型的序列化输出操作(`$model->toArray()`及`toJson()`);
* 显式调用`getAttr`方法(`$this->getAttr('field_name')`);
获取器的场景包括:
* 时间日期字段的格式化输出;
* 集合或枚举类型的输出;
* 数字状态字段的输出;
* 组合字段的输出;
例如,我们需要对状态值进行转换,可以使用:
~~~
<?php
namespace app\model;
use think\Model;
class User extends Model
{
public function getStatusAttr($value)
{
$status = [-1=>'删除',0=>'禁用',1=>'正常',2=>'待审核'];
return $status[$value];
}
}
~~~
数据表的字段会自动转换为驼峰法,一般`status`字段的值采用数值类型,我们可以通过获取器定义,自动转换为字符串描述。
~~~
$user = User::find(1);
echo $user->status; // 例如输出“正常”
~~~
获取器还可以定义数据表中不存在的字段,例如:
~~~
<?php
namespace app\model;
use think\Model;
class User extends Model
{
public function getStatusTextAttr($value,$data)
{
$status = [-1=>'删除',0=>'禁用',1=>'正常',2=>'待审核'];
return $status[$data['status']];
}
}
~~~
> 获取器方法的第二个参数传入的是当前的所有数据数组。
我们就可以直接使用status_text字段的值了,例如:
~~~
$user = User::find(1);
echo $user->status_text; // 例如输出“正常”
~~~
## 获取原始数据
如果你定义了获取器的情况下,希望获取数据表中的原始数据,可以使用:
~~~
$user = User::find(1);
// 通过获取器获取字段
echo $user->status;
// 获取原始字段数据
echo $user->getData('status');
// 获取全部原始数据
dump($user->getData());
~~~
## 动态获取器
可以支持对模型使用动态获取器,无需在模型类中定义获取器方法。
~~~
User::withAttr('name', function($value, $data) {
return strtolower($value);
})->select();
~~~
> `withAttr`方法支持多次调用,定义多个字段的获取器。另外注意,`withAttr`方法之后不能再使用模型的查询方法,必须使用Db类的查询方法。
>[danger] 如果同时还在模型里面定义了相同字段的获取器,则动态获取器优先,也就是可以临时覆盖定义某个字段的获取器。
支持对关联模型的字段使用动态获取器,例如:
~~~
User::with('profile')->withAttr('profile.name', function($value, $data) {
return strtolower($value);
})->select();
~~~
>[danger] 注意:对于`MorphTo`关联不支持使用动态获取器。
并且支持对`JSON`字段使用获取器,例如在模型中定义了`JSON`字段的话:
~~~
<?php
namespace app\index\model;
use think\Model;
class User extends Model
{
// 设置json类型字段
protected $json = ['info'];
}
~~~
可以使用下面的代码定义JSON字段的获取器。
~~~
User::withAttr('info.name', function($value, $data) {
return strtolower($value);
})->select();
~~~
可以在查询之后使用`withAttr`方法,例如:
~~~
User::select()->withAttr('name', function($value, $data) {
return strtolower($value);
});
~~~
## 查询结果处理
如果你需要处理多个字段的数据或者增加虚拟字段的话,可以使用新版本增加的查询结果处理机制更方便对模型对象实例进行统一的数据处理。
```
User::filter(function($user) {
$user->name = 'new value';
$user->test = 'test';
})->select();
```
>[danger] 注意:`filter`方法的数据处理和获取器并不冲突,`filter`处理的数据会改变模型的原始数据,获取器只有在取值或输出的时候才会进行处理。
- 序言
- 基础
- 安装
- 开发规范
- 目录结构
- 配置
- 架构
- 请求流程
- 架构总览
- 入口文件
- 多应用模式
- URL访问
- 容器和依赖注入
- 服务
- 门面
- 中间件
- 事件
- 路由
- 路由定义
- 变量规则
- 路由地址
- 路由参数
- 路由中间件
- 路由分组
- 资源路由
- 注解路由
- 路由绑定
- 域名路由
- MISS路由
- 跨域请求
- URL生成
- 控制器
- 控制器定义
- 基础控制器
- 空控制器
- 资源控制器
- 控制器中间件
- 请求
- 请求对象
- 请求信息
- 输入变量
- 请求类型
- HTTP头信息
- 伪静态
- 参数绑定
- 请求缓存
- 响应
- 响应输出
- 响应参数
- 重定向
- 文件下载
- 数据库
- 连接数据库
- 分布式数据库
- 查询构造器
- 查询数据
- 添加数据
- 更新数据
- 删除数据
- 查询表达式
- 链式操作
- where
- table
- alias
- field
- strict
- limit
- page
- order
- group
- having
- join
- union
- distinct
- lock
- cache
- cacheAlways
- comment
- fetchSql
- force
- partition
- failException
- sequence
- replace
- extra
- duplicate
- procedure
- 聚合查询
- 分页查询
- 时间查询
- 高级查询
- 视图查询
- JSON字段
- 子查询
- 原生查询
- 获取查询参数
- 查询事件
- 获取器
- 事务操作
- 存储过程
- 数据集
- 数据库驱动
- 模型
- 定义
- 模型字段
- 新增
- 更新
- 删除
- 查询
- 查询范围
- JSON字段
- 获取器
- 修改器
- 搜索器
- 数据集
- 自动时间戳
- 只读字段
- 软删除
- 类型转换
- 模型输出
- 模型事件
- 模型关联
- 一对一关联
- 一对多关联
- 远程一对多
- 远程一对一
- 多对多关联
- 多态关联
- 关联预载入
- 关联统计
- 关联输出
- 虚拟模型
- 视图
- 模板变量
- 视图过滤
- 模板渲染
- 模板引擎
- 视图驱动
- 错误和日志
- 异常处理
- 日志处理
- 调试
- 调试模式
- Trace调试
- SQL调试
- 变量调试
- 远程调试
- 验证
- 验证器
- 验证规则
- 错误信息
- 验证场景
- 路由验证
- 内置规则
- 表单令牌
- 注解验证
- 杂项
- 缓存
- Session
- Cookie
- 多语言
- 上传
- 命令行
- 启动内置服务器
- 查看版本
- 自动生成应用目录
- 创建类库文件
- 清除缓存文件
- 生成数据表字段缓存
- 生成路由映射缓存
- 输出路由定义
- 自定义指令
- Debug输出级别
- 扩展库
- 数据库迁移工具
- Workerman
- think助手工具库
- 验证码
- Swoole
- 附录
- 助手函数
- 升级指导
- 更新日志