Version 1
[yaffs-website] / web / core / modules / search / src / Plugin / ConfigurableSearchPluginBase.php
diff --git a/web/core/modules/search/src/Plugin/ConfigurableSearchPluginBase.php b/web/core/modules/search/src/Plugin/ConfigurableSearchPluginBase.php
new file mode 100644 (file)
index 0000000..50a44db
--- /dev/null
@@ -0,0 +1,71 @@
+<?php
+
+namespace Drupal\search\Plugin;
+
+use Drupal\Component\Utility\NestedArray;
+use Drupal\Core\Form\FormStateInterface;
+
+/**
+ * Provides a base implementation for a configurable Search plugin.
+ */
+abstract class ConfigurableSearchPluginBase extends SearchPluginBase implements ConfigurableSearchPluginInterface {
+
+  /**
+   * The unique ID for the search page using this plugin.
+   *
+   * @var string
+   */
+  protected $searchPageId;
+
+  /**
+   * {@inheritdoc}
+   */
+  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
+    parent::__construct($configuration, $plugin_id, $plugin_definition);
+
+    $this->configuration = NestedArray::mergeDeep($this->defaultConfiguration(), $this->configuration);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function defaultConfiguration() {
+    return [];
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getConfiguration() {
+    return $this->configuration;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function setConfiguration(array $configuration) {
+    $this->configuration = $configuration;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function calculateDependencies() {
+    return [];
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function setSearchPageId($search_page_id) {
+    $this->searchPageId = $search_page_id;
+    return $this;
+  }
+
+}