class UserPermissionsRoleSpecificForm

Same name in other branches
  1. 9 core/modules/user/src/Form/UserPermissionsRoleSpecificForm.php \Drupal\user\Form\UserPermissionsRoleSpecificForm
  2. 8.9.x core/modules/user/src/Form/UserPermissionsRoleSpecificForm.php \Drupal\user\Form\UserPermissionsRoleSpecificForm
  3. 10 core/modules/user/src/Form/UserPermissionsRoleSpecificForm.php \Drupal\user\Form\UserPermissionsRoleSpecificForm

Provides the user permissions administration form for a specific role.

@internal

Hierarchy

Expanded class hierarchy of UserPermissionsRoleSpecificForm

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

File

core/modules/user/src/Form/UserPermissionsRoleSpecificForm.php, line 13

Namespace

Drupal\user\Form
View source 
class UserPermissionsRoleSpecificForm extends UserPermissionsForm {
    
    /**
     * The specific role for this form.
     *
     * @var \Drupal\user\RoleInterface
     */
    protected $userRole;
    
    /**
     * {@inheritdoc}
     */
    protected function getRoles() {
        return [
            $this->userRole
                ->id() => $this->userRole,
        ];
    }
    
    /**
     * Builds the user permissions administration form for a specific role.
     *
     * @param array $form
     *   An associative array containing the structure of the form.
     * @param \Drupal\Core\Form\FormStateInterface $form_state
     *   The current state of the form.
     * @param \Drupal\user\RoleInterface|null $user_role
     *   (optional) The user role used for this form. Defaults to NULL.
     */
    public function buildForm(array $form, FormStateInterface $form_state, ?RoleInterface $user_role = NULL) {
        $this->userRole = $user_role;
        return parent::buildForm($form, $form_state);
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 2
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 2
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user. 2
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.
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 Overrides FormInterface::validateForm 57
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. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
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. 3
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.
UserPermissionsForm::$moduleHandler protected property The module handler.
UserPermissionsForm::$permissionHandler protected property The permission handler.
UserPermissionsForm::$roleStorage protected property The role storage.
UserPermissionsForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create 1
UserPermissionsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
UserPermissionsForm::permissionsByProvider protected function Group permissions by the modules that provide them. 2
UserPermissionsForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
UserPermissionsForm::__construct public function Constructs a new UserPermissionsForm. 1
UserPermissionsRoleSpecificForm::$userRole protected property The specific role for this form.
UserPermissionsRoleSpecificForm::buildForm public function Builds the user permissions administration form for a specific role. Overrides UserPermissionsForm::buildForm
UserPermissionsRoleSpecificForm::getRoles protected function Gets the roles to display in this form. Overrides UserPermissionsForm::getRoles

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