Stores the Twig configuration. More...

Inheritance diagram for Twig_Environment:

Collaboration diagram for Twig_Environment:

Public Member Functions
	__construct (Twig_LoaderInterface $loader=null, $options=array())
	Constructor. More...

	getBaseTemplateClass ()
	Gets the base template class for compiled templates. More...

	setBaseTemplateClass ($class)
	Sets the base template class for compiled templates. More...

	enableDebug ()
	Enables debugging mode. More...

	disableDebug ()
	Disables debugging mode. More...

	isDebug ()
	Checks if debug mode is enabled. More...

	enableAutoReload ()
	Enables the auto_reload option. More...

	disableAutoReload ()
	Disables the auto_reload option. More...

	isAutoReload ()
	Checks if the auto_reload option is enabled. More...

	enableStrictVariables ()
	Enables the strict_variables option. More...

	disableStrictVariables ()
	Disables the strict_variables option. More...

	isStrictVariables ()
	Checks if the strict_variables option is enabled. More...

	getCache ($original=true)
	Gets the current cache implementation. More...

	setCache ($cache)
	Sets the current cache implementation. More...

	getCacheFilename ($name)
	Gets the cache filename for a given template. More...

	getTemplateClass ($name, $index=null)
	Gets the template class associated with the given string. More...

	getTemplateClassPrefix ()
	Gets the template class prefix. More...

	render ($name, array $context=array())
	Renders a template. More...

	display ($name, array $context=array())
	Displays a template. More...

	load ($name)
	Loads a template. More...

	loadTemplate ($name, $index=null)
	Loads a template internal representation. More...

	createTemplate ($template)
	Creates a template from source. More...

	isTemplateFresh ($name, $time)
	Returns true if the template is still fresh. More...

	resolveTemplate ($names)
	Tries to load a template consecutively from an array. More...

	clearTemplateCache ()
	Clears the internal template cache. More...

	clearCacheFiles ()
	Clears the template cache files on the filesystem. More...

	getLexer ()
	Gets the Lexer instance. More...

	setLexer (Twig_LexerInterface $lexer)

	tokenize ($source, $name=null)
	Tokenizes a source code. More...

	getParser ()
	Gets the Parser instance. More...

	setParser (Twig_ParserInterface $parser)

	parse (Twig_TokenStream $stream)
	Converts a token stream to a node tree. More...

	getCompiler ()
	Gets the Compiler instance. More...

	setCompiler (Twig_CompilerInterface $compiler)

	compile (Twig_NodeInterface $node)
	Compiles a node and returns the PHP code. More...

	compileSource ($source, $name=null)
	Compiles a template source code. More...

	setLoader (Twig_LoaderInterface $loader)

	getLoader ()
	Gets the Loader instance. More...

	setCharset ($charset)
	Sets the default template charset. More...

	getCharset ()
	Gets the default template charset. More...

	initRuntime ()
	Initializes the runtime environment. More...

	hasExtension ($class)
	Returns true if the given extension is registered. More...

	addRuntimeLoader (Twig_RuntimeLoaderInterface $loader)
	Adds a runtime loader. More...

	getExtension ($class)
	Gets an extension by class name. More...

	getRuntime ($class)
	Returns the runtime implementation of a Twig element (filter/function/test). More...

	addExtension (Twig_ExtensionInterface $extension)

	removeExtension ($name)
	Removes an extension by name. More...

	setExtensions (array $extensions)
	Registers an array of extensions. More...

	getExtensions ()
	Returns all registered extensions. More...

	addTokenParser (Twig_TokenParserInterface $parser)

	getTokenParsers ()
	Gets the registered Token Parsers. More...

	getTags ()
	Gets registered tags. More...

	addNodeVisitor (Twig_NodeVisitorInterface $visitor)

	getNodeVisitors ()
	Gets the registered Node Visitors. More...

	addFilter ($name, $filter=null)
	Registers a Filter. More...

	getFilter ($name)
	Get a filter by name. More...

	registerUndefinedFilterCallback ($callable)

	getFilters ()
	Gets the registered Filters. More...

	addTest ($name, $test=null)
	Registers a Test. More...

	getTests ()
	Gets the registered Tests. More...

	getTest ($name)
	Gets a test by name. More...

	addFunction ($name, $function=null)
	Registers a Function. More...

	getFunction ($name)
	Get a function by name. More...

	registerUndefinedFunctionCallback ($callable)

	getFunctions ()
	Gets registered functions. More...

	addGlobal ($name, $value)
	Registers a Global. More...

	getGlobals ()
	Gets the registered Globals. More...

	mergeGlobals (array $context)
	Merges a context with the defined globals. More...

	getUnaryOperators ()
	Gets the registered unary Operators. More...

	getBinaryOperators ()
	Gets the registered binary Operators. More...

	computeAlternatives ($name, $items)

Data Fields
const	VERSION = '1.35.3'

const	VERSION_ID = 13503

const	MAJOR_VERSION = 1

const	MINOR_VERSION = 35

const	RELEASE_VERSION = 3

const	EXTRA_VERSION = ''

Protected Member Functions
	initGlobals ()

	initExtensions ()

	initExtension (Twig_ExtensionInterface $extension)

	writeCacheFile ($file, $content)

Protected Attributes
	$charset

	$loader

	$debug

	$autoReload

	$cache

	$lexer

	$parser

	$compiler

	$baseTemplateClass

	$extensions

	$parsers

	$visitors

	$filters

	$tests

	$functions

	$globals

	$runtimeInitialized = false

	$extensionInitialized = false

	$loadedTemplates

	$strictVariables

	$unaryOperators

	$binaryOperators

	$templateClassPrefix = '__TwigTemplate_'

	$functionCallbacks = array()

	$filterCallbacks = array()

	$staging

Private Member Functions
	updateOptionsHash ()

Private Attributes
	$originalCache

	$bcWriteCacheFile = false

	$bcGetCacheFilename = false

	$lastModifiedExtension = 0

	$extensionsByClass = array()

	$runtimeLoaders = array()

	$runtimes = array()

	$optionsHash

	$loading = array()

Detailed Description

Stores the Twig configuration.

Author: Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

Definition at line 17 of file Environment.php.

Constructor & Destructor Documentation

◆ __construct()

Twig_Environment::__construct	(	Twig_LoaderInterface	$loader = `null`,
			$options = `array()`
	)

Constructor.

Available options:

debug: When set to true, it automatically set "auto_reload" to true as well (default to false).
charset: The charset used by the templates (default to UTF-8).
base_template_class: The base template class to use for generated templates (default to Twig_Template).
cache: An absolute path where to store the compiled templates, a Twig_Cache_Interface implementation, or false to disable compilation cache (default).
auto_reload: Whether to reload the template if the original source changed. If you don't provide the auto_reload option, it will be determined automatically based on the debug value.
strict_variables: Whether to ignore invalid variables in templates (default to false).
autoescape: Whether to enable auto-escaping (default to html):
- false: disable auto-escaping
- true: equivalent to html
- html, js: set the autoescaping to one of the supported strategies
- name: set the autoescaping strategy based on the template name extension
- PHP callback: a PHP callback that returns an escaping strategy based on the template "name"
optimizations: A flag that indicates which optimizations to apply (default to -1 which means that all optimizations are enabled; set it to 0 to disable).

Parameters

Twig_LoaderInterface	$loader
array	$options	An array of options

