refactored extensions management

This commit is contained in:
Fabien Potencier
2015-10-25 07:24:20 +01:00
parent e82e447194
commit 8b7698f8ff
4 changed files with 528 additions and 308 deletions
+43 -296
View File
@@ -27,25 +27,13 @@ class Twig_Environment
private $parser;
private $compiler;
private $baseTemplateClass;
private $extensions;
private $parsers;
private $visitors;
private $filters;
private $tests;
private $functions;
private $globals;
private $runtimeInitialized = false;
private $extensionInitialized = false;
private $globals = array();
private $resolvedGlobals;
private $loadedTemplates;
private $strictVariables;
private $unaryOperators;
private $binaryOperators;
private $templateClassPrefix = '__TwigTemplate_';
private $functionCallbacks = array();
private $filterCallbacks = array();
private $staging;
private $originalCache;
private $lastModifiedExtension = 0;
private $extensionSet;
/**
* Constructor.
@@ -105,11 +93,11 @@ class Twig_Environment
$this->autoReload = null === $options['auto_reload'] ? $this->debug : (bool) $options['auto_reload'];
$this->strictVariables = (bool) $options['strict_variables'];
$this->setCache($options['cache']);
$this->extensionSet = new Twig_ExtensionSet();
$this->addExtension(new Twig_Extension_Core());
$this->addExtension(new Twig_Extension_Escaper($options['autoescape']));
$this->addExtension(new Twig_Extension_Optimizer($options['optimizations']));
$this->staging = new Twig_Extension_Staging();
}
/**
@@ -263,7 +251,7 @@ class Twig_Environment
public function getTemplateClass($name, $index = null)
{
$key = $this->getLoader()->getCacheKey($name);
$key .= json_encode(array_keys($this->extensions));
$key .= $this->extensionSet->getSignature();
$key .= function_exists('twig_template_get_attributes');
return $this->templateClassPrefix.hash('sha256', $key).(null === $index ? '' : '_'.$index);
@@ -335,9 +323,8 @@ class Twig_Environment
}
}
if (!$this->runtimeInitialized) {
$this->initRuntime();
}
// to be removed in 3.0
$this->extensionSet->initRuntime($this);
return $this->loadedTemplates[$cls] = new $cls($this);
}
@@ -387,16 +374,7 @@ class Twig_Environment
*/
public function isTemplateFresh($name, $time)
{
if (0 === $this->lastModifiedExtension) {
foreach ($this->extensions as $extension) {
$r = new ReflectionObject($extension);
if (file_exists($r->getFileName()) && ($extensionTime = filemtime($r->getFileName())) > $this->lastModifiedExtension) {
$this->lastModifiedExtension = $extensionTime;
}
}
}
return $this->lastModifiedExtension <= $time && $this->getLoader()->isFresh($name, $time);
return $this->extensionSet->getLastModified() <= $time && $this->getLoader()->isFresh($name, $time);
}
/**
@@ -592,20 +570,6 @@ class Twig_Environment
return $this->charset;
}
/**
* Initializes the runtime environment.
*/
public function initRuntime()
{
$this->runtimeInitialized = true;
foreach ($this->getExtensions() as $extension) {
if ($extension instanceof Twig_Extension_InitRuntimeInterface) {
$extension->initRuntime($this);
}
}
}
/**
* Returns true if the given extension is registered.
*
@@ -615,7 +579,7 @@ class Twig_Environment
*/
public function hasExtension($name)
{
return isset($this->extensions[$name]);
return $this->extensionSet->hasExtension($name);
}
/**
@@ -627,11 +591,7 @@ class Twig_Environment
*/
public function getExtension($name)
{
if (!isset($this->extensions[$name])) {
throw new Twig_Error_Runtime(sprintf('The "%s" extension is not enabled.', $name));
}
return $this->extensions[$name];
return $this->extensionSet->getExtension($name);
}
/**
@@ -641,19 +601,7 @@ class Twig_Environment
*/
public function addExtension(Twig_ExtensionInterface $extension)
{
$name = $extension->getName();
if ($this->extensionInitialized) {
throw new LogicException(sprintf('Unable to register extension "%s" as extensions have already been initialized.', $name));
}
if (isset($this->extensions[$name])) {
throw new LogicException(sprintf('Unable to register extension "%s" as it is already registered.', $name));
}
$this->lastModifiedExtension = 0;
$this->extensions[$name] = $extension;
$this->extensionSet->addExtension($extension);
}
/**
@@ -663,9 +611,7 @@ class Twig_Environment
*/
public function setExtensions(array $extensions)
{
foreach ($extensions as $extension) {
$this->addExtension($extension);
}
$this->extensionSet->setExtensions($extensions);
}
/**
@@ -675,7 +621,7 @@ class Twig_Environment
*/
public function getExtensions()
{
return $this->extensions;
return $this->extensionSet->getExtensions();
}
/**
@@ -685,11 +631,7 @@ class Twig_Environment
*/
public function addTokenParser(Twig_TokenParserInterface $parser)
{
if ($this->extensionInitialized) {
throw new LogicException('Unable to add a token parser as extensions have already been initialized.');
}
$this->staging->addTokenParser($parser);
$this->extensionSet->addTokenParser($parser);
}
/**
@@ -701,11 +643,7 @@ class Twig_Environment
*/
public function getTokenParsers()
{
if (!$this->extensionInitialized) {
$this->initExtensions();
}
return $this->parsers;
return $this->extensionSet->getTokenParsers();
}
/**
@@ -732,11 +670,7 @@ class Twig_Environment
*/
public function addNodeVisitor(Twig_NodeVisitorInterface $visitor)
{
if ($this->extensionInitialized) {
throw new LogicException('Unable to add a node visitor as extensions have already been initialized.');
}
$this->staging->addNodeVisitor($visitor);
$this->extensionSet->addNodeVisitor($visitor);
}
/**
@@ -748,11 +682,7 @@ class Twig_Environment
*/
public function getNodeVisitors()
{
if (!$this->extensionInitialized) {
$this->initExtensions();
}
return $this->visitors;
return $this->extensionSet->getNodeVisitors();
}
/**
@@ -762,11 +692,7 @@ class Twig_Environment
*/
public function addFilter(Twig_Filter $filter)
{
if ($this->extensionInitialized) {
throw new LogicException(sprintf('Unable to add filter "%s" as extensions have already been initialized.', $filter->getName()));
}
$this->staging->addFilter($filter);
$this->extensionSet->addFilter($filter);
}
/**
@@ -783,39 +709,12 @@ class Twig_Environment
*/
public function getFilter($name)
{
if (!$this->extensionInitialized) {
$this->initExtensions();
}
if (isset($this->filters[$name])) {
return $this->filters[$name];
}
foreach ($this->filters as $pattern => $filter) {
$pattern = str_replace('\\*', '(.*?)', preg_quote($pattern, '#'), $count);
if ($count) {
if (preg_match('#^'.$pattern.'$#', $name, $matches)) {
array_shift($matches);
$filter->setArguments($matches);
return $filter;
}
}
}
foreach ($this->filterCallbacks as $callback) {
if (false !== $filter = $callback($name)) {
return $filter;
}
}
return false;
return $this->extensionSet->getFilter($name);
}
public function registerUndefinedFilterCallback(callable $callable)
{
$this->filterCallbacks[] = $callable;
$this->extensionSet->registerUndefinedFilterCallback($callable);
}
/**
@@ -831,11 +730,7 @@ class Twig_Environment
*/
public function getFilters()
{
if (!$this->extensionInitialized) {
$this->initExtensions();
}
return $this->filters;
return $this->extensionSet->getFilters();
}
/**
@@ -845,11 +740,7 @@ class Twig_Environment
*/
public function addTest(Twig_Test $test)
{
if ($this->extensionInitialized) {
throw new LogicException(sprintf('Unable to add test "%s" as extensions have already been initialized.', $test->getName()));
}
$this->staging->addTest($test);
$this->extensionSet->addTest($test);
}
/**
@@ -861,11 +752,7 @@ class Twig_Environment
*/
public function getTests()
{
if (!$this->extensionInitialized) {
$this->initExtensions();
}
return $this->tests;
return $this->extensionSet->getTests();
}
/**
@@ -879,15 +766,7 @@ class Twig_Environment
*/
public function getTest($name)
{
if (!$this->extensionInitialized) {
$this->initExtensions();
}
if (isset($this->tests[$name])) {
return $this->tests[$name];
}
return false;
return $this->extensionSet->getTest($name);
}
/**
@@ -897,11 +776,7 @@ class Twig_Environment
*/
public function addFunction(Twig_Function $function)
{
if ($this->extensionInitialized) {
throw new LogicException(sprintf('Unable to add function "%s" as extensions have already been initialized.', $function->getName()));
}
$this->staging->addFunction($function);
$this->extensionSet->addFunction($function);
}
/**
@@ -918,39 +793,12 @@ class Twig_Environment
*/
public function getFunction($name)
{
if (!$this->extensionInitialized) {
$this->initExtensions();
}
if (isset($this->functions[$name])) {
return $this->functions[$name];
}
foreach ($this->functions as $pattern => $function) {
$pattern = str_replace('\\*', '(.*?)', preg_quote($pattern, '#'), $count);
if ($count) {
if (preg_match('#^'.$pattern.'$#', $name, $matches)) {
array_shift($matches);
$function->setArguments($matches);
return $function;
}
}
}
foreach ($this->functionCallbacks as $callback) {
if (false !== $function = $callback($name)) {
return $function;
}
}
return false;
return $this->extensionSet->getFunction($name);
}
public function registerUndefinedFunctionCallback(callable $callable)
{
$this->functionCallbacks[] = $callable;
$this->extensionSet->registerUndefinedFunctionCallback($callable);
}
/**
@@ -966,11 +814,7 @@ class Twig_Environment
*/
public function getFunctions()
{
if (!$this->extensionInitialized) {
$this->initExtensions();
}
return $this->functions;
return $this->extensionSet->getFunctions();
}
/**
@@ -984,19 +828,14 @@ class Twig_Environment
*/
public function addGlobal($name, $value)
{
if ($this->extensionInitialized || $this->runtimeInitialized) {
if (null === $this->globals) {
$this->globals = $this->initGlobals();
}
if ($this->extensionSet->isInitialized() && !array_key_exists($name, $this->getGlobals())) {
throw new LogicException(sprintf('Unable to add global "%s" as the runtime or the extensions have already been initialized.', $name));
}
if (!array_key_exists($name, $this->globals)) {
throw new LogicException(sprintf('Unable to add global "%s" as the runtime or the extensions have already been initialized.', $name));
}
// update the value
$this->globals[$name] = $value;
if (null !== $this->resolvedGlobals) {
$this->resolvedGlobals[$name] = $value;
} else {
$this->staging->addGlobal($name, $value);
$this->globals[$name] = $value;
}
}
@@ -1009,15 +848,15 @@ class Twig_Environment
*/
public function getGlobals()
{
if (!$this->runtimeInitialized && !$this->extensionInitialized) {
return $this->initGlobals();
if ($this->extensionSet->isInitialized()) {
if (null === $this->resolvedGlobals) {
$this->resolvedGlobals = array_merge($this->extensionSet->getGlobals(), $this->globals);
}
return $this->resolvedGlobals;
}
if (null === $this->globals) {
$this->globals = $this->initGlobals();
}
return $this->globals;
return array_merge($this->extensionSet->getGlobals(), $this->globals);
}
/**
@@ -1049,11 +888,7 @@ class Twig_Environment
*/
public function getUnaryOperators()
{
if (!$this->extensionInitialized) {
$this->initExtensions();
}
return $this->unaryOperators;
return $this->extensionSet->getUnaryOperators();
}
/**
@@ -1065,94 +900,6 @@ class Twig_Environment
*/
public function getBinaryOperators()
{
if (!$this->extensionInitialized) {
$this->initExtensions();
}
return $this->binaryOperators;
}
private function initGlobals()
{
$globals = array();
foreach ($this->extensions as $name => $extension) {
if (!$extension instanceof Twig_Extension_GlobalsInterface) {
continue;
}
$extGlob = $extension->getGlobals();
if (!is_array($extGlob)) {
throw new UnexpectedValueException(sprintf('"%s::getGlobals()" must return an array of globals.', get_class($extension)));
}
$globals[] = $extGlob;
}
$globals[] = $this->staging->getGlobals();
return call_user_func_array('array_merge', $globals);
}
private function initExtensions()
{
if ($this->extensionInitialized) {
return;
}
$this->extensionInitialized = true;
$this->parsers = array();
$this->filters = array();
$this->functions = array();
$this->tests = array();
$this->visitors = array();
$this->unaryOperators = array();
$this->binaryOperators = array();
foreach ($this->extensions as $extension) {
$this->initExtension($extension);
}
$this->initExtension($this->staging);
}
private function initExtension(Twig_ExtensionInterface $extension)
{
// filters
foreach ($extension->getFilters() as $filter) {
$this->filters[$filter->getName()] = $filter;
}
// functions
foreach ($extension->getFunctions() as $function) {
$this->functions[$function->getName()] = $function;
}
// tests
foreach ($extension->getTests() as $test) {
$this->tests[$test->getName()] = $test;
}
// token parsers
foreach ($extension->getTokenParsers() as $parser) {
if (!$parser instanceof Twig_TokenParserInterface) {
throw new LogicException('getTokenParsers() must return an array of Twig_TokenParserInterface');
}
$this->parsers[] = $parser;
}
// node visitors
foreach ($extension->getNodeVisitors() as $visitor) {
$this->visitors[] = $visitor;
}
// operators
if ($operators = $extension->getOperators()) {
if (2 !== count($operators)) {
throw new InvalidArgumentException(sprintf('"%s::getOperators()" does not return a valid operators array.', get_class($extension)));
}
$this->unaryOperators = array_merge($this->unaryOperators, $operators[0]);
$this->binaryOperators = array_merge($this->binaryOperators, $operators[1]);
}
return $this->extensionSet->getBinaryOperators();
}
}
-11
View File
@@ -22,7 +22,6 @@ final class Twig_Extension_Staging extends Twig_Extension
private $filters = array();
private $visitors = array();
private $tokenParsers = array();
private $globals = array();
private $tests = array();
public function addFunction(Twig_Function $function)
@@ -65,16 +64,6 @@ final class Twig_Extension_Staging extends Twig_Extension
return $this->tokenParsers;
}
public function addGlobal($name, $value)
{
$this->globals[$name] = $value;
}
public function getGlobals()
{
return $this->globals;
}
public function addTest(Twig_Test $test)
{
$this->tests[$test->getName()] = $test;
+484
View File
@@ -0,0 +1,484 @@
<?php
/*
* This file is part of Twig.
*
* (c) Fabien Potencier
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
/**
* @author Fabien Potencier <fabien@symfony.com>
*
* @internal
*/
final class Twig_ExtensionSet
{
private $extensions;
private $initialized = false;
private $runtimeInitialized = false;
private $staging;
private $parsers;
private $visitors;
private $filters;
private $tests;
private $functions;
private $unaryOperators;
private $binaryOperators;
private $globals;
private $functionCallbacks = array();
private $filterCallbacks = array();
private $lastModified = 0;
public function __construct()
{
$this->staging = new Twig_Extension_Staging();
}
/**
* Initializes the runtime environment.
*/
public function initRuntime(Twig_Environment $env)
{
if ($this->runtimeInitialized) {
return;
}
$this->runtimeInitialized = true;
foreach ($this->extensions as $extension) {
if ($extension instanceof Twig_Extension_InitRuntimeInterface) {
$extension->initRuntime($env);
}
}
}
/**
* Returns true if the given extension is registered.
*
* @param string $name The extension name
*
* @return bool Whether the extension is registered or not
*/
public function hasExtension($name)
{
return isset($this->extensions[$name]);
}
/**
* Gets an extension by name.
*
* @param string $name The extension name
*
* @return Twig_ExtensionInterface A Twig_ExtensionInterface instance
*/
public function getExtension($name)
{
if (!isset($this->extensions[$name])) {
throw new Twig_Error_Runtime(sprintf('The "%s" extension is not enabled.', $name));
}
return $this->extensions[$name];
}
/**
* Registers an array of extensions.
*
* @param array $extensions An array of extensions
*/
public function setExtensions(array $extensions)
{
foreach ($extensions as $extension) {
$this->addExtension($extension);
}
}
/**
* Returns all registered extensions.
*
* @return array An array of extensions
*/
public function getExtensions()
{
return $this->extensions;
}
public function getSignature()
{
return json_encode(array_keys($this->extensions));
}
public function isInitialized()
{
return $this->initialized || $this->runtimeInitialized;
}
public function getLastModified()
{
if (0 !== $this->lastModified) {
return $this->lastModified;
}
foreach ($this->extensions as $extension) {
$r = new ReflectionObject($extension);
if (file_exists($r->getFileName()) && ($extensionTime = filemtime($r->getFileName())) > $this->lastModified) {
$this->lastModified = $extensionTime;
}
}
return $this->lastModified;
}
/**
* Registers an extension.
*
* @param Twig_ExtensionInterface $extension A Twig_ExtensionInterface instance
*/
public function addExtension(Twig_ExtensionInterface $extension)
{
$name = $extension->getName();
if ($this->initialized) {
throw new LogicException(sprintf('Unable to register extension "%s" as extensions have already been initialized.', $name));
}
if (isset($this->extensions[$name])) {
throw new LogicException(sprintf('Unable to register extension "%s" as it is already registered.', $name));
}
$this->lastModifiedExtension = 0;
$this->extensions[$name] = $extension;
}
public function addFunction(Twig_Function $function)
{
if ($this->initialized) {
throw new LogicException(sprintf('Unable to add function "%s" as extensions have already been initialized.', $function->getName()));
}
$this->staging->addFunction($function);
}
/**
* {@inheritdoc}
*/
public function getFunctions()
{
if (!$this->initialized) {
$this->initExtensions();
}
return $this->functions;
}
/**
* Get a function by name.
*
* @param string $name function name
*
* @return Twig_Function|false A Twig_Function instance or false if the function does not exist
*/
public function getFunction($name)
{
if (!$this->initialized) {
$this->initExtensions();
}
if (isset($this->functions[$name])) {
return $this->functions[$name];
}
foreach ($this->functions as $pattern => $function) {
$pattern = str_replace('\\*', '(.*?)', preg_quote($pattern, '#'), $count);
if ($count && preg_match('#^'.$pattern.'$#', $name, $matches)) {
array_shift($matches);
$function->setArguments($matches);
return $function;
}
}
foreach ($this->functionCallbacks as $callback) {
if (false !== $function = $callback($name)) {
return $function;
}
}
return false;
}
public function registerUndefinedFunctionCallback(callable $callable)
{
$this->functionCallbacks[] = $callable;
}
public function addFilter(Twig_Filter $filter)
{
if ($this->initialized) {
throw new LogicException(sprintf('Unable to add filter "%s" as extensions have already been initialized.', $filter->getName()));
}
$this->staging->addFilter($filter);
}
/**
* {@inheritdoc}
*/
public function getFilters()
{
if (!$this->initialized) {
$this->initExtensions();
}
return $this->filters;
}
/**
* Get a filter by name.
*
* Subclasses may override this method and load filters differently;
* so no list of filters is available.
*
* @param string $name The filter name
*
* @return Twig_Filter|false A Twig_Filter instance or false if the filter does not exist
*/
public function getFilter($name)
{
if (!$this->initialized) {
$this->initExtensions();
}
if (isset($this->filters[$name])) {
return $this->filters[$name];
}
foreach ($this->filters as $pattern => $filter) {
$pattern = str_replace('\\*', '(.*?)', preg_quote($pattern, '#'), $count);
if ($count && preg_match('#^'.$pattern.'$#', $name, $matches)) {
array_shift($matches);
$filter->setArguments($matches);
return $filter;
}
}
foreach ($this->filterCallbacks as $callback) {
if (false !== $filter = $callback($name)) {
return $filter;
}
}
return false;
}
public function registerUndefinedFilterCallback(callable $callable)
{
$this->filterCallbacks[] = $callable;
}
public function addNodeVisitor(Twig_NodeVisitorInterface $visitor)
{
if ($this->initialized) {
throw new LogicException('Unable to add a node visitor as extensions have already been initialized.');
}
$this->staging->addNodeVisitor($visitor);
}
/**
* {@inheritdoc}
*/
public function getNodeVisitors()
{
if (!$this->initialized) {
$this->initExtensions();
}
return $this->visitors;
}
public function addTokenParser(Twig_TokenParserInterface $parser)
{
if ($this->initialized) {
throw new LogicException('Unable to add a token parser as extensions have already been initialized.');
}
$this->staging->addTokenParser($parser);
}
/**
* {@inheritdoc}
*/
public function getTokenParsers()
{
if (!$this->initialized) {
$this->initExtensions();
}
return $this->parsers;
}
/**
* {@inheritdoc}
*/
public function getGlobals()
{
if (null !== $this->globals) {
return $this->globals;
}
$globals = array();
foreach ($this->extensions as $extension) {
if (!$extension instanceof Twig_Extension_GlobalsInterface) {
continue;
}
$extGlobals = $extension->getGlobals();
if (!is_array($extGlobals)) {
throw new UnexpectedValueException(sprintf('"%s::getGlobals()" must return an array of globals.', get_class($extension)));
}
$globals = array_merge($globals, $extGlobals);
}
if ($this->initialized) {
$this->globals = $globals;
}
return $globals;
}
public function addTest(Twig_Test $test)
{
if ($this->initialized) {
throw new LogicException(sprintf('Unable to add test "%s" as extensions have already been initialized.', $test->getName()));
}
$this->staging->addTest($test);
}
/**
* {@inheritdoc}
*/
public function getTests()
{
if (!$this->initialized) {
$this->initExtensions();
}
return $this->tests;
}
/**
* Gets a test by name.
*
* @param string $name The test name
*
* @return Twig_Test|false A Twig_Test instance or false if the test does not exist
*/
public function getTest($name)
{
if (!$this->initialized) {
$this->initExtensions();
}
if (isset($this->tests[$name])) {
return $this->tests[$name];
}
return false;
}
/**
* Gets the registered unary Operators.
*
* @return array An array of unary operators
*/
public function getUnaryOperators()
{
if (!$this->initialized) {
$this->initExtensions();
}
return $this->unaryOperators;
}
/**
* Gets the registered binary Operators.
*
* @return array An array of binary operators
*/
public function getBinaryOperators()
{
if (!$this->initialized) {
$this->initExtensions();
}
return $this->binaryOperators;
}
private function initExtensions()
{
$this->initialized = true;
$this->parsers = array();
$this->filters = array();
$this->functions = array();
$this->tests = array();
$this->visitors = array();
$this->unaryOperators = array();
$this->binaryOperators = array();
foreach ($this->extensions as $extension) {
$this->initExtension($extension);
}
$this->initExtension($this->staging);
}
private function initExtension(Twig_ExtensionInterface $extension)
{
// filters
foreach ($extension->getFilters() as $filter) {
$this->filters[$filter->getName()] = $filter;
}
// functions
foreach ($extension->getFunctions() as $function) {
$this->functions[$function->getName()] = $function;
}
// tests
foreach ($extension->getTests() as $test) {
$this->tests[$test->getName()] = $test;
}
// token parsers
foreach ($extension->getTokenParsers() as $parser) {
if (!$parser instanceof Twig_TokenParserInterface) {
throw new LogicException('getTokenParsers() must return an array of Twig_TokenParserInterface');
}
$this->parsers[] = $parser;
}
// node visitors
foreach ($extension->getNodeVisitors() as $visitor) {
$this->visitors[] = $visitor;
}
// operators
if ($operators = $extension->getOperators()) {
if (2 !== count($operators)) {
throw new InvalidArgumentException(sprintf('"%s::getOperators()" does not return a valid operators array.', get_class($extension)));
}
$this->unaryOperators = array_merge($this->unaryOperators, $operators[0]);
$this->binaryOperators = array_merge($this->binaryOperators, $operators[1]);
}
}
}
+1 -1
View File
@@ -287,7 +287,7 @@ class Twig_Tests_EnvironmentTest extends PHPUnit_Framework_TestCase
$twig = new Twig_Environment($this->getMockBuilder('Twig_LoaderInterface')->getMock());
$twig->addExtension(new Twig_Tests_EnvironmentTest_ExtensionWithoutDeprecationInitRuntime());
$twig->initRuntime();
$twig->loadTemplate('');
}
/**