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

   1 <?php
   2
   3 namespace Drupal\views\Annotation;
   4
   5 /**
   6  * Defines a Plugin annotation object for views cache plugins.
   7  *
   8  * @see \Drupal\views\Plugin\views\cache\CachePluginBase
   9  *
  10  * @ingroup views_cache_plugins
  11  *
  12  * @Annotation
  13  */
  14 class ViewsCache 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    * A short help string; this is displayed in the views UI.
  43    *
  44    * @var \Drupal\Core\Annotation\Translation
  45    *
  46    * @ingroup plugin_translatable
  47    */
  48   public $help = '';
  49
  50   /**
  51    * The types of the display this plugin can be used with.
  52    *
  53    * For example the Feed display defines the type 'feed', so only rss style
  54    * and row plugins can be used in the views UI.
  55    *
  56    * @var array
  57    */
  58   public $display_types;
  59
  60   /**
  61    * The base tables on which this cache plugin can be used.
  62    *
  63    * If no base table is specified the plugin can be used with all tables.
  64    *
  65    * @var array
  66    */
  67   public $base;
  68
  69   /**
  70    * Whether the plugin should be not selectable in the UI.
  71    *
  72    * If it's set to TRUE, you can still use it via the API in config files.
  73    *
  74    * @var bool
  75    */
  76   public $no_ui;
  77
  78 }