Definition at line 101 of file Environment.php.

    {
        if (null !== $loader) {
            $this->setLoader($loader);
        } else {
            @trigger_error('Not passing a Twig_LoaderInterface as the first constructor argument of Twig_Environment is deprecated since version 1.21.', E_USER_DEPRECATED);
        }
 
        $options = array_merge(array(
            'debug' => false,
            'charset' => 'UTF-8',
            'base_template_class' => 'Twig_Template',
            'strict_variables' => false,
            'autoescape' => 'html',
            'cache' => false,
            'auto_reload' => null,
            'optimizations' => -1,
        ), $options);
 
        $this->debug = (bool) $options['debug'];
        $this->charset = strtoupper($options['charset']);
        $this->baseTemplateClass = $options['base_template_class'];
        $this->autoReload = null === $options['auto_reload'] ? $this->debug : (bool) $options['auto_reload'];
        $this->strictVariables = (bool) $options['strict_variables'];
        $this->setCache($options['cache']);
 
        $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();
 
        // For BC
        if (is_string($this->originalCache)) {
            $r = new ReflectionMethod($this, 'writeCacheFile');
            if (__CLASS__ !== $r->getDeclaringClass()->getName()) {
                @trigger_error('The Twig_Environment::writeCacheFile method is deprecated since version 1.22 and will be removed in Twig 2.0.', E_USER_DEPRECATED);
 
                $this->bcWriteCacheFile = true;
            }
 
            $r = new ReflectionMethod($this, 'getCacheFilename');
            if (__CLASS__ !== $r->getDeclaringClass()->getName()) {
                @trigger_error('The Twig_Environment::getCacheFilename method is deprecated since version 1.22 and will be removed in Twig 2.0.', E_USER_DEPRECATED);
 
                $this->bcGetCacheFilename = true;
            }
        }
    }

References $loader, $options, $r, addExtension(), setCache(), and setLoader().

Here is the call graph for this function:

Member Function Documentation

◆ addExtension()

Twig_Environment::addExtension ( Twig_ExtensionInterface $extension )

Definition at line 938 of file Environment.php.

    {
        if ($this->extensionInitialized) {
            throw new LogicException(sprintf('Unable to register extension "%s" as extensions have already been initialized.', $extension->getName()));
        }
 
        $class = get_class($extension);
        if ($class !== $extension->getName()) {
            if (isset($this->extensions[$extension->getName()])) {
                unset($this->extensions[$extension->getName()], $this->extensionsByClass[$class]);
                @trigger_error(sprintf('The possibility to register the same extension twice ("%s") is deprecated since version 1.23 and will be removed in Twig 2.0. Use proper PHP inheritance instead.', $extension->getName()), E_USER_DEPRECATED);
            }
        }
 
        $this->lastModifiedExtension = 0;
        $this->extensionsByClass[$class] = $extension;
        $this->extensions[$extension->getName()] = $extension;
        $this->updateOptionsHash();
    }

References Twig_ExtensionInterface\getName(), sprintf, and updateOptionsHash().

Referenced by __construct(), and setExtensions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addFilter()

Twig_Environment::addFilter	(	$name,
		$filter = `null`
	)

Registers a Filter.

Parameters

string \| Twig_SimpleFilter	$name	The filter name or a Twig_SimpleFilter instance
Twig_FilterInterface \| Twig_SimpleFilter	$filter

Definition at line 1093 of file Environment.php.

    {
        if (!$name instanceof Twig_SimpleFilter && !($filter instanceof Twig_SimpleFilter || $filter instanceof Twig_FilterInterface)) {
            throw new LogicException('A filter must be an instance of Twig_FilterInterface or Twig_SimpleFilter.');
        }
 
        if ($name instanceof Twig_SimpleFilter) {
            $filter = $name;
            $name = $filter->getName();
        } else {
            @trigger_error(sprintf('Passing a name as a first argument to the %s method is deprecated since version 1.21. Pass an instance of "Twig_SimpleFilter" instead when defining filter "%s".', __METHOD__, $name), E_USER_DEPRECATED);
        }
 
        if ($this->extensionInitialized) {
            throw new LogicException(sprintf('Unable to add filter "%s" as extensions have already been initialized.', $name));
        }
 
        $this->staging->addFilter($name, $filter);
    }

References $name, and sprintf.

◆ addFunction()

Twig_Environment::addFunction	(	$name,
		$function = `null`
	)

Registers a Function.

Parameters

string \| Twig_SimpleFunction	$name	The function name or a Twig_SimpleFunction instance
Twig_FunctionInterface \| Twig_SimpleFunction	$function

Definition at line 1252 of file Environment.php.

    {
        if (!$name instanceof Twig_SimpleFunction && !($function instanceof Twig_SimpleFunction || $function instanceof Twig_FunctionInterface)) {
            throw new LogicException('A function must be an instance of Twig_FunctionInterface or Twig_SimpleFunction.');
        }
 
        if ($name instanceof Twig_SimpleFunction) {
            $function = $name;
            $name = $function->getName();
        } else {
            @trigger_error(sprintf('Passing a name as a first argument to the %s method is deprecated since version 1.21. Pass an instance of "Twig_SimpleFunction" instead when defining function "%s".', __METHOD__, $name), E_USER_DEPRECATED);
        }
 
        if ($this->extensionInitialized) {
            throw new LogicException(sprintf('Unable to add function "%s" as extensions have already been initialized.', $name));
        }
 
        $this->staging->addFunction($name, $function);
    }

References $function, $name, and sprintf.

◆ addGlobal()

Twig_Environment::addGlobal	(	$name,
		$value
	)

Registers a Global.

New globals can be added before compiling or rendering a template; but after, you can only update existing globals.

Parameters

string	$name	The global name
mixed	$value	The global value

Definition at line 1350 of file Environment.php.

    {
        if ($this->extensionInitialized || $this->runtimeInitialized) {
            if (null === $this->globals) {
                $this->globals = $this->initGlobals();
            }
 
            if (!array_key_exists($name, $this->globals)) {
                // The deprecation notice must be turned into the following exception in Twig 2.0
                @trigger_error(sprintf('Registering global variable "%s" at runtime or when the extensions have already been initialized is deprecated since version 1.21.', $name), E_USER_DEPRECATED);
                //throw new LogicException(sprintf('Unable to add global "%s" as the runtime or the extensions have already been initialized.', $name));
            }
        }
 
        if ($this->extensionInitialized || $this->runtimeInitialized) {
            // update the value
            $this->globals[$name] = $value;
        } else {
            $this->staging->addGlobal($name, $value);
        }
    }

References $name, initGlobals(), and sprintf.

Here is the call graph for this function:

◆ addNodeVisitor()

Twig_Environment::addNodeVisitor ( Twig_NodeVisitorInterface $visitor )

Definition at line 1062 of file Environment.php.

    {
        if ($this->extensionInitialized) {
            throw new LogicException('Unable to add a node visitor as extensions have already been initialized.');
        }
 
        $this->staging->addNodeVisitor($visitor);
    }

◆ addRuntimeLoader()

Twig_Environment::addRuntimeLoader ( Twig_RuntimeLoaderInterface $loader )

Adds a runtime loader.

Definition at line 878 of file Environment.php.

    {
        $this->runtimeLoaders[] = $loader;
    }

References $loader.

◆ addTest()

Twig_Environment::addTest	(	$name,
		$test = `null`
	)

Registers a Test.

Parameters

string \| Twig_SimpleTest	$name	The test name or a Twig_SimpleTest instance
Twig_TestInterface \| Twig_SimpleTest	$test	A Twig_TestInterface instance or a Twig_SimpleTest instance

Definition at line 1188 of file Environment.php.

    {
        if (!$name instanceof Twig_SimpleTest && !($test instanceof Twig_SimpleTest || $test instanceof Twig_TestInterface)) {
            throw new LogicException('A test must be an instance of Twig_TestInterface or Twig_SimpleTest.');
        }
 
        if ($name instanceof Twig_SimpleTest) {
            $test = $name;
            $name = $test->getName();
        } else {
            @trigger_error(sprintf('Passing a name as a first argument to the %s method is deprecated since version 1.21. Pass an instance of "Twig_SimpleTest" instead when defining test "%s".', __METHOD__, $name), E_USER_DEPRECATED);
        }
 
        if ($this->extensionInitialized) {
            throw new LogicException(sprintf('Unable to add test "%s" as extensions have already been initialized.', $name));
        }
 
        $this->staging->addTest($name, $test);
    }

References $name, $test, and sprintf.

◆ addTokenParser()

Twig_Environment::addTokenParser ( Twig_TokenParserInterface $parser )

Definition at line 1016 of file Environment.php.

    {
        if ($this->extensionInitialized) {
            throw new LogicException('Unable to add a token parser as extensions have already been initialized.');
        }
 
        $this->staging->addTokenParser($parser);
    }

References $parser.

◆ clearCacheFiles()

