www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/views/src/Annotation/ViewsDisplay.php

   1 <?php
   2
   3 namespace Drupal\views\Annotation;
   4
   5 /**
   6  * Defines a Plugin annotation object for views display plugins.
   7  *
   8  * @see \Drupal\views\Plugin\views\display\DisplayPluginBase
   9  *
  10  * @ingroup views_display_plugins
  11  *
  12  * @Annotation
  13  */
  14 class ViewsDisplay extends ViewsPluginAnnotationBase {
  15
  16   /**
  17    * The plugin ID.
  18    *
  19    * @var string
  20    */
  21   public $id;
  22
  23   /**
  24    * The plugin title used in the views UI.
  25    *
  26    * @var \Drupal\Core\Annotation\Translation
  27    *
  28    * @ingroup plugin_translatable
  29    */
  30   public $title = '';
  31
  32   /**
  33    * (optional) The short title used in the views UI.
  34    *
  35    * @var \Drupal\Core\Annotation\Translation
  36    *
  37    * @ingroup plugin_translatable
  38    */
  39   public $short_title = '';
  40
  41   /**
  42    * The administrative name of the display.
  43    *
  44    * The name is displayed on the Views overview and also used as default name
  45    * for new displays.
  46    *
  47    * @var \Drupal\Core\Annotation\Translation
  48    *
  49    * @ingroup plugin_translatable
  50    */
  51   public $admin = '';
  52
  53   /**
  54    * A short help string; this is displayed in the views UI.
  55    *
  56    * @var \Drupal\Core\Annotation\Translation
  57    *
  58    * @ingroup plugin_translatable
  59    */
  60   public $help = '';
  61
  62   /**
  63    * Whether or not to use hook_menu() to register a route.
  64    *
  65    * @var bool
  66    */
  67   public $uses_menu_links;
  68
  69   /**
  70    * Does the display plugin registers routes to the route.
  71    *
  72    * @var bool
  73    */
  74   public $uses_route;
  75
  76   /**
  77    * Does the display plugin provide blocks.
  78    *
  79    * @var bool
  80    */
  81   public $uses_hook_block;
  82
  83   /**
  84    * A list of places where contextual links should be added.
  85    * For example:
  86    * @code
  87    * array(
  88    *   'page',
  89    *   'block',
  90    * )
  91    * @endcode
  92    *
  93    * If you don't specify it there will be contextual links rendered for all
  94    * displays of a view. If this is not set or regions have been specified,
  95    * views will display an option to 'hide contextual links'. Use an empty
  96    * array to disable.
  97    *
  98    * @var array
  99    */
 100   public $contextual_links_locations;
 101
 102   /**
 103    * The base tables on which this display plugin can be used.
 104    *
 105    * If no base table is specified the plugin can be used with all tables.
 106    *
 107    * @var array
 108    */
 109   public $base;
 110
 111   /**
 112    * The theme function used to render the display's output.
 113    *
 114    * @return string
 115    */
 116   public $theme;
 117
 118   /**
 119    * Whether the plugin should be not selectable in the UI.
 120    *
 121    * If it's set to TRUE, you can still use it via the API in config files.
 122    *
 123    * @var bool
 124    */
 125   public $no_ui;
 126
 127   /**
 128    * Whether the display returns a response object.
 129    *
 130    * @var bool
 131    */
 132   public $returns_response;
 133
 134 }