class DisplayExtenderPluginBase

Same name and namespace in other branches
  1. 11.x core/modules/views/src/Plugin/views/display_extender/DisplayExtenderPluginBase.php \Drupal\views\Plugin\views\display_extender\DisplayExtenderPluginBase
  2. 10 core/modules/views/src/Plugin/views/display_extender/DisplayExtenderPluginBase.php \Drupal\views\Plugin\views\display_extender\DisplayExtenderPluginBase
  3. 8.9.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

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 34

Namespace

Drupal\views\Plugin\views\display_extender
View 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) {
  }

}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.