abstract class WebformConfigEntityDeleteFormBase in Webform 8.5

Same name and namespace in other branches

6.x src/Form/WebformConfigEntityDeleteFormBase.php \Drupal\webform\Form\WebformConfigEntityDeleteFormBase

Provides a generic base class for a webform entity deletion form.

Copied from: \Drupal\Core\Entity\EntityConfirmFormBase.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
  - class \Drupal\webform\Form\WebformConfigEntityDeleteFormBase implements WebformDeleteFormInterface uses EntityDeleteFormTrait, WebformDialogFormTrait

Expanded class hierarchy of WebformConfigEntityDeleteFormBase

6 files declare their use of WebformConfigEntityDeleteFormBase

WebformAccessGroupDeleteForm.php in modules/webform_access/src/WebformAccessGroupDeleteForm.php
WebformAccessTypeDeleteForm.php in modules/webform_access/src/WebformAccessTypeDeleteForm.php
WebformEntityDeleteForm.php in src/WebformEntityDeleteForm.php
WebformImageSelectImagesDeleteForm.php in modules/webform_image_select/src/WebformImageSelectImagesDeleteForm.php
WebformOptionsCustomDeleteForm.php in modules/webform_options_custom/src/WebformOptionsCustomDeleteForm.php

... See full list

File

src/Form/WebformConfigEntityDeleteFormBase.php, line 15

Namespace

Drupal\webform\Form

View source

abstract class WebformConfigEntityDeleteFormBase extends EntityForm implements WebformDeleteFormInterface {
  use EntityDeleteFormTrait;
  use WebformDialogFormTrait;

  /**
   * Display confirmation checkbox.
   *
   * @var bool
   */
  protected $confirmCheckbox = TRUE;

  /**
   * {@inheritdoc}
   */
  public function getBaseFormId() {
    return $this->entity
      ->getEntityTypeId() . '_confirm_form';
  }

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    if ($this
      ->isDialog()) {
      $t_args = [
        '@entity-type' => $this
          ->getEntity()
          ->getEntityType()
          ->getSingularLabel(),
        '@label' => $this
          ->getEntity()
          ->label(),
      ];
      return $this
        ->t("Delete '@label' @entity-type?", $t_args);
    }
    else {
      $t_args = [
        '@entity-type' => $this
          ->getEntity()
          ->getEntityType()
          ->getSingularLabel(),
        '%label' => $this
          ->getEntity()
          ->label(),
      ];
      return $this
        ->t('Delete %label @entity-type?', $t_args);
    }
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function getConfirmInput() {
    $t_args = [
      '@entity-type' => $this
        ->getEntity()
        ->getEntityType()
        ->getSingularLabel(),
      '%label' => $this
        ->getEntity()
        ->label(),
    ];
    if ($this->confirmCheckbox) {
      return [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Yes, I want to delete the %label @entity-type', $t_args),
        '#required' => TRUE,
      ];
    }
    else {
      return [];
    }
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $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;
    }

    // Dialog.
    return $this
      ->buildDialogConfirmForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  protected function actions(array $form, FormStateInterface $form_state) {
    return [
      'submit' => [
        '#type' => 'submit',
        '#value' => $this
          ->getConfirmText(),
        '#submit' => [
          [
            $this,
            'submitForm',
          ],
        ],
      ],
      'cancel' => ConfirmFormHelper::buildCancelLink($this, $this
        ->getRequest()),
    ];
  }