Twig_Environment::clearCacheFiles ( )

Clears the template cache files on the filesystem.

Deprecated:: since 1.22 (to be removed in 2.0)

Definition at line 620 of file Environment.php.

    {
        @trigger_error(sprintf('The %s method is deprecated since version 1.22 and will be removed in Twig 2.0.', __METHOD__), E_USER_DEPRECATED);
 
        if (is_string($this->originalCache)) {
            foreach (new RecursiveIteratorIterator(new RecursiveDirectoryIterator($this->originalCache), RecursiveIteratorIterator::LEAVES_ONLY) as $file) {
                if ($file->isFile()) {
                    @unlink($file->getPathname());
                }
            }
        }
    }

References $file, and sprintf.

◆ clearTemplateCache()

Twig_Environment::clearTemplateCache ( )

Clears the internal template cache.

Deprecated:: since 1.18.3 (to be removed in 2.0)

Definition at line 608 of file Environment.php.

    {
        @trigger_error(sprintf('The %s method is deprecated since version 1.18.3 and will be removed in Twig 2.0.', __METHOD__), E_USER_DEPRECATED);
 
        $this->loadedTemplates = array();
    }

References sprintf.

◆ compile()

Twig_Environment::compile ( Twig_NodeInterface $node )

Compiles a node and returns the PHP code.

Returns: string The compiled PHP source code

Definition at line 747 of file Environment.php.

    {
        if (null === $this->compiler) {
            $this->compiler = new Twig_Compiler($this);
        }
 
        return $this->compiler->compile($node)->getSource();
    }

Referenced by compileSource().

Here is the caller graph for this function:

◆ compileSource()

Twig_Environment::compileSource	(	$source,
		$name = `null`
	)

Compiles a template source code.

Parameters

string \| Twig_Source	$source	The template source code
string	$name	The template name (deprecated)

Returns: string The compiled PHP source code

Exceptions

Twig_Error_Syntax When there was an error during tokenizing, parsing or compiling

Definition at line 766 of file Environment.php.

    {
        if (!$source instanceof Twig_Source) {
            @trigger_error(sprintf('Passing a string as the $source argument of %s() is deprecated since version 1.27. Pass a Twig_Source instance instead.', __METHOD__), E_USER_DEPRECATED);
            $source = new Twig_Source($source, $name);
        }
 
        try {
            return $this->compile($this->parse($this->tokenize($source)));
        } catch (Twig_Error $e) {
            $e->setSourceContext($source);
            throw $e;
        } catch (Exception $e) {
            throw new Twig_Error_Syntax(sprintf('An exception has been thrown during the compilation of a template ("%s").', $e->getMessage()), -1, $source, $e);
        }
    }

References $name, $source, compile(), parse(), Twig_Error\setSourceContext(), sprintf, and tokenize().

Referenced by loadTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ computeAlternatives()

Twig_Environment::computeAlternatives	(	$name,
		$items
	)

Deprecated:: since 1.23 (to be removed in 2.0)

Definition at line 1447 of file Environment.php.

    {
        @trigger_error(sprintf('The %s method is deprecated since version 1.23 and will be removed in Twig 2.0.', __METHOD__), E_USER_DEPRECATED);
 
        return Twig_Error_Syntax::computeAlternatives($name, $items);
    }

References $name, Twig_Error_Syntax\computeAlternatives(), and sprintf.

Here is the call graph for this function:

◆ createTemplate()

Twig_Environment::createTemplate ( $template )

Creates a template from source.

This method should not be used as a generic way to load templates.

Parameters

string $template The template name

Returns: Twig_Template A template instance representing the given template name

Exceptions

Twig_Error_Loader	When the template cannot be found
Twig_Error_Syntax	When an error occurred during compilation

Definition at line 510 of file Environment.php.

    {
        $name = sprintf('__string_template__%s', hash('sha256', $template, false));
 
        $loader = new Twig_Loader_Chain(array(
            new Twig_Loader_Array(array($name => $template)),
            $current = $this->getLoader(),
        ));
 
        $this->setLoader($loader);
        try {
            $template = $this->loadTemplate($name);
        } catch (Exception $e) {
            $this->setLoader($current);
 
            throw $e;
        } catch (Throwable $e) {
            $this->setLoader($current);
 
            throw $e;
        }
        $this->setLoader($current);
 
        return $template;
    }

References $current, $loader, $name, $template, getLoader(), GuzzleHttp\Psr7\hash(), loadTemplate(), setLoader(), and sprintf.

Here is the call graph for this function:

◆ disableAutoReload()

Twig_Environment::disableAutoReload ( )

Disables the auto_reload option.

Definition at line 210 of file Environment.php.

    {
        $this->autoReload = false;
    }

◆ disableDebug()

Twig_Environment::disableDebug ( )

Disables debugging mode.

Definition at line 183 of file Environment.php.

    {
        $this->debug = false;
        $this->updateOptionsHash();
    }

References updateOptionsHash().

Here is the call graph for this function:

◆ disableStrictVariables()

Twig_Environment::disableStrictVariables ( )

Disables the strict_variables option.

Definition at line 237 of file Environment.php.

    {
        $this->strictVariables = false;
        $this->updateOptionsHash();
    }

References updateOptionsHash().

Here is the call graph for this function:

◆ display()

Twig_Environment::display	(		$name,
		array	$context = `array()`
	)

Displays a template.

Parameters

string	$name	The template name
array	$context	An array of parameters to pass to the template

Exceptions

Twig_Error_Loader	When the template cannot be found
Twig_Error_Syntax	When an error occurred during compilation
Twig_Error_Runtime	When an error occurred during rendering

Definition at line 376 of file Environment.php.

    {
        $this->loadTemplate($name)->display($context);
    }

References $name, and loadTemplate().

Here is the call graph for this function:

◆ enableAutoReload()

Twig_Environment::enableAutoReload ( )

Enables the auto_reload option.

Definition at line 202 of file Environment.php.

    {
        $this->autoReload = true;
    }

◆ enableDebug()

Twig_Environment::enableDebug ( )

Enables debugging mode.

Definition at line 174 of file Environment.php.

    {
        $this->debug = true;
        $this->updateOptionsHash();
    }

References updateOptionsHash().

Here is the call graph for this function:

◆ enableStrictVariables()

Twig_Environment::enableStrictVariables ( )

Enables the strict_variables option.

Definition at line 228 of file Environment.php.

    {
        $this->strictVariables = true;
        $this->updateOptionsHash();
    }

References updateOptionsHash().

Here is the call graph for this function:

◆ getBaseTemplateClass()

Twig_Environment::getBaseTemplateClass ( )

Gets the base template class for compiled templates.

Returns: string The base template class name

Definition at line 155 of file Environment.php.

    {
        return $this->baseTemplateClass;
    }

References $baseTemplateClass.

◆ getBinaryOperators()

Twig_Environment::getBinaryOperators ( )

Gets the registered binary Operators.

Returns: array An array of binary operators

Definition at line 1435 of file Environment.php.

    {
        if (!$this->extensionInitialized) {
            $this->initExtensions();
        }
 
        return $this->binaryOperators;
    }

References $binaryOperators, and initExtensions().

Here is the call graph for this function:

◆ getCache()

Twig_Environment::getCache ( $original = true )

Gets the current cache implementation.

Parameters

bool $original Whether to return the original cache option or the real cache instance

Returns: Twig_CacheInterface|string|false A Twig_CacheInterface implementation, an absolute path to the compiled templates, or false to disable cache

Definition at line 262 of file Environment.php.

    {
        return $original ? $this->originalCache : $this->cache;
    }

References $cache.

◆ getCacheFilename()

Twig_Environment::getCacheFilename ( $name )

Gets the cache filename for a given template.

Parameters

string $name The template name

Returns: string|false The cache file name or false when caching is disabled

Deprecated:: since 1.22 (to be removed in 2.0)

Definition at line 302 of file Environment.php.

    {
        @trigger_error(sprintf('The %s method is deprecated since version 1.22 and will be removed in Twig 2.0.', __METHOD__), E_USER_DEPRECATED);
 
        $key = $this->cache->generateKey($name, $this->getTemplateClass($name));
 
        return !$key ? false : $key;
    }

