Yii2AR 模型 toArray 输出,隐藏指定字段属性配置

阿枫姑娘_2101

阿枫姑娘_2101

2026-10-03

667人浏览

原创

yii 2 active record 通过重写 fields() 控制 toarray() 默认输出字段(如隐藏 password_hash),用 extrafields() 管理关联数据扩展字段,并支持权限动态过滤。

yii2ar 模型 toarray 输出,隐藏指定字段属性配置

Yii 2 的 Active Record 模型默认调用 toArray() 会把所有公开属性(包括数据库字段、虚拟属性、关联对象等)转为数组。若需隐藏某些敏感或冗余字段(如 password_hash、auth_key、created_at 等),不能靠前端过滤或手动 unset,而应通过模型层统一控制——核心方式是重写 fields() 和/或 extraFields() 方法。

只保留白名单字段:重写 fields()

该方法定义 toArray() 默认输出的字段集合。返回一个键值数组,键为输出字段名,值为对应属性名或闭包。

  • 不声明的字段不会出现在结果中,天然实现“隐藏”
  • 可返回 parent::fields() 再 unset 特定项,也可全新定义
  • 示例:隐藏密码相关字段和时间戳
public function fields()
{
  $fields = parent::fields();
  unset($fields['password_hash'], $fields['auth_key'], $fields['password_reset_token']);
  return $fields;
}

按需扩展额外字段:重写 extraFields()

该方法用于支持 toArray(['id', 'name'], ['profile']) 中的第二个参数(即显式请求的扩展字段)。它不影响默认输出,但可用来安全暴露关联数据。

Yii Framework 2.0.51
Yii Framework 2.0.51

Yii Framework 2.0.51 官方 Basic 应用模板,适合旧项目兼容、升级验证和开发测试。

下载
  • 常用于控制关联模型是否加载、是否过滤其内部字段
  • 例如只允许输出 profile 关联中的 nickname 和 avatar,不暴露 user_id 或 updated_at
public function extraFields()
{
  return [
    'profile' => function () {
      return $this->profile ? $this->profile->toArray(['nickname', 'avatar']) : null;
    },
  ];
}

配合场景:API 输出与序列化控制

在 RESTful 接口或 JSON 返回中,建议结合 Serializer 或控制器层统一处理,避免每个地方重复逻辑。

  • 控制器中可直接调用 $model->toArray(['id', 'username', 'email']) 指定字段子集
  • 若使用 yii\rest\Serializer,它会自动调用 fields();你只需确保模型已正确定义
  • 注意:hidden 属性(Laravel 风格)在 Yii 2 中不存在,不可直接设置 public $hidden = [...]

进阶:动态字段控制(如角色权限)

若需根据当前用户权限决定是否输出某字段(如管理员可见 last_login_ip,普通用户不可见),可在 fields() 中加入运行时判断:

  • 检查 Yii::$app->user->can('viewIp') 或类似授权逻辑
  • 字段值可为闭包,实现懒计算与条件过滤
public function fields()
{
  $fields = parent::fields();
  if (!Yii::$app->user->can('admin')) {
    unset($fields['last_login_ip'], $fields['login_count']);
  }
  return $fields;
}

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

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

下载

相关标签:

yii框架 yii2 yii

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

相关专题

更多
go语言 面向对象
go语言 面向对象

本专题整合了go语言面向对象相关内容,阅读专题下面的文章了解更多详细内容。

2025.09.05

5595

14

java面向对象
java面向对象

本专题整合了java面向对象相关内容,阅读专题下面的文章了解更多详细内容。

2025.11.27

302

13

C++ 面向对象编程与设计模式实践
C++ 面向对象编程与设计模式实践

本专题整合了 C++ 面向对象编程的核心机制,涵盖类的定义与访问控制、构造函数与析构函数、拷贝语义与移动语义、继承与虚函数多态、抽象类与接口、运算符重载、友元函数等关键知识点,同时结合单例模式、工厂模式、观察者模式、策略模式等常用设计模式的 C++ 实现,帮助开发者写出结构清晰、易于维护的面向对象代码。

2026.04.09

324

30

Java 面向对象与核心编程机制
Java 面向对象与核心编程机制

系统讲解 Java 面向对象编程的核心知识体系,涵盖类的定义与封装、构造方法与 this/super 关键字、继承与方法重写、多态与向上向下转型、抽象类与接口的区别与设计原则、异常处理机制(try-catch-finally / 自定义异常)、泛型的类型参数与通配符、集合框架(List/Set/Map)的使用与遍历方式,帮助开发者全面掌握 Java 程序设计的核心机制与面向对象思维。

2026.04.17

203

15

PHP Yii框架专题
PHP Yii框架专题

本专题专注于PHP主流框架Yii的应用,系统讲解MVC架构、路由机制、数据库操作、表单处理、安全验证与RESTful API 开发等核心内容。通过电商网站、后台管理系统与内容管理平台等实战项目,帮助学员快速掌握Yii框架的开发技巧与实战经验。

2025.09.04

2890

22

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

2026.09.30

20

10

LLVM RISC-V参数配置教程
LLVM RISC-V参数配置教程

本专题介绍LLVM对RISC-V基础ISA和扩展的支持方式,涵盖RV32、RV64、标准扩展、实验性扩展、厂商扩展、-menable-experimental-extensions和版本差异。

2026.09.30

40

14

LLVM IR中间表示入门指南
LLVM IR中间表示入门指南

本专题整理LLVM IR的核心概念,包括中间表示作用、模块结构、函数、基本块、SSA形式、类型系统和常见语法,帮助新手理解LLVM编译流程中的关键层。

2026.09.30

20

12

PDF转图片方法
PDF转图片方法

需要把 PDF 页面用于上传、预览、分享或图片归档时,PDF 转图片方法专题整理 JPG/PNG 格式选择、逐页导出、清晰度设置、批量下载和结果检查等流程,帮助用户稳定完成 PDF 图片化处理。

2026.09.30

20

26

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Yii2.0框架开发实战视频教程
Yii2.0框架开发实战视频教程

共22课时 | 9.3万人学习

Yii2框架基础视频教程
Yii2框架基础视频教程

共22课时 | 2.8万人学习