Version 1

[yaffs-website] / web / core / lib / Drupal / Core / Display / Annotation / DisplayVariant.php

diff --git a/web/core/lib/Drupal/Core/Display/Annotation/DisplayVariant.php b/web/core/lib/Drupal/Core/Display/Annotation/DisplayVariant.php
new file mode 100644 (file)
index 0000000..28d75b5
--- /dev/null
+++ b/web/core/lib/Drupal/Core/Display/Annotation/DisplayVariant.php
@@ -0,0 +1,53 @@
+<?php
+
+namespace Drupal\Core\Display\Annotation;
+
+use Drupal\Component\Annotation\Plugin;
+
+/**
+ * Defines a display variant annotation object.
+ *
+ * Display variants are used to dictate the output of a given Display, which
+ * can be used to control the output of many parts of Drupal.
+ *
+ * Variants are usually chosen by some selection criteria, and are instantiated
+ * directly. Each variant must define its own approach to rendering, and can
+ * either load its own data or be injected with data from another Display
+ * object.
+ *
+ * @todo: Revise description when/if Displays are added to core:
+ *   https://www.drupal.org/node/2292733
+ *
+ * Plugin namespace: Plugin\DisplayVariant
+ *
+ * For working examples, see
+ * - \Drupal\Core\Render\Plugin\DisplayVariant\SimplePageVariant
+ * - \Drupal\block\Plugin\DisplayVariant\BlockPageVariant
+ *
+ * @see \Drupal\Core\Display\VariantInterface
+ * @see \Drupal\Core\Display\VariantBase
+ * @see \Drupal\Core\Display\VariantManager
+ * @see \Drupal\Core\Display\PageVariantInterface
+ * @see plugin_api
+ *
+ * @Annotation
+ */
+class DisplayVariant extends Plugin {
+
+  /**
+   * The plugin ID.
+   *
+   * @var string
+   */
+  public $id;
+
+  /**
+   * The administrative label.
+   *
+   * @var \Drupal\Core\Annotation\Translation
+   *
+   * @ingroup plugin_translatable
+   */
+  public $admin_label = '';
+
+}