You are here

Home » API reference » Migrate Source CSV 8.2 » CSV.php

class CSV in Migrate Source CSV 8.2

Same name and namespace in other branches
  1. 8.3 src/Plugin/migrate/source/CSV.php \Drupal\migrate_source_csv\Plugin\migrate\source\CSV
  2. 8 src/Plugin/migrate/source/CSV.php \Drupal\migrate_source_csv\Plugin\migrate\source\CSV

Source for CSV.

If the CSV file contains non-ASCII characters, make sure it includes a UTF BOM (Byte Order Marker) so they are interpreted correctly.

Plugin annotation


@MigrateSource(
  id = "csv"
)

Hierarchy

Expanded class hierarchy of CSV

2 files declare their use of CSV
CSVUnitTest.php in tests/src/Unit/Plugin/migrate/source/CSVUnitTest.php
YieldRows.php in tests/modules/source_plugin_yield_test/src/Plugin/migrate/source/YieldRows.php
2 string references to 'CSV'
migrate_plus.migration.migrate_csv.yml in tests/modules/migrate_source_csv_test/config/optional/migrate_plus.migration.migrate_csv.yml
tests/modules/migrate_source_csv_test/config/optional/migrate_plus.migration.migrate_csv.yml
migrate_source_csv.source.schema.yml in config/schema/migrate_source_csv.source.schema.yml
config/schema/migrate_source_csv.source.schema.yml

File

src/Plugin/migrate/source/CSV.php, line 22

Namespace

Drupal\migrate_source_csv\Plugin\migrate\source
View source 
class CSV extends SourcePluginBase implements ConfigurablePluginInterface {

  /**
   * List of available source fields.
   *
   * Keys are the field machine names as used in field mappings, values are
   * descriptions.
   *
   * @var array
   */
  protected $fields = [];

  /**
   * List of key fields, as indexes.
   *
   * @var array
   */
  protected $keys = [];

  /**
   * The file class to read the file.
   *
   * @var string
   */
  protected $fileClass = '';

