Issue #3549220 by alan.cole: Search & Auto list page title and search results message. #1429
Conversation
WalkthroughAdds configurable keyword-based search fields and UI, injects searched keywords into head titles and Views headers, enables single-field inline exposed filters, forwards title_size to field templates, extends cache contexts for URL query args, and updates the UI kit dependency. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor User
participant Browser
participant Drupal as Drupal (render)
participant Theme as CivicTheme
participant Config as ThemeConfig
Browser->>Drupal: GET /search?q=term
Drupal->>Theme: civictheme_preprocess_html(variables)
Theme->>Config: load components.search.keyword_fields
Theme->>Theme: find first matching query param
alt keyword found
Theme->>Drupal: append "Searching for '…'" to head_title
Theme->>Drupal: merge cache contexts with url.query_args
else no keyword
Theme-->>Drupal: no head_title change
end
sequenceDiagram
autonumber
participant Views as Views (preprocess)
participant Theme as CivicTheme
participant Config as ThemeConfig
participant Twig as Twig Template
Views->>Theme: civictheme_preprocess_views_view(variables)
Theme->>Theme: _civictheme_preprocess_views_view__results_count()
Theme->>Config: read keyword_fields
Theme->>Theme: extract keywords from exposed input
alt keywords found and @keywords present
Theme->>Views: replace @keywords in results_count
Theme->>Views: add url.query_args to cache contexts
end
Theme->>Theme: determine inline_filter eligibility
alt inline_filter true
Theme->>Twig: render civictheme:inline-filter with filter_items, submit_text
else
Theme->>Twig: render default exposed form
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (5)
🚧 Files skipped from review as they are similar to previous changes (2)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
🔇 Additional comments (5)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
alan-cole
changed the title
alan-cole
added
the
State: Needs review
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
🧹 Nitpick comments (1)
web/themes/contrib/civictheme/includes/search.inc (1)
68-72: Review sanitization approach for consistency with Drupal's translation system.The code uses
htmlspecialchars()before passing tot(). However, Drupal'st()function with '@' placeholders already escapes HTML by default, which may result in double-escaping (e.g.,&becoming&).Consider removing the explicit
htmlspecialchars()call and relying ont()'s built-in escaping:- $sanitized_keywords = htmlspecialchars($keywords, ENT_QUOTES, 'UTF-8'); $variables['head_title']['title'] = t("@title - Searching for '@keywords'", [ '@title' => $head_title, - '@keywords' => $sanitized_keywords, + '@keywords' => $keywords, ]);If additional sanitization is required, verify this doesn't cause double-escaping in the browser page title.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
web/themes/contrib/civictheme/package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (9)
web/themes/contrib/civictheme/civictheme.theme(3 hunks)web/themes/contrib/civictheme/config/install/civictheme.settings.yml(1 hunks)web/themes/contrib/civictheme/config/install/views.view.civictheme_automated_list.yml(1 hunks)web/themes/contrib/civictheme/config/optional/views.view.civictheme_search.yml(1 hunks)web/themes/contrib/civictheme/includes/search.inc(2 hunks)web/themes/contrib/civictheme/includes/views.inc(4 hunks)web/themes/contrib/civictheme/package.json(1 hunks)web/themes/contrib/civictheme/src/Settings/CivicthemeSettingsFormSectionComponents.php(1 hunks)web/themes/contrib/civictheme/templates/views/views-exposed-form.html.twig(1 hunks)
🧰 Additional context used
🧬 Code graph analysis (1)
web/themes/contrib/civictheme/src/Settings/CivicthemeSettingsFormSectionComponents.php (2)
web/themes/contrib/civictheme/src/CivicthemeUtility.php (2)
CivicthemeUtility(10-157)arrayToMultiline(23-25)web/themes/contrib/civictheme/src/CivicthemeConfigManager.php (1)
load(67-74)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: build-and-push
- GitHub Check: commit
🔇 Additional comments (8)
web/themes/contrib/civictheme/civictheme.theme (2)
11-11: LGTM!The
Cacheclass import is necessary for the cache context merging functionality added later in the file.
165-165: Verified:_civictheme_preprocess_html__search_head_titleis defined inweb/themes/contrib/civictheme/includes/search.inc(line 44) and correctly extracts keywords and formats the head title.web/themes/contrib/civictheme/config/install/civictheme.settings.yml (1)
70-73: Verified keyword_fields match exposed filter identifiers in the search and automated list views.web/themes/contrib/civictheme/includes/views.inc (3)
165-177: Good implementation of inline filter logic.The early return pattern and view-specific filtering logic is clean and appropriate.
299-299: Correct cache context added for query arguments.The addition of
url.query_argscache context ensures proper cache variation based on query parameters.
302-312: Verify Twig escaping forresults_count
I couldn’t locate whereresults_countis rendered in the theme; please inspect the Twig template that outputs this variable and ensure it’s in an auto-escaped context (or explicitly passed through the|escapefilter) to prevent XSS from user-supplied keywords.web/themes/contrib/civictheme/config/optional/views.view.civictheme_search.yml (1)
221-230: Configuration changes align with keyword support.The header configuration correctly changes from a custom area to a result summary plugin with the
@keywordsplaceholder, which will be processed by_civictheme_preprocess_views_view__results_count()inviews.inc.web/themes/contrib/civictheme/includes/search.inc (1)
55-72: Cache context for query parameters is correctly applied
Theurl.query_argscontext is already being merged into$attachments['#cache']['contexts']inweb/themes/contrib/civictheme/civictheme.theme(around line 280).
web/themes/contrib/civictheme/config/install/views.view.civictheme_automated_list.yml
Show resolved
Hide resolved
web/themes/contrib/civictheme/src/Settings/CivicthemeSettingsFormSectionComponents.php
Show resolved
Hide resolved
| {% elseif inline_filter %} | ||
| {% include 'civictheme:inline-filter' with { | ||
| theme: theme, | ||
| items: filter_items, | ||
| } only %} |
There was a problem hiding this comment.
🧩 Analysis chain
Verify inline-filter component exists and preprocessing sets inline_filter variable.
The template now includes a civictheme:inline-filter component. Ensure:
- The component exists in the updated UIKit dependency
- The
inline_filtervariable is properly set inincludes/views.incpreprocessing - The
filter_itemsvariable is populated with the correct structure expected by the component
🏁 Script executed:
#!/bin/bash
# Check if inline-filter component exists in the components directory after uikit-install
fd -t d "inline-filter" components/
# Search for inline_filter variable assignment in views preprocessing
rg -n --type=php "inline_filter" web/themes/contrib/civictheme/includes/views.inc -C5Length of output: 713
🏁 Script executed:
#!/bin/bash
# Locate directories named inline-filter
fd -t d inline-filter
# Locate twig templates named inline-filter
fd -t f "*inline-filter*.twig"
# Find any files referencing inline-filter
rg -l "inline-filter"Length of output: 374
🏁 Script executed:
#!/bin/bash
# Search for inline-filter or inline_filter twig templates in the theme
find web/themes/contrib/civictheme/templates -type f \( -iname "*inline-filter*.twig" -o -iname "*inline_filter*.twig" \)Length of output: 0
Add missing inline-filter component template
The include in web/themes/contrib/civictheme/templates/views/views-exposed-form.html.twig references civictheme:inline-filter, but no corresponding Twig template or component directory exists. Add a templates/components/inline-filter.html.twig (or your project’s component path) to define this component. Variables inline_filter and filter_items are already set in includes/views.inc.
🤖 Prompt for AI Agents
In web/themes/contrib/civictheme/templates/views/views-exposed-form.html.twig
around lines 32 to 36 the template includes "civictheme:inline-filter" but no
component template exists; create a new Twig component at
web/themes/contrib/civictheme/templates/components/inline-filter.html.twig (or
your project's component path) that accepts the passed-in variables (theme and
filter_items / inline_filter), loops over filter_items to render each filter
control with appropriate markup/classes (respect theme if needed), and returns
the expected HTML structure used by the views-exposed-form include; after adding
the file clear Drupal caches so the new component is discoverable.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
web/themes/contrib/civictheme/includes/views.inc (1)
165-165: Fix typo in inline-filter commentReplace “exsits” with “exists” to tidy the comment.
- // Use inline filter on search and auto pages if a single text field exsits. + // Use inline filter on search and auto pages if a single text field exists.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
web/themes/contrib/civictheme/includes/form_element.inc(1 hunks)web/themes/contrib/civictheme/includes/views.inc(4 hunks)web/themes/contrib/civictheme/package.json(1 hunks)web/themes/contrib/civictheme/templates/form/form-element--civictheme-field.html.twig(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: build-and-push
- GitHub Check: build-and-push
- GitHub Check: commit
github-actions
bot
added
State: CONFLICT
and removed
State: Needs review
alan-cole
force-pushed
the
feature/3549220-search-results-message
branch
from
394ad2d to
08d8f19
Compare
alan-cole
added
the
State: Needs review
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
web/themes/contrib/civictheme/civictheme.theme (1)
280-280: Critical: Fix incorrect variable name in cache context merging.Line 280 references
$variablesbut the function parameter is$attachments. This will cause the cache context merging to fail or produce an undefined variable error.Apply this diff:
- $attachments['#cache']['contexts'] = Cache::mergeContexts($variables['#cache']['contexts'] ?? [], ['url.query_args']); + $attachments['#cache']['contexts'] = Cache::mergeContexts($attachments['#cache']['contexts'] ?? [], ['url.query_args']);web/themes/contrib/civictheme/includes/views.inc (1)
165-165: Fix typo in comment."exsits" should be "exists".
Apply this diff:
- // Use inline filter on search and auto pages if a single text field exsits. + // Use inline filter on search and auto pages if a single text field exists.
🧹 Nitpick comments (1)
web/themes/contrib/civictheme/includes/search.inc (1)
68-72: Consider removing redundant escaping.The
t()function with@placeholders automatically escapes values usingHtml::escape(), which internally useshtmlspecialchars(). Manually callinghtmlspecialchars()before passing tot()results in double-escaping, though it's not harmful.Apply this diff to simplify:
- $sanitized_keywords = htmlspecialchars($keywords, ENT_QUOTES, 'UTF-8'); $variables['head_title']['title'] = t("@title - Searching for '@keywords'", [ '@title' => $head_title, - '@keywords' => $sanitized_keywords, + '@keywords' => $keywords, ]);
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (11)
web/themes/contrib/civictheme/civictheme.theme(3 hunks)web/themes/contrib/civictheme/config/install/civictheme.settings.yml(1 hunks)web/themes/contrib/civictheme/config/install/views.view.civictheme_automated_list.yml(1 hunks)web/themes/contrib/civictheme/config/optional/views.view.civictheme_search.yml(1 hunks)web/themes/contrib/civictheme/includes/form_element.inc(1 hunks)web/themes/contrib/civictheme/includes/search.inc(2 hunks)web/themes/contrib/civictheme/includes/views.inc(4 hunks)web/themes/contrib/civictheme/package.json(1 hunks)web/themes/contrib/civictheme/src/Settings/CivicthemeSettingsFormSectionComponents.php(2 hunks)web/themes/contrib/civictheme/templates/form/form-element--civictheme-field.html.twig(1 hunks)web/themes/contrib/civictheme/templates/views/views-exposed-form.html.twig(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (5)
- web/themes/contrib/civictheme/templates/form/form-element--civictheme-field.html.twig
- web/themes/contrib/civictheme/config/install/views.view.civictheme_automated_list.yml
- web/themes/contrib/civictheme/includes/form_element.inc
- web/themes/contrib/civictheme/templates/views/views-exposed-form.html.twig
- web/themes/contrib/civictheme/config/install/civictheme.settings.yml
🧰 Additional context used
🧬 Code graph analysis (1)
web/themes/contrib/civictheme/src/Settings/CivicthemeSettingsFormSectionComponents.php (2)
web/themes/contrib/civictheme/src/Settings/CivicthemeSettingsFormSectionOptout.php (2)
form(27-60)multilineToArray(65-68)web/themes/contrib/civictheme/src/CivicthemeUtility.php (3)
CivicthemeUtility(10-157)arrayToMultiline(23-25)multilineToArray(36-40)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: build-and-push
- GitHub Check: build-and-push
- GitHub Check: commit
🔇 Additional comments (4)
web/themes/contrib/civictheme/config/optional/views.view.civictheme_search.yml (1)
221-230: LGTM!The header configuration changes correctly introduce the
@keywordsplaceholder, which aligns with the PR's goal of adding keyword support. The placeholder will be dynamically replaced by the preprocessor inweb/themes/contrib/civictheme/includes/views.inc.web/themes/contrib/civictheme/src/Settings/CivicthemeSettingsFormSectionComponents.php (1)
606-616: LGTM!The
submitSearchhandler correctly converts the multiline textarea input to an array before saving, addressing the past review comment. The implementation follows the established pattern and integrates seamlessly with the auto-discovery mechanism.web/themes/contrib/civictheme/includes/views.inc (2)
166-178: LGTM!The instanceof check at line 166 correctly guards against null/invalid View objects before calling
$view->id(), addressing the past review concern. The inline filter logic properly handles single-field exposed forms for search and automated list views.
283-316: LGTM!The
_civictheme_preprocess_views_view__results_countfunction is well-structured with appropriate early returns, proper cache context handling, and correct keyword extraction logic. The implementation aligns with the PR's objectives for keyword-based search result messaging.
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
web/themes/contrib/civictheme/civictheme.theme(3 hunks)web/themes/contrib/civictheme/includes/search.inc(2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- web/themes/contrib/civictheme/civictheme.theme
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: build-and-push
- GitHub Check: commit
🔇 Additional comments (2)
web/themes/contrib/civictheme/includes/search.inc (2)
11-11: LGTM!The import of
CivicthemeUtilityis appropriate for the new functionality.
44-49: Verify cache context in preprocess_html
Nocivictheme_preprocess_htmlimplementation was found; ensure your theme’s preprocess_html hook adds theurl.query_argscache context to prevent serving stale cached pages for different query parameters.
| foreach ($search_fields as $field) { | ||
| $query_field = \Drupal::request()->query->get($field); | ||
| if (!empty($query_field)) { | ||
| $keywords = $query_field; | ||
| break; | ||
| } | ||
| } |
There was a problem hiding this comment.
Add input validation and error handling for query parameters.
The code retrieves query parameters without validation or error handling, which could lead to issues:
- No input validation: Query parameter values are not validated for length or type. A malicious user could pass extremely long strings that might cause memory issues or unexpected behavior.
- No null-safety: If
\Drupal::request()returns null (though rare), this will cause a fatal error.
Apply this diff to add validation:
$keywords = NULL;
$search_fields = CivicthemeUtility::multilineToArray($setting_keyword_fields);
foreach ($search_fields as $field) {
- $query_field = \Drupal::request()->query->get($field);
+ $request = \Drupal::request();
+ if (!$request) {
+ continue;
+ }
+ $query_field = $request->query->get($field);
if (!empty($query_field)) {
+ // Limit keyword length to prevent abuse.
+ $query_field = is_string($query_field) ? mb_substr($query_field, 0, 255) : '';
$keywords = $query_field;
break;
}
}🤖 Prompt for AI Agents
In web/themes/contrib/civictheme/includes/search.inc around lines 54 to 60, the
code reads query parameters without null-safety or validation; update it to
first ensure \Drupal::request() returns a Request object
(null-check/type-check), then retrieve each $field value safely, ensure it is a
string, trim it, enforce a maximum length (e.g. 1024 chars) and optional
pattern/type checks, and only assign $keywords and break when the value passes
validation; if validation fails, skip that param and optionally log a warning or
set a safe default so no fatal error or unbounded input is accepted.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
web/themes/contrib/civictheme/includes/views.inc (1)
191-214: LGTM with a minor suggestion!The function correctly guards against invalid views and implements the inline filter logic. The past review concern about null guards has been addressed.
Consider adding a null check before accessing the submit button:
$variables['inline_filter'] = TRUE; $keyword_field['#title_size'] = 'extra-large'; $variables['filter_items'] = $keyword_field; - $submit_field = $variables['form']['actions']['submit'] ?? NULL; - if (!empty($submit_field)) { + if (!empty($variables['form']['actions']['submit'])) { + $submit_field = $variables['form']['actions']['submit']; $variables['submit_text'] = $submit_field['#value'] ?? ''; }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
web/themes/contrib/civictheme/includes/search.inc(2 hunks)web/themes/contrib/civictheme/includes/views.inc(4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- web/themes/contrib/civictheme/includes/search.inc
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: build-and-push
- GitHub Check: build-and-push
- GitHub Check: commit
🔇 Additional comments (3)
web/themes/contrib/civictheme/includes/views.inc (3)
11-11: LGTM!The import is necessary for the
multilineToArray()method used in the new results count preprocessor.
25-25: LGTM!The preprocessor call is correctly integrated following the existing pattern.
165-169: LGTM!The inline filter check correctly returns early when applicable, preventing the fallback to single filter processing. The typo and guard issues from previous reviews have been addressed.
| 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)) { | ||
| // Strip the @keywords token because it exists but won't be populated. | ||
| $variables['results_count'] = str_replace('@keywords', '', $variables['results_count']); | ||
| 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']); | ||
| } |
There was a problem hiding this comment.
🧩 Analysis chain
Guard against missing view object.
Line 335 calls $variables['view']->getExposedInput() without verifying that $variables['view'] exists, which could cause a fatal error.
Apply this diff to add a guard:
if (!str_contains($variables['results_count'], '@keywords')) {
return;
}
+ if (empty($variables['view'])) {
+ $variables['results_count'] = str_replace('@keywords', '', $variables['results_count']);
+ return;
+ }
// Load search fields from theme settings.Verify the keyword extraction logic.
Lines 338-343 extract keywords from the first matching field and break immediately. If multiple search fields are configured (e.g., "keywords" and "title"), only the first field with a value will be used. Please confirm this is the intended behavior rather than concatenating or prioritizing keywords.
Run the following script to check how keyword_fields are configured and used:
🏁 Script executed:
#!/bin/bash
# Description: Check keyword_fields configuration and usage
# Find theme settings configuration
fd -e yml -e yaml . | xargs rg -l "keyword_fields" | head -5
# Check how keyword_fields are used in preprocessing
rg -A 5 "keyword_fields" --type=phpLength of output: 2731
🏁 Script executed:
#!/bin/bash
# Inspect default config for keyword_fields
echo "== YAML snippet for keyword_fields =="
rg -n "keyword_fields" -C2 web/themes/contrib/civictheme/config/install/civictheme.settings.yml
# Locate multilineToArray implementation
echo "== multilineToArray implementation =="
rg -n "function multilineToArray" -C5 web/themes/contrib/civictheme/src/UtilityLength of output: 258
Add guard for missing view and confirm keyword field priority.
- After the
str_containscheck, guard against a missing view to avoid a fatal error:
if (!str_contains($variables['results_count'], '@keywords')) {
return;
}
+ if (empty($variables['view'])) {
+ $variables['results_count'] = str_replace('@keywords', '', $variables['results_count']);
+ return;
+ }- Confirm that only the first non-empty field from
components.search.keyword_fieldsis intended to replace@keywordsrather than combining multiple fields.
📝 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.
| 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)) { | |
| // Strip the @keywords token because it exists but won't be populated. | |
| $variables['results_count'] = str_replace('@keywords', '', $variables['results_count']); | |
| 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']); | |
| } | |
| function _civictheme_preprocess_views_view__results_count(array &$variables): void { | |
| if (empty($variables['results_count'])) { | |
| return; | |
| } | |
| if (!str_contains($variables['results_count'], '@keywords')) { | |
| return; | |
| } | |
| if (empty($variables['view'])) { | |
| // Strip the @keywords token because no view is available to provide keywords. | |
| $variables['results_count'] = str_replace('@keywords', '', $variables['results_count']); | |
| 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)) { | |
| // Strip the @keywords token because it exists but won't be populated. | |
| $variables['results_count'] = str_replace('@keywords', '', $variables['results_count']); | |
| 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']); | |
| } |
🤖 Prompt for AI Agents
In web/themes/contrib/civictheme/includes/views.inc around lines 316 to 346, add
a null/instance guard after the str_contains check to ensure $variables['view']
exists and is an object before calling getExposedInput() to avoid a fatal error
(return early if missing), and make the replacement behavior explicit: either
keep the current logic which uses only the first non-empty field from
components.search.keyword_fields (document this with a short inline comment) or,
if the intent is to combine multiple fields, change the loop to accumulate
non-empty fields into $keywords (joined with a separator) and use that combined
string when replacing @keywords; also preserve cache context merging and the
existing token stripping fallback.
b8d9a1b to
3957fa8
Compare
github-actions
bot
added
State: CONFLICT
and removed
State: Needs review
https://www.drupal.org/project/civictheme/issues/3549220
Checklist before requesting a review
Issue #123456 by drupal_org_username: Issue titleChangedsection about WHY something was done if this was not a normal implementationChanged
"Showing @start - @end of @total @keywords"instead of"Search results...""Showing @start - @end of @total @keywords"url.query_args.@keywordsif present.Screenshots
Screenshots for Points 1-6.
Screenshot for Point 7.
Summary by CodeRabbit
New Features
Chores