1. 8.2.x core/modules/views/src/Annotation/ViewsDisplay.php ViewsDisplay
  2. 8.0.x core/modules/views/src/Annotation/ViewsDisplay.php ViewsDisplay
  3. 8.1.x core/modules/views/src/Annotation/ViewsDisplay.php ViewsDisplay
  4. 8.3.x core/modules/views/src/Annotation/ViewsDisplay.php ViewsDisplay

Defines a Plugin annotation object for views display plugins.

Hierarchy

Expanded class hierarchy of ViewsDisplay

See also

\Drupal\views\Plugin\views\display\DisplayPluginBase

Related topics

9 classes are annotated with ViewsDisplay
Attachment in core/modules/views/src/Plugin/views/display/Attachment.php
The plugin that handles an attachment display.
DefaultDisplay in core/modules/views/src/Plugin/views/display/DefaultDisplay.php
A plugin to handle defaults on a view.
DisplayNoAreaTest in core/modules/views/tests/modules/views_test_data/src/Plugin/views/display/DisplayNoAreaTest.php
Defines a Display test plugin with areas disabled.
DisplayTest in core/modules/views/tests/modules/views_test_data/src/Plugin/views/display/DisplayTest.php
Defines a Display test plugin.
Embed in core/modules/views/src/Plugin/views/display/Embed.php
The plugin that handles an embed display.

... See full list

File

core/modules/views/src/Annotation/ViewsDisplay.php, line 14

Namespace

Drupal\views\Annotation
View source
class ViewsDisplay 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 = '';

  /**
   * The administrative name of the display.
   *
   * The name is displayed on the Views overview and also used as default name
   * for new displays.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $admin = '';

  /**
   * A short help string; this is displayed in the views UI.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $help = '';

  /**
   * Whether or not to use hook_menu() to register a route.
   *
   * @var bool
   */
  public $uses_menu_links;

  /**
   * Does the display plugin registers routes to the route.
   *
   * @var bool
   */
  public $uses_route;

  /**
   * Does the display plugin provide blocks.
   *
   * @var bool
   */
  public $uses_hook_block;

  /**
   * A list of places where contextual links should be added.
   * For example:
   * @code
   * array(
   *   'page',
   *   'block',
   * )
   * @endcode
   *
   * If you don't specify it there will be contextual links rendered for all
   * displays of a view. If this is not set or regions have been specified,
   * views will display an option to 'hide contextual links'. Use an empty
   * array to disable.
   *
   * @var array
   */
  public $contextual_links_locations;

  /**
   * The base tables on which this display plugin can be used.
   *
   * If no base table is specified the plugin can be used with all tables.
   *
   * @var array
   */
  public $base;

  /**
   * The theme function used to render the display's output.
   *
   * @return string
   */
  public $theme;

  /**
   * 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;

  /**
   * Whether the display returns a response object.
   *
   * @var bool
   */
  public $returns_response;

}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
Plugin::$definition protected property The plugin definition read from the class annotation.
Plugin::get public function Gets the value of an annotation. Overrides AnnotationInterface::get
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId public function Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider public function Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse protected function Parses an annotation into its definition.
Plugin::setClass public function Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider public function Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct public function Constructs a Plugin object.
ViewsDisplay::$admin public property The administrative name of the display.
ViewsDisplay::$base public property The base tables on which this display plugin can be used.
ViewsDisplay::$contextual_links_locations public property A list of places where contextual links should be added. For example:
ViewsDisplay::$help public property A short help string; this is displayed in the views UI.
ViewsDisplay::$id public property The plugin ID.
ViewsDisplay::$no_ui public property Whether the plugin should be not selectable in the UI.
ViewsDisplay::$returns_response public property Whether the display returns a response object.
ViewsDisplay::$short_title public property (optional) The short title used in the views UI.
ViewsDisplay::$theme public property The theme function used to render the display's output.
ViewsDisplay::$title public property The plugin title used in the views UI.
ViewsDisplay::$uses_hook_block public property Does the display plugin provide blocks.
ViewsDisplay::$uses_menu_links public property Whether or not to use hook_menu() to register a route.
ViewsDisplay::$uses_route public property Does the display plugin registers routes to the route.
ViewsPluginAnnotationBase::$register_theme public property Whether or not to register a theme function automatically.