Twig_Parser Class Reference

Default parser implementation. More...

Inheritance diagram for Twig_Parser:

Collaboration diagram for Twig_Parser:

Public Member Functions
	__construct (Twig_Environment $env)
	getEnvironment ()
	getVarName ()
	getFilename ()
	parse (Twig_TokenStream $stream, $test=null, $dropNeedle=false)
	subparse ($test, $dropNeedle=false)
	addHandler ($name, $class)
	addNodeVisitor (Twig_NodeVisitorInterface $visitor)
	getBlockStack ()
	peekBlockStack ()
	popBlockStack ()
	pushBlockStack ($name)
	hasBlock ($name)
	getBlock ($name)
	setBlock ($name, Twig_Node_Block $value)
	hasMacro ($name)
	setMacro ($name, Twig_Node_Macro $node)
	isReservedMacroName ($name)
	addTrait ($trait)
	hasTraits ()
	embedTemplate (Twig_Node_Module $template)
	addImportedSymbol ($type, $alias, $name=null, Twig_Node_Expression $node=null)
	getImportedSymbol ($type, $alias)
	isMainScope ()
	pushLocalScope ()
	popLocalScope ()
	getExpressionParser ()
	getParent ()
	setParent ($parent)
	getStream ()
	getCurrentToken ()
Public Member Functions inherited from Twig_ParserInterface
	parse (Twig_TokenStream $stream)
	Converts a token stream to a node tree. More...

Protected Member Functions
	filterBodyNodes (Twig_NodeInterface $node)

Protected Attributes
	$stack = array()
	$stream
	$parent
	$handlers
	$visitors
	$expressionParser
	$blocks
	$blockStack
	$macros
	$env
	$reservedMacroNames
	$importedSymbols
	$traits
	$embeddedTemplates = array()

Private Attributes
	$varNameSalt = 0

Detailed Description

Default parser implementation.

Author

Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

Definition at line 18 of file Parser.php.

Constructor & Destructor Documentation

__construct()

Twig_Parser::__construct

(

Twig_Environment

$env

)

Definition at line 36 of file Parser.php.

References $env.

    {
        $this->env = $env;
    }

Member Function Documentation

addHandler()

Twig_Parser::addHandler	(		$name,
			$class
	)

Deprecated:

since 1.27 (to be removed in 2.0)

Definition at line 213 of file Parser.php.

References $name.

    {
        @trigger_error('The '.__METHOD__.' method is deprecated since version 1.27 and will be removed in 2.0.', E_USER_DEPRECATED);

        $this->handlers[$name] = $class;
    }

addImportedSymbol()

Twig_Parser::addImportedSymbol	(		$type,
			$alias,
			$name = null,
		Twig_Node_Expression	$node = null
	)

Definition at line 313 of file Parser.php.

References $name, $type, and array.

    {
        $this->importedSymbols[0][$type][$alias] = array('name' => $name, 'node' => $node);
    }

addNodeVisitor()

Twig_Parser::addNodeVisitor

(

Twig_NodeVisitorInterface

$visitor

)

Deprecated:

since 1.27 (to be removed in 2.0)

Definition at line 223 of file Parser.php.

    {
        @trigger_error('The '.__METHOD__.' method is deprecated since version 1.27 and will be removed in 2.0.', E_USER_DEPRECATED);

        $this->visitors[] = $visitor;
    }

addTrait()

Twig_Parser::addTrait

(

$trait

)

Definition at line 296 of file Parser.php.

    {
        $this->traits[] = $trait;
    }

embedTemplate()

Twig_Parser::embedTemplate

(

Twig_Node_Module

$template

)

Definition at line 306 of file Parser.php.

References $template, and Twig_Node_Module\setIndex().

    {
        $template->setIndex(mt_rand());

        $this->embeddedTemplates[] = $template;
    }

Here is the call graph for this function:

filterBodyNodes()

Twig_Parser::filterBodyNodes ( Twig_NodeInterface  $node )

protected

Definition at line 376 of file Parser.php.

References $n.

Referenced by parse().

    {
        // check that the body does not contain non-empty output nodes
        if (
            ($node instanceof Twig_Node_Text && !ctype_space($node->getAttribute('data')))
            ||
            (!$node instanceof Twig_Node_Text && !$node instanceof Twig_Node_BlockReference && $node instanceof Twig_NodeOutputInterface)
        ) {
            if (false !== strpos((string) $node, chr(0xEF).chr(0xBB).chr(0xBF))) {
                throw new Twig_Error_Syntax('A template that extends another one cannot start with a byte order mark (BOM); it must be removed.', $node->getTemplateLine(), $this->stream->getSourceContext());
            }

            throw new Twig_Error_Syntax('A template that extends another one cannot include content outside Twig blocks. Did you forget to put the content inside a {% block %} tag?', $node->getTemplateLine(), $this->stream->getSourceContext());
        }

        // bypass nodes that will "capture" the output
        if ($node instanceof Twig_NodeCaptureInterface) {
            return $node;
        }

        if ($node instanceof Twig_NodeOutputInterface) {
            return;
        }

        foreach ($node as $k => $n) {
            if (null !== $n && null === $this->filterBodyNodes($n)) {
                $node->removeNode($k);
            }
        }

        return $node;
    }

Here is the caller graph for this function:

getBlock()

Twig_Parser::getBlock

(

$name

)

Definition at line 255 of file Parser.php.

References $name.

    {
        return $this->blocks[$name];
    }

getBlockStack()

Twig_Parser::getBlockStack

(

)

Definition at line 230 of file Parser.php.

References $blockStack.

    {
        return $this->blockStack;
    }

getCurrentToken()

Twig_Parser::getCurrentToken

(

)

Returns

Twig_Token

Definition at line 371 of file Parser.php.

Referenced by subparse().

    {
        return $this->stream->getCurrent();
    }

Here is the caller graph for this function:

getEnvironment()

Twig_Parser::getEnvironment

(

)

Deprecated:

since 1.27 (to be removed in 2.0)

Definition at line 44 of file Parser.php.

References $env.

Referenced by Twig_ExpressionParser\__construct().

    {
        @trigger_error('The '.__METHOD__.' method is deprecated since version 1.27 and will be removed in 2.0.', E_USER_DEPRECATED);

        return $this->env;
    }

Here is the caller graph for this function:

getExpressionParser()

Twig_Parser::getExpressionParser

(

)

Returns

Twig_ExpressionParser

Definition at line 345 of file Parser.php.

References $expressionParser.

    {
        return $this->expressionParser;
    }

getFilename()

Twig_Parser::getFilename

(

)

Deprecated:

since 1.27 (to be removed in 2.0).

Use $parser->getStream()->getSourceContext()->getPath() instead.

Definition at line 59 of file Parser.php.

    {
        @trigger_error(sprintf('The "%s" method is deprecated since version 1.27 and will be removed in 2.0. Use $parser->getStream()->getSourceContext()->getPath() instead.', __METHOD__), E_USER_DEPRECATED);

        return $this->stream->getSourceContext()->getName();
    }

getImportedSymbol()

Twig_Parser::getImportedSymbol	(		$type,
			$alias
	)

Definition at line 318 of file Parser.php.

References $type.

    {
        foreach ($this->importedSymbols as $functions) {
            if (isset($functions[$type][$alias])) {
                return $functions[$type][$alias];
            }
        }
    }

getParent()

Twig_Parser::getParent

(

)

Definition at line 350 of file Parser.php.

References $parent.

    {
        return $this->parent;
    }

getStream()

Twig_Parser::getStream

(

)

Returns

Twig_TokenStream

Definition at line 363 of file Parser.php.

References $stream.

    {
        return $this->stream;
    }

getVarName()

Twig_Parser::getVarName

(

)

Definition at line 51 of file Parser.php.

References GuzzleHttp\Psr7\hash().

    {
        return sprintf('__internal_%s', hash('sha256', __METHOD__.$this->stream->getSourceContext()->getCode().$this->varNameSalt++));
    }

Here is the call graph for this function:

hasBlock()

Twig_Parser::hasBlock

(

$name

)

Definition at line 250 of file Parser.php.

References $name.

    {
        return isset($this->blocks[$name]);
    }

hasMacro()

Twig_Parser::hasMacro

(

$name

)

Definition at line 265 of file Parser.php.

References $name.

    {
        return isset($this->macros[$name]);
    }

hasTraits()

Twig_Parser::hasTraits

(

)

Definition at line 301 of file Parser.php.

    {
        return count($this->traits) > 0;
    }

isMainScope()

Twig_Parser::isMainScope

(

)

Definition at line 327 of file Parser.php.

    {
        return 1 === count($this->importedSymbols);
    }

isReservedMacroName()

Twig_Parser::isReservedMacroName

(

$name

)

Definition at line 279 of file Parser.php.

References $name, $r, and array.

Referenced by setMacro().

    {
        if (null === $this->reservedMacroNames) {
            $this->reservedMacroNames = array();
            $r = new ReflectionClass($this->env->getBaseTemplateClass());
            foreach ($r->getMethods() as $method) {
                $methodName = strtolower($method->getName());

                if ('get' === substr($methodName, 0, 3) && isset($methodName[3])) {
                    $this->reservedMacroNames[] = substr($methodName, 3);
                }
            }
        }

        return in_array(strtolower($name), $this->reservedMacroNames);
    }

Here is the caller graph for this function:

parse()

