Kreyu DataTable Bundle 数组数据源实现指南

Kreyu DataTable Bundle 数组数据源实现指南

data-table-bundle Streamlines creation process of the data tables in Symfony applications. NOT PRODUCTION READY. 项目地址: https://gitcode.com/gh_mirrors/da/data-table-bundle

概述

Kreyu DataTable Bundle 是一个功能强大的 Symfony 数据表格组件，最新发布的 0.23 版本中新增了对数组数据源的支持。本文将详细介绍如何在该组件中使用数组作为数据源，包括实现原理和实际应用场景。

数组数据源的优势

传统的数据表格通常直接与数据库交互，但在某些业务场景下，我们需要：

• 对查询结果进行二次处理后再展示
• 组合多个数据源的数据
• 展示计算后的统计结果
• 实现复杂的业务逻辑过滤

数组数据源正好满足了这些需求，为开发者提供了更大的灵活性。

实现方式

基础实现

0.23 版本后，可以直接使用内置的 ArrayProxyQuery：

use Kreyu\Bundle\DataTableBundle\Query\ArrayProxyQuery;

// 在控制器中
$data = [
    ['id' => 1, 'name' => 'John'],
    ['id' => 2, 'name' => 'Jane'],
    // 更多数据...
];

$query = new ArrayProxyQuery($data);
$dataTable = $this->createDataTable(ProductDataTableType::class, $query);

自定义实现

在早期版本中，开发者需要自行实现 ProxyQueryInterface。以下是一个完整示例：

namespace App\Datatable\Query;

use Kreyu\Bundle\DataTableBundle\Query\ProxyQueryInterface;
use Kreyu\Bundle\DataTableBundle\Query\ResultSetInterface;
use Kreyu\Bundle\DataTableBundle\Query\ResultSet;

class ArrayProxyQuery implements ProxyQueryInterface
{
    private array $data;
    
    public function __construct(array $data, private int $page = 1) 
    {
        $this->data = $data;
    }

    // 实现排序功能
    public function sort(SortingData $sortingData): void
    {
        foreach ($sortingData->getColumns() as $column) {
            usort($this->data, function ($a, $b) use ($column) {
                return $column->isDescending() 
                    ? $b[$column->getName()] <=> $a[$column->getName()]
                    : $a[$column->getName()] <=> $b[$column->getName()];
            });
        }
    }

    // 实现分页功能
    public function paginate(PaginationData $paginationData): void
    {
        $perPage = $paginationData->getPerPage();
        $offset = ($this->page - 1) * $perPage;
        $this->data = array_slice($this->data, $offset, $perPage);
    }

    // 获取结果集
    public function getResult(): ResultSetInterface
    {
        return new ResultSet(
            new \ArrayIterator($this->data),
            count($this->data),
            count($this->data)
        );
    }
}

数据表格类型配置

配置数据表格类型时，需要注意数组数据源的特殊性：

namespace App\Datatable\Type;

use Kreyu\Bundle\DataTableBundle\Type\AbstractDataTableType;
use Kreyu\Bundle\DataTableBundle\DataTableBuilderInterface;

class ProductDataTableType extends AbstractDataTableType
{
    public function buildDataTable(DataTableBuilderInterface $builder, array $options)
    {
        $builder
            ->addColumn('id', TextColumnType::class, [
                'label' => 'ID',
                'property_path' => '[id]', // 注意使用数组访问语法
            ])
            ->addColumn('name', TextColumnType::class, [
                'label' => 'Name',
                'property_path' => '[name]',
            ]);
    }
}

实际应用场景

复杂数据聚合

// 从多个数据源获取数据
$salesData = $salesRepo->getMonthlySales();
$inventoryData = $inventoryRepo->getStockLevels();

// 合并和处理数据
$reportData = array_map(function($sale, $inventory) {
    return [
        'month' => $sale['month'],
        'sales' => $sale['amount'],
        'inventory' => $inventory['count'],
        'turnover' => $sale['amount'] / $inventory['count']
    ];
}, $salesData, $inventoryData);

// 创建数据表格
$query = new ArrayProxyQuery($reportData);
$dataTable = $this->createDataTable(SalesReportType::class, $query);

自定义过滤

// 在自定义的 ArrayProxyQuery 中
public function filterDataBy(FilterData $filterData, Filter $filter): void
{
    $this->data = array_filter($this->data, function($item) use ($filterData, $filter) {
        $value = $item[$filter->getConfig()->getName()];
        
        switch ($filterData->getOperator()) {
            case Operator::Equals:
                return $value == $filterData->getValue();
            case Operator::Contains:
                return stripos($value, $filterData->getValue()) !== false;
            // 其他操作符...
        }
    });
}

性能考虑

当处理大型数组时，应注意：

1. 尽量在原始查询中完成数据过滤，减少传输到PHP的数据量
2. 对于超大数据集，考虑实现基于游标的分页
3. 缓存处理后的结果，避免重复计算

总结

Kreyu DataTable Bundle 的数组数据源功能为开发者提供了处理复杂数据展示需求的强大工具。无论是简单的数组展示，还是需要复杂业务逻辑处理的数据，都可以通过这一功能优雅地实现。最新版本中内置的 ArrayProxyQuery 更是简化了这一过程，使得开发者可以更加专注于业务逻辑的实现。

data-table-bundle Streamlines creation process of the data tables in Symfony applications. NOT PRODUCTION READY. 项目地址: https://gitcode.com/gh_mirrors/da/data-table-bundle