You are here

Home » API reference » Webform 8.5 » WebformUiElementDeleteForm.php

class WebformUiElementDeleteForm in Webform 8.5

Same name and namespace in other branches
  1. 6.x modules/webform_ui/src/Form/WebformUiElementDeleteForm.php \Drupal\webform_ui\Form\WebformUiElementDeleteForm

Webform for deleting a webform element.

Hierarchy

Expanded class hierarchy of WebformUiElementDeleteForm

1 string reference to 'WebformUiElementDeleteForm'
webform_ui.routing.yml in modules/webform_ui/webform_ui.routing.yml
modules/webform_ui/webform_ui.routing.yml

File

modules/webform_ui/src/Form/WebformUiElementDeleteForm.php, line 20

Namespace

Drupal\webform_ui\Form
View source 
class WebformUiElementDeleteForm extends WebformDeleteFormBase {

  /**
   * The renderer.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * The webform element manager.
   *
   * @var \Drupal\webform\Plugin\WebformElementManagerInterface
   */
  protected $elementManager;

  /**
   * The webform element validator.
   *
   * @var \Drupal\webform\WebformEntityElementsValidatorInterface
   */
  protected $elementsValidator;

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

  /**
   * A webform element.
   *
   * @var \Drupal\webform\Plugin\WebformElementInterface
   */
  protected $webformElement;

  /**
   * The webform element key.
   *
   * @var string
   */
  protected $key;

  /**
   * The webform element.
   *
   * @var array
   */
  protected $element;

