class DuplicateRoleForm in Duplicate role 8

Provides a form for adding a new role.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\duplicate_role\Form\DuplicateRoleForm

Expanded class hierarchy of DuplicateRoleForm

1 string reference to 'DuplicateRoleForm'

duplicate_role.routing.yml in ./duplicate_role.routing.yml: duplicate_role.routing.yml

File

src/Form/DuplicateRoleForm.php, line 16

Namespace

Drupal\duplicate_role\Form

View source

class DuplicateRoleForm extends FormBase {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManager
   */
  protected $entityTypeManager;

  /**
   * The route match.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $routeMatch;

  /**
   * Constructs a DuplicateRoleForm object.
   *
   * @param \Drupal\Core\Entity\EntityTypeManager $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The messenger.
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The route match.
   */
  public function __construct(EntityTypeManager $entity_type_manager, MessengerInterface $messenger, RouteMatchInterface $route_match) {
    $this->entityTypeManager = $entity_type_manager;
    $this->messenger = $messenger;
    $this->routeMatch = $route_match;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager'), $container
      ->get('messenger'), $container
      ->get('current_route_match'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'duplicate_role_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $note = NULL) {
    $u_roles = user_role_names();
    asort($u_roles);
    $options = [];
    $options[''] = $this
      ->t('-select-');
    foreach ($u_roles as $key => $value) {
      $options[$key] = $value;
    }

    // Try to get a base role from route parameter.
    $base_role = $this->routeMatch
      ->getParameter('role');
    $form['base_role'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Choose role to duplicate'),
      '#description' => $this
        ->t('Select role to duplicate'),
      '#options' => $options,
      '#required' => TRUE,
      '#access' => !isset($options[$base_role]),
    ];
    $form['label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('New role'),
      '#required' => TRUE,
      '#size' => 40,
      '#maxlength' => 40,
      '#description' => $this
        ->t('The name for the duplicated role. Example: "Moderator", "Editorial board", "Site architect".'),
    ];
    $form['id'] = [
      '#type' => 'machine_name',
      '#default_value' => '',
      '#required' => TRUE,
      '#size' => 30,
      '#maxlength' => 64,
      '#machine_name' => [
        'exists' => [
          Role::class,
          'load',
        ],
      ],
    ];
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Duplicate'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $roles = user_role_names();
    $base_role_id = $this->routeMatch
      ->getParameter('role');
    if (!isset($roles[$base_role_id])) {
      $base_role_id = $form_state
        ->getValue('base_role');
    }
    $new_role_name = $form_state
      ->getValue('label');
    $new_role_id = $form_state
      ->getValue('id');

    /** @var \Drupal\user\RoleInterface $role */
    $base_role = $this->entityTypeManager
      ->getStorage('user_role')
      ->load($base_role_id);
    if ($base_role !== NULL) {
      $new_role = Role::create([
        'id' => $new_role_id,
        'label' => $new_role_name,
      ]);
      $new_role
        ->save();
      user_role_grant_permissions($new_role
        ->id(), $base_role
        ->getPermissions());
      $this->messenger
        ->addStatus($this
        ->t('Role %role_name has been added.', [
        '%role_name' => $new_role_name,
      ]));
      $form_state
        ->setRedirect('entity.user_role.collection');
    }
    else {
      $this->messenger
        ->addError($this
        ->t('Base role %base_role_id not found.', [
        '%base_role_id' => $base_role_id,
      ]));
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
DuplicateRoleForm::$entityTypeManager	protected	property	The entity type manager.
DuplicateRoleForm::$routeMatch	protected	property	The route match. Overrides FormBase::$routeMatch
DuplicateRoleForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
DuplicateRoleForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
DuplicateRoleForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
DuplicateRoleForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
DuplicateRoleForm::__construct	public	function	Constructs a DuplicateRoleForm object.
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::config	protected	function	Retrieves a configuration object.
FormBase::configFactory	protected	function	Gets the config factory for this form.	1
FormBase::container	private	function	Returns the service container.
FormBase::currentUser	protected	function	Gets the current user.
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. Overrides UrlGeneratorTrait::redirect
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.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
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.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
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.	1
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.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.

You are here

class DuplicateRoleForm in Duplicate role 8

Hierarchy

File

Namespace

Members

API Navigation