Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/Display/Annotation/DisplayVariant.php

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Core\Display\Annotation\DisplayVariant.
6	*/
7
8	namespace Drupal\Core\Display\Annotation;
9
10	use Drupal\Component\Annotation\Plugin;
11
12	/**
13	* Defines a display variant annotation object.
14	*
15	* Display variants are used to dictate the output of a given Display, which
16	* can be used to control the output of many parts of Drupal.
17	*
18	* Variants are usually chosen by some selection criteria, and are instantiated
19	* directly. Each variant must define its own approach to rendering, and can
20	* either load its own data or be injected with data from another Display
21	* object.
22	*
23	* @todo: Revise description when/if Displays are added to core:
24	* https://www.drupal.org/node/2292733
25	*
26	* Plugin namespace: Plugin\DisplayVariant
27	*
28	* For working examples, see
29	* - \Drupal\Core\Render\Plugin\DisplayVariant\SimplePageVariant
30	* - \Drupal\block\Plugin\DisplayVariant\BlockPageVariant
31	*
32	* @see \Drupal\Core\Display\VariantInterface
33	* @see \Drupal\Core\Display\VariantBase
34	* @see \Drupal\Core\Display\VariantManager
35	* @see \Drupal\Core\Display\PageVariantInterface
36	* @see plugin_api
37	*
38	* @Annotation
39	*/
40	class DisplayVariant extends Plugin {
41
42	/**
43	* The plugin ID.
44	*
45	* @var string
46	*/
47	public $id;
48
49	/**
50	* The administrative label.
51	*
52	* @var \Drupal\Core\Annotation\Translation
53	*
54	* @ingroup plugin_translatable
55	*/
56	public $admin_label = '';
57
58	}