class ViewsBootstrapThumbnailPluginStyle in Views Bootstrap 7.3
Same name and namespace in other branches
- 7 plugins/thumbnail/views_bootstrap_thumbnail_plugin_style.inc \ViewsBootstrapThumbnailPluginStyle
- 7.2 plugins/thumbnail/views_bootstrap_thumbnail_plugin_style.inc \ViewsBootstrapThumbnailPluginStyle
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 ViewsBootstrapThumbnailPluginStyle
1 string reference to 'ViewsBootstrapThumbnailPluginStyle'
- views_bootstrap_views_plugins in ./
views_bootstrap.views.inc - Implements hook_views_plugins().
File
- plugins/
thumbnail/ views_bootstrap_thumbnail_plugin_style.inc, line 11 - Definition of views_bootstrap_plugin_style.
View source
class ViewsBootstrapThumbnailPluginStyle extends views_plugin_style {
/**
* Definition.
*/
public function option_definition() {
$options = parent::option_definition();
$options['alignment'] = array(
'default' => 'horizontal',
);
$options['columns_horizontal'] = array(
'default' => -1,
);
$options['columns_vertical'] = array(
'default' => 4,
);
$options['clear_columns'] = array(
'default' => TRUE,
'bool' => TRUE,
);
$options['columns_xs'] = array(
'default' => 12,
);
$options['columns_sm'] = array(
'default' => 6,
);
$options['columns_md'] = array(
'default' => 4,
);
$options['columns_lg'] = array(
'default' => 3,
);
$options['column_class'] = array(
'default' => '',
);
return $options;
}
/**
* Form.
*/
public function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
$form['help'] = array(
'#markup' => t('The Bootstrap thumbnails extends the grid display with the thumbnail component to showcase linked images (<a href="!docs">see documentation</a>).', [
'!docs' => 'https://www.drupal.org/docs/7/modules/views-bootstrap/thumbnail',
]),
'#weight' => -99,
);
$form['alignment'] = array(
'#type' => 'radios',
'#title' => t('Alignment'),
'#options' => array(
'horizontal' => t('Horizontal'),
'vertical' => t('Vertical'),
),
'#description' => t('Horizontal alignment will place items starting in the upper left and moving right. Vertical alignment will place items starting in the upper left and moving down.'),
'#default_value' => $this->options['alignment'],
);
$options = array(
1 => 1,
2 => 2,
3 => 3,
4 => 4,
6 => 6,
12 => 12,
);
// Number of columns wrapped in a views row for horizontal alignment.
$form['columns_horizontal'] = array(
'#type' => 'select',
'#title' => t('Number of columns per views row'),
'#options' => array(
-1 => 'Single row',
0 => 'Auto',
) + $options,
'#required' => TRUE,
'#description' => t('Choose the number of columns that views will wrap in a single row. This will be reflected in the HTML structure rendered regardless of the device size. When the "Single row" value is selected, all columns will be wrapped in one row.'),
'#default_value' => $this->options['columns_horizontal'],
'#states' => array(
'visible' => array(
'input[name="style_options[alignment]"]' => array(
'value' => 'horizontal',
),
),
),
);
// Number of columns for vertical alignment.
$form['columns_vertical'] = array(
'#type' => 'select',
'#title' => t('Number of columns'),
'#options' => $options,
'#required' => TRUE,
'#description' => t('Choose the number of columns that content will be split into'),
'#default_value' => $this->options['columns_vertical'],
'#states' => array(
'visible' => array(
'input[name="style_options[alignment]"]' => array(
'value' => 'vertical',
),
),
),
);
// Whether to clear the columns; available only in horizontal alignment and
// when the "Single row" option is selected.
$form['clear_columns'] = array(
'#type' => 'checkbox',
'#title' => t('Clear columns per device size'),
'#description' => t('When this option is selected, clearfix divs will be used to "clear" the columns as needed per device size (see related ') . '<a target="_blank" href="http://getbootstrap.com/css/#grid-example-mixed-complete">' . t('Bootstrap documentation') . '</a>. ' . t('This option applies only when "Single row" is selected for the "Number of columns per view row" option'),
'#default_value' => $this->options['clear_columns'],
'#states' => array(
'visible' => array(
'input[name="style_options[alignment]"]' => array(
'value' => 'horizontal',
),
'select[name="style_options[columns_horizontal]"]' => array(
'value' => -1,
),
),
),
);
// Number of columns per device size. To be used for generating css classes.
// Options are the same for all device sizes.
$options = array(
12 => 1,
6 => 2,
4 => 3,
3 => 4,
2 => 6,
1 => 12,
);
$form['columns_xs'] = array(
'#type' => 'select',
'#title' => t('Number of columns for extra small devices'),
'#options' => $options,
'#required' => TRUE,
'#description' => t('Choose the number of columns for a particular device size and up. This affects the css classes that will be applied to the columns and not the actual HTML structure that will be rendered. Not defining the number of columns for a device size will result in inheriting the number of columns from one size below.'),
'#default_value' => $this->options['columns_xs'],
);
// Add option to not define the number of columns for the rest.
$options[0] = 'Do not define';
$form['columns_sm'] = array(
'#type' => 'select',
'#title' => t('Number of columns for small devices'),
'#options' => $options,
'#required' => FALSE,
'#description' => t('See the description on the number of columns for extra small devices.'),
'#default_value' => $this->options['columns_sm'],
);
$form['columns_md'] = array(
'#type' => 'select',
'#title' => t('Number of columns for medium devices'),
'#options' => $options,
'#required' => FALSE,
'#description' => t('See the description on the number of columns for extra small devices.'),
'#default_value' => $this->options['columns_md'],
);
$form['columns_lg'] = array(
'#type' => 'select',
'#title' => t('Number of columns for large devices'),
'#options' => $options,
'#required' => FALSE,
'#description' => t('See the description on the number of columns for extra small devices.'),
'#default_value' => $this->options['columns_lg'],
);
$form['column_class'] = array(
'#title' => t('Column class'),
'#description' => t('Additional classes to provide on each column.'),
'#type' => 'textfield',
'#default_value' => $this->options['column_class'],
);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ViewsBootstrapThumbnailPluginStyle:: |
public | function |
Form. Overrides views_plugin_style:: |
|
ViewsBootstrapThumbnailPluginStyle:: |
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:: |