kba-team / cakephp-filter-plugin
Filter是一个CakePHP插件,它可以快速简单地创建用于您数据的筛选表单,而不会妨碍分页、排序和其他“标准”显示数据功能。它还会记住会话中的筛选条件,但如果不需要,则可以关闭。
Requires
- php: >=8.1, <8.4
- composer/installers: ^1.9
- kba-team/cakephp: ^2.11
Requires (Dev)
- phpunit/phpunit: ^9.5
This package is auto-updated.
Last update: 2024-09-21 10:42:34 UTC
README
关于
Filter是一个CakePHP插件,允许您以非常快速和简单的方式创建用于数据的筛选表单,而不会妨碍分页、排序和其他“标准”显示数据功能。它还会记住会话中的筛选条件,但如果不需要,则可以关闭。
它还提供回调方法以在必要时进一步细化搜索。
重要:以下说明适用于CakePHP 2.0。如果您使用的是CakePHP 1.3.x,则卸载插件的正确路径是app/plugins/filter/
。更重要的是,如果您使用的是CakePHP 1.3.x,您应该使用此插件的1.3.x版本,而不是GitHub上的最新版本。
用法
首先,获取插件。如果您使用Git,请在您的应用目录中运行以下命令
composer require kba-team/cakephp-filter-plugin
要使用插件,您需要告诉它要筛选哪个模型以及使用哪些字段。有关快速教程,请访问https://github.com/lecterror/cakephp-filter-plugin/wiki/Basic-usage
如果您需要比此插件提供的默认功能更多,有方法可以自定义它,请参阅此文章:https://github.com/lecterror/cakephp-filter-plugin/wiki/Advanced-usage
为了生成GET表单,请将'type' => 'GET'
添加到filterForm()
或beginForm()
选项数组中。
测试
运行PHPUnit测试
Test/phpunit.sh <args>
执行shell进行手动测试
docker pull devkba/cake2-app-template:staging docker run \ --rm \ --init \ -it \ -v "$(pwd)":/cakephp-filter-plugin \ -e DEBUG=0 \ -e BEFORE_SCRIPT="/cakephp-filter-plugin/Test/before_script.sh" \ -e AFTER_SCRIPT="/cakephp-filter-plugin/Test/after_script.sh" \ devkba/cake2-app-template:staging
贡献
如果您想做出贡献,请克隆GitHub上的源代码,进行更改,并向我发送拉取请求。如果您不知道如何修复问题,或者您太懒不想做,请创建一个工单,我们将看看接下来会发生什么。
重要:如果您发送补丁,请遵循编码风格!如果不这样做,有很大可能性我不会接受它。例如
// bad public function drink() { return false; }
// good public function drink() { return true; }
许可证
以下许可协议下多许可