ThinkPHP模型搜索_ThinkPHP高级搜索介绍【方法】

老静大大_5239

老静大大_5239

2026-05-01

888人浏览

原创

withsearch是唯一触发搜索器的方法,必须作为模型静态方法调用,如user::withsearch(['name'], ['name'=>'admin'])->select();搜索器方法名须为searchfieldnameattr格式,且仅处理白名单字段,不校验类型或报错。

thinkphp模型搜索_thinkphp高级搜索介绍【方法】

withSearch 是唯一能触发搜索器的方法,其他查询方式(where、find、select)完全无视搜索器定义。


withSearch 必须配合模型方法调用,不能链在 Query 对象后

withSearch 是模型类的静态方法,只能在模型类上调用,比如 User::withSearch(...)。
它不是 Query 实例的方法,所以写成 User::where(...)->withSearch(...) 会报错:Call to undefined method think\db\Query::withSearch()。

  • ✅ 正确写法:

    User::withSearch(['name', 'status'], ['name' => 'admin', 'status' => 1])->select();
  • ❌ 错误写法:

    User::where('id', '>', 10)->withSearch([...])->select(); // 报错
  • 搜索器方法名必须严格遵循 searchFieldNameAttr 格式(驼峰字段名 + Attr 后缀),例如:

    • 表字段是 create_time → 方法名是 searchCreateTimeAttr
    • 表字段是 user_name → 方法名是 searchUserNameAttr
  • 第一个参数是搜索标识数组,只控制哪些字段允许被搜索;第二个参数是实际传入的值,键名必须和搜索标识一致,否则该搜索器不会执行。

    btpanel phpsite 宝塔面板PHP网站
    btpanel phpsite 宝塔面板PHP网站

    宝塔面板 PHP 网站管理:站点创建、删除、启停、PHP 版本切换、域名管理、SSL证书管理、伪静态管理、数据库管理

    下载

搜索器内部不能直接用 $query->where() 硬拼条件

搜索器函数签名是:public function searchNameAttr($query, $value, $data)。
其中 $query 是当前模型的查询对象(think\db\Query 实例),但它的作用域仅限于本次搜索器逻辑——它不累积到外层查询链,除非你显式返回或修改它。

常见错误是写成:

public function searchNameAttr($query, $value, $data) {
    $query->where('name', 'like', "%{$value}%"); // ❌ 无效:没返回,也没绑定到主查询
}

✅ 正确做法是:

public function searchNameAttr($query, $value, $data) {
    $query->where('name', 'like', "%{$value}%"); // ✅ 可以,$query 是引用传递
}

ThinkPHP 的 $query 在搜索器中是引用传递,修改即生效。但要注意:不要在搜索器里调用 select() 或 find(),那会提前执行查询。


搜索器不处理未声明的字段,也不校验类型,容易漏掉非法参数

withSearch 的设计初衷就是白名单过滤:只允许你在第一个参数数组里列出的字段参与搜索。
比如你写了 withSearch(['name'], [...]),那么即使传入 ['name' => 'a', 'id' => 123, 'email' => 'x@y'],只有 name 会被处理,其余字段被完全忽略。

  • 这能防止前端传 status=999 绕过权限直接查管理员数据;
  • 但也会掩盖问题:比如字段名写错(user_name 写成 username),搜索器根本不会触发,也不会报错,结果就是“查不到”,调试时容易卡住;
  • 如果字段需要类型转换(如时间范围传字符串数组),必须在搜索器里自己做 strtotime 或 Carbon::parse,框架不帮你转。

withSearch 的白名单机制很干净,但代价是所有搜索逻辑必须收口到模型里——一旦字段语义变复杂(比如“最近7天”要算时间范围,“模糊+拼音首字母”要连表),搜索器方法就会迅速膨胀。这时候不如拆成独立 Service 类,别硬塞进模型。

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

相关文章

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

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

下载

相关标签:

thinkphp php

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

相关专题

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

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

2023.09.01

10064

6

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

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

2023.10.11

5961

5

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

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

2023.10.11

2075

5

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

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

2023.10.23

3748

4

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

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

2023.10.23

4434

6

html怎么上传
html怎么上传

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

2023.11.03

3471

9

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

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

2023.11.09

4957

8

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

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

2023.11.13

3882

8

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

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

2023.11.27

11862

4

热门下载

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

精品课程

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