References $key, $name, getTemplateClass(), and sprintf.

Referenced by loadTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCharset()

Twig_Environment::getCharset ( )

Gets the default template charset.

Returns: string The default charset

Definition at line 821 of file Environment.php.

    {
        return $this->charset;
    }

References $charset.

◆ getCompiler()

Twig_Environment::getCompiler ( )

Gets the Compiler instance.

Returns: Twig_CompilerInterface

Deprecated:: since 1.25 (to be removed in 2.0)

Definition at line 726 of file Environment.php.

    {
        @trigger_error(sprintf('The %s() method is deprecated since version 1.25 and will be removed in 2.0.', __FUNCTION__), E_USER_DEPRECATED);
 
        if (null === $this->compiler) {
            $this->compiler = new Twig_Compiler($this);
        }
 
        return $this->compiler;
    }

References $compiler, and sprintf.

◆ getExtension()

Twig_Environment::getExtension ( $class )

Gets an extension by class name.

Parameters

string $class The extension class name

Returns: Twig_ExtensionInterface

Definition at line 890 of file Environment.php.

    {
        $class = ltrim($class, '\\');
        if (!isset($this->extensionsByClass[$class]) && class_exists($class, false)) {
            // For BC/FC with namespaced aliases
            $class = new ReflectionClass($class);
            $class = $class->name;
        }
 
        if (isset($this->extensions[$class])) {
            if ($class !== get_class($this->extensions[$class])) {
                @trigger_error(sprintf('Referencing the "%s" extension by its name (defined by getName()) is deprecated since 1.26 and will be removed in Twig 2.0. Use the Fully Qualified Extension Class Name instead.', $class), E_USER_DEPRECATED);
            }
 
            return $this->extensions[$class];
        }
 
        if (!isset($this->extensionsByClass[$class])) {
            throw new Twig_Error_Runtime(sprintf('The "%s" extension is not enabled.', $class));
        }
 
        return $this->extensionsByClass[$class];
    }

References sprintf.

◆ getExtensions()

Twig_Environment::getExtensions ( )

Returns all registered extensions.

Returns: Twig_ExtensionInterface[] An array of extensions (keys are for internal usage only and should not be relied on)

Definition at line 1011 of file Environment.php.

    {
        return $this->extensions;
    }

References $extensions.

Referenced by initRuntime().

Here is the caller graph for this function:

◆ getFilter()

Twig_Environment::getFilter ( $name )

Get a filter by name.

Subclasses may override this method and load filters differently; so no list of filters is available.

Parameters

string $name The filter name

Returns: Twig_Filter|false A Twig_Filter instance or false if the filter does not exist

Definition at line 1125 of file Environment.php.

    {
        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 = call_user_func($callback, $name)) {
                return $filter;
            }
        }
 
        return false;
    }

References $name, and initExtensions().

Here is the call graph for this function:

◆ getFilters()

Twig_Environment::getFilters ( )

Gets the registered Filters.

Be warned that this method cannot return filters defined with registerUndefinedFilterCallback.

Returns: Twig_FilterInterface[]

See also: registerUndefinedFilterCallback

Definition at line 1173 of file Environment.php.

    {
        if (!$this->extensionInitialized) {
            $this->initExtensions();
        }
 
        return $this->filters;
    }

References $filters, and initExtensions().

Here is the call graph for this function:

◆ getFunction()

Twig_Environment::getFunction ( $name )

Get a function by name.

Subclasses may override this method and load functions differently; so no list of functions is available.

Parameters

string $name function name

Returns: Twig_Function|false A Twig_Function instance or false if the function does not exist

Definition at line 1284 of file Environment.php.

    {
        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 = call_user_func($callback, $name)) {
                return $function;
            }
        }
 
        return false;
    }

References $function, $name, and initExtensions().

Here is the call graph for this function:

◆ getFunctions()

Twig_Environment::getFunctions ( )

Gets registered functions.

Be warned that this method cannot return functions defined with registerUndefinedFunctionCallback.

Returns: Twig_FunctionInterface[]

See also: registerUndefinedFunctionCallback

Definition at line 1332 of file Environment.php.

    {
        if (!$this->extensionInitialized) {
            $this->initExtensions();
        }
 
        return $this->functions;
    }

References $functions, and initExtensions().

Here is the call graph for this function:

◆ getGlobals()

Twig_Environment::getGlobals ( )

Gets the registered Globals.

Returns: array An array of globals

Definition at line 1379 of file Environment.php.

    {
        if (!$this->runtimeInitialized && !$this->extensionInitialized) {
            return $this->initGlobals();
        }
 
        if (null === $this->globals) {
            $this->globals = $this->initGlobals();
        }
 
        return $this->globals;
    }

References $globals, and initGlobals().

Referenced by mergeGlobals().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLexer()

Twig_Environment::getLexer ( )

Gets the Lexer instance.

Returns: Twig_LexerInterface

Deprecated:: since 1.25 (to be removed in 2.0)

Definition at line 640 of file Environment.php.

    {
        @trigger_error(sprintf('The %s() method is deprecated since version 1.25 and will be removed in 2.0.', __FUNCTION__), E_USER_DEPRECATED);
 
        if (null === $this->lexer) {
            $this->lexer = new Twig_Lexer($this);
        }
 
        return $this->lexer;
    }

References $lexer, and sprintf.

◆ getLoader()

Twig_Environment::getLoader ( )

Gets the Loader instance.

Returns: Twig_LoaderInterface

Definition at line 797 of file Environment.php.

    {
        if (null === $this->loader) {
            throw new LogicException('You must set a loader first.');
        }
 
        return $this->loader;
    }

References $loader.

Referenced by createTemplate(), getTemplateClass(), isTemplateFresh(), and loadTemplate().

Here is the caller graph for this function:

◆ getNodeVisitors()

Twig_Environment::getNodeVisitors ( )

Gets the registered Node Visitors.

Returns: Twig_NodeVisitorInterface[]

Definition at line 1078 of file Environment.php.

    {
        if (!$this->extensionInitialized) {
            $this->initExtensions();
        }
 
        return $this->visitors;
    }

References $visitors, and initExtensions().

Here is the call graph for this function:

◆ getParser()

Twig_Environment::getParser ( )

Gets the Parser instance.

Returns: Twig_ParserInterface

Deprecated:: since 1.25 (to be removed in 2.0)

Definition at line 687 of file Environment.php.

    {
        @trigger_error(sprintf('The %s() method is deprecated since version 1.25 and will be removed in 2.0.', __FUNCTION__), E_USER_DEPRECATED);
 
        if (null === $this->parser) {
            $this->parser = new Twig_Parser($this);
        }
 
        return $this->parser;
    }

References $parser, and sprintf.

◆ getRuntime()

Twig_Environment::getRuntime ( $class )

Returns the runtime implementation of a Twig element (filter/function/test).

Parameters

string $class A runtime class name

Returns: object The runtime implementation

Exceptions

Twig_Error_Runtime When the template cannot be found

Definition at line 923 of file Environment.php.

    {
        if (isset($this->runtimes[$class])) {
            return $this->runtimes[$class];
        }
 
        foreach ($this->runtimeLoaders as $loader) {
            if (null !== $runtime = $loader->load($class)) {
                return $this->runtimes[$class] = $runtime;
            }
        }
 
        throw new Twig_Error_Runtime(sprintf('Unable to load the "%s" runtime.', $class));
    }

References $loader, and sprintf.

◆ getTags()

Twig_Environment::getTags ( )

Gets registered tags.

Be warned that this method cannot return tags defined by Twig_TokenParserBrokerInterface classes.

Returns: Twig_TokenParserInterface[]

Definition at line 1050 of file Environment.php.

    {
        $tags = array();
        foreach ($this->getTokenParsers()->getParsers() as $parser) {
            if ($parser instanceof Twig_TokenParserInterface) {
                $tags[$parser->getTag()] = $parser;
            }
        }
 
        return $tags;
    }

References $parser, $tags, and getTokenParsers().

Here is the call graph for this function:

◆ getTemplateClass()

Twig_Environment::getTemplateClass	(	$name,
		$index = `null`
	)

Gets the template class associated with the given string.

The generated template class is based on the following parameters:

The cache key for the given template;
The currently enabled extensions;
Whether the Twig C extension is available or not;
PHP version;
Twig version;
Options with what environment was created.

Parameters

string	$name	The name for which to calculate the template class name
int \| null	$index	The index if it is an embedded template

Returns: string The template class name

Definition at line 328 of file Environment.php.

    {
        $key = $this->getLoader()->getCacheKey($name).$this->optionsHash;
 
        return $this->templateClassPrefix.hash('sha256', $key).(null === $index ? '' : '_'.$index);
    }

References $index, $key, $name, and getLoader().

Referenced by getCacheFilename(), and loadTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTemplateClassPrefix()

Twig_Environment::getTemplateClassPrefix ( )

Gets the template class prefix.

Returns: string The template class prefix

Deprecated:: since 1.22 (to be removed in 2.0)

Definition at line 342 of file Environment.php.

    {
        @trigger_error(sprintf('The %s method is deprecated since version 1.22 and will be removed in Twig 2.0.', __METHOD__), E_USER_DEPRECATED);
 
        return $this->templateClassPrefix;
    }

References $templateClassPrefix, and sprintf.

◆ getTest()

Twig_Environment::getTest ( $name )

Gets a test by name.

Parameters

string $name The test name

Returns: Twig_Test|false A Twig_Test instance or false if the test does not exist

Definition at line 1233 of file Environment.php.

    {
        if (!$this->extensionInitialized) {
            $this->initExtensions();
        }
 
        if (isset($this->tests[$name])) {
            return $this->tests[$name];
        }
 
        return false;
    }

References $name, and initExtensions().

Here is the call graph for this function:

◆ getTests()

Twig_Environment::getTests ( )

Gets the registered Tests.

Returns: Twig_TestInterface[]

Definition at line 1215 of file Environment.php.

    {
        if (!$this->extensionInitialized) {
            $this->initExtensions();
        }
 
        return $this->tests;
    }

References $tests, and initExtensions().

Here is the call graph for this function:

◆ getTokenParsers()

Twig_Environment::getTokenParsers ( )

Gets the registered Token Parsers.

Returns: Twig_TokenParserBrokerInterface

Definition at line 1032 of file Environment.php.

    {
        if (!$this->extensionInitialized) {
            $this->initExtensions();
        }
 
        return $this->parsers;
    }

References $parsers, and initExtensions().

Referenced by getTags().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUnaryOperators()

Twig_Environment::getUnaryOperators ( )

Gets the registered unary Operators.

Returns: array An array of unary operators

Definition at line 1419 of file Environment.php.

    {
        if (!$this->extensionInitialized) {
            $this->initExtensions();
        }
 
        return $this->unaryOperators;
    }

References $unaryOperators, and initExtensions().

Here is the call graph for this function:

◆ hasExtension()

Twig_Environment::hasExtension ( $class )

Returns true if the given extension is registered.

Parameters

string $class The extension class name

Returns: bool Whether the extension is registered or not

Definition at line 855 of file Environment.php.

    {
        $class = ltrim($class, '\\');
        if (!isset($this->extensionsByClass[$class]) && class_exists($class, false)) {
            // For BC/FC with namespaced aliases
            $class = new ReflectionClass($class);
            $class = $class->name;
        }
 
        if (isset($this->extensions[$class])) {
            if ($class !== get_class($this->extensions[$class])) {
                @trigger_error(sprintf('Referencing the "%s" extension by its name (defined by getName()) is deprecated since 1.26 and will be removed in Twig 2.0. Use the Fully Qualified Extension Class Name instead.', $class), E_USER_DEPRECATED);
            }
 
            return true;
        }
 
        return isset($this->extensionsByClass[$class]);
    }

References sprintf.

◆ initExtension()

Twig_Environment::initExtension ( Twig_ExtensionInterface $extension )

protected

Definition at line 1510 of file Environment.php.

    {
        // filters
        foreach ($extension->getFilters() as $name => $filter) {
            if ($filter instanceof Twig_SimpleFilter) {
                $name = $filter->getName();
            } else {
                @trigger_error(sprintf('Using an instance of "%s" for filter "%s" is deprecated since version 1.21. Use Twig_SimpleFilter instead.', get_class($filter), $name), E_USER_DEPRECATED);
            }
 
            $this->filters[$name] = $filter;
        }
 
        // functions
        foreach ($extension->getFunctions() as $name => $function) {
            if ($function instanceof Twig_SimpleFunction) {
                $name = $function->getName();
            } else {
                @trigger_error(sprintf('Using an instance of "%s" for function "%s" is deprecated since version 1.21. Use Twig_SimpleFunction instead.', get_class($function), $name), E_USER_DEPRECATED);
            }
 
            $this->functions[$name] = $function;
        }
 
        // tests
        foreach ($extension->getTests() as $name => $test) {
            if ($test instanceof Twig_SimpleTest) {
                $name = $test->getName();
            } else {
                @trigger_error(sprintf('Using an instance of "%s" for test "%s" is deprecated since version 1.21. Use Twig_SimpleTest instead.', get_class($test), $name), E_USER_DEPRECATED);
            }
 
            $this->tests[$name] = $test;
        }
 
        // token parsers
        foreach ($extension->getTokenParsers() as $parser) {
            if ($parser instanceof Twig_TokenParserInterface) {
                $this->parsers->addTokenParser($parser);
            } elseif ($parser instanceof Twig_TokenParserBrokerInterface) {
                @trigger_error('Registering a Twig_TokenParserBrokerInterface instance is deprecated since version 1.21.', E_USER_DEPRECATED);
 
                $this->parsers->addTokenParserBroker($parser);
            } else {
                throw new LogicException('getTokenParsers() must return an array of Twig_TokenParserInterface or Twig_TokenParserBrokerInterface instances.');
            }
        }
 
        // node visitors
        foreach ($extension->getNodeVisitors() as $visitor) {
            $this->visitors[] = $visitor;
        }
 
        // operators
        if ($operators = $extension->getOperators()) {
            if (!is_array($operators)) {
                throw new InvalidArgumentException(sprintf('"%s::getOperators()" must return an array with operators, got "%s".', get_class($extension), is_object($operators) ? get_class($operators) : gettype($operators).(is_resource($operators) ? '' : '#'.$operators)));
            }
 
            if (2 !== count($operators)) {
                throw new InvalidArgumentException(sprintf('"%s::getOperators()" must return an array of 2 elements, got %d.', get_class($extension), count($operators)));
            }
 
            $this->unaryOperators = array_merge($this->unaryOperators, $operators[0]);
            $this->binaryOperators = array_merge($this->binaryOperators, $operators[1]);
        }
    }

References $function, $name, $parser, $test, Twig_ExtensionInterface\getFilters(), Twig_ExtensionInterface\getFunctions(), Twig_ExtensionInterface\getNodeVisitors(), Twig_ExtensionInterface\getOperators(), Twig_ExtensionInterface\getTests(), Twig_ExtensionInterface\getTokenParsers(), and sprintf.

Referenced by initExtensions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initExtensions()

Twig_Environment::initExtensions ( )

protected

Definition at line 1485 of file Environment.php.

    {
        if ($this->extensionInitialized) {
            return;
        }
 
        $this->parsers = new Twig_TokenParserBroker(array(), array(), false);
        $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);
        // Done at the end only, so that an exception during initialization does not mark the environment as initialized when catching the exception
        $this->extensionInitialized = true;
    }

References initExtension().

Referenced by getBinaryOperators(), getFilter(), getFilters(), getFunction(), getFunctions(), getNodeVisitors(), getTest(), getTests(), getTokenParsers(), and getUnaryOperators().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initGlobals()

Twig_Environment::initGlobals ( )

protected

Definition at line 1457 of file Environment.php.

    {
        $globals = array();
        foreach ($this->extensions as $name => $extension) {
            if (!$extension instanceof Twig_Extension_GlobalsInterface) {
                $m = new ReflectionMethod($extension, 'getGlobals');
 
                if ('Twig_Extension' !== $m->getDeclaringClass()->getName()) {
                    @trigger_error(sprintf('Defining the getGlobals() method in the "%s" extension without explicitly implementing Twig_Extension_GlobalsInterface is deprecated since version 1.23.', $name), E_USER_DEPRECATED);
                }
            }
 
            $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);
    }

