class ViewsIsotopeViewsPluginStyleIsotopeSorter in Brainstorm profile 7
Style plugin.
Hierarchy
- class \views_object
- class \views_plugin
- class \views_plugin_style
- class \views_plugin
Expanded class hierarchy of ViewsIsotopeViewsPluginStyleIsotopeSorter
1 string reference to 'ViewsIsotopeViewsPluginStyleIsotopeSorter'
- views_isotope_views_views_plugins in modules/
custom/ views_isotope/ views/ views_isotope_views.views.inc - Implements hook_views_plugins().
File
- modules/
custom/ views_isotope/ views/ ViewsIsotopeViewsPluginStyleIsotopeSorter.inc, line 11 - Define the "sorter" views plugin.
View source
class ViewsIsotopeViewsPluginStyleIsotopeSorter extends views_plugin_style_list {
/**
* Set default options.
*/
public function optionDefinition() {
$options = parent::optionDefinition();
$options['instance_id'] = [
'default' => '',
];
$options['data_fields'] = [
'default' => [],
];
$options['original'] = [
'default' => [],
];
return $options;
}
/**
* Render the given style.
*/
public function optionsForm(&$form, &$form_state) {
$handlers = $this->display->handler
->get_handlers('field');
if (empty($handlers)) {
$form['error_markup'] = [
'#markup' => t('<div class="error messages">You need at least one field before you can configure your isotope settings</div>'),
];
return;
}
$field_names = $this->display->handler
->get_field_labels();
$form['data_fields'] = [
'#type' => 'checkboxes',
'#options' => $field_names,
'#required' => TRUE,
'#title' => t('Data Fields'),
'#default_value' => $this->options['data_fields'],
'#description' => t('Select which fields contain data to be used for sorting.'),
];
$form['instance_id'] = [
'#type' => 'textfield',
'#title' => t('Enter an Instance ID'),
'#default_value' => $this->options['instance_id'],
'#description' => t('(Optional) If you have multiple grids on a page and you want sorts that target specific ones.'),
];
$form['original'] = [
'#type' => 'textfield',
'#title' => t('Label for Original Sort option'),
'#default_value' => !empty($this->options['instance_id']) ? $this->options['instance_id'] : 'Original',
'#description' => t('Leave blank for no original sort option'),
];
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ViewsIsotopeViewsPluginStyleIsotopeSorter:: |
public | function | Set default options. | |
ViewsIsotopeViewsPluginStyleIsotopeSorter:: |
public | function | Render the given 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:: |
|
views_plugin_style_list:: |
public | function |
Render the given style. Overrides views_plugin_style:: |
|
views_plugin_style_list:: |
public | function |
Set default options. Overrides views_plugin_style:: |