You are here

Home » API reference » Taxonomy Multi-delete Terms 8 » DeleteTermsConfirm.php

class DeleteTermsConfirm in Taxonomy Multi-delete Terms 8

Defines a confirmation form for deleting term data.

Hierarchy

Expanded class hierarchy of DeleteTermsConfirm

1 string reference to 'DeleteTermsConfirm'
taxonomy_multidelete_terms.routing.yml in ./taxonomy_multidelete_terms.routing.yml
taxonomy_multidelete_terms.routing.yml

File

src/Form/DeleteTermsConfirm.php, line 16

Namespace

Drupal\taxonomy_multidelete_terms\Form
View source 
class DeleteTermsConfirm extends ConfirmFormBase {
  protected $tempStore;

  /**
   * {@inheritdoc}
   */
  public function __construct(PrivateTempStoreFactory $temp_store_factory) {

    // For taxonomy_multidelete_terms any unique namespace will do.
    $this->tempStore = $temp_store_factory
      ->get('taxonomy_multidelete_terms');
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('user.private_tempstore'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {

    // The question to display to the user.
    return t('Are you sure you want to delete these taxonomy terms?');
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return new Url('taxonomy_multidelete_terms.overview_form', array(
      'taxonomy_vocabulary' => $this
        ->getVocablaryName(),
    ));
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this
      ->t('Deleting a term will delete all its children if there are any. This action cannot be undone.');
  }

  /**
   * {@inheritdoc}
   */
  public function getConfirmText() {
    return $this
      ->t('Delete');
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelText() {
    return $this
      ->t('Cancel');
  }

  /**
   * {@inheritdoc}
   */
  protected function getRedirectUrl() {
    return $this
      ->getCancelUrl();
  }

  /**
   * {@inheritdoc}
   */
  protected function deleteStore() {
    $storedata = $this->tempStore
      ->get('deletedterms');
    if (!empty($storedata)) {
      $this->tempStore
        ->delete('deletedterms');
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function getDeletionMessage() {
    $name = implode(', ', $this
      ->getTermsName());
    return $this
      ->t('Deleted term(s) %name.', array(
      '%name' => $name,
    ));
  }

  /**
   * {@inheritdoc}
   */
  protected function getVocablaryName() {
    return $this->tempStore
      ->get('vocabulary');
  }

  /**
   * {@inheritdoc}
   */
  protected function getTermsName() {
    $tids = $this
      ->getTermsId();
    $name = array();
    foreach ($tids as $tid) {
      $name[] = Term::load($tid)
        ->get('name')->value;
    }
    return $name;
  }

  /**
   * {@inheritdoc}
   */
  protected function getTermsId() {
    $terms_data = $this->tempStore
      ->get('deletedterms');
    $tids = array();
    foreach ($terms_data as $value) {
      if (!empty($value['term']['check-delete'])) {
        $tids[] = $value['term']['tid'];
      }
    }
    return $tids;
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $term_data = $this
      ->getTermsId();
    $form['terms'] = array(
      '#prefix' => '<ul>',
      '#suffix' => '</ul>',
      '#tree' => TRUE,
    );
    foreach ($term_data as $tid) {
      $val = \Drupal::entityTypeManager()
        ->getStorage('taxonomy_term')
        ->load($tid);
      if (!$val) {
        $form_state
          ->setRedirectUrl($this
          ->getRedirectUrl());
        $response = new RedirectResponse($this
          ->getCancelUrl()
          ->toString());
        $response
          ->send();
        return $response;
      }
      $termname = Term::load($tid)
        ->get('name')->value;
      $form['terms'][$tid] = array(
        '#type' => 'hidden',
        '#value' => $tid,
        '#prefix' => '<li>',
        '#suffix' => $termname . "</li>\n",
      );
    }
    $form['operation'] = array(
      '#type' => 'hidden',
      '#value' => 'cancel',
    );
    $form = parent::buildForm($form, $form_state);
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $selected_terms = array_filter($form_state
      ->getValue('terms'));
    if ($form_state
      ->getValue('terms') === 'cancel') {
      $this
        ->deleteStore();
    }
    $batch = [
      'title' => t('Deleting Terms...'),
      'operations' => [
        [
          '\\Drupal\\taxonomy_multidelete_terms\\TaxonomyMultideleteBatch::processTerms',
          [
            $selected_terms,
          ],
        ],
      ],
      'finished' => '\\Drupal\\taxonomy_multidelete_terms\\TaxonomyMultideleteBatch::finishProcess',
    ];
    batch_set($batch);
    $form_state
      ->setRedirectUrl($this
      ->getRedirectUrl());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfirmFormBase::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
DeleteTermsConfirm::$tempStore protected property
DeleteTermsConfirm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
DeleteTermsConfirm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
DeleteTermsConfirm::deleteStore protected function
DeleteTermsConfirm::getCancelText public function Returns a caption for the link which cancels the action. Overrides ConfirmFormBase::getCancelText
DeleteTermsConfirm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
DeleteTermsConfirm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
DeleteTermsConfirm::getDeletionMessage protected function
DeleteTermsConfirm::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
DeleteTermsConfirm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
DeleteTermsConfirm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
DeleteTermsConfirm::getRedirectUrl protected function
DeleteTermsConfirm::getTermsId protected function
DeleteTermsConfirm::getTermsName protected function
DeleteTermsConfirm::getVocablaryName protected function
DeleteTermsConfirm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
DeleteTermsConfirm::__construct public function
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.
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.