Twig_TokenParser_AutoEscape Class Reference

Marks a section of a template to be escaped or not. More...

Inheritance diagram for Twig_TokenParser_AutoEscape:

Collaboration diagram for Twig_TokenParser_AutoEscape:

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 to be escaped or not.

{% autoescape true %}
  Everything will be automatically escaped in this block
{% endautoescape %}

{% autoescape false %}
  Everything will be outputed as is in this block
{% endautoescape %}

{% autoescape true js %}
  Everything will be automatically escaped in this block
  using the js escaping strategy
{% endautoescape %}

Definition at line 32 of file AutoEscape.php.

Member Function Documentation

decideBlockEnd()

Twig_TokenParser_AutoEscape::decideBlockEnd

(

Twig_Token

$token

)

Definition at line 72 of file AutoEscape.php.

References Twig_Token\test().

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

Here is the call graph for this function:

getTag()

Twig_TokenParser_AutoEscape::getTag

(

)

Gets the tag name associated with this token parser.

Returns

string The tag name

Implements Twig_TokenParserInterface.

Definition at line 77 of file AutoEscape.php.

Referenced by parse().

    {
        return 'autoescape';
    }

Here is the caller graph for this function:

parse()

Twig_TokenParser_AutoEscape::parse

(

Twig_Token

$token

)

Parses a token and returns a node.

Returns

Twig_NodeInterface

Exceptions

Twig_Error_Syntax

Implements Twig_TokenParserInterface.

Definition at line 34 of file AutoEscape.php.

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

    {
        $lineno = $token->getLine();
        $stream = $this->parser->getStream();

        if ($stream->test(Twig_Token::BLOCK_END_TYPE)) {
            $value = 'html';
        } else {
            $expr = $this->parser->getExpressionParser()->parseExpression();
            if (!$expr instanceof Twig_Node_Expression_Constant) {
                throw new Twig_Error_Syntax('An escaping strategy must be a string or a bool.', $stream->getCurrent()->getLine(), $stream->getSourceContext());
            }
            $value = $expr->getAttribute('value');

            $compat = true === $value || false === $value;

            if (true === $value) {
                $value = 'html';
            }

            if ($compat && $stream->test(Twig_Token::NAME_TYPE)) {
                @trigger_error('Using the autoescape tag with "true" or "false" before the strategy name is deprecated since version 1.21.', E_USER_DEPRECATED);

                if (false === $value) {
                    throw new Twig_Error_Syntax('Unexpected escaping strategy as you set autoescaping to false.', $stream->getCurrent()->getLine(), $stream->getSourceContext());
                }

                $value = $stream->next()->getValue();
            }
        }

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

        return new Twig_Node_AutoEscape($value, $body, $lineno, $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/AutoEscape.php