Macro.php

File

drupal/core/vendor/twig/twig/lib/Twig/TokenParser/Macro.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.
 */

/**
 * Defines a macro.
 *
 * <pre>
 * {% macro input(name, value, type, size) %}
 *    <input type="{{ type|default('text') }}" name="{{ name }}" value="{{ value|e }}" size="{{ size|default(20) }}" />
 * {% endmacro %}
 * </pre>
 */
class Twig_TokenParser_Macro 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();
    $name = $stream
      ->expect(Twig_Token::NAME_TYPE)
      ->getValue();
    $arguments = $this->parser
      ->getExpressionParser()
      ->parseArguments(true, true);
    $stream
      ->expect(Twig_Token::BLOCK_END_TYPE);
    $this->parser
      ->pushLocalScope();
    $body = $this->parser
      ->subparse(array(
      $this,
      'decideBlockEnd',
    ), true);
    if ($stream
      ->test(Twig_Token::NAME_TYPE)) {
      $value = $stream
        ->next()
        ->getValue();
      if ($value != $name) {
        throw new Twig_Error_Syntax(sprintf("Expected endmacro for macro '{$name}' (but %s given)", $value), $stream
          ->getCurrent()
          ->getLine(), $stream
          ->getFilename());
      }
    }
    $this->parser
      ->popLocalScope();
    $stream
      ->expect(Twig_Token::BLOCK_END_TYPE);
    $this->parser
      ->setMacro($name, new Twig_Node_Macro($name, new Twig_Node_Body(array(
      $body,
    )), $arguments, $lineno, $this
      ->getTag()));
    return null;
  }
  public function decideBlockEnd(Twig_Token $token) {
    return $token
      ->test('endmacro');
  }

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

}

Classes

Namesort descending Description
Twig_TokenParser_Macro Defines a macro.