  /**
   * Constructs a WebformUiElementDeleteForm.
   *
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer.
   * @param \Drupal\webform\Plugin\WebformElementManagerInterface $element_manager
   *   The webform element manager.
   * @param \Drupal\webform\WebformEntityElementsValidatorInterface $elements_validator
   *   Webform element validator.
   */
  public function __construct(RendererInterface $renderer, WebformElementManagerInterface $element_manager, WebformEntityElementsValidatorInterface $elements_validator) {
    $this->renderer = $renderer;
    $this->elementManager = $element_manager;
    $this->elementsValidator = $elements_validator;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('renderer'), $container
      ->get('plugin.manager.webform.element'), $container
      ->get('webform.elements_validator'));
  }

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

  // Delete form.

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

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    if ($this
      ->isDialog()) {
      $t_args = [
        '@title' => $this
          ->getElementTitle(),
      ];
      return $this
        ->t("Delete the '@title' element?", $t_args);
    }
    else {
      $t_args = [
        '%webform' => $this->webform
          ->label(),
        '%title' => $this
          ->getElementTitle(),
      ];
      return $this
        ->t('Delete the %title element from the %webform webform?', $t_args);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getWarning() {
    $t_args = [
      '%title' => $this
        ->getElementTitle(),
    ];
    return [
      '#type' => 'webform_message',
      '#message_type' => 'warning',
      '#message_message' => $this
        ->t('Are you sure you want to delete the %title element?', $t_args) . '<br/>' . '<strong>' . $this
        ->t('This action cannot be undone.') . '</strong>',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    $element_plugin = $this
      ->getWebformElementPlugin();
    $items = [];
    $items[] = $this
      ->t('Remove this element');
    $items[] = $this
      ->t('Delete any submission data associated with this element');
    if ($element_plugin
      ->isContainer($this->element)) {
      $items[] = $this
        ->t('Delete all child elements');
    }
    if ($element_plugin instanceof WebformElementVariantInterface) {
      $items[] = $this
        ->t('Delete all related variants');
    }
    return [
      'title' => [
        '#markup' => $this
          ->t('This action will…'),
      ],
      'list' => [
        '#theme' => 'item_list',
        '#items' => $items,
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getDetails() {
    $elements = $this
      ->getDeletedElementsItemList($this->element['#webform_children']);
    if ($elements) {
      return [
        '#type' => 'details',
        '#title' => $this
          ->t('Nested elements being deleted'),
        'elements' => $elements,
      ];
    }
    else {
      return [];
    }
  }

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

  // Form methods.

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, WebformInterface $webform = NULL, $key = NULL) {
    $this->webform = $webform;
    $this->key = $key;
    $this->element = $webform
      ->getElement($key);
    if ($this->element === NULL) {
      throw new NotFoundHttpException();
    }
    $form = parent::buildForm($form, $form_state);
    $form = $this
      ->buildDialogConfirmForm($form, $form_state);
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this->webform
      ->deleteElement($this->key);
    $this->webform
      ->save();
    $this
      ->messenger()
      ->addStatus($this
      ->t('The webform element %title has been deleted.', [
      '%title' => $this
        ->getElementTitle(),
    ]));
    $query = [];

    // Variants require the entire page to be reloaded so that Variants tab
    // can be hidden.
    if ($this
      ->getWebformElementPlugin() instanceof WebformElementVariantInterface) {
      $query = [
        'reload' => 'true',
      ];
    }
    $form_state
      ->setRedirectUrl($this->webform
      ->toUrl('edit-form', [
      'query' => $query,
    ]));
  }

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

  // Helper methods.

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

  /**
   * Get deleted elements as item list.
   *
   * @param array $children
   *   An array child key.
   *
   * @return array
   *   A render array representing an item list of elements.
   */
  protected function getDeletedElementsItemList(array $children) {
    if (empty($children)) {
      return [];
    }
    $items = [];
    foreach ($children as $key) {
      $element = $this->webform
        ->getElement($key);
      if (isset($element['#title'])) {
        $title = new FormattableMarkup('@title (@key)', [
          '@title' => $element['#title'],
          '@key' => $key,
        ]);
      }
      else {
        $title = $key;
      }
      $items[$key]['title'] = [
        '#markup' => $title,
      ];
      if ($element['#webform_children']) {
        $items[$key]['items'] = $this
          ->getDeletedElementsItemList($element['#webform_children']);
      }
    }
    return [
      '#theme' => 'item_list',
      '#items' => $items,
    ];
  }

  /**
   * Get the webform element's title or key.
   *
   * @return string
   *   The webform element's title or key,
   */
  protected function getElementTitle() {
    return WebformElementHelper::getAdminTitle($this->element);
  }

  /**
   * Return the webform element plugin associated with this form.
   *
   * @return \Drupal\webform\Plugin\WebformElementInterface
   *   A webform element.
   */
  protected function getWebformElementPlugin() {
    return $this->elementManager
      ->getElementInstance($this->element);
  }

}

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::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.
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::getConfirmInput public function Returns confirm input to display. Overrides WebformDeleteFormInterface::getConfirmInput 3
WebformDeleteFormBase::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText 2
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
WebformUiElementDeleteForm::$element protected property The webform element.
WebformUiElementDeleteForm::$elementManager protected property The webform element manager.
WebformUiElementDeleteForm::$elementsValidator protected property The webform element validator.
WebformUiElementDeleteForm::$key protected property The webform element key.
WebformUiElementDeleteForm::$renderer protected property The renderer.
WebformUiElementDeleteForm::$webform protected property The webform containing the webform handler to be deleted.
WebformUiElementDeleteForm::$webformElement protected property A webform element.
WebformUiElementDeleteForm::buildForm public function Form constructor. Overrides WebformDeleteFormBase::buildForm
WebformUiElementDeleteForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
WebformUiElementDeleteForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
WebformUiElementDeleteForm::getDeletedElementsItemList protected function Get deleted elements as item list.
WebformUiElementDeleteForm::getDescription public function Returns additional text to display as a description. Overrides WebformDeleteFormBase::getDescription
WebformUiElementDeleteForm::getDetails public function Returns details to display. Overrides WebformDeleteFormBase::getDetails
WebformUiElementDeleteForm::getElementTitle protected function Get the webform element's title or key.
WebformUiElementDeleteForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
WebformUiElementDeleteForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
WebformUiElementDeleteForm::getWarning public function Returns warning message to display. Overrides WebformDeleteFormBase::getWarning
WebformUiElementDeleteForm::getWebformElementPlugin protected function Return the webform element plugin associated with this form.
WebformUiElementDeleteForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
WebformUiElementDeleteForm::__construct public function Constructs a WebformUiElementDeleteForm.