Issue #3549220: Search & Auto list page title & search results message.

Author: alan-cole

web/themes/contrib/civictheme/civictheme.theme

@@ -8,6 +8,7 @@
 declare(strict_types=1);
 
 use Drupal\civictheme\CivicthemeConstants;
+use Drupal\Core\Cache\Cache;
 use Drupal\Core\Render\Component\Exception\ComponentNotFoundException;
 
 require_once __DIR__ . '/includes/utilities.inc';
@@ -161,6 +162,7 @@ function civictheme_preprocess_last(array &$variables, string $hook): void {
 function civictheme_preprocess_html(array &$variables): void {
   _civictheme_preprocess_html__skip_link($variables);
   _civictheme_preprocess_html__site_section($variables);
+  _civictheme_preprocess_html__search_head_title($variables);
 
   // Disable modifier_class as this template is provided by Drupal.
   $variables['modifier_class'] = FALSE;
@@ -275,4 +277,5 @@ function civictheme_page_attachments_alter(array &$attachments) {
   catch (ComponentNotFoundException $exception) {
     \Drupal::logger('civictheme')->error('Unable to find alert component: %message', ['%message' => $exception->getMessage()]);
   }
+  $attachments['#cache']['contexts'] = Cache::mergeContexts($variables['#cache']['contexts'] ?? [], ['url.query_args']);
 }

web/themes/contrib/civictheme/config/install/civictheme.settings.yml

@@ -67,6 +67,10 @@ components:
     summary_length: 160
   attachment:
     use_media_name: true
+  search:
+    keyword_fields:
+      - keywords
+      - title
 colors:
   use_color_selector: true
   use_brand_colors: true

web/themes/contrib/civictheme/config/install/views.view.civictheme_automated_list.yml

@@ -531,7 +531,7 @@ display:
           admin_label: ''
           plugin_id: result
           empty: false
-          content: 'Showing @start - @end of @total'
+          content: 'Showing @start - @end of @total @keywords'
       footer: {  }
       display_extenders: {  }
     cache_metadata:

web/themes/contrib/civictheme/config/optional/views.view.civictheme_search.yml

@@ -218,19 +218,16 @@ display:
           query_tags: {  }
       relationships: {  }
       header:
-        area:
-          id: area
+        result:
+          id: result
           table: views
-          field: area
+          field: result
           relationship: none
           group_type: group
           admin_label: ''
-          plugin_id: text
+          plugin_id: result
           empty: false
-          content:
-            value: '<h3 class="ct-heading ct-list__title">Search results...</h3>'
-            format: civictheme_rich_text
-          tokenize: false
+          content: 'Showing @start - @end of @total @keywords'
       footer: {  }
       display_extenders: {  }
     cache_metadata:

web/themes/contrib/civictheme/includes/search.inc

@@ -8,6 +8,7 @@
 declare(strict_types=1);
 
 use Drupal\civictheme\CivicthemeConstants;
+use Drupal\civictheme\CivicthemeUtility;
 
 /**
  * Implements template_preprocess_block().
@@ -36,3 +37,37 @@ function civictheme_preprocess_block__civictheme_search(array &$variables): void
 
   $variables['theme'] = civictheme_get_theme_config_manager()->load('components.header.theme', CivicthemeConstants::HEADER_THEME_DEFAULT);
 }
+
+/**
+ * Implements hook_preprocess_html().
+ */
+function _civictheme_preprocess_html__search_head_title(array &$variables): void {
+  // Load search fields from theme settings.
+  $setting_keyword_fields = civictheme_get_theme_config_manager()->load('components.search.keyword_fields') ?? '';
+  if (empty($setting_keyword_fields)) {
+    return;
+  }
+
+  // Add search keywords to head title.
+  $keywords = NULL;
+  $search_fields = CivicthemeUtility::multilineToArray($setting_keyword_fields);
+  foreach ($search_fields as $field) {
+    $query_field = \Drupal::request()->query->get($field);
+    if (!empty($query_field)) {
+      $keywords = $query_field;
+      break;
+    }
+  }
+  if (empty($keywords)) {
+    return;
+  }
+  $head_title = (string) $variables['head_title']['title'] ?? '';
+  if (empty($head_title)) {
+    return;
+  }
+  $sanitized_keywords = htmlspecialchars($keywords, ENT_QUOTES, 'UTF-8');
+  $variables['head_title']['title'] = t("@title - Searching for '@keywords'", [
+    '@title' => $head_title,
+    '@keywords' => $sanitized_keywords,
+  ]);
+}

web/themes/contrib/civictheme/includes/views.inc

@@ -8,6 +8,7 @@
 declare(strict_types=1);
 
 use Drupal\civictheme\CivicthemeConstants;
+use Drupal\civictheme\CivicthemeUtility;
 use Drupal\Component\Utility\Html;
 use Drupal\Core\Cache\Cache;
 use Drupal\Core\Form\FormStateInterface;
@@ -21,6 +22,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__results_count($variables);
 }
 
 /**
@@ -261,3 +263,36 @@ function _civictheme_preprocess_views_view__search_page(array &$variables): void
     $variables['vertical_spacing'] = 'top';
   }
 }
+
+/**
+ * Pre-process results count for views.
+ */
+function _civictheme_preprocess_views_view__results_count(array &$variables): void {
+  if (empty($variables['results_count'])) {
+    return;
+  }
+  if (!str_contains($variables['results_count'], '@keywords')) {
+    return;
+  }
+
+  // Load search fields from theme settings.
+  $setting_keyword_fields = civictheme_get_theme_config_manager()->load('components.search.keyword_fields') ?? '';
+  if (empty($setting_keyword_fields)) {
+    return;
+  }
+
+  $variables['#cache']['contexts'] = Cache::mergeContexts($variables['#cache']['contexts'] ?? [], ['url.query_args']);
+
+  $keywords = '';
+  $exposed_input = $variables['view']->getExposedInput();
+  $search_fields = CivicthemeUtility::multilineToArray($setting_keyword_fields);
+
+  foreach ($search_fields as $field) {
+    if (!empty($exposed_input[$field])) {
+      $keywords = t("for '@keywords'", ['@keywords' => $exposed_input[$field]])->__toString();
+      break;
+    }
+  }
+
+  $variables['results_count'] = str_replace('@keywords', $keywords, $variables['results_count']);
+}

web/themes/contrib/civictheme/src/Settings/CivicthemeSettingsFormSectionComponents.php

@@ -442,6 +442,21 @@ public function form(array &$form, FormStateInterface $form_state): void {
       '#default_value' => $this->themeConfigManager->loadForComponent('attachment', 'use_media_name', TRUE),
     ];
 
+    $form['components']['search'] = [
+      '#type' => 'details',
+      '#title' => $this->t('Search'),
+      '#group' => 'components',
+      '#tree' => TRUE,
+    ];
+
+    $form['components']['search']['keyword_fields'] = [
+      '#type' => 'textarea',
+      '#title' => $this->t('Search and Automated list keyword fields'),
+      '#description' => $this->t('A list of machine names for views exposed filters keyword search.<br/>Fields added here will populate the "Showing @start - @end of @total @keywords" where @keywords is replaced with "for [keyword_field_value]" if a value exists.<br/>It will also be used in the browser page title as "@title - Searching for \'@keywords\' | @suffix".<br/>One keyword field per line.'),
+      '#default_value' => CivicthemeUtility::arrayToMultiline($this->themeConfigManager->load('components.search.keyword_fields', [])),
+      '#rows' => 4,
+    ];
+
     $form['#process'][] = $this->processForm(...);
 
     // Auto-discover per-component validation and submit handlers.