Add active statuses config option with default values

Author: johnnynotsolucky

src/Plugin.php

@@ -7,7 +7,6 @@
 use craft\base\Model;
 use craft\base\Plugin as BasePlugin;
 use craft\elements\db\ElementQuery;
-use craft\elements\Entry;
 use craft\events\ModelEvent;
 use craft\helpers\ElementHelper;
 use craft\helpers\Queue;
@@ -80,40 +79,24 @@ static function (ModelEvent $event) use ($autoSyncIndices): void {
 						return;
 					}
 
-					$status = $sender->getStatus();
-
-					// Determine which status to use to check if the element is active.
-					if ($sender instanceof Entry) {
-						$activeStatus = Entry::STATUS_LIVE;
-					} else {
-						$activeStatus = Element::STATUS_ENABLED;
-					}
-
-					if ($status === $activeStatus) {
-						// If an element is active, then we should update it in the index
-						$autoSyncIndices->each(static function (Index $index) use ($sender): void {
-							/** @var ElementQuery<array-key, Element> $query */
-							$query = $index->query;
+					$autoSyncIndices->each(static function (Index $index) use ($sender): void {
+						/** @var ElementQuery<array-key, Element> $query */
+						$query = $index->query;
+						if (in_array($sender->getStatus(), $index->activeStatuses, true)) {
+							// If an element is active, then we should update it in the index
 							if ($query->id($sender->id)->exists()) {
 								Queue::push(new SyncJob([
 									'indexName' => $index->handle,
 									'identifier' => $sender->id,
 								]));
 							}
-						});
-					} else {
-						// Otherwise, we should make sure that it is not in the index
-						$autoSyncIndices->each(static function (Index $index) use ($sender): void {
-							/** @var ElementQuery<array-key, Element> $query */
-							$query = $index->query;
-							if ($query->status(null)->id($sender->id)->exists()) {
-								Queue::push(new DeleteJob([
-									'indexName' => $index->handle,
-									'identifier' => $sender->id,
-								]));
-							}
-						});
-					}
+						} elseif ($query->status(null)->id($sender->id)->exists()) {
+							Queue::push(new DeleteJob([
+			'indexName' => $index->handle,
+								'identifier' => $sender->id,
+		]));
+						}
+					});
 				}
 			);
 

src/builders/IndexBuilder.php

@@ -2,8 +2,10 @@
 
 namespace fostercommerce\meilisearch\builders;
 
+use craft\base\Element;
 use craft\elements\db\ElementQuery;
 use craft\elements\db\ElementQueryInterface;
+use craft\elements\Entry;
 use fostercommerce\meilisearch\helpers\Fetch;
 
 class IndexBuilder
@@ -21,6 +23,11 @@ class IndexBuilder
 
 	private bool $autoSync = true;
 
+	/**
+	 * @var string[]
+	 */
+	private array $activeStatuses = [Element::STATUS_ENABLED, Entry::STATUS_LIVE];
+
 	/**
 	 * @var ?callable
 	 */
@@ -90,6 +97,15 @@ public function withAutoSync(bool $enabled = true): self
 		return $this;
 	}
 
+	/**
+	 * @param string[] $statuses
+	 */
+	public function withActiveStatuses(array $statuses = [Element::STATUS_ENABLED, Entry::STATUS_LIVE]): self
+	{
+		$this->activeStatuses = $statuses;
+		return $this;
+	}
+
 	/**
 	 * Set the callable that is used by the plugin when reporting progress on synchronization tasks.
 	 *
@@ -154,6 +170,7 @@ public function build(): array
 			'pageSize' => $this->pageSize,
 			'query' => $this->query,
 			'autoSync' => $this->autoSync,
+			'activeStatuses' => $this->activeStatuses,
 			'pages' => $this->pagesFn,
 			'fetch' => $this->fetchFn,
 		];

src/models/Index.php

@@ -2,9 +2,11 @@
 
 namespace fostercommerce\meilisearch\models;
 
+use craft\base\Element;
 use craft\base\Model;
 use craft\elements\db\ElementQuery;
 use craft\elements\db\ElementQueryInterface;
+use craft\elements\Entry;
 use Generator;
 
 /**
@@ -48,6 +50,13 @@ class Index extends Model
 	 */
 	public bool $autoSync = true;
 
+	/**
+	 * Statuses to use during auto-sync to check whether an element is active or not.
+	 *
+	 * @var string[]
+	 */
+	public array $activeStatuses = [Element::STATUS_ENABLED, Entry::STATUS_LIVE];
+
 	/**
 	 * An optional callable that is used by the plugin when reporting progress on synchronization tasks.
 	 *