class ViewsBootstrapDropdownPluginStyle in Views Bootstrap 7.3
Class to define a style plugin handler.
Hierarchy
- class \views_object
- class \views_plugin
- class \views_plugin_style
- class \views_plugin
Expanded class hierarchy of ViewsBootstrapDropdownPluginStyle
1 string reference to 'ViewsBootstrapDropdownPluginStyle'
- views_bootstrap_views_plugins in ./
views_bootstrap.views.inc - Implements hook_views_plugins().
File
- plugins/
dropdown/ views_bootstrap_dropdown_plugin_style.inc, line 11 - Definition of views_bootstrap_plugin_style.
View source
class ViewsBootstrapDropdownPluginStyle extends views_plugin_style {
/**
* Definition.
*/
public function option_definition() {
$options = parent::option_definition();
$options['class'] = array(
'default' => NULL,
);
$options['wrapper_class'] = array(
'default' => NULL,
);
$options['button_text'] = array(
'default' => 'Select',
);
$options['button_class'] = array(
'default' => 'btn-default',
);
return $options;
}
/**
* Options form.
*/
public function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
$form['help'] = array(
'#markup' => t('The Bootstrap dropdown style displays a list of links in a drop-down menu format (<a href="!docs">see Bootstrap documentation</a>).', [
'!docs' => 'https://www.drupal.org/docs/7/modules/views-bootstrap/dropdown',
]),
'#weight' => -99,
);
$form['wrapper_class'] = array(
'#title' => t('Wrapper class'),
'#description' => t('The class to provide on the wrapper, outside the list.'),
'#type' => 'textfield',
'#size' => '30',
'#default_value' => $this->options['wrapper_class'],
);
$form['button_text'] = array(
'#title' => t('Button text'),
'#description' => t('Text label for the button that is the drop-down toggle.'),
'#type' => 'textfield',
'#default_value' => $this->options['button_text'],
);
$form['button_class'] = array(
'#title' => t('Button class'),
'#description' => t('Classes for the button that is the dropdown toggle.'),
'#type' => 'select',
'#options' => array(
'btn-default' => t('Default'),
'btn-primary' => t('Primary'),
'btn-success' => t('Success'),
'btn-info' => t('Info'),
'btn-warning' => t('Warning'),
'btn-danger' => t('Danger'),
),
'#default_value' => $this->options['button_class'],
);
$form['class'] = array(
'#title' => t('List class'),
'#description' => t('The class to provide on the list element itself.'),
'#type' => 'textfield',
'#size' => '30',
'#default_value' => $this->options['class'],
);
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ViewsBootstrapDropdownPluginStyle:: |
public | function |
Options form. Overrides views_plugin_style:: |
|
ViewsBootstrapDropdownPluginStyle:: |
public | function |
Definition. Overrides views_plugin_style:: |
|
views_object:: |
public | property | Handler's definition. | |
views_object:: |
public | property | Except for displays, options for the object will be held here. | 1 |
views_object:: |
function | Collect this handler's option definition and alter them, ready for use. | ||
views_object:: |
public | function | Views handlers use a special construct function. | 4 |
views_object:: |
public | function | 1 | |
views_object:: |
public | function | ||
views_object:: |
public | function | Always exports the option, regardless of the default value. | |
views_object:: |
public | function | Set default options on this object. | 1 |
views_object:: |
public | function | Set default options. | |
views_object:: |
public | function | Let the handler know what its full definition is. | |
views_object:: |
public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
views_object:: |
public | function | Unpack a single option definition. | |
views_object:: |
public | function | Unpacks each handler to store translatable texts. | |
views_object:: |
public | function | ||
views_plugin:: |
public | property | The current used views display. | |
views_plugin:: |
public | property | The plugin name of this plugin, for example table or full. | |
views_plugin:: |
public | property | The plugin type of this plugin, for example style or query. | |
views_plugin:: |
public | property |
The top object of a view. Overrides views_object:: |
1 |
views_plugin:: |
public | function | Provide a list of additional theme functions for the theme info page. | |
views_plugin:: |
public | function | Handle any special handling on the validate form. | 9 |
views_plugin:: |
public | function | Return the human readable name of the display. | |
views_plugin:: |
public | function | Returns the summary of the settings in the display. | 8 |
views_plugin:: |
public | function | Provide a full list of possible theme templates used by this style. | |
views_plugin_style:: |
public | property | The row plugin, if it's initialized and the style itself supports it. | |
views_plugin_style:: |
public | property | Store all available tokens row rows. | |
views_plugin_style:: |
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:: |
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:: |
public | function |
Destructor. Overrides views_object:: |
|
views_plugin_style:: |
public | function | Should the output of the style plugin be rendered even if it's empty. | 1 |
views_plugin_style:: |
public | function | Get a rendered field. | |
views_plugin_style:: |
public | function | Get the raw field value. | |
views_plugin_style:: |
public | function | Return the token replaced row class for the specified row. | |
views_plugin_style:: |
public | function | Initialize a style plugin. | |
views_plugin_style:: |
public | function |
Validate the options form. Overrides views_plugin:: |
|
views_plugin_style:: |
public | function | Allow the style to do stuff before each row is rendered. | |
views_plugin_style:: |
public | function |
Add anything to the query that we might need to. Overrides views_plugin:: |
2 |
views_plugin_style:: |
public | function | Render the display in this style. | 5 |
views_plugin_style:: |
public | function | Render all of the fields for a given style and store them on the object. | |
views_plugin_style:: |
public | function | Group records as needed for rendering. | |
views_plugin_style:: |
public | function | Render the grouping sets. | |
views_plugin_style:: |
public | function | Take a value and apply token replacement logic to it. | |
views_plugin_style:: |
public | function | Return TRUE if this style also uses fields. | |
views_plugin_style:: |
public | function | Return TRUE if this style also uses a row plugin. | |
views_plugin_style:: |
public | function | Return TRUE if this style also uses a row plugin. | |
views_plugin_style:: |
public | function | Return TRUE if this style uses tokens. | |
views_plugin_style:: |
public | function |
Validate that the plugin is correct and can be saved. Overrides views_plugin:: |