
| Current Path : /var/www/html/rocksensor3/web/core/lib/Drupal/Core/Entity/ |
Linux ift1.ift-informatik.de 5.4.0-216-generic #236-Ubuntu SMP Fri Apr 11 19:53:21 UTC 2025 x86_64 |
| Current File : /var/www/html/rocksensor3/web/core/lib/Drupal/Core/Entity/DraggableListBuilderTrait.php |
<?php
namespace Drupal\Core\Entity;
use Drupal\Core\Form\FormStateInterface;
/**
* Provides a trait for draggable listings of entities.
*
* Classes using this trait must implement \Drupal\Core\Form\FormInterface and
* are expected to set the $formBuilder property in their constructor.
*/
trait DraggableListBuilderTrait {
/**
* 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;
/**
* Gets the weight of the given entity.
*
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity to get the weight for.
*
* @return int|float
* The weight of the entity.
*/
abstract protected function getWeight(EntityInterface $entity): int|float;
/**
* Sets the weight of an entity.
*
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity whose weight will be set.
* @param int|float $weight
* The weight to set on the entity.
*
* @return $this
*/
abstract protected function setWeight(EntityInterface $entity, int|float $weight): EntityInterface;
/**
* Builds the header row for the entity listing.
*
* @return array
* A render array structure for the header.
*
* @see \Drupal\Core\Entity\EntityListBuilder::buildHeader()
*/
public function buildHeader() {
$header = [];
if (!empty($this->weightKey)) {
$header['weight'] = t('Weight');
}
return $header + parent::buildHeader();
}
/**
* Builds a row for an entity in the entity listing.
*
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity for this row of the list.
*
* @return array
* A render array structure for an entity row.
*
* @see \Drupal\Core\Entity\EntityListBuilder::buildRow()
*/
public function buildRow(EntityInterface $entity) {
$row = [];
if (!empty($this->weightKey)) {
// Override default values to markup elements.
$row['#attributes']['class'][] = 'draggable';
$row['#weight'] = $this->getWeight($entity);
// Add weight column.
$row['weight'] = [
'#type' => 'weight',
'#title' => t('Weight for @title', ['@title' => $entity->label()]),
'#title_display' => 'invisible',
'#default_value' => $this->getWeight($entity),
'#attributes' => ['class' => ['weight']],
];
}
return $row + parent::buildRow($entity);
}
/**
* Builds a listing of entities for the given entity type.
*
* @return array
* A render array structure for the entity list.
*
* @see \Drupal\Core\Entity\EntityListBuilder::render()
*/
public function render() {
if (!empty($this->weightKey)) {
return $this->formBuilder->getForm($this);
}
return parent::render();
}
/**
* Form constructor.
*
* @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.
*
* @return array
* The form structure.
*
* @see \Drupal\Core\Form\FormInterface::buildForm())
*/
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 there are 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;
}
/**
* Form validation handler.
*
* @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.
*
* @see \Drupal\Core\Form\FormInterface::validateForm())
*/
public function validateForm(array &$form, FormStateInterface $form_state) {
// No validation.
}
/**
* Form submission handler.
*
* @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.
*
* @see \Drupal\Core\Form\FormInterface::submitForm()
*
* @throws \Drupal\Core\Entity\EntityStorageException
* If there is a failure when saving the entity.
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
foreach ($form_state->getValue($this->entitiesKey) as $id => $value) {
if (isset($this->entities[$id]) && $this->getWeight($this->entities[$id]) != $value['weight']) {
// Save entity only when its weight was changed.
$this->setWeight($this->entities[$id], $value['weight']);
$this->entities[$id]->save();
}
}
}
}