Default base class for compiled templates. More...

Inheritance diagram for Twig_Template:

Collaboration diagram for Twig_Template:

Public Member Functions
	__construct (Twig_Environment $env)

	__toString ()

	getTemplateName ()
	Returns the template name. More...

	getDebugInfo ()
	Returns debug information about the template. More...

	getSource ()
	Returns the template source code. More...

	getSourceContext ()
	Returns information about the original template source code. More...

	getEnvironment ()

	getParent (array $context)
	Returns the parent template. More...

	isTraitable ()

	displayParentBlock ($name, array $context, array $blocks=array())
	Displays a parent block. More...

	displayBlock ($name, array $context, array $blocks=array(), $useBlocks=true)
	Displays a block. More...

	renderParentBlock ($name, array $context, array $blocks=array())
	Renders a parent block. More...

	renderBlock ($name, array $context, array $blocks=array(), $useBlocks=true)
	Renders a block. More...

	hasBlock ($name, array $context=null, array $blocks=array())
	Returns whether a block exists or not in the current context of the template. More...

	getBlockNames (array $context=null, array $blocks=array())
	Returns all block names in the current context of the template. More...

	getBlocks ()
	Returns all blocks. More...

	display (array $context, array $blocks=array())
	Displays the template with the given context. More...

	render (array $context)
	Renders the template with the given context and returns it as string. More...

	render (array $context)
	Renders the template with the given context and returns it as string. More...

	display (array $context, array $blocks=array())
	Displays the template with the given context. More...

	getEnvironment ()
	Returns the bound environment for this template. More...

Protected Member Functions
	doGetParent (array $context)

	loadTemplate ($template, $templateName=null, $line=null, $index=null)

	displayWithErrorHandling (array $context, array $blocks=array())

	doDisplay (array $context, array $blocks=array())
	Auto-generated method to display the template with the given context. More...

	getContext ($context, $item, $ignoreStrictCheck=false)
	Returns a variable from the context. More...

	getAttribute ($object, $item, array $arguments=array(), $type=self::ANY_CALL, $isDefinedTest=false, $ignoreStrictCheck=false)
	Returns the attribute value for a given array/object. More...

Protected Attributes
	$parent

	$parents = array()

	$env

	$blocks = array()

	$traits = array()

Static Protected Attributes
static	$cache = array()

Additional Inherited Members
Data Fields inherited from Twig_TemplateInterface
const	ANY_CALL = 'any'

const	ARRAY_CALL = 'array'

const	METHOD_CALL = 'method'

Detailed Description

Default base class for compiled templates.

This class is an implementation detail of how template compilation currently works, which might change. It should never be used directly. Use $twig->load() instead, which returns an instance of Twig_TemplateWrapper.

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

Definition at line 24 of file Template.php.

Constructor & Destructor Documentation

◆ __construct()

Twig_Template::__construct ( Twig_Environment $env )

Definition at line 37 of file Template.php.

    {
        $this->env = $env;
    }

References $env.

Member Function Documentation

◆ __toString()

Twig_Template::__toString ( )

Definition at line 45 of file Template.php.

    {
        return $this->getTemplateName();
    }

References getTemplateName().

Here is the call graph for this function:

◆ display()

Twig_Template::display	(	array	$context,
		array	$blocks = `array()`
	)

Displays the template with the given context.

Parameters

array	$context	An array of parameters to pass to the template
array	$blocks	An array of blocks to pass to the template

Implements Twig_TemplateInterface.

Definition at line 401 of file Template.php.

    {
        $this->displayWithErrorHandling($this->env->mergeGlobals($context), array_merge($this->blocks, $blocks));
    }

References $blocks, $context, and displayWithErrorHandling().

Referenced by render().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ displayBlock()

Twig_Template::displayBlock	(		$name,
		array	$context,
		array	$blocks = `array()`,
			$useBlocks = `true`
	)

Displays a block.

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

Parameters

string	$name	The block name to display
array	$context	The context
array	$blocks	The current set of blocks
bool	$useBlocks	Whether to use the current set of blocks

