Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x

RoleForm.php

Namespace

Drupal\user

File

core/modules/user/src/RoleForm.php

View source
<?php

namespace Drupal\user;

use Drupal\Core\Config\Entity\ConfigEntityStorage;
use Drupal\Core\Entity\EntityForm;
use Drupal\Core\Form\FormStateInterface;

/**
 * Form controller for the role entity edit forms.
 *
 * @internal
 */
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' => ConfigEntityStorage::MAX_ID_LENGTH,
            '#machine_name' => [
                'exists' => [
                    '\\Drupal\\user\\Entity\\Role',
                    'load',
                ],
            ],
        ];
        $form['weight'] = [
            '#type' => 'value',
            '#value' => $entity->getWeight(),
        ];
        return parent::form($form, $form_state);
    }
    
    /**
     * {@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')
                ->info('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')
                ->info('Role %label has been added.', [
                '%label' => $entity->label(),
                'link' => $edit_link,
            ]);
        }
        $form_state->setRedirect('entity.user_role.collection');
    }

}

Classes

Title Deprecated Summary
RoleForm Form controller for the role entity edit forms.

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal