Defines a display extender test plugin.
@Plugin(
id = "display_extender_test",
title = @Translation("Display extender test")
)
Expanded class hierarchy of DisplayExtenderTest
class DisplayExtenderTest extends DisplayExtenderPluginBase {
/**
* Stores some state booleans to be sure a certain method got called.
*
* @var array
*/
public $testState;
/**
* Overrides Drupal\views\Plugin\views\display_extender\DisplayExtenderPluginBase::defineOptionsAlter().
*/
public function defineOptionsAlter(&$options) {
$options['test_extender_test_option'] = array(
'default' => '',
);
return $options;
}
/**
* Overrides Drupal\views\Plugin\views\display\DisplayPluginBase::optionsSummary().
*/
public function optionsSummary(&$categories, &$options) {
parent::optionsSummary($categories, $options);
$categories['display_extender_test'] = array(
'title' => t('Display extender test settings'),
'column' => 'second',
'build' => array(
'#weight' => -100,
),
);
$test_option = $this->displayHandler
->getOption('test_extender_test_option') ?: t('Empty');
$options['test_extender_test_option'] = array(
'category' => 'display_extender_test',
'title' => t('Test option'),
'value' => views_ui_truncate($test_option, 24),
);
}
/**
* Overrides Drupal\views\Plugin\views\display_extender\DisplayExtenderPluginBase::buildOptionsForm().
*/
public function buildOptionsForm(&$form, &$form_state) {
switch ($form_state['section']) {
case 'test_extender_test_option':
$form['#title'] .= t('Test option');
$form['test_extender_test_option'] = array(
'#type' => 'textfield',
'#description' => t('This is a textfield for test_option.'),
'#default_value' => $this->displayHandler
->getOption('test_extender_test_option'),
);
}
}
/**
* Overrides Drupal\views\Plugin\views\display\DisplayExtenderPluginBase::submitOptionsForm().
*/
public function submitOptionsForm(&$form, &$form_state) {
parent::submitOptionsForm($form, $form_state);
switch ($form_state['section']) {
case 'test_extender_test_option':
$this->displayHandler
->setOption('test_extender_test_option', $form_state['values']['test_extender_test_option']);
break;
}
}
/**
* Overrides Drupal\views\Plugin\views\display\DisplayExtenderPluginBase::defaultableSections().
*/
public function defaultableSections(&$sections, $section = NULL) {
$sections['test_extender_test_option'] = array(
'test_extender_test_option',
);
}
/**
* Overrides Drupal\views\Plugin\views\display\DisplayExtenderPluginBase::query().
*/
public function query() {
$this->testState['query'] = TRUE;
}
/**
* Overrides Drupal\views\Plugin\views\display\DisplayExtenderPluginBase::pre_execute().
*/
public function pre_execute() {
$this->testState['pre_execute'] = TRUE;
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DisplayExtenderPluginBase:: |
public | function | ||
DisplayExtenderPluginBase:: |
public | function |
Validate the options form. Overrides PluginBase:: |
|
DisplayExtenderTest:: |
public | property | Stores some state booleans to be sure a certain method got called. | |
DisplayExtenderTest:: |
public | function |
Overrides Drupal\views\Plugin\views\display_extender\DisplayExtenderPluginBase::buildOptionsForm(). Overrides DisplayExtenderPluginBase:: |
|
DisplayExtenderTest:: |
public | function |
Overrides Drupal\views\Plugin\views\display\DisplayExtenderPluginBase::defaultableSections(). Overrides DisplayExtenderPluginBase:: |
|
DisplayExtenderTest:: |
public | function |
Overrides Drupal\views\Plugin\views\display_extender\DisplayExtenderPluginBase::defineOptionsAlter(). Overrides DisplayExtenderPluginBase:: |
|
DisplayExtenderTest:: |
public | function |
Overrides Drupal\views\Plugin\views\display\DisplayPluginBase::optionsSummary(). Overrides DisplayExtenderPluginBase:: |
|
DisplayExtenderTest:: |
public | function |
Overrides Drupal\views\Plugin\views\display\DisplayExtenderPluginBase::pre_execute(). Overrides DisplayExtenderPluginBase:: |
|
DisplayExtenderTest:: |
public | function |
Overrides Drupal\views\Plugin\views\display\DisplayExtenderPluginBase::query(). Overrides DisplayExtenderPluginBase:: |
|
DisplayExtenderTest:: |
public | function |
Overrides Drupal\views\Plugin\views\display\DisplayExtenderPluginBase::submitOptionsForm(). Overrides DisplayExtenderPluginBase:: |
|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
public | property | Plugins's definition | |
PluginBase:: |
protected | property | The discovery object. | |
PluginBase:: |
public | property | The display object this plugin is for. | |
PluginBase:: |
public | property | Options for this plugin will be held here. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
protected | property | Denotes whether the plugin has an additional options form. | 8 |
PluginBase:: |
public | property | The top object of a view. | 1 |
PluginBase:: |
public | function | Provide a list of additional theme functions for the theme information page | |
PluginBase:: |
protected | function | Information about options for all kinds of purposes will be held here. @code 'option_name' => array( | 14 |
PluginBase:: |
public | function | Clears a plugin. | 2 |
PluginBase:: |
public | function | Returns an array of available token replacements. | |
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Adds elements for available core tokens to a form. | |
PluginBase:: |
public | function | Returns a string with any core tokens replaced. | |
PluginBase:: |
public | function | Return the human readable name of the display. | |
PluginBase:: |
protected | function | ||
PluginBase:: |
public | function | Returns the summary of the settings in the display. | 6 |
PluginBase:: |
public | function | Provide a full list of possible theme templates used by this style. | 1 |
PluginBase:: |
public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
PluginBase:: |
public | function | Returns the usesOptions property. | 8 |
PluginBase:: |
public | function | Validate that the plugin is correct and can be saved. | 4 |
PluginBase:: |
public | function |
Constructs a Plugin object. Overrides PluginBase:: |