www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/views/src/Plugin/views/display_extender/DisplayExtenderPluginBase.php

   1 <?php
   2
   3 namespace Drupal\views\Plugin\views\display_extender;
   4
   5 use Drupal\Core\Form\FormStateInterface;
   6 use Drupal\views\Plugin\views\PluginBase;
   7
   8 /**
   9  * @defgroup views_display_extender_plugins Views display extender plugins
  10  * @{
  11  * Plugins that offer additional display options across display types.
  12  *
  13  * Display extender plugins allow additional options or configuration to be
  14  * added to views across all display types. For example, if you wanted to allow
  15  * site users to add certain metadata to the rendered output of every view
  16  * display regardless of display type, you could provide this option as a
  17  * display extender.
  18  *
  19  * Display extender plugins extend
  20  * \Drupal\views\Plugin\views\display_extender\DisplayExtenderPluginBase.
  21  * They must be annotated with
  22  * \Drupal\views\Annotation\ViewsDisplayExtender annotation, and they
  23  * must be in namespace directory Plugin\views\display_extender.
  24  *
  25  * @ingroup views_plugins
  26  *
  27  * @see plugin_api
  28  * @see views_display_plugins
  29  */
  30
  31 /**
  32  * Base class for Views display extender plugins.
  33  */
  34 abstract class DisplayExtenderPluginBase extends PluginBase {
  35
  36   /**
  37    * Provide a form to edit options for this plugin.
  38    */
  39   public function defineOptionsAlter(&$options) {}
  40
  41   /**
  42    * Provide a form to edit options for this plugin.
  43    */
  44   public function buildOptionsForm(&$form, FormStateInterface $form_state) {}
  45
  46   /**
  47    * Validate the options form.
  48    */
  49   public function validateOptionsForm(&$form, FormStateInterface $form_state) {}
  50
  51   /**
  52    * Handle any special handling on the validate form.
  53    */
  54   public function submitOptionsForm(&$form, FormStateInterface $form_state) {}
  55
  56   /**
  57    * Set up any variables on the view prior to execution.
  58    */
  59   public function preExecute() {}
  60
  61   /**
  62    * Inject anything into the query that the display_extender handler needs.
  63    */
  64   public function query() {}
  65
  66   /**
  67    * Provide the default summary for options in the views UI.
  68    *
  69    * This output is returned as an array.
  70    */
  71   public function optionsSummary(&$categories, &$options) {}
  72
  73   /**
  74    * Static member function to list which sections are defaultable
  75    * and what items each section contains.
  76    */
  77   public function defaultableSections(&$sections, $section = NULL) {}
  78
  79 }
  80
  81 /**
  82  * @}
  83  */