Twig_Parser::parse	(	Twig_TokenStream	$stream,
			$test = null,
			$dropNeedle = false
	)

Definition at line 66 of file Parser.php.

References $key, $stream, $test, array, filterBodyNodes(), Twig_TokenStream\getSourceContext(), Twig_Error\getSourceContext(), Twig_Error\getTemplateLine(), Twig_Error\setSourceContext(), Twig_Error\setTemplateLine(), and subparse().

    {
        // push all variables into the stack to keep the current state of the parser
        // using get_object_vars() instead of foreach would lead to https://bugs.php.net/71336
        // This hack can be removed when min version if PHP 7.0
        $vars = array();
        foreach ($this as $k => $v) {
            $vars[$k] = $v;
        }

        unset($vars['stack'], $vars['env'], $vars['handlers'], $vars['visitors'], $vars['expressionParser'], $vars['reservedMacroNames']);
        $this->stack[] = $vars;

        // tag handlers
        if (null === $this->handlers) {
            $this->handlers = $this->env->getTokenParsers();
            $this->handlers->setParser($this);
        }

        // node visitors
        if (null === $this->visitors) {
            $this->visitors = $this->env->getNodeVisitors();
        }

        if (null === $this->expressionParser) {
            $this->expressionParser = new Twig_ExpressionParser($this, $this->env);
        }

        $this->stream = $stream;
        $this->parent = null;
        $this->blocks = array();
        $this->macros = array();
        $this->traits = array();
        $this->blockStack = array();
        $this->importedSymbols = array(array());
        $this->embeddedTemplates = array();
        $this->varNameSalt = 0;

        try {
            $body = $this->subparse($test, $dropNeedle);

            if (null !== $this->parent && null === $body = $this->filterBodyNodes($body)) {
                $body = new Twig_Node();
            }
        } catch (Twig_Error_Syntax $e) {
            if (!$e->getSourceContext()) {
                $e->setSourceContext($this->stream->getSourceContext());
            }

            if (!$e->getTemplateLine()) {
                $e->setTemplateLine($this->stream->getCurrent()->getLine());
            }

            throw $e;
        }

        $node = new Twig_Node_Module(new Twig_Node_Body(array($body)), $this->parent, new Twig_Node($this->blocks), new Twig_Node($this->macros), new Twig_Node($this->traits), $this->embeddedTemplates, $stream->getSourceContext());

        $traverser = new Twig_NodeTraverser($this->env, $this->visitors);

        $node = $traverser->traverse($node);

        // restore previous stack so previous parse() call can resume working
        foreach (array_pop($this->stack) as $key => $val) {
            $this->$key = $val;
        }

        return $node;
    }

Here is the call graph for this function:

peekBlockStack()

Twig_Parser::peekBlockStack

(

)

Definition at line 235 of file Parser.php.

    {
        return $this->blockStack[count($this->blockStack) - 1];
    }

popBlockStack()

Twig_Parser::popBlockStack

(

)

Definition at line 240 of file Parser.php.

    {
        array_pop($this->blockStack);
    }

popLocalScope()

Twig_Parser::popLocalScope

(

)

Definition at line 337 of file Parser.php.

    {
        array_shift($this->importedSymbols);
    }

pushBlockStack()

Twig_Parser::pushBlockStack

(

$name

)

Definition at line 245 of file Parser.php.

References $name.

    {
        $this->blockStack[] = $name;
    }

pushLocalScope()

Twig_Parser::pushLocalScope

(

)

Definition at line 332 of file Parser.php.

References array.

    {
        array_unshift($this->importedSymbols, array());
    }

setBlock()

Twig_Parser::setBlock	(		$name,
		Twig_Node_Block	$value
	)

Definition at line 260 of file Parser.php.

References $name, array, and Twig_Node\getTemplateLine().

    {
        $this->blocks[$name] = new Twig_Node_Body(array($value), array(), $value->getTemplateLine());
    }

Here is the call graph for this function:

setMacro()

Twig_Parser::setMacro	(		$name,
		Twig_Node_Macro	$node
	)

Definition at line 270 of file Parser.php.

References $name, Twig_Node\getTemplateLine(), and isReservedMacroName().

    {
        if ($this->isReservedMacroName($name)) {
            throw new Twig_Error_Syntax(sprintf('"%s" cannot be used as a macro name as it is a reserved keyword.', $name), $node->getTemplateLine(), $this->stream->getSourceContext());
        }

        $this->macros[$name] = $node;
    }

Here is the call graph for this function:

setParent()

Twig_Parser::setParent

(

$parent

)

Definition at line 355 of file Parser.php.

References $parent.

    {
        $this->parent = $parent;
    }

subparse()

Twig_Parser::subparse	(		$test,
			$dropNeedle = false
	)

Definition at line 136 of file Parser.php.

