public static function Tableselect::preRenderTableselect

public static Tableselect::preRenderTableselect($element)

Prepares a 'tableselect' #type element for rendering.

Adds a column of radio buttons or checkboxes for each row of a table.

Parameters

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:

    $options = array(
      array(
        'title' => $this->t('How to Learn Drupal'),
        'content_type' => $this->t('Article'),
        'status' => 'published',
        '#attributes' => array('class' => array('article-row')),
      ),
      array(
        'title' => $this->t('Privacy Policy'),
        'content_type' => $this->t('Page'),
        'status' => 'published',
        '#attributes' => array('class' => array('page-row')),
      ),
    );
    $header = array(
      'title' => $this->t('Title'),
      'content_type' => $this->t('Content type'),
      'status' => $this->t('Status'),
    );
    $form['table'] = array(
      '#type' => 'tableselect',
      '#header' => $header,
      '#options' => $options,
      '#empty' => $this->t('No content available.'),
    );
  

Return value

array The processed element.

File

core/lib/Drupal/Core/Render/Element/Tableselect.php, line 149

Class

Tableselect
Provides a form element for a table with radios or checkboxes in left column.

Namespace

Drupal\Core\Render\Element

Code

public static function preRenderTableselect($element) {
  $rows = array();
  $header = $element['#header'];
  if (!empty($element['#options'])) {
    // Generate a table row for each selectable item in #options.
    foreach (Element::children($element) as $key) {
      $row = array();

      $row['data'] = array();
      if (isset($element['#options'][$key]['#attributes'])) {
        $row += $element['#options'][$key]['#attributes'];
      }
      // Render the checkbox / radio element.
      $row['data'][] = drupal_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];
          }
        }
      }
      $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, array('class' => array('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;
}

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Render!Element!Tableselect.php/function/Tableselect::preRenderTableselect/8.1.x