abstract class WebformDeleteFormBase in Webform 6.x

Same name and namespace in other branches

8.5 src/Form/WebformDeleteFormBase.php \Drupal\webform\Form\WebformDeleteFormBase

Provides a generic base class for a webform deletion form.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
  - class \Drupal\webform\Form\WebformDeleteFormBase implements WebformDeleteFormInterface uses WebformDialogFormTrait

Expanded class hierarchy of WebformDeleteFormBase

1 file declares its use of WebformDeleteFormBase

WebformUiElementDeleteForm.php in modules/webform_ui/src/Form/WebformUiElementDeleteForm.php

File

src/Form/WebformDeleteFormBase.php, line 12

Namespace

Drupal\webform\Form

View source

abstract class WebformDeleteFormBase extends ConfirmFormBase implements WebformDeleteFormInterface {
  use WebformDialogFormTrait;

  /**
   * {@inheritdoc}
   */
  public function getFormName() {
    return 'webform_delete';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['#attributes']['class'][] = 'confirmation';
    $form['#theme'] = 'confirm_form';
    $form[$this
      ->getFormName()] = [
      '#type' => 'hidden',
      '#value' => 1,
    ];

    // Title.
    $form['#title'] = $this
      ->getQuestion();

    // Warning.
    $form['warning'] = $this
      ->getWarning();

    // Description.
    $form['description'] = $this
      ->getDescription();

    // Details and confirm input.
    $details = $this
      ->getDetails();
    $confirm_input = $this
      ->getConfirmInput();
    if ($details) {
      $form['details'] = $details;
    }
    if (!$details && $confirm_input) {
      $form['hr'] = [
        '#markup' => '<p><hr/></p>',
      ];
    }
    if ($confirm_input) {
      $form['confirm'] = $confirm_input;
    }

    // Actions.
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->getConfirmText(),
      '#button_type' => 'primary',
    ];
    $form['actions']['cancel'] = ConfirmFormHelper::buildCancelLink($this, $this
      ->getRequest());
    return $this
      ->buildDialogConfirmForm($form, $form_state);
  }

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

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getDetails() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getConfirmInput() {
    return [];
  }

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

}

Members

Name	Modifiers	Type	Description	Overrides
ConfirmFormBase::getCancelText	public	function	Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText	2
ConfirmFormInterface::getCancelUrl	public	function	Returns the route to go to if the user cancels the action.	38
ConfirmFormInterface::getQuestion	public	function	Returns the question to ask the user.	39
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::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	105
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.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	72
FormInterface::getFormId	public	function	Returns a unique string identifying the form.	264
FormInterface::submitForm	public	function	Form submission handler.	214
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.
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.
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::buildForm	public	function	Form constructor. Overrides ConfirmFormBase::buildForm	6
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::getDescription	public	function	Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription	6
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
WebformDeleteFormBase::getWarning	public	function	Returns warning message to display. Overrides WebformDeleteFormInterface::getWarning	6
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

You are here

abstract class WebformDeleteFormBase in Webform 6.x

Hierarchy

File

Namespace

Members

API Navigation