Same name and namespace in other branches
- 8.9.x core/lib/Drupal/Core/Entity/EntityConfirmFormBase.php \Drupal\Core\Entity\EntityConfirmFormBase
- 9 core/lib/Drupal/Core/Entity/EntityConfirmFormBase.php \Drupal\Core\Entity\EntityConfirmFormBase
Provides a generic base class for an entity-based confirmation form.
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\EntityConfirmFormBase implements ConfirmFormInterface
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
Expanded class hierarchy of EntityConfirmFormBase
Related topics
6 files declare their use of EntityConfirmFormBase
- BreakLockForm.php in core/
modules/ views_ui/ src/ Form/ BreakLockForm.php - FilterDisableForm.php in core/
modules/ filter/ src/ Form/ FilterDisableForm.php - ImageStyleFlushForm.php in core/
modules/ image/ src/ Form/ ImageStyleFlushForm.php - VocabularyResetForm.php in core/
modules/ taxonomy/ src/ Form/ VocabularyResetForm.php - WorkflowDeleteForm.php in core/
modules/ workflows/ src/ Form/ WorkflowDeleteForm.php
File
- core/
lib/ Drupal/ Core/ Entity/ EntityConfirmFormBase.php, line 14
Namespace
Drupal\Core\EntityView source
abstract class EntityConfirmFormBase extends EntityForm implements ConfirmFormInterface {
/**
* {@inheritdoc}
*/
public function getBaseFormId() {
return $this->entity
->getEntityTypeId() . '_confirm_form';
}
/**
* {@inheritdoc}
*/
public function getDescription() {
return $this
->t('This action cannot be undone.');
}
/**
* {@inheritdoc}
*/
public function getConfirmText() {
return $this
->t('Confirm');
}
/**
* {@inheritdoc}
*/
public function getCancelText() {
return $this
->t('Cancel');
}
/**
* {@inheritdoc}
*/
public function getFormName() {
return 'confirm';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$form = parent::buildForm($form, $form_state);
$form['#title'] = $this
->getQuestion();
$form['#attributes']['class'][] = 'confirmation';
$form['description'] = [
'#markup' => $this
->getDescription(),
];
$form[$this
->getFormName()] = [
'#type' => 'hidden',
'#value' => 1,
];
// By default, render the form using theme_confirm_form().
if (!isset($form['#theme'])) {
$form['#theme'] = 'confirm_form';
}
return $form;
}
/**
* {@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 |
---|---|---|---|---|
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
EntityForm:: |
public | function |
Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface:: |
4 |
EntityForm:: |
protected | function | Copies top-level form values to entity properties. | 9 |
EntityForm:: |
public | function |
Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface:: |
1 |
EntityConfirmFormBase:: |
public | function |
Form constructor. Overrides EntityForm:: |
4 |
EntityForm:: |
public | function | Form element #after_build callback: Updates the entity with submitted data. | |
FormBase:: |
public | function |
Form validation handler. Overrides FormInterface:: |
47 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
EntityForm:: |
public | function | Gets the actual form array to be built. | 29 |
FormBase:: |
protected | function | Gets the config factory for this form. | 2 |
FormBase:: |
protected | function | Gets the current user. | |
EntityForm:: |
public | function |
Gets the form entity. Overrides EntityFormInterface:: |
|
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
MessengerTrait:: |
public | function | Gets the messenger. | 8 |
EntityForm:: |
public | function |
Gets the operation identifying the form. Overrides EntityFormInterface:: |
|
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
EntityForm:: |
protected | function | Initialize the form state and the entity before the first form build. | 2 |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
FormBase:: |
public static | function |
Instantiates a new instance of this class. Overrides ContainerInjectionInterface:: |
85 |
EntityForm:: |
protected | function | Invokes the specified prepare hook variant. | |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
EntityForm:: |
protected | function | Prepares the entity object before the form is built first. | 2 |
EntityForm:: |
public | function | Process callback: assigns weights and hides extra fields. | |
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
protected | function | Retrieves a configuration object. | |
EntityConfirmFormBase:: |
public | function |
Returns a caption for the button that confirms the action. Overrides ConfirmFormInterface:: |
5 |
EntityConfirmFormBase:: |
public | function |
Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface:: |
|
FormBase:: |
protected | function | Returns a redirect response object for the specified route. | |
EntityConfirmFormBase:: |
public | function |
Returns a string identifying the base form. Overrides EntityForm:: |
|
EntityForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
12 |
EntityConfirmFormBase:: |
public | function |
Returns additional text to display as a description. Overrides ConfirmFormInterface:: |
11 |
EntityConfirmFormBase:: |
protected | function |
Returns an array of supported actions for the current entity form. Overrides EntityForm:: |
1 |
EntityForm:: |
protected | function | Returns the action form element for the current entity form. | |
EntityConfirmFormBase:: |
public | function |
Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface:: |
|
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
ConfirmFormInterface:: |
public | function | Returns the question to ask the user. | 38 |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
ConfirmFormInterface:: |
public | function | Returns the route to go to if the user cancels the action. | 37 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
EntityForm:: |
public | function |
Sets the entity type manager for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the form entity. Overrides EntityFormInterface:: |
|
MessengerTrait:: |
public | function | Sets the messenger. | |
EntityForm:: |
public | function |
Sets the module handler for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the operation for this form. Overrides EntityFormInterface:: |
|
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 1 |
FormBase:: |
protected | property | The config factory. | 2 |
EntityConfirmFormBase:: |
public | function | The delete() method is not used in EntityConfirmFormBase. This overrides the default implementation that redirects to the delete-form confirmation form. | |
EntityForm:: |
protected | property | The entity being used by this form. | 8 |
EntityForm:: |
protected | property | The entity type manager. | 3 |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
MessengerTrait:: |
protected | property | The messenger. | 8 |
EntityForm:: |
protected | property | The module handler service. | 2 |
EntityForm:: |
protected | property | The name of the current operation. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
EntityConfirmFormBase:: |
public | function |
The save() method is not used in EntityConfirmFormBase. This overrides the
default implementation that saves the entity. Overrides EntityForm:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 3 |
EntityForm:: |
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 FormInterface:: |
15 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |