Twig_TokenParser_Use Class Reference

Imports blocks defined in another template into the current template. More...

Inheritance diagram for Twig_TokenParser_Use:

Collaboration diagram for Twig_TokenParser_Use:

Public Member Functions
	parse (Twig_Token $token)
	Parses a token and returns a node. More...
	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...
	setParser (Twig_Parser $parser)
	Sets the parser associated with this token parser. More...
	parse (Twig_Token $token)
	Parses a token and returns a node. More...
	getTag ()
	Gets the tag name associated with this token parser. More...

Additional Inherited Members
Protected Attributes inherited from Twig_TokenParser
	$parser

Detailed Description

Imports blocks defined in another template into the current template.

{% extends "base.html" %}

{% use "blocks.html" %}

{% block title %}{% endblock %}
{% block content %}{% endblock %}

See also

http://www.twig-project.org/doc/templates.html#horizontal-reuse for details.

@final

Definition at line 28 of file Use.php.

Member Function Documentation

getTag()

Twig_TokenParser_Use::getTag

(

)

Gets the tag name associated with this token parser.

Returns

string The tag name

Implements Twig_TokenParserInterface.

Definition at line 64 of file Use.php.

    {
        return 'use';
    }

parse()

Twig_TokenParser_Use::parse

(

Twig_Token

$token

)

Parses a token and returns a node.

Returns

Twig_NodeInterface

Exceptions

Twig_Error_Syntax

Implements Twig_TokenParserInterface.

Definition at line 30 of file Use.php.

    {
        $template = $this->parser->getExpressionParser()->parseExpression();
        $stream = $this->parser->getStream();
 
        if (!$template instanceof Twig_Node_Expression_Constant) {
            throw new Twig_Error_Syntax('The template references in a "use" statement must be a string.', $stream->getCurrent()->getLine(), $stream->getSourceContext());
        }
 
        $targets = array();
        if ($stream->nextIf('with')) {
            do {
                $name = $stream->expect(Twig_Token::NAME_TYPE)->getValue();
 
                $alias = $name;
                if ($stream->nextIf('as')) {
                    $alias = $stream->expect(Twig_Token::NAME_TYPE)->getValue();
                }
 
                $targets[$name] = new Twig_Node_Expression_Constant($alias, -1);
 
                if (!$stream->nextIf(Twig_Token::PUNCTUATION_TYPE, ',')) {
                    break;
                }
            } while (true);
        }
 
        $stream->expect(Twig_Token::BLOCK_END_TYPE);
 
        $this->parser->addTrait(new Twig_Node(array('template' => $template, 'targets' => new Twig_Node($targets))));
 
        return new Twig_Node();
    }

References $name, GuzzleHttp\Psr7\$stream, $template, Twig_Token\BLOCK_END_TYPE, Twig_Token\NAME_TYPE, and Twig_Token\PUNCTUATION_TYPE.

---

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

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