interface ImportPluginInterface in Search API Synonym 8

Provides an interface for search api synonym import plugins.

Hierarchy

• interface \Drupal\Core\Plugin\PluginFormInterface; interface \Drupal\Component\Plugin\ConfigurableInterface; interface \Drupal\Component\Plugin\DependentPluginInterface
  • interface \Drupal\search_api_synonym\Import\ImportPluginInterface

3 files declare their use of ImportPluginInterface

CSV.php in src/Plugin/search_api_synonym/import/CSV.php

JSON.php in src/Plugin/search_api_synonym/import/JSON.php

Solr.php in src/Plugin/search_api_synonym/import/Solr.php

File

src/Import/ImportPluginInterface.php, line 16

Namespace

Drupal\search_api_synonym\Import

interface ImportPluginInterface extends PluginFormInterface, ConfigurableInterface, DependentPluginInterface {

  /**
   * Parse the import file.
   *
   * @param \Drupal\file\Entity\File $file
   *   The temporary file object.
   * @param array $settings
   *   Array with plugin settings.
   *
   * @return string
   *   The parsed file content.
   */
  public function parseFile(File $file, array $settings = []);

  /**
   * Plugin configuration form.
   *
   * @param array $form
   *   Form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state array.
   *
   * @return array
   *   Form array.
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state);

  /**
   * Validate configuration form.
   *
   * @param array $form
   *   Form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state array.
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state);

  /**
   * Get a list of allowed file extensions.
   *
   * @return array
   *   List of allowed extensions.
   */
  public function allowedExtensions();

}

Members

Name	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
ImportPluginInterface::allowedExtensions	public	function	Get a list of allowed file extensions.	1
ImportPluginInterface::buildConfigurationForm	public	function	Plugin configuration form. Overrides PluginFormInterface::buildConfigurationForm	1
ImportPluginInterface::parseFile	public	function	Parse the import file.	1
ImportPluginInterface::validateConfigurationForm	public	function	Validate configuration form. Overrides PluginFormInterface::validateConfigurationForm	1
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32