You are here

Home » API reference » User Merge 2.x » PickAccountsForm.php

class PickAccountsForm in User Merge 2.x

Class PickAccountsForm.

@package Drupal\usermerge\Form

Hierarchy

Expanded class hierarchy of PickAccountsForm

File

src/Form/PickAccountsForm.php, line 17

Namespace

Drupal\usermerge\Form
View source 
class PickAccountsForm extends MultiStepFormBase {

  /**
   * Action plugin manager.
   *
   * @var \Drupal\Component\Plugin\PluginManagerInterface
   */
  protected $actionPluginManager;

  /**
   * Property plugin manager.
   *
   * @var \Drupal\Component\Plugin\PluginManagerInterface
   */
  protected $propertyPluginManager;

  /**
   * MergeAccountsForm constructor.
   *
   * @param \Drupal\usermerge\MultiStepStorageInterface $multi_step_storage
   *   Multi step storage.
   * @param \Drupal\usermerge\ReviewFormSwitcherInterface $review_switcher
   *   Review form switcher.
   * @param \Drupal\usermerge\BatchGeneratorInterface $batch_generator
   *   Batch generator.
   * @param \Drupal\Component\Plugin\PluginManagerInterface $action_manager
   *   Action plugin manager.
   * @param \Drupal\Component\Plugin\PluginManagerInterface $property_manager
   *   Property plugin manager.
   */
  public function __construct(MultiStepStorageInterface $multi_step_storage, ReviewFormSwitcherInterface $review_switcher, BatchGeneratorInterface $batch_generator, PluginManagerInterface $action_manager, PluginManagerInterface $property_manager) {
    parent::__construct($multi_step_storage, $review_switcher, $batch_generator);
    $this->actionPluginManager = $action_manager;
    $this->propertyPluginManager = $property_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('usermerge.multi_step_storage'), $container
      ->get('usermerge.review_form_switcher'), $container
      ->get('usermerge.batch_generator'), $container
      ->get('plugin.manager.usermerge.action'), $container
      ->get('plugin.manager.usermerge.property'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $property = $this->reviewSwitcher
      ->getPropertyFromForm(static::class);
    $form['properties']['list'] = [
      '#theme' => 'item_list',
      '#items' => $this
        ->getSupportedProperties(),
      '#title' => $this
        ->t('Supported actions'),
    ];
    $form['general']['retire'] = [
      '#type' => 'entity_autocomplete',
      '#target_type' => 'user',
      '#selection_settings' => [
        'include_anonymous' => FALSE,
      ],
      '#title' => $this
        ->t('The name of the account you wish to retire'),
      '#required' => TRUE,
      '#default_value' => $this->multiStepStorage
        ->getRetiredAccount(),
    ];
    $form['general']['retain'] = [
      '#type' => 'entity_autocomplete',
      '#target_type' => 'user',
      '#selection_settings' => [
        'include_anonymous' => FALSE,
      ],
      '#title' => $this
        ->t('The name of the account you wish to keep'),
      '#required' => TRUE,
      '#default_value' => $this->multiStepStorage
        ->getRetainedAccount(),
    ];
    $default_action = $this->multiStepStorage
      ->getValueFromStore($property, 'action');
    if (is_null($default_action)) {
      $default_action = 'action_block';
    }
    $form['general']['action'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Action to perform on the account you wish to retire'),
      '#options' => $this
        ->getActionOptions(),
      '#default_value' => $default_action,
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $retire = $form_state
      ->getValue('retire');
    $retain = $form_state
      ->getValue('retain');
    if ($retire == 1) {
      $form_state
        ->setErrorByName('retire', $this
        ->t("Retiring user 1 is not allowed."));
    }
    if ($retire == $retain) {
      $form_state
        ->setErrorByName('retain', $this
        ->t("You must pick a different account from the one you're retiring."));
    }
  }

  /**
   * Get action options which will be displayed in the form.
   *
   * @return array
   *   Action options.
   */
  private function getActionOptions() : array {
    $options = [];
    $definitions = $this->actionPluginManager
      ->getDefinitions();
    foreach ($definitions as $definition) {
      $options[$definition['id']] = (string) $definition['name'];
    }
    return $options;
  }

  /**
   * Get list of enabled properties.
   *
   * @return array
   *   List of properties.
   */
  private function getSupportedProperties() : array {
    $list = [];
    $definitions = $this->propertyPluginManager
      ->getDefinitions();
    foreach ($definitions as $definition) {
      $list[] = $definition['description'];
    }
    return $list;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 3
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. 3
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.
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.
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. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
MultiStepFormBase::$batchGenerator protected property Batch generator.
MultiStepFormBase::$multiStepStorage protected property Multi step storage.
MultiStepFormBase::$reviewSwitcher protected property Review form steps switcher.
MultiStepFormBase::submitCreateBatch public function Form submission for the last step.
MultiStepFormBase::submitForm final public function Overrides FormInterface::submitForm
MultiStepFormBase::submitGoBack public function Form submission for back button.
MultiStepFormBase::submitGoNext public function Form submission for next button.
PickAccountsForm::$actionPluginManager protected property Action plugin manager.
PickAccountsForm::$propertyPluginManager protected property Property plugin manager.
PickAccountsForm::buildForm public function Form constructor. Overrides MultiStepFormBase::buildForm
PickAccountsForm::create public static function Instantiates a new instance of this class. Overrides MultiStepFormBase::create
PickAccountsForm::getActionOptions private function Get action options which will be displayed in the form.
PickAccountsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
PickAccountsForm::getSupportedProperties private function Get list of enabled properties.
PickAccountsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
PickAccountsForm::__construct public function MergeAccountsForm constructor. Overrides MultiStepFormBase::__construct
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. 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.