You are here

Home » API reference » Simple Node Importer 8 » SimpleUserConfirmImportForm.php

class SimpleUserConfirmImportForm in Simple Node Importer 8

Defines a confirmation form to confirm deletion of something by id.

Hierarchy

Expanded class hierarchy of SimpleUserConfirmImportForm

1 string reference to 'SimpleUserConfirmImportForm'
simple_node_importer.routing.yml in ./simple_node_importer.routing.yml
simple_node_importer.routing.yml

File

src/Form/SimpleUserConfirmImportForm.php, line 20

Namespace

Drupal\simple_node_importer\Form
View source 
class SimpleUserConfirmImportForm extends ConfirmFormBase {
  protected $services;
  protected $sessionVariable;
  protected $sessionManager;
  protected $currentUser;
  protected $entityTypeManager;

  /**
   * Confirmation form for the start User import.
   *
   * @param Drupal\simple_node_importer\Services\GetServices $getServices
   *   Constructs a Drupal\simple_node_importer\Services object.
   * @param Drupal\Core\TempStore\PrivateTempStoreFactory $sessionVariable
   *   Constructs a Drupal\Core\TempStore\PrivateTempStoreFactory object.
   * @param Drupal\Core\Session\SessionManagerInterface $session_manager
   *   Constructs a Drupal\Core\Session\SessionManagerInterface object.
   * @param Drupal\Core\Session\AccountInterface $current_user
   *   Constructs a Drupal\Core\Session\AccountInterface object.
   * @param Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   Constructs a Drupal\Core\Entity\EntityTypeManagerInterface object.
   */
  public function __construct(GetServices $getServices, PrivateTempStoreFactory $sessionVariable, SessionManagerInterface $session_manager, AccountInterface $current_user, EntityTypeManagerInterface $entity_type_manager) {
    $this->services = $getServices;
    $this->sessionVariable = $sessionVariable
      ->get('simple_node_importer');
    $this->sessionManager = $session_manager;
    $this->currentUser = $current_user;
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $option = NULL, NodeInterface $node = NULL) {
    $this->node = $node;
    $form['snp_nid'] = [
      '#type' => 'hidden',
      '#value' => $node
        ->id(),
    ];
    $parameters = [
      'option' => $option,
      'node' => $node
        ->id(),
    ];
    return parent::buildForm($form, $form_state, $parameters);
  }

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

    // Remove unnecessary values.
    $form_state
      ->cleanValues();
    $node_storage = $this->entityTypeManager
      ->getStorage('node');
    $file_storage = $this->entityTypeManager
      ->getStorage('file');
    $snp_nid = $form_state
      ->getValue('snp_nid');
    $node = $node_storage
      ->load($snp_nid);
    $map_values = $this->sessionVariable
      ->get('mapvalues');
    $fid = $node
      ->get('field_upload_csv')
      ->getValue()[0]['target_id'];
    $file = $file_storage
      ->load($fid);
    $csv_uri = $file
      ->getFileUri();
    $handle = fopen($csv_uri, 'r');
    $columns = [];
    $columns = array_values($this->services
      ->simpleNodeImporterGetAllColumnHeaders($csv_uri));
    $record = [];
    $map_fields = array_keys($map_values);
    $i = 1;
    $records = [];
    while ($row = fgetcsv($handle)) {
      if ($i == 1) {
        $i++;
        continue;
      }
      foreach ($row as $k => $field) {
        $column1 = str_replace(' ', '_', strtolower($columns[$k]));
        foreach ($map_fields as $field_name) {
          if ($map_values[$field_name] == $column1) {
            $record[$field_name] = trim($field);
          }
          else {
            if (is_array($map_values[$field_name])) {
              $multiple_fields = array_keys($map_values[$field_name]);
              foreach ($multiple_fields as $j => $m_fields) {
                if ($m_fields == $column1) {
                  if ($m_fields == 'roles') {
                    $field = str_replace(' ', '_', strtolower($field));
                  }
                  if (!empty($field)) {
                    $record[$field_name][$j] = trim($field);
                  }
                  else {
                    $record[$field_name][$j] = NULL;
                  }
                }
              }
            }
          }
        }
      }
      $record['nid'] = $node
        ->id();
      $record['type'] = 'user';
      $records[] = $record;
    }

    // Preapring batch parmeters to be execute.
    $batch = [
      'title' => t('Importing User'),
      'operations' => [
        [
          '\\Drupal\\simple_node_importer\\Controller\\UserImportController::userImport',
          [
            $records,
          ],
        ],
      ],
      'finished' => '\\Drupal\\simple_node_importer\\Controller\\UserImportController::userImportBatchFinished',
      'init_message' => t('Initialializing User importing.'),
      'progress_message' => t('Processed @current out of @total.'),
      'error_message' => t('User creation has encountered an error.'),
    ];

    // Set the batch operation.
    batch_set($batch);
    fclose($handle);
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() : string {
    return "simple_user_confirm_importing_form";
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    $parameters = $this->sessionVariable
      ->get('parameters');
    return new Url('simple_node_importer.user_mapping_form', $parameters);
  }

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    $critical_info = new FormattableMarkup('<p class="@class"></p><p>Do you want to continue?</p>', [
      "@class" => "confirmation-info",
    ]);
    return $this
      ->t("@critical_info", [
      "@critical_info" => $critical_info,
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('snp.get_services'), $container
      ->get('user.private_tempstore'), $container
      ->get('session_manager'), $container
      ->get('current_user'), $container
      ->get('entity_type.manager'));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfirmFormBase::getCancelText public function Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText 1
ConfirmFormBase::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormInterface::getConfirmText 20
ConfirmFormBase::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormInterface::getDescription 11
ConfirmFormBase::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
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::$requestStack protected property The request stack. 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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
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.
SimpleUserConfirmImportForm::$currentUser protected property
SimpleUserConfirmImportForm::$entityTypeManager protected property
SimpleUserConfirmImportForm::$services protected property
SimpleUserConfirmImportForm::$sessionManager protected property
SimpleUserConfirmImportForm::$sessionVariable protected property
SimpleUserConfirmImportForm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
SimpleUserConfirmImportForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
SimpleUserConfirmImportForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
SimpleUserConfirmImportForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SimpleUserConfirmImportForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
SimpleUserConfirmImportForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
SimpleUserConfirmImportForm::__construct public function Confirmation form for the start User import.
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.