DisplayExtenderPluginBase.php

<?php

/**
 * @file
 * Definition of Drupal\views\Plugin\views\display_extender\DisplayExtenderPluginBase.
 */
namespace Drupal\views\Plugin\views\display_extender;

use Drupal\views\ViewExecutable;
use Drupal\views\Plugin\views\PluginBase;
use Drupal\Core\Annotation\Translation;

/**
 * @todo.
 *
 * @ingroup views_display_plugins
 */
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) {
  }

}