class RobotDeleteForm
Same name in other branches
- 3.x modules/config_entity_example/src/Form/RobotDeleteForm.php \Drupal\config_entity_example\Form\RobotDeleteForm
Class RobotDeleteForm.
Provides a confirm form for deleting the entity. This is different from the add and edit forms as it does not inherit from RobotFormBase. The reason for this is that we do not need to build the same form. Instead, we present the user with a simple yes/no question. For this reason, we derive from EntityConfirmFormBase instead.
Hierarchy
- class \Drupal\Core\Form\FormBase implements \Drupal\Core\Form\FormInterface, \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait
- class \Drupal\Core\Entity\EntityForm extends \Drupal\Core\Form\FormBase implements \Drupal\Core\Entity\EntityFormInterface
- class \Drupal\Core\Entity\EntityConfirmFormBase extends \Drupal\Core\Entity\EntityForm implements \Drupal\Core\Form\ConfirmFormInterface
- class \Drupal\config_entity_example\Form\RobotDeleteForm extends \Drupal\Core\Entity\EntityConfirmFormBase
- class \Drupal\Core\Entity\EntityConfirmFormBase extends \Drupal\Core\Entity\EntityForm implements \Drupal\Core\Form\ConfirmFormInterface
- class \Drupal\Core\Entity\EntityForm extends \Drupal\Core\Form\FormBase implements \Drupal\Core\Entity\EntityFormInterface
Expanded class hierarchy of RobotDeleteForm
Related topics
File
-
modules/
config_entity_example/ src/ Form/ RobotDeleteForm.php, line 20
Namespace
Drupal\config_entity_example\FormView source
class RobotDeleteForm extends EntityConfirmFormBase {
/**
* Gathers a confirmation question.
*
* The question is used as a title in our confirm form. For delete confirm
* forms, this typically takes the form of "Are you sure you want to
* delete...", including the entity label.
*
* @return string
* Translated string.
*/
public function getQuestion() {
return $this->t('Are you sure you want to delete robot %label?', [
'%label' => $this->entity
->label(),
]);
}
/**
* Gather the confirmation text.
*
* The confirm text is used as the text in the button that confirms the
* question posed by getQuestion().
*
* @return string
* Translated string.
*/
public function getConfirmText() {
return $this->t('Delete Robot');
}
/**
* Gets the cancel URL.
*
* Provides the URL to go to if the user cancels the action. For entity
* delete forms, this is typically the route that points at the list
* controller.
*
* @return \Drupal\Core\Url
* The URL to go to if the user cancels the deletion.
*/
public function getCancelUrl() {
return new Url('entity.robot.list');
}
/**
* The submit handler for the confirm form.
*
* For entity delete forms, you use this to delete the entity in
* $this->entity.
*
* @param array $form
* An associative array containing the structure of the form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* An associative array containing the current state of the form.
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
// Delete the entity.
$this->entity
->delete();
// Set a message that the entity was deleted.
$this->messenger()
->addMessage($this->t('Robot %label was deleted.', [
'%label' => $this->entity
->label(),
]));
// Redirect the user to the list controller when complete.
$form_state->setRedirectUrl($this->getCancelUrl());
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
DependencySerializationTrait::$_entityStorages | protected | property | |||
DependencySerializationTrait::$_serviceIds | protected | property | |||
DependencySerializationTrait::__sleep | public | function | 1 | ||
DependencySerializationTrait::__wakeup | public | function | 2 | ||
EntityConfirmFormBase::actions | protected | function | Overrides EntityForm::actions | 1 | |
EntityConfirmFormBase::buildForm | public | function | Overrides EntityForm::buildForm | 4 | |
EntityConfirmFormBase::delete | public | function | The delete() method is not used in EntityConfirmFormBase. This overrides the default implementation that redirects to the delete-form confirmation form. |
||
EntityConfirmFormBase::getBaseFormId | public | function | Overrides EntityForm::getBaseFormId | ||
EntityConfirmFormBase::getCancelText | public | function | Overrides ConfirmFormInterface::getCancelText | ||
EntityConfirmFormBase::getDescription | public | function | Overrides ConfirmFormInterface::getDescription | 11 | |
EntityConfirmFormBase::getFormName | public | function | Overrides ConfirmFormInterface::getFormName | ||
EntityConfirmFormBase::save | public | function | The save() method is not used in EntityConfirmFormBase. This overrides the default implementation that saves the entity. |
Overrides EntityForm::save | |
EntityForm::$entity | protected | property | The entity being used by this form. | 11 | |
EntityForm::$entityTypeManager | protected | property | The entity type manager. | 3 | |
EntityForm::$moduleHandler | protected | property | The module handler service. | 2 | |
EntityForm::$operation | protected | property | The name of the current operation. | ||
EntityForm::actionsElement | protected | function | Returns the action form element for the current entity form. | ||
EntityForm::afterBuild | public | function | Form element #after_build callback: Updates the entity with submitted data. | 1 | |
EntityForm::buildEntity | public | function | Overrides EntityFormInterface::buildEntity | 5 | |
EntityForm::copyFormValuesToEntity | protected | function | Copies top-level form values to entity properties. | 11 | |
EntityForm::form | public | function | Gets the actual form array to be built. | 36 | |
EntityForm::getEntity | public | function | Overrides EntityFormInterface::getEntity | ||
EntityForm::getEntityFromRouteMatch | public | function | Overrides EntityFormInterface::getEntityFromRouteMatch | 3 | |
EntityForm::getFormId | public | function | Overrides FormInterface::getFormId | 13 | |
EntityForm::getOperation | public | function | Overrides EntityFormInterface::getOperation | ||
EntityForm::init | protected | function | Initialize the form state and the entity before the first form build. | 3 | |
EntityForm::prepareEntity | protected | function | Prepares the entity object before the form is built first. | 3 | |
EntityForm::prepareInvokeAll | protected | function | Invokes the specified prepare hook variant. | ||
EntityForm::processForm | public | function | Process callback: assigns weights and hides extra fields. | ||
EntityForm::setEntity | public | function | Overrides EntityFormInterface::setEntity | ||
EntityForm::setEntityTypeManager | public | function | Overrides EntityFormInterface::setEntityTypeManager | ||
EntityForm::setModuleHandler | public | function | Overrides EntityFormInterface::setModuleHandler | ||
EntityForm::setOperation | public | function | Overrides EntityFormInterface::setOperation | ||
FormBase::$configFactory | protected | property | The config factory. | 3 | |
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. | 3 | |
FormBase::container | private | function | Returns the service container. | ||
FormBase::create | public static | function | Overrides ContainerInjectionInterface::create | 111 | |
FormBase::currentUser | protected | function | Gets the current user. | 2 | |
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. | ||
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 | Overrides FormInterface::validateForm | 57 | |
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. | 16 | |
MessengerTrait::messenger | public | function | Gets the messenger. | 16 | |
MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
RedirectDestinationTrait::$redirectDestination | protected | property | The redirect destination service. | 2 | |
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. | ||
RobotDeleteForm::getCancelUrl | public | function | Gets the cancel URL. | Overrides ConfirmFormInterface::getCancelUrl | |
RobotDeleteForm::getConfirmText | public | function | Gather the confirmation text. | Overrides EntityConfirmFormBase::getConfirmText | |
RobotDeleteForm::getQuestion | public | function | Gathers a confirmation question. | Overrides ConfirmFormInterface::getQuestion | |
RobotDeleteForm::submitForm | public | function | The submit handler for the confirm form. | Overrides EntityForm::submitForm | |
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | |
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. |