inc/Twig/TokenParser/Use.php

   1 <?php
   2
   3 /*
   4  * This file is part of Twig.
   5  *
   6  * (c) 2011 Fabien Potencier
   7  *
   8  * For the full copyright and license information, please view the LICENSE
   9  * file that was distributed with this source code.
  10  */
  11
  12 /**
  13  * Imports blocks defined in another template into the current template.
  14  *
  15  * <pre>
  16  * {% extends "base.html" %}
  17  *
  18  * {% use "blocks.html" %}
  19  *
  20  * {% block title %}{% endblock %}
  21  * {% block content %}{% endblock %}
  22  * </pre>
  23  *
  24  * @see http://www.twig-project.org/doc/templates.html#horizontal-reuse for details.
  25  */
  26 class Twig_TokenParser_Use extends Twig_TokenParser
  27 {
  28     /**
  29      * Parses a token and returns a node.
  30      *
  31      * @param Twig_Token $token A Twig_Token instance
  32      *
  33      * @return Twig_NodeInterface A Twig_NodeInterface instance
  34      */
  35     public function parse(Twig_Token $token)
  36     {
  37         $template = $this->parser->getExpressionParser()->parseExpression();
  38         $stream = $this->parser->getStream();
  39
  40         if (!$template instanceof Twig_Node_Expression_Constant) {
  41             throw new Twig_Error_Syntax('The template references in a "use" statement must be a string.', $stream->getCurrent()->getLine(), $stream->getFilename());
  42         }
  43
  44         $targets = array();
  45         if ($stream->test('with')) {
  46             $stream->next();
  47
  48             do {
  49                 $name = $stream->expect(Twig_Token::NAME_TYPE)->getValue();
  50
  51                 $alias = $name;
  52                 if ($stream->test('as')) {
  53                     $stream->next();
  54
  55                     $alias = $stream->expect(Twig_Token::NAME_TYPE)->getValue();
  56                 }
  57
  58                 $targets[$name] = new Twig_Node_Expression_Constant($alias, -1);
  59
  60                 if (!$stream->test(Twig_Token::PUNCTUATION_TYPE, ',')) {
  61                     break;
  62                 }
  63
  64                 $stream->next();
  65             } while (true);
  66         }
  67
  68         $stream->expect(Twig_Token::BLOCK_END_TYPE);
  69
  70         $this->parser->addTrait(new Twig_Node(array('template' => $template, 'targets' => new Twig_Node($targets))));
  71     }
  72
  73     /**
  74      * Gets the tag name associated with this token parser.
  75      *
  76      * @return string The tag name
  77      */
  78     public function getTag()
  79     {
  80         return 'use';
  81     }
  82 }