Fixed hooks for Automated list to allow alteration withiin consumer sites.

AlexSkrypnyk · AlexSkrypnyk · commit 289d35841120 · 2024-07-15T18:18:09.000+10:00
diff --git a/tests/behat/features/paragraph.civictheme_automated_list.render.feature b/tests/behat/features/paragraph.civictheme_automated_list.render.feature
@@ -238,9 +238,11 @@ Feature: Automated list render
   @api @testmode
   Scenario: Automated list, different view from listing type field
     Given "civictheme_page" content:
-      | title          | created            | status | moderation_state |
-      | [TEST] Page 16 | [relative:-5 days] | 1      | published        |
-      | [TEST] Page 17 | [relative:-5 days] | 1      | published        |
+      | title          | created            | status | moderation_state | field_c_n_vertical_spacing |
+      | [TEST] Page 16 | [relative:-5 days] | 1      | published        | both                       |
+      | [TEST] Page 17 | [relative:-5 days] | 1      | published        | both                       |
+      | [TEST] Page 18 | [relative:-5 days] | 1      | published        | top                        |
+      | [TEST] Page 19 | [relative:-5 days] | 1      | published        | top                        |
 
     And "field_c_n_components" in "civictheme_page" "node" with "title" of "Test page with Automated list content" has "civictheme_automated_list" paragraph:
       | field_c_p_title            | [TEST] Automated list title |
@@ -260,7 +262,9 @@ Feature: Automated list render
     And I should see an ".ct-list__filters" element
 
     # Add a Test view as a list type.
-    # This view only shows items older than 2 days and has a Title filter exposed.
+    # This view only shows items older than 2 days, having a 'top' vertical
+    # spacing (to assert the adjustems via preprocess hook) and has a Title
+    # filter exposed.
     When I am logged in as a user with the "Administrator" role
     And I go to "admin/structure/paragraphs_type/civictheme_automated_list/fields/paragraph.civictheme_automated_list.field_c_p_list_type"
     And I fill in the following:
@@ -277,7 +281,8 @@ Feature: Automated list render
     And I press "Save"
 
     And I should see 2 ".ct-promo-card" elements
-    And I should see 2 ".ct-promo-card.ct-theme-light" elements
+    # Preprocess hook overrides the 'item_theme' to be 'dark'.
+    And I should see 2 ".ct-promo-card.ct-theme-dark" elements
     And I should not see an ".ct-list__pagination" element
 
     And I should see an ".ct-list__filters" element
diff --git a/web/modules/custom/civictheme_dev/civictheme_dev.module b/web/modules/custom/civictheme_dev/civictheme_dev.module
@@ -7,8 +7,10 @@
 
 declare(strict_types=1);
 
+use Drupal\civictheme\CivicthemeConstants;
 use Drupal\civictheme\CivicthemeVersionManager;
 use Drupal\Core\Site\Settings;
+use Drupal\views\ViewExecutable;
 
 require_once __DIR__ . '/styleguide.inc';
 
@@ -48,3 +50,44 @@ function civictheme_dev_styleguide_alter(array &$items): void {
   _civictheme_dev_styleguide__form_test__checkboxes($items);
   _civictheme_dev_styleguide__form_test__radios($items);
 }