Definition at line 193 of file Template.php.

    {
        $name = (string) $name;
 
        if ($useBlocks && isset($blocks[$name])) {
            $template = $blocks[$name][0];
            $block = $blocks[$name][1];
        } elseif (isset($this->blocks[$name])) {
            $template = $this->blocks[$name][0];
            $block = $this->blocks[$name][1];
        } else {
            $template = null;
            $block = null;
        }
 
        // avoid RCEs when sandbox is enabled
        if (null !== $template && !$template instanceof self) {
            throw new LogicException('A block must be a method on a Twig_Template instance.');
        }
 
        if (null !== $template) {
            try {
                $template->$block($context, $blocks);
            } catch (Twig_Error $e) {
                if (!$e->getSourceContext()) {
                    $e->setSourceContext($template->getSourceContext());
                }
 
                // this is mostly useful for Twig_Error_Loader exceptions
                // see Twig_Error_Loader
                if (false === $e->getTemplateLine()) {
                    $e->setTemplateLine(-1);
                    $e->guess();
                }
 
                throw $e;
            } catch (Exception $e) {
                throw new Twig_Error_Runtime(sprintf('An exception has been thrown during the rendering of a template ("%s").', $e->getMessage()), -1, $template->getSourceContext(), $e);
            }
        } elseif (false !== $parent = $this->getParent($context)) {
            $parent->displayBlock($name, $context, array_merge($this->blocks, $blocks), false);
        } else {
            @trigger_error(sprintf('Silent display of undefined block "%s" in template "%s" is deprecated since version 1.29 and will throw an exception in 2.0. Use the "block(\'%s\') is defined" expression to test for block existence.', $name, $this->getTemplateName(), $name), E_USER_DEPRECATED);
        }
    }

References $blocks, $context, $name, $parent, $template, getParent(), Twig_Error\getSourceContext(), Twig_Error\getTemplateLine(), getTemplateName(), Twig_Error\guess(), Twig_Error\setSourceContext(), and Twig_Error\setTemplateLine().

Referenced by renderBlock().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ displayParentBlock()

Twig_Template::displayParentBlock	(		$name,
		array	$context,
		array	$blocks = `array()`
	)

Displays a parent block.

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

Parameters

string	$name	The block name to display from the parent
array	$context	The context
array	$blocks	The current set of blocks

Definition at line 167 of file Template.php.

    {
        $name = (string) $name;
 
        if (isset($this->traits[$name])) {
            $this->traits[$name][0]->displayBlock($name, $context, $blocks, false);
        } elseif (false !== $parent = $this->getParent($context)) {
            $parent->displayBlock($name, $context, $blocks, false);
        } else {
            throw new Twig_Error_Runtime(sprintf('The template has no parent and no traits defining the "%s" block.', $name), -1, $this->getSourceContext());
        }
    }

References $blocks, $context, $name, $parent, getParent(), and getSourceContext().

Referenced by renderParentBlock().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ displayWithErrorHandling()

Twig_Template::displayWithErrorHandling	(	array	$context,
		array	$blocks = `array()`
	)

protected

Definition at line 429 of file Template.php.

    {
        try {
            $this->doDisplay($context, $blocks);
        } catch (Twig_Error $e) {
            if (!$e->getSourceContext()) {
                $e->setSourceContext($this->getSourceContext());
            }
 
            // this is mostly useful for Twig_Error_Loader exceptions
            // see Twig_Error_Loader
            if (false === $e->getTemplateLine()) {
                $e->setTemplateLine(-1);
                $e->guess();
            }
 
            throw $e;
        } catch (Exception $e) {
            throw new Twig_Error_Runtime(sprintf('An exception has been thrown during the rendering of a template ("%s").', $e->getMessage()), -1, $this->getSourceContext(), $e);
        }
    }

References $blocks, doDisplay(), Twig_Error\getSourceContext(), getSourceContext(), Twig_Error\getTemplateLine(), Twig_Error\guess(), Twig_Error\setSourceContext(), and Twig_Error\setTemplateLine().

Referenced by display().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doDisplay()

Twig_Template::doDisplay	(	array	$context,
		array	$blocks = `array()`
	)

abstractprotected

Auto-generated method to display the template with the given context.

Parameters

array	$context	An array of parameters to pass to the template
array	$blocks	An array of blocks to pass to the template

Reimplemented in Twig_TemplateTest.

Referenced by displayWithErrorHandling().

Here is the caller graph for this function:

◆ doGetParent()

Twig_Template::doGetParent ( array $context )

protected

Reimplemented in Twig_TemplateTest.

Definition at line 145 of file Template.php.

    {
        return false;
    }

Referenced by getParent().

Here is the caller graph for this function:

◆ getAttribute()

Twig_Template::getAttribute	(		$object,
			$item,
		array	$arguments = `array()`,
			$type = `self::ANY_CALL`,
			$isDefinedTest = `false`,
			$ignoreStrictCheck = `false`
	)

protected

Returns the attribute value for a given array/object.

Parameters

mixed	$object	The object or array from where to get the item
mixed	$item	The item to get from the array or object
array	$arguments	An array of arguments to pass if the item is an object method
string	$type	The type of attribute (

See also: Twig_Template constants)

Parameters

bool	$isDefinedTest	Whether this is only a defined check
bool	$ignoreStrictCheck	Whether to ignore the strict attribute check or not

Returns: mixed The attribute value, or a Boolean when $isDefinedTest is true, or null when the attribute is not set and $ignoreStrictCheck is true

Exceptions

Twig_Error_Runtime if the attribute does not exist and Twig is running in strict mode and $isDefinedTest is false

Reimplemented in Twig_TemplateTest.

Definition at line 509 of file Template.php.

    {
        // array
        if (self::METHOD_CALL !== $type) {
            $arrayItem = is_bool($item) || is_float($item) ? (int) $item : $item;
 
            if ((is_array($object) && (isset($object[$arrayItem]) || array_key_exists($arrayItem, $object)))
                || ($object instanceof ArrayAccess && isset($object[$arrayItem]))
            ) {
                if ($isDefinedTest) {
                    return true;
                }
 
                return $object[$arrayItem];
            }
 
            if (self::ARRAY_CALL === $type || !is_object($object)) {
                if ($isDefinedTest) {
                    return false;
                }
 
                if ($ignoreStrictCheck || !$this->env->isStrictVariables()) {
                    return;
                }
 
                if ($object instanceof ArrayAccess) {
                    $message = sprintf('Key "%s" in object with ArrayAccess of class "%s" does not exist.', $arrayItem, get_class($object));
                } elseif (is_object($object)) {
                    $message = sprintf('Impossible to access a key "%s" on an object of class "%s" that does not implement ArrayAccess interface.', $item, get_class($object));
                } elseif (is_array($object)) {
                    if (empty($object)) {
                        $message = sprintf('Key "%s" does not exist as the array is empty.', $arrayItem);
                    } else {
                        $message = sprintf('Key "%s" for array with keys "%s" does not exist.', $arrayItem, implode(', ', array_keys($object)));
                    }
                } elseif (self::ARRAY_CALL === $type) {
                    if (null === $object) {
                        $message = sprintf('Impossible to access a key ("%s") on a null variable.', $item);
                    } else {
                        $message = sprintf('Impossible to access a key ("%s") on a %s variable ("%s").', $item, gettype($object), $object);
                    }
                } elseif (null === $object) {
                    $message = sprintf('Impossible to access an attribute ("%s") on a null variable.', $item);
                } else {
                    $message = sprintf('Impossible to access an attribute ("%s") on a %s variable ("%s").', $item, gettype($object), $object);
                }
 
                throw new Twig_Error_Runtime($message, -1, $this->getSourceContext());
            }
        }
 
        if (!is_object($object)) {
            if ($isDefinedTest) {
                return false;
            }
 
            if ($ignoreStrictCheck || !$this->env->isStrictVariables()) {
                return;
            }
 
            if (null === $object) {
                $message = sprintf('Impossible to invoke a method ("%s") on a null variable.', $item);
            } elseif (is_array($object)) {
                $message = sprintf('Impossible to invoke a method ("%s") on an array.', $item);
            } else {
                $message = sprintf('Impossible to invoke a method ("%s") on a %s variable ("%s").', $item, gettype($object), $object);
            }
 
            throw new Twig_Error_Runtime($message, -1, $this->getSourceContext());
        }
 
        // object property
        if (self::METHOD_CALL !== $type && !$object instanceof self) { // Twig_Template does not have public properties, and we don't want to allow access to internal ones
            if (isset($object->$item) || array_key_exists((string) $item, $object)) {
                if ($isDefinedTest) {
                    return true;
                }
 
                if ($this->env->hasExtension('Twig_Extension_Sandbox')) {
                    $this->env->getExtension('Twig_Extension_Sandbox')->checkPropertyAllowed($object, $item);
                }
 
                return $object->$item;
            }
        }
 
        $class = get_class($object);
 
        // object method
        if (!isset(self::$cache[$class])) {
            // get_class_methods returns all methods accessible in the scope, but we only want public ones to be accessible in templates
            if ($object instanceof self) {
                $ref = new ReflectionClass($class);
                $methods = array();
 
                foreach ($ref->getMethods(ReflectionMethod::IS_PUBLIC) as $refMethod) {
                    // Accessing the environment from templates is forbidden to prevent untrusted changes to the environment
                    if ('getenvironment' !== strtolower($refMethod->name)) {
                        $methods[] = $refMethod->name;
                    }
                }
            } else {
                $methods = get_class_methods($object);
            }
            // sort values to have consistent behavior, so that "get" methods win precedence over "is" methods
            sort($methods);
 
            $cache = array();
 
            foreach ($methods as $method) {
                $cache[$method] = $method;
                $cache[$lcName = strtolower($method)] = $method;
 
                if ('g' === $lcName[0] && 0 === strpos($lcName, 'get')) {
                    $name = substr($method, 3);
                    $lcName = substr($lcName, 3);
                } elseif ('i' === $lcName[0] && 0 === strpos($lcName, 'is')) {
                    $name = substr($method, 2);
                    $lcName = substr($lcName, 2);
                } else {
                    continue;
                }
 
                // skip get() and is() methods (in which case, $name is empty)
                if ($name) {
                    if (!isset($cache[$name])) {
                        $cache[$name] = $method;
                    }
                    if (!isset($cache[$lcName])) {
                        $cache[$lcName] = $method;
                    }
                }
            }
            self::$cache[$class] = $cache;
        }
 
        $call = false;
        if (isset(self::$cache[$class][$item])) {
            $method = self::$cache[$class][$item];
        } elseif (isset(self::$cache[$class][$lcItem = strtolower($item)])) {
            $method = self::$cache[$class][$lcItem];
        } elseif (isset(self::$cache[$class]['__call'])) {
            $method = $item;
            $call = true;
        } else {
            if ($isDefinedTest) {
                return false;
            }
 
            if ($ignoreStrictCheck || !$this->env->isStrictVariables()) {
                return;
            }
 
            throw new Twig_Error_Runtime(sprintf('Neither the property "%1$s" nor one of the methods "%1$s()", "get%1$s()"/"is%1$s()" or "__call()" exist and have public access in class "%2$s".', $item, $class), -1, $this->getSourceContext());
        }
 
        if ($isDefinedTest) {
            return true;
        }
 
        if ($this->env->hasExtension('Twig_Extension_Sandbox')) {
            $this->env->getExtension('Twig_Extension_Sandbox')->checkMethodAllowed($object, $method);
        }
 
        // Some objects throw exceptions when they have __call, and the method we try
        // to call is not supported. If ignoreStrictCheck is true, we should return null.
        try {
            if (!$arguments) {
                $ret = $object->$method();
            } else {
                $ret = call_user_func_array(array($object, $method), $arguments);
            }
        } catch (BadMethodCallException $e) {
            if ($call && ($ignoreStrictCheck || !$this->env->isStrictVariables())) {
                return;
            }
            throw $e;
        }
 
        // @deprecated in 1.28
        if ($object instanceof Twig_TemplateInterface) {
            $self = $object->getTemplateName() === $this->getTemplateName();
            $message = sprintf('Calling "%s" on template "%s" from template "%s" is deprecated since version 1.28 and won\'t be supported anymore in 2.0.', $item, $object->getTemplateName(), $this->getTemplateName());
            if ('renderBlock' === $method || 'displayBlock' === $method) {
                $message .= sprintf(' Use block("%s"%s) instead).', $arguments[0], $self ? '' : ', template');
            } elseif ('hasBlock' === $method) {
                $message .= sprintf(' Use "block("%s"%s) is defined" instead).', $arguments[0], $self ? '' : ', template');
            } elseif ('render' === $method || 'display' === $method) {
                $message .= sprintf(' Use include("%s") instead).', $object->getTemplateName());
            }
            @trigger_error($message, E_USER_DEPRECATED);
 
            return '' === $ret ? '' : new Twig_Markup($ret, $this->env->getCharset());
        }
 
        return $ret;
    }

References $cache, $message, $name, $ret, $type, getSourceContext(), and getTemplateName().

Here is the call graph for this function:

◆ getBlockNames()

Twig_Template::getBlockNames	(	array	$context = `null`,
		array	$blocks = `array()`
	)

Returns all block names in the current context of the template.

This method checks blocks defined in the current template or defined in "used" traits or defined in parent templates.

Parameters

array	$context	The context
array	$blocks	The current set of blocks

Returns: array An array of block names

Definition at line 334 of file Template.php.

    {
        if (null === $context) {
            @trigger_error('The '.__METHOD__.' method is internal and should never be called; calling it directly is deprecated since version 1.28 and won\'t be possible anymore in 2.0.', E_USER_DEPRECATED);
 
            return array_keys($this->blocks);
        }
 
        $names = array_merge(array_keys($blocks), array_keys($this->blocks));
 
        if (false !== $parent = $this->getParent($context)) {
            $names = array_merge($names, $parent->getBlockNames($context));
        }
 
        return array_unique($names);
    }

References $blocks, $context, $parent, and getParent().

Here is the call graph for this function:

◆ getBlocks()

Twig_Template::getBlocks ( )

Returns all blocks.

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

Returns: array An array of blocks

Definition at line 396 of file Template.php.

    {
        return $this->blocks;
    }

References $blocks.

◆ getContext()

Twig_Template::getContext	(	$context,
		$item,
		$ignoreStrictCheck = `false`
	)

finalprotected

Returns a variable from the context.

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

This method should not be overridden in a sub-class as this is an implementation detail that has been introduced to optimize variable access for versions of PHP before 5.4. This is not a way to override the way to get a variable value.

Parameters

array	$context	The context
string	$item	The variable to return from the context
bool	$ignoreStrictCheck	Whether to ignore the strict variable check or not

Returns: mixed The content of the context variable

Exceptions

Twig_Error_Runtime if the variable does not exist and Twig is running in strict mode

Definition at line 480 of file Template.php.

    {
        if (!array_key_exists($item, $context)) {
            if ($ignoreStrictCheck || !$this->env->isStrictVariables()) {
                return;
            }
 
            throw new Twig_Error_Runtime(sprintf('Variable "%s" does not exist.', $item), -1, $this->getSourceContext());
        }
 
        return $context[$item];
    }

References $context, and getSourceContext().

Here is the call graph for this function:

◆ getDebugInfo()

Twig_Template::getDebugInfo ( )

Returns debug information about the template.

Returns: array Debug information

Reimplemented in Twig_TemplateTest.

Definition at line 64 of file Template.php.

    {
        return array();
    }

◆ getEnvironment()

Twig_Template::getEnvironment ( )

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

Implements Twig_TemplateInterface.

Definition at line 96 of file Template.php.

    {
        @trigger_error('The '.__METHOD__.' method is deprecated since version 1.20 and will be removed in 2.0.', E_USER_DEPRECATED);
 
        return $this->env;
    }

References $env.

◆ getParent()

Twig_Template::getParent ( array $context )

Returns the parent template.

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

Parameters

array $context

Returns: Twig_TemplateInterface|false The parent template or false if there is no parent

Definition at line 115 of file Template.php.

    {
        if (null !== $this->parent) {
            return $this->parent;
        }
 
        try {
            $parent = $this->doGetParent($context);
 
            if (false === $parent) {
                return false;
            }
 
            if ($parent instanceof self) {
                return $this->parents[$parent->getTemplateName()] = $parent;
            }
 
            if (!isset($this->parents[$parent])) {
                $this->parents[$parent] = $this->loadTemplate($parent);
            }
        } catch (Twig_Error_Loader $e) {
            $e->setSourceContext(null);
            $e->guess();
 
            throw $e;
        }
 
        return $this->parents[$parent];
    }

References $parent, doGetParent(), Twig_Error\guess(), loadTemplate(), and Twig_Error\setSourceContext().

Referenced by displayBlock(), displayParentBlock(), getBlockNames(), and hasBlock().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSource()

Twig_Template::getSource ( )

Returns the template source code.

Returns: string The template source code

Deprecated:: since 1.27 (to be removed in 2.0). Use getSourceContext() instead

Definition at line 76 of file Template.php.

    {
        @trigger_error('The '.__METHOD__.' method is deprecated since version 1.27 and will be removed in 2.0. Use getSourceContext() instead.', E_USER_DEPRECATED);
 
        return '';
    }

◆ getSourceContext()

Twig_Template::getSourceContext ( )

Returns information about the original template source code.

Returns: Twig_Source

Definition at line 88 of file Template.php.

    {
        return new Twig_Source('', $this->getTemplateName());
    }

References getTemplateName().

Referenced by displayParentBlock(), displayWithErrorHandling(), getAttribute(), getContext(), and loadTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTemplateName()

Twig_Template::getTemplateName ( )

abstract

Returns the template name.

Returns: string The template name

Reimplemented in Twig_TemplateTest.

Referenced by __toString(), displayBlock(), getAttribute(), and getSourceContext().

Here is the caller graph for this function:

◆ hasBlock()

Twig_Template::hasBlock	(		$name,
		array	$context = `null`,
		array	$blocks = `array()`
	)

Returns whether a block exists or not in the current context of the template.

This method checks blocks defined in the current template or defined in "used" traits or defined in parent templates.

Parameters

string	$name	The block name
array	$context	The context
array	$blocks	The current set of blocks

Returns: bool true if the block exists, false otherwise

Definition at line 298 of file Template.php.

    {
        if (null === $context) {
            @trigger_error('The '.__METHOD__.' method is internal and should never be called; calling it directly is deprecated since version 1.28 and won\'t be possible anymore in 2.0.', E_USER_DEPRECATED);
 
            return isset($this->blocks[(string) $name]);
        }
 
        if (isset($blocks[$name])) {
            return $blocks[$name][0] instanceof self;
        }
 
        if (isset($this->blocks[$name])) {
            return true;
        }
 
        if (false !== $parent = $this->getParent($context)) {
            return $parent->hasBlock($name, $context);
        }
 
        return false;
    }

References $blocks, $context, $name, $parent, and getParent().

Here is the call graph for this function:

◆ isTraitable()

Twig_Template::isTraitable ( )

Definition at line 150 of file Template.php.

    {
        return true;
    }

◆ loadTemplate()

Twig_Template::loadTemplate	(	$template,
		$templateName = `null`,
		$line = `null`,
		$index = `null`
	)

protected

Definition at line 351 of file Template.php.

    {
        try {
            if (is_array($template)) {
                return $this->env->resolveTemplate($template);
            }
 
            if ($template instanceof self) {
                return $template;
            }
 
            if ($template instanceof Twig_TemplateWrapper) {
                return $template;
            }
 
            return $this->env->loadTemplate($template, $index);
        } catch (Twig_Error $e) {
            if (!$e->getSourceContext()) {
                $e->setSourceContext($templateName ? new Twig_Source('', $templateName) : $this->getSourceContext());
            }
 
            if ($e->getTemplateLine()) {
                throw $e;
            }
 
            if (!$line) {
                $e->guess();
            } else {
                $e->setTemplateLine($line);
            }
 
            throw $e;
        }
    }