  /**
   * {@inheritdoc}
   *
   * The save() method is not used in EntityConfirmFormBase. This overrides the
   * default implementation that saves the entity.
   *
   * Confirmation forms should override submitForm() instead for their logic.
   */
  public function save(array $form, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   *
   * The delete() method is not used in EntityConfirmFormBase. This overrides
   * the default implementation that redirects to the delete-form confirmation
   * form.
   *
   * Confirmation forms should override submitForm() instead for their logic.
   */
  public function delete(array $form, FormStateInterface $form_state) {
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigDependencyDeleteFormTrait::addDependencyListsToForm	protected	function	Adds form elements to list affected configuration entities.
ConfigDependencyDeleteFormTrait::t	abstract protected	function	Translates a string to the current language or to a given language.
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
EntityDeleteFormTrait::getCancelUrl	public	function		3
EntityDeleteFormTrait::getDeletionMessage	protected	function	Gets the message to display to the user after deleting the entity.	3
EntityDeleteFormTrait::getEntity	abstract public	function	Gets the entity of this form.
EntityDeleteFormTrait::getRedirectUrl	protected	function	Returns the URL where the user should be redirected after deletion.	5
EntityDeleteFormTrait::logDeletionMessage	protected	function	Logs a message about the deleted entity.	2
EntityDeleteFormTrait::logger	abstract protected	function	Gets the logger for a specific channel.
EntityDeleteFormTrait::submitForm	public	function		4
EntityForm::$entity	protected	property	The entity being used by this form.	7
EntityForm::$entityTypeManager	protected	property	The entity type manager.	3
EntityForm::$moduleHandler	protected	property	The module handler service.
EntityForm::$operation	protected	property	The name of the current operation.
EntityForm::$privateEntityManager	private	property	The entity manager.
EntityForm::actionsElement	protected	function	Returns the action form element for the current entity form.
EntityForm::afterBuild	public	function	Form element #after_build callback: Updates the entity with submitted data.
EntityForm::buildEntity	public	function	Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface::buildEntity	2
EntityForm::copyFormValuesToEntity	protected	function	Copies top-level form values to entity properties	7
EntityForm::form	public	function	Gets the actual form array to be built.	30
EntityForm::getEntityFromRouteMatch	public	function	Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface::getEntityFromRouteMatch	1
EntityForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId	10
EntityForm::getOperation	public	function	Gets the operation identifying the form. Overrides EntityFormInterface::getOperation
EntityForm::init	protected	function	Initialize the form state and the entity before the first form build.	3
EntityForm::prepareEntity	protected	function	Prepares the entity object before the form is built first.	3
EntityForm::prepareInvokeAll	protected	function	Invokes the specified prepare hook variant.
EntityForm::processForm	public	function	Process callback: assigns weights and hides extra fields.
EntityForm::setEntity	public	function	Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::setEntityManager	public	function	Sets the entity manager for this form. Overrides EntityFormInterface::setEntityManager
EntityForm::setEntityTypeManager	public	function	Sets the entity type manager for this form. Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler	public	function	Sets the module handler for this form. Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation	public	function	Sets the operation for this form. Overrides EntityFormInterface::setOperation
EntityForm::__get	public	function
EntityForm::__set	public	function
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::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
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
WebformConfigEntityDeleteFormBase::$confirmCheckbox	protected	property	Display confirmation checkbox.	2
WebformConfigEntityDeleteFormBase::actions	protected	function	Returns an array of supported actions for the current entity form. Overrides EntityForm::actions
WebformConfigEntityDeleteFormBase::buildForm	public	function	Form constructor. Overrides EntityForm::buildForm
WebformConfigEntityDeleteFormBase::delete	public	function	The delete() method is not used in EntityConfirmFormBase. This overrides the default implementation that redirects to the delete-form confirmation form.
WebformConfigEntityDeleteFormBase::getBaseFormId	public	function	Returns a string identifying the base form. Overrides EntityForm::getBaseFormId
WebformConfigEntityDeleteFormBase::getCancelText	public	function	Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText
WebformConfigEntityDeleteFormBase::getConfirmInput	public	function	Returns confirm input to display. Overrides WebformDeleteFormInterface::getConfirmInput
WebformConfigEntityDeleteFormBase::getConfirmText	public	function	Returns a caption for the button that confirms the action. Overrides EntityDeleteFormTrait::getConfirmText
WebformConfigEntityDeleteFormBase::getDescription	public	function	Returns additional text to display as a description. Overrides WebformDeleteFormInterface::getDescription	6
WebformConfigEntityDeleteFormBase::getDetails	public	function	Returns details to display. Overrides WebformDeleteFormInterface::getDetails	3
WebformConfigEntityDeleteFormBase::getFormName	public	function	Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
WebformConfigEntityDeleteFormBase::getQuestion	public	function	Returns the question to ask the user. Overrides EntityDeleteFormTrait::getQuestion
WebformConfigEntityDeleteFormBase::getWarning	public	function	Returns warning message to display. Overrides WebformDeleteFormInterface::getWarning
WebformConfigEntityDeleteFormBase::save	public	function	The save() method is not used in EntityConfirmFormBase. This overrides the default implementation that saves the entity. Overrides EntityForm::save
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 WebformConfigEntityDeleteFormBase in Webform 8.5

Hierarchy

File

Namespace

Members

API Navigation