+
+/**
+ * Implements hook_civictheme_automated_list_view_info_alter().
+ */
+function civictheme_dev_civictheme_automated_list_view_info_alter(array &$info, array $settings): void {
+  if ($settings['content_type'] == 'civictheme_event') {
+    // Use a different view and display for 'civictheme_event' content type.
+    $info['view_name'] = 'civictheme_automated_list_examples';
+    $info['display_name'] = 'page_multiple_filters';
+  }
+}
+
+/**
+ * Implements hook_civictheme_automated_list_preprocess_view_alter().
+ */
+function civictheme_dev_civictheme_automated_list_preprocess_view_alter(ViewExecutable $view): void {
+  if ($view->id() === 'civictheme_automated_list_test') {
+    if (!property_exists($view, 'component_settings') || $view->component_settings === NULL) {
+      return;
+    }
+
+    $view->component_settings['theme'] = CivicthemeConstants::THEME_LIGHT;
+    $view->component_settings['item_theme'] = CivicthemeConstants::THEME_DARK;
+
+    // Example of setting view arguments based on the expected contextual
+    // filters of this specific view.
+    $view_args = [];
+    // First view argument - content types.
+    $view_args[] = $view->component_settings['content_type'] ?? 'all';
+    // Second view argument - Topics.
+    $view_args[] = empty($view->component_settings['topics']) ? 'all' : implode('+', array_keys($view->component_settings['topics']));
+    // Third view argument - Site Sections.
+    $view_args[] = empty($view->component_settings['site_sections']) ? 'all' : implode('+', array_keys($view->component_settings['site_sections']));
+    // Fourth view argument - Content ID value.
+    $view_args[] = 'all';
+    // Fifth view argument - Vertical Spacing value (used as an example).
+    $view_args[] = CivicthemeConstants::VERTICAL_SPACING_TOP;
+
+    $view->setArguments($view_args);
+  }
+}
diff --git a/web/modules/custom/civictheme_dev/config/install/views.view.civictheme_automated_list_test.yml b/web/modules/custom/civictheme_dev/config/install/views.view.civictheme_automated_list_test.yml
@@ -7,6 +7,7 @@ dependencies:
     - taxonomy.vocabulary.civictheme_topics
   module:
     - node
+    - options
     - taxonomy
     - user
 id: civictheme_automated_list_test
@@ -300,6 +301,45 @@ display:
           validate_options: {  }
           break_phrase: false
           not: true
+        field_c_n_vertical_spacing_value:
+          id: field_c_n_vertical_spacing_value
+          table: node__field_c_n_vertical_spacing
+          field: field_c_n_vertical_spacing_value
+          relationship: none
+          group_type: group
+          admin_label: ''
+          plugin_id: string_list_field
+          default_action: ignore
+          exception:
+            value: all
+            title_enable: false
+            title: All
+          title_enable: false
+          title: ''
+          default_argument_type: fixed
+          default_argument_options:
+            argument: ''
+          summary_options:
+            base_path: ''
+            count: true
+            override: false
+            items_per_page: 25
+          summary:
+            sort_order: asc
+            number_of_records: 0
+            format: default_summary
+            human: false
+          specify_validation: false
+          validate:
+            type: none
+            fail: 'not found'
+          validate_options: {  }
+          glossary: false
+          limit: 0
+          case: none
+          path_case: none
+          transform_dash: false
+          break_phrase: false
       filters:
         status:
           id: status
@@ -572,7 +612,6 @@ display:
         - 'languages:language_interface'
         - url
         - url.query_args
-        - user
         - 'user.node_grants:view'
         - user.permissions
       tags: {  }
@@ -595,7 +634,6 @@ display:
         - 'languages:language_interface'
         - url
         - url.query_args
-        - user
         - 'user.node_grants:view'
         - user.permissions
       tags: {  }
diff --git a/web/themes/contrib/civictheme/civictheme.api.php b/web/themes/contrib/civictheme/civictheme.api.php
@@ -12,14 +12,23 @@
 use Drupal\views\ViewExecutable;
 
 /**
- * Alter the view info used in the Automated list component.
+ * Alter the info about the view used in the Automated list component.
+ *
+ * This hook allows to alter which view and display are used to power the
+ * Automated list component based on the settings provided.
+ * The settings are extracted from the fields provided by the CivicTheme within
+ * the Automated list paragraph entity.
+ * Note that for any custom fields added to the Automated list paragraph entity,
+ * the settings would need to be extracted from those fields using
+ * $settings['paragraph']->get('field_name')->getString() or similar methods as
+ * CivicTheme cannot predict the field names used in the custom implementation.
  *
  * @param array $info
  *   View info array to alter passed by reference. Keys are:
  *   - view_name: (string) A view machine name.
  *   - display_name: (string) A view display machine name.
  * @param array $settings
- *   The Automated list component settings passed by reference with the
+ *   The Automated list component settings with the
  *   following keys:
  *   - title: (string) List title.
  *   - type: (string) List type (view name that powers Automated list).
@@ -33,8 +42,9 @@
  *   - topics: (array) Array of Topic entities.
  *   - site_sections: (array) Array of Site section entities.
  *   - cache_tags: (array) Array of the cache tags.
+ *   - paragraph: (Paragraph) The paragraph entity.
  */
