You are here

Home » API reference » Webform 8.5 » WebformVariantApplyForm.php

class WebformVariantApplyForm in Webform 8.5

Same name and namespace in other branches
  1. 6.x src/Form/WebformVariantApplyForm.php \Drupal\webform\Form\WebformVariantApplyForm

Form for apply a webform variant.

Hierarchy

Expanded class hierarchy of WebformVariantApplyForm

1 string reference to 'WebformVariantApplyForm'
webform.routing.yml in ./webform.routing.yml
webform.routing.yml

File

src/Form/WebformVariantApplyForm.php, line 13

Namespace

Drupal\webform\Form
View source 
class WebformVariantApplyForm extends WebformDeleteFormBase {

  /**
   * The webform containing the webform variant to be deleted.
   *
   * @var \Drupal\webform\WebformInterface
   */
  protected $webform;

  /**
   * The webform variant to be deleted.
   *
   * @var \Drupal\webform\Plugin\WebformVariantInterface
   */
  protected $webformVariant;

  /**
   * Track if webform has multiple variants.
   *
   * @var bool
   */
  protected $hasMultipleVariants;

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    if ($this
      ->isDialog()) {
      return $this->hasMultipleVariants ? $this
        ->t("Apply variants?") : $this
        ->t("Apply variant?");
    }
    else {
      $t_args = [
        '%webform' => $this->webform
          ->label(),
      ];
      return $this->hasMultipleVariants ? $this
        ->t('Apply the selected variants to the %webform webform?', $t_args) : $this
        ->t('Apply variant to the %webform webform?', $t_args);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getWarning() {
    if (!$this->hasMultipleVariants && $this->webformVariant) {
      $t_args = [
        '%title' => $this->webformVariant
          ->label(),
      ];
      return [
        '#type' => 'webform_message',
        '#message_type' => 'warning',
        '#message_message' => $this
          ->t('Are you sure you want to apply the %title variant?', $t_args) . '<br/>' . '<strong>' . $this
          ->t('This action cannot be undone.') . '</strong>',
      ];
    }
    else {
      return [
        '#type' => 'webform_message',
        '#message_type' => 'warning',
        '#message_message' => $this
          ->t('Are you sure you want to apply the selected variants?') . '<br/>' . '<strong>' . $this
          ->t('This action cannot be undone.') . '</strong>',
      ];
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return [
      'title' => [
        '#markup' => $this
          ->t('This action will…'),
      ],
      'list' => [
        '#theme' => 'item_list',
        '#items' => [
          $this->hasMultipleVariants ? $this
            ->t('Replace existing settings, elements, and handler with selected variants.') : $this
            ->t('Replace existing settings, elements, and handler with this variant.'),
        ],
      ],
    ];
  }

  /****************************************************************************/

  // Form methods.

  /****************************************************************************/

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return $this->webform
      ->toUrl('variants');
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, WebformInterface $webform = NULL) {
    $this->webform = $webform;
    $variant_id = $this
      ->getRequest()->query
      ->get('variant_id');
    if ($variant_id) {

      // Throw access denied exception is the variant does not exist.
      if (!$webform
        ->getVariants()
        ->has($variant_id)) {
        throw new AccessDeniedHttpException();
      }
      $this->webformVariant = $webform
        ->getVariant($variant_id);
    }
    $this->hasMultipleVariants = count($this->webform
      ->getElementsVariant()) > 1 ? TRUE : FALSE;
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function getConfirmInput() {
    $webform = $this->webform;
    $build = [];
    if ($this->hasMultipleVariants || empty($this->webformVariant)) {
      $build['variants'] = [
        '#tree' => TRUE,
      ];
      $element_keys = $webform
        ->getElementsVariant();
      foreach ($element_keys as $element_key) {
        $element = $webform
          ->getElement($element_key);
        $variants = $webform
          ->getVariants(NULL, NULL, $element_key);
        if (!$variants
          ->count()) {
          continue;
        }
        $variant_options = [];
        foreach ($variants as $variant) {
          $variant_options[$variant
            ->getVariantId()] = $variant
            ->label();
        }
        $build['variants'][$element_key] = [
          '#type' => 'select',
          '#title' => WebformElementHelper::getAdminTitle($element),
          '#options' => $variant_options,
          '#empty_option' => $this
            ->t('- None -'),
          '#default_value' => $this->webformVariant ? $this->webformVariant
            ->getVariantId() : '',
        ];
      }
    }
    $build['delete'] = [
      '#type' => 'radios',
      '#title' => $this->hasMultipleVariants ? $this
        ->t('After selected variants are applied…') : $this
        ->t('After this variant is applied…'),
      '#options' => [
        'selected' => $this->hasMultipleVariants ? $this
          ->t('Delete the selected variants') : $this
          ->t('Delete this variant'),
        'all' => $this
          ->t('Delete all variants'),
        'none' => $this
          ->t('Do not delete any variants'),
      ],
      '#required' => TRUE,
    ];
    return $build;
  }

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

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $variants = array_filter($form_state
      ->getValue('variants') ?: []);
    if ($this->hasMultipleVariants && empty($variants)) {
      $form_state
        ->setErrorByName('variants', $this
        ->t('Please select variants to be applied to the webform.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $webform = $this->webform;

    // Apply variant(s).
    $variants = array_filter($form_state
      ->getValue('variants') ?: []);
    if (empty($variants) && $this->webformVariant) {
      $element_key = $this->webformVariant
        ->getElementKey();
      $variant_id = $this->webformVariant
        ->getVariantId();
      $variants = [
        $element_key => $variant_id,
      ];
    }
    $webform
      ->applyVariants(NULL, $variants, TRUE);
    $webform
      ->setOverride(FALSE);
    $webform
      ->save();
    $variant_plugin = $this->webformVariant;
    if (!$this->hasMultipleVariants && empty($variant_plugin)) {
      $variant_plugin = $webform
        ->getVariant(reset($variants));
    }

    // Delete variant and display a status message.
    $t_args = [
      '%title' => $variant_plugin
        ->label(),
    ];
    switch ($form_state
      ->getValue('delete')) {
      case 'selected':
        foreach ($variants as $element_key => $variant_id) {
          $variant_plugin = $webform
            ->getVariant($variant_id);
          $this->webform
            ->deleteWebformVariant($variant_plugin);
        }
        $this->hasMultipleVariants ? $this
          ->messenger()
          ->addStatus($this
          ->t('The selected webform variants have been applied and deleted.')) : $this
          ->messenger()
          ->addStatus($this
          ->t('The webform variant %title has been applied and deleted.', $t_args));
        break;
      case 'all':
        $variant_plugins = $webform
          ->getVariants();
        foreach ($variant_plugins as $variant_plugin) {
          $this->webform
            ->deleteWebformVariant($variant_plugin);
        }
        $this->hasMultipleVariants ? $this
          ->messenger()
          ->addStatus($this
          ->t('The selected webform variants have been applied and all variants have been deleted.')) : $this
          ->messenger()
          ->addStatus($this
          ->t('The webform variant %title has been applied and all variants have been deleted.', $t_args));
        break;
      case 'none':
      default:
        $this->hasMultipleVariants ? $this
          ->messenger()
          ->addStatus($this
          ->t('The selected webform variants have been applied.')) : $this
          ->messenger()
          ->addStatus($this
          ->t('The webform variant %title has been applied.', $t_args));
        break;
    }
    $form_state
      ->setRedirectUrl($this->webform
      ->toUrl());
  }

}

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
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::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 87
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.
WebformAjaxFormTrait::announce protected function Queue announcement with Ajax response.
WebformAjaxFormTrait::buildAjaxForm protected function Add Ajax support to a form.
WebformAjaxFormTrait::createAjaxResponse protected function Create an AjaxResponse or WebformAjaxResponse object.
WebformAjaxFormTrait::getAnnouncements protected function Get announcements.
WebformAjaxFormTrait::getDefaultAjaxSettings protected function Get default ajax callback settings. 1
WebformAjaxFormTrait::getFormStateRedirectUrl protected function Get redirect URL from the form's state.
WebformAjaxFormTrait::getWrapperId protected function Get the form's Ajax wrapper id. 1
WebformAjaxFormTrait::isCallableAjaxCallback protected function Determine if Ajax callback is callable.
WebformAjaxFormTrait::isDialog protected function Is the current request for an Ajax modal/dialog.
WebformAjaxFormTrait::isOffCanvasDialog protected function Is the current request for an off canvas dialog.
WebformAjaxFormTrait::missingAjaxCallback protected function Handle missing Ajax callback.
WebformAjaxFormTrait::replaceForm protected function Replace form via an Ajax response. 1
WebformAjaxFormTrait::resetAnnouncements protected function Reset announcements.
WebformAjaxFormTrait::setAnnouncements protected function Set announcements.
WebformAjaxFormTrait::submitAjaxForm public function Submit form #ajax callback. 1
WebformAjaxFormTrait::validateAjaxForm public function Validate form #ajax callback. 1
WebformDeleteFormBase::getDetails public function Returns details to display. Overrides WebformDeleteFormInterface::getDetails 1
WebformDeleteFormBase::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormBase::getFormName
WebformDialogFormTrait::buildDialogConfirmForm protected function Add modal dialog support to a confirm form.
WebformDialogFormTrait::buildDialogDeleteAction protected function Build webform dialog delete link.
WebformDialogFormTrait::buildDialogForm protected function Add modal dialog support to a form.
WebformDialogFormTrait::cancelAjaxForm public function Cancel form #ajax callback. Overrides WebformAjaxFormTrait::cancelAjaxForm 1
WebformDialogFormTrait::closeDialog public function Close dialog.
WebformDialogFormTrait::isAjax protected function Returns if webform is using Ajax. Overrides WebformAjaxFormTrait::isAjax 1
WebformDialogFormTrait::noSubmit public function Empty submit callback used to only have the submit button to use an #ajax submit callback. Overrides WebformAjaxFormTrait::noSubmit
WebformDialogFormTrait::noValidate public function Validate callback to clear validation errors. 2
WebformVariantApplyForm::$hasMultipleVariants protected property Track if webform has multiple variants.
WebformVariantApplyForm::$webform protected property The webform containing the webform variant to be deleted.
WebformVariantApplyForm::$webformVariant protected property The webform variant to be deleted.
WebformVariantApplyForm::buildForm public function Form constructor. Overrides WebformDeleteFormBase::buildForm
WebformVariantApplyForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
WebformVariantApplyForm::getConfirmInput public function Returns confirm input to display. Overrides WebformDeleteFormBase::getConfirmInput
WebformVariantApplyForm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides WebformDeleteFormBase::getConfirmText
WebformVariantApplyForm::getDescription public function Returns additional text to display as a description. Overrides WebformDeleteFormBase::getDescription
WebformVariantApplyForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
WebformVariantApplyForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
WebformVariantApplyForm::getWarning public function Returns warning message to display. Overrides WebformDeleteFormBase::getWarning
WebformVariantApplyForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
WebformVariantApplyForm::validateForm public function Form validation handler. Overrides FormBase::validateForm