class DisplayExtenderPluginBase
Same name in other branches
- 9 core/modules/views/src/Plugin/views/display_extender/DisplayExtenderPluginBase.php \Drupal\views\Plugin\views\display_extender\DisplayExtenderPluginBase
- 8.9.x core/modules/views/src/Plugin/views/display_extender/DisplayExtenderPluginBase.php \Drupal\views\Plugin\views\display_extender\DisplayExtenderPluginBase
- 11.x core/modules/views/src/Plugin/views/display_extender/DisplayExtenderPluginBase.php \Drupal\views\Plugin\views\display_extender\DisplayExtenderPluginBase
Base class for Views display extender plugins.
Hierarchy
- class \Drupal\views\Plugin\views\display_extender\DisplayExtenderPluginBase extends \Drupal\views\Plugin\views\PluginBase
Expanded class hierarchy of DisplayExtenderPluginBase
Related topics
1 file declares its use of DisplayExtenderPluginBase
- DisplayExtenderTest.php in core/
modules/ views/ tests/ modules/ views_test_data/ src/ Plugin/ views/ display_extender/ DisplayExtenderTest.php
File
-
core/
modules/ views/ src/ Plugin/ views/ display_extender/ DisplayExtenderPluginBase.php, line 33
Namespace
Drupal\views\Plugin\views\display_extenderView source
abstract class DisplayExtenderPluginBase extends PluginBase {
/**
* 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, FormStateInterface $form_state) {
}
/**
* Validate the options form.
*/
public function validateOptionsForm(&$form, FormStateInterface $form_state) {
}
/**
* Handle any special handling on the validate form.
*/
public function submitOptionsForm(&$form, FormStateInterface $form_state) {
}
/**
* Set up any variables on the view prior to execution.
*/
public function preExecute() {
}
/**
* 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) {
}
/**
* Gets a list of defaultable sections and the items they contain.
*/
public function defaultableSections(&$sections, $section = NULL) {
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
DerivativeInspectionInterface::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | 1 | ||
DerivativeInspectionInterface::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | 1 | ||
DisplayExtenderPluginBase::buildOptionsForm | public | function | Provide a form to edit options for this plugin. | Overrides PluginBase::buildOptionsForm | 1 | |
DisplayExtenderPluginBase::defaultableSections | public | function | Gets a list of defaultable sections and the items they contain. | 1 | ||
DisplayExtenderPluginBase::defineOptionsAlter | public | function | Provide a form to edit options for this plugin. | |||
DisplayExtenderPluginBase::optionsSummary | public | function | Provide the default summary for options in the views UI. | 1 | ||
DisplayExtenderPluginBase::preExecute | public | function | Set up any variables on the view prior to execution. | 1 | ||
DisplayExtenderPluginBase::query | public | function | Inject anything into the query that the display_extender handler needs. | Overrides PluginBase::query | 1 | |
DisplayExtenderPluginBase::submitOptionsForm | public | function | Handle any special handling on the validate form. | Overrides PluginBase::submitOptionsForm | 1 | |
DisplayExtenderPluginBase::validateOptionsForm | public | function | Validate the options form. | Overrides PluginBase::validateOptionsForm | ||
PluginBase::$definition | public | property | Plugins' definition. | |||
PluginBase::$displayHandler | public | property | The display object this plugin is for. | |||
PluginBase::$options | public | property | Options for this plugin will be held here. | |||
PluginBase::$position | public | property | The handler position. | |||
PluginBase::$renderer | protected | property | Stores the render API renderer. | 3 | ||
PluginBase::$usesOptions | protected | property | Denotes whether the plugin has an additional options form. | 8 | ||
PluginBase::$view | public | property | The top object of a view. | 1 | ||
PluginBase::calculateDependencies | public | function | Overrides DependentPluginInterface::calculateDependencies | 14 | ||
PluginBase::create | public static | function | Overrides ContainerFactoryPluginInterface::create | 60 | ||
PluginBase::defineOptions | protected | function | Information about options for all kinds of purposes will be held here. | 18 | ||
PluginBase::destroy | public | function | Overrides ViewsPluginInterface::destroy | 2 | ||
PluginBase::doFilterByDefinedOptions | protected | function | Do the work to filter out stored options depending on the defined options. | |||
PluginBase::filterByDefinedOptions | public | function | Overrides ViewsPluginInterface::filterByDefinedOptions | |||
PluginBase::getAvailableGlobalTokens | public | function | Overrides ViewsPluginInterface::getAvailableGlobalTokens | |||
PluginBase::getProvider | public | function | Overrides ViewsPluginInterface::getProvider | |||
PluginBase::getRenderer | protected | function | Returns the render API renderer. | 1 | ||
PluginBase::globalTokenForm | public | function | Overrides ViewsPluginInterface::globalTokenForm | |||
PluginBase::globalTokenReplace | public | function | Overrides ViewsPluginInterface::globalTokenReplace | |||
PluginBase::INCLUDE_ENTITY | constant | Include entity row languages when listing languages. | ||||
PluginBase::INCLUDE_NEGOTIATED | constant | Include negotiated languages when listing languages. | ||||
PluginBase::init | public | function | Overrides ViewsPluginInterface::init | 6 | ||
PluginBase::listLanguages | protected | function | Makes an array of languages, optionally including special languages. | |||
PluginBase::pluginTitle | public | function | Overrides ViewsPluginInterface::pluginTitle | |||
PluginBase::preRenderAddFieldsetMarkup | public static | function | Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup | |||
PluginBase::preRenderFlattenData | public static | function | Overrides ViewsPluginInterface::preRenderFlattenData | |||
PluginBase::queryLanguageSubstitutions | public static | function | Returns substitutions for Views queries for languages. | |||
PluginBase::setOptionDefaults | protected | function | Fills up the options of the plugin with defaults. | |||
PluginBase::summaryTitle | public | function | Overrides ViewsPluginInterface::summaryTitle | 6 | ||
PluginBase::themeFunctions | public | function | Overrides ViewsPluginInterface::themeFunctions | 1 | ||
PluginBase::trustedCallbacks | public static | function | Overrides TrustedCallbackInterface::trustedCallbacks | 6 | ||
PluginBase::unpackOptions | public | function | Overrides ViewsPluginInterface::unpackOptions | |||
PluginBase::usesOptions | public | function | Overrides ViewsPluginInterface::usesOptions | 8 | ||
PluginBase::validate | public | function | Overrides ViewsPluginInterface::validate | 6 | ||
PluginBase::viewsTokenReplace | protected | function | Replaces Views' tokens in a given string. | 1 | ||
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT | constant | Query string to indicate the site default language. | ||||
PluginBase::__construct | public | function | Constructs a PluginBase object. | 19 | ||
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 6 | ||
PluginInspectionInterface::getPluginId | public | function | Gets the plugin ID of the plugin instance. | 2 | ||
TrustedCallbackInterface::THROW_EXCEPTION | constant | Untrusted callbacks throw exceptions. | ||||
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION | constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. | ||||
TrustedCallbackInterface::TRIGGER_WARNING | Deprecated | constant | Untrusted callbacks trigger E_USER_WARNING errors. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.