You are here

class Authmap in External Authentication 2.0.x

Same name in this branch
  1. 2.0.x src/Authmap.php \Drupal\externalauth\Authmap
  2. 2.0.x src/Plugin/migrate/source/Authmap.php \Drupal\externalauth\Plugin\migrate\source\Authmap
  3. 2.0.x src/Plugin/migrate/destination/Authmap.php \Drupal\externalauth\Plugin\migrate\destination\Authmap
Same name and namespace in other branches
  1. 8 src/Plugin/migrate/destination/Authmap.php \Drupal\externalauth\Plugin\migrate\destination\Authmap

Drupal 8 authmap destination.

Plugin annotation


@MigrateDestination(
  id = "authmap"
)

Hierarchy

Expanded class hierarchy of Authmap

2 string references to 'Authmap'
d6_authmap.yml in migration_templates/d6_authmap.yml
migration_templates/d6_authmap.yml
d7_authmap.yml in migration_templates/d7_authmap.yml
migration_templates/d7_authmap.yml

File

src/Plugin/migrate/destination/Authmap.php, line 20

Namespace

Drupal\externalauth\Plugin\migrate\destination
View source
class Authmap extends DestinationBase implements ContainerFactoryPluginInterface {

  /**
   * The Authmap class.
   *
   * @var \Drupal\externalauth\AuthmapInterface
   */
  protected $authmap;

  /**
   * User storage.
   *
   * @var \Drupal\user\UserStorageInterface
   */
  protected $userStorage;

  /**
   * 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\externalauth\AuthmapInterface $authmap
   *   The Authmap handling class.
   * @param \Drupal\user\UserStorageInterface $user_storage
   *   The user storage.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, AuthmapInterface $authmap, UserStorageInterface $user_storage) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $migration);
    $this->authmap = $authmap;
    $this->userStorage = $user_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('externalauth.authmap'), $container
      ->get('entity_type.manager')
      ->getStorage('user'));
  }

  /**
   * {@inheritdoc}
   */
  public function getIds() {
    return [
      'uid' => [
        'type' => 'integer',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function fields(MigrationInterface $migration = NULL) {
    return [
      'uid' => 'Primary key: users.uid for user.',
      'provider' => 'The name of the authentication provider providing the authname',
      'authname' => 'Unique authentication name provided by authentication provider',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function import(Row $row, array $old_destination_id_values = []) {

    /** @var \Drupal\user\UserInterface $account */
    $account = $this->userStorage
      ->load($row
      ->getDestinationProperty('uid'));
    $provider = $row
      ->getDestinationProperty('provider');
    $authname = $row
      ->getDestinationProperty('authname');
    $this->authmap
      ->save($account, $provider, $authname);
    return [
      $account
        ->id(),
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Authmap::$authmap protected property The Authmap class.
Authmap::$userStorage protected property User storage.
Authmap::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
Authmap::fields public function Returns an array of destination fields. Overrides MigrateDestinationInterface::fields
Authmap::getIds public function Gets the destination IDs. Overrides MigrateDestinationInterface::getIds
Authmap::import public function Import the row. Overrides MigrateDestinationInterface::import
Authmap::__construct public function Constructs an entity destination plugin. Overrides DestinationBase::__construct
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
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
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.