public function BlockedIp::getIds in Drupal 9

Same name and namespace in other branches

8 core/modules/ban/src/Plugin/migrate/destination/BlockedIp.php \Drupal\ban\Plugin\migrate\destination\BlockedIp::getIds()
10 core/modules/ban/src/Plugin/migrate/destination/BlockedIp.php \Drupal\ban\Plugin\migrate\destination\BlockedIp::getIds()

Gets the destination IDs.

To support MigrateIdMap maps, derived destination classes should return field definition(s) corresponding to the primary key of the destination being implemented. These are used to construct the destination key fields of the map table for a migration using this destination.

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(). As an example, for a composite destination primary key that is defined by an integer and a string, the returned value might look like:

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 passed in definitions:

return [
  'nid' => [
    'type' => 'integer',
    'custom_setting' => 'some_value',
  ],
];

Overrides MigrateDestinationInterface::getIds

File

core/modules/ban/src/Plugin/migrate/destination/BlockedIp.php, line 63

Class

BlockedIp: Destination for blocked IP addresses.

Namespace

Drupal\ban\Plugin\migrate\destination

Code

public function getIds() {
  return [
    'ip' => [
      'type' => 'string',
    ],
  ];
}

You are here