class YamlFormSubmissionsPurgeForm in YAML Form 8

Form for form submission purge form.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
  - class \Drupal\yamlform\Form\YamlFormSubmissionsDeleteFormBase
    class \Drupal\yamlform\Form\YamlFormSubmissionsPurgeForm

Expanded class hierarchy of YamlFormSubmissionsPurgeForm

1 file declares its use of YamlFormSubmissionsPurgeForm

yamlform.drush.inc in drush/yamlform.drush.inc: YAML Form module drush commands.

1 string reference to 'YamlFormSubmissionsPurgeForm'

yamlform.routing.yml in ./yamlform.routing.yml: yamlform.routing.yml

File

src/Form/YamlFormSubmissionsPurgeForm.php, line 11

Namespace

Drupal\yamlform\Form

View source

class YamlFormSubmissionsPurgeForm extends YamlFormSubmissionsDeleteFormBase {

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

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this
      ->t('Are you sure you want to delete all submissions?');
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);
    $submission_total = \Drupal::entityQuery('yamlform_submission')
      ->count()
      ->execute();
    $form_total = \Drupal::entityQuery('yamlform')
      ->count()
      ->execute();
    $t_args = [
      '@submission_total' => $submission_total,
      '@submissions' => $this
        ->formatPlural($submission_total, $this
        ->t('submission'), $this
        ->t('submissions')),
      '@form_total' => $form_total,
      '@forms' => $this
        ->formatPlural($form_total, $this
        ->t('form'), $this
        ->t('forms')),
    ];
    $form['confirm'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Are you sure you want to delete @submission_total @submissions in @form_total @forms?', $t_args),
      '#required' => TRUE,
      '#weight' => -10,
    ];
    return $form;
  }

}

Members

Name	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.
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::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::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
YamlFormSubmissionsDeleteFormBase::__construct	public	function	Constructs a new YamlFormResultsDeleteBaseForm object.
YamlFormSubmissionsPurgeForm::buildForm	public	function	Form constructor. Overrides YamlFormSubmissionsDeleteFormBase::buildForm
YamlFormSubmissionsPurgeForm::getCancelUrl	public	function	Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
YamlFormSubmissionsPurgeForm::getConfirmText	public	function	Returns a caption for the button that confirms the action. Overrides YamlFormSubmissionsDeleteFormBase::getConfirmText
YamlFormSubmissionsPurgeForm::getFinishedMessage	public	function	Message to displayed after submissions are deleted. Overrides YamlFormSubmissionsDeleteFormBase::getFinishedMessage
YamlFormSubmissionsPurgeForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
YamlFormSubmissionsPurgeForm::getQuestion	public	function	Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion

You are here

class YamlFormSubmissionsPurgeForm in YAML Form 8

Hierarchy

File

Namespace

Members

API Navigation