References $globals, $m, $name, and sprintf.

Referenced by addGlobal(), and getGlobals().

Here is the caller graph for this function:

◆ initRuntime()

Twig_Environment::initRuntime ( )

Initializes the runtime environment.

Deprecated:: since 1.23 (to be removed in 2.0)

Definition at line 831 of file Environment.php.

    {
        $this->runtimeInitialized = true;
 
        foreach ($this->getExtensions() as $name => $extension) {
            if (!$extension instanceof Twig_Extension_InitRuntimeInterface) {
                $m = new ReflectionMethod($extension, 'initRuntime');
 
                if ('Twig_Extension' !== $m->getDeclaringClass()->getName()) {
                    @trigger_error(sprintf('Defining the initRuntime() method in the "%s" extension is deprecated since version 1.23. Use the `needs_environment` option to get the Twig_Environment instance in filters, functions, or tests; or explicitly implement Twig_Extension_InitRuntimeInterface if needed (not recommended).', $name), E_USER_DEPRECATED);
                }
            }
 
            $extension->initRuntime($this);
        }
    }

References $m, $name, getExtensions(), and sprintf.

Referenced by loadTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isAutoReload()

Twig_Environment::isAutoReload ( )

Checks if the auto_reload option is enabled.

Returns: bool true if auto_reload is enabled, false otherwise

Definition at line 220 of file Environment.php.

    {
        return $this->autoReload;
    }

References $autoReload.

Referenced by loadTemplate().

Here is the caller graph for this function:

◆ isDebug()

Twig_Environment::isDebug ( )

Checks if debug mode is enabled.

Returns: bool true if debug mode is enabled, false otherwise

Definition at line 194 of file Environment.php.

    {
        return $this->debug;
    }

References $debug.

◆ isStrictVariables()

Twig_Environment::isStrictVariables ( )

Checks if the strict_variables option is enabled.

Returns: bool true if strict_variables is enabled, false otherwise

Definition at line 248 of file Environment.php.

    {
        return $this->strictVariables;
    }

References $strictVariables.

◆ isTemplateFresh()

Twig_Environment::isTemplateFresh	(	$name,
		$time
	)

Returns true if the template is still fresh.

Besides checking the loader for freshness information, this method also checks if the enabled extensions have not changed.

Parameters

string	$name	The template name
int	$time	The last modification time of the cached template

Returns: bool true if the template is fresh, false otherwise

Definition at line 548 of file Environment.php.

    {
        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);
    }

References $name, $r, $time, and getLoader().

Referenced by loadTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ load()

Twig_Environment::load ( $name )

Loads a template.

Parameters

string | Twig_TemplateWrapper | Twig_Template $name The template name

Exceptions

Twig_Error_Loader	When the template cannot be found
Twig_Error_Runtime	When a previously generated cache is corrupted
Twig_Error_Syntax	When an error occurred during compilation

Returns: Twig_TemplateWrapper

Definition at line 392 of file Environment.php.

    {
        if ($name instanceof Twig_TemplateWrapper) {
            return $name;
        }
 
        if ($name instanceof Twig_Template) {
            return new Twig_TemplateWrapper($this, $name);
        }
 
        return new Twig_TemplateWrapper($this, $this->loadTemplate($name));
    }

References $name, and loadTemplate().

Here is the call graph for this function:

◆ loadTemplate()

Twig_Environment::loadTemplate	(	$name,
		$index = `null`
	)

Loads a template internal representation.

This method is for internal use only and should never be called directly.

Parameters

string	$name	The template name
int	$index	The index if it is an embedded template

Returns: Twig_TemplateInterface A template instance representing the given template name

Exceptions

Twig_Error_Loader	When the template cannot be found
Twig_Error_Runtime	When a previously generated cache is corrupted
Twig_Error_Syntax	When an error occurred during compilation

Definition at line 422 of file Environment.php.

    {
        $cls = $mainCls = $this->getTemplateClass($name);
        if (null !== $index) {
            $cls .= '_'.$index;
        }
 
        if (isset($this->loadedTemplates[$cls])) {
            return $this->loadedTemplates[$cls];
        }
 
        if (!class_exists($cls, false)) {
            if ($this->bcGetCacheFilename) {
                $key = $this->getCacheFilename($name);
            } else {
                $key = $this->cache->generateKey($name, $mainCls);
            }
 
            if (!$this->isAutoReload() || $this->isTemplateFresh($name, $this->cache->getTimestamp($key))) {
                $this->cache->load($key);
            }
 
            if (!class_exists($cls, false)) {
                $loader = $this->getLoader();
                if (!$loader instanceof Twig_SourceContextLoaderInterface) {
                    $source = new Twig_Source($loader->getSource($name), $name);
                } else {
                    $source = $loader->getSourceContext($name);
                }
 
                $content = $this->compileSource($source);
 
                if ($this->bcWriteCacheFile) {
                    $this->writeCacheFile($key, $content);
                } else {
                    $this->cache->write($key, $content);
                    $this->cache->load($key);
                }
 
                if (!class_exists($mainCls, false)) {
                    /* Last line of defense if either $this->bcWriteCacheFile was used,
                     * $this->cache is implemented as a no-op or we have a race condition
                     * where the cache was cleared between the above calls to write to and load from
                     * the cache.
                     */
                    eval('?>'.$content);
                }
            }
 
            if (!class_exists($cls, false)) {
                throw new Twig_Error_Runtime(sprintf('Failed to load Twig template "%s", index "%s": cache is corrupted.', $name, $index), -1, $source);
            }
        }
 
        if (!$this->runtimeInitialized) {
            $this->initRuntime();
        }
 
        if (isset($this->loading[$cls])) {
            throw new Twig_Error_Runtime(sprintf('Circular reference detected for Twig template "%s", path: %s.', $name, implode(' -> ', array_merge($this->loading, array($name)))));
        }
 
        $this->loading[$cls] = $name;
 
        try {
            $this->loadedTemplates[$cls] = new $cls($this);
            unset($this->loading[$cls]);
        } catch (\Exception $e) {
            unset($this->loading[$cls]);
 
            throw $e;
        }
 
        return $this->loadedTemplates[$cls];
    }

References $index, $key, $loader, $name, $source, compileSource(), getCacheFilename(), getLoader(), getTemplateClass(), initRuntime(), isAutoReload(), isTemplateFresh(), sprintf, and writeCacheFile().

Referenced by createTemplate(), display(), load(), render(), and resolveTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mergeGlobals()

Twig_Environment::mergeGlobals ( array $context )

Merges a context with the defined globals.

Parameters

array $context An array representing the context

Returns: array The context merged with the globals

Definition at line 1399 of file Environment.php.

    {
        // we don't use array_merge as the context being generally
        // bigger than globals, this code is faster.
        foreach ($this->getGlobals() as $key => $value) {
            if (!array_key_exists($key, $context)) {
                $context[$key] = $value;
            }
        }
 
        return $context;
    }

References $key, and getGlobals().

Here is the call graph for this function:

◆ parse()

Twig_Environment::parse ( Twig_TokenStream $stream )

Converts a token stream to a node tree.

Returns: Twig_Node_Module

Exceptions

Twig_Error_Syntax When the token stream is syntactically or semantically wrong

Definition at line 710 of file Environment.php.

    {
        if (null === $this->parser) {
            $this->parser = new Twig_Parser($this);
        }
 
        return $this->parser->parse($stream);
    }

References GuzzleHttp\Psr7\$stream.

Referenced by compileSource().

Here is the caller graph for this function:

◆ registerUndefinedFilterCallback()

Twig_Environment::registerUndefinedFilterCallback ( $callable )

Definition at line 1157 of file Environment.php.

    {
        $this->filterCallbacks[] = $callable;
    }

◆ registerUndefinedFunctionCallback()

Twig_Environment::registerUndefinedFunctionCallback ( $callable )