References $test, Twig_Error_Syntax\addSuggestions(), Twig_Error\appendMessage(), array, Twig_Token\BLOCK_START_TYPE, getCurrentToken(), Twig_Token\NAME_TYPE, Twig_Token\TEXT_TYPE, Twig_Token\VAR_END_TYPE, and Twig_Token\VAR_START_TYPE.

Referenced by parse().

    {
        $lineno = $this->getCurrentToken()->getLine();
        $rv = array();
        while (!$this->stream->isEOF()) {
            switch ($this->getCurrentToken()->getType()) {
                case Twig_Token::TEXT_TYPE:
                    $token = $this->stream->next();
                    $rv[] = new Twig_Node_Text($token->getValue(), $token->getLine());
                    break;

                case Twig_Token::VAR_START_TYPE:
                    $token = $this->stream->next();
                    $expr = $this->expressionParser->parseExpression();
                    $this->stream->expect(Twig_Token::VAR_END_TYPE);
                    $rv[] = new Twig_Node_Print($expr, $token->getLine());
                    break;

                case Twig_Token::BLOCK_START_TYPE:
                    $this->stream->next();
                    $token = $this->getCurrentToken();

                    if (Twig_Token::NAME_TYPE !== $token->getType()) {
                        throw new Twig_Error_Syntax('A block must start with a tag name.', $token->getLine(), $this->stream->getSourceContext());
                    }

                    if (null !== $test && call_user_func($test, $token)) {
                        if ($dropNeedle) {
                            $this->stream->next();
                        }

                        if (1 === count($rv)) {
                            return $rv[0];
                        }

                        return new Twig_Node($rv, array(), $lineno);
                    }

                    $subparser = $this->handlers->getTokenParser($token->getValue());
                    if (null === $subparser) {
                        if (null !== $test) {
                            $e = new Twig_Error_Syntax(sprintf('Unexpected "%s" tag', $token->getValue()), $token->getLine(), $this->stream->getSourceContext());

                            if (is_array($test) && isset($test[0]) && $test[0] instanceof Twig_TokenParserInterface) {
                                $e->appendMessage(sprintf(' (expecting closing tag for the "%s" tag defined near line %s).', $test[0]->getTag(), $lineno));
                            }
                        } else {
                            $e = new Twig_Error_Syntax(sprintf('Unknown "%s" tag.', $token->getValue()), $token->getLine(), $this->stream->getSourceContext());
                            $e->addSuggestions($token->getValue(), array_keys($this->env->getTags()));
                        }

                        throw $e;
                    }

                    $this->stream->next();

                    $node = $subparser->parse($token);
                    if (null !== $node) {
                        $rv[] = $node;
                    }
                    break;

                default:
                    throw new Twig_Error_Syntax('Lexer or parser ended up in unsupported state.', $this->getCurrentToken()->getLine(), $this->stream->getSourceContext());
            }
        }

        if (1 === count($rv)) {
            return $rv[0];
        }

        return new Twig_Node($rv, array(), $lineno);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$blocks

Twig_Parser::$blocks

protected

Definition at line 26 of file Parser.php.

$blockStack

Twig_Parser::$blockStack

protected

Definition at line 27 of file Parser.php.

Referenced by getBlockStack().

$embeddedTemplates

Twig_Parser::$embeddedTemplates = array()

protected

Definition at line 33 of file Parser.php.

$env

Twig_Parser::$env

protected

Definition at line 29 of file Parser.php.

Referenced by __construct(), and getEnvironment().

$expressionParser

Twig_Parser::$expressionParser

protected

Definition at line 25 of file Parser.php.

Referenced by getExpressionParser().

$handlers

Twig_Parser::$handlers

protected

Definition at line 23 of file Parser.php.

$importedSymbols

Twig_Parser::$importedSymbols

protected

Definition at line 31 of file Parser.php.

$macros

Twig_Parser::$macros

protected

Definition at line 28 of file Parser.php.

$parent

Twig_Parser::$parent

protected

Definition at line 22 of file Parser.php.

Referenced by getParent(), and setParent().

$reservedMacroNames

Twig_Parser::$reservedMacroNames

protected

Definition at line 30 of file Parser.php.

$stack

Twig_Parser::$stack = array()

protected

Definition at line 20 of file Parser.php.

$stream

Twig_Parser::$stream

protected

Definition at line 21 of file Parser.php.

Referenced by getStream(), and parse().

$traits

Twig_Parser::$traits

protected

Definition at line 32 of file Parser.php.

$varNameSalt

Twig_Parser::$varNameSalt = 0

private

Definition at line 34 of file Parser.php.

$visitors

Twig_Parser::$visitors

protected

Definition at line 24 of file Parser.php.

---

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

• libs/composer/vendor/twig/twig/lib/Twig/Parser.php