References $index, $template, Twig_Error\getSourceContext(), getSourceContext(), Twig_Error\getTemplateLine(), Twig_Error\guess(), Twig_Error\setSourceContext(), and Twig_Error\setTemplateLine().

Referenced by getParent(), and Twig_Tests_Node_ModuleTest\getTests().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ render()

Twig_Template::render ( array $context )

Renders the template with the given context and returns it as string.

Parameters

array $context An array of parameters to pass to the template

Returns: string The rendered template

Implements Twig_TemplateInterface.

Definition at line 406 of file Template.php.

    {
        $level = ob_get_level();
        ob_start();
        try {
            $this->display($context);
        } catch (Exception $e) {
            while (ob_get_level() > $level) {
                ob_end_clean();
            }
 
            throw $e;
        } catch (Throwable $e) {
            while (ob_get_level() > $level) {
                ob_end_clean();
            }
 
            throw $e;
        }
 
        return ob_get_clean();
    }

References display().

Here is the call graph for this function:

◆ renderBlock()

Twig_Template::renderBlock	(		$name,
		array	$context,
		array	$blocks = `array()`,
			$useBlocks = `true`
	)

Renders a block.

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

Parameters

string	$name	The block name to render
array	$context	The context
array	$blocks	The current set of blocks
bool	$useBlocks	Whether to use the current set of blocks

Returns: string The rendered block

Definition at line 276 of file Template.php.

    {
        ob_start();
        $this->displayBlock($name, $context, $blocks, $useBlocks);
 
        return ob_get_clean();
    }

References $blocks, $name, and displayBlock().

Here is the call graph for this function:

◆ renderParentBlock()

Twig_Template::renderParentBlock	(		$name,
		array	$context,
		array	$blocks = `array()`
	)

Renders a parent block.

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

Parameters

string	$name	The block name to render from the parent
array	$context	The context
array	$blocks	The current set of blocks

Returns: string The rendered block

Definition at line 253 of file Template.php.

    {
        ob_start();
        $this->displayParentBlock($name, $context, $blocks);
 
        return ob_get_clean();
    }

References $blocks, $name, and displayParentBlock().

Here is the call graph for this function:

Field Documentation

◆ $blocks

Twig_Template::$blocks = array()

protected

Definition at line 34 of file Template.php.

Referenced by display(), displayBlock(), displayParentBlock(), displayWithErrorHandling(), getBlockNames(), getBlocks(), hasBlock(), renderBlock(), and renderParentBlock().

◆ $cache

Twig_Template::$cache = array()

staticprotected

Definition at line 29 of file Template.php.

Referenced by getAttribute().

◆ $env

Twig_Template::$env

protected

Definition at line 33 of file Template.php.

Referenced by __construct(), Twig_TemplateTest\__construct(), and getEnvironment().

◆ $parent

Twig_Template::$parent

protected

Definition at line 31 of file Template.php.

Referenced by displayBlock(), displayParentBlock(), getBlockNames(), getParent(), and hasBlock().

◆ $parents

Twig_Template::$parents = array()

protected

Definition at line 32 of file Template.php.

◆ $traits

Twig_Template::$traits = array()

protected

Definition at line 35 of file Template.php.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __toString()

◆ display()

◆ displayBlock()

◆ displayParentBlock()

◆ displayWithErrorHandling()

◆ doDisplay()

◆ doGetParent()

◆ getAttribute()

◆ getBlockNames()

◆ getBlocks()

◆ getContext()

◆ getDebugInfo()

◆ getEnvironment()

◆ getParent()

◆ getSource()

◆ getSourceContext()

◆ getTemplateName()

◆ hasBlock()

◆ isTraitable()

◆ loadTemplate()

◆ render()

◆ renderBlock()

◆ renderParentBlock()

Field Documentation

◆ $blocks

◆ $cache

◆ $env

◆ $parent

◆ $parents

◆ $traits