Twig_TemplateWrapper Class Reference

Exposes a template to userland. More...

Collaboration diagram for Twig_TemplateWrapper:

Public Member Functions
	__construct (Twig_Environment $env, Twig_Template $template)
	This method is for internal use only and should never be called directly (use Twig_Environment::load() instead). More...
	render ($context=array())
	Renders the template. More...
	display ($context=array())
	Displays the template. More...
	hasBlock ($name, $context=array())
	Checks if a block is defined. More...
	getBlockNames ($context=array())
	Returns defined block names in the template. More...
	renderBlock ($name, $context=array())
	Renders a template block. More...
	displayBlock ($name, $context=array())
	Displays a template block. More...
	getSourceContext ()

Private Attributes
	$env
	$template

Detailed Description

Exposes a template to userland.

Author

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

Definition at line 17 of file TemplateWrapper.php.

Constructor & Destructor Documentation

__construct()

Twig_TemplateWrapper::__construct	(	Twig_Environment	$env,
		Twig_Template	$template
	)

This method is for internal use only and should never be called directly (use Twig_Environment::load() instead).

Definition at line 28 of file TemplateWrapper.php.

    {
        $this->env = $env;
        $this->template = $template;
    }

References $env, and $template.

Member Function Documentation

display()

Twig_TemplateWrapper::display

(

$context = array()

)

Displays the template.

Parameters

array

$context

An array of parameters to pass to the template

Definition at line 51 of file TemplateWrapper.php.

    {
        $this->template->display($context);
    }

References $context.

displayBlock()

Twig_TemplateWrapper::displayBlock	(		$name,
			$context = array()
	)

Displays a template block.

Parameters

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

Definition at line 119 of file TemplateWrapper.php.

    {
        $this->template->displayBlock($name, $this->env->mergeGlobals($context));
    }

References $context, and $name.

getBlockNames()

Twig_TemplateWrapper::getBlockNames

(

$context = array()

)

Returns defined block names in the template.

Parameters

array

$context

An array of parameters to pass to the template

Returns

string[] An array of defined template block names

Definition at line 76 of file TemplateWrapper.php.

    {
        return $this->template->getBlockNames($context);
    }

References $context.

getSourceContext()

Twig_TemplateWrapper::getSourceContext

(

)

Returns

Twig_Source

Definition at line 127 of file TemplateWrapper.php.

    {
        return $this->template->getSourceContext();
    }

hasBlock()

Twig_TemplateWrapper::hasBlock	(		$name,
			$context = array()
	)

Checks if a block is defined.

Parameters

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

Returns

bool

Definition at line 64 of file TemplateWrapper.php.

    {
        return $this->template->hasBlock($name, $context);
    }

References $context, and $name.

render()

Twig_TemplateWrapper::render

(

$context = array()

)

Renders the template.

Parameters

array

$context

An array of parameters to pass to the template

Returns

string The rendered template

Definition at line 41 of file TemplateWrapper.php.

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

References $context.

renderBlock()

Twig_TemplateWrapper::renderBlock	(		$name,
			$context = array()
	)

Renders a template block.

Parameters

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

Returns

string The rendered block

Definition at line 89 of file TemplateWrapper.php.

    {
        $context = $this->env->mergeGlobals($context);
        $level = ob_get_level();
        ob_start();
        try {
            $this->template->displayBlock($name, $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 $context, and $name.

Field Documentation

$env

Twig_TemplateWrapper::$env

private

Definition at line 19 of file TemplateWrapper.php.

Referenced by __construct().

$template

Twig_TemplateWrapper::$template

private

Definition at line 20 of file TemplateWrapper.php.

Referenced by __construct().

---

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

• libs/composer/vendor/twig/twig/lib/Twig/TemplateWrapper.php