Newer
Older
Dries Buytaert
committed
<?php
namespace Drupal\migrate\Plugin\migrate\destination;
use Drupal\Core\Plugin\PluginBase;
use Drupal\migrate\Plugin\MigrationInterface;
use Drupal\migrate\Exception\RequirementsException;
Dries Buytaert
committed
use Drupal\migrate\Plugin\MigrateDestinationInterface;
Angie Byron
committed
use Drupal\migrate\Plugin\MigrateIdMapInterface;
Dries Buytaert
committed
use Drupal\migrate\Plugin\RequirementsInterface;
Dries Buytaert
committed
Jennifer Hodgdon
committed
/**
* Base class for migrate destination classes.
*
* @see \Drupal\migrate\Plugin\MigrateDestinationInterface
* @see \Drupal\migrate\Plugin\MigrateDestinationPluginManager
* @see \Drupal\migrate\Annotation\MigrateDestination
* @see plugin_api
Angie Byron
committed
*
* @ingroup migration
Jennifer Hodgdon
committed
*/
Dries Buytaert
committed
abstract class DestinationBase extends PluginBase implements MigrateDestinationInterface, RequirementsInterface {
Angie Byron
committed
/**
* Indicates whether the destination can be rolled back.
*
* @var bool
*/
protected $supportsRollback = FALSE;
Angie Byron
committed
/**
* The rollback action to be saved for the last imported item.
*
* @var int
*/
protected $rollbackAction = MigrateIdMapInterface::ROLLBACK_DELETE;
Dries Buytaert
committed
/**
* The migration.
*
* @var \Drupal\migrate\Plugin\MigrationInterface
Dries Buytaert
committed
*/
protected $migration;
/**
* Constructs an entity destination plugin.
*
* @param array $configuration
* A configuration array containing information about the plugin instance.
* @param string $plugin_id
* The plugin_id for the plugin instance.
* @param mixed $plugin_definition
Dries Buytaert
committed
* The plugin implementation definition.
* @param \Drupal\migrate\Plugin\MigrationInterface $migration
Dries Buytaert
committed
* The migration.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration) {
Dries Buytaert
committed
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->migration = $migration;
}
Angie Byron
committed
/**
* {@inheritdoc}
*/
public function rollbackAction() {
return $this->rollbackAction;
}
Dries Buytaert
committed
/**
* {@inheritdoc}
*/
public function checkRequirements() {
if (empty($this->pluginDefinition['requirements_met'])) {
throw new RequirementsException();
}
Dries Buytaert
committed
}
Dries Buytaert
committed
Dries Buytaert
committed
/**
* {@inheritdoc}
*/
Angie Byron
committed
public function rollback(array $destination_identifier) {
Dries Buytaert
committed
// By default we do nothing.
Dries Buytaert
committed
}
Angie Byron
committed
/**
* {@inheritdoc}
*/
public function supportsRollback() {
return $this->supportsRollback;
}
Angie Byron
committed
/**
* For a destination item being updated, set the appropriate rollback action.
*
* @param array $id_map
* The map row data for the item.
* @param int $update_action
* The rollback action to take if we are updating an existing item.
Angie Byron
committed
*/
protected function setRollbackAction(array $id_map, $update_action = MigrateIdMapInterface::ROLLBACK_PRESERVE) {
Angie Byron
committed
// If the entity we're updating was previously migrated by us, preserve the
// existing rollback action.
if (isset($id_map['sourceid1'])) {
$this->rollbackAction = $id_map['rollback_action'];
}
// Otherwise, we're updating an entity which already existed on the
// destination and want to make sure we do not delete it on rollback.
else {
$this->rollbackAction = $update_action;
Angie Byron
committed
}
}