public function Spreadsheet::getIds in Migrate Spreadsheet 8

Same name and namespace in other branches

2.0.x src/Plugin/migrate/source/Spreadsheet.php \Drupal\migrate_spreadsheet\Plugin\migrate\source\Spreadsheet::getIds()

Defines the source fields uniquely identifying a source row.

None of these fields should contain a NULL value. If necessary, use prepareRow() or hook_migrate_prepare_row() to rewrite NULL values to appropriate empty values (such as '' or 0).

Return value

array[] An associative array of field definitions keyed by field ID. Values are associative arrays with a structure that contains the field type ('type' key). The other keys are the field storage settings as they are returned by FieldStorageDefinitionInterface::getSettings().

Examples:

A composite source primary key that is defined by an integer and a string might look like this:

return [
  'id' => [
    'type' => 'integer',
    'unsigned' => FALSE,
    'size' => 'big',
  ],
  'version' => [
    'type' => 'string',
    'max_length' => 64,
    'is_ascii' => TRUE,
  ],
];

If 'type' points to a field plugin with multiple columns and needs to refer to a column different than 'value', the key of that column will be appended as a suffix to the plugin name, separated by dot ('.'). Example:

return [
  'format' => [
    'type' => 'text.format',
  ],
];

Additional custom keys/values that are not part of field storage definition can be added as shown below. The most common setting passed along to the ID definition is table 'alias', used by the SqlBase source plugin in order to distinguish between ambiguous column names - for example, when a SQL source query joins two tables with the same column names.

return [
  'nid' => [
    'type' => 'integer',
    'alias' => 'n',
  ],
];

Overrides MigrateSourceInterface::getIds

File

src/Plugin/migrate/source/Spreadsheet.php, line 129

Class

Spreadsheet: Provides a source plugin that migrate from spreadsheet files.

Namespace

Drupal\migrate_spreadsheet\Plugin\migrate\source

Code

public function getIds() {
  $config = $this
    ->getConfiguration();
  if (empty($config['keys'])) {
    if (empty($config['row_index_column'])) {
      throw new \RuntimeException("Row index should act as key but no name has been provided. Set 'row_index_column' in source config to provide a name for this column.");
    }

    // If no keys are defined, we'll use the 'zero based' index of the
    // spreadsheet current row.
    return [
      $config['row_index_column'] => [
        'type' => 'integer',
      ],
    ];
  }
  return $config['keys'];
}

You are here