class Twig_TokenParser_AutoEscape

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

<pre> {% 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 %} </pre>

Hierarchy

Expanded class hierarchy of Twig_TokenParser_AutoEscape

File

drupal/core/vendor/twig/twig/lib/Twig/TokenParser/AutoEscape.php, line 30

View source
class Twig_TokenParser_AutoEscape extends Twig_TokenParser {

  /**
   * Parses a token and returns a node.
   *
   * @param Twig_Token $token A Twig_Token instance
   *
   * @return Twig_NodeInterface A Twig_NodeInterface instance
   */
  public function parse(Twig_Token $token) {
    $lineno = $token
      ->getLine();
    if ($this->parser
      ->getStream()
      ->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 Boolean.', $lineno);
      }
      $value = $expr
        ->getAttribute('value');
      $compat = true === $value || false === $value;
      if (true === $value) {
        $value = 'html';
      }
      if ($compat && $this->parser
        ->getStream()
        ->test(Twig_Token::NAME_TYPE)) {
        if (false === $value) {
          throw new Twig_Error_Syntax('Unexpected escaping strategy as you set autoescaping to false.', $lineno);
        }
        $value = $this->parser
          ->getStream()
          ->next()
          ->getValue();
      }
    }
    $this->parser
      ->getStream()
      ->expect(Twig_Token::BLOCK_END_TYPE);
    $body = $this->parser
      ->subparse(array(
      $this,
      'decideBlockEnd',
    ), true);
    $this->parser
      ->getStream()
      ->expect(Twig_Token::BLOCK_END_TYPE);
    return new Twig_Node_AutoEscape($value, $body, $lineno, $this
      ->getTag());
  }
  public function decideBlockEnd(Twig_Token $token) {
    return $token
      ->test('endautoescape');
  }

  /**
   * Gets the tag name associated with this token parser.
   *
   * @return string The tag name
   */
  public function getTag() {
    return 'autoescape';
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Twig_TokenParser::$parser protected property
Twig_TokenParser::setParser public function Sets the parser associated with this token parser Overrides Twig_TokenParserInterface::setParser
Twig_TokenParser_AutoEscape::decideBlockEnd public function
Twig_TokenParser_AutoEscape::getTag public function Gets the tag name associated with this token parser. Overrides Twig_TokenParserInterface::getTag
Twig_TokenParser_AutoEscape::parse public function Parses a token and returns a node. Overrides Twig_TokenParserInterface::parse