Custom ProxyQuery not showing filters

[davidromani]

Hello.

I'm trying to build a custom ProxyQuery without a Doctrine entity behind. It seems that works fine, but I don't know why are not appearing the filter itself.

// controller action
public function batchAnalysisAction(Request $request, WorkOrderResultRepository $wor): Response
{
    $qb = $wor->batchAnalysisQB();
    $batchAnalysis = new BatchAnalysisArrayProxyQuery($qb);
    $dataTable = $this->createDataTable(BatchAnalysisDataTableType::class, $batchAnalysis);
    $dataTable->handleRequest($request);

    return $this->render('@App/admin/reports/batch_analysis.html.twig', [
        'batchAnalysisTable' => $dataTable->createView(),
    ]);
}

// datatable type
class BatchAnalysisDataTableType extends AbstractDataTableType
{
    public function buildDataTable(DataTableBuilderInterface $builder, array $options): void
    {
        $builder
            ->addColumn(
                'batchCode',
                TextColumnType::class, [
                    'label' => 'batchCode',
                ]
            )
            ->addColumn(
                'totalWorkstationSeconds',
                NumberColumnType::class, [
                    'label' => 'totalWorkstationSeconds',
                ]
            )
            ->addFilter(
                'batchCode',
                CallbackFilterType::class,
                [
                    'default_operator' => Operator::Equals,
                    'callback' => function (ProxyQueryInterface $query, FilterData $data, FilterInterface $filter): void {
                        // ...
                    },
                ]
            )
        ;
    }

    public function configureOptions(OptionsResolver $resolver): void
    {
        $resolver->setDefaults([
            'filtration_enabled' => true,
        ]);
    }
}

// proxy query
final readonly class BatchAnalysisArrayProxyQuery implements ProxyQueryInterface
{
    public function __construct(
        private QueryBuilder $queryBuilder,
    ) {
    }

    public function sort(SortingData $sortingData): void
    {
        // TODO: Implement sort() method.
    }

    public function paginate(PaginationData $paginationData): void
    {
        // TODO: Implement paginate() method.
    }

    public function getResult(): ResultSetInterface
    {
        $resultArray = $this->queryBuilder->getQuery()->getResult();
        $resultArrayDtos = [];
        foreach ($resultArray as $result) {
            $resultArrayDtos[] = new BatchAnalysisDto(
                batchCode: $result['batchCode'],
                totalWorkstationSeconds: $result['totalWorkstationSeconds'],
            );
        }

        return new ResultSet(
            iterator: new \ArrayIterator(iterator_to_array($resultArrayDtos)),
            currentPageItemCount: 1,
            totalItemCount: count($resultArrayDtos),
        );
    }
}

[Kreyu]

Hey @davidromani!

First of, judging by the provided screenshot, it seems like you're using a base.html.twig theme, which is incredibly minimal and not meant to be used directly - working as a base for other Bootstrap 5 and Tabler themes. Please try using one of those themes, described in the documentation:

# config/packages/kreyu_data_table.yaml
kreyu_data_table:
  defaults:
    themes:
      - '@KreyuDataTable/themes/bootstrap_5.html.twig'

or in Twig:

{% data_table_theme batchAnalysisTable '@KreyuDataTable/themes/bootstrap_5.html.twig' %}

{{ data_table(batchAnalysisTable) }}

By the way, I don't think you need a custom proxy query, because you are still using Doctrine, therefore, you can use the built-in one. Unless you're using DBAL directly instead of ORM - I am not able to tell by provided code.

You don't have to work on entities - anything returned by the Doctrine will work, even simple arrays. For example, if your QueryBuilder returns data in following format:

[
  [
    'batchCode' => 2416,
    'totalWorkstationSeconds' => 815.448,
  ], 
  [
    'batchCode' => 2417,
    'totalWorkstationSeconds' => 715.026,
  ]
]

You can use the following column definition - note the property paths of each column is wrapped in square brackets, since its an array (re: reading from arrays in property access component):

public function buildDataTable(DataTableBuilderInterface $builder, array $options): void
{
    $builder
        ->addColumn('batchCode', TextColumnType::class, [
            'label' => 'batchCode',
            'property_path' => '[batchCode]',
        ])
        ->addColumn('totalWorkstationSeconds', NumberColumnType::class, [
            'label' => 'totalWorkstationSeconds',
            'property_path' => '[totalWorkstationSeconds]',
        ])
    ;
}

You can even sort by those columns. By default, setting the sort option to true inherits the sort property path from property_path (which then inherits from column name). Because we are setting the property path with square brackets, this is no longer valid DQL, therefore, we have to set the sort option explicitly:

public function buildDataTable(DataTableBuilderInterface $builder, array $options): void
{
    $builder
        ->addColumn('batchCode', TextColumnType::class, [
            'label' => 'batchCode',
            'property_path' => '[batchCode]',
            'sort' => 'batchCode',
        ])
        ->addColumn('totalWorkstationSeconds', NumberColumnType::class, [
            'label' => 'totalWorkstationSeconds',
            'property_path' => '[totalWorkstationSeconds]',
            'sort' => 'totalWorkstationSeconds',
        ])
    ;
}

Also, if you prefer to work on DTOs like in your example above, try returning them directly from QueryBuilder, by using the NEW DQL keyword.

Working with built-in ProxyQuery will allow you to use the built-in filters, so make sure you are 100% sure you need custom adapter for your data. For example, as I mentioned before, if you're using Doctrine DBAL directly instead of an ORM - sure, there's no built-in adapter for that.

[davidromani]

@Kreyu thanks for your hints and your time! I'll take a look and give you some feedback.