<?php

/*

 * This file is part of Twig.

 *

 * (c) 2009 Fabien Potencier

 * (c) 2009 Armin Ronacher

 *

 * For the full copyright and license information, please view the LICENSE

 * file that was distributed with this source code.

 */

/**

 * Loops over each item of a sequence.

 *

 * <pre>

 * <ul>

 *  {% for user in users %}

 *    <li>{{ user.username|e }}</li>

 *  {% endfor %}

 * </ul>

 * </pre>

 */

class Twig_TokenParser_For 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();

        $targets = $this->parser->getExpressionParser()->parseAssignmentExpression();

        $this->parser->getStream()->expect(Twig_Token::OPERATOR_TYPE, 'in');

        $seq = $this->parser->getExpressionParser()->parseExpression();

        $this->parser->getStream()->expect(Twig_Token::BLOCK_END_TYPE);

        $body = $this->parser->subparse(array($this, 'decideForFork'));

        if ($this->parser->getStream()->next()->getValue() == 'else') {

            $this->parser->getStream()->expect(Twig_Token::BLOCK_END_TYPE);

            $else = $this->parser->subparse(array($this, 'decideForEnd'), true);

        } else {

            $else = null;

        }

        $this->parser->getStream()->expect(Twig_Token::BLOCK_END_TYPE);

        if (count($targets) > 1) {

            $keyTarget = $targets->getNode(0);

            $valueTarget = $targets->getNode(1);

        } else {

            $keyTarget = new Twig_Node_Expression_AssignName('_key', $lineno);

            $valueTarget = $targets->getNode(0);

        }

        return new Twig_Node_For($keyTarget, $valueTarget, $seq, $body, $else, $lineno, $this->getTag());

    }

    public function decideForFork(Twig_Token $token)

    {

        return $token->test(array('else', 'endfor'));

    }

    public function decideForEnd(Twig_Token $token)

    {

        return $token->test('endfor');

    }

    /**

     * Gets the tag name associated with this token parser.

     *

     * @param string The tag name

     */

    public function getTag()

    {

        return 'for';

    }

}