www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/search_api_synonym/src/Export/ExportPluginInterface.php

   1 <?php
   2
   3 namespace Drupal\search_api_synonym\Export;
   4
   5 use Drupal\Core\Plugin\PluginFormInterface;
   6 use Drupal\Component\Plugin\ConfigurablePluginInterface;
   7
   8 /**
   9  * Provides an interface for search api synonym export plugins.
  10  *
  11  * @ingroup plugin_api
  12  */
  13 interface ExportPluginInterface extends PluginFormInterface, ConfigurablePluginInterface {
  14
  15   /**
  16    * Get synonyms in the export format.
  17    **
  18    * @param array $synonyms
  19    *   An array containing synonym objects.
  20    *
  21    * @return string
  22    *   The formatted synonyms as a string ready to be saved to an export file.
  23    */
  24   public function getFormattedSynonyms(array $synonyms);
  25
  26 }