class UserLangcode

Same name and namespace in other branches
  1. 9 core/modules/user/src/Plugin/migrate/process/UserLangcode.php \Drupal\user\Plugin\migrate\process\UserLangcode
  2. 8.9.x core/modules/user/src/Plugin/migrate/process/UserLangcode.php \Drupal\user\Plugin\migrate\process\UserLangcode
  3. 11.x core/modules/user/src/Plugin/migrate/process/UserLangcode.php \Drupal\user\Plugin\migrate\process\UserLangcode

Provides a process plugin for the user langcode.

Hierarchy

Expanded class hierarchy of UserLangcode

File

core/modules/user/src/Plugin/migrate/process/UserLangcode.php, line 16

Namespace

Drupal\user\Plugin\migrate\process
View source
class UserLangcode extends ProcessPluginBase implements ContainerFactoryPluginInterface {
  
  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManager
   */
  protected $languageManager;
  
  /**
   * Constructs a UserLangcode object.
   *
   * @param array $configuration
   *   Plugin configuration.
   * @param string $plugin_id
   *   The plugin ID.
   * @param mixed $plugin_definition
   *   The plugin definition.
   * @param \Drupal\Core\Language\LanguageManager $language_manager
   *   The language manager service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, LanguageManager $language_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->languageManager = $language_manager;
  }
  
  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container->get('language_manager'));
  }
  
  /**
   * {@inheritdoc}
   */
  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
    if (!isset($this->configuration['fallback_to_site_default'])) {
      $this->configuration['fallback_to_site_default'] = TRUE;
    }
    // If the user's language is empty, it means the locale module was not
    // installed, so the user's langcode should be English and the user's
    // preferred_langcode and preferred_admin_langcode should fallback to the
    // default language.
    if (empty($value)) {
      if ($this->configuration['fallback_to_site_default']) {
        return $this->languageManager
          ->getDefaultLanguage()
          ->getId();
      }
      else {
        return 'en';
      }
    }
    elseif ($this->languageManager
      ->getLanguage($value) === NULL) {
      return $this->languageManager
        ->getDefaultLanguage()
        ->getId();
    }
    // If the langcode is a valid one, just return it.
    return $value;
  }

}

Members

Title Sort descending 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.
UserLangcode::$languageManager protected property The language manager.
UserLangcode::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
UserLangcode::transform public function Performs the associated process. Overrides ProcessPluginBase::transform
UserLangcode::__construct public function Constructs a UserLangcode object.

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