interface TextExtractorPluginInterface in Search API attachments 9.0.x

Provides an interface for a plugin that extracts files content.

Hierarchy

• interface \Drupal\Core\Plugin\PluginFormInterface; interface \Drupal\Component\Plugin\ConfigurableInterface
  • interface \Drupal\search_api_attachments\TextExtractorPluginInterface

1 file declares its use of TextExtractorPluginInterface

FilesExtractor.php in src/Plugin/search_api/processor/FilesExtractor.php

File

src/TextExtractorPluginInterface.php, line 14

Namespace

Drupal\search_api_attachments

interface TextExtractorPluginInterface extends PluginFormInterface, ConfigurableInterface {

  /**
   * Extract method.
   *
   * @param \Drupal\file\Entity\File $file
   *   The file object.
   *
   * @return string
   *   The file extracted content.
   */
  public function extract(File $file);

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	14
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	15
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	15
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	37
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	18
TextExtractorPluginInterface::extract	public	function	Extract method.	1