You are here

interface ExportPluginInterface in Search API Synonym 8

Provides an interface for search api synonym export plugins.

Hierarchy

Expanded class hierarchy of ExportPluginInterface

All classes that implement ExportPluginInterface

1 file declares its use of ExportPluginInterface
Solr.php in src/Plugin/search_api_synonym/export/Solr.php

File

src/Export/ExportPluginInterface.php, line 14

Namespace

Drupal\search_api_synonym\Export
View source
interface ExportPluginInterface extends PluginFormInterface, ConfigurableInterface, DependentPluginInterface {

  /**
   * 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);

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigurableInterface::defaultConfiguration public function Gets default configuration for this plugin. 11
ConfigurableInterface::getConfiguration public function Gets this plugin's configuration. 12
ConfigurableInterface::setConfiguration public function Sets the configuration for this plugin instance. 12
DependentPluginInterface::calculateDependencies public function Calculates dependencies for the configured plugin. 19
ExportPluginInterface::getFormattedSynonyms public function Get synonyms in the export format. * 1
PluginFormInterface::buildConfigurationForm public function Form constructor. 36
PluginFormInterface::submitConfigurationForm public function Form submission handler. 32
PluginFormInterface::validateConfigurationForm public function Form validation handler. 18