Skip to content

Issue #3510578: Group filter: integrate the selected filters feature into automated list #1358

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
wants to merge 13 commits into
base: develop
Choose a base branch
from
Open

Issue #3510578: Group filter: integrate the selected filters feature into automated list #1358

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
c48a3b9
[CIVIC-2105] Selected filters.
febdao Mar 14, 2025
5397039
[CIVIC-2105] Fixed lint.
febdao Mar 14, 2025
064b40c
[CIVIC-2105] Update uiKit for selecter filters testing.
febdao Mar 14, 2025
33f0509
[CIVIC-2105] Rerun test.
febdao Mar 14, 2025
76ee193
[#3510578] Fixed CR.
febdao Mar 24, 2025
44b35d7
[#3510578] Fixed create_filter_label to use generic types to get labels.
alan-cole May 14, 2025
66dc10c
[#3510578] Fixed linting issues.
alan-cole May 14, 2025
20a86b9
[#3510578] Avoid issues in ajax by disabling selected filters on AJAX.
alan-cole May 14, 2025
ea2f5d7
[#3510578] Improve link paths. This partially resolves ajax issues.
alan-cole May 14, 2025
f181c41
[#3510578] Removed unnecessary check.
alan-cole May 14, 2025
e82077e
[#3510578] Updated base branch.
alan-cole May 14, 2025
f106a3b
[#3510578] Fixes from CR.
alan-cole May 14, 2025
f154e74
Merge branch 'develop' into feature/CIVIC-2105
joshua-salsadigital Oct 27, 2025
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
133 changes: 133 additions & 0 deletions web/themes/contrib/civictheme/includes/views.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ use Drupal\Component\Utility\Html;
use Drupal\Core\Cache\Cache;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Template\Attribute;
use Drupal\views\Plugin\views\filter\FilterPluginBase;
use Drupal\views\ViewExecutable;
use Drupal\views\Views;

/**
Expand All @@ -21,6 +23,7 @@ function civictheme_preprocess_views_view(array &$variables): void {
_civictheme_preprocess_views_view__view($variables);
_civictheme_preprocess_views_view__pager($variables);
_civictheme_preprocess_views_view__search_page($variables);
_civictheme_preprocess_views_view__selected_filters($variables);
}

/**
Expand Down Expand Up @@ -68,6 +71,7 @@ function _civictheme_preprocess_views_view__pager(array &$variables): void {
return;
}

/** @var \Drupal\views\ViewExecutable $view */
$view = &$variables['view'];

// Hide pager if there is only one result page.
Expand Down Expand Up @@ -250,14 +254,143 @@ function _civictheme_preprocess_views__exposed_form__group_filter(array &$variab
$variables['group_filter'] = TRUE;
}

/**
* Preprocess views selected filters from the query params.
*/
function _civictheme_preprocess_views_view__selected_filters(array &$variables): void {
/** @var \Drupal\views\ViewExecutable $view */
$view = $variables['view'];
$variables['selected_filters'] = _civictheme_preprocess_views_view__selected_filters_list($view);

if (!empty($variables['selected_filters'])) {
$variables['selected_filters_clear_link'] = [
'url' => \Drupal::request()->getUriForPath(\Drupal::request()->getPathInfo()) . '?' . http_build_query([]),
'text' => t('Clear all'),
'attributes' => 'aria-label="' . t('Clear all filters') . '"',
];
}
}

/**
* Preprocess for a search page.
*
* @SuppressWarnings(PHPMD.ElseExpression)
*/
function _civictheme_preprocess_views_view__search_page(array &$variables): void {
/** @var \Drupal\views\ViewExecutable $view */
$view = $variables['view'];
if ($view->id() == 'civictheme_search' && $view->current_display == 'page_1') {
$variables['vertical_spacing'] = 'top';
}
}

/**
* Preprocess the selected filters list.
*/
function _civictheme_preprocess_views_view__selected_filters_list(ViewExecutable $view): array {
$filter_types = _civictheme_preprocess_views_view__selected_filters_get_filter_types($view);
$query_params = \Drupal::request()->query->all();
$current_values = array_filter($query_params, function ($value) {
return !empty($value);
});

Comment on lines +300 to +303
Copy link
Contributor

@coderabbitai coderabbitai bot May 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

array_filter() drops legitimate “falsy” filter values

array_filter($query_params, fn($v) => !empty($v)) removes numeric 0, string '0', or boolean false, even though these can be valid filter inputs (e.g. a taxonomy term with ID 0 or a boolean flag).
Use a stricter check to keep anything that is not NULL and not an empty string:

-  $current_values = array_filter($query_params, function ($value) {
-    return !empty($value);
-  });
+  $current_values = array_filter(
+    $query_params,
+    fn($v) => !(is_string($v) && $v === '') && $v !== NULL
+  );
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
$current_values = array_filter($query_params, function ($value) {
return !empty($value);
});
$current_values = array_filter(
$query_params,
fn($v) => !(is_string($v) && $v === '') && $v !== NULL
);

// Prevent other query params from being used in the selected filters.
$permitted_keys = [
'type',
'topic',
'title',
'items_per_page',
];
$selected_filters = [];

foreach ($current_values as $key => $value) {
if (!in_array($key, $permitted_keys)) {
continue;
}
$new_query_params = $query_params;
if (is_string($value)) {
unset($new_query_params[$key]);
$selected_filters[$key] = [
'url' => \Drupal::request()->getUriForPath(\Drupal::request()->getPathInfo()) . '?' . http_build_query($new_query_params),
'text' => _civictheme_preprocess_views_view__selected_filters_list__create_filter_label($key, $value, $filter_types),
];
continue;
}
if (is_array($value)) {
foreach ($value as $value_key => $item) {
if (!empty($item)) {
$temp_query_params = $query_params;
unset($temp_query_params[$key][$value_key]);
if (empty($temp_query_params[$key])) {
unset($temp_query_params[$key]);
}
$selected_filters[$key . '_' . $item . '_' . $value_key] = [
'url' => \Drupal::request()->getUriForPath(\Drupal::request()->getPathInfo()) . '?' . http_build_query($temp_query_params),
'text' => _civictheme_preprocess_views_view__selected_filters_list__create_filter_label($key, $item, $filter_types),
];
}
}
}
}
return $selected_filters;
}
Comment on lines 297 to 335
Copy link
Contributor

@coderabbitai coderabbitai bot May 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Undefined-index notices when filter is not exposed

$permitted_keys permits title and items_per_page, yet these keys are not present in $filter_types.
When such parameters are present in the query string, the call to _create_filter_label() triggers:

Notice: Undefined index: title in _civictheme_preprocess_views_view__selected_filters_list__create_filter_label()

Suggested fix:

-      $selected_filters[$key] = [
-        'url' => …,
-        'text' => _civictheme_preprocess_views_view__selected_filters_list__create_filter_label($key, $value, $filter_types),
-      ];
+      if (isset($filter_types[$key])) {
+        $label = _civictheme_preprocess_views_view__selected_filters_list__create_filter_label($key, $value, $filter_types);
+      }
+      else {
+        // Fallback to a generic human-readable label.
+        $label = ucfirst(str_replace('_', ' ', $key)) . ': ' . $value;
+      }
+      $selected_filters[$key] = [
+        'url' => …,
+        'text' => $label,
+      ];

Replicate the same guard inside the array-value branch.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
function _civictheme_preprocess_views_view__selected_filters_list(ViewExecutable $view): array {
$filter_types = _civictheme_preprocess_views_view__selected_filters_get_filter_types($view);
$query_params = \Drupal::request()->query->all();
$current_values = array_filter($query_params, function ($value) {
return !empty($value);
});
// Prevent other query params from being used in the selected filters.
$permitted_keys = [
'type',
'topic',
'title',
'items_per_page',
];
$selected_filters = [];
foreach ($current_values as $key => $value) {
if (!in_array($key, $permitted_keys)) {
continue;
}
$new_query_params = $query_params;
if (is_string($value)) {
unset($new_query_params[$key]);
$selected_filters[$key] = [
'url' => \Drupal::request()->getUriForPath(\Drupal::request()->getPathInfo()) . '?' . http_build_query($new_query_params),
'text' => _civictheme_preprocess_views_view__selected_filters_list__create_filter_label($key, $value, $filter_types),
];
continue;
}
if (is_array($value)) {
foreach ($value as $value_key => $item) {
if (!empty($item)) {
$temp_query_params = $query_params;
unset($temp_query_params[$key][$value_key]);
if (empty($temp_query_params[$key])) {
unset($temp_query_params[$key]);
}
$selected_filters[$key . '_' . $item . '_' . $value_key] = [
'url' => \Drupal::request()->getUriForPath(\Drupal::request()->getPathInfo()) . '?' . http_build_query($temp_query_params),
'text' => _civictheme_preprocess_views_view__selected_filters_list__create_filter_label($key, $item, $filter_types),
];
}
}
}
}
return $selected_filters;
}
function _civictheme_preprocess_views_view__selected_filters_list(ViewExecutable $view): array {
$filter_types = _civictheme_preprocess_views_view__selected_filters_get_filter_types($view);
$query_params = \Drupal::request()->query->all();
$current_values = array_filter($query_params, function ($value) {
return !empty($value);
});
// Prevent other query params from being used in the selected filters.
$permitted_keys = [
'type',
'topic',
'title',
'items_per_page',
];
$selected_filters = [];
foreach ($current_values as $key => $value) {
if (!in_array($key, $permitted_keys)) {
continue;
}
$new_query_params = $query_params;
// String-valued filter.
if (is_string($value)) {
unset($new_query_params[$key]);
if (isset($filter_types[$key])) {
$label = _civictheme_preprocess_views_view__selected_filters_list__create_filter_label($key, $value, $filter_types);
}
else {
// Fallback to a generic human-readable label.
$label = ucfirst(str_replace('_', ' ', $key)) . ': ' . $value;
}
$selected_filters[$key] = [
'url' => \Drupal::request()->getUriForPath(\Drupal::request()->getPathInfo()) . '?' . http_build_query($new_query_params),
'text' => $label,
];
continue;
}
// Array-valued filter.
if (is_array($value)) {
foreach ($value as $value_key => $item) {
if (empty($item)) {
continue;
}
$temp_query_params = $query_params;
unset($temp_query_params[$key][$value_key]);
if (empty($temp_query_params[$key])) {
unset($temp_query_params[$key]);
}
if (isset($filter_types[$key])) {
$label = _civictheme_preprocess_views_view__selected_filters_list__create_filter_label($key, $item, $filter_types);
}
else {
// Fallback to a generic human-readable label.
$label = ucfirst(str_replace('_', ' ', $key)) . ': ' . $item;
}
$selected_filters["{$key}_{$item}_{$value_key}"] = [
'url' => \Drupal::request()->getUriForPath(\Drupal::request()->getPathInfo()) . '?' . http_build_query($temp_query_params),
'text' => $label,
];
}
}
}
return $selected_filters;
}


/**
* Get the filter types from the view.
*
* @param \Drupal\views\ViewExecutable $view
* The view executable object.
*
* @return array
* Array of exposed filters with their properties:
* - name: The human readable label
* - type: The filter plugin ID
* - machine_name: The filter ID
*/
function _civictheme_preprocess_views_view__selected_filters_get_filter_types(ViewExecutable $view): array {
$exposed_filters = [];
if (!empty($view)) {
$filters = $view->display_handler->getHandlers('filter');
foreach ($filters as $filter_id => $filter) {
if ($filter instanceof FilterPluginBase && $filter->isExposed()) {
$exposed_filters[$filter->options['expose']['identifier']] = [
'name' => $filter->options['expose']['label'],
'type' => $filter->getPluginId(),
'machine_name' => $filter_id,
];
}
}
}
return $exposed_filters;
}

/**
* Create the label correctly for each of the selected filters.
*
* @param string $key
* The filter key.
* @param string|int $value
* The filter value.
* @param array $filter_types
* Array of filter types containing metadata about each filter.
*
* @return string
* The formatted filter label in the format "Key: Value".
*/
function _civictheme_preprocess_views_view__selected_filters_list__create_filter_label(string $key, string|int $value, array $filter_types): string {
switch ($filter_types[$key]['type']) {
case 'bundle':
$node_type = \Drupal::entityTypeManager()->getStorage('node_type')->load($value);
$value_label = $node_type ? $node_type->label() : $value;
break;

case 'taxonomy_index_tid':
Copy link
Member

@AlexSkrypnyk AlexSkrypnyk Jun 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this does not support search-API plugins

$taxonomy_term = \Drupal::entityTypeManager()->getStorage('taxonomy_term')->load($value);
$value_label = $taxonomy_term ? $taxonomy_term->label() : $value;
break;

default:
$value_label = $value;
}
return $filter_types[$key]['name'] . ': ' . $value_label;
Copy link
Member

@AlexSkrypnyk AlexSkrypnyk Jun 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this function should return only a label and the formatting of this label should take place outside of this function

}
7 changes: 3 additions & 4 deletions web/themes/contrib/civictheme/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion web/themes/contrib/civictheme/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
"uikit-install": "rm -Rf components > /dev/null 2>&1 && cp -R node_modules/@civictheme/uikit/components components"
},
"dependencies": {
"@civictheme/uikit": "github:civictheme/uikit#v1.10.0",
"@civictheme/uikit": "github:civictheme/uikit#feature/497-Selected-filters",
"@popperjs/core": "^2.11.8"
},
"devDependencies": {
Expand Down