You are here

Home » API reference » YAML Form 8 » YamlFormResultsClearForm.php

class YamlFormResultsClearForm in YAML Form 8

Form for form results clear form.

Hierarchy

Expanded class hierarchy of YamlFormResultsClearForm

1 file declares its use of YamlFormResultsClearForm
yamlform.drush.inc in drush/yamlform.drush.inc
YAML Form module drush commands.
2 string references to 'YamlFormResultsClearForm'
yamlform.routing.yml in ./yamlform.routing.yml
yamlform.routing.yml
yamlform_node.routing.yml in modules/yamlform_node/yamlform_node.routing.yml
modules/yamlform_node/yamlform_node.routing.yml

File

src/Form/YamlFormResultsClearForm.php, line 10

Namespace

Drupal\yamlform\Form
View source 
class YamlFormResultsClearForm extends YamlFormSubmissionsDeleteFormBase {

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

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    if ($this->sourceEntity) {
      $t_args = [
        '%title' => $this->sourceEntity
          ->label(),
      ];
    }
    else {
      $t_args = [
        '%title' => $this->yamlform
          ->label(),
      ];
    }
    return $this
      ->t('Are you sure you want to delete all submissions to the %title form?', $t_args);
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    $route_name = $this->requestHandler
      ->getRouteName($this->yamlform, $this->sourceEntity, 'yamlform.results_submissions');
    $route_parameters = $this->requestHandler
      ->getRouteParameters($this->yamlform, $this->sourceEntity);
    return new Url($route_name, $route_parameters);
  }

  /**
   * {@inheritdoc}
   */
  public function getMessage() {
    if ($this->sourceEntity) {
      $t_args = [
        '%title' => $this->sourceEntity
          ->label(),
      ];
    }
    else {
      $t_args = [
        '%title' => $this->yamlform
          ->label(),
      ];
    }
    $this
      ->t('Form %title submissions cleared.', $t_args);
  }

}

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
ConfirmFormBase::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormInterface::getDescription 11
ConfirmFormBase::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
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.
YamlFormResultsClearForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
YamlFormResultsClearForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
YamlFormResultsClearForm::getMessage public function
YamlFormResultsClearForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
YamlFormSubmissionsDeleteFormBase::$batchLimit protected property Default number of submission to be deleted during batch processing.
YamlFormSubmissionsDeleteFormBase::$requestHandler protected property Form request handler.
YamlFormSubmissionsDeleteFormBase::$sourceEntity protected property The form source entity.
YamlFormSubmissionsDeleteFormBase::$submissionStorage protected property The form submission storage.
YamlFormSubmissionsDeleteFormBase::$yamlform protected property The form entity.
YamlFormSubmissionsDeleteFormBase::batchFinish public function Batch API callback; Completed deletion.
YamlFormSubmissionsDeleteFormBase::batchProcess public function Batch API callback; Delete submissions.
YamlFormSubmissionsDeleteFormBase::batchSet public function Batch API; Initialize batch operations.
YamlFormSubmissionsDeleteFormBase::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm 1
YamlFormSubmissionsDeleteFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create
YamlFormSubmissionsDeleteFormBase::getBatchLimit public function Get the number of submissions to be deleted with each batch.
YamlFormSubmissionsDeleteFormBase::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText 1
YamlFormSubmissionsDeleteFormBase::getFinishedMessage public function Message to displayed after submissions are deleted. 1
YamlFormSubmissionsDeleteFormBase::submitForm public function Form submission handler. Overrides FormInterface::submitForm
YamlFormSubmissionsDeleteFormBase::__construct public function Constructs a new YamlFormResultsDeleteBaseForm object.