[ticket/13717] Set the assets after rendering the whole template

The goal being to be able to call INCLUDECSS/JS from anywhere in any tempalte or event PHPBB3-13717
author: Tristan Darricau <tristan.darricau@sensiolabs.com> 2016-01-17 20:11:36 +0100
committer: Tristan Darricau <tristan.darricau@sensiolabs.com> 2016-01-25 00:31:45 +0100
commit: 52b3d54805af6d0a89ede1cd2acac92cd95693c0 (patch)
tree: 83b86f33995d5cdc69d54e73b8da2d3379e41c98 /phpBB/phpbb/template
parent: d8af5ac4f9ddc1de16af73f5af1f2c465ee124e4 (diff)
download: forums-52b3d54805af6d0a89ede1cd2acac92cd95693c0.tar
forums-52b3d54805af6d0a89ede1cd2acac92cd95693c0.tar.gz
forums-52b3d54805af6d0a89ede1cd2acac92cd95693c0.tar.bz2
forums-52b3d54805af6d0a89ede1cd2acac92cd95693c0.tar.xz
forums-52b3d54805af6d0a89ede1cd2acac92cd95693c0.zip
5 files changed, 160 insertions, 48 deletions
diff --git a/phpBB/phpbb/template/assets_bag.php b/phpBB/phpbb/template/assets_bag.php
new file mode 100644
index 0000000000..9013061b96
--- /dev/null
+++ b/phpBB/phpbb/template/assets_bag.php
@@ -0,0 +1,95 @@
+<?php
+/**
+*
+* This file is part of the phpBB Forum Software package.
+*
+* @copyright (c) phpBB Limited <https://www.phpbb.com>
+* @license GNU General Public License, version 2 (GPL-2.0)
+*
+* For full copyright and license information, please see
+* the docs/CREDITS.txt file.
+*
+*/
+
+namespace phpbb\template;
+
+class assets_bag
+{
+	/** @var asset[] */
+	protected $stylesheets = [];
+
+	/** @var asset[] */
+	protected $scripts = [];
+
+	/**
+	 * Add a css asset to the bag
+	 *
+	 * @param asset $asset
+	 */
+	public function add_stylesheet(asset $asset)
+	{
+		$this->stylesheets[] = $asset;
+	}
+
+	/**
+	 * Add a js script asset to the bag
+	 *
+	 * @param asset $asset
+	 */
+	public function add_script(asset $asset)
+	{
+		$this->scripts[] = $asset;
+	}
+
+	/**
+	 * Returns all css assets
+	 *
+	 * @return asset[]
+	 */
+	public function get_stylesheets()
+	{
+		return $this->stylesheets;
+	}
+
+	/**
+	 * Returns all js assets
+	 *
+	 * @return asset[]
+	 */
+	public function get_scripts()
+	{
+		return $this->scripts;
+	}
+
+	/**
+	 * Returns the HTML code to includes all css assets
+	 *
+	 * @return string
+	 */
+	public function get_stylesheets_content()
+	{
+		$output = '';
+		foreach ($this->stylesheets as $stylesheet)
+		{
+			$output .= "<link href=\"{$stylesheet->get_url()}\" rel=\"stylesheet\" type=\"text/css\" media=\"screen\" />\n";
+		}
+
+		return $output;
+	}
+
+	/**
+	 * Returns the HTML code to includes all js assets
+	 *
+	 * @return string
+	 */
+	public function get_scripts_content()
+	{
+		$output = '';
+		foreach ($this->scripts as $script)
+		{
+			$output .= "<script type=\"text/javascript\" src=\"{$script->get_url()}\"></script>\n";
+		}
+
+		return $output;
+	}
+}
diff --git a/phpBB/phpbb/template/twig/environment.php b/phpBB/phpbb/template/twig/environment.php
index 6e75403159..709505a75f 100644
--- a/phpBB/phpbb/template/twig/environment.php
+++ b/phpBB/phpbb/template/twig/environment.php
@@ -13,6 +13,8 @@
 
 namespace phpbb\template\twig;
 
+use phpbb\template\assets_bag;
+
 class environment extends \Twig_Environment
 {
 	/** @var \phpbb\config\config */
@@ -39,6 +41,9 @@ class environment extends \Twig_Environment
 	/** @var array **/
 	protected $namespace_look_up_order = array('__main__');
 
+	/** @var assets_bag */
+	protected $assets_bag;
+
 	/**
 	* Constructor
 	*
@@ -63,6 +68,8 @@ class environment extends \Twig_Environment
 		$this->phpbb_root_path = $this->phpbb_path_helper->get_phpbb_root_path();
 		$this->web_root_path = $this->phpbb_path_helper->get_web_root_path();
 
+		$this->assets_bag = new assets_bag();
+
 		$options = array_merge(array(
 			'cache'			=> (defined('IN_INSTALL')) ? false : $cache_path,
 			'debug'			=> false,
@@ -151,6 +158,16 @@ class environment extends \Twig_Environment
 	}
 
 	/**
+	 * Gets the assets bag
+	 *
+	 * @return assets_bag
+	 */
+	public function get_assets_bag()
+	{
+		return $this->assets_bag;
+	}
+
+	/**
 	* Get the namespace look up order
 	*
 	* @return array
@@ -174,6 +191,43 @@ class environment extends \Twig_Environment
 	}
 
 	/**
+	 * {@inheritdoc}
+	 */
+	public function render($name, array $context = [])
+	{
+		$output = parent::render($name, $context);
+
+		return $this->inject_assets($output);
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function display($name, array $context = [])
+	{
+		ob_start();
+		parent::display($name, $context);
+		$output = ob_get_clean();
+
+		echo $this->inject_assets($output);
+	}
+
+	/**
+	 * Injects the assets (from INCLUDECSS/JS) in the output.
+	 *
+	 * @param string $output
+	 *
+	 * @return string
+	 */
+	private function inject_assets($output)
+	{
+		$output = str_replace('__STYLESHEETS_PLACEHOLDER__', $this->assets_bag->get_stylesheets_content(), $output);
+		$output = str_replace('__SCRIPTS_PLACEHOLDER__', $this->assets_bag->get_scripts_content(), $output);
+
+		return $output;
+	}
+
+	/**
 	* Loads a template by name.
 	*
 	* @param string  $name  The template name
diff --git a/phpBB/phpbb/template/twig/node/includeasset.php b/phpBB/phpbb/template/twig/node/includeasset.php
index 324823b8d7..3d3c6e4df8 100644
--- a/phpBB/phpbb/template/twig/node/includeasset.php
+++ b/phpBB/phpbb/template/twig/node/includeasset.php
@@ -49,33 +49,20 @@ abstract class includeasset extends \Twig_Node
 					->write("\$local_file = \$this->getEnvironment()->findTemplate(\$asset_path);\n")
 					->write("\$asset->set_path(\$local_file, true);\n")
 				->outdent()
-				->write("\$asset->add_assets_version('{$config['assets_version']}');\n")
-				->write("\$asset_file = \$asset->get_url();\n")
 				->write("}\n")
+				->write("\$asset->add_assets_version('{$config['assets_version']}');\n")
 			->outdent()
 			->write("}\n")
-			->write("\$context['definition']->append('{$this->get_definition_name()}', '")
-		;
-
-		$this->append_asset($compiler);
-
-		$compiler
-			->raw("\n');\n")
+			->write("\$context['definition']->set('STYLESHEETS', '__STYLESHEETS_PLACEHOLDER__');\n")
+			->write("\$context['definition']->set('SCRIPTS', '__SCRIPTS_PLACEHOLDER__');\n")
+			->write("\$this->getEnvironment()->get_assets_bag()->add_{$this->get_setters_name()}(\$asset);")
 		;
 	}
 
 	/**
-	* Get the definition name
+	* Get the name of the assets bag setter
 	*
-	* @return string (e.g. 'SCRIPTS')
-	*/
-	abstract public function get_definition_name();
-
-	/**
-	* Append the output code for the asset
-	*
-	* @param \Twig_Compiler A Twig_Compiler instance
-	* @return null
+	* @return string (e.g. 'script')
 	*/
-	abstract protected function append_asset(\Twig_Compiler $compiler);
+	abstract public function get_setters_name();
 }
diff --git a/phpBB/phpbb/template/twig/node/includecss.php b/phpBB/phpbb/template/twig/node/includecss.php
index 2dac154036..2e97d4972d 100644
--- a/phpBB/phpbb/template/twig/node/includecss.php
+++ b/phpBB/phpbb/template/twig/node/includecss.php
@@ -18,20 +18,8 @@ class includecss extends \phpbb\template\twig\node\includeasset
 	/**
 	* {@inheritdoc}
 	*/
-	public function get_definition_name()
+	public function get_setters_name()
 	{
-		return 'STYLESHEETS';
-	}
-
-	/**
-	* {@inheritdoc}
-	*/
-	public function append_asset(\Twig_Compiler $compiler)
-	{
-		$compiler
-			->raw("<link href=\"' . ")
-			->raw("\$asset_file . '\"")
-			->raw(' rel="stylesheet" type="text/css" media="screen" />')
-		;
+		return 'stylesheet';
 	}
 }
diff --git a/phpBB/phpbb/template/twig/node/includejs.php b/phpBB/phpbb/template/twig/node/includejs.php
index e77f2afeed..505b49757b 100644
--- a/phpBB/phpbb/template/twig/node/includejs.php
+++ b/phpBB/phpbb/template/twig/node/includejs.php
@@ -18,20 +18,8 @@ class includejs extends \phpbb\template\twig\node\includeasset
 	/**
 	* {@inheritdoc}
 	*/
-	public function get_definition_name()
+	public function get_setters_name()
 	{
-		return 'SCRIPTS';
-	}
-
-	/**
-	* {@inheritdoc}
-	*/
-	protected function append_asset(\Twig_Compiler $compiler)
-	{
-		$compiler
-			->raw("<script type=\"text/javascript\" src=\"' . ")
-			->raw("\$asset_file")
-			->raw(". '\"></script>\n")
-		;
+		return 'script';
 	}
 }
author	Tristan Darricau <tristan.darricau@sensiolabs.com>	2016-01-17 20:11:36 +0100
committer	Tristan Darricau <tristan.darricau@sensiolabs.com>	2016-01-25 00:31:45 +0100
commit	52b3d54805af6d0a89ede1cd2acac92cd95693c0 (patch)
tree	83b86f33995d5cdc69d54e73b8da2d3379e41c98 /phpBB/phpbb/template
parent	d8af5ac4f9ddc1de16af73f5af1f2c465ee124e4 (diff)
download	forums-52b3d54805af6d0a89ede1cd2acac92cd95693c0.tar forums-52b3d54805af6d0a89ede1cd2acac92cd95693c0.tar.gz forums-52b3d54805af6d0a89ede1cd2acac92cd95693c0.tar.bz2 forums-52b3d54805af6d0a89ede1cd2acac92cd95693c0.tar.xz forums-52b3d54805af6d0a89ede1cd2acac92cd95693c0.zip