Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/EventSubscriber/MainContentViewSubscriber.php

	Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total	0.00% covered (danger)	0.00%	0 / 1	0.00% covered (danger)	0.00%	0 / 3	CRAP	0.00% covered (danger)	0.00%	0 / 18
MainContentViewSubscriber	0.00% covered (danger)	0.00%	0 / 1	0.00% covered (danger)	0.00%	0 / 3	72	0.00% covered (danger)	0.00%	0 / 18
__construct				0.00% covered (danger)	0.00%	0 / 1	2	0.00% covered (danger)	0.00%	0 / 4
onViewRenderArray				0.00% covered (danger)	0.00%	0 / 1	42	0.00% covered (danger)	0.00%	0 / 12
getSubscribedEvents				0.00% covered (danger)	0.00%	0 / 1	2	0.00% covered (danger)	0.00%	0 / 2

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Core\EventSubscriber\MainContentViewSubscriber.
6	*/
7
8	namespace Drupal\Core\EventSubscriber;
9
10	use Drupal\Core\Cache\CacheableMetadata;
11	use Drupal\Core\Cache\CacheableResponseInterface;
12	use Drupal\Core\DependencyInjection\ClassResolverInterface;
13	use Drupal\Core\Routing\RouteMatchInterface;
14	use Symfony\Component\EventDispatcher\EventSubscriberInterface;
15	use Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent;
16	use Symfony\Component\HttpKernel\KernelEvents;
17
18	/**
19	* View subscriber rendering main content render arrays into responses.
20	*
21	* Additional target rendering formats can be defined by adding another service
22	* that implements \Drupal\Core\Render\MainContent\MainContentRendererInterface
23	* and tagging it as a @code render.main_content_renderer @endcode, then
24	* \Drupal\Core\Render\MainContent\MainContentRenderersPass will detect it and
25	* use it when appropriate.
26	*
27	* @see \Drupal\Core\Render\MainContent\MainContentRendererInterface
28	* @see \Drupal\Core\Render\MainContentControllerPass
29	*/
30	class MainContentViewSubscriber implements EventSubscriberInterface {
31
32	/**
33	* The class resolver service.
34	*
35	* @var \Drupal\Core\Controller\ControllerResolverInterface
36	*/
37	protected $classResolver;
38
39	/**
40	* The current route match.
41	*
42	* @var \Drupal\Core\Routing\RouteMatchInterface
43	*/
44	protected $routeMatch;
45
46	/**
47	* The available main content renderer services, keyed per format.
48	*
49	* @var array
50	*/
51	protected $mainContentRenderers;
52
53	/**
54	* URL query attribute to indicate the wrapper used to render a request.
55	*
56	* The wrapper format determines how the HTML is wrapped, for example in a
57	* modal dialog.
58	*/
59	const WRAPPER_FORMAT = '_wrapper_format';
60
61	/**
62	* Constructs a new MainContentViewSubscriber object.
63	*
64	* @param \Drupal\Core\DependencyInjection\ClassResolverInterface $class_resolver
65	* The class resolver service.
66	* @param \Drupal\Core\Routing\RouteMatchInterface $route_match
67	* The current route match.
68	* @param array $main_content_renderers
69	* The available main content renderer service IDs, keyed by format.
70	*/
71	public function __construct(ClassResolverInterface $class_resolver, RouteMatchInterface $route_match, array $main_content_renderers) {
72	$this->classResolver = $class_resolver;
73	$this->routeMatch = $route_match;
74	$this->mainContentRenderers = $main_content_renderers;
75	}
76
77	/**
78	* Sets a response given a (main content) render array.
79	*
80	* @param \Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent $event
81	* The event to process.
82	*/
83	public function onViewRenderArray(GetResponseForControllerResultEvent $event) {
84	$request = $event->getRequest();
85	$result = $event->getControllerResult();
86
87	// Render the controller result into a response if it's a render array.
88	if (is_array($result) && ($request->query->has(static::WRAPPER_FORMAT) \|\| $request->getRequestFormat() == 'html')) {
89	$wrapper = $request->query->get(static::WRAPPER_FORMAT, 'html');
90
91	// Fall back to HTML if the requested wrapper envelope is not available.
92	$wrapper = isset($this->mainContentRenderers[$wrapper]) ? $wrapper : 'html';
93
94	$renderer = $this->classResolver->getInstanceFromDefinition($this->mainContentRenderers[$wrapper]);
95	$response = $renderer->renderResponse($result, $request, $this->routeMatch);
96	// The main content render array is rendered into a different Response
97	// object, depending on the specified wrapper format.
98	if ($response instanceof CacheableResponseInterface) {
99	$main_content_view_subscriber_cacheability = (new CacheableMetadata())->setCacheContexts(['url.query_args:' . static::WRAPPER_FORMAT]);
100	$response->addCacheableDependency($main_content_view_subscriber_cacheability);
101	}
102	$event->setResponse($response);
103	}
104	}
105
106	/**
107	* {@inheritdoc}
108	*/
109	static function getSubscribedEvents() {
110	$events[KernelEvents::VIEW][] = ['onViewRenderArray'];
111
112	return $events;
113	}
114
115	}