class BulkUserImport in Bulk User Registration 8

Bulk user import form.

@package Drupal\bulk_user_registration

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\bulk_user_registration\Form\BulkUserImport

Expanded class hierarchy of BulkUserImport

1 string reference to 'BulkUserImport'

bulk_user_registration.routing.yml in ./bulk_user_registration.routing.yml: bulk_user_registration.routing.yml

File

src/Form/BulkUserImport.php, line 19

Namespace

Drupal\bulk_user_registration\Form

View source

class BulkUserImport extends FormBase {

  /**
   * Request stack.
   *
   * @var \Symfony\Component\HttpFoundation\RequestStack
   */
  protected $requestStack;

  /**
   * The bulk user registration service.
   *
   * @var \Drupal\bulk_user_registration\BulkUserRegistration
   */
  protected $bulkUserRegistration;

  /**
   * Constructor.
   *
   * @param \Symfony\Component\HttpFoundation\RequestStack $requestStack
   *   Request stack.
   * @param \Drupal\bulk_user_registration\BulkUserRegistration $bulkUserRegistration
   *   The bulk user registration service.
   */
  public function __construct(RequestStack $requestStack, BulkUserRegistration $bulkUserRegistration) {
    $this->requestStack = $requestStack;
    $this->bulkUserRegistration = $bulkUserRegistration;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('request_stack'), $container
      ->get('bulk_user_registration'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'bulk_user_registration_import';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['file_upload'] = [
      '#type' => 'file',
      '#title' => $this
        ->t('Import CSV file'),
      '#description' => $this
        ->t('The CSV file to be imported. Check the CSV sample below if you are not sure about the format.'),
      '#autoupload' => TRUE,
      '#upload_validators' => [
        'file_validate_extensions' => [
          'csv',
        ],
      ],
    ];
    $form['sample_csv'] = [
      '#type' => 'item',
      'link' => [
        '#type' => 'link',
        '#title' => $this
          ->t('Download sample CSV'),
        '#url' => Url::fromRoute('bulk_user_registration.csv_sample'),
      ],
      '#description' => $this
        ->t('This sample file contains all possible fields and various data samples to get you started.'),
    ];
    $form['default_role'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Default role'),
      '#description' => $this
        ->t('The default role for imported users. When no role data is provided in the CSV, this role will be assigned.'),
      '#options' => self::getAllowedRoles(),
      '#default_value' => '',
      '#required' => TRUE,
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Import'),
      '#button_type' => 'primary',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {

    // TODO Prevent form submit when file_upload is empty.
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $defaultRole = $form_state
      ->getValue('default_role');
    $this
      ->handleFileData($this->requestStack
      ->getCurrentRequest()->files, $defaultRole);
  }

  /**
   * To import data as users.
   *
   * @param \Symfony\Component\HttpFoundation\FileBag $filedata
   *   Field data.
   * @param string $defaultRole
   *   The default role.
   */
  protected function handleFileData(FileBag $filedata, $defaultRole) {

    /** @var \Symfony\Component\HttpFoundation\File\UploadedFile $uploadedFile */
    $uploadedFiles = $filedata
      ->get('files');
    $location = $uploadedFiles['file_upload']
      ->getRealPath();
    if (($handle = fopen($location, 'r')) === FALSE) {
      return;
    }

    // Read the csv data.
    $headerData = [];
    $csvData = [];
    while (($data = fgetcsv($handle)) !== FALSE) {
      if (empty($headerData)) {
        $headerData = $data;
      }
      else {
        $csvData[] = $data;
      }
    }
    fclose($handle);

    // Only standard and extra fields are allowed as csv columns. Unknown
    // fields will be ignored.
    $fieldNames = $this->bulkUserRegistration
      ->getFieldNames();
    $columnsToIgnore = [];
    foreach ($headerData as $column => $header) {
      if (!isset($fieldNames[$header])) {
        $columnsToIgnore[] = $column;
      }
    }

    // Collect the user data in a structured array. Where keys are the
    // names of the appropriate header column.
    $userData = [];
    foreach ($csvData as $csvRow) {
      $row_data = [];
      foreach ($csvRow as $column => $value) {
        if (in_array($column, $columnsToIgnore)) {
          continue;
        }
        $row_data[$headerData[$column]] = trim($value);
      }
      $userData[] = $row_data;
    }
    $userData = array_filter($userData);
    $this
      ->batchProcessUserInfo($userData, $defaultRole);
  }

  /**
   * Process user information in a batch.
   *
   * @param array $userData
   *   Structured array of user data.
   * @param string $defaultRole
   *   Default user role.
   */
  public function batchProcessUserInfo(array $userData, $defaultRole) {
    $operations = [];
    foreach ($userData as $data) {
      $operations[] = [
        '\\Drupal\\bulk_user_registration\\Form\\BulkUserImport::batchImport',
        [
          'userData' => $data,
          'defaultRole' => $defaultRole,
        ],
      ];
    }
    $batch = [
      'title' => $this
        ->t('Importing users..'),
      'operations' => $operations,
      'finished' => '\\Drupal\\bulk_user_registration\\Form\\BulkUserImport::batchFinished',
    ];
    batch_set($batch);
  }

  /**
   * Batch callback: User import operation.
   *
   * @param array $userData
   *   Structured array of user data. The keys are user field names.
   * @param string $defaultRole
   *   The default role.
   * @param array $context
   *   Batch context data.
   */
  public static function batchImport(array $userData, $defaultRole, array &$context) {

    // Required user data is missing. Do not import.
    if (empty($userData[BulkUserRegistrationInterface::FIELD_EMAIL]) || empty($userData[BulkUserRegistrationInterface::FIELD_USER_NAME])) {
      return;
    }

    // This user already exists. Do not import.
    if (user_load_by_mail($userData[BulkUserRegistrationInterface::FIELD_EMAIL])) {
      return;
    }
    $user = \Drupal::service('bulk_user_registration')
      ->createUser($userData, $defaultRole);

    // Notify user via mail.
    if ($user
      ->isActive()) {
      _user_mail_notify('register_no_approval_required', $user);
    }
    $context['results'][] = $user
      ->id();
  }

  /**
   * Batch callback: Finish bulk user import process.
   *
   * @param bool $success
   *   Success or not.
   * @param array $results
   *   Results array.
   * @param mixed $operations
   *   Operations.
   */
  public static function batchFinished($success, array $results, $operations) {
    $messenger = \Drupal::messenger();
    if ($success) {
      $messenger
        ->addStatus(\Drupal::translation()
        ->formatPlural(count($results), '1 user imported.', '@count users imported.'));
    }
    else {
      $messenger
        ->addError(t('Finished with errors.'));
    }
  }

  /**
   * The roles allowed to import.
   *
   * @return array
   *   An associative array with the role id as the key and the role name as
   *   value.
   */
  protected function getAllowedRoles() {
    $allowedRoles = \Drupal::config('bulk_user_registration.settings')
      ->get('allowed_roles');
    return array_intersect_key(user_role_names(TRUE), array_flip(array_filter($allowedRoles)));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BulkUserImport::$bulkUserRegistration	protected	property	The bulk user registration service.
BulkUserImport::$requestStack	protected	property	Request stack. Overrides FormBase::$requestStack
BulkUserImport::batchFinished	public static	function	Batch callback: Finish bulk user import process.
BulkUserImport::batchImport	public static	function	Batch callback: User import operation.
BulkUserImport::batchProcessUserInfo	public	function	Process user information in a batch.
BulkUserImport::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
BulkUserImport::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
BulkUserImport::getAllowedRoles	protected	function	The roles allowed to import.
BulkUserImport::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
BulkUserImport::handleFileData	protected	function	To import data as users.
BulkUserImport::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
BulkUserImport::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
BulkUserImport::__construct	public	function	Constructor.
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::config	protected	function	Retrieves a configuration object.
FormBase::configFactory	protected	function	Gets the config factory for this form.	1
FormBase::container	private	function	Returns the service container.
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.

You are here

class BulkUserImport in Bulk User Registration 8

Hierarchy

File

Namespace

Members

API Navigation