DisplayExtenderPluginBase.php 1.46 KB
Newer Older
merlinofchaos's avatar
merlinofchaos committed
1
2
3
4
<?php

/**
 * @file
5
 * Definition of Drupal\views\Plugin\views\display_extender\DisplayExtenderPluginBase.
merlinofchaos's avatar
merlinofchaos committed
6
7
 */

8
namespace Drupal\views\Plugin\views\display_extender;
9

10
use Drupal\views\ViewExecutable;
11
use Drupal\views\Plugin\views\PluginBase;
12
use Drupal\Core\Annotation\Translation;
13

merlinofchaos's avatar
merlinofchaos committed
14
15
16
17
18
/**
 * @todo.
 *
 * @ingroup views_display_plugins
 */
19
abstract class DisplayExtenderPluginBase extends PluginBase {
20

merlinofchaos's avatar
merlinofchaos committed
21
22
23
  /**
   * Provide a form to edit options for this plugin.
   */
24
  public function defineOptionsAlter(&$options) { }
merlinofchaos's avatar
merlinofchaos committed
25
26
27
28

  /**
   * Provide a form to edit options for this plugin.
   */
29
  public function buildOptionsForm(&$form, &$form_state) { }
merlinofchaos's avatar
merlinofchaos committed
30
31
32
33

  /**
   * Validate the options form.
   */
34
  public function validateOptionsForm(&$form, &$form_state) { }
merlinofchaos's avatar
merlinofchaos committed
35
36
37
38

  /**
   * Handle any special handling on the validate form.
   */
39
  public function submitOptionsForm(&$form, &$form_state) { }
merlinofchaos's avatar
merlinofchaos committed
40
41
42
43

  /**
   * Set up any variables on the view prior to execution.
   */
44
  public function preExecute() { }
merlinofchaos's avatar
merlinofchaos committed
45
46
47
48

  /**
   * Inject anything into the query that the display_extender handler needs.
   */
49
  public function query() { }
merlinofchaos's avatar
merlinofchaos committed
50
51
52
53
54
55

  /**
   * Provide the default summary for options in the views UI.
   *
   * This output is returned as an array.
   */
56
  public function optionsSummary(&$categories, &$options) { }
merlinofchaos's avatar
merlinofchaos committed
57
58
59
60
61

  /**
   * Static member function to list which sections are defaultable
   * and what items each section contains.
   */
62
  public function defaultableSections(&$sections, $section = NULL) { }
63

merlinofchaos's avatar
merlinofchaos committed
64
}