Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/Template/TwigEnvironment.php

	Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total	100.00% covered (success)	100.00%	1 / 1	100.00% covered (success)	100.00%	0 / 0	CRAP	100.00% covered (success)	100.00%	0 / 0
TwigEnvironment	100.00% covered (success)	100.00%	1 / 1	100.00% covered (success)	100.00%	3 / 3	7	100.00% covered (success)	100.00%	0 / 0
__construct				100.00% covered (success)	100.00%	1 / 1	2	100.00% covered (success)	100.00%	0 / 0
getTemplateClass				100.00% covered (success)	100.00%	1 / 1	4	100.00% covered (success)	100.00%	0 / 0
renderInline				100.00% covered (success)	100.00%	1 / 1	1	100.00% covered (success)	100.00%	0 / 0

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Core\Template\TwigEnvironment.
6	*/
7
8	namespace Drupal\Core\Template;
9
10	use Drupal\Core\Cache\CacheBackendInterface;
11	use Drupal\Core\Render\Markup;
12
13	/**
14	* A class that defines a Twig environment for Drupal.
15	*
16	* Instances of this class are used to store the configuration and extensions,
17	* and are used to load templates from the file system or other locations.
18	*
19	* @see core\vendor\twig\twig\lib\Twig\Environment.php
20	*/
21	class TwigEnvironment extends \Twig_Environment {
22
23	/**
24	* Static cache of template classes.
25	*
26	* @var array
27	*/
28	protected $templateClasses;
29
30	/**
31	* Constructs a TwigEnvironment object and stores cache and storage
32	* internally.
33	*
34	* @param string $root
35	* The app root.
36	* @param \Drupal\Core\Cache\CacheBackendInterface $cache
37	* The cache bin.
38	* @param string $twig_extension_hash
39	* The Twig extension hash.
40	* @param \Twig_LoaderInterface $loader
41	* The Twig loader or loader chain.
42	* @param array $options
43	* The options for the Twig environment.
44	*/
45	public function __construct($root, CacheBackendInterface $cache, $twig_extension_hash, \Twig_LoaderInterface $loader = NULL, $options = array()) {
46	// Ensure that twig.engine is loaded, given that it is needed to render a
47	// template because functions like TwigExtension::escapeFilter() are called.
48	require_once $root . '/core/themes/engines/twig/twig.engine';
49
50	$this->templateClasses = array();
51
52	$options += array(
53	// @todo Ensure garbage collection of expired files.
54	'cache' => TRUE,
55	'debug' => FALSE,
56	'auto_reload' => NULL,
57	);
58	// Ensure autoescaping is always on.
59	$options['autoescape'] = 'html';
60
61	$policy = new TwigSandboxPolicy();
62	$sandbox = new \Twig_Extension_Sandbox($policy, TRUE);
63	$this->addExtension($sandbox);
64
65	if ($options['cache'] === TRUE) {
66	$options['cache'] = new TwigPhpStorageCache($cache, $twig_extension_hash);
67	}
68
69	$this->loader = $loader;
70	parent::__construct($this->loader, $options);
71	}
72
73	/**
74	* Gets the template class associated with the given string.
75	*
76	* @param string $name
77	* The name for which to calculate the template class name.
78	* @param int $index
79	* The index if it is an embedded template.
80	*
81	* @return string
82	* The template class name.
83	*/
84	public function getTemplateClass($name, $index = NULL) {
85	// We override this method to add caching because it gets called multiple
86	// times when the same template is used more than once. For example, a page
87	// rendering 50 nodes without any node template overrides will use the same
88	// node.html.twig for the output of each node and the same compiled class.
89	$cache_index = $name . (NULL === $index ? '' : '_' . $index);
90	if (!isset($this->templateClasses[$cache_index])) {
91	$this->templateClasses[$cache_index] = $this->templateClassPrefix . hash('sha256', $this->loader->getCacheKey($name)) . (NULL === $index ? '' : '_' . $index);
92	}
93	return $this->templateClasses[$cache_index];
94	}
95
96	/**
97	* Renders a twig string directly.
98	*
99	* Warning: You should use the render element 'inline_template' together with
100	* the #template attribute instead of this method directly.
101	* On top of that you have to ensure that the template string is not dynamic
102	* but just an ordinary static php string, because there may be installations
103	* using read-only PHPStorage that want to generate all possible twig
104	* templates as part of a build step. So it is important that an automated
105	* script can find the templates and extract them. This is only possible if
106	* the template is a regular string.
107	*
108	* @param string $template_string
109	* The template string to render with placeholders.
110	* @param array $context
111	* An array of parameters to pass to the template.
112	*
113	* @return \Drupal\Component\Render\MarkupInterface\|string
114	* The rendered inline template as a Markup object.
115	*
116	* @see \Drupal\Core\Template\Loader\StringLoader::exists()
117	*/
118	public function renderInline($template_string, array $context = array()) {
119	// Prefix all inline templates with a special comment.
120	$template_string = '{# inline_template_start #}' . $template_string;
121	return Markup::create($this->loadTemplate($template_string, NULL)->render($context));
122	}
123
124	}