class Table in Migrate Plus 8.3
Same name and namespace in other branches
- 8.5 src/Plugin/migrate/destination/Table.php \Drupal\migrate_plus\Plugin\migrate\destination\Table
- 8.4 src/Plugin/migrate/destination/Table.php \Drupal\migrate_plus\Plugin\migrate\destination\Table
Provides table destination plugin.
Use this plugin for a table not registered with Drupal Schema API.
Plugin annotation
@MigrateDestination(
id = "table"
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\migrate\Plugin\migrate\destination\DestinationBase implements MigrateDestinationInterface, RequirementsInterface
- class \Drupal\migrate_plus\Plugin\migrate\destination\Table implements ContainerFactoryPluginInterface
- class \Drupal\migrate\Plugin\migrate\destination\DestinationBase implements MigrateDestinationInterface, RequirementsInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of Table
File
- src/
Plugin/ migrate/ destination/ Table.php, line 24
Namespace
Drupal\migrate_plus\Plugin\migrate\destinationView source
class Table extends DestinationBase implements ContainerFactoryPluginInterface {
/**
* The name of the destination table.
*
* @var string
*/
protected $tableName;
/**
* IDMap compatible array of id fields.
*
* @var array
*/
protected $idFields;
/**
* Array of fields present on the destination table.
*
* @var array
*/
protected $fields;
/**
* The database connection.
*
* @var \Drupal\Core\Database\Connection
*/
protected $dbConnection;
public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, Connection $connection) {
parent::__construct($configuration, $plugin_id, $plugin_definition, $migration);
$this->dbConnection = $connection;
$this->tableName = $configuration['table_name'];
$this->idFields = $configuration['id_fields'];
$this->fields = isset($configuration['fields']) ? $configuration['fields'] : [];
$this->supportsRollback = TRUE;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration = NULL) {
$db_key = !empty($configuration['database_key']) ? $configuration['database_key'] : NULL;
return new static($configuration, $plugin_id, $plugin_definition, $migration, Database::getConnection('default', $db_key));
}
/**
* {@inheritdoc}
*/
public function getIds() {
if (empty($this->idFields)) {
throw new MigrateException('Id fields are required for a table destination');
}
return $this->idFields;
}
/**
* {@inheritdoc}
*/
public function fields(MigrationInterface $migration = NULL) {
return $this->fields;
}
/**
* {@inheritdoc}
*/
public function import(Row $row, array $old_destination_id_values = []) {
$id = $row
->getSourceIdValues();
if (count($id) != count($this->idFields)) {
throw new MigrateSkipProcessException('All the id fields are required for a table migration.');
}
$values = $row
->getDestination();
if ($this->fields) {
$values = array_intersect_key($values, $this->fields);
}
$status = $this->dbConnection
->merge($this->tableName)
->key($id)
->fields($values)
->execute();
return $status ? $id : NULL;
}
/**
* {@inheritdoc}
*/
public function rollback(array $destination_identifier) {
$delete = $this->dbConnection
->delete($this->tableName);
foreach ($destination_identifier as $field => $value) {
$delete
->condition($field, $value);
}
$delete
->execute();
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
DestinationBase:: |
protected | property | The migration. | |
DestinationBase:: |
protected | property | The rollback action to be saved for the last imported item. | |
DestinationBase:: |
protected | property | Indicates whether the destination can be rolled back. | |
DestinationBase:: |
public | function |
Checks if requirements for this plugin are OK. Overrides RequirementsInterface:: |
|
DestinationBase:: |
public | function |
Gets the destination module handling the destination data. Overrides MigrateDestinationInterface:: |
1 |
DestinationBase:: |
public | function |
The rollback action for the last imported item. Overrides MigrateDestinationInterface:: |
|
DestinationBase:: |
protected | function | For a destination item being updated, set the appropriate rollback action. | |
DestinationBase:: |
public | function |
Whether the destination can be rolled back or not. Overrides MigrateDestinationInterface:: |
|
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
Table:: |
protected | property | The database connection. | |
Table:: |
protected | property | Array of fields present on the destination table. | |
Table:: |
protected | property | IDMap compatible array of id fields. | |
Table:: |
protected | property | The name of the destination table. | |
Table:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
|
Table:: |
public | function |
Returns an array of destination fields. Overrides MigrateDestinationInterface:: |
|
Table:: |
public | function |
Gets the destination IDs. Overrides MigrateDestinationInterface:: |
|
Table:: |
public | function |
Import the row. Overrides MigrateDestinationInterface:: |
|
Table:: |
public | function |
Delete the specified destination object from the target Drupal. Overrides DestinationBase:: |
|
Table:: |
public | function |
Constructs an entity destination plugin. Overrides DestinationBase:: |