class WebformHandlerDeleteForm in Webform 6.x

Same name and namespace in other branches

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

Form for deleting a webform handler.

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
    class \Drupal\webform\Form\WebformHandlerDeleteForm

Expanded class hierarchy of WebformHandlerDeleteForm

1 string reference to 'WebformHandlerDeleteForm'

webform.routing.yml in ./webform.routing.yml: webform.routing.yml

File

src/Form/WebformHandlerDeleteForm.php, line 11

Namespace

Drupal\webform\Form

View source

class WebformHandlerDeleteForm extends WebformDeleteFormBase {

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

  /**
   * The webform handler to be deleted.
   *
   * @var \Drupal\webform\Plugin\WebformHandlerInterface
   */
  protected $webformHandler;

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

  /**
   * {@inheritdoc}
   */
  public function getWarning() {
    $t_args = [
      '%title' => $this->webformHandler
        ->label(),
    ];
    return [
      '#type' => 'webform_message',
      '#message_type' => 'warning',
      '#message_message' => $this
        ->t('Are you sure you want to delete the %title handler?', $t_args) . '<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
            ->t('Remove this handler'),
          $this
            ->t('Cancel all pending actions'),
        ],
      ],
    ];
  }

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

  // Form methods.

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, WebformInterface $webform = NULL, $webform_handler = NULL) {
    $this->webform = $webform;
    $this->webformHandler = $this->webform
      ->getHandler($webform_handler);
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this->webform
      ->deleteWebformHandler($this->webformHandler);
    $this
      ->messenger()
      ->addStatus($this
      ->t('The webform handler %name has been deleted.', [
      '%name' => $this->webformHandler
        ->label(),
    ]));
    $form_state
      ->setRedirectUrl($this->webform
      ->toUrl('handlers'));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfirmFormBase::getCancelText	public	function	Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText	2
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
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::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::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
WebformHandlerDeleteForm::$webform	protected	property	The webform containing the webform handler to be deleted.
WebformHandlerDeleteForm::$webformHandler	protected	property	The webform handler to be deleted.
WebformHandlerDeleteForm::buildForm	public	function	Form constructor. Overrides WebformDeleteFormBase::buildForm
WebformHandlerDeleteForm::getCancelUrl	public	function	Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
WebformHandlerDeleteForm::getDescription	public	function	Returns additional text to display as a description. Overrides WebformDeleteFormBase::getDescription
WebformHandlerDeleteForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
WebformHandlerDeleteForm::getQuestion	public	function	Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
WebformHandlerDeleteForm::getWarning	public	function	Returns warning message to display. Overrides WebformDeleteFormBase::getWarning
WebformHandlerDeleteForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm

You are here

class WebformHandlerDeleteForm in Webform 6.x

Hierarchy

File

Namespace

Members

API Navigation