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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
<?php
namespace Drupal\Core\Render;
/**
* Bare HTML page renderer.
*
* By "bare HTML page", we mean that the following hooks that allow for "normal"
* pages are not invoked:
* - hook_page_attachments()
* - hook_page_attachments_alter()
* - hook_page_top()
* - hook_page_bottom()
*
* Examples of bare HTML pages are:
* - install.php
* - update.php
* - authorize.php
* - maintenance mode
* - exception handlers
*
* i.e. use this when rendering HTML pages in limited environments. Otherwise,
* use a "_controller" route, and return a render array. This will cause a main
* content renderer
* (\Drupal\Core\Render\MainContent\MainContentRendererInterface) to be used,
* and in case of an HTML request that will be
* \Drupal\Core\Render\MainContent\HtmlRenderer.
*
* In fact, this is not only *typically* used in a limited environment, it even
* *must* be used in a limited environment: when using the bare HTML page
* renderer, use as little state/additional services as possible, because the
* same safeguards aren't present (precisely because this is intended to be used
* in a limited environment).
*
* Currently, there are two types of bare pages available:
* - Install (hook_preprocess_install_page(), install-page.html.twig).
* - Maintenance (hook_preprocess_maintenance_page(),
* maintenance-page.html.twig).
*
* @see \Drupal\Core\Render\MainContent\HtmlRenderer
*/
interface BareHtmlPageRendererInterface {
/**
* Renders a bare page.
*
* @param array $content
* The main content to render in the 'content' region.
* @param string $title
* The title for this maintenance page.
* @param string $page_theme_property
* The #theme property to set on #type 'page'.
* @param array $page_additions
* Additional regions to add to the page. May also be used to pass the
* #show_messages property for #type 'page'.
*
* @return \Drupal\Core\Render\HtmlResponse
* The rendered HTML response, ready to be sent.
*/
public function renderBarePage(array $content, $title, $page_theme_property, array $page_additions = []);
}
|
