You are here

Home » API reference » Term Merge 8 » MergeTermsConfirm.php

class MergeTermsConfirm in Term Merge 8

Term merge confirm form.

Hierarchy

Expanded class hierarchy of MergeTermsConfirm

1 file declares its use of MergeTermsConfirm
MergeTermsConfirmTest.php in tests/src/Kernel/Form/MergeTermsConfirmTest.php
1 string reference to 'MergeTermsConfirm'
term_merge.routing.yml in ./term_merge.routing.yml
term_merge.routing.yml

File

src/Form/MergeTermsConfirm.php, line 17

Namespace

Drupal\term_merge\Form
View source 
class MergeTermsConfirm extends FormBase {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The term storage handler.
   *
   * @var \Drupal\taxonomy\TermStorageInterface
   */
  protected $termStorage;

  /**
   * The private temporary storage factory.
   *
   * @var \Drupal\Core\TempStore\PrivateTempStoreFactory
   */
  private $tempStoreFactory;

  /**
   * The term merger.
   *
   * @var \Drupal\term_merge\TermMergerInterface
   */
  private $termMerger;

  /**
   * The vocabulary.
   *
   * @var \Drupal\taxonomy\VocabularyInterface
   */
  private $vocabulary;

  /**
   * Constructs a MergeTermsConfirm object.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   The entity manager service.
   * @param \Drupal\Core\TempStore\PrivateTempStoreFactory $tempStoreFactory
   *   The private temporary storage factory.
   * @param \Drupal\term_merge\TermMergerInterface $termMerger
   *   The term merger service.
   */
  public function __construct(EntityTypeManagerInterface $entityTypeManager, PrivateTempStoreFactory $tempStoreFactory, TermMergerInterface $termMerger) {
    $this->entityTypeManager = $entityTypeManager;
    $this->termStorage = $entityTypeManager
      ->getStorage('taxonomy_term');
    $this->tempStoreFactory = $tempStoreFactory;
    $this->termMerger = $termMerger;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager'), $container
      ->get('tempstore.private'), $container
      ->get('term_merge.term_merger'));
  }

  /**
   * Returns a unique string identifying the form.
   *
   * @return string
   *   The unique string identifying the form.
   */
  public function getFormId() {
    return 'taxonomy_merge_terms_confirm';
  }

  /**
   * {@inheritdoc}
   *
   * @SuppressWarnings(camelCase)
   * @SuppressWarnings("else")
   */
  public function buildForm(array $form, FormStateInterface $form_state, VocabularyInterface $taxonomy_vocabulary = NULL) {
    $this->vocabulary = $taxonomy_vocabulary;
    $selectedTermIds = $this
      ->getSelectedTermIds();
    if (empty($selectedTermIds)) {
      $this
        ->messenger()
        ->addError($this
        ->t("You must submit at least one term."), 'error');
      return $form;
    }
    $target = $this->tempStoreFactory
      ->get('term_merge')
      ->get('target');
    if (!is_string($target) && !$target instanceof TermInterface) {
      throw new \LogicException("Invalid target type. Should be string or implement TermInterface");
    }
    $arguments = [
      '%termCount' => count($selectedTermIds),
      '%termName' => is_string($target) ? $target : $target
        ->label(),
    ];
    if (is_string($target)) {
      $form['message']['#markup'] = $this
        ->t("You are about to merge %termCount terms into new term %termName. This action can't be undone. Are you sure you wish to continue with merging the terms below?", $arguments);
    }
    else {
      $form['message']['#markup'] = $this
        ->t("You are about to merge %termCount terms into existing term %termName. This action can't be undone. Are you sure you wish to continue with merging the terms below?", $arguments);
    }
    $form['terms'] = [
      '#title' => $this
        ->t("Terms to be merged"),
      '#theme' => 'item_list',
      '#items' => $this
        ->getSelectedTermLabels(),
    ];
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#button_type' => 'primary',
      '#type' => 'submit',
      '#value' => $this
        ->t('Confirm merge'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   *
   * @SuppressWarnings(camelCase)
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $selectedTerms = $this
      ->loadSelectedTerms();
    $target = $this->tempStoreFactory
      ->get('term_merge')
      ->get('target');
    if (is_string($target)) {
      $this->termMerger
        ->mergeIntoNewTerm($selectedTerms, $target);
      $this
        ->setSuccessfullyMergedMessage(count($selectedTerms), $target);
      $this
        ->redirectToTermMergeForm($form_state);
      return;
    }
    $this->termMerger
      ->mergeIntoTerm($selectedTerms, $target);
    $this
      ->setSuccessfullyMergedMessage(count($selectedTerms), $target
      ->label());
    $this
      ->redirectToTermMergeForm($form_state);
  }

  /**
   * Callback for the form title.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   The title.
   *
   * @SuppressWarnings(camelCase)
   */
  public function titleCallback() {
    $termCount = count($this
      ->getSelectedTermIds());
    $arguments = [
      '%termCount' => $termCount,
    ];
    return $this
      ->t("Are you sure you wish to merge %termCount terms?", $arguments);
  }

  /**
   * Gets a list of selected term ids from the temp store.
   *
   * @return int[]
   *   The selected term ids.
   */
  private function getSelectedTermIds() {
    $selectedTerms = $this->tempStoreFactory
      ->get('term_merge')
      ->get('terms');
    if ($selectedTerms === NULL) {
      $selectedTerms = [];
    }
    return $selectedTerms;
  }

  /**
   * Gets a list of selected term labels from the temp store.
   *
   * @return \Drupal\taxonomy\TermInterface[]
   *   The labels of the selected terms.
   */
  private function getSelectedTermLabels() {
    $selectedTerms = $this
      ->loadSelectedTerms();
    $items = [];
    foreach ($selectedTerms as $term) {
      $items[] = $term
        ->label();
    }
    return $items;
  }

  /**
   * Loads the selected terms.
   *
   * @return \Drupal\taxonomy\TermInterface[]
   *   The selected terms.
   */
  private function loadSelectedTerms() {
    $termStorage = $this->entityTypeManager
      ->getStorage('taxonomy_term');

    /** @var \Drupal\taxonomy\TermInterface[] $selectedTerms */
    $selectedTerms = $termStorage
      ->loadMultiple($this
      ->getSelectedTermIds());
    return $selectedTerms;
  }

  /**
   * Sets a redirect to the term merge form.
   *
   * @param \Drupal\Core\Form\FormStateInterface $formState
   *   The form state object to set the redirect on.
   */
  private function redirectToTermMergeForm(FormStateInterface $formState) {
    $parameters['taxonomy_vocabulary'] = $this->vocabulary
      ->id();
    $routeName = 'entity.taxonomy_vocabulary.merge_form';
    $formState
      ->setRedirect($routeName, $parameters);
  }

  /**
   * Sets the successfully merged terms message.
   *
   * @param int $count
   *   The numner of terms merged.
   * @param string $targetName
   *   The name of the target term.
   */
  private function setSuccessfullyMergedMessage($count, $targetName) {
    $arguments = [
      '%count' => $count,
      '%target' => $targetName,
    ];
    $this
      ->messenger()
      ->addStatus($this
      ->t('Successfully merged %count terms into %target', $arguments));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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.
MergeTermsConfirm::$entityTypeManager protected property The entity type manager.
MergeTermsConfirm::$tempStoreFactory private property The private temporary storage factory.
MergeTermsConfirm::$termMerger private property The term merger.
MergeTermsConfirm::$termStorage protected property The term storage handler.
MergeTermsConfirm::$vocabulary private property The vocabulary.
MergeTermsConfirm::buildForm public function Plugin annotation @SuppressWarnings(camelCase) @SuppressWarnings("else") Overrides FormInterface::buildForm
MergeTermsConfirm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
MergeTermsConfirm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
MergeTermsConfirm::getSelectedTermIds private function Gets a list of selected term ids from the temp store.
MergeTermsConfirm::getSelectedTermLabels private function Gets a list of selected term labels from the temp store.
MergeTermsConfirm::loadSelectedTerms private function Loads the selected terms.
MergeTermsConfirm::redirectToTermMergeForm private function Sets a redirect to the term merge form.
MergeTermsConfirm::setSuccessfullyMergedMessage private function Sets the successfully merged terms message.
MergeTermsConfirm::submitForm public function Plugin annotation @SuppressWarnings(camelCase); Overrides FormInterface::submitForm
MergeTermsConfirm::titleCallback public function Callback for the form title.
MergeTermsConfirm::__construct public function Constructs a MergeTermsConfirm object.
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.