AutoEscape.php

File

drupal/core/vendor/twig/twig/lib/Twig/TokenParser/AutoEscape.php
View source
<?php

/*
 * This file is part of Twig.
 *
 * (c) 2009 Fabien Potencier
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

/**
 * 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>
 */
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();
    $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 Boolean.', $stream
          ->getCurrent()
          ->getLine(), $stream
          ->getFilename());
      }
      $value = $expr
        ->getAttribute('value');
      $compat = true === $value || false === $value;
      if (true === $value) {
        $value = 'html';
      }
      if ($compat && $stream
        ->test(Twig_Token::NAME_TYPE)) {
        if (false === $value) {
          throw new Twig_Error_Syntax('Unexpected escaping strategy as you set autoescaping to false.', $stream
            ->getCurrent()
            ->getLine(), $stream
            ->getFilename());
        }
        $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());
  }
  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';
  }

}

Classes

Namesort descending Description
Twig_TokenParser_AutoEscape Marks a section of a template to be escaped or not.