class RoleListBuilder

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

Defines a class to build a listing of user role entities.

Hierarchy

Expanded class hierarchy of RoleListBuilder

See also

\Drupal\user\Entity\Role

File

core/modules/user/src/RoleListBuilder.php, line 18

Namespace

Drupal\user
View source
class RoleListBuilder extends DraggableListBuilder {
    
    /**
     * The messenger.
     *
     * @var \Drupal\Core\Messenger\MessengerInterface
     */
    protected $messenger;
    
    /**
     * RoleListBuilder constructor.
     *
     * @param \Drupal\Core\Entity\EntityTypeInterface $entityType
     *   The entity type definition.
     * @param \Drupal\Core\Entity\EntityStorageInterface $storage
     *   The entity storage class.
     * @param \Drupal\Core\Messenger\MessengerInterface $messenger
     *   The messenger.
     */
    public function __construct(EntityTypeInterface $entityType, EntityStorageInterface $storage, MessengerInterface $messenger) {
        parent::__construct($entityType, $storage);
        $this->messenger = $messenger;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
        return new static($entity_type, $container->get('entity_type.manager')
            ->getStorage($entity_type->id()), $container->get('messenger'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'user_admin_roles_form';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildHeader() {
        $header['label'] = $this->t('Name');
        return $header + parent::buildHeader();
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildRow(EntityInterface $entity) {
        $row['label'] = $entity->label();
        return $row + parent::buildRow($entity);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDefaultOperations(EntityInterface $entity) {
        $operations = parent::getDefaultOperations($entity);
        if ($entity->hasLinkTemplate('edit-permissions-form')) {
            $operations['permissions'] = [
                'title' => $this->t('Edit permissions'),
                'weight' => 20,
                'url' => $entity->toUrl('edit-permissions-form'),
            ];
        }
        return $operations;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        parent::submitForm($form, $form_state);
        $this->messenger
            ->addStatus($this->t('The role settings have been updated.'));
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConfigEntityListBuilder::$storage protected property The config entity storage class. Overrides EntityListBuilder::$storage
ConfigEntityListBuilder::getStorage public function Gets the config entity storage. Overrides EntityListBuilder::getStorage
ConfigEntityListBuilder::load public function Overrides EntityListBuilder::load 6
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
DraggableListBuilder::getWeight protected function Gets the weight of the given entity. Overrides DraggableListBuilderTrait::getWeight
DraggableListBuilder::setWeight protected function Sets the weight of an entity. Overrides DraggableListBuilderTrait::setWeight
DraggableListBuilderTrait::$entities protected property The entities being listed. 1
DraggableListBuilderTrait::$entitiesKey protected property The key to use for the form element containing the entities. 3
DraggableListBuilderTrait::$formBuilder protected property The form builder.
DraggableListBuilderTrait::$weightKey protected property Name of the entity's weight field or FALSE if no field is provided.
DraggableListBuilderTrait::buildForm public function Form constructor. 4
DraggableListBuilderTrait::render public function Builds a listing of entities for the given entity type. 1
DraggableListBuilderTrait::validateForm public function Form validation handler. 2
EntityHandlerBase::$moduleHandler protected property The module handler to invoke hooks on. 5
EntityHandlerBase::moduleHandler protected function Gets the module handler. 5
EntityHandlerBase::setModuleHandler public function Sets the module handler for this handler.
EntityListBuilder::$entityType protected property Information about the entity type.
EntityListBuilder::$entityTypeId protected property The entity type ID.
EntityListBuilder::$limit protected property The number of entities to list per page, or FALSE to list all entities.
EntityListBuilder::buildOperations public function Builds a renderable list of operation links for the entity. 2
EntityListBuilder::ensureDestination protected function Ensures that a destination is present on the given URL. 1
EntityListBuilder::getEntityIds protected function Loads entity IDs using a pager sorted by the entity id. 4
EntityListBuilder::getEntityListQuery protected function Returns a query object for loading entity IDs from the storage.
EntityListBuilder::getOperations public function Overrides EntityListBuilderInterface::getOperations 3
EntityListBuilder::getTitle protected function Gets the title of the page. 1
EntityListBuilder::SORT_KEY protected constant The entity key to sort the list by. 1
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.
RoleListBuilder::$messenger protected property The messenger. Overrides MessengerTrait::$messenger
RoleListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides DraggableListBuilderTrait::buildHeader
RoleListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides DraggableListBuilderTrait::buildRow
RoleListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
RoleListBuilder::getDefaultOperations public function Gets this list's default operations. Overrides ConfigEntityListBuilder::getDefaultOperations
RoleListBuilder::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
RoleListBuilder::submitForm public function Form submission handler. Overrides DraggableListBuilderTrait::submitForm
RoleListBuilder::__construct public function RoleListBuilder constructor. Overrides DraggableListBuilder::__construct
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.

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