You are here

class WebformSubmissionsPurgeForm in Webform 8.5

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

Webform for webform submission purge webform.

Hierarchy

Expanded class hierarchy of WebformSubmissionsPurgeForm

1 file declares its use of WebformSubmissionsPurgeForm
WebformCliService.php in src/Commands/WebformCliService.php
1 string reference to 'WebformSubmissionsPurgeForm'
webform.routing.yml in ./webform.routing.yml
webform.routing.yml

File

src/Form/WebformSubmissionsPurgeForm.php, line 11

Namespace

Drupal\webform\Form
View source
class WebformSubmissionsPurgeForm extends WebformSubmissionsDeleteFormBase {

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

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this
      ->t('Purge all submissions?');
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $submission_total = $this
      ->getSubmissionTotal();
    if ($submission_total) {
      return parent::buildForm($form, $form_state);
    }
    else {
      $form['message'] = [
        '#type' => 'webform_message',
        '#message_type' => 'error',
        '#message_message' => $this
          ->t('There are no webform submissions.'),
      ];
      return $form;
    }
  }

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

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    $form_total = $this->entityTypeManager
      ->getStorage('webform')
      ->getQuery()
      ->count()
      ->execute();
    $submission_total = $this
      ->getSubmissionTotal();
    $t_args = [
      '@submission_total' => $submission_total,
      '@submissions' => $this
        ->formatPlural($submission_total, 'submission', 'submissions'),
      '@form_total' => $form_total,
      '@forms' => $this
        ->formatPlural($form_total, 'webform', 'webforms'),
    ];
    return [
      'title' => [
        '#markup' => $this
          ->t('This action will…'),
      ],
      'list' => [
        '#theme' => 'item_list',
        '#items' => [
          $this
            ->t('Remove @submission_total @submissions in @form_total @forms', $t_args),
          [
            '#markup' => '<em>' . $this
              ->t('Take a few minutes to complete') . '</em>',
          ],
        ],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getConfirmInput() {
    return [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Yes, I want to purge all submissions'),
      '#required' => TRUE,
    ];
  }

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

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return new Url('entity.webform_submission.collection');
  }

  /**
   * {@inheritdoc}
   */
  public function getFinishedMessage() {
    return $this
      ->t('Webform submissions purged.');
  }

  /**
   * {@inheritdoc}
   */
  protected function getSubmissionTotal() {
    if (!isset($this->submissionTotal)) {
      $this->submissionTotal = $this->entityTypeManager
        ->getStorage('webform_submission')
        ->getQuery()
        ->count()
        ->execute();
    }
    return $this->submissionTotal;
  }

}

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::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
WebformSubmissionsDeleteFormBase::$batchLimit protected property Default number of submission to be deleted during batch processing.
WebformSubmissionsDeleteFormBase::$entityTypeManager protected property The entity type manager.
WebformSubmissionsDeleteFormBase::$requestHandler protected property The webform request handler.
WebformSubmissionsDeleteFormBase::$sourceEntity protected property The webform source entity.
WebformSubmissionsDeleteFormBase::$submissionStorage protected property The webform submission storage.
WebformSubmissionsDeleteFormBase::$submissionTotal protected property Total number of submissions.
WebformSubmissionsDeleteFormBase::$webform protected property The webform entity.
WebformSubmissionsDeleteFormBase::batchFinish public function Batch API callback; Completed deletion.
WebformSubmissionsDeleteFormBase::batchProcess public function Batch API callback; Delete submissions.
WebformSubmissionsDeleteFormBase::batchSet public function Batch API; Initialize batch operations.
WebformSubmissionsDeleteFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create
WebformSubmissionsDeleteFormBase::getBatchLimit public function Get the number of submissions to be deleted with each batch.
WebformSubmissionsDeleteFormBase::getLabel public function Get webform or source entity label.
WebformSubmissionsDeleteFormBase::submitForm public function Form submission handler. Overrides FormInterface::submitForm
WebformSubmissionsDeleteFormBase::__construct public function Constructs a WebformResultsDeleteFormBase object.
WebformSubmissionsPurgeForm::buildForm public function Form constructor. Overrides WebformDeleteFormBase::buildForm
WebformSubmissionsPurgeForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
WebformSubmissionsPurgeForm::getConfirmInput public function Returns confirm input to display. Overrides WebformDeleteFormBase::getConfirmInput
WebformSubmissionsPurgeForm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides WebformSubmissionsDeleteFormBase::getConfirmText
WebformSubmissionsPurgeForm::getDescription public function Returns additional text to display as a description. Overrides WebformDeleteFormBase::getDescription
WebformSubmissionsPurgeForm::getFinishedMessage public function Message to displayed after submissions are deleted. Overrides WebformSubmissionsDeleteFormBase::getFinishedMessage
WebformSubmissionsPurgeForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
WebformSubmissionsPurgeForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
WebformSubmissionsPurgeForm::getSubmissionTotal protected function Get total number of submissions. Overrides WebformSubmissionsDeleteFormBase::getSubmissionTotal
WebformSubmissionsPurgeForm::getWarning public function Returns warning message to display. Overrides WebformDeleteFormBase::getWarning