ViewsCache.php

Same filename in this branch
  1. 10 core/modules/views/src/Attribute/ViewsCache.php
Same filename and directory in other branches
  1. 9 core/modules/views/src/Annotation/ViewsCache.php
  2. 8.9.x core/modules/views/src/Annotation/ViewsCache.php
  3. 11.x core/modules/views/src/Annotation/ViewsCache.php
  4. 11.x core/modules/views/src/Attribute/ViewsCache.php

Namespace

Drupal\views\Annotation

File

core/modules/views/src/Annotation/ViewsCache.php

View source
<?php

namespace Drupal\views\Annotation;


/**
 * Defines a Plugin annotation object for views cache plugins.
 *
 * @see \Drupal\views\Plugin\views\cache\CachePluginBase
 *
 * @ingroup views_cache_plugins
 *
 * @Annotation
 */
class ViewsCache extends ViewsPluginAnnotationBase {
  
  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;
  
  /**
   * The plugin title used in the views UI.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $title = '';
  
  /**
   * (optional) The short title used in the views UI.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $short_title = '';
  
  /**
   * A short help string; this is displayed in the views UI.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $help = '';
  
  /**
   * The types of the display this plugin can be used with.
   *
   * For example the Feed display defines the type 'feed', so only rss style
   * and row plugins can be used in the views UI.
   *
   * @var array
   */
  public $display_types;
  
  /**
   * The base tables on which this cache plugin can be used.
   *
   * If no base table is specified the plugin can be used with all tables.
   *
   * @var array
   */
  public $base;
  
  /**
   * Whether the plugin should be not selectable in the UI.
   *
   * If it's set to TRUE, you can still use it via the API in config files.
   *
   * @var bool
   */
  public $no_ui;

}

Classes

Title Deprecated Summary
ViewsCache Defines a Plugin annotation object for views cache plugins.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.