blob: 7e065b652a8cff46eedcb564104a93d60b59af14 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
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\Attribute\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);
}
|