-function hook_civictheme_automated_list_view_info_alter(array &$info, array &$settings): void {
+function hook_civictheme_automated_list_view_info_alter(array &$info, array $settings): void {
   // Change the view name and block based on the conditions set in the
   // Automated list settings.
   if ($settings['content_type'] == 'event') {
@@ -49,48 +59,65 @@ function hook_civictheme_automated_list_view_info_alter(array &$info, array &$se
 }
 
 /**
- * Alter the CivicTheme view preprocess settings.
+ * Alter the view used in the Automated list component before rendering.
  *
- * @param array $variables
- *   Array of preprocess variables of the Automated list view.
+ * The view instance already has settings applied from the default fields
+ * provided by the CivicTheme within the Automated list paragraph entity.
+ * Any additional settings can be extracted from the fields provided by the
+ * Automated list paragraph entity using $view->component_settings['paragraph'].
+ *
+ * @param \Drupal\views\ViewExecutable $view
+ *   The view object to alter.
  */
-function hook_civictheme_automated_list_preprocess_view_alter(array &$variables, ViewExecutable &$view): void {
-  if ($view->id() == 'civictheme_view_examples') {
-    $variables['theme'] = CivicthemeConstants::THEME_DARK;
-    $variables['with_background'] = TRUE;
-    $variables['vertical_spacing'] = 'both';
+function hook_civictheme_automated_list_preprocess_view_alter(ViewExecutable $view): void {
+  // Example of altering the view theme, item theme and arguments.
+  if ($view->id() === 'custom_view_id') {
+    $view->component_settings['theme'] = CivicthemeConstants::THEME_LIGHT;
+    $view->component_settings['item_theme'] = CivicthemeConstants::THEME_DARK;
+
+    // Example of setting view arguments based on the expected contextual
+    // filters of this specific view.
+    // In thi example, the view has 3 contextual filters.
+    $view_args = [];
+    // First view argument - content types. Read from settings.
+    $view_args[] = $view->component_settings['content_type'] ?? 'all';
+    // Second view argument - Content ID value. Use `all` to skip it.
+    $view_args[] = 'all';
+    // Third view argument - Vertical Spacing value. Use a constant value.
+    $view_args[] = CivicthemeConstants::VERTICAL_SPACING_TOP;
+    // Set the arguments to the view.
+    $view->setArguments($view_args);
   }
+}
 
-  /**
-   * Allow to suppress page regions for pages with Layout Builder enabled.
-   *
-   * @param array $variables
-   *   Array of variables passed to the page template.
-   * @param array $context
-   *   Array of context data.
-   *   - node: The node object.
-   *   - layout_builder_settings_per_view_mode: An array of the layout builder
-   *     settings keyed by view mode.
-   *
-   * @SuppressWarnings(PHPMD.StaticAccess)
-   */
-  function hook_civictheme_layout_suppress_page_regions_alter(array &$variables, array $context): void {
-    /** @var \Drupal\node\NodeInterface $node */
-    $node = $variables['node'];
-    if ($node->bundle() == 'civictheme_page' && $context['layout_builder_settings_per_view_mode']['full']['enabled']) {
-      $variables['page']['sidebar_top_left'] = [];
-      $variables['page']['sidebar_bottom_left'] = [];
-      $variables['page']['sidebar_top_right'] = [];
-      $variables['page']['sidebar_bottom_right'] = [];
+/**
+ * Allow to suppress page regions for pages with Layout Builder enabled.
+ *
+ * @param array $variables
+ *   Array of variables passed to the page template.
+ * @param array $context
+ *   Array of context data.
+ *   - node: The node object.
+ *   - layout_builder_settings_per_view_mode: An array of the layout builder
+ *     settings keyed by view mode.
+ *
+ * @SuppressWarnings(PHPMD.StaticAccess)
+ */
+function hook_civictheme_layout_suppress_page_regions_alter(array &$variables, array $context): void {
+  /** @var \Drupal\node\NodeInterface $node */
+  $node = $variables['node'];
+  if ($node->bundle() == 'civictheme_page' && $context['layout_builder_settings_per_view_mode']['full']['enabled']) {
+    $variables['page']['sidebar_top_left'] = [];
+    $variables['page']['sidebar_bottom_left'] = [];
+    $variables['page']['sidebar_top_right'] = [];
+    $variables['page']['sidebar_bottom_right'] = [];
 
-      // Do not forget to merge the cache contexts.
-      $variables['#cache']['contexts'] = Cache::mergeContexts(
-        $variables['#cache']['contexts'] ?? [],
-        [
-          'user.roles:authenticated',
-        ]
-      );
-    }
+    // Do not forget to merge the cache contexts.
+    $variables['#cache']['contexts'] = Cache::mergeContexts(
+      $variables['#cache']['contexts'] ?? [],
+      [
+        'user.roles:authenticated',
+      ]
+    );
   }
-
 }
diff --git a/web/themes/contrib/civictheme/civictheme_starter_kit/civictheme_starter_kit.theme b/web/themes/contrib/civictheme/civictheme_starter_kit/civictheme_starter_kit.theme
diff --git a/web/themes/contrib/civictheme/includes/automated_list.inc b/web/themes/contrib/civictheme/includes/automated_list.inc
@@ -39,11 +39,19 @@ function civictheme_preprocess_paragraph__civictheme_automated_list(array &$vari
   _civictheme_preprocess_paragraph__paragraph_field__background($variables);
 
   // Views settings.
-  // We want to have a single place to gather all the view settings to pass
+  // We want to have a single place to gather all initial view settings to pass
   // them further in the pipeline. There should not be any other places to
   // access these fields variables directly (separation of concerns). Only
   // these settings should be used.
+  // Consumer sites can alter these settings in
+  // hook_civictheme_automated_list_preprocess_view_alter().
   $settings = [];
+  // Store paragraph entity in the settings to allow accessing the values of
+  // fields that may be added in the consumer sites (in addition to the fields
+  // provided by the CivicTheme Automated List paragraph).
+  $settings['paragraph'] = $paragraph;
+  $settings['cache_tags'] = $paragraph->getCacheTags();
+  // Settings provided by the CivicTheme Automated List paragraph's fields.
   $settings['type'] = civictheme_get_field_value($paragraph, 'field_c_p_list_type');
   $settings['content_type'] = civictheme_get_field_value($paragraph, 'field_c_p_list_content_type');
   $settings['limit'] = civictheme_get_field_value($paragraph, 'field_c_p_list_limit');
@@ -53,14 +61,10 @@ function civictheme_preprocess_paragraph__civictheme_automated_list(array &$vari
   $settings['item_theme'] = civictheme_get_field_value($paragraph, 'field_c_p_list_item_theme');
   $settings['topics'] = civictheme_get_field_value($paragraph, 'field_c_p_list_topics');
   $settings['site_sections'] = civictheme_get_field_value($paragraph, 'field_c_p_list_site_sections');
-  $settings['cache_tags'] = $paragraph->getCacheTags();
-  // Use existing value getters to populate settings.
-  $settings['paragraph'] = $paragraph;
   _civictheme_preprocess_paragraph__paragraph_field__theme($settings);
   _civictheme_preprocess_paragraph__paragraph_field__title($settings);
   _civictheme_preprocess_paragraph__paragraph_field__column_count($settings);
   _civictheme_preprocess_paragraph__paragraph_field__fill_width($settings);
-  unset($settings['paragraph']);
 
   // Get view with already set display.
   try {
@@ -128,7 +132,7 @@ function _civictheme_automated_list__get_view(array &$settings): ViewExecutable
       'display_name' => $parts[1] ?? 'default',
     ];
 
-    // Allow to alter view information to modules and themes.
+    // Allow modules and themes to alter view information.
     \Drupal::moduleHandler()->alter('civictheme_automated_list_view_info', $info, $settings);
     \Drupal::service('theme.manager')->alter('civictheme_automated_list_view_info', $info, $settings);
   }
@@ -252,6 +256,10 @@ function _civictheme_automated_list__update_view(ViewExecutable $view): void {
     }
   }
 
+  // Allow modules and themes to alter view based on settings.
+  \Drupal::moduleHandler()->alter('civictheme_automated_list_preprocess_view', $view);
+  \Drupal::service('theme.manager')->alter('civictheme_automated_list_preprocess_view', $view);
+
   // Mark these settings.
   $view->component_settings['processed'] = TRUE;
 }
