class ShortcutSetUsers
Same name in this branch
- 10 core/modules/shortcut/src/Plugin/migrate/source/d7/ShortcutSetUsers.php \Drupal\shortcut\Plugin\migrate\source\d7\ShortcutSetUsers
Same name in other branches
- 9 core/modules/shortcut/src/Plugin/migrate/destination/ShortcutSetUsers.php \Drupal\shortcut\Plugin\migrate\destination\ShortcutSetUsers
- 9 core/modules/shortcut/src/Plugin/migrate/source/d7/ShortcutSetUsers.php \Drupal\shortcut\Plugin\migrate\source\d7\ShortcutSetUsers
- 8.9.x core/modules/shortcut/src/Plugin/migrate/destination/ShortcutSetUsers.php \Drupal\shortcut\Plugin\migrate\destination\ShortcutSetUsers
- 8.9.x core/modules/shortcut/src/Plugin/migrate/source/d7/ShortcutSetUsers.php \Drupal\shortcut\Plugin\migrate\source\d7\ShortcutSetUsers
- 11.x core/modules/shortcut/src/Plugin/migrate/destination/ShortcutSetUsers.php \Drupal\shortcut\Plugin\migrate\destination\ShortcutSetUsers
- 11.x core/modules/shortcut/src/Plugin/migrate/source/d7/ShortcutSetUsers.php \Drupal\shortcut\Plugin\migrate\source\d7\ShortcutSetUsers
Migration destination for shortcut_set_users.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\migrate\Plugin\migrate\destination\DestinationBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\migrate\Plugin\MigrateDestinationInterface, \Drupal\migrate\Plugin\RequirementsInterface
- class \Drupal\shortcut\Plugin\migrate\destination\ShortcutSetUsers extends \Drupal\migrate\Plugin\migrate\destination\DestinationBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface
- class \Drupal\migrate\Plugin\migrate\destination\DestinationBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\migrate\Plugin\MigrateDestinationInterface, \Drupal\migrate\Plugin\RequirementsInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of ShortcutSetUsers
1 file declares its use of ShortcutSetUsers
- DestinationCategoryTest.php in core/
modules/ migrate_drupal/ tests/ src/ Kernel/ Plugin/ migrate/ DestinationCategoryTest.php
File
-
core/
modules/ shortcut/ src/ Plugin/ migrate/ destination/ ShortcutSetUsers.php, line 17
Namespace
Drupal\shortcut\Plugin\migrate\destinationView source
class ShortcutSetUsers extends DestinationBase implements ContainerFactoryPluginInterface {
/**
* The shortcut set storage handler.
*
* @var \Drupal\shortcut\ShortcutSetStorageInterface
*/
protected $shortcutSetStorage;
/**
* 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.
* @param \Drupal\shortcut\ShortcutSetStorageInterface $shortcut_set_storage
* The shortcut_set entity storage handler.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, ShortcutSetStorageInterface $shortcut_set_storage) {
parent::__construct($configuration, $plugin_id, $plugin_definition, $migration);
$this->shortcutSetStorage = $shortcut_set_storage;
}
/**
* {@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('entity_type.manager')
->getStorage('shortcut_set'));
}
/**
* {@inheritdoc}
*/
public function getIds() {
return [
'set_name' => [
'type' => 'string',
],
'uid' => [
'type' => 'integer',
],
];
}
/**
* {@inheritdoc}
*/
public function fields() {
return [
'uid' => 'The users.uid for this set.',
'source' => 'The shortcut_set.set_name that will be displayed for this user.',
];
}
/**
* {@inheritdoc}
*/
public function import(Row $row, array $old_destination_id_values = []) {
/** @var \Drupal\shortcut\ShortcutSetInterface $set */
$set = $this->shortcutSetStorage
->load($row->getDestinationProperty('set_name'));
/** @var \Drupal\user\UserInterface $account */
$account = User::load($row->getDestinationProperty('uid'));
$this->shortcutSetStorage
->assignUser($set, $account);
return [
$set->id(),
$account->id(),
];
}
}
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 | |
ShortcutSetUsers::$shortcutSetStorage | protected | property | The shortcut set storage handler. | ||
ShortcutSetUsers::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | |
ShortcutSetUsers::fields | public | function | Returns an array of destination fields. | Overrides MigrateDestinationInterface::fields | |
ShortcutSetUsers::getIds | public | function | Gets the destination IDs. | Overrides MigrateDestinationInterface::getIds | |
ShortcutSetUsers::import | public | function | Import the row. | Overrides MigrateDestinationInterface::import | |
ShortcutSetUsers::__construct | public | function | Constructs an entity destination plugin. | Overrides DestinationBase::__construct |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.