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

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Core\Display\PageVariantInterface.
6	*/
7
8	namespace Drupal\Core\Display;
9
10	/**
11	* Provides an interface for PageDisplayVariant plugins.
12	*
13	* Page display variants are a specific type of DisplayVariant, intended for
14	* "pages", which always have some main content to be rendered. Hence page
15	* display variants may choose to render that main content in a certain way:
16	* decorated in a certain way, laid out in a certain way, et cetera.
17	*
18	* For example, the \Drupal\block\Plugin\DisplayVariant\FullPageVariant page
19	* display variant is used by the Block module to control regions and output
20	* blocks placed in those regions.
21	*
22	* @see \Drupal\Core\Display\Annotation\DisplayVariant
23	* @see \Drupal\Core\Display\VariantBase
24	* @see \Drupal\Core\Display\VariantManager
25	* @see plugin_api
26	*/
27	interface PageVariantInterface extends VariantInterface {
28
29	/**
30	* Sets the main content for the page being rendered.
31	*
32	* @param array $main_content
33	* The render array representing the main content.
34	*
35	* @return $this
36	*/
37	public function setMainContent(array $main_content);
38
39	/**
40	* Sets the title for the page being rendered.
41	*
42	* @param string\|array $title
43	* The page title: either a string for plain titles or a render array for
44	* formatted titles.
45	*
46	* @return $this
47	*/
48	public function setTitle($title);
49
50	}