class UserData

Same name in this branch
  1. 11.x core/modules/user/src/Plugin/views/field/UserData.php \Drupal\user\Plugin\views\field\UserData
  2. 11.x core/modules/user/src/UserData.php \Drupal\user\UserData
Same name and namespace in other branches
  1. 9 core/modules/user/src/Plugin/views/field/UserData.php \Drupal\user\Plugin\views\field\UserData
  2. 9 core/modules/user/src/Plugin/migrate/destination/UserData.php \Drupal\user\Plugin\migrate\destination\UserData
  3. 9 core/modules/user/src/UserData.php \Drupal\user\UserData
  4. 8.9.x core/modules/user/src/Plugin/views/field/UserData.php \Drupal\user\Plugin\views\field\UserData
  5. 8.9.x core/modules/user/src/Plugin/migrate/destination/UserData.php \Drupal\user\Plugin\migrate\destination\UserData
  6. 8.9.x core/modules/user/src/UserData.php \Drupal\user\UserData
  7. 10 core/modules/user/src/Plugin/views/field/UserData.php \Drupal\user\Plugin\views\field\UserData
  8. 10 core/modules/user/src/Plugin/migrate/destination/UserData.php \Drupal\user\Plugin\migrate\destination\UserData
  9. 10 core/modules/user/src/UserData.php \Drupal\user\UserData

Migration destination for user data.

Hierarchy

Expanded class hierarchy of UserData

1 file declares its use of UserData
DestinationCategoryTest.php in core/modules/migrate_drupal/tests/src/Kernel/Plugin/migrate/DestinationCategoryTest.php

File

core/modules/user/src/Plugin/migrate/destination/UserData.php, line 16

Namespace

Drupal\user\Plugin\migrate\destination
View source
class UserData extends DestinationBase implements ContainerFactoryPluginInterface {
    
    /**
     * @var \Drupal\user\UserData
     */
    protected $userData;
    
    /**
     * Builds a user data entity destination.
     *
     * @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.
     * @param \Drupal\user\UserData $user_data
     *   The user data service.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, UserDataStorage $user_data) {
        parent::__construct($configuration, $plugin_id, $plugin_definition, $migration);
        $this->userData = $user_data;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, ?MigrationInterface $migration = NULL) {
        return new static($configuration, $plugin_id, $plugin_definition, $migration, $container->get('user.data'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function import(Row $row, array $old_destination_id_values = []) {
        $uid = $row->getDestinationProperty('uid');
        $module = $row->getDestinationProperty('module');
        $key = $row->getDestinationProperty('key');
        $this->userData
            ->set($module, $uid, $key, $row->getDestinationProperty('settings'));
        return [
            $uid,
            $module,
            $key,
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getIds() {
        $ids['uid']['type'] = 'integer';
        $ids['module']['type'] = 'string';
        $ids['key']['type'] = 'string';
        return $ids;
    }
    
    /**
     * {@inheritdoc}
     */
    public function fields() {
        return [
            'uid' => 'The user id.',
            'module' => 'The module name responsible for the settings.',
            'key' => 'The setting key to save under.',
            'settings' => 'The settings to save.',
        ];
    }

}

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 Checks if requirements for this plugin are OK. Overrides RequirementsInterface::checkRequirements
DestinationBase::getDestinationModule public function Gets the destination module handling the destination data. Overrides MigrateDestinationInterface::getDestinationModule 1
DestinationBase::rollback public function Delete the specified destination object from the target Drupal. Overrides MigrateDestinationInterface::rollback 2
DestinationBase::rollbackAction public function The rollback action for the last imported item. Overrides MigrateDestinationInterface::rollbackAction
DestinationBase::setRollbackAction protected function For a destination item being updated, set the appropriate rollback action.
DestinationBase::supportsRollback public function Whether the destination can be rolled back or not. Overrides MigrateDestinationInterface::supportsRollback
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
UserData::$userData protected property
UserData::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
UserData::fields public function Returns an array of destination fields. Overrides MigrateDestinationInterface::fields
UserData::getIds public function Gets the destination IDs. Overrides MigrateDestinationInterface::getIds
UserData::import public function Import the row. Overrides MigrateDestinationInterface::import
UserData::__construct public function Builds a user data entity destination. Overrides DestinationBase::__construct

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