You are here

function UIkitViewsPluginStyleTable::options_form in UIkit Components 7.2

Same name and namespace in other branches
  1. 7.3 uikit_views/plugins/UIkitViewsPluginStyleTable.inc \UIkitViewsPluginStyleTable::options_form()

Render the given style.

Overrides views_plugin_style::options_form

File

uikit_views/plugins/UIkitViewsPluginStyleTable.inc, line 169
Contains the table style plugin.

Class

UIkitViewsPluginStyleTable
Style plugin to render each item as a row in a UIkit table.

Code

function options_form(&$form, &$form_state) {
  parent::options_form($form, $form_state);
  $args = array(
    '@href' => 'https://getuikit.com/v2/docs/table.html',
    '@title' => 'Table component - UIkit documentation',
  );
  $handlers = $this->display->handler
    ->get_handlers('field');
  if (empty($handlers)) {
    $form['error_markup'] = array(
      '#markup' => '<div class="error messages">' . t('You need at least one field before you can configure your table settings') . '</div>',
    );
    return;
  }
  $form['override'] = array(
    '#type' => 'checkbox',
    '#title' => t('Override normal sorting if click sorting is used'),
    '#default_value' => !empty($this->options['override']),
  );
  $form['sticky'] = array(
    '#type' => 'checkbox',
    '#title' => t('Enable Drupal style "sticky" table headers (Javascript)'),
    '#default_value' => !empty($this->options['sticky']),
    '#description' => t('(Sticky header effects will not be active for preview below, only on live output.)'),
  );
  $form['caption'] = array(
    '#type' => 'textfield',
    '#title' => t('Short description of table'),
    '#description' => t('Include a caption for better accessibility of your table.'),
    '#default_value' => $this->options['caption'],
    '#maxlength' => 255,
  );
  $form['summary'] = array(
    '#type' => 'textfield',
    '#title' => t('Table summary'),
    '#description' => t('This value will be displayed as table-summary attribute in the html. Use this to give a summary of complex tables.'),
    '#default_value' => $this->options['summary'],
    '#maxlength' => 255,
  );
  $form['uikit_table_options'] = array(
    '#type' => 'fieldset',
    '#title' => t('UIkit table options'),
    '#description' => t('Easily create nicely looking tables, which come in different styles. See <a href="@href" target="_blank" title="@title">Table component</a> for more details.', $args),
  );
  $form['uikit_table_options']['responsive_table'] = array(
    '#type' => 'checkbox',
    '#title' => t('Responsive table'),
    '#description' => t('If your table happens to be wider than its container element or would eventually get too big on a specific viewport width, this creates a container that provides a horizontal scrollbar whenever the elements inside it are wider than the container itself.'),
    '#default_value' => $this->options['uikit_table_options']['responsive_table'],
  );
  $form['uikit_table_options']['vertical_modifier'] = array(
    '#type' => 'checkbox',
    '#title' => t('Vertical modifider'),
    '#description' => t('Vertically center table content.'),
    '#default_value' => $this->options['uikit_table_options']['vertical_modifier'],
  );
  $form['uikit_table_options']['table_modifiers'] = array(
    '#type' => 'checkboxes',
    '#title' => t('Table modifiers'),
    '#description' => t('Display the table in a different style. These modifiers can be used together.'),
    '#default_value' => $this->options['uikit_table_options']['table_modifiers'],
    '#options' => array(
      'hover' => t('Hover (displays a hover state on table rows)'),
      'striped' => t('Striped (adds zebra-striping on table rows)'),
      'condensed' => t('Condensed (compacts table rows to use less space)'),
    ),
  );

  // Note: views UI registers this theme handler on our behalf. Your module
  // will have to register your theme handlers if you do stuff like this.
  $form['#theme'] = 'views_ui_style_plugin_table';
  $columns = $this
    ->sanitize_columns($this->options['columns']);

  // Create an array of allowed columns from the data we know:
  $field_names = $this->display->handler
    ->get_field_labels();
  if (isset($this->options['default'])) {
    $default = $this->options['default'];
    if (!isset($columns[$default])) {
      $default = -1;
    }
  }
  else {
    $default = -1;
  }
  foreach ($columns as $field => $column) {
    $safe = str_replace(array(
      '][',
      '_',
      ' ',
    ), '-', $field);

    // the $id of the column for dependency checking.
    $id = 'edit-style-options-columns-' . $safe;
    $form['columns'][$field] = array(
      '#type' => 'select',
      '#options' => $field_names,
      '#default_value' => $column,
    );
    if ($handlers[$field]
      ->click_sortable()) {
      $form['info'][$field]['sortable'] = array(
        '#type' => 'checkbox',
        '#default_value' => !empty($this->options['info'][$field]['sortable']),
        '#dependency' => array(
          $id => array(
            $field,
          ),
        ),
      );
      $form['info'][$field]['default_sort_order'] = array(
        '#type' => 'select',
        '#options' => array(
          'asc' => t('Ascending'),
          'desc' => t('Descending'),
        ),
        '#default_value' => !empty($this->options['info'][$field]['default_sort_order']) ? $this->options['info'][$field]['default_sort_order'] : 'asc',
        '#dependency_count' => 2,
        '#dependency' => array(
          $id => array(
            $field,
          ),
          'edit-style-options-info-' . $safe . '-sortable' => array(
            1,
          ),
        ),
      );

      // Provide an ID so we can have such things.
      $radio_id = drupal_html_id('edit-default-' . $field);
      $form['default'][$field] = array(
        '#type' => 'radio',
        '#return_value' => $field,
        '#parents' => array(
          'style_options',
          'default',
        ),
        '#id' => $radio_id,
        // because 'radio' doesn't fully support '#id' =(
        '#attributes' => array(
          'id' => $radio_id,
        ),
        '#default_value' => $default,
        '#dependency' => array(
          $id => array(
            $field,
          ),
        ),
      );
    }
    $form['info'][$field]['align'] = array(
      '#type' => 'select',
      '#default_value' => !empty($this->options['info'][$field]['align']) ? $this->options['info'][$field]['align'] : '',
      '#options' => array(
        '' => t('None'),
        'views-align-left' => t('Left'),
        'views-align-center' => t('Center'),
        'views-align-right' => t('Right'),
      ),
      '#dependency' => array(
        $id => array(
          $field,
        ),
      ),
    );
    $form['info'][$field]['separator'] = array(
      '#type' => 'textfield',
      '#size' => 10,
      '#default_value' => isset($this->options['info'][$field]['separator']) ? $this->options['info'][$field]['separator'] : '',
      '#dependency' => array(
        $id => array(
          $field,
        ),
      ),
    );
    $form['info'][$field]['empty_column'] = array(
      '#type' => 'checkbox',
      '#default_value' => isset($this->options['info'][$field]['empty_column']) ? $this->options['info'][$field]['empty_column'] : FALSE,
      '#dependency' => array(
        $id => array(
          $field,
        ),
      ),
    );

    // markup for the field name
    $form['info'][$field]['name'] = array(
      '#markup' => $field_names[$field],
    );
  }

  // Provide a radio for no default sort
  $form['default'][-1] = array(
    '#type' => 'radio',
    '#return_value' => -1,
    '#parents' => array(
      'style_options',
      'default',
    ),
    '#id' => 'edit-default-0',
    '#default_value' => $default,
  );
  $form['empty_table'] = array(
    '#type' => 'checkbox',
    '#title' => t('Show the empty text in the table'),
    '#default_value' => $this->options['empty_table'],
    '#description' => t('Per default the table is hidden for an empty view. With this option it is posible to show an empty table with the text in it.'),
  );
  $form['description_markup'] = array(
    '#markup' => '<div class="description form-item">' . t('Place fields into columns; you may combine multiple fields into the same column. If you do, the separator in the column specified will be used to separate the fields. Check the sortable box to make that column click sortable, and check the default sort radio to determine which column will be sorted by default, if any. You may control column order and field labels in the fields section.') . '</div>',
  );
}