Definition at line 1316 of file Environment.php.

    {
        $this->functionCallbacks[] = $callable;
    }

◆ removeExtension()

Twig_Environment::removeExtension ( $name )

Removes an extension by name.

This method is deprecated and you should not use it.

Parameters

string $name The extension name

Deprecated:: since 1.12 (to be removed in 2.0)

Definition at line 967 of file Environment.php.

    {
        @trigger_error(sprintf('The %s method is deprecated since version 1.12 and will be removed in Twig 2.0.', __METHOD__), E_USER_DEPRECATED);
 
        if ($this->extensionInitialized) {
            throw new LogicException(sprintf('Unable to remove extension "%s" as extensions have already been initialized.', $name));
        }
 
        $class = ltrim($name, '\\');
        if (!isset($this->extensionsByClass[$class]) && class_exists($class, false)) {
            // For BC/FC with namespaced aliases
            $class = new ReflectionClass($class);
            $class = $class->name;
        }
 
        if (isset($this->extensions[$class])) {
            if ($class !== get_class($this->extensions[$class])) {
                @trigger_error(sprintf('Referencing the "%s" extension by its name (defined by getName()) is deprecated since 1.26 and will be removed in Twig 2.0. Use the Fully Qualified Extension Class Name instead.', $class), E_USER_DEPRECATED);
            }
 
            unset($this->extensions[$class]);
        }
 
        unset($this->extensions[$class]);
        $this->updateOptionsHash();
    }

References $name, sprintf, and updateOptionsHash().

Here is the call graph for this function:

◆ render()

Twig_Environment::render	(		$name,
		array	$context = `array()`
	)

Renders a template.

Parameters

string	$name	The template name
array	$context	An array of parameters to pass to the template

Returns: string The rendered template

Exceptions

Twig_Error_Loader	When the template cannot be found
Twig_Error_Syntax	When an error occurred during compilation
Twig_Error_Runtime	When an error occurred during rendering

Definition at line 361 of file Environment.php.

    {
        return $this->loadTemplate($name)->render($context);
    }

References $name, and loadTemplate().

Here is the call graph for this function:

◆ resolveTemplate()

Twig_Environment::resolveTemplate ( $names )

Tries to load a template consecutively from an array.

Similar to loadTemplate() but it also accepts instances of Twig_Template and Twig_TemplateWrapper, and an array of templates where each is tried to be loaded.

Parameters

string | Twig_Template | Twig_TemplateWrapper | array $names A template or an array of templates to try consecutively

Returns: Twig_Template|Twig_TemplateWrapper

Exceptions

Twig_Error_Loader	When none of the templates can be found
Twig_Error_Syntax	When an error occurred during compilation

Definition at line 575 of file Environment.php.

    {
        if (!is_array($names)) {
            $names = array($names);
        }
 
        foreach ($names as $name) {
            if ($name instanceof Twig_Template) {
                return $name;
            }
 
            if ($name instanceof Twig_TemplateWrapper) {
                return $name;
            }
 
            try {
                return $this->loadTemplate($name);
            } catch (Twig_Error_Loader $e) {
            }
        }
 
        if (1 === count($names)) {
            throw $e;
        }
 
        throw new Twig_Error_Loader(sprintf('Unable to find one of the following templates: "%s".', implode('", "', $names)));
    }

References $name, $names, loadTemplate(), and sprintf.

Here is the call graph for this function:

◆ setBaseTemplateClass()

Twig_Environment::setBaseTemplateClass ( $class )

Sets the base template class for compiled templates.

Parameters

string $class The base template class name

Definition at line 165 of file Environment.php.

    {
        $this->baseTemplateClass = $class;
        $this->updateOptionsHash();
    }

References updateOptionsHash().

Here is the call graph for this function:

◆ setCache()

Twig_Environment::setCache ( $cache )

Sets the current cache implementation.

Parameters

Twig_CacheInterface | string | false $cache A Twig_CacheInterface implementation, an absolute path to the compiled templates, or false to disable cache

Definition at line 274 of file Environment.php.

    {
        if (is_string($cache)) {
            $this->originalCache = $cache;
            $this->cache = new Twig_Cache_Filesystem($cache);
        } elseif (false === $cache) {
            $this->originalCache = $cache;
            $this->cache = new Twig_Cache_Null();
        } elseif (null === $cache) {
            @trigger_error('Using "null" as the cache strategy is deprecated since version 1.23 and will be removed in Twig 2.0.', E_USER_DEPRECATED);
            $this->originalCache = false;
            $this->cache = new Twig_Cache_Null();
        } elseif ($cache instanceof Twig_CacheInterface) {
            $this->originalCache = $this->cache = $cache;
        } else {
            throw new LogicException(sprintf('Cache can only be a string, false, or a Twig_CacheInterface implementation.'));
        }
    }

References $cache, and sprintf.

Referenced by __construct().

Here is the caller graph for this function:

◆ setCharset()

Twig_Environment::setCharset ( $charset )

Sets the default template charset.

Parameters

string $charset The default charset

Definition at line 811 of file Environment.php.

    {
        $this->charset = strtoupper($charset);
    }

References $charset.

◆ setCompiler()

Twig_Environment::setCompiler ( Twig_CompilerInterface $compiler )

Definition at line 737 of file Environment.php.

    {
        $this->compiler = $compiler;
    }

References $compiler.

◆ setExtensions()

Twig_Environment::setExtensions ( array $extensions )

Registers an array of extensions.

Parameters

array $extensions An array of extensions

Definition at line 999 of file Environment.php.

    {
        foreach ($extensions as $extension) {
            $this->addExtension($extension);
        }
    }

References $extensions, and addExtension().

Here is the call graph for this function:

◆ setLexer()

Twig_Environment::setLexer ( Twig_LexerInterface $lexer )

Definition at line 651 of file Environment.php.

    {
        $this->lexer = $lexer;
    }

References $lexer.

◆ setLoader()

Twig_Environment::setLoader ( Twig_LoaderInterface $loader )

Definition at line 783 of file Environment.php.

    {
        if (!$loader instanceof Twig_SourceContextLoaderInterface && 0 !== strpos(get_class($loader), 'Mock_')) {
            @trigger_error(sprintf('Twig loader "%s" should implement Twig_SourceContextLoaderInterface since version 1.27.', get_class($loader)), E_USER_DEPRECATED);
        }
 
        $this->loader = $loader;
    }

References $loader, and sprintf.

Referenced by __construct(), and createTemplate().

Here is the caller graph for this function:

◆ setParser()

Twig_Environment::setParser ( Twig_ParserInterface $parser )

Definition at line 698 of file Environment.php.

    {
        $this->parser = $parser;
    }

References $parser.

◆ tokenize()

Twig_Environment::tokenize	(	$source,
		$name = `null`
	)

Tokenizes a source code.

Parameters

string \| Twig_Source	$source	The template source code
string	$name	The template name (deprecated)

Returns: Twig_TokenStream

Exceptions

Twig_Error_Syntax When the code is syntactically wrong

Definition at line 666 of file Environment.php.

    {
        if (!$source instanceof Twig_Source) {
            @trigger_error(sprintf('Passing a string as the $source argument of %s() is deprecated since version 1.27. Pass a Twig_Source instance instead.', __METHOD__), E_USER_DEPRECATED);
            $source = new Twig_Source($source, $name);
        }
 
        if (null === $this->lexer) {
            $this->lexer = new Twig_Lexer($this);
        }
 
        return $this->lexer->tokenize($source);
    }

References $name, $source, and sprintf.

Referenced by compileSource().

Here is the caller graph for this function:

◆ updateOptionsHash()

Twig_Environment::updateOptionsHash ( )

private

Definition at line 1586 of file Environment.php.

    {
        $hashParts = array_merge(
            array_keys($this->extensions),
            array(
                (int) function_exists('twig_template_get_attributes'),
                PHP_MAJOR_VERSION,
                PHP_MINOR_VERSION,
                self::VERSION,
                (int) $this->debug,
                $this->baseTemplateClass,
                (int) $this->strictVariables,
            )
        );
        $this->optionsHash = implode(':', $hashParts);
    }

