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

Namespace

Drupal\views\Annotation

File

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

Classes

Namesort descending Description
ViewsDisplay Defines a Plugin annotation object for views display plugins.