class Tableselect
Same name in other branches
- 9 core/lib/Drupal/Core/Render/Element/Tableselect.php \Drupal\Core\Render\Element\Tableselect
- 8.9.x core/lib/Drupal/Core/Render/Element/Tableselect.php \Drupal\Core\Render\Element\Tableselect
- 10 core/lib/Drupal/Core/Render/Element/Tableselect.php \Drupal\Core\Render\Element\Tableselect
Provides a form element for a table with radios or checkboxes in left column.
Properties:
- #header: An array of table header labels.
- #options: An associative array where each key is the value returned when a user selects the radio button or checkbox, and each value is the row of table data.
- #empty: The message to display if table does not have any options.
- #multiple: Set to FALSE to render the table with radios instead checkboxes.
- #js_select: Set to FALSE if you don't want the select all checkbox added to the header.
Other properties of the \Drupal\Core\Render\Element\Table element are also available.
Usage example:
$header = [
'color' => $this->t('Color'),
'shape' => $this->t('Shape'),
];
$options = [
1 => [
'color' => 'Red',
'shape' => 'Triangle',
],
2 => [
'color' => 'Green',
'shape' => 'Square',
],
// Prevent users from selecting a row by adding a '#disabled' property set
// to TRUE.
3 => [
'color' => 'Blue',
'shape' => 'Hexagon',
'#disabled' => TRUE,
],
];
$form['table'] = [
'#type' => 'tableselect',
'#header' => $header,
'#options' => $options,
'#empty' => $this->t('No shapes found'),
];See https://www.drupal.org/node/945102 for a full explanation.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Render\Element\ElementInterface
- class \Drupal\Core\Render\Element\FormElementBase extends \Drupal\Core\Render\Element\RenderElementBase implements \Drupal\Core\Render\Element\FormElementInterface
- class \Drupal\Core\Render\Element\Table extends \Drupal\Core\Render\Element\FormElementBase
- class \Drupal\Core\Render\Element\Tableselect extends \Drupal\Core\Render\Element\Table
- class \Drupal\Core\Render\Element\Table extends \Drupal\Core\Render\Element\FormElementBase
- class \Drupal\Core\Render\Element\FormElementBase extends \Drupal\Core\Render\Element\RenderElementBase implements \Drupal\Core\Render\Element\FormElementInterface
- class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Render\Element\ElementInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of Tableselect
See also
\Drupal\Core\Render\Element\Table
1 file declares its use of Tableselect
- TableSelectTest.php in core/
tests/ Drupal/ Tests/ Core/ Render/ Element/ TableSelectTest.php
3 string references to 'Tableselect'
- FormTestTableSelectMultipleFalseForm::submitForm in core/
modules/ system/ tests/ modules/ form_test/ src/ Form/ FormTestTableSelectMultipleFalseForm.php - FormTestTableSelectMultipleTrueForm::submitForm in core/
modules/ system/ tests/ modules/ form_test/ src/ Form/ FormTestTableSelectMultipleTrueForm.php - FormValidator::performRequiredValidation in core/
lib/ Drupal/ Core/ Form/ FormValidator.php - Performs validation of elements that are not subject to limited validation.
File
-
core/
lib/ Drupal/ Core/ Render/ Element/ Tableselect.php, line 54
Namespace
Drupal\Core\Render\ElementView source
class Tableselect extends Table {
/**
* {@inheritdoc}
*/
public function getInfo() {
$class = static::class;
return [
'#input' => TRUE,
'#js_select' => TRUE,
'#multiple' => TRUE,
'#responsive' => TRUE,
'#sticky' => FALSE,
'#pre_render' => [
[
$class,
'preRenderTable',
],
[
$class,
'preRenderTableselect',
],
],
'#process' => [
[
$class,
'processTableselect',
],
],
'#options' => [],
'#empty' => '',
'#theme' => 'table__tableselect',
];
}
/**
* {@inheritdoc}
*/
public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
// If $element['#multiple'] == FALSE, then radio buttons are displayed and
// the default value handling is used.
if (isset($element['#multiple']) && $element['#multiple']) {
// Checkboxes are being displayed with the default value coming from the
// keys of the #default_value property. This differs from the checkboxes
// element which uses the array values.
if ($input === FALSE) {
$value = [];
$element += [
'#default_value' => [],
];
foreach ($element['#default_value'] as $key => $flag) {
if ($flag) {
$value[$key] = $key;
}
}
return $value;
}
else {
return is_array($input) ? array_combine($input, $input) : [];
}
}
}
/**
* Prepares a 'tableselect' #type element for rendering.
*
* Adds a column of radio buttons or checkboxes for each row of a table.
*
* @param array $element
* An associative array containing the properties and children of
* the tableselect element. Properties used: #header, #options, #empty,
* and #js_select. The #options property is an array of selection options;
* each array element of #options is an array of properties. These
* properties can include #attributes, which is added to the
* table row's HTML attributes; see table.html.twig. An example of per-row
* options:
* @code
* $options = [
* [
* 'title' => $this->t('How to Learn Drupal'),
* 'content_type' => $this->t('Article'),
* 'status' => 'published',
* '#attributes' => ['class' => ['article-row']],
* ],
* [
* 'title' => $this->t('Privacy Policy'),
* 'content_type' => $this->t('Page'),
* 'status' => 'published',
* '#attributes' => ['class' => ['page-row']],
* ],
* ];
* $header = [
* 'title' => $this->t('Title'),
* 'content_type' => $this->t('Content type'),
* 'status' => $this->t('Status'),
* ];
* $form['table'] = [
* '#type' => 'tableselect',
* '#header' => $header,
* '#options' => $options,
* '#empty' => $this->t('No content available.'),
* ];
* @endcode
*
* @return array
* The processed element.
*/
public static function preRenderTableselect($element) {
$rows = [];
$header = $element['#header'];
if (!empty($element['#options'])) {
// Generate a table row for each selectable item in #options.
foreach (Element::children($element) as $key) {
$row = [];
$row['data'] = [];
if (isset($element['#options'][$key]['#attributes'])) {
$row += $element['#options'][$key]['#attributes'];
}
// Render the checkbox / radio element.
$row['data'][] = \Drupal::service('renderer')->render($element[$key]);
// As table.html.twig only maps header and row columns by order, create
// the correct order by iterating over the header fields.
foreach ($element['#header'] as $fieldname => $title) {
// A row cell can span over multiple headers, which means less row
// cells than headers could be present.
if (isset($element['#options'][$key][$fieldname])) {
// A header can span over multiple cells and in this case the cells
// are passed in an array. The order of this array determines the
// order in which they are added.
if (is_array($element['#options'][$key][$fieldname]) && !isset($element['#options'][$key][$fieldname]['data'])) {
foreach ($element['#options'][$key][$fieldname] as $cell) {
$row['data'][] = $cell;
}
}
else {
$row['data'][] = $element['#options'][$key][$fieldname];
}
}
}
if (!empty($element['#options'][$key]['#disabled'])) {
$row['class'][] = 'disabled';
}
$rows[] = $row;
}
// Add an empty header or a "Select all" checkbox to provide room for the
// checkboxes/radios in the first table column.
if ($element['#js_select']) {
// Add a "Select all" checkbox.
$element['#attached']['library'][] = 'core/drupal.tableselect';
array_unshift($header, [
'class' => [
'select-all',
],
]);
}
else {
// Add an empty header when radio buttons are displayed or a "Select all"
// checkbox is not desired.
array_unshift($header, '');
}
}
$element['#header'] = $header;
$element['#rows'] = $rows;
return $element;
}
/**
* Creates checkbox or radio elements to populate a tableselect table.
*
* @param array $element
* An associative array containing the properties and children of the
* tableselect element.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
* @param array $complete_form
* The complete form structure.
*
* @return array
* The processed element.
*/
public static function processTableselect(&$element, FormStateInterface $form_state, &$complete_form) {
if ($element['#multiple']) {
$value = is_array($element['#value']) ? $element['#value'] : [];
}
else {
// Advanced selection behavior makes no sense for radios.
$element['#js_select'] = FALSE;
}
$element['#tree'] = TRUE;
if (count($element['#options']) > 0) {
if (!isset($element['#default_value']) || $element['#default_value'] === 0) {
$element['#default_value'] = [];
}
// Create a checkbox or radio for each item in #options in such a way that
// the value of the tableselect element behaves as if it had been of type
// checkboxes or radios.
foreach ($element['#options'] as $key => $choice) {
// Do not overwrite manually created children.
if (!isset($element[$key])) {
$disabled = !empty($element['#options'][$key]['#disabled']);
if ($element['#multiple']) {
$title = '';
if (isset($element['#options'][$key]['title']) && is_array($element['#options'][$key]['title'])) {
if (!empty($element['#options'][$key]['title']['data']['#title'])) {
$title = new TranslatableMarkup('Update @title', [
'@title' => $element['#options'][$key]['title']['data']['#title'],
]);
}
}
$element[$key] = [
'#type' => 'checkbox',
'#title' => $title,
'#title_display' => 'invisible',
'#return_value' => $key,
'#default_value' => isset($value[$key]) ? $key : NULL,
'#attributes' => $element['#attributes'],
'#disabled' => $disabled,
'#ajax' => $element['#ajax'] ?? NULL,
];
}
else {
// Generate the parents as the autogenerator does, so we will have a
// unique id for each radio button.
$parents_for_id = array_merge($element['#parents'], [
$key,
]);
$element[$key] = [
'#type' => 'radio',
'#title' => '',
'#return_value' => $key,
'#default_value' => $element['#default_value'] == $key ? $key : NULL,
'#attributes' => $element['#attributes'],
'#parents' => $element['#parents'],
'#id' => HtmlUtility::getUniqueId('edit-' . implode('-', $parents_for_id)),
'#disabled' => $disabled,
'#ajax' => $element['#ajax'] ?? NULL,
];
}
if (isset($element['#options'][$key]['#weight'])) {
$element[$key]['#weight'] = $element['#options'][$key]['#weight'];
}
}
}
}
else {
$element['#value'] = [];
}
return $element;
}
}Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
|---|---|---|---|---|---|
| FormElementBase::processAutocomplete | public static | function | Adds autocomplete functionality to elements. | 1 | |
| FormElementBase::processPattern | public static | function | #process callback for #pattern form element property. | 1 | |
| FormElementBase::validatePattern | public static | function | #element_validate callback for #pattern form element property. | 1 | |
| PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 6 | |
| PluginInspectionInterface::getPluginId | public | function | Gets the plugin ID of the plugin instance. | 2 | |
| RenderElementBase::preRenderAjaxForm | public static | function | Adds Ajax information about an element to communicate with JavaScript. | 2 | |
| RenderElementBase::preRenderGroup | public static | function | Adds members of this group as actual elements for rendering. | 2 | |
| RenderElementBase::processAjaxForm | public static | function | Form element processing handler for the #ajax form property. | 3 | |
| RenderElementBase::processGroup | public static | function | Arranges elements into groups. | 2 | |
| RenderElementBase::setAttributes | public static | function | Overrides ElementInterface::setAttributes | 2 | |
| Table::preRenderTable | public static | function | #pre_render callback to transform children of an element of #type 'table'. | ||
| Table::processTable | public static | function | #process callback for #type 'table' to add tableselect support. | ||
| Table::validateTable | public static | function | #element_validate callback for #type 'table'. | ||
| Tableselect::getInfo | public | function | Overrides Table::getInfo | ||
| Tableselect::preRenderTableselect | public static | function | Prepares a 'tableselect' #type element for rendering. | ||
| Tableselect::processTableselect | public static | function | Creates checkbox or radio elements to populate a tableselect table. | ||
| Tableselect::valueCallback | public static | function | Overrides Table::valueCallback |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.