  /**
   * The file object that reads the CSV file.
   *
   * @var \SplFileObject
   */
  protected $file = NULL;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $migration);
    $this
      ->setConfiguration($configuration);

    // Path is required.
    if (empty($this
      ->getConfiguration()['path'])) {
      throw new MigrateException('You must declare the "path" to the source CSV file in your source settings.');
    }

    // Key field(s) are required.
    if (empty($this
      ->getConfiguration()['keys'])) {
      throw new MigrateException('You must declare "keys" as a unique array of fields in your source settings.');
    }
    $this->fileClass = $this
      ->getConfiguration()['file_class'];
  }

  /**
   * Return a string representing the source file path.
   *
   * @return string
   *   The file path.
   */
  public function __toString() {
    return $this
      ->getConfiguration()['path'];
  }

  /**
   * {@inheritdoc}
   */
  public function initializeIterator() {
    if (!file_exists($this
      ->getConfiguration()['path'])) {
      throw new InvalidPluginDefinitionException($this
        ->getPluginId(), sprintf('File path (%s) does not exist.', $this
        ->getConfiguration()['path']));
    }

    // File handler using header-rows-respecting extension of SPLFileObject.
    $this->file = new $this->fileClass($this
      ->getConfiguration()['path']);
    return $this
      ->setupFile();
  }

  /**
   * Setup the file.
   *
   * @return \SplFileObject
   *   Returns the file object.
   */
  protected function setupFile() {

    // Set basics of CSV behavior based on configuration.
    $delimiter = $this
      ->getConfiguration()['delimiter'];
    $enclosure = $this
      ->getConfiguration()['enclosure'];
    $escape = $this
      ->getConfiguration()['escape'];
    $this->file
      ->setCsvControl($delimiter, $enclosure, $escape);
    $this->file
      ->setFlags($this
      ->getConfiguration()['file_flags']);

    // Figure out what CSV column(s) to use. Use either the header row(s) or
    // explicitly provided column name(s).
    if ($this
      ->getConfiguration()['header_row_count']) {
      $this->file
        ->setHeaderRowCount($this
        ->getConfiguration()['header_row_count']);

      // Find the last header line.
      $this->file
        ->rewind();
      $this->file
        ->seek($this->file
        ->getHeaderRowCount() - 1);
      $row = $this->file
        ->current();
      foreach ($row as $header) {
        $header = trim($header);
        $column_names[] = [
          $header => $header,
        ];
      }
      $this->file
        ->setColumnNames($column_names);
    }

    // An explicit list of column name(s) will override any header row(s).
    if ($this
      ->getConfiguration()['column_names']) {
      $this->file
        ->setColumnNames($this
        ->getConfiguration()['column_names']);
    }
    return $this->file;
  }

  /**
   * {@inheritdoc}
   */
  public function getIds() {
    $ids = [];
    foreach ($this
      ->getConfiguration()['keys'] as $delta => $value) {
      if (is_array($value)) {
        $ids[$delta] = $value;
      }
      else {
        $ids[$value]['type'] = 'string';
      }
    }
    return $ids;
  }

  /**
   * {@inheritdoc}
   */
  public function fields() {
    $fields = [];
    if (!$this->file) {
      $this
        ->initializeIterator();
    }
    foreach ($this->file
      ->getColumnNames() as $column) {
      $fields[key($column)] = reset($column);
    }

    // Any caller-specified fields with the same names as extracted fields will
    // override them; any others will be added.
    $fields = $this
      ->getConfiguration()['fields'] + $fields;
    return $fields;
  }

  /**
   * {@inheritdoc}
   */
  public function getConfiguration() {
    return $this->configuration;
  }

  /**
   * Gets the file object.
   *
   * @return \SplFileObject
   *   The file object.
   */
  public function getFile() {
    return $this->file;
  }

  /**
   * {@inheritdoc}
   */
  public function setConfiguration(array $configuration) {

    // We must preserve integer keys for column_name mapping.
    $this->configuration = NestedArray::mergeDeepArray([
      $this
        ->defaultConfiguration(),
      $configuration,
    ], TRUE);
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'fields' => [],
      'keys' => [],
      'column_names' => [],
      'header_row_count' => 0,
      'file_flags' => \SplFileObject::READ_CSV | \SplFileObject::READ_AHEAD | \SplFileObject::DROP_NEW_LINE | \SplFileObject::SKIP_EMPTY,
      'delimiter' => ',',
      'enclosure' => '"',
      'escape' => '\\',
      'path' => '',
      'file_class' => 'Drupal\\migrate_source_csv\\CSVFileObject',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    return [];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CSV::$fields protected property List of available source fields.
CSV::$file protected property The file object that reads the CSV file.
CSV::$fileClass protected property The file class to read the file.
CSV::$keys protected property List of key fields, as indexes.
CSV::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
CSV::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurablePluginInterface::defaultConfiguration
CSV::fields public function Returns available fields on the source. Overrides MigrateSourceInterface::fields
CSV::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurablePluginInterface::getConfiguration
CSV::getFile public function Gets the file object.
CSV::getIds public function Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface::getIds
CSV::initializeIterator public function Initializes the iterator with the source data. Overrides SourcePluginBase::initializeIterator 1
CSV::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurablePluginInterface::setConfiguration
CSV::setupFile protected function Setup the file.
CSV::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides SourcePluginBase::__construct
CSV::__toString public function Return a string representing the source file path. Overrides MigrateSourceInterface::__toString
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
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.
SourcePluginBase::$cache protected property The backend cache.
SourcePluginBase::$cacheCounts protected property Whether this instance should cache the source count. 1
SourcePluginBase::$cacheKey protected property Key to use for caching counts.
SourcePluginBase::$currentRow protected property The current row from the query.
SourcePluginBase::$currentSourceIds protected property The primary key of the current row.
SourcePluginBase::$highWaterProperty protected property Information on the property used as the high-water mark.
SourcePluginBase::$highWaterStorage protected property The key-value storage for the high-water value.
SourcePluginBase::$idMap protected property The migration ID map.
SourcePluginBase::$iterator protected property The iterator to iterate over the source rows.
SourcePluginBase::$mapRowAdded protected property Flags whether source plugin will read the map row and add to data row.
SourcePluginBase::$migration protected property The entity migration object.
SourcePluginBase::$moduleHandler protected property The module handler service. 2
SourcePluginBase::$originalHighWater protected property The high water mark at the beginning of the import operation.
SourcePluginBase::$skipCount protected property Whether this instance should not attempt to count the source. 1
SourcePluginBase::$trackChanges protected property Flags whether to track changes to incoming data. 1
SourcePluginBase::aboveHighwater protected function Check if the incoming data is newer than what we've previously imported.
SourcePluginBase::count public function Gets the source count. 4
SourcePluginBase::current public function
SourcePluginBase::doCount protected function Gets the source count checking if the source is countable or using the iterator_count function. 1
SourcePluginBase::fetchNextRow protected function Position the iterator to the following row. 1
SourcePluginBase::getCache protected function Gets the cache object.
SourcePluginBase::getCurrentIds public function Gets the currentSourceIds data member.
SourcePluginBase::getHighWater protected function The current value of the high water mark.
SourcePluginBase::getHighWaterField protected function Get the name of the field used as the high watermark.
SourcePluginBase::getHighWaterProperty protected function Get information on the property used as the high watermark.
SourcePluginBase::getHighWaterStorage protected function Get the high water storage object. 1
SourcePluginBase::getIterator protected function Returns the iterator that will yield the row arrays to be processed.
SourcePluginBase::getModuleHandler protected function Gets the module handler.
SourcePluginBase::getSourceModule public function Gets the source module providing the source data. Overrides MigrateSourceInterface::getSourceModule
SourcePluginBase::key public function Gets the iterator key.
SourcePluginBase::next public function The migration iterates over rows returned by the source plugin. This method determines the next row which will be processed and imported into the system.
SourcePluginBase::postRollback public function Performs post-rollback tasks. Overrides RollbackAwareInterface::postRollback
SourcePluginBase::prepareRow public function Adds additional data to the row. Overrides MigrateSourceInterface::prepareRow 50
SourcePluginBase::preRollback public function Performs pre-rollback tasks. Overrides RollbackAwareInterface::preRollback
SourcePluginBase::rewind public function Rewinds the iterator.
SourcePluginBase::rowChanged protected function Checks if the incoming row has changed since our last import.
SourcePluginBase::saveHighWater protected function Save the new high water mark.
SourcePluginBase::valid public function Checks whether the iterator is currently valid.
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.