class Solr in Search API Synonym 8

Provides a synonym export plugin for Apache Solr..

Plugin annotation

@SearchApiSynonymExport(
  id = "solr",
  label = @Translation("Solr"),
  description = @Translation("Synonym export plugin for Apache Solr")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\search_api_synonym\Export\ExportPluginBase implements ContainerFactoryPluginInterface, ExportPluginInterface
      • class \Drupal\search_api_synonym\Plugin\search_api_synonym\export\Solr implements ExportPluginInterface

File

src/Plugin/search_api_synonym/export/Solr.php, line 17

Namespace

Drupal\search_api_synonym\Plugin\search_api_synonym\export

class Solr extends ExportPluginBase implements ExportPluginInterface {

  /**
   * {@inheritdoc}
   */
  public function getFormattedSynonyms(array $synonyms) {
    $lines = [];
    $lines[] = "#";
    $lines[] = "# Synonyms file for Apache Solr generated by Search API Synonym.";
    $lines[] = "# See file https://www.drupal.org/project/search_api_synonym.";
    $lines[] = "#";
    $lines[] = "";

    // Generate a line for each synonym.
    foreach ($synonyms as $synonym) {
      $lines[] = $this
        ->generateLine($synonym->word, $synonym->synonyms, $synonym->type);
    }
    return implode("\n", $lines);
  }

  /**
   * Generate a single synonyms line for the export file.
   *
   * @param string $word
   *   The main word.
   *
   * @param string $synonyms
   *   The comma separated string with synonyms.
   *
   * @param string $type
   *   Synonym (synonym) og Spelling error (spelling_error)
   *
   * @return string
   *   Return the single line with synonyms and the corresponding word.
   */
  private function generateLine($word, $synonyms, $type) {
    $line = '';
    switch ($type) {
      case 'synonym':

        // We force using of equivalent mappings for type = synonym.
        $line = "{$word}, {$synonyms}";
        break;
      case 'spelling_error':
        $line = "{$word} => {$synonyms}";
        break;
    }
    return $line;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
ExportPluginBase::$configFactory	protected	property	Config factory service.
ExportPluginBase::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm
ExportPluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ExportPluginBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ExportPluginBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
ExportPluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ExportPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ExportPluginBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
ExportPluginBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
ExportPluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
Solr::generateLine	private	function	Generate a single synonyms line for the export file.
Solr::getFormattedSynonyms	public	function	Get synonyms in the export format. * Overrides ExportPluginInterface::getFormattedSynonyms
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.