1. class
  2. Drupal
  3. \
  4. user
  5. \
  6. Plugin
  7. \
  8. migrate
  9. \
  10. destination
  11. \
  12. UserData

UserData

class UserData extends DestinationBase implements ContainerFactoryPluginInterface (View source)

Traits

StringTranslationTrait

Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.

DependencySerializationTrait

Provides dependency injection friendly methods for serialization.

MessengerTrait

Provides a trait for the messenger service.

Constants

DERIVATIVE_SEPARATOR

A string which is used to separate base plugin IDs from the derivative ID.

Properties

protected string $pluginId

The plugin_id.

 from  PluginBase
protected array $pluginDefinition

The plugin implementation definition.

 from  PluginBase
protected array $configuration

Configuration information passed into the plugin.

 from  PluginBase
protected TranslationInterface $stringTranslation

The string translation service.

 from  StringTranslationTrait
protected array $_serviceIds

An array of service IDs keyed by property name used for serialization.

 from  DependencySerializationTrait
protected array $_entityStorages

An array of entity type IDs keyed by the property name of their storages.

 from  DependencySerializationTrait
protected MessengerInterface $messenger

The messenger.

 from  MessengerTrait
protected bool $supportsRollback

Indicates whether the destination can be rolled back.

 from  DestinationBase
protected int $rollbackAction

The rollback action to be saved for the last imported item.

 from  DestinationBase
protected MigrationInterface $migration

The migration.

 from  DestinationBase
protected UserData $userData

Methods

__construct(array $configuration, string $plugin_id, mixed $plugin_definition, MigrationInterface $migration, UserData $user_data)

Builds a user data entity destination.

string
getPluginId()

Gets the plugin_id of the plugin instance.

from  PluginBase
string
getBaseId()

Gets the base_plugin_id of the plugin instance.

from  PluginBase
string|null
getDerivativeId()

Gets the derivative_id of the plugin instance.

from  PluginBase
array
getPluginDefinition()

Gets the definition of the plugin implementation.

from  PluginBase
bool
isConfigurable()

Determines if the plugin is configurable.

from  PluginBase
TranslatableMarkup
t(string $string, array $args = [], array $options = [])

Translates a string to the current language or to a given language.

from  StringTranslationTrait
formatPlural($count, $singular, $plural, array $args = [], array $options = [])

Formats a string containing a count of items.

from  StringTranslationTrait
getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

from  StringTranslationTrait
TranslationInterface
getStringTranslation()

Gets the string translation service.

from  StringTranslationTrait
$this
setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

from  StringTranslationTrait
__sleep()

{@inheritdoc}

from  DependencySerializationTrait
__wakeup()

{@inheritdoc}

from  DependencySerializationTrait
setMessenger(MessengerInterface $messenger)

Sets the messenger.

from  MessengerTrait
MessengerInterface
messenger()

Gets the messenger.

from  MessengerTrait
int
rollbackAction()

The rollback action for the last imported item.

from  DestinationBase
checkRequirements()

Checks if requirements for this plugin are OK.

from  DestinationBase
rollback(array $destination_identifier)

Delete the specified destination object from the target Drupal.

from  DestinationBase
bool
supportsRollback()

Whether the destination can be rolled back or not.

from  DestinationBase
setRollbackAction(array $id_map, int $update_action = MigrateIdMapInterface::ROLLBACK_PRESERVE)

For a destination item being updated, set the appropriate rollback action.

from  DestinationBase
string|null
getDestinationModule()

Gets the destination module handling the destination data.

from  DestinationBase
static ContainerFactoryPluginInterface
create(ContainerInterface $container, array $configuration, string $plugin_id, mixed $plugin_definition, MigrationInterface $migration = NULL)

Creates an instance of the plugin.

array|bool
import(Row $row, array $old_destination_id_values = [])

Import the row.

array[]
getIds()

Gets the destination IDs.

array
fields()

Returns an array of destination fields.

Details

at line 38
__construct(array $configuration, string $plugin_id, mixed $plugin_definition, MigrationInterface $migration, UserData $user_data)

Builds a user data entity destination.

Parameters

array $configuration

A configuration array containing information about the plugin instance.
string $plugin_id

The plugin_id for the plugin instance.
mixed $plugin_definition

The plugin implementation definition.
MigrationInterface $migration

The migration.
UserData $user_data

The user data service.

in PluginBase at line 62
string getPluginId()

Gets the plugin_id of the plugin instance.

Return Value

string

The plugin_id of the plugin instance.

in PluginBase at line 69
string getBaseId()

Gets the base_plugin_id of the plugin instance.

Return Value

string

The base_plugin_id of the plugin instance.

in PluginBase at line 80
string|null getDerivativeId()

Gets the derivative_id of the plugin instance.

Return Value

string|null

The derivative_id of the plugin instance NULL otherwise.

in PluginBase at line 92
array getPluginDefinition()

Gets the definition of the plugin implementation.

Return Value

array

The plugin definition, as returned by the discovery object used by the plugin manager.

in PluginBase at line 102
bool isConfigurable()

Determines if the plugin is configurable.

