ThinkPHP7模型搜索器怎么用

雪夜

雪夜

2026-07-22

152人浏览

原创

thinkphp7模型搜索器需在模型类中定义search+字段驼峰名+attr的public方法,如searchusernameattr,接收$query、$value、$data三参数并返回$query;必须通过withsearch(['field'], ['field'=>'value'])调用,配合select()执行,支持多字段搜索、动态排序、字段白名单校验及分页参数保留。

thinkphp7模型搜索器怎么用

ThinkPHP7模型搜索器需要在模型类中定义特定命名的public方法,再通过withSearch()调用才能生效,不能直接在控制器里写where条件模拟,否则字段映射、参数传递和闭包封装全失效。

定义搜索器方法

在模型类(如app\model\User.php)中,按search + 字段驼峰名 + Attr规则声明public方法:
比如数据库字段是user_name,对应搜索器方法名为searchUserNameAttr;字段是email_verified_at,则方法名为searchEmailVerifiedAtAttr。

每个搜索器方法必须接收三个参数:$query(查询对象)、$value(用户传入的关键词值)、$data(整个搜索参数数组),且必须返回$query对象以维持链式调用。

【方法名必须严格匹配字段驼峰转换规则,拼错一个字母或大小写不符,withSearch()就完全不触发该方法】

示例代码:

public function searchUserNameAttr($query, $value, $data)
{
  $query->where('user_name', 'like', '%' . $value . '%');
}

调用搜索器执行查询

控制器中不能用User::where('user_name', 'like', '%xxx%')——这是绕过搜索器的原始写法,丢失了封装逻辑和字段校验能力。

正确调用方式是使用withSearch(),它接收两个数组参数:
第一个是启用的搜索器字段列表,如['user_name', 'email'];
第二个是各字段对应的搜索值,如['user_name' => 'admin', 'email' => 'test@']。

注意:withSearch()必须配合select()或find()等终端方法才能真正执行SQL,单独调用只是构造查询条件。

完整示例:
$users = User::withSearch(['user_name'], ['user_name' => 'think'])->select();

PHP 8.5.5
PHP 8.5.5

PHP 8.5.5 是 PHP 8.5 分支的维护更新版本。该版本延续了“小步快跑”的迭代逻辑,通过深度错误修复、底层性能微调以及安全加固,旨在为开发者提供一个更健壮、更高效的运行环境。该版本严格遵守语义化版本规范,不包含破坏性变更。

下载

多字段联合搜索与排序控制

方法一:启用多个搜索器
在模型中分别定义searchUserNameAttr、searchEmailAttr、searchStatusAttr等方法;
调用时传入对应字段名数组:withSearch(['user_name', 'email', 'status'], [...])。

方法二:单个搜索器内支持多字段OR逻辑
不推荐在搜索器里硬写多个whereOr(),容易污染全局查询;
应由控制器层构建闭包,把合法字段数组透传进搜索器,再在闭包内循环调用whereOr()。

方法三:在搜索器中读取$data参数实现动态排序
比如用户提交了sort=created_at|desc,可在searchUserNameAttr方法里判断:
if (!empty($data['sort'])) { $query->order($data['sort']); }
这比在控制器里重复写order()更易复用和维护。

字段白名单校验与安全过滤

第一步:获取模型真实字段列表
$schemaFields = (new User())->getSchemaFields(); // 返回数据库字段小写蛇形数组

第二步:校验用户传入的搜索字段是否在白名单内
$field = input('field', 'user_name');
if (!in_array($field, $schemaFields)) { $field = 'user_name'; }

第三步:禁止将用户输入直接拼进SQL字符串
错误写法:where("{$field}", 'like', "%{$keyword}%") —— 字段名未校验,存在SQL注入风险;
正确路径:只允许白名单字段进入withSearch()第一参数,其余一律丢弃。

【开启模型strict模式后,非法字段会直接抛出异常而非静默忽略,调试阶段务必打开】

分页时保留动态搜索参数

第一步:手动设置分页query参数
$users = User::withSearch(['user_name'], ['user_name' => $keyword])
  ->paginate(15, false, ['query' => ['field' => 'user_name', 'keyword' => $keyword]]);

第二步:避免使用默认分页链接生成逻辑
Paginator组件不会自动捕获withSearch()中的动态键名,field和keyword必须显式塞进query选项,否则翻页后条件清空。

第三步:前端URL需携带原始参数
生成分页HTML前,确保模板中分页链接已包含?field=user_name&keyword=admin这类参数,否则后端无法还原搜索上下文。

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

相关文章

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

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

下载

相关标签:

php thinkphp php7

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

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

5528

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

3630

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

1808

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

2294

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

2831

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

2021

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

3076

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

2340

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

10931

4

热门下载

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

精品课程

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