class UserRoleDelete

Provides a deletion confirmation form for Role entity.

Hierarchy

Expanded class hierarchy of UserRoleDelete

1 string reference to 'UserRoleDelete'
user.routing.yml in drupal/core/modules/user/user.routing.yml
drupal/core/modules/user/user.routing.yml

File

drupal/core/modules/user/lib/Drupal/user/Form/UserRoleDelete.php, line 16
Contains \Drupal\user\Form\UserRoleDelete.

Namespace

Drupal\user\Form
View source
class UserRoleDelete extends ConfirmFormBase {

  /**
   * The role being deleted.
   *
   * @var \Drupal\user\RoleInterface
   */
  protected $role;

  /**
   * {@inheritdoc}
   */
  public function getFormID() {
    return 'user_admin_role_delete_confirm';
  }

  /**
   * {@inheritdoc}
   */
  protected function getQuestion() {
    return t('Are you sure you want to delete the role %name?', array(
      '%name' => $this->role
        ->label(),
    ));
  }

  /**
   * {@inheritdoc}
   */
  protected function getCancelPath() {
    return 'admin/people/roles';
  }

  /**
   * {@inheritdoc}
   */
  protected function getConfirmText() {
    return t('Delete');
  }

  /**
   * {@inheritdoc}
   * @param \Drupal\user\RoleInterface $user_role
   *   The role being deleted.
   */
  public function buildForm(array $form, array &$form_state, RoleInterface $user_role = NULL) {
    $this->role = $user_role;
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, array &$form_state) {
    $this->role
      ->delete();
    watchdog('user', 'Role %name has been deleted.', array(
      '%name' => $this->role
        ->label(),
    ));
    drupal_set_message(t('Role %name has been deleted.', array(
      '%name' => $this->role
        ->label(),
    )));
    $form_state['redirect'] = 'admin/people/roles';
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfirmFormBase::getCancelText protected function Returns a caption for the link which cancels the action. 2
ConfirmFormBase::getDescription protected function Returns additional text to display as a description. 10
ConfirmFormBase::getFormName protected function Returns the internal name used to refer to the confirmation item.
ConfirmFormBase::validateForm public function Implements \Drupal\Core\Form\FormInterface::validateForm(). Overrides FormInterface::validateForm 1
UserRoleDelete::$role protected property The role being deleted.
UserRoleDelete::buildForm public function Overrides ConfirmFormBase::buildForm
UserRoleDelete::getCancelPath protected function Returns the page to go to if the user cancels the action. Overrides ConfirmFormBase::getCancelPath
UserRoleDelete::getConfirmText protected function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
UserRoleDelete::getFormID public function Returns a unique string identifying the form. Overrides FormInterface::getFormID
UserRoleDelete::getQuestion protected function Returns the question to ask the user. Overrides ConfirmFormBase::getQuestion
UserRoleDelete::submitForm public function Form submission handler. Overrides FormInterface::submitForm