class CSV in Search API Synonym 8

Import of CSV files.

Plugin annotation


@SearchApiSynonymImport(
  id = "csv",
  label = @Translation("CSV"),
  description = @Translation("Synonym import plugin from CSV / delimited file.")
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\search_api_synonym\Import\ImportPluginBase implements ContainerFactoryPluginInterface, ImportPluginInterface
    class \Drupal\search_api_synonym\Plugin\search_api_synonym\import\CSV implements ImportPluginInterface

Expanded class hierarchy of CSV

File

src/Plugin/search_api_synonym/import/CSV.php, line 21

Namespace

Drupal\search_api_synonym\Plugin\search_api_synonym\import

View source

class CSV extends ImportPluginBase implements ImportPluginInterface {

  /**
   * {@inheritdoc}
   */
  public function parseFile(File $file, array $settings = []) {
    $data = [];
    $delimiter = $settings['delimiter'];
    $enclosure = $settings['enclosure'];
    $header_row = $settings['header_row'];
    $i = 1;
    if (($handle = fopen($file
      ->getFileUri(), 'r')) !== FALSE) {
      while (($row = fgetcsv($handle, 1000, $delimiter, $enclosure)) !== FALSE) {
        if ($header_row && $i++ == 1) {
          continue;
        }
        if (!empty($row[0]) && !empty($row[1])) {
          $data[] = [
            'word' => $row[0],
            'synonym' => $row['1'],
            'type' => !empty($row['2']) ? $row['2'] : '',
          ];
        }
      }
      fclose($handle);
    }
    return $data;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $example_url = 'internal:' . base_path() . drupal_get_path('module', 'search_api_synonym') . '/examples/example.csv';
    $form['template'] = [
      '#type' => 'item',
      '#title' => $this
        ->t('Example'),
      '#markup' => Link::fromTextAndUrl(t('Download example file'), Url::fromUri($example_url))
        ->toString(),
    ];
    $form['delimiter'] = [
      '#type' => 'select',
      '#title' => t('Delimiter'),
      '#description' => t('Field delimiter character used in the import file.'),
      '#options' => [
        ';' => $this
          ->t('Semicolon'),
        ',' => $this
          ->t('Comma'),
        '\\t' => $this
          ->t('Tab'),
        '|' => $this
          ->t('Pipe'),
      ],
      '#default_value' => ';',
      '#required' => TRUE,
    ];
    $form['enclosure'] = [
      '#type' => 'select',
      '#title' => t('Text qualifier'),
      '#description' => t('Field enclosure character used in import file.'),
      '#options' => [
        '"' => '"',
        "'" => "'",
        '' => $this
          ->t('None'),
      ],
      '#default_value' => '"',
    ];
    $form['header_row'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Header row'),
      '#description' => $this
        ->t('Does the file contain a header row that should be skipped in the import?'),
      '#default_value' => FALSE,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
  }

  /**
   * {@inheritdoc}
   */
  public function allowedExtensions() {
    return [
      'csv txt',
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CSV::allowedExtensions	public	function	Get a list of allowed file extensions. Overrides ImportPluginBase::allowedExtensions
CSV::buildConfigurationForm	public	function	Plugin configuration form. Overrides ImportPluginBase::buildConfigurationForm
CSV::parseFile	public	function	Parse the import file. Overrides ImportPluginBase::parseFile
CSV::validateConfigurationForm	public	function	Validate configuration form. Overrides ImportPluginBase::validateConfigurationForm
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
ImportPluginBase::$configFactory	protected	property	Config factory service.
ImportPluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ImportPluginBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ImportPluginBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
ImportPluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ImportPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ImportPluginBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
ImportPluginBase::__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.
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.

You are here

class CSV in Search API Synonym 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation