class EntityUserRole

Same name in other branches
  1. 11.x core/modules/user/src/Plugin/migrate/destination/EntityUserRole.php \Drupal\user\Plugin\migrate\destination\EntityUserRole

Provides a destination plugin for migrating user role entities.

Hierarchy

Expanded class hierarchy of EntityUserRole

File

core/modules/user/src/Plugin/migrate/destination/EntityUserRole.php, line 17

Namespace

Drupal\user\Plugin\migrate\destination
View source
class EntityUserRole extends EntityConfigBase {
    
    /**
     * All permissions on the destination site.
     *
     * @var string[]
     */
    protected $destinationPermissions = [];
    
    /**
     * Builds a user role 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\Core\Entity\EntityStorageInterface $storage
     *   The storage for this entity type.
     * @param array $bundles
     *   The list of bundles this entity type has.
     * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
     *   The language manager.
     * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
     *   The configuration factory.
     * @param array $destination_permissions
     *   All available permissions.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, EntityStorageInterface $storage, array $bundles, LanguageManagerInterface $language_manager, ConfigFactoryInterface $config_factory, array $destination_permissions) {
        parent::__construct($configuration, $plugin_id, $plugin_definition, $migration, $storage, $bundles, $language_manager, $config_factory);
        $this->destinationPermissions = $destination_permissions;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, ?MigrationInterface $migration = NULL) {
        $entity_type_id = static::getEntityTypeId($plugin_id);
        return new static($configuration, $plugin_id, $plugin_definition, $migration, $container->get('entity_type.manager')
            ->getStorage($entity_type_id), array_keys($container->get('entity_type.bundle.info')
            ->getBundleInfo($entity_type_id)), $container->get('language_manager'), $container->get('config.factory'), array_keys($container->get('user.permissions')
            ->getPermissions()));
    }
    
    /**
     * {@inheritdoc}
     */
    public function import(Row $row, array $old_destination_id_values = []) : array|bool {
        $permissions = $row->getDestinationProperty('permissions') ?? [];
        // Get permissions that do not exist on the destination.
        $invalid_permissions = array_diff($permissions, $this->destinationPermissions);
        if ($invalid_permissions) {
            sort($invalid_permissions);
            // Log the message in the migration message table.
            $message = "Permission(s) '" . implode("', '", $invalid_permissions) . "' not found.";
            $this->migration
                ->getIdMap()
                ->saveMessage($row->getSourceIdValues(), $message, MigrationInterface::MESSAGE_WARNING);
        }
        $valid_permissions = array_intersect($permissions, $this->destinationPermissions);
        $row->setDestinationProperty('permissions', $valid_permissions);
        return parent::import($row, $old_destination_id_values);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
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::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
Entity::$bundles protected property The list of the bundles of this entity type.
Entity::$entityFieldManager protected property The entity field manager.
Entity::$storage protected property The entity storage.
Entity::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
Entity::fields public function Returns an array of destination fields. Overrides MigrateDestinationInterface::fields
Entity::getBundle public function Gets the bundle for the row taking into account the default.
Entity::getEntity protected function Creates or loads an entity. 7
Entity::getEntityId protected function Gets the entity ID of the row. 2
Entity::getKey protected function Returns a specific entity key.
Entity::processStubRow protected function Populates as much of the stub row as possible. 1
EntityConfigBase::$configFactory protected property The configuration factory.
EntityConfigBase::$languageManager protected property The language manager.
EntityConfigBase::generateId protected function Generates an entity ID.
EntityConfigBase::getIds public function Gets the destination IDs. Overrides MigrateDestinationInterface::getIds 3
EntityConfigBase::isTranslationDestination protected function Get whether this destination is for translations.
EntityConfigBase::rollback public function Delete the specified destination object from the target Drupal. Overrides Entity::rollback 2
EntityConfigBase::updateEntity protected function Updates an entity with the contents of a row. Overrides Entity::updateEntity 1
EntityConfigBase::updateEntityProperty protected function Updates a (possible nested) entity property with a value. 1
EntityFieldDefinitionTrait::getDefinitionFromEntity protected function Gets the field definition from a specific entity base field.
EntityFieldDefinitionTrait::getEntityTypeId protected static function Finds the entity type from configuration or plugin ID. 3
EntityUserRole::$destinationPermissions protected property All permissions on the destination site.
EntityUserRole::create public static function Creates an instance of the plugin. Overrides EntityConfigBase::create
EntityUserRole::import public function Import the row. Overrides EntityConfigBase::import
EntityUserRole::__construct public function Builds a user role entity destination. Overrides EntityConfigBase::__construct
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.