class WebformSubmissionDeleteForm in Webform 6.x
Same name and namespace in other branches
- 8.5 src/Form/WebformSubmissionDeleteForm.php \Drupal\webform\Form\WebformSubmissionDeleteForm
Provides a confirmation webform for deleting a webform submission.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
- class \Drupal\Core\Entity\ContentEntityForm implements ContentEntityFormInterface
- class \Drupal\Core\Entity\ContentEntityConfirmFormBase implements ConfirmFormInterface
- class \Drupal\Core\Entity\ContentEntityDeleteForm uses EntityDeleteFormTrait
- class \Drupal\webform\Form\WebformSubmissionDeleteForm implements WebformDeleteFormInterface uses WebformDialogFormTrait
- class \Drupal\Core\Entity\ContentEntityDeleteForm uses EntityDeleteFormTrait
- class \Drupal\Core\Entity\ContentEntityConfirmFormBase implements ConfirmFormInterface
- class \Drupal\Core\Entity\ContentEntityForm implements ContentEntityFormInterface
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
Expanded class hierarchy of WebformSubmissionDeleteForm
File
- src/
Form/ WebformSubmissionDeleteForm.php, line 13
Namespace
Drupal\webform\FormView source
class WebformSubmissionDeleteForm extends ContentEntityDeleteForm implements WebformDeleteFormInterface {
use WebformDialogFormTrait;
/**
* The webform entity.
*
* @var \Drupal\webform\WebformInterface
*/
protected $webform;
/**
* The webform submission entity.
*
* @var \Drupal\webform\WebformSubmissionInterface
*/
protected $webformSubmission;
/**
* The webform source entity.
*
* @var \Drupal\Core\Entity\EntityInterface
*/
protected $sourceEntity;
/**
* The webform request handler.
*
* @var \Drupal\webform\WebformRequestInterface
*/
protected $requestHandler;
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
$instance = parent::create($container);
$instance->requestHandler = $container
->get('webform.request');
return $instance;
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
list($this->webformSubmission, $this->sourceEntity) = $this->requestHandler
->getWebformSubmissionEntities();
$this->webform = $this->webformSubmission
->getWebform();
$form['warning'] = $this
->getWarning();
$form = parent::buildForm($form, $form_state);
$form['description'] = $this
->getDescription();
return $this
->buildDialogConfirmForm($form, $form_state);
}
/**
* {@inheritdoc}
*/
protected function actions(array $form, FormStateInterface $form_state) {
// Issue #2582295: Confirmation cancel links are incorrect if installed in
// a subdirectory
// Work-around: Remove subdirectory from destination before generating
// actions.
$request = $this
->getRequest();
$destination = $request->query
->get('destination');
if ($destination) {
// Remove subdirectory from destination.
$update_destination = preg_replace('/^' . preg_quote(base_path(), '/') . '/', '/', $destination);
$request->query
->set('destination', $update_destination);
$actions = parent::actions($form, $form_state);
$request->query
->set('destination', $destination);
return $actions;
}
else {
return parent::actions($form, $form_state);
}
}
/**
* {@inheritdoc}
*/
public function getQuestion() {
$t_args = [
'%label' => $this
->getEntity()
->label(),
];
return $this
->t('Delete %label?', $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() {
// @see \Drupal\webform\Form\WebformSubmissionDeleteMultipleForm::getDescription
return [
'title' => [
'#markup' => $this
->t('This action will…'),
],
'list' => [
'#theme' => 'item_list',
'#items' => [
$this
->t('Remove records from the database'),
$this
->t('Delete any uploaded files'),
$this
->t('Cancel all pending actions'),
],
],
];
}
/**
* {@inheritdoc}
*/
public function getDetails() {
return [];
}
/**
* {@inheritdoc}
*/
public function getConfirmInput() {
return [];
}
/**
* {@inheritdoc}
*/
protected function getDeletionMessage() {
return $this
->t('%label has been deleted.', [
'%label' => $this->webformSubmission
->label(),
]);
}
/**
* {@inheritdoc}
*/
public function getCancelUrl() {
if ($this->webform
->access('submission_view_own') || $this->webform
->access('submission_view_any')) {
$base_route_name = strpos(\Drupal::routeMatch()
->getRouteName(), 'webform.user.submission.delete') !== FALSE ? 'webform.user.submissions' : 'webform.results_submissions';
return $this->requestHandler
->getUrl($this->webform, $this->sourceEntity, $base_route_name);
}
elseif ($this->sourceEntity && $this->sourceEntity
->hasLinkTemplate('canonical') && $this->sourceEntity
->access('view')) {
return $this->sourceEntity
->toUrl();
}
elseif ($this->webform
->access('view')) {
return $this->webform
->toUrl();
}
else {
return Url::fromRoute('<front>');
}
}
/**
* {@inheritdoc}
*/
protected function getRedirectUrl() {
return $this
->getCancelUrl();
}
/**
* {@inheritdoc}
*/
protected function logDeletionMessage() {
// Deletion logging is handled via WebformSubmissionStorage.
// @see \Drupal\webform\WebformSubmissionStorage::delete
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ConfigDependencyDeleteFormTrait:: |
protected | function | Adds form elements to list affected configuration entities. | |
ConfigDependencyDeleteFormTrait:: |
abstract protected | function | Translates a string to the current language or to a given language. | |
ContentEntityConfirmFormBase:: |
public | function | The delete() method is not used in ContentEntityConfirmFormBase. This overrides the default implementation that redirects to the delete-form confirmation form. | |
ContentEntityConfirmFormBase:: |
public | function |
Gets the actual form array to be built. Overrides ContentEntityForm:: |
|
ContentEntityConfirmFormBase:: |
public | function |
Returns a string identifying the base form. Overrides EntityForm:: |
|
ContentEntityConfirmFormBase:: |
public | function |
Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface:: |
|
ContentEntityConfirmFormBase:: |
public | function |
Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface:: |
|
ContentEntityConfirmFormBase:: |
public | function |
The save() method is not used in ContentEntityConfirmFormBase. This
overrides the default implementation that saves the entity. Overrides EntityForm:: |
|
ContentEntityConfirmFormBase:: |
public | function |
Button-level validation handlers are highly discouraged for entity forms,
as they will prevent entity validation from running. If the entity is going
to be saved during the form submission, this method should be manually
invoked from the button-level… Overrides ContentEntityForm:: |
|
ContentEntityDeleteForm:: |
public | function |
This is the default entity object builder function. It is called before any
other submit handler to build the new entity object to be used by the
following submit handlers. At this point of the form workflow the entity is
validated and the form state… Overrides EntityDeleteFormTrait:: |
|
ContentEntityForm:: |
protected | property |
The entity being used by this form. Overrides EntityForm:: |
9 |
ContentEntityForm:: |
protected | property | The entity repository service. | |
ContentEntityForm:: |
protected | property | The entity type bundle info service. | |
ContentEntityForm:: |
protected | property | The time service. | |
ContentEntityForm:: |
protected | function | Add revision form fields if the entity enabled the UI. | |
ContentEntityForm:: |
public | function |
Builds an updated entity object based upon the submitted form values. Overrides EntityForm:: |
4 |
ContentEntityForm:: |
protected | function |
Copies top-level form values to entity properties. Overrides EntityForm:: |
|
ContentEntityForm:: |
protected | function | Flags violations for the current form. | 4 |
ContentEntityForm:: |
protected | function | Returns the bundle entity of the entity, or NULL if there is none. | |
ContentEntityForm:: |
protected | function | Gets the names of all fields edited in the form. | 4 |
ContentEntityForm:: |
public | function |
Gets the form display. Overrides ContentEntityFormInterface:: |
|
ContentEntityForm:: |
public | function |
Gets the code identifying the active form language. Overrides ContentEntityFormInterface:: |
|
ContentEntityForm:: |
protected | function | Should new revisions created on default. | |
ContentEntityForm:: |
protected | function |
Initializes the form state and the entity before the first form build. Overrides EntityForm:: |
1 |
ContentEntityForm:: |
protected | function | Initializes form language code values. | |
ContentEntityForm:: |
public | function |
Checks whether the current form language matches the entity one. Overrides ContentEntityFormInterface:: |
|
ContentEntityForm:: |
protected | function |
Prepares the entity object before the form is built first. Overrides EntityForm:: |
1 |
ContentEntityForm:: |
public | function |
Sets the form display. Overrides ContentEntityFormInterface:: |
|
ContentEntityForm:: |
protected | function | Checks whether the revision form fields should be added to the form. | |
ContentEntityForm:: |
public | function | Updates the changed time of the entity. | |
ContentEntityForm:: |
public | function | Updates the form language to reflect any change to the entity language. | |
ContentEntityForm:: |
public | function | Constructs a ContentEntityForm object. | 9 |
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
EntityDeleteFormTrait:: |
public | function | Aliased as: traitGetCancelUrl | 3 |
EntityDeleteFormTrait:: |
public | function | 1 | |
EntityDeleteFormTrait:: |
protected | function | Gets the message to display to the user after deleting the entity. Aliased as: traitGetDeletionMessage | 3 |
EntityDeleteFormTrait:: |
abstract public | function | Gets the entity of this form. | |
EntityDeleteFormTrait:: |
public | function | Aliased as: traitGetQuestion | 4 |
EntityDeleteFormTrait:: |
protected | function | Logs a message about the deleted entity. Aliased as: traitLogDeletionMessage | 2 |
EntityDeleteFormTrait:: |
abstract protected | function | Gets the logger for a specific channel. | |
EntityForm:: |
protected | property | The entity type manager. | 3 |
EntityForm:: |
protected | property | The module handler service. | |
EntityForm:: |
protected | property | The name of the current operation. | |
EntityForm:: |
protected | function | Returns the action form element for the current entity form. | |
EntityForm:: |
public | function | Form element #after_build callback: Updates the entity with submitted data. | |
EntityForm:: |
public | function |
Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface:: |
3 |
EntityForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
12 |
EntityForm:: |
public | function |
Gets the operation identifying the form. Overrides EntityFormInterface:: |
|
EntityForm:: |
protected | function | Invokes the specified prepare hook variant. | |
EntityForm:: |
public | function | Process callback: assigns weights and hides extra fields. | |
EntityForm:: |
public | function |
Sets the form entity. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the entity type manager for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the module handler for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the operation for this form. Overrides EntityFormInterface:: |
|
FormBase:: |
protected | property | The config factory. | 3 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Retrieves a configuration object. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 3 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Returns a redirect response object for the specified route. | |
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
WebformAjaxFormTrait:: |
protected | function | Queue announcement with Ajax response. | |
WebformAjaxFormTrait:: |
protected | function | Add Ajax support to a form. | |
WebformAjaxFormTrait:: |
protected | function | Create an AjaxResponse or WebformAjaxResponse object. | |
WebformAjaxFormTrait:: |
protected | function | Get announcements. | |
WebformAjaxFormTrait:: |
protected | function | Get default ajax callback settings. | 1 |
WebformAjaxFormTrait:: |
protected | function | Get redirect URL from the form's state. | |
WebformAjaxFormTrait:: |
protected | function | Get the form's Ajax wrapper id. | 1 |
WebformAjaxFormTrait:: |
protected | function | Determine if Ajax callback is callable. | |
WebformAjaxFormTrait:: |
protected | function | Is the current request for an Ajax modal/dialog. | |
WebformAjaxFormTrait:: |
protected | function | Is the current request for an off canvas dialog. | |
WebformAjaxFormTrait:: |
protected | function | Handle missing Ajax callback. | |
WebformAjaxFormTrait:: |
protected | function | Replace form via an Ajax response. | 1 |
WebformAjaxFormTrait:: |
protected | function | Reset announcements. | |
WebformAjaxFormTrait:: |
protected | function | Set announcements. | |
WebformAjaxFormTrait:: |
public | function | Submit form #ajax callback. | 1 |
WebformAjaxFormTrait:: |
public | function | Validate form #ajax callback. | 1 |
WebformDialogFormTrait:: |
protected | function | Add modal dialog support to a confirm form. | |
WebformDialogFormTrait:: |
protected | function | Build webform dialog delete link. | |
WebformDialogFormTrait:: |
protected | function | Add modal dialog support to a form. | |
WebformDialogFormTrait:: |
public | function |
Cancel form #ajax callback. Overrides WebformAjaxFormTrait:: |
1 |
WebformDialogFormTrait:: |
public | function | Close dialog. | |
WebformDialogFormTrait:: |
protected | function |
Returns if webform is using Ajax. Overrides WebformAjaxFormTrait:: |
1 |
WebformDialogFormTrait:: |
public | function |
Empty submit callback used to only have the submit button to use an #ajax submit callback. Overrides WebformAjaxFormTrait:: |
|
WebformDialogFormTrait:: |
public | function | Validate callback to clear validation errors. | 2 |
WebformSubmissionDeleteForm:: |
protected | property | The webform request handler. | |
WebformSubmissionDeleteForm:: |
protected | property | The webform source entity. | |
WebformSubmissionDeleteForm:: |
protected | property | The webform entity. | |
WebformSubmissionDeleteForm:: |
protected | property | The webform submission entity. | |
WebformSubmissionDeleteForm:: |
protected | function |
Returns an array of supported actions for the current entity form. Overrides ContentEntityConfirmFormBase:: |
|
WebformSubmissionDeleteForm:: |
public | function |
Form constructor. Overrides ContentEntityDeleteForm:: |
|
WebformSubmissionDeleteForm:: |
public static | function |
Instantiates a new instance of this class. Overrides ContentEntityForm:: |
|
WebformSubmissionDeleteForm:: |
public | function |
Returns the route to go to if the user cancels the action. Overrides ContentEntityDeleteForm:: |
|
WebformSubmissionDeleteForm:: |
public | function |
Returns confirm input to display. Overrides WebformDeleteFormInterface:: |
|
WebformSubmissionDeleteForm:: |
protected | function |
Overrides ContentEntityDeleteForm:: |
|
WebformSubmissionDeleteForm:: |
public | function |
Returns additional text to display as a description. Overrides ContentEntityConfirmFormBase:: |
|
WebformSubmissionDeleteForm:: |
public | function |
Returns details to display. Overrides WebformDeleteFormInterface:: |
|
WebformSubmissionDeleteForm:: |
public | function |
Returns the question to ask the user. Overrides ContentEntityDeleteForm:: |
|
WebformSubmissionDeleteForm:: |
protected | function |
Returns the URL where the user should be redirected after deletion. Overrides EntityDeleteFormTrait:: |
|
WebformSubmissionDeleteForm:: |
public | function |
Returns warning message to display. Overrides WebformDeleteFormInterface:: |
|
WebformSubmissionDeleteForm:: |
protected | function |
Overrides ContentEntityDeleteForm:: |