From 4d77ff78ecc66817b7af235a2e262cb429e8aa15 Mon Sep 17 00:00:00 2001
From: Len van Essen <len@wndr.digital>
Date: Fri, 23 Sep 2022 10:46:24 +0200
Subject: [PATCH] Add before query event

---
 CHANGELOG.md                    |  5 +++++
 src/events/BeforeQueryEvent.php | 13 +++++++++++++
 src/services/Elements.php       | 14 ++++++++++++++
 3 files changed, 32 insertions(+)
 create mode 100644 src/events/BeforeQueryEvent.php

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 80a9acc..1ab9d5c 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Release Notes for Elasticsearch Plugin
 
+## Unreleased
+
+### Added
+- Event to manipulate the search parameters before querying Elasticsearch.
+
 ## 1.2.0 - 2022-06-15
 
 ### Added
diff --git a/src/events/BeforeQueryEvent.php b/src/events/BeforeQueryEvent.php
new file mode 100644
index 0000000..bdf3e85
--- /dev/null
+++ b/src/events/BeforeQueryEvent.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace codemonauts\elastic\events;
+
+use yii\base\Event;
+
+class BeforeQueryEvent extends Event
+{
+    /**
+     * @var array The params that will be sent to Elasticsearch.
+     */
+    public array $params = [];
+}
diff --git a/src/services/Elements.php b/src/services/Elements.php
index 648643d..a89c122 100644
--- a/src/services/Elements.php
+++ b/src/services/Elements.php
@@ -3,6 +3,7 @@
 namespace codemonauts\elastic\services;
 
 use codemonauts\elastic\Elastic;
+use codemonauts\elastic\events\BeforeQueryEvent;
 use craft\base\Component;
 use craft\base\ElementInterface;
 use craft\models\Site;
@@ -17,6 +18,11 @@
  */
 class Elements extends Component
 {
+    /**
+     * @event BeforeQueryEvent The event that is triggered before the query is sent to ELasticsearch.
+     */
+    public const EVENT_BEFORE_QUERY = 'beforeQuery';
+
     /**
      * Adds the keywords of an element to the Elasticsearch index of a site.
      *
@@ -158,6 +164,14 @@ public function search(SearchQuery $searchQuery, array $scope, Site $site)
             ];
         }
 
+        // Allow plugins to modify the query parameters
+        $event = new BeforeQueryEvent([
+            'params' => $params,
+        ]);
+        $this->trigger(self::EVENT_BEFORE_QUERY, $event);
+        $params = $event->params;
+
+
         return Elastic::$plugin->getElasticsearch()->getClient()->search($params);
     }