You are here

Home » API reference » Views (for Drupal 7) 8.3 » DisplayExtenderPluginBase.php

abstract class DisplayExtenderPluginBase in Views (for Drupal 7) 8.3

@todo.

Hierarchy

Expanded class hierarchy of DisplayExtenderPluginBase

Related topics

Views display plugins
Display plugins control how Views interact with the rest of Drupal.
1 file declares its use of DisplayExtenderPluginBase
DisplayExtenderTest.php in tests/views_test_data/lib/Drupal/views_test_data/Plugin/views/display_extender/DisplayExtenderTest.php
Definition of Drupal\views_test_data\Plugin\views\display_extender\DisplayExtenderTest.

File

lib/Drupal/views/Plugin/views/display_extender/DisplayExtenderPluginBase.php, line 19
Definition of Drupal\views\Plugin\views\display_extender\DisplayExtenderPluginBase.

Namespace

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

}

Members

Namesort descending Modifiers Type Description Overrides
DisplayExtenderPluginBase::buildOptionsForm public function Provide a form to edit options for this plugin. Overrides PluginBase::buildOptionsForm 1
DisplayExtenderPluginBase::defaultableSections public function Static member function to list which sections are defaultable and what items each section contains. 1
DisplayExtenderPluginBase::defineOptionsAlter public function Provide a form to edit options for this plugin. 1
DisplayExtenderPluginBase::init public function
DisplayExtenderPluginBase::optionsSummary public function Provide the default summary for options in the views UI. 1
DisplayExtenderPluginBase::pre_execute 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::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins's 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::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
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::additionalThemeFunctions public function Provide a list of additional theme functions for the theme information page
PluginBase::defineOptions protected function Information about options for all kinds of purposes will be held here. @code 'option_name' => array( 13
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy public function Clears a plugin. 2
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::setOptionDefaults protected function
PluginBase::summaryTitle public function Returns the summary of the settings in the display. 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. 1
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::usesOptions public function Returns the usesOptions property. 8
PluginBase::validate public function Validate that the plugin is correct and can be saved. 4
PluginBase::__construct public function Constructs a Plugin object. Overrides PluginBase::__construct 2