class UserCancelForm
Same name in other branches
- 9 core/modules/user/src/Form/UserCancelForm.php \Drupal\user\Form\UserCancelForm
- 8.9.x core/modules/user/src/Form/UserCancelForm.php \Drupal\user\Form\UserCancelForm
- 10 core/modules/user/src/Form/UserCancelForm.php \Drupal\user\Form\UserCancelForm
Provides a confirmation form for cancelling user account.
@internal
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\ContentEntityForm extends \Drupal\Core\Entity\EntityForm implements \Drupal\Core\Entity\ContentEntityFormInterface
- class \Drupal\Core\Entity\ContentEntityConfirmFormBase extends \Drupal\Core\Entity\ContentEntityForm implements \Drupal\Core\Form\ConfirmFormInterface
- class \Drupal\user\Form\UserCancelForm extends \Drupal\Core\Entity\ContentEntityConfirmFormBase
- class \Drupal\Core\Entity\ContentEntityConfirmFormBase extends \Drupal\Core\Entity\ContentEntityForm implements \Drupal\Core\Form\ConfirmFormInterface
- class \Drupal\Core\Entity\ContentEntityForm extends \Drupal\Core\Entity\EntityForm implements \Drupal\Core\Entity\ContentEntityFormInterface
- class \Drupal\Core\Entity\EntityForm extends \Drupal\Core\Form\FormBase implements \Drupal\Core\Entity\EntityFormInterface
Expanded class hierarchy of UserCancelForm
File
-
core/
modules/ user/ src/ Form/ UserCancelForm.php, line 13
Namespace
Drupal\user\FormView source
class UserCancelForm extends ContentEntityConfirmFormBase {
/**
* Available account cancellation methods.
*
* @var array
*/
protected $cancelMethods;
/**
* Whether it is allowed to select cancellation method.
*
* @var bool
*/
protected $selectCancel;
/**
* The account being cancelled.
*
* @var \Drupal\user\UserInterface
*/
protected $entity;
/**
* {@inheritdoc}
*/
public function getQuestion() {
if ($this->entity
->id() == $this->currentUser()
->id()) {
return $this->t('Are you sure you want to cancel your account?');
}
return $this->t('Are you sure you want to cancel the account %name?', [
'%name' => $this->entity
->label(),
]);
}
/**
* {@inheritdoc}
*/
public function getCancelUrl() {
return $this->entity
->toUrl();
}
/**
* {@inheritdoc}
*/
public function getDescription() {
if ($this->selectCancel) {
return '';
}
$default_method = $this->config('user.settings')
->get('cancel_method');
$own_account = $this->entity
->id() == $this->currentUser()
->id();
// Options supplied via user_cancel_methods() can have a custom
// #confirm_description property for the confirmation form description. This
// text refers to "Your account" so only user it if cancelling own account.
if ($own_account && isset($this->cancelMethods[$default_method]['#confirm_description'])) {
return $this->cancelMethods[$default_method]['#confirm_description'];
}
return $this->cancelMethods['#options'][$default_method];
}
/**
* {@inheritdoc}
*/
public function getConfirmText() {
return $this->t('Confirm');
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$user = $this->currentUser();
$this->cancelMethods = user_cancel_methods();
// Display account cancellation method selection, if allowed.
$own_account = $this->entity
->id() == $user->id();
$this->selectCancel = $user->hasPermission('administer users') || $user->hasPermission('select account cancellation method');
$form['user_cancel_method'] = [
'#type' => 'radios',
'#title' => $own_account ? $this->t('When cancelling your account') : $this->t('Cancellation method'),
'#access' => $this->selectCancel,
];
$form['user_cancel_method'] += $this->cancelMethods;
// When managing another user, can skip the account cancellation
// confirmation mail (by default).
$override_access = !$own_account;
$form['user_cancel_confirm'] = [
'#type' => 'checkbox',
'#title' => $this->t('Require email confirmation'),
'#default_value' => !$override_access,
'#access' => $override_access,
'#description' => $this->t('When enabled, the user must confirm the account cancellation via email.'),
];
// Also allow to send account canceled notification mail, if enabled.
$default_notify = $this->config('user.settings')
->get('notify.status_canceled');
$form['user_cancel_notify'] = [
'#type' => 'checkbox',
'#title' => $this->t('Notify user when account is canceled'),
'#default_value' => $override_access ? FALSE : $default_notify,
'#access' => $override_access && $default_notify,
'#description' => $this->t('When enabled, the user will receive an email notification after the account has been canceled.'),
];
// Always provide entity id in the same form key as in the entity edit form.
$form['uid'] = [
'#type' => 'value',
'#value' => $this->entity
->id(),
];
// Store the user permissions so that it can be altered in hook_form_alter()
// if desired.
$form['access'] = [
'#type' => 'value',
'#value' => !$own_account,
];
$form = parent::buildForm($form, $form_state);
return $form;
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
// Cancel account immediately, if the current user has administrative
// privileges, no confirmation mail shall be sent, and the user does not
// attempt to cancel the own account.
if (!$form_state->isValueEmpty('access') && $form_state->isValueEmpty('user_cancel_confirm') && $this->entity
->id() != $this->currentUser()
->id()) {
user_cancel($form_state->getValues(), $this->entity
->id(), $form_state->getValue('user_cancel_method'));
$form_state->setRedirectUrl($this->entity
->toUrl('collection'));
}
else {
// Store cancelling method and whether to notify the user in
// $this->entity for
// \Drupal\user\Controller\UserController::confirmCancel().
$this->entity->user_cancel_method = $form_state->getValue('user_cancel_method');
$this->entity->user_cancel_notify = $form_state->getValue('user_cancel_notify');
$this->entity
->save();
_user_mail_notify('cancel_confirm', $this->entity);
$this->logger('user')
->info('Sent account cancellation request to %name %email.', [
'%name' => $this->entity
->label(),
'%email' => '<' . $this->entity
->getEmail() . '>',
]);
$cancel_message = $this->t('A confirmation request to cancel your account has been sent to your email address.');
if ($this->entity
->id() !== $this->currentUser()
->id()) {
$cancel_message = $this->t("A confirmation request to cancel the account %name has been sent to the user's email address.", [
'%name' => $this->entity
->label(),
]);
}
$this->messenger()
->addStatus($cancel_message);
$form_state->setRedirect('entity.user.canonical', [
'user' => $this->entity
->id(),
]);
}
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
ContentEntityConfirmFormBase::actions | protected | function | Overrides EntityForm::actions | ||
ContentEntityConfirmFormBase::delete | public | function | The delete() method is not used in ContentEntityConfirmFormBase. This overrides the default implementation that redirects to the delete-form confirmation form. |
||
ContentEntityConfirmFormBase::form | public | function | Overrides ContentEntityForm::form | ||
ContentEntityConfirmFormBase::getBaseFormId | public | function | Overrides EntityForm::getBaseFormId | ||
ContentEntityConfirmFormBase::getCancelText | public | function | Overrides ConfirmFormInterface::getCancelText | ||
ContentEntityConfirmFormBase::getFormName | public | function | Overrides ConfirmFormInterface::getFormName | ||
ContentEntityConfirmFormBase::save | public | function | The save() method is not used in ContentEntityConfirmFormBase. This overrides the default implementation that saves the entity. |
Overrides EntityForm::save | |
ContentEntityConfirmFormBase::validateForm | public | function | Overrides ContentEntityForm::validateForm | ||
ContentEntityForm::$entityRepository | protected | property | The entity repository service. | ||
ContentEntityForm::$entityTypeBundleInfo | protected | property | The entity type bundle info service. | ||
ContentEntityForm::$time | protected | property | The time service. | ||
ContentEntityForm::addRevisionableFormFields | protected | function | Add revision form fields if the entity enabled the UI. | ||
ContentEntityForm::buildEntity | public | function | Overrides EntityForm::buildEntity | 4 | |
ContentEntityForm::copyFormValuesToEntity | protected | function | Overrides EntityForm::copyFormValuesToEntity | ||
ContentEntityForm::create | public static | function | Overrides FormBase::create | 9 | |
ContentEntityForm::flagViolations | protected | function | Flags violations for the current form. | 4 | |
ContentEntityForm::getBundleEntity | protected | function | Returns the bundle entity of the entity, or NULL if there is none. | ||
ContentEntityForm::getEditedFieldNames | protected | function | Gets the names of all fields edited in the form. | 4 | |
ContentEntityForm::getFormDisplay | public | function | Overrides ContentEntityFormInterface::getFormDisplay | ||
ContentEntityForm::getFormLangcode | public | function | Overrides ContentEntityFormInterface::getFormLangcode | ||
ContentEntityForm::getNewRevisionDefault | protected | function | Should new revisions created on default. | ||
ContentEntityForm::init | protected | function | Initializes the form state and the entity before the first form build. | Overrides EntityForm::init | 1 |
ContentEntityForm::initFormLangcodes | protected | function | Initializes form language code values. | ||
ContentEntityForm::isDefaultFormLangcode | public | function | Overrides ContentEntityFormInterface::isDefaultFormLangcode | ||
ContentEntityForm::prepareEntity | protected | function | Overrides EntityForm::prepareEntity | 1 | |
ContentEntityForm::setFormDisplay | public | function | Overrides ContentEntityFormInterface::setFormDisplay | ||
ContentEntityForm::showRevisionUi | protected | function | Checks whether the revision form fields should be added to the form. | ||
ContentEntityForm::updateChangedTime | public | function | Updates the changed time of the entity. | ||
ContentEntityForm::updateFormLangcode | public | function | Updates the form language to reflect any change to the entity language. | ||
ContentEntityForm::__construct | public | function | Constructs a ContentEntityForm object. | 8 | |
DependencySerializationTrait::$_entityStorages | protected | property | |||
DependencySerializationTrait::$_serviceIds | protected | property | |||
DependencySerializationTrait::__sleep | public | function | 1 | ||
DependencySerializationTrait::__wakeup | public | function | 2 | ||
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::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::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. | 2 | |
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. | 2 | |
FormBase::container | private | function | Returns the service container. | ||
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. | ||
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. | ||
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. | 1 | |
UserCancelForm::$cancelMethods | protected | property | Available account cancellation methods. | ||
UserCancelForm::$entity | protected | property | The account being cancelled. | Overrides ContentEntityForm::$entity | |
UserCancelForm::$selectCancel | protected | property | Whether it is allowed to select cancellation method. | ||
UserCancelForm::buildForm | public | function | Overrides ContentEntityConfirmFormBase::buildForm | ||
UserCancelForm::getCancelUrl | public | function | Overrides ConfirmFormInterface::getCancelUrl | ||
UserCancelForm::getConfirmText | public | function | Overrides ContentEntityConfirmFormBase::getConfirmText | ||
UserCancelForm::getDescription | public | function | Overrides ContentEntityConfirmFormBase::getDescription | ||
UserCancelForm::getQuestion | public | function | Overrides ConfirmFormInterface::getQuestion | ||
UserCancelForm::submitForm | public | function | Overrides ContentEntityForm::submitForm |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.