UserCancelForm.php in Zircon Profile 8

Contains \Drupal\user\Form\UserCancelForm.

Namespace

Drupal\user\Form

File

core/modules/user/src/Form/UserCancelForm.php

<?php

/**
 * @file
 * Contains \Drupal\user\Form\UserCancelForm.
 */
namespace Drupal\user\Form;

use Drupal\Core\Entity\ContentEntityConfirmFormBase;
use Drupal\Core\Form\FormStateInterface;

/**
 * Provides a confirmation form for cancelling user account.
 */
class UserCancelForm extends ContentEntityConfirmFormBase {

  /**
   * Available account cancellation methods.
   *
   * @var array
   */
  protected $cancelMethods;

  /**
   * The user 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?', array(
      '%name' => $this->entity
        ->label(),
    ));
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return $this->entity
      ->urlInfo();
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    $description = '';
    $default_method = $this
      ->config('user.settings')
      ->get('cancel_method');
    if ($this
      ->currentUser()
      ->hasPermission('administer users') || $this
      ->currentUser()
      ->hasPermission('select account cancellation method')) {
      $description = $this
        ->t('Select the method to cancel the account above.');
    }
    elseif (isset($this->cancelMethods[$default_method]['#confirm_description'])) {
      $description = $this->cancelMethods[$default_method]['#confirm_description'];
    }
    return $description . ' ' . $this
      ->t('This action cannot be undone.');
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $user = $this
      ->currentUser();
    $this->cancelMethods = user_cancel_methods();

    // Display account cancellation method selection, if allowed.
    $admin_access = $user
      ->hasPermission('administer users');
    $form['user_cancel_method'] = array(
      '#type' => 'radios',
      '#title' => $this->entity
        ->id() == $user
        ->id() ? $this
        ->t('When cancelling your account') : $this
        ->t('When cancelling the account'),
      '#access' => $admin_access || $user
        ->hasPermission('select account cancellation method'),
    );
    $form['user_cancel_method'] += $this->cancelMethods;

    // Allow user administrators to skip the account cancellation confirmation
    // mail (by default), as long as they do not attempt to cancel their own
    // account.
    $override_access = $admin_access && $this->entity
      ->id() != $user
      ->id();
    $form['user_cancel_confirm'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Require email confirmation to cancel account'),
      '#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'] = array(
      '#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'] = array(
      '#type' => 'value',
      '#value' => $this->entity
        ->id(),
    );

    // Store the user permissions so that it can be altered in hook_form_alter()
    // if desired.
    $form['access'] = array(
      '#type' => 'value',
      '#value' => $user
        ->hasPermission('administer users'),
    );
    $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
        ->urlInfo('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);
      drupal_set_message($this
        ->t('A confirmation request to cancel your account has been sent to your email address.'));
      $this
        ->logger('user')
        ->notice('Sent account cancellation request to %name %email.', array(
        '%name' => $this->entity
          ->label(),
        '%email' => '<' . $this->entity
          ->getEmail() . '>',
      ));
      $form_state
        ->setRedirect('entity.user.canonical', array(
        'user' => $this->entity
          ->id(),
      ));
    }
  }

}

Classes

Name	Description
UserCancelForm	Provides a confirmation form for cancelling user account.