class DraggableListBuilder

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Config/Entity/DraggableListBuilder.php \Drupal\Core\Config\Entity\DraggableListBuilder
  2. 10 core/lib/Drupal/Core/Config/Entity/DraggableListBuilder.php \Drupal\Core\Config\Entity\DraggableListBuilder
  3. 11.x 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 {
    
    /**
     * The key to use for the form element containing the entities.
     *
     * @var string
     */
    protected $entitiesKey = 'entities';
    
    /**
     * The entities being listed.
     *
     * @var \Drupal\Core\Entity\EntityInterface[]
     */
    protected $entities = [];
    
    /**
     * Name of the entity's weight field or FALSE if no field is provided.
     *
     * @var string|bool
     */
    protected $weightKey = FALSE;
    
    /**
     * The form builder.
     *
     * @var \Drupal\Core\Form\FormBuilderInterface
     */
    protected $formBuilder;
    
    /**
     * {@inheritdoc}
     */
    public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage) {
        parent::__construct($entity_type, $storage);
        // Check if the entity type supports weighting.
        if ($this->entityType
            ->hasKey('weight')) {
            $this->weightKey = $this->entityType
                ->getKey('weight');
        }
        $this->limit = FALSE;
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildHeader() {
        $header = [];
        if (!empty($this->weightKey)) {
            $header['weight'] = t('Weight');
        }
        return $header + parent::buildHeader();
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildRow(EntityInterface $entity) {
        $row = [];
        if (!empty($this->weightKey)) {
            // Override default values to markup elements.
            $row['#attributes']['class'][] = 'draggable';
            $row['#weight'] = $entity->get($this->weightKey);
            // Add weight column.
            $row['weight'] = [
                '#type' => 'weight',
                '#title' => t('Weight for @title', [
                    '@title' => $entity->label(),
                ]),
                '#title_display' => 'invisible',
                '#default_value' => $entity->get($this->weightKey),
                '#attributes' => [
                    'class' => [
                        'weight',
                    ],
                ],
            ];
        }
        return $row + parent::buildRow($entity);
    }
    
    /**
     * {@inheritdoc}
     */
    public function render() {
        if (!empty($this->weightKey)) {
            return $this->formBuilder()
                ->getForm($this);
        }
        return parent::render();
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $form[$this->entitiesKey] = [
            '#type' => 'table',
            '#header' => $this->buildHeader(),
            '#empty' => t('There are no @label yet.', [
                '@label' => $this->entityType
                    ->getPluralLabel(),
            ]),
            '#tabledrag' => [
                [
                    'action' => 'order',
                    'relationship' => 'sibling',
                    'group' => 'weight',
                ],
            ],
        ];
        $this->entities = $this->load();
        $delta = 10;
        // Change the delta of the weight field if have more than 20 entities.
        if (!empty($this->weightKey)) {
            $count = count($this->entities);
            if ($count > 20) {
                $delta = ceil($count / 2);
            }
        }
        foreach ($this->entities as $entity) {
            $row = $this->buildRow($entity);
            if (isset($row['label'])) {
                $row['label'] = [
                    '#plain_text' => $row['label'],
                ];
            }
            if (isset($row['weight'])) {
                $row['weight']['#delta'] = $delta;
            }
            $form[$this->entitiesKey][$entity->id()] = $row;
        }
        $form['actions']['#type'] = 'actions';
        $form['actions']['submit'] = [
            '#type' => 'submit',
            '#value' => t('Save'),
            '#button_type' => 'primary',
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function validateForm(array &$form, FormStateInterface $form_state) {
        // No validation.
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        foreach ($form_state->getValue($this->entitiesKey) as $id => $value) {
            if (isset($this->entities[$id]) && $this->entities[$id]
                ->get($this->weightKey) != $value['weight']) {
                // Save entity only when its weight was changed.
                $this->entities[$id]
                    ->set($this->weightKey, $value['weight']);
                $this->entities[$id]
                    ->save();
            }
        }
    }
    
    /**
     * Returns the form builder.
     *
     * @return \Drupal\Core\Form\FormBuilderInterface
     *   The form builder.
     */
    protected function formBuilder() {
        if (!$this->formBuilder) {
            $this->formBuilder = \Drupal::formBuilder();
        }
        return $this->formBuilder;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConfigEntityListBuilder::getDefaultOperations public function Gets this list's default operations. Overrides EntityListBuilder::getDefaultOperations 15
ConfigEntityListBuilder::load public function Loads entities of this type from storage for listing. Overrides EntityListBuilder::load 7
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
DraggableListBuilder::$entities protected property The entities being listed. 1
DraggableListBuilder::$entitiesKey protected property The key to use for the form element containing the entities. 3
DraggableListBuilder::$formBuilder protected property The form builder.
DraggableListBuilder::$weightKey protected property Name of the entity's weight field or FALSE if no field is provided.
DraggableListBuilder::buildForm public function Form constructor. Overrides FormInterface::buildForm 4
DraggableListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader 5
DraggableListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow 5
DraggableListBuilder::formBuilder protected function Returns the form builder.
DraggableListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render 1
DraggableListBuilder::submitForm public function Form submission handler. Overrides FormInterface::submitForm 5
DraggableListBuilder::validateForm public function Form validation handler. Overrides FormInterface::validateForm 2
DraggableListBuilder::__construct public function Constructs a new EntityListBuilder object. Overrides EntityListBuilder::__construct 5
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::$storage protected property The entity storage class. 1
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 20
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::getOperations public function Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface::getOperations 2
EntityListBuilder::getStorage public function Gets the entity storage. Overrides EntityListBuilderInterface::getStorage
EntityListBuilder::getTitle protected function Gets the title of the page. 1
FormInterface::getFormId public function Returns a unique string identifying the form. 270
MessengerTrait::$messenger protected property The messenger. 17
MessengerTrait::messenger public function Gets the messenger. 17
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. 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.