Twig_TokenParser_Sandbox Class Reference

Marks a section of a template as untrusted code that must be evaluated in the sandbox mode. More...

Inheritance diagram for Twig_TokenParser_Sandbox:

Collaboration diagram for Twig_TokenParser_Sandbox:

Public Member Functions
	parse (Twig_Token $token)
	Parses a token and returns a node. More...
	decideBlockEnd (Twig_Token $token)
	getTag ()
	Gets the tag name associated with this token parser. More...
Public Member Functions inherited from Twig_TokenParser
	setParser (Twig_Parser $parser)
	Sets the parser associated with this token parser. More...

Additional Inherited Members
Protected Attributes inherited from Twig_TokenParser
	$parser

Detailed Description

Marks a section of a template as untrusted code that must be evaluated in the sandbox mode.

{% sandbox %}
    {% include 'user.html' %}
{% endsandbox %}

See also

http://www.twig-project.org/doc/api.html#sandbox-extension for details

Definition at line 25 of file Sandbox.php.

Member Function Documentation

decideBlockEnd()

Twig_TokenParser_Sandbox::decideBlockEnd

(

Twig_Token

$token

)

Definition at line 50 of file Sandbox.php.

References Twig_Token\test().

    {
        return $token->test('endsandbox');
    }

Here is the call graph for this function:

getTag()

Twig_TokenParser_Sandbox::getTag

(

)

Gets the tag name associated with this token parser.

Returns

string The tag name

Implements Twig_TokenParserInterface.

Definition at line 55 of file Sandbox.php.

Referenced by parse().

    {
        return 'sandbox';
    }

Here is the caller graph for this function:

parse()

Twig_TokenParser_Sandbox::parse

(

Twig_Token

$token

)

Parses a token and returns a node.

Returns

Twig_NodeInterface

Exceptions

Twig_Error_Syntax

Implements Twig_TokenParserInterface.

Definition at line 27 of file Sandbox.php.

References GuzzleHttp\Psr7\$stream, Twig_Token\BLOCK_END_TYPE, Twig_Token\getLine(), and getTag().

    {
        $stream = $this->parser->getStream();
        $stream->expect(Twig_Token::BLOCK_END_TYPE);
        $body = $this->parser->subparse(array($this, 'decideBlockEnd'), true);
        $stream->expect(Twig_Token::BLOCK_END_TYPE);

        // in a sandbox tag, only include tags are allowed
        if (!$body instanceof Twig_Node_Include) {
            foreach ($body as $node) {
                if ($node instanceof Twig_Node_Text && ctype_space($node->getAttribute('data'))) {
                    continue;
                }

                if (!$node instanceof Twig_Node_Include) {
                    throw new Twig_Error_Syntax('Only "include" tags are allowed within a "sandbox" section.', $node->getTemplateLine(), $stream->getSourceContext());
                }
            }
        }

        return new Twig_Node_Sandbox($body, $token->getLine(), $this->getTag());
    }

Here is the call graph for this function:

---

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

• libs/composer/vendor/twig/twig/lib/Twig/TokenParser/Sandbox.php