class DestinationBase

Same name in other branches
  1. 9 core/modules/migrate/src/Plugin/migrate/destination/DestinationBase.php \Drupal\migrate\Plugin\migrate\destination\DestinationBase
  2. 8.9.x core/modules/migrate/src/Plugin/migrate/destination/DestinationBase.php \Drupal\migrate\Plugin\migrate\destination\DestinationBase
  3. 10 core/modules/migrate/src/Plugin/migrate/destination/DestinationBase.php \Drupal\migrate\Plugin\migrate\destination\DestinationBase

Base class for migrate destination classes.

Migrate destination plugins perform the import operation of the migration. Destination plugins extend this abstract base class. A destination plugin must implement at least fields(), getIds() and import() methods. Destination plugins can also support rollback operations. For more information, refer to \Drupal\migrate\Plugin\MigrateDestinationInterface.

Hierarchy

Expanded class hierarchy of DestinationBase

See also

\Drupal\migrate\Plugin\MigrateDestinationPluginManager

\Drupal\migrate\Attribute\MigrateDestination

Plugin API

Related topics

6 files declare their use of DestinationBase
BlockedIp.php in core/modules/ban/src/Plugin/migrate/destination/BlockedIp.php
DummyDestination.php in core/modules/migrate/tests/modules/migrate_events_test/src/Plugin/migrate/destination/DummyDestination.php
NodeCounter.php in core/modules/statistics/src/Plugin/migrate/destination/NodeCounter.php
ShortcutSetUsers.php in core/modules/shortcut/src/Plugin/migrate/destination/ShortcutSetUsers.php
ThemeSettings.php in core/modules/system/src/Plugin/migrate/destination/d7/ThemeSettings.php

... See full list

File

core/modules/migrate/src/Plugin/migrate/destination/DestinationBase.php, line 29

Namespace

Drupal\migrate\Plugin\migrate\destination
View source
abstract class DestinationBase extends PluginBase implements MigrateDestinationInterface, RequirementsInterface {
    
    /**
     * Indicates whether the destination can be rolled back.
     *
     * @var bool
     */
    protected $supportsRollback = FALSE;
    
    /**
     * The rollback action to be saved for the last imported item.
     *
     * @var int
     */
    protected $rollbackAction = MigrateIdMapInterface::ROLLBACK_DELETE;
    
    /**
     * The migration.
     *
     * @var \Drupal\migrate\Plugin\MigrationInterface
     */
    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
     *   The plugin implementation definition.
     * @param \Drupal\migrate\Plugin\MigrationInterface $migration
     *   The migration.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->migration = $migration;
    }
    
    /**
     * {@inheritdoc}
     */
    public function rollbackAction() {
        return $this->rollbackAction;
    }
    
    /**
     * {@inheritdoc}
     */
    public function checkRequirements() {
        if (empty($this->pluginDefinition['requirements_met'])) {
            throw new RequirementsException(sprintf("Destination plugin '%s' did not meet the requirements", $this->pluginId));
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function rollback(array $destination_identifier) {
        // By default we do nothing.
    }
    
    /**
     * {@inheritdoc}
     */
    public function supportsRollback() {
        return $this->supportsRollback;
    }
    
    /**
     * 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.
     */
    protected function setRollbackAction(array $id_map, $update_action = MigrateIdMapInterface::ROLLBACK_PRESERVE) {
        // 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'];
        }
        else {
            $this->rollbackAction = $update_action;
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDestinationModule() {
        if (!empty($this->configuration['destination_module'])) {
            return $this->configuration['destination_module'];
        }
        if (!empty($this->pluginDefinition['destination_module'])) {
            return $this->pluginDefinition['destination_module'];
        }
        if (is_string($this->migration->provider)) {
            return $this->migration->provider;
        }
        else {
            return reset($this->migration->provider);
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DestinationBase::$migration protected property The migration.
DestinationBase::$rollbackAction protected property The rollback action to be saved for the last imported item.
DestinationBase::$supportsRollback protected property Indicates whether the destination can be rolled back.
DestinationBase::checkRequirements public function Overrides RequirementsInterface::checkRequirements
DestinationBase::getDestinationModule public function Overrides MigrateDestinationInterface::getDestinationModule 1
DestinationBase::rollback public function Overrides MigrateDestinationInterface::rollback 2
DestinationBase::rollbackAction public function Overrides MigrateDestinationInterface::rollbackAction
DestinationBase::setRollbackAction protected function For a destination item being updated, set the appropriate rollback action.
DestinationBase::supportsRollback public function Overrides MigrateDestinationInterface::supportsRollback
DestinationBase::__construct public function Constructs an entity destination plugin. 8
MigrateDestinationInterface::fields public function Returns an array of destination fields. 10
MigrateDestinationInterface::getIds public function Gets the destination IDs. 11
MigrateDestinationInterface::import public function Import the row. 11
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.