Version 1

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

diff --git a/web/core/lib/Drupal/Core/Display/PageVariantInterface.php b/web/core/lib/Drupal/Core/Display/PageVariantInterface.php
new file mode 100644 (file)
index 0000000..5f0b7c2
--- /dev/null
+++ b/web/core/lib/Drupal/Core/Display/PageVariantInterface.php
@@ -0,0 +1,45 @@
+<?php
+
+namespace Drupal\Core\Display;
+
+/**
+ * Provides an interface for PageDisplayVariant plugins.
+ *
+ * Page display variants are a specific type of DisplayVariant, intended for
+ * "pages", which always have some main content to be rendered. Hence page
+ * display variants may choose to render that main content in a certain way:
+ * decorated in a certain way, laid out in a certain way, et cetera.
+ *
+ * For example, the \Drupal\block\Plugin\DisplayVariant\FullPageVariant page
+ * display variant is used by the Block module to control regions and output
+ * blocks placed in those regions.
+ *
+ * @see \Drupal\Core\Display\Annotation\DisplayVariant
+ * @see \Drupal\Core\Display\VariantBase
+ * @see \Drupal\Core\Display\VariantManager
+ * @see plugin_api
+ */
+interface PageVariantInterface extends VariantInterface {
+
+  /**
+   * Sets the main content for the page being rendered.
+   *
+   * @param array $main_content
+   *   The render array representing the main content.
+   *
+   * @return $this
+   */
+  public function setMainContent(array $main_content);
+
+  /**
+   * Sets the title for the page being rendered.
+   *
+   * @param string|array $title
+   *   The page title: either a string for plain titles or a render array for
+   *   formatted titles.
+   *
+   * @return $this
+   */
+  public function setTitle($title);
+
+}