Skip to content

SearchKit - When filtering a hierarchical entity, don't exclude children #36437

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
colemanw wants to merge 1 commit into
base: master
Choose a base branch
from
+47 −2
Open

SearchKit - When filtering a hierarchical entity, don't exclude children #36437

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions Civi/Api4/Event/Subscriber/HierarchicalEntitySubscriber.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,10 @@ public function onApiRespond(RespondEvent $event): void {
// Filter out children, maintaining sorted order
$children = [];
if (!$needsExtraDfkQuery) {
$records = array_filter($records, function($record) use ($parentName, $dfkControlName, $dfkValue, &$children) {
$isChild = !empty($record[$parentName]);
$allRecordIds = array_column($records, $idName);
$records = array_filter($records, function($record) use ($parentName, $dfkControlName, $dfkValue, $allRecordIds, &$children) {
// To avoid orphans disappearing, only designate child if parent can be found
$isChild = !empty($record[$parentName]) && array_intersect((array) $record[$parentName], $allRecordIds);
if ($dfkValue) {
$isChild = $record[$dfkControlName] == $dfkValue;
}
Expand Down
43 changes: 43 additions & 0 deletions ext/search_kit/tests/phpunit/api/v4/SearchDisplay/SearchRunTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4104,4 +4104,47 @@ public function testGroupFirstDateFilter(): void {
$this->assertNotContains($contacts[0]['id'], $returnedContactIds, 'Alpha (February 2023) should be excluded');
}

/**
* Test filtering a hierarchical group SearchDisplay by title.
*
* Replicates issue where filtering by group title only returns matching top-level groups,
* while matching child groups are dropped because their parent groups are excluded by the filter.
*/
public function testHierarchicalGroupFilterByTitle(): void {
$parentGroup = $this->createTestRecord('Group', [
'title' => 'Parent Group ' . uniqid(),
]);
$childGroup = $this->createTestRecord('Group', [
'title' => 'Child Group ' . uniqid(),
'parents' => [$parentGroup['id']],
]);

$params = [
'checkPermissions' => FALSE,
'savedSearch' => [
'api_entity' => 'Group',
'api_params' => [
'version' => 4,
'select' => ['id', 'title', 'parents'],
],
],
'display' => [
'type' => 'table',
'settings' => [
'hierarchical' => TRUE,
'columns' => [
['type' => 'field', 'key' => 'title', 'sortable' => TRUE],
],
],
],
'filters' => [
'title' => $childGroup['title'],
],
];

$result = civicrm_api4('SearchDisplay', 'run', $params);
$returnedIds = array_column(array_column($result->getArrayCopy(), 'data'), 'id');
$this->assertContains($childGroup['id'], $returnedIds, 'Matching child group should be returned when filtering by title');
}

}