You are here

Home » API reference » Views Bootstrap 7.3 » views_bootstrap_panel_plugin_style.inc

class ViewsBootstrapPanelPluginStyle in Views Bootstrap 7.3

Class to define a style plugin handler.

Hierarchy

Expanded class hierarchy of ViewsBootstrapPanelPluginStyle

1 string reference to 'ViewsBootstrapPanelPluginStyle'
views_bootstrap_views_plugins in ./views_bootstrap.views.inc
Implements hook_views_plugins().

File

plugins/panel/views_bootstrap_panel_plugin_style.inc, line 11
Definition of views_bootstrap_plugin_style.

View source 
class ViewsBootstrapPanelPluginStyle extends views_plugin_style {

  /**
   * Definition.
   */
  public function option_definition() {
    $options = parent::option_definition();
    $options['heading_field'] = array(
      'default' => NULL,
    );
    $options['title'] = array(
      'default' => FALSE,
    );
    $options['title_tag'] = array(
      'default' => 'h3',
    );
    $options['label_field'] = array(
      'default' => NULL,
    );
    $options['footer_field'] = array(
      'default' => NULL,
    );
    $options['context'] = array(
      'default' => 'default',
    );
    return $options;
  }

  /**
   * Options form.
   */
  public function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    if (isset($form['grouping'])) {
      $options = array();
      foreach (element_children($form['grouping']) as $key => $value) {
        if (!empty($form['grouping'][$key]['field']['#options']) && is_array($form['grouping'][$key]['field']['#options'])) {
          $options = array_merge($options, $form['grouping'][$key]['field']['#options']);
        }
      }
      $form['help'] = array(
        '#markup' => t('The Bootstrap panels displays content in a box with optional header and footer elements (<a href="!docs">see documentation</a>).', [
          '!docs' => 'https://www.drupal.org/docs/7/modules/views-bootstrap/panels',
        ]),
        '#weight' => -99,
      );
      $form['heading_field'] = array(
        '#type' => 'select',
        '#title' => t('Heading field'),
        '#options' => $options,
        '#default_value' => $this->options['heading_field'],
        '#description' => t('Select the field that will be used as the heading.'),
        '#id' => 'heading-field',
      );
      $field_labels = $this->display->handler
        ->get_field_labels(TRUE);
      $form['title'] = array(
        '#type' => 'checkbox',
        '#title' => t('Use panel-title class'),
        '#default_value' => $this->options['title'],
        '#states' => array(
          'invisible' => array(
            ':input#heading-field' => array(
              'value' => '',
            ),
          ),
        ),
        '#id' => 'title-checkbox',
      );
      $t_options = array(
        'h1' => t('h1'),
        'h2' => t('h2'),
        'h3' => t('h3'),
        'h4' => t('h4'),
        'h5' => t('h5'),
        'h6' => t('h6'),
        'div' => t('div'),
      );
      $form['title_tag'] = array(
        '#type' => 'select',
        '#title' => t('Title tag'),
        '#options' => $t_options,
        '#default_value' => $this->options['title_tag'],
        '#description' => t('Select the tag to use around the title.'),
        '#states' => array(
          'visible' => array(
            ':input#title-checkbox' => array(
              'checked' => TRUE,
            ),
          ),
        ),
      );
      $form['label_field'] = array(
        '#type' => 'select',
        '#title' => t('Label field'),
        '#options' => $options,
        '#required' => FALSE,
        '#default_value' => $this->options['label_field'],
        '#description' => t('Select the field that will be used as the label.'),
        '#states' => array(
          'invisible' => array(
            ':input#heading-field' => array(
              'value' => '',
            ),
          ),
        ),
      );
      $form['footer_field'] = array(
        '#type' => 'select',
        '#title' => t('Footer field'),
        '#options' => $options,
        '#default_value' => $this->options['footer_field'],
        '#description' => t('Select the field that will be used as the footer.'),
      );
      $c_options = array(
        'default' => t('Default'),
        'primary' => t('Primary'),
        'success' => t('Success'),
        'info' => t('Info'),
        'warning' => t('Warning'),
        'danger' => t('Danger'),
      );
      $form['context'] = array(
        '#type' => 'select',
        '#title' => t('Contextual class'),
        '#options' => $c_options,
        '#default_value' => $this->options['context'],
        '#description' => t('<a href="!docs">see Bootstrap documentation</a>', [
          '!docs' => 'https://getbootstrap.com/docs/3.4/components/#panels-alternatives',
        ]),
      );
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ViewsBootstrapPanelPluginStyle::options_form public function Options form. Overrides views_plugin_style::options_form
ViewsBootstrapPanelPluginStyle::option_definition public function Definition. Overrides views_plugin_style::option_definition
views_object::$definition public property Handler's definition.
views_object::$options public property Except for displays, options for the object will be held here. 1
views_object::altered_option_definition function Collect this handler's option definition and alter them, ready for use.
views_object::construct public function Views handlers use a special construct function. 4
views_object::export_option public function 1
views_object::export_options public function
views_object::export_option_always public function Always exports the option, regardless of the default value.
views_object::options Deprecated public function Set default options on this object. 1
views_object::set_default_options public function Set default options.
views_object::set_definition public function Let the handler know what its full definition is.
views_object::unpack_options public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable public function Unpack a single option definition.
views_object::unpack_translatables public function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults public function
views_plugin::$display public property The current used views display.
views_plugin::$plugin_name public property The plugin name of this plugin, for example table or full.
views_plugin::$plugin_type public property The plugin type of this plugin, for example style or query.
views_plugin::$view public property The top object of a view. Overrides views_object::$view 1
views_plugin::additional_theme_functions public function Provide a list of additional theme functions for the theme info page.
views_plugin::options_submit public function Handle any special handling on the validate form. 9
views_plugin::plugin_title public function Return the human readable name of the display.
views_plugin::summary_title public function Returns the summary of the settings in the display. 8
views_plugin::theme_functions public function Provide a full list of possible theme templates used by this style.
views_plugin_style::$row_plugin public property The row plugin, if it's initialized and the style itself supports it.
views_plugin_style::$row_tokens public property Store all available tokens row rows.
views_plugin_style::build_sort public function Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query. 1
views_plugin_style::build_sort_post public function Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view. 1
views_plugin_style::destroy public function Destructor. Overrides views_object::destroy
views_plugin_style::even_empty public function Should the output of the style plugin be rendered even if it's empty. 1
views_plugin_style::get_field public function Get a rendered field.
views_plugin_style::get_field_value public function Get the raw field value.
views_plugin_style::get_row_class public function Return the token replaced row class for the specified row.
views_plugin_style::init public function Initialize a style plugin.
views_plugin_style::options_validate public function Validate the options form. Overrides views_plugin::options_validate
views_plugin_style::pre_render public function Allow the style to do stuff before each row is rendered.
views_plugin_style::query public function Add anything to the query that we might need to. Overrides views_plugin::query 2
views_plugin_style::render public function Render the display in this style. 5
views_plugin_style::render_fields public function Render all of the fields for a given style and store them on the object.
views_plugin_style::render_grouping public function Group records as needed for rendering.
views_plugin_style::render_grouping_sets public function Render the grouping sets.
views_plugin_style::tokenize_value public function Take a value and apply token replacement logic to it.
views_plugin_style::uses_fields public function Return TRUE if this style also uses fields.
views_plugin_style::uses_row_class public function Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_row_plugin public function Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_tokens public function Return TRUE if this style uses tokens.
views_plugin_style::validate public function Validate that the plugin is correct and can be saved. Overrides views_plugin::validate