class RoleForm

Same name and namespace in other branches
  1. 11.x core/modules/user/src/RoleForm.php \Drupal\user\RoleForm
  2. 10 core/modules/user/src/RoleForm.php \Drupal\user\RoleForm
  3. 8.9.x core/modules/user/src/RoleForm.php \Drupal\user\RoleForm

Form controller for the role entity edit forms.

@internal

Hierarchy

Expanded class hierarchy of RoleForm

File

core/modules/user/src/RoleForm.php, line 13

Namespace

Drupal\user
View source
class RoleForm extends EntityForm {
  
  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {
    $entity = $this->entity;
    $form['label'] = [
      '#type' => 'textfield',
      '#title' => $this->t('Role name'),
      '#default_value' => $entity->label(),
      '#size' => 30,
      '#required' => TRUE,
      '#maxlength' => 64,
      '#description' => $this->t('The name for this role. Example: "Moderator", "Editorial board", "Site architect".'),
    ];
    $form['id'] = [
      '#type' => 'machine_name',
      '#default_value' => $entity->id(),
      '#required' => TRUE,
      '#disabled' => !$entity->isNew(),
      '#size' => 30,
      '#maxlength' => 64,
      '#machine_name' => [
        'exists' => [
          '\\Drupal\\user\\Entity\\Role',
          'load',
        ],
      ],
    ];
    $form['weight'] = [
      '#type' => 'value',
      '#value' => $entity->getWeight(),
    ];
    return parent::form($form, $form_state, $entity);
  }
  
  /**
   * {@inheritdoc}
   */
  public function save(array $form, FormStateInterface $form_state) {
    $entity = $this->entity;
    // Prevent leading and trailing spaces in role names.
    $entity->set('label', trim($entity->label()));
    $status = $entity->save();
    $edit_link = $this->entity
      ->toLink($this->t('Edit'), 'edit-form')
      ->toString();
    if ($status == SAVED_UPDATED) {
      $this->messenger()
        ->addStatus($this->t('Role %label has been updated.', [
        '%label' => $entity->label(),
      ]));
      $this->logger('user')
        ->notice('Role %label has been updated.', [
        '%label' => $entity->label(),
        'link' => $edit_link,
      ]);
    }
    else {
      $this->messenger()
        ->addStatus($this->t('Role %label has been added.', [
        '%label' => $entity->label(),
      ]));
      $this->logger('user')
        ->notice('Role %label has been added.', [
        '%label' => $entity->label(),
        'link' => $edit_link,
      ]);
    }
    $form_state->setRedirect('entity.user_role.collection');
  }

}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.