Return Value

bool

A boolean indicating whether the plugin is configurable.

in StringTranslationTrait at line 70
protected TranslatableMarkup t(string $string, array $args = [], array $options = [])

Translates a string to the current language or to a given language.

See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.

In order for strings to be localized, make them available in one of the ways supported by the

Parameters

string $string

A string containing the English text to translate.
array $args

(optional) An associative array of replacements to make after translation. Based on the first character of the key, the value is escaped and/or themed. See \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for details.
array $options

(optional) An associative array of additional options, with the following elements:

  • 'langcode' (defaults to the current language): A language code, to translate to a language other than what is used to display the page.
  • 'context' (defaults to the empty context): The context the source string belongs to. See the @link i18n Internationalization topic @endlink for more information about string contexts.

Return Value

TranslatableMarkup

An object that, when cast to a string, returns the translated string.

See also

FormattableMarkup::placeholderFormat
TranslatableMarkup::__construct

in StringTranslationTrait at line 79
protected formatPlural($count, $singular, $plural, array $args = [], array $options = [])

Formats a string containing a count of items.

Parameters

$count
$singular
$plural
array $args
array $options

See also

TranslationInterface::formatPlural

in StringTranslationTrait at line 88
protected getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

Parameters

$langcode

See also

PluralFormulaInterface::getNumberOfPlurals

in StringTranslationTrait at line 102
protected TranslationInterface getStringTranslation()

Gets the string translation service.

Return Value

TranslationInterface

The string translation service.

in StringTranslationTrait at line 118
$this setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

Parameters

TranslationInterface $translation

The string translation service.

Return Value

$this

in DependencySerializationTrait at line 32
__sleep()

{@inheritdoc}

in DependencySerializationTrait at line 67
__wakeup()

{@inheritdoc}

in MessengerTrait at line 23
setMessenger(MessengerInterface $messenger)

Sets the messenger.

Parameters

MessengerInterface $messenger

The messenger.

in MessengerTrait at line 33
MessengerInterface messenger()

Gets the messenger.

Return Value

MessengerInterface

The messenger.

in DestinationBase at line 72
int rollbackAction()

The rollback action for the last imported item.

Return Value

int

The MigrateIdMapInterface::ROLLBACK_ constant indicating how an imported item should be handled on rollback.

in DestinationBase at line 79
checkRequirements()

Checks if requirements for this plugin are OK.

Exceptions

RequirementsException

in DestinationBase at line 88
rollback(array $destination_identifier)

Delete the specified destination object from the target Drupal.

Parameters

array $destination_identifier

The ID of the destination object to delete.

in DestinationBase at line 95
bool supportsRollback()

Whether the destination can be rolled back or not.

Return Value

bool

TRUE if rollback is supported, FALSE if not.

in DestinationBase at line 107
protected setRollbackAction(array $id_map, int $update_action = MigrateIdMapInterface::ROLLBACK_PRESERVE)

For a destination item being updated, set the appropriate rollback action.

Parameters

array $id_map

The map row data for the item.
int $update_action

The rollback action to take if we are updating an existing item.

in DestinationBase at line 123
string|null getDestinationModule()

Gets the destination module handling the destination data.

Return Value

string|null

The destination module or NULL if not found.

at line 46
static ContainerFactoryPluginInterface create(ContainerInterface $container, array $configuration, string $plugin_id, mixed $plugin_definition, MigrationInterface $migration = NULL)

Creates an instance of the plugin.

Parameters

ContainerInterface $container

The container to pull out services used in the plugin.
array $configuration

A configuration array containing information about the plugin instance.
string $plugin_id

The plugin ID for the plugin instance.
mixed $plugin_definition

The plugin implementation definition.
MigrationInterface $migration

Return Value

ContainerFactoryPluginInterface

Returns an instance of this plugin.

at line 59
array|bool import(Row $row, array $old_destination_id_values = [])

Import the row.

Derived classes must implement import(), to construct one new object (pre-populated) using ID mappings in the Migration.

Parameters

Row $row

The row object.
array $old_destination_id_values

(optional) The old destination IDs. Defaults to an empty array.

Return Value

array|bool

An indexed array of destination IDs in the same order as defined in the plugin's getIds() method if the plugin wants to save the IDs to the ID map, TRUE to indicate success without saving IDs to the ID map, or FALSE to indicate a failure.

at line 71
array[] 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: @code return [ 'id' => [ 'type' => 'integer', 'unsigned' => FALSE, 'size' => 'big', ], 'version' => [ 'type' => 'string', 'max_length' => 64, 'is_ascii' => TRUE, ], ]; @endcode 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: @code return [ 'format' => [ 'type' => 'text.format', ], ]; @endcode Additional custom keys/values, that are not part of field storage definition, can be passed in definitions: @code return [ 'nid' => [ 'type' => 'integer', 'custom_setting' => 'some_value', ], ]; @endcode

at line 81
array fields()

Returns an array of destination fields.

Derived classes must implement fields(), returning a list of available destination fields.

Return Value

array
  • Keys: machine names of the fields
  • Values: Human-friendly descriptions of the fields.