EWPP-2570: Add EventSubscriber to alter created/updated facets.

modules/oe_list_pages_open_vocabularies/oe_list_pages_open_vocabularies.services.yml

@@ -1,7 +1,7 @@
 services:
   oe_list_pages_open_vocabularies.configurator:
     class: \Drupal\oe_list_pages_open_vocabularies\SearchApiConfigurator
-    arguments: ['@entity_type.manager', '@entity_field.manager', '@oe_list_pages.list_source.factory', '@language_manager']
+    arguments: ['@entity_type.manager', '@entity_field.manager', '@oe_list_pages.list_source.factory', '@language_manager', '@event_dispatcher']
   oe_list_pages_open_vocabularies.config_subscriber:
     class: Drupal\oe_list_pages_open_vocabularies\EventSubscriber\AssociationTranslationSubscriber
     arguments: ['@oe_list_pages_open_vocabularies.configurator', '@entity_type.manager']

modules/oe_list_pages_open_vocabularies/src/Event/SearchApiConfigurationEvents.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Drupal\oe_list_pages_open_vocabularies\Event;
+
+/**
+ * Update Search API configuration.
+ *
+ * @internal
+ */
+final class SearchApiConfigurationEvents {
+
+  /**
+   * Event update search API facet configuration.
+   */
+  const UPDATE_SEARCH_API_FACET = 'oe_list_pages_open_vocabularies.update_search_api_facet_config';
+
+}

modules/oe_list_pages_open_vocabularies/src/Event/SearchApiFacetUpdateEvent.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Drupal\oe_list_pages_open_vocabularies\Event;
+
+use Drupal\facets\FacetInterface;
+use Symfony\Component\EventDispatcher\Event;
+
+/**
+ * Event for updating search api facet configuration.
+ */
+class SearchApiFacetUpdateEvent extends Event {
+
+  /**
+   * The facet.
+   *
+   * @var \Drupal\facets\FacetInterface
+   */
+  protected FacetInterface $facet;
+
+  /**
+   * SearchApiFacetUpdateEvent constructor.
+   */
+  public function __construct(FacetInterface $facet) {
+    $this->facet = $facet;
+  }
+
+  /**
+   * Return the facet object.
+   *
+   * @return \Drupal\facets\FacetInterface
+   *   The facet object instance.
+   */
+  public function getFacet(): FacetInterface {
+    return $this->facet;
+  }
+
+  /**
+   * Set the updated facet object.
+   *
+   * @param \Drupal\facets\FacetInterface $facet
+   *   The facet object instance.
+   *
+   * @return $this
+   */
+  public function setFacet(FacetInterface $facet): SearchApiFacetUpdateEvent {
+    $this->facet = $facet;
+    return $this;
+  }
+
+}

modules/oe_list_pages_open_vocabularies/src/SearchApiConfigurator.php

@@ -8,10 +8,13 @@
 use Drupal\facets\FacetInterface;
 use Drupal\language\Config\LanguageConfigOverride;
 use Drupal\oe_list_pages\ListSourceFactoryInterface;
+use Drupal\oe_list_pages_open_vocabularies\Event\SearchApiConfigurationEvents;
+use Drupal\oe_list_pages_open_vocabularies\Event\SearchApiFacetUpdateEvent;
 use Drupal\open_vocabularies\OpenVocabularyAssociationInterface;
 use Drupal\search_api\IndexInterface;
 use Drupal\search_api\Item\Field;
 use Drupal\search_api\Item\FieldInterface;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 
 /**
  * Configure search api when vocabulary associations are created.
@@ -53,14 +56,22 @@ class SearchApiConfigurator {
    */
   private $languageManager;
 
+  /**
+   * The event dispatcher.
+   *
+   * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
+   */
+  protected $eventDispatcher;
+
   /**
    * {@inheritdoc}
    */
-  public function __construct(EntityTypeManagerInterface $entityTypeManager, EntityFieldManagerInterface $entityFieldManager, ListSourceFactoryInterface $listSourceFactory, LanguageManagerInterface $languageManager) {
+  public function __construct(EntityTypeManagerInterface $entityTypeManager, EntityFieldManagerInterface $entityFieldManager, ListSourceFactoryInterface $listSourceFactory, LanguageManagerInterface $languageManager, EventDispatcherInterface $eventDispatcher) {
     $this->entityTypeManager = $entityTypeManager;
     $this->listSourceFactory = $listSourceFactory;
     $this->entityFieldManager = $entityFieldManager;
     $this->languageManager = $languageManager;
+    $this->eventDispatcher = $eventDispatcher;
   }
 
   /**
@@ -133,7 +144,11 @@ public function updateConfig(OpenVocabularyAssociationInterface $association, st
     $facet->setFacetSourceId($list_source->getSearchId());
     $facet->setWidget('oe_list_pages_multiselect', []);
     $facet->setFieldIdentifier($property_path);
-    $facet->save();
+
+    // Use event dispatching to allow alter facet config before saving.
+    $event = new SearchApiFacetUpdateEvent($facet);
+    $this->eventDispatcher->dispatch($event, SearchApiConfigurationEvents::UPDATE_SEARCH_API_FACET);
+    $event->getFacet()->save();
   }
 
   /**

modules/oe_list_pages_open_vocabularies/tests/modules/oe_list_pages_open_vocabularies_test/oe_list_pages_open_vocabularies_test.services.yml

@@ -0,0 +1,6 @@
+services:
+  oe_list_pages_open_vocabularies_test.config_subscriber:
+    class: Drupal\oe_list_pages_open_vocabularies_test\EventSubscriber\SearchApiFacetTestSubscriber
+    arguments: ['@oe_list_pages_open_vocabularies.configurator', '@entity_type.manager']
+    tags:
+      - { name: event_subscriber }

modules/oe_list_pages_open_vocabularies/tests/modules/oe_list_pages_open_vocabularies_test/src/EventSubscriber/SearchApiFacetTestSubscriber.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Drupal\oe_list_pages_open_vocabularies_test\EventSubscriber;
+
+use Drupal\oe_list_pages_open_vocabularies\Event\SearchApiConfigurationEvents;
+use Drupal\oe_list_pages_open_vocabularies\Event\SearchApiFacetUpdateEvent;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+/**
+ * Responds to changes to facet configuration update/create.
+ */
+class SearchApiFacetTestSubscriber implements EventSubscriberInterface {
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function getSubscribedEvents() {
+    $events[SearchApiConfigurationEvents::UPDATE_SEARCH_API_FACET] = 'onFacetUpdate';
+    return $events;
+  }
+
+  /**
+   * Updates the open vocabulary facets before saving.
+   *
+   * @param \Drupal\oe_list_pages_open_vocabularies\Event\SearchApiFacetUpdateEvent $event
+   *   The Search API Facet update event.
+   */
+  public function onFacetUpdate(SearchApiFacetUpdateEvent $event) {
+    $facet = $event->getFacet();
+    $settings = [
+      'behavior' => 'text',
+      'text' => 'No results found for this block!',
+      'text_format' => 'plain_text',
+    ];
+    $facet->setEmptyBehavior($settings);
+    $event->setFacet($facet);
+  }
+
+}

modules/oe_list_pages_open_vocabularies/tests/src/Kernel/ListPagesSearchApiConfiguratorTest.php

@@ -61,6 +61,13 @@ public function testVocabularyAssociationChanges(): void {
     $this->assertEquals($values['label'], $facet_1->label());
     $this->assertEquals($field_id, $facet_1->getFieldIdentifier());
     $this->assertEquals($facet_1->getWeight(), SearchApiConfigurator::MAX_WEIGHT);
+    // Assert overriding of empty_behavior value by
+    // \Drupal\oe_list_pages_open_vocabularies_test\EventSubscriber\SearchApiFacetTestSubscriber.
+    $this->assertEquals([
+      'behavior' => 'text',
+      'text' => 'No results found for this block!',
+      'text_format' => 'plain_text',
+    ], $facet_1->getEmptyBehavior());
     $facet_2 = Facet::load($id_2);
     $this->assertNull($facet_2);
     // Check fields exists.
@@ -88,14 +95,27 @@ public function testVocabularyAssociationChanges(): void {
     $this->assertEquals('New label', $facet_1->label());
     $this->assertEquals($field_id, $facet_1->getFieldIdentifier());
     $this->assertEquals($facet_1->getWeight(), SearchApiConfigurator::MAX_WEIGHT);
+    // Assert overriding of empty_behavior value by
+    // \Drupal\oe_list_pages_open_vocabularies_test\EventSubscriber\SearchApiFacetTestSubscriber.
+    $this->assertEquals([
+      'behavior' => 'text',
+      'text' => 'No results found for this block!',
+      'text_format' => 'plain_text',
+    ], $facet_1->getEmptyBehavior());
     $this->assertArrayHasKey('url_processor_handler', $facet_1->getProcessors());
     $this->assertArrayHasKey('display_value_widget_order', $facet_1->getProcessors());
     $this->assertArrayHasKey('translate_entity', $facet_1->getProcessors());
     $facet_2 = Facet::load($id_2);
     $this->assertEquals('New label', $facet_2->label());
     $this->assertEquals($field_id, $facet_2->getFieldIdentifier());
     $this->assertEquals($facet_2->getWeight(), SearchApiConfigurator::MAX_WEIGHT);
-
+    // Assert overriding of empty_behavior value by
+    // \Drupal\oe_list_pages_open_vocabularies_test\EventSubscriber\SearchApiFacetTestSubscriber.
+    $this->assertEquals([
+      'behavior' => 'text',
+      'text' => 'No results found for this block!',
+      'text_format' => 'plain_text',
+    ], $facet_2->getEmptyBehavior());
     // Check field exists.
     $node_index = Index::load('node');
     $field_1 = $node_index->getField($field_id);