CakePHP：限制 hasMany 查询中关联表和主表的字段

本文档旨在解决在使用 Cakephp 的 hasMany 关联查询时，如何限制主表和关联表中返回的字段，以优化性能。我们将探讨如何在查询中使用 select() 方法来指定需要的字段，并解决因缺少主键导致关联数据无法正确合并的问题。同时，介绍如何使用结果格式化器来移除不需要的字段。

使用 select() 限制字段

在使用 CakePHP 的 ORM 进行数据查询时，如果关联关系是 hasMany，并且希望限制返回的字段以提高性能，可以直接在 find() 方法中使用 select() 方法来指定要查询的字段。

例如，假设有两个表：ProcessoAdministrativo 和 DocumentoProcessoAdministrativo，它们之间存在 hasMany 关联关系。我们希望只查询 ProcessoAdministrativo 表的 codigo_pa 字段，以及 DocumentoProcessoAdministrativo 表的 id、descricao、ordem 和 processo_administrativo_id 字段。

以下代码展示了如何实现：

<?php  use CakeORMTableRegistry;  $tablePA = TableRegistry::get('ProcessoAdministrativo');  $query = $tablePA     ->find()     ->select(['id', 'codigo_pa']) // 必须包含主键 'id'     ->contain([         'DocumentoProcessoAdministrativo' => function ($q) {             return $q->select(['id', 'descricao', 'ordem', 'processo_administrativo_id']);         }     ]);  $results = $query->toArray();  debug($results);

注意：

• 必须包含主键： 在选择主表的字段时，必须包含主键字段（通常是 id），否则 CakePHP 的 ORM 无法正确地将关联表的数据合并到主表的结果中。这是因为关联数据的合并是在 PHP 层面进行的，ORM 需要通过外键关联主表和关联表的数据。
• contain() 方法中的闭包函数允许你自定义关联表的查询。

移除不需要的字段

即使必须包含主键才能正确关联数据，但有时我们并不希望在最终结果中包含主键字段。为了解决这个问题，可以使用结果格式化器（Result Formatter）来移除不需要的字段。

以下代码展示了如何使用结果格式化器移除 ProcessoAdministrativo 表的 id 字段：

<?php  use CakeORMTableRegistry; use CakeCollectionCollectionInterface;  $tablePA = TableRegistry::get('ProcessoAdministrativo');  $query = $tablePA     ->find()     ->select(['id', 'codigo_pa']) // 必须包含主键 'id'     ->contain([         'DocumentoProcessoAdministrativo' => function ($q) {             return $q->select(['id', 'descricao', 'ordem', 'processo_administrativo_id']);         }     ])     ->formatResults(function (CollectionInterface $results) {         return $results->map(function ($row) {             unset($row['id']); // 移除 'id' 字段             return $row;         });     });  $results = $query->toArray();  debug($results);

解释：

• formatResults() 方法接受一个闭包函数，该函数接收一个 CakeCollectionCollectionInterface 对象，其中包含了查询结果。
• 在闭包函数中，使用 map() 方法遍历结果集中的每一行数据。
• 对于每一行数据，使用 unset() 函数移除 id 字段。
• 最后，返回修改后的结果集。

总结

通过结合使用 select() 方法和结果格式化器，可以灵活地控制在使用 CakePHP 的 hasMany 关联查询时返回的字段，从而优化性能并满足特定的数据需求。记住，在选择主表的字段时，必须包含主键字段，以便 ORM 能够正确地关联数据。如果不需要主键字段，可以使用结果格式化器在查询完成后将其移除。