class RolesLookup

Same name and namespace in other branches
  1. 11.x core/modules/block/src/Plugin/migrate/process/RolesLookup.php \Drupal\block\Plugin\migrate\process\RolesLookup

Gets the destination roles ID for an array of source roles IDs.

The roles_lookup plugin is used to get the destination roles for roles that are assigned to a block. It always uses the 'roles' value on the row as the source value.

Examples


 process:
   roles:
     plugin: roles_lookup
     migration: d7_user_role

This will get the destination role ID for each role in the 'roles' value on the source row.

Hierarchy

Expanded class hierarchy of RolesLookup

See also

\Drupal\migrate\Plugin\MigrateProcessInterface

File

core/modules/block/src/Plugin/migrate/process/RolesLookup.php, line 35

Namespace

Drupal\block\Plugin\migrate\process
View on git.drupalcode.org
View source 
class RolesLookup extends ProcessPluginBase implements ContainerFactoryPluginInterface {
  
  /**
   * The migrate lookup service.
   *
   * @var \Drupal\migrate\MigrateLookupInterface
   */
  protected $migrateLookup;
  
  /**
   * The migration for user role lookup.
   *
   * @var string
   */
  protected $migration;
  
  /**
   * Constructs a BlockVisibility object.
   *
   * @param array $configuration
   *   The plugin configuration.
   * @param string $plugin_id
   *   The plugin ID.
   * @param mixed $plugin_definition
   *   The plugin definition.
   * @param \Drupal\migrate\MigrateLookupInterface $migrate_lookup
   *   The migrate lookup service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrateLookupInterface $migrate_lookup) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->migrateLookup = $migrate_lookup;
    if (isset($configuration['migration'])) {
      $this->migration = $configuration['migration'];
    }
  }
  
  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, ?MigrationInterface $migration = NULL) {
    return new static($configuration, $plugin_id, $plugin_definition, $container->get('migrate.lookup'));
  }
  
  /**
   * {@inheritdoc}
   */
  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
    $roles = $row->get('roles');
    $roles_result = [];
    // If the block is assigned to specific roles, add the user_role condition.
    if ($roles) {
      foreach ($roles as $role_id) {
        $lookup_result = $this->migrateLookup
          ->lookup([
          $this->migration,
        ], [
          $role_id,
        ]);
        if ($lookup_result) {
          $roles_result[$role_id] = $lookup_result[0]['id'];
        }
      }
    }
    return $roles_result;
  }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
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
ProcessPluginBase::$stopPipeline protected property Determines if processing of the pipeline is stopped.
ProcessPluginBase::isPipelineStopped public function Determines if the pipeline should stop processing. Overrides MigrateProcessInterface::isPipelineStopped
ProcessPluginBase::multiple public function Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple 3
ProcessPluginBase::reset public function Resets the internal data of a plugin. Overrides MigrateProcessInterface::reset
ProcessPluginBase::stopPipeline protected function Stops pipeline processing after this plugin finishes.
RolesLookup::$migrateLookup protected property The migrate lookup service.
RolesLookup::$migration protected property The migration for user role lookup.
RolesLookup::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
RolesLookup::transform public function Performs the associated process. Overrides ProcessPluginBase::transform
RolesLookup::__construct public function Constructs a BlockVisibility object.

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