Added the Search API Synonym module to deal specifically with licence and license...

[yaffs-website] / web / modules / contrib / search_api_synonym / src / Export / ExportPluginInterface.php

diff --git a/web/modules/contrib/search_api_synonym/src/Export/ExportPluginInterface.php b/web/modules/contrib/search_api_synonym/src/Export/ExportPluginInterface.php
new file mode 100644 (file)
index 0000000..8e685eb
--- /dev/null
+++ b/web/modules/contrib/search_api_synonym/src/Export/ExportPluginInterface.php
@@ -0,0 +1,26 @@
+<?php
+
+namespace Drupal\search_api_synonym\Export;
+
+use Drupal\Core\Plugin\PluginFormInterface;
+use Drupal\Component\Plugin\ConfigurablePluginInterface;
+
+/**
+ * Provides an interface for search api synonym export plugins.
+ *
+ * @ingroup plugin_api
+ */
+interface ExportPluginInterface extends PluginFormInterface, ConfigurablePluginInterface {
+
+  /**
+   * Get synonyms in the export format.
+   **
+   * @param array $synonyms
+   *   An array containing synonym objects.
+   *
+   * @return string
+   *   The formatted synonyms as a string ready to be saved to an export file.
+   */
+  public function getFormattedSynonyms(array $synonyms);
+
+}