ViewsBootstrapTable.php in Views Bootstrap 8.3

Namespace

Drupal\views_bootstrap\Plugin\views\style

File

src/Plugin/views/style/ViewsBootstrapTable.php

<?php

namespace Drupal\views_bootstrap\Plugin\views\style;

use Drupal\Core\Form\FormStateInterface;
use Drupal\views\Plugin\views\style\Table;

/**
 * Style plugin to render each item as a row in a Bootstrap table.
 *
 * @ingroup views_style_plugins
 *
 * @ViewsStyle(
 *   id = "views_bootstrap_table",
 *   title = @Translation("Bootstrap Table"),
 *   help = @Translation("Displays rows in a Bootstrap table."),
 *   theme = "views_bootstrap_table",
 *   theme_file = "../views_bootstrap.theme.inc",
 *   display_types = {"normal"}
 * )
 */
class ViewsBootstrapTable extends Table {

  /**
   * Definition.
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['bootstrap_styles'] = [
      'default' => [],
    ];
    $options['caption'] = [
      'default' => '',
    ];
    $options['summary'] = [
      'default' => '',
    ];
    $options['description'] = [
      'default' => '',
    ];
    $options['responsive'] = [
      'default' => FALSE,
    ];
    return $options;
  }

  /**
   * Render the given style.
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['help'] = [
      '#markup' => $this
        ->t('The Bootstrap table style adds default Bootstrap table classes and optional classes (<a href=":docs">see documentation</a>).', [
        ':docs' => 'https://www.drupal.org/docs/contributed-modules/views-bootstrap-for-bootstrap-3/table',
      ]),
      '#weight' => -99,
    ];
    $form['responsive'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Responsive'),
      '#default_value' => $this->options['responsive'],
      '#description' => $this
        ->t('To make a table scroll horizontally on small devices.'),
    ];
    $form['bootstrap_styles'] = [
      '#title' => $this
        ->t('Bootstrap styles'),
      '#type' => 'checkboxes',
      '#default_value' => $this->options['bootstrap_styles'],
      '#options' => [
        'striped' => $this
          ->t('Striped'),
        'bordered' => $this
          ->t('Bordered'),
        'hover' => $this
          ->t('Hover'),
        'condensed' => $this
          ->t('Condensed'),
      ],
    ];
    $form['caption'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Caption for the table'),
      '#description' => $this
        ->t('A title semantically associated with your table for increased accessibility.'),
      '#default_value' => $this->options['caption'],
      '#maxlength' => 255,
    ];
    $form['accessibility_details'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Table details'),
    ];
    $form['summary'] = [
      '#title' => $this
        ->t('Summary title'),
      '#type' => 'textfield',
      '#default_value' => $this->options['summary'],
      '#fieldset' => 'accessibility_details',
    ];
    $form['description'] = [
      '#title' => $this
        ->t('Table description'),
      '#type' => 'textarea',
      '#description' => $this
        ->t('Provide additional details about the table to increase accessibility.'),
      '#default_value' => $this->options['description'],
      '#states' => [
        'visible' => [
          ':input[name="style_options[summary]"]' => [
            'filled' => TRUE,
          ],
        ],
      ],
      '#fieldset' => 'accessibility_details',
    ];
  }

}

Classes

Name	Description
ViewsBootstrapTable	Style plugin to render each item as a row in a Bootstrap table.