Referenced by addExtension(), disableDebug(), disableStrictVariables(), enableDebug(), enableStrictVariables(), removeExtension(), and setBaseTemplateClass().

Here is the caller graph for this function:

◆ writeCacheFile()

Twig_Environment::writeCacheFile	(	$file,
		$content
	)

protected

Deprecated:: since 1.22 (to be removed in 2.0)

Definition at line 1581 of file Environment.php.

    {
        $this->cache->write($file, $content);
    }

References $file.

Referenced by loadTemplate().

Here is the caller graph for this function:

Field Documentation

◆ $autoReload

Twig_Environment::$autoReload

protected

Definition at line 29 of file Environment.php.

Referenced by isAutoReload().

◆ $baseTemplateClass

Twig_Environment::$baseTemplateClass

protected

Definition at line 34 of file Environment.php.

Referenced by getBaseTemplateClass().

◆ $bcGetCacheFilename

Twig_Environment::$bcGetCacheFilename = false

private

Definition at line 55 of file Environment.php.

◆ $bcWriteCacheFile

Twig_Environment::$bcWriteCacheFile = false

private

Definition at line 54 of file Environment.php.

◆ $binaryOperators

Twig_Environment::$binaryOperators

protected

Definition at line 47 of file Environment.php.

Referenced by getBinaryOperators().

◆ $cache

Twig_Environment::$cache

protected

Definition at line 30 of file Environment.php.

Referenced by getCache(), and setCache().

◆ $charset

Twig_Environment::$charset

protected

Definition at line 26 of file Environment.php.

Referenced by getCharset(), and setCharset().

◆ $compiler

Twig_Environment::$compiler

protected

Definition at line 33 of file Environment.php.

Referenced by getCompiler(), and setCompiler().

◆ $debug

Twig_Environment::$debug

protected

Definition at line 28 of file Environment.php.

Referenced by isDebug().

◆ $extensionInitialized

Twig_Environment::$extensionInitialized = false

protected

Definition at line 43 of file Environment.php.

◆ $extensions

Twig_Environment::$extensions

protected

Definition at line 35 of file Environment.php.

Referenced by getExtensions(), and setExtensions().

◆ $extensionsByClass

Twig_Environment::$extensionsByClass = array()

private

Definition at line 57 of file Environment.php.

◆ $filterCallbacks

Twig_Environment::$filterCallbacks = array()

protected

Definition at line 50 of file Environment.php.

◆ $filters

Twig_Environment::$filters

protected

Definition at line 38 of file Environment.php.

Referenced by getFilters().

◆ $functionCallbacks

Twig_Environment::$functionCallbacks = array()

protected

Definition at line 49 of file Environment.php.

◆ $functions

Twig_Environment::$functions

protected

Definition at line 40 of file Environment.php.

Referenced by getFunctions().

◆ $globals

Twig_Environment::$globals

protected

Definition at line 41 of file Environment.php.

Referenced by getGlobals(), and initGlobals().

◆ $lastModifiedExtension

Twig_Environment::$lastModifiedExtension = 0

private

Definition at line 56 of file Environment.php.

◆ $lexer

Twig_Environment::$lexer

protected

Definition at line 31 of file Environment.php.

Referenced by getLexer(), and setLexer().

◆ $loadedTemplates

Twig_Environment::$loadedTemplates

protected

Definition at line 44 of file Environment.php.

◆ $loader

Twig_Environment::$loader

protected

Definition at line 27 of file Environment.php.

Referenced by JaimePerez\TwigConfigurableI18n\Twig\Environment\__construct(), __construct(), addRuntimeLoader(), createTemplate(), getLoader(), getRuntime(), loadTemplate(), and setLoader().

◆ $loading

Twig_Environment::$loading = array()

private

Definition at line 61 of file Environment.php.

◆ $optionsHash

Twig_Environment::$optionsHash

private

Definition at line 60 of file Environment.php.

◆ $originalCache

Twig_Environment::$originalCache

private

Definition at line 53 of file Environment.php.

◆ $parser

Twig_Environment::$parser

protected

Definition at line 32 of file Environment.php.

Referenced by addTokenParser(), getParser(), getTags(), initExtension(), and setParser().

◆ $parsers

Twig_Environment::$parsers

protected

Definition at line 36 of file Environment.php.

Referenced by getTokenParsers().

◆ $runtimeInitialized

Twig_Environment::$runtimeInitialized = false

protected

Definition at line 42 of file Environment.php.

◆ $runtimeLoaders

Twig_Environment::$runtimeLoaders = array()

private

Definition at line 58 of file Environment.php.

◆ $runtimes

Twig_Environment::$runtimes = array()

private

Definition at line 59 of file Environment.php.

◆ $staging

Twig_Environment::$staging

protected

Definition at line 51 of file Environment.php.

◆ $strictVariables

Twig_Environment::$strictVariables

protected

Definition at line 45 of file Environment.php.

Referenced by isStrictVariables().

◆ $templateClassPrefix

Twig_Environment::$templateClassPrefix = '__TwigTemplate_'

protected

Definition at line 48 of file Environment.php.

Referenced by getTemplateClassPrefix().

◆ $tests

Twig_Environment::$tests

protected

Definition at line 39 of file Environment.php.

Referenced by getTests().

◆ $unaryOperators

Twig_Environment::$unaryOperators

protected

Definition at line 46 of file Environment.php.

Referenced by getUnaryOperators().

◆ $visitors

Twig_Environment::$visitors

protected

Definition at line 37 of file Environment.php.

Referenced by getNodeVisitors().

◆ EXTRA_VERSION

const Twig_Environment::EXTRA_VERSION = ''

Definition at line 24 of file Environment.php.

◆ MAJOR_VERSION

const Twig_Environment::MAJOR_VERSION = 1

Definition at line 21 of file Environment.php.

◆ MINOR_VERSION

const Twig_Environment::MINOR_VERSION = 35

Definition at line 22 of file Environment.php.

◆ RELEASE_VERSION

const Twig_Environment::RELEASE_VERSION = 3

Definition at line 23 of file Environment.php.

◆ VERSION

const Twig_Environment::VERSION = '1.35.3'

Definition at line 19 of file Environment.php.

◆ VERSION_ID

const Twig_Environment::VERSION_ID = 13503

Definition at line 20 of file Environment.php.

The documentation for this class was generated from the following file:

libs/composer/vendor/twig/twig/lib/Twig/Environment.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addExtension()

◆ addFilter()

◆ addFunction()

◆ addGlobal()

◆ addNodeVisitor()

◆ addRuntimeLoader()

◆ addTest()

◆ addTokenParser()

◆ clearCacheFiles()

◆ clearTemplateCache()

◆ compile()

◆ compileSource()

◆ computeAlternatives()

◆ createTemplate()

◆ disableAutoReload()

◆ disableDebug()

◆ disableStrictVariables()

◆ display()

◆ enableAutoReload()

◆ enableDebug()

◆ enableStrictVariables()

◆ getBaseTemplateClass()

◆ getBinaryOperators()

◆ getCache()

◆ getCacheFilename()

◆ getCharset()

◆ getCompiler()

◆ getExtension()

◆ getExtensions()

◆ getFilter()

◆ getFilters()

◆ getFunction()

◆ getFunctions()

◆ getGlobals()

◆ getLexer()

◆ getLoader()

◆ getNodeVisitors()

◆ getParser()

◆ getRuntime()

◆ getTags()

◆ getTemplateClass()

◆ getTemplateClassPrefix()

◆ getTest()

◆ getTests()

◆ getTokenParsers()

◆ getUnaryOperators()

◆ hasExtension()

◆ initExtension()

◆ initExtensions()

◆ initGlobals()

◆ initRuntime()

◆ isAutoReload()

◆ isDebug()

◆ isStrictVariables()

◆ isTemplateFresh()

◆ load()

◆ loadTemplate()

◆ mergeGlobals()

◆ parse()

◆ registerUndefinedFilterCallback()

◆ registerUndefinedFunctionCallback()

◆ removeExtension()

◆ render()

◆ resolveTemplate()

◆ setBaseTemplateClass()

◆ setCache()

◆ setCharset()

◆ setCompiler()

◆ setExtensions()

◆ setLexer()