@todo.
Expanded class hierarchy of DisplayExtenderPluginBase
abstract class DisplayExtenderPluginBase extends PluginBase {
public function init(ViewExecutable $view, &$display) {
$this
->setOptionDefaults($this->options, $this
->defineOptions());
$this->view = $view;
$this->displayHandler = $display;
}
/**
* Provide a form to edit options for this plugin.
*/
public function defineOptionsAlter(&$options) {
}
/**
* Provide a form to edit options for this plugin.
*/
public function buildOptionsForm(&$form, &$form_state) {
}
/**
* Validate the options form.
*/
public function validateOptionsForm(&$form, &$form_state) {
}
/**
* Handle any special handling on the validate form.
*/
public function submitOptionsForm(&$form, &$form_state) {
}
/**
* Set up any variables on the view prior to execution.
*/
public function pre_execute() {
}
/**
* Inject anything into the query that the display_extender handler needs.
*/
public function query() {
}
/**
* Provide the default summary for options in the views UI.
*
* This output is returned as an array.
*/
public function optionsSummary(&$categories, &$options) {
}
/**
* Static member function to list which sections are defaultable
* and what items each section contains.
*/
public function defaultableSections(&$sections, $section = NULL) {
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DisplayExtenderPluginBase:: |
public | function | ||
PluginBase:: |
protected | function | ||
PluginBase:: |
public | function | Adds elements for available core tokens to a form. | |
PluginBase:: |
public | function | Clears a plugin. | 2 |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
public | function |
Constructs a Plugin object. Overrides PluginBase:: |
|
PluginBase:: |
protected | property | Denotes whether the plugin has an additional options form. | 8 |
DisplayExtenderPluginBase:: |
public | function |
Handle any special handling on the validate form. Overrides PluginBase:: |
1 |
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface:: |
|
PluginBase:: |
protected | function | Information about options for all kinds of purposes will be held here. @code 'option_name' => array( | 14 |
DisplayExtenderPluginBase:: |
public | function |
Inject anything into the query that the display_extender handler needs. Overrides PluginBase:: |
1 |
PluginBase:: |
public | property | Options for this plugin will be held here. | |
PluginBase:: |
public | property | Plugins's definition | |
DisplayExtenderPluginBase:: |
public | function | Provide a form to edit options for this plugin. | 1 |
DisplayExtenderPluginBase:: |
public | function |
Provide a form to edit options for this plugin. Overrides PluginBase:: |
1 |
PluginBase:: |
public | function | Provide a full list of possible theme templates used by this style. | 1 |
PluginBase:: |
public | function | Provide a list of additional theme functions for the theme information page | |
DisplayExtenderPluginBase:: |
public | function | Provide the default summary for options in the views UI. | 1 |
PluginBase:: |
public | function | Return the human readable name of the display. | |
PluginBase:: |
public | function | Returns a string with any core tokens replaced. | |
PluginBase:: |
public | function | Returns an array of available token replacements. | |
PluginBase:: |
public | function | Returns the summary of the settings in the display. | 6 |
PluginBase:: |
public | function | Returns the usesOptions property. | 8 |
DisplayExtenderPluginBase:: |
public | function | Set up any variables on the view prior to execution. | 1 |
DisplayExtenderPluginBase:: |
public | function | Static member function to list which sections are defaultable and what items each section contains. | 1 |
PluginBase:: |
protected | property | The discovery object. | |
PluginBase:: |
public | property | The display object this plugin is for. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
public | property | The top object of a view. | 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 | Validate that the plugin is correct and can be saved. | 4 |
DisplayExtenderPluginBase:: |
public | function |
Validate the options form. Overrides PluginBase:: |