Twig_TokenParser_For Class Reference

Loops over each item of a sequence. More...

Inheritance diagram for Twig_TokenParser_For:

Collaboration diagram for Twig_TokenParser_For:

Public Member Functions
	parse (Twig_Token $token)
	Parses a token and returns a node. More...
	decideForFork (Twig_Token $token)
	decideForEnd (Twig_Token $token)
	getTag ()
	Gets the tag name associated with this token parser. More...
Public Member Functions inherited from Twig_TokenParser
	setParser (Twig_Parser $parser)
	Sets the parser associated with this token parser. More...

Protected Member Functions
	checkLoopUsageCondition (Twig_TokenStream $stream, Twig_NodeInterface $node)
	checkLoopUsageBody (Twig_TokenStream $stream, Twig_NodeInterface $node)

Additional Inherited Members
Protected Attributes inherited from Twig_TokenParser
	$parser

Detailed Description

Loops over each item of a sequence.

% for user in users %}
   {{ user.username|e }}
 {% endfor %}

Definition at line 26 of file For.php.

Member Function Documentation

checkLoopUsageBody()

Twig_TokenParser_For::checkLoopUsageBody ( Twig_TokenStream  $stream, Twig_NodeInterface  $node  )

protected

Definition at line 98 of file For.php.

References $n, array, and Twig_TokenStream\getSourceContext().

Referenced by parse().

    {
        if ($node instanceof Twig_Node_Expression_GetAttr && $node->getNode('node') instanceof Twig_Node_Expression_Name && 'loop' == $node->getNode('node')->getAttribute('name')) {
            $attribute = $node->getNode('attribute');
            if ($attribute instanceof Twig_Node_Expression_Constant && in_array($attribute->getAttribute('value'), array('length', 'revindex0', 'revindex', 'last'))) {
                throw new Twig_Error_Syntax(sprintf('The "loop.%s" variable is not defined when looping with a condition.', $attribute->getAttribute('value')), $node->getTemplateLine(), $stream->getSourceContext());
            }
        }

        // should check for parent.loop.XXX usage
        if ($node instanceof Twig_Node_For) {
            return;
        }

        foreach ($node as $n) {
            if (!$n) {
                continue;
            }

            $this->checkLoopUsageBody($stream, $n);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkLoopUsageCondition()

Twig_TokenParser_For::checkLoopUsageCondition ( Twig_TokenStream  $stream, Twig_NodeInterface  $node  )

protected

Definition at line 81 of file For.php.

References $n, and Twig_TokenStream\getSourceContext().

Referenced by parse().

    {
        if ($node instanceof Twig_Node_Expression_GetAttr && $node->getNode('node') instanceof Twig_Node_Expression_Name && 'loop' == $node->getNode('node')->getAttribute('name')) {
            throw new Twig_Error_Syntax('The "loop" variable cannot be used in a looping condition.', $node->getTemplateLine(), $stream->getSourceContext());
        }

        foreach ($node as $n) {
            if (!$n) {
                continue;
            }

            $this->checkLoopUsageCondition($stream, $n);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

decideForEnd()

Twig_TokenParser_For::decideForEnd

(

Twig_Token

$token

)

Definition at line 75 of file For.php.

References Twig_Token\test().

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

Here is the call graph for this function:

decideForFork()

Twig_TokenParser_For::decideForFork

(

Twig_Token

$token

)

Definition at line 70 of file For.php.

References array, and Twig_Token\test().

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

Here is the call graph for this function:

getTag()

Twig_TokenParser_For::getTag

(

)

Gets the tag name associated with this token parser.

Returns

string The tag name

Implements Twig_TokenParserInterface.

Definition at line 121 of file For.php.

Referenced by parse().

    {
        return 'for';
    }

Here is the caller graph for this function:

parse()

Twig_TokenParser_For::parse

(

Twig_Token

$token

)

Parses a token and returns a node.

Returns

Twig_NodeInterface

Exceptions

Twig_Error_Syntax

Implements Twig_TokenParserInterface.

Definition at line 28 of file For.php.

References GuzzleHttp\Psr7\$stream, array, Twig_Token\BLOCK_END_TYPE, checkLoopUsageBody(), checkLoopUsageCondition(), Twig_Node\getAttribute(), Twig_Token\getLine(), Twig_Node\getNode(), getTag(), Twig_Node\getTemplateLine(), Twig_Token\NAME_TYPE, and Twig_Token\OPERATOR_TYPE.

    {
        $lineno = $token->getLine();
        $stream = $this->parser->getStream();
        $targets = $this->parser->getExpressionParser()->parseAssignmentExpression();
        $stream->expect(Twig_Token::OPERATOR_TYPE, 'in');
        $seq = $this->parser->getExpressionParser()->parseExpression();

        $ifexpr = null;
        if ($stream->nextIf(Twig_Token::NAME_TYPE, 'if')) {
            $ifexpr = $this->parser->getExpressionParser()->parseExpression();
        }

        $stream->expect(Twig_Token::BLOCK_END_TYPE);
        $body = $this->parser->subparse(array($this, 'decideForFork'));
        if ('else' == $stream->next()->getValue()) {
            $stream->expect(Twig_Token::BLOCK_END_TYPE);
            $else = $this->parser->subparse(array($this, 'decideForEnd'), true);
        } else {
            $else = null;
        }
        $stream->expect(Twig_Token::BLOCK_END_TYPE);

        if (count($targets) > 1) {
            $keyTarget = $targets->getNode(0);
            $keyTarget = new Twig_Node_Expression_AssignName($keyTarget->getAttribute('name'), $keyTarget->getTemplateLine());
            $valueTarget = $targets->getNode(1);
            $valueTarget = new Twig_Node_Expression_AssignName($valueTarget->getAttribute('name'), $valueTarget->getTemplateLine());
        } else {
            $keyTarget = new Twig_Node_Expression_AssignName('_key', $lineno);
            $valueTarget = $targets->getNode(0);
            $valueTarget = new Twig_Node_Expression_AssignName($valueTarget->getAttribute('name'), $valueTarget->getTemplateLine());
        }

        if ($ifexpr) {
            $this->checkLoopUsageCondition($stream, $ifexpr);
            $this->checkLoopUsageBody($stream, $body);
        }

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

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/twig/twig/lib/Twig/TokenParser/For.php