aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/includes/template
diff options
context:
space:
mode:
authorNathan Guse <nathaniel.guse@gmail.com>2013-06-09 22:09:00 -0500
committerNathan Guse <nathaniel.guse@gmail.com>2013-06-09 22:11:12 -0500
commit1da4be04b021af62e24f91bf0f82849c78bd04b9 (patch)
treebbc8ce3736cb22522f11615cb86b850705657927 /phpBB/includes/template
parent7ea0019a7167561b029ea727cf8be2e8f490dda7 (diff)
downloadforums-1da4be04b021af62e24f91bf0f82849c78bd04b9.tar
forums-1da4be04b021af62e24f91bf0f82849c78bd04b9.tar.gz
forums-1da4be04b021af62e24f91bf0f82849c78bd04b9.tar.bz2
forums-1da4be04b021af62e24f91bf0f82849c78bd04b9.tar.xz
forums-1da4be04b021af62e24f91bf0f82849c78bd04b9.zip
[feature/twig] WIP extension/lexer/some tokenparsers/nodes
PHPBB3-11598
Diffstat (limited to 'phpBB/includes/template')
-rw-r--r--phpBB/includes/template/twig/extension.php45
-rw-r--r--phpBB/includes/template/twig/lexer.php42
-rw-r--r--phpBB/includes/template/twig/node/begin.php77
-rw-r--r--phpBB/includes/template/twig/tokenparser/begin.php71
-rw-r--r--phpBB/includes/template/twig/tokenparser/event.php33
-rw-r--r--phpBB/includes/template/twig/tokenparser/if.php94
-rw-r--r--phpBB/includes/template/twig/tokenparser/include.php33
7 files changed, 395 insertions, 0 deletions
diff --git a/phpBB/includes/template/twig/extension.php b/phpBB/includes/template/twig/extension.php
new file mode 100644
index 0000000000..29020fcf8e
--- /dev/null
+++ b/phpBB/includes/template/twig/extension.php
@@ -0,0 +1,45 @@
+<?php
+/**
+*
+* @package phpBB3
+* @copyright (c) 2013 phpBB Group
+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+*
+*/
+
+/**
+* @ignore
+*/
+if (!defined('IN_PHPBB'))
+{
+ exit;
+}
+
+class phpbb_template_twig_extension extends Twig_Extension
+{
+ public function getName()
+ {
+ return 'phpbb';
+ }
+
+ public function getTokenParsers()
+ {
+ return array(
+ new phpbb_template_twig_tokenparser_if,
+ new phpbb_template_twig_tokenparser_include,
+ new phpbb_template_twig_tokenparser_event,
+ new phpbb_template_twig_tokenparser_begin,
+ );
+ }
+
+ public function getOperators()
+ {
+ return array(
+ array(),
+ array(
+ 'eq' => array('precedence' => 20, 'class' => 'Twig_Node_Expression_Binary_Equal', 'associativity' => Twig_ExpressionParser::OPERATOR_LEFT),
+ '!==' => array('precedence' => 20, 'class' => 'Twig_Node_Expression_Binary_NotEqual', 'associativity' => Twig_ExpressionParser::OPERATOR_LEFT),
+ ),
+ );
+ }
+}
diff --git a/phpBB/includes/template/twig/lexer.php b/phpBB/includes/template/twig/lexer.php
new file mode 100644
index 0000000000..45b97acf8c
--- /dev/null
+++ b/phpBB/includes/template/twig/lexer.php
@@ -0,0 +1,42 @@
+<?php
+/**
+*
+* @package phpBB3
+* @copyright (c) 2013 phpBB Group
+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+*
+*/
+
+/**
+* @ignore
+*/
+if (!defined('IN_PHPBB'))
+{
+ exit;
+}
+
+class phpbb_template_twig_lexer extends Twig_Lexer
+{
+ protected function lexExpression()
+ {
+ /**
+ * This is some compatibility code to continue supporting expressions such as:
+ * <!-- IF .blah -->
+ *
+ * This does not seem very efficient, but I have not been able to find a better
+ * method which works properly (maybe lexData can do it better, @todo test this)
+ */
+ $last_element = end($this->tokens);
+ if ($last_element->getValue() === '.')
+ {
+ $last_element2 = prev($this->tokens);
+
+ if ($last_element2->getValue() === 'IF')
+ {
+ array_pop($this->tokens);
+ }
+ }
+
+ parent::lexExpression();
+ }
+}
diff --git a/phpBB/includes/template/twig/node/begin.php b/phpBB/includes/template/twig/node/begin.php
new file mode 100644
index 0000000000..1d47e35d87
--- /dev/null
+++ b/phpBB/includes/template/twig/node/begin.php
@@ -0,0 +1,77 @@
+<?php
+
+/*
+ * This file is part of Twig.
+ *
+ * (c) 2009 Fabien Potencier
+ * (c) 2009 Armin Ronacher
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+/**
+ * Represents a for node.
+ *
+ * @package twig
+ * @author Fabien Potencier <fabien.potencier@symfony-project.com>
+ */
+class phpbb_template_twig_node_begin extends Twig_Node
+{
+ public function __construct($beginName, Twig_NodeInterface $body, Twig_NodeInterface $else = null, $lineno, $tag = null)
+ {
+ parent::__construct(array('body' => $body, 'else' => $else), array('beginName' => $beginName), $lineno, $tag);
+ }
+
+ /**
+ * Compiles the node to PHP.
+ *
+ * @param Twig_Compiler A Twig_Compiler instance
+ */
+ public function compile(Twig_Compiler $compiler)
+ {
+ $compiler
+ ->write("if (!isset(\$blocks)) {\n")
+ ->indent()
+ ->write("\$blocks = array();")
+ ->write("\$nestingLevel = 0;")
+ ->outdent()
+ ->write("}\n")
+ ->write("\$blocks[\$nestingLevel] = array();\n")
+ ;
+
+ if (null !== $this->getNode('else')) {
+ $compiler->write("\$blocks[\$nestingLevel]['iterated'] = false;\n");
+ }
+
+ $compiler
+ ->write("foreach (\$context['_phpbb_blocks']['")
+ ->write($this->getAttribute('beginName'))
+ ->write("'] as \$blocks[\$nestingLevel]['i'] => \$blocks[\$nestingLevel]['values']) {")
+ ->indent()
+ ;
+
+ $compiler->subcompile($this->getNode('body'));
+
+ if (null !== $this->getNode('else')) {
+ $compiler->write("\$blocks[\$nestingLevel]['iterated'] = true;\n");
+ }
+
+ $compiler
+ ->outdent()
+ ->write("}\n")
+ ;
+
+ if (null !== $this->getNode('else')) {
+ $compiler
+ ->write("if (!\$blocks[\$nestingLevel]['iterated']) {\n")
+ ->indent()
+ ->subcompile($this->getNode('else'))
+ ->outdent()
+ ->write("}\n")
+ ;
+ }
+
+ $compiler->write("\$nestingLevel--;\n");
+ }
+} \ No newline at end of file
diff --git a/phpBB/includes/template/twig/tokenparser/begin.php b/phpBB/includes/template/twig/tokenparser/begin.php
new file mode 100644
index 0000000000..939f3b8f16
--- /dev/null
+++ b/phpBB/includes/template/twig/tokenparser/begin.php
@@ -0,0 +1,71 @@
+<?php
+
+/*
+ * This file is part of Twig.
+ *
+ * (c) 2009 Fabien Potencier
+ * (c) 2009 Armin Ronacher
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+/**
+ * Loops over each item of a sequence.
+ *
+ * <pre>
+ * <ul>
+ * {% for user in users %}
+ * <li>{{ user.username|e }}</li>
+ * {% endfor %}
+ * </ul>
+ * </pre>
+ */
+class phpbb_template_twig_tokenparser_begin extends Twig_TokenParser_For
+{
+ /**
+ * Parses a token and returns a node.
+ *
+ * @param Twig_Token $token A Twig_Token instance
+ *
+ * @return Twig_NodeInterface A Twig_NodeInterface instance
+ */
+ public function parse(Twig_Token $token)
+ {
+ $lineno = $token->getLine();
+ $beginName = $this->parser->getStream()->expect(Twig_Token::NAME_TYPE)->getValue();
+
+ $this->parser->getStream()->expect(Twig_Token::BLOCK_END_TYPE);
+ $body = $this->parser->subparse(array($this, 'decideBeginFork'));
+ if ($this->parser->getStream()->next()->getValue() == 'ELSE') {
+ $this->parser->getStream()->expect(Twig_Token::BLOCK_END_TYPE);
+ $else = $this->parser->subparse(array($this, 'decideBeginEnd'), true);
+ } else {
+ $else = null;
+ }
+ $this->parser->getStream()->expect(Twig_Token::NAME_TYPE, $beginName);
+ $this->parser->getStream()->expect(Twig_Token::BLOCK_END_TYPE);
+
+ return new phpbb_template_twig_node_begin($beginName, $body, $else, $lineno, $this->getTag());
+ }
+
+ public function decideBeginFork(Twig_Token $token)
+ {
+ return $token->test(array('BEGINELSE', 'END'));
+ }
+
+ public function decideForEnd(Twig_Token $token)
+ {
+ return $token->test('END');
+ }
+
+ /**
+ * Gets the tag name associated with this token parser.
+ *
+ * @return string The tag name
+ */
+ public function getTag()
+ {
+ return 'BEGIN';
+ }
+}
diff --git a/phpBB/includes/template/twig/tokenparser/event.php b/phpBB/includes/template/twig/tokenparser/event.php
new file mode 100644
index 0000000000..cd211098d6
--- /dev/null
+++ b/phpBB/includes/template/twig/tokenparser/event.php
@@ -0,0 +1,33 @@
+<?php
+
+/*
+ * This file is part of Twig.
+ *
+ * (c) 2009 Fabien Potencier
+ * (c) 2009 Armin Ronacher
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+/**
+ * Includes a template.
+ *
+ * <pre>
+ * {% include 'header.html' %}
+ * Body
+ * {% include 'footer.html' %}
+ * </pre>
+ */
+class phpbb_template_twig_tokenparser_event extends Twig_TokenParser_Include
+{
+ /**
+ * Gets the tag name associated with this token parser.
+ *
+ * @return string The tag name
+ */
+ public function getTag()
+ {
+ return 'EVENT';
+ }
+}
diff --git a/phpBB/includes/template/twig/tokenparser/if.php b/phpBB/includes/template/twig/tokenparser/if.php
new file mode 100644
index 0000000000..e47744093e
--- /dev/null
+++ b/phpBB/includes/template/twig/tokenparser/if.php
@@ -0,0 +1,94 @@
+<?php
+
+/*
+ * This file is part of Twig.
+ *
+ * (c) 2009 Fabien Potencier
+ * (c) 2009 Armin Ronacher
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+/**
+ * Tests a condition.
+ *
+ * <pre>
+ * {% if users %}
+ * <ul>
+ * {% for user in users %}
+ * <li>{{ user.username|e }}</li>
+ * {% endfor %}
+ * </ul>
+ * {% endif %}
+ * </pre>
+ */
+class phpbb_template_twig_tokenparser_if extends Twig_TokenParser_If
+{
+ /**
+ * Parses a token and returns a node.
+ *
+ * @param Twig_Token $token A Twig_Token instance
+ *
+ * @return Twig_NodeInterface A Twig_NodeInterface instance
+ */
+ public function parse(Twig_Token $token)
+ {
+ $lineno = $token->getLine();
+ $expr = $this->parser->getExpressionParser()->parseExpression();
+ $stream = $this->parser->getStream();
+ $stream->expect(Twig_Token::BLOCK_END_TYPE);
+ $body = $this->parser->subparse(array($this, 'decideIfFork'));
+ $tests = array($expr, $body);
+ $else = null;
+
+ $end = false;
+ while (!$end) {
+ switch ($stream->next()->getValue()) {
+ case 'ELSE':
+ $stream->expect(Twig_Token::BLOCK_END_TYPE);
+ $else = $this->parser->subparse(array($this, 'decideIfEnd'));
+ break;
+
+ case 'ELSEIF':
+ $expr = $this->parser->getExpressionParser()->parseExpression();
+ $stream->expect(Twig_Token::BLOCK_END_TYPE);
+ $body = $this->parser->subparse(array($this, 'decideIfFork'));
+ $tests[] = $expr;
+ $tests[] = $body;
+ break;
+
+ case 'ENDIF':
+ $end = true;
+ break;
+
+ default:
+ throw new Twig_Error_Syntax(sprintf('Unexpected end of template. Twig was looking for the following tags "ELSE", "ELSEIF", or "ENDIF" to close the "IF" block started at line %d)', $lineno), $stream->getCurrent()->getLine(), $stream->getFilename());
+ }
+ }
+
+ $stream->expect(Twig_Token::BLOCK_END_TYPE);
+
+ return new Twig_Node_If(new Twig_Node($tests), $else, $lineno, $this->getTag());
+ }
+
+ public function decideIfFork(Twig_Token $token)
+ {
+ return $token->test(array('ELSEIF', 'ELSE', 'ENDIF'));
+ }
+
+ public function decideIfEnd(Twig_Token $token)
+ {
+ return $token->test(array('ENDIF'));
+ }
+
+ /**
+ * Gets the tag name associated with this token parser.
+ *
+ * @return string The tag name
+ */
+ public function getTag()
+ {
+ return 'IF';
+ }
+}
diff --git a/phpBB/includes/template/twig/tokenparser/include.php b/phpBB/includes/template/twig/tokenparser/include.php
new file mode 100644
index 0000000000..d9421095d1
--- /dev/null
+++ b/phpBB/includes/template/twig/tokenparser/include.php
@@ -0,0 +1,33 @@
+<?php
+
+/*
+ * This file is part of Twig.
+ *
+ * (c) 2009 Fabien Potencier
+ * (c) 2009 Armin Ronacher
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+/**
+ * Includes a template.
+ *
+ * <pre>
+ * {% include 'header.html' %}
+ * Body
+ * {% include 'footer.html' %}
+ * </pre>
+ */
+class phpbb_template_twig_tokenparser_include extends Twig_TokenParser_Include
+{
+ /**
+ * Gets the tag name associated with this token parser.
+ *
+ * @return string The tag name
+ */
+ public function getTag()
+ {
+ return 'INCLUDE';
+ }
+}