一、简介

ListFilter是一款PHP列表过滤器，旨在为PHP开发者提供一种高效、方便的列表数据处理方法。在开发过程中常常遇到需要对列表数据进行排序、查询、过滤等操作的情况，而这些操作在PHP中通常需要写大量的代码，所以开发了这款工具，可以大大简化列表数据处理的过程。

二、安装

ListFilter可以通过composer进行安装，使用composer.json文件如下：

{
    "require": {
        "filer/listfilter": "^1.0.0"
    }
}

也可以通过在命令行运行以下命令进行安装：

composer require filer/listfilter

三、使用

先通过构造函数初始化ListFilter：

use Filer\ListFilter;
$filter = new ListFilter($listData);

其中$listData为需要处理的列表数据。

四、过滤

可以使用where方法对数据进行过滤。以下是一个根据数据中某个字段值进行过滤的示例：

$filter->where('fieldName', '=', $fieldValue);

上面这行代码会筛选出数据中fieldName字段值等于$fieldValue的项。可以使用多个where方法进行复杂的过滤操作。例如，我们需要筛选出数据中fieldName字段值等于$fieldValue1并且field2字段值等于$fieldValue2的项，代码示例如下：

$filter->where('fieldName', '=', $fieldValue1)->where('field2', '=', $fieldValue2);

除了=，还有其它的比较操作符可以使用：

>: 大于
>=: 大于等于
<: 小于
<=: 小于等于
!=: 不等于
like: 包含示例代码：

$filter->where('fieldName', '>', 10);
$filter->where('fieldName', 'like', '%keyword%');

五、排序

可以使用orderBy方法对数据进行排序。以下是一个根据某个字段升序排序的示例：

$filter->orderBy('fieldName', 'asc');

其中，第二个参数可以是asc或desc，分别表示升序和降序。可以同时设置多个排序规则，如下所示：

$filter->orderBy('fieldName1', 'asc')->orderBy('fieldName2', 'desc');

六、分页

ListFilter也支持分页功能。以下是一个将结果分页的示例：

$result = $filter->page(2, 10)->get();

这行代码将列表数据按照每页10项进行分页，获取第二页的数据。

七、完整示例

下面是一个完整的示例代码：

use Filer\ListFilter;
$originalData = [
    [
        'name' => 'Tom',
        'age' => 20,
        'gender' => 'male'
    ],
    [
        'name' => 'Alice',
        'age' => 25,
        'gender' => 'female'
    ],
    [
        'name' => 'Bob',
        'age' => 18,
        'gender' => 'male'
    ],
];
$filter = new ListFilter($originalData);
$result = $filter->where('age', '>', 18)
                ->where('gender', '=', 'male')
                ->orderBy('age', 'asc')
                ->page(1, 2)
                ->get();

以上代码将原始数据进行筛选，选出年龄大于18岁，性别为男的数据，并按照年龄进行升序排序，然后将结果分页，获取第一页的数据。

八、总结

ListFilter是一个高效、便捷的PHP列表过滤器，可以大大简化列表数据处理的过程，同时提供了多种方法对列表数据进行筛选、排序、分页等操作，让数据处理更加灵活、方便。如果您在开发过程中需要处理列表数据，不妨尝试使用ListFilter。

ListFilter：高效便捷的PHP列表过滤器