annotate core/modules/views/src/Annotation/ViewsDisplay.php @ 19:fa3358dc1485 tip

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