class DraggableListBuilder

Same name in other branches
  1. 9 core/lib/Drupal/Core/Config/Entity/DraggableListBuilder.php \Drupal\Core\Config\Entity\DraggableListBuilder
  2. 8.9.x core/lib/Drupal/Core/Config/Entity/DraggableListBuilder.php \Drupal\Core\Config\Entity\DraggableListBuilder
  3. 10 core/lib/Drupal/Core/Config/Entity/DraggableListBuilder.php \Drupal\Core\Config\Entity\DraggableListBuilder

Defines a class to build a draggable listing of configuration entities.

Hierarchy

Expanded class hierarchy of DraggableListBuilder

5 files declare their use of DraggableListBuilder
FilterFormatListBuilder.php in core/modules/filter/src/FilterFormatListBuilder.php
LanguageListBuilder.php in core/modules/language/src/LanguageListBuilder.php
RoleListBuilder.php in core/modules/user/src/RoleListBuilder.php
SearchPageListBuilder.php in core/modules/search/src/SearchPageListBuilder.php
VocabularyListBuilder.php in core/modules/taxonomy/src/VocabularyListBuilder.php

File

core/lib/Drupal/Core/Config/Entity/DraggableListBuilder.php, line 14

Namespace

Drupal\Core\Config\Entity
View source
abstract class DraggableListBuilder extends ConfigEntityListBuilder implements FormInterface {
    use DraggableListBuilderTrait;
    
    /**
     * {@inheritdoc}
     */
    public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage) {
        parent::__construct($entity_type, $storage);
        // Do not inject the form builder for backwards-compatibility.
        $this->formBuilder = \Drupal::formBuilder();
        // Check if the entity type supports weighting.
        if ($this->entityType
            ->hasKey('weight')) {
            $this->weightKey = $this->entityType
                ->getKey('weight');
        }
        $this->limit = FALSE;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getWeight(EntityInterface $entity) : int|float {
        
        /** @var \Drupal\Core\Config\Entity\ConfigEntityInterface $entity */
        return $entity->get($this->weightKey) ?: 0;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function setWeight(EntityInterface $entity, int|float $weight) : EntityInterface {
        
        /** @var \Drupal\Core\Config\Entity\ConfigEntityInterface $entity */
        $entity->set($this->weightKey, $weight);
        return $entity;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConfigEntityListBuilder::$storage protected property The config entity storage class. Overrides EntityListBuilder::$storage
ConfigEntityListBuilder::getDefaultOperations public function Gets this list's default operations. Overrides EntityListBuilder::getDefaultOperations 15
ConfigEntityListBuilder::getStorage public function Gets the config entity storage. Overrides EntityListBuilder::getStorage
ConfigEntityListBuilder::load public function Loads entities of this type from storage for listing. 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
DraggableListBuilder::__construct public function Constructs a new EntityListBuilder object. Overrides EntityListBuilder::__construct 5
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::buildHeader public function Builds the header row for the entity listing. 5
DraggableListBuilderTrait::buildRow public function Builds a row for an entity in the entity listing. 5
DraggableListBuilderTrait::render public function Builds a listing of entities for the given entity type. 1
DraggableListBuilderTrait::submitForm public function Form submission handler. 5
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::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance 22
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 Provides an array of information to build a list of operation links. 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
FormInterface::getFormId public function Returns a unique string identifying the form. 282
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.

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