Twig_Node Class Reference

Represents a node in the AST. More...

Inheritance diagram for Twig_Node:

Collaboration diagram for Twig_Node:

Public Member Functions
	__construct (array $nodes=array(), array $attributes=array(), $lineno=0, $tag=null)
	Constructor. More...
	__toString ()
	toXml ($asDom=false)
	compile (Twig_Compiler $compiler)
	Compiles the node to PHP. More...
	getTemplateLine ()
	getLine ()
	getNodeTag ()
	hasAttribute ($name)
	getAttribute ($name)
	setAttribute ($name, $value)
	removeAttribute ($name)
	hasNode ($name)
	getNode ($name)
	setNode ($name, $node=null)
	removeNode ($name)
	count ()
	getIterator ()
	setTemplateName ($name)
	getTemplateName ()
	setFilename ($name)
	getFilename ()

Protected Attributes
	$nodes
	$attributes
	$lineno
	$tag

Private Attributes
	$name

Detailed Description

Represents a node in the AST.

Author

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

Definition at line 18 of file Node.php.

Constructor & Destructor Documentation

__construct()

Twig_Node::__construct	(	array	$nodes = array(),
		array	$attributes = array(),
			$lineno = 0,
			$tag = null
	)

Constructor.

The nodes are automatically made available as properties ($this->node). The attributes are automatically made available as array items ($this['name']).

Parameters

array	$nodes	An array of named nodes
array	$attributes	An array of attributes (should not be nodes)
int	$lineno	The line number
string	$tag	The tag name associated with the Node

Definition at line 38 of file Node.php.

References $attributes, $lineno, $name, $nodes, and $tag.

    {
        foreach ($nodes as $name => $node) {
            if (!$node instanceof Twig_NodeInterface) {
                @trigger_error(sprintf('Using "%s" for the value of node "%s" of "%s" is deprecated since version 1.25 and will be removed in 2.0.', is_object($node) ? get_class($node) : null === $node ? 'null' : gettype($node), $name, get_class($this)), E_USER_DEPRECATED);
            }
        }
        $this->nodes = $nodes;
        $this->attributes = $attributes;
        $this->lineno = $lineno;
        $this->tag = $tag;
    }

Member Function Documentation

__toString()

Twig_Node::__toString

(

)

Definition at line 51 of file Node.php.

References $attributes, $name, and count().

    {
        $attributes = array();
        foreach ($this->attributes as $name => $value) {
            $attributes[] = sprintf('%s: %s', $name, str_replace("\n", '', var_export($value, true)));
        }

        $repr = array(get_class($this).'('.implode(', ', $attributes));

        if (count($this->nodes)) {
            foreach ($this->nodes as $name => $node) {
                $len = strlen($name) + 4;
                $noderepr = array();
                foreach (explode("\n", (string) $node) as $line) {
                    $noderepr[] = str_repeat(' ', $len).$line;
                }

                $repr[] = sprintf('  %s: %s', $name, ltrim(implode("\n", $noderepr)));
            }

            $repr[] = ')';
        } else {
            $repr[0] .= ')';
        }

        return implode("\n", $repr);
    }

Here is the call graph for this function:

compile()

Twig_Node::compile

(

Twig_Compiler

$compiler

)

Compiles the node to PHP.

Implements Twig_NodeInterface.

Definition at line 114 of file Node.php.

Referenced by Twig_Node_Expression_Call\compileCallable().

    {
        foreach ($this->nodes as $node) {
            $node->compile($compiler);
        }
    }

Here is the caller graph for this function:

count()

Twig_Node::count

(

)

Definition at line 209 of file Node.php.

Referenced by Twig_Node_Expression_Filter_Default\__construct(), __toString(), Twig_Node_If\compile(), Twig_Node_Macro\compile(), Twig_Node_Set\compile(), Twig_Node_Module\compileConstructor(), Twig_Node_Module\compileIsTraitable(), Twig_Extensions_Node_Trans\compileString(), Twig_Node_Module\compileTemplate(), and Twig_Node_Expression_Call\getArguments().

    {
        return count($this->nodes);
    }

Here is the caller graph for this function:

getAttribute()

Twig_Node::getAttribute

(

$name

)

Returns

mixed

Definition at line 152 of file Node.php.

References $name.

Referenced by Twig_Node_Expression_Array\__construct(), Twig_Node_Set\__construct(), Twig_Node_Expression_Filter_Default\__construct(), Twig_Node_Embed\addGetTemplate(), Twig_Node_Include\addTemplateArguments(), Twig_Node_Expression_AssignName\compile(), Twig_Node_Expression_Function\compile(), Twig_Node_Expression_TempName\compile(), Twig_Node_Expression_Constant\compile(), Twig_Node_SetTemp\compile(), Twig_Node_Expression_MethodCall\compile(), Twig_Node_Expression_Test\compile(), Twig_Node_ForLoop\compile(), Twig_Node_Import\compile(), Twig_Profiler_Node_EnterProfile\compile(), Twig_Profiler_Node_LeaveProfile\compile(), Twig_Node_Expression_GetAttr\compile(), Twig_Node_Expression_Name\compile(), Twig_Node_Block\compile(), Twig_Node_BlockReference\compile(), Twig_Node_Text\compile(), Twig_Node_Expression_Parent\compile(), Twig_Node_Expression_ExtensionReference\compile(), Twig_Node_With\compile(), Twig_Node_Include\compile(), Twig_Node_Macro\compile(), Twig_Node_For\compile(), Twig_Extensions_Node_Trans\compile(), Twig_Node_Expression_BlockReference\compile(), Twig_Node_Set\compile(), Twig_Node_Module\compile(), Twig_Node_Expression_Call\compileArguments(), Twig_Node_Expression_Call\compileCallable(), Twig_Node_Module\compileClassHeader(), Twig_Extensions_Node_Trans\compileString(), Twig_Node_Module\compileTemplate(), Twig_NodeVisitor_Sandbox\doEnterNode(), Twig_NodeVisitor_Escaper\doEnterNode(), Twig_Profiler_NodeVisitor_Profiler\doLeaveNode(), Twig_NodeVisitor_Escaper\doLeaveNode(), Twig_NodeVisitor_SafeAnalysis\doLeaveNode(), Twig_Node_Expression_Call\getArguments(), Twig_Node_Expression_Call\getCallableParameters(), Twig_Node_Expression_Name\isSimple(), Twig_Node_Expression_Name\isSpecial(), and Twig_TokenParser_For\parse().

    {
        if (!array_key_exists($name, $this->attributes)) {
            throw new LogicException(sprintf('Attribute "%s" does not exist for Node "%s".', $name, get_class($this)));
        }

        return $this->attributes[$name];
    }

Here is the caller graph for this function:

getFilename()

Twig_Node::getFilename

(

)

Deprecated:

since 1.27 (to be removed in 2.0)

Definition at line 247 of file Node.php.

References $name.

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

        return $this->name;
    }

getIterator()

Twig_Node::getIterator

(

)

Definition at line 214 of file Node.php.

    {
        return new ArrayIterator($this->nodes);
    }

getLine()

Twig_Node::getLine

(

)

Deprecated:

since 1.27 (to be removed in 2.0)

Implements Twig_NodeInterface.

Definition at line 129 of file Node.php.

References $lineno.

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

        return $this->lineno;
    }

getNode()

Twig_Node::getNode

(

$name

)

Returns

Twig_Node

Definition at line 186 of file Node.php.

References $name.

Referenced by Twig_Node_Set\__construct(), Twig_Node_Include\addGetTemplate(), Twig_Node_Include\addTemplateArguments(), Twig_Node_Expression_Test_Defined\changeIgnoreStrictCheck(), Twig_Extensions_TokenParser_Trans\checkTransString(), Twig_Node_Expression_Binary_Power\compile(), Twig_Node_Expression_Binary_StartsWith\compile(), Twig_Node_Expression_Binary_Range\compile(), Twig_Node_Expression_Binary_EndsWith\compile(), Twig_Node_Expression_Binary_In\compile(), Twig_Node_Expression_Binary_Matches\compile(), Twig_Node_Expression_Binary_NotIn\compile(), Twig_Node_Expression_Filter\compile(), Twig_Node_Expression_Conditional\compile(), Twig_Node_Expression_Test_Sameas\compile(), Twig_Node_Expression_Unary\compile(), Twig_Node_Expression_Binary\compile(), Twig_Node_Expression_MethodCall\compile(), Twig_Node_Expression_Test_Null\compile(), Twig_Node_Expression_Test_Divisibleby\compile(), Twig_Node_Expression_Test_Even\compile(), Twig_Node_Expression_Test_Odd\compile(), Twig_Node_Expression_GetAttr\compile(), Twig_Node_Expression_NullCoalesce\compile(), Twig_Node_Sandbox\compile(), Twig_Node_Do\compile(), Twig_Node_Import\compile(), Twig_Node_SandboxedPrint\compile(), Twig_Node_Expression_Test_Constant\compile(), Twig_Node_Print\compile(), Twig_Node_Block\compile(), Twig_Node_Spaceless\compile(), Twig_Node_With\compile(), Twig_Node_AutoEscape\compile(), Twig_Node_If\compile(), Twig_Node_Macro\compile(), Twig_Extensions_Node_Trans\compile(), Twig_Node_For\compile(), Twig_Node_Expression_Filter_Default\compile(), Twig_Node_Set\compile(), Twig_Node_Expression_Test_Defined\compile(), Twig_Node_Expression_Call\compileArguments(), Twig_Node_Expression_BlockReference\compileBlockArguments(), Twig_Node_Module\compileClassFooter(), Twig_Node_Module\compileConstructor(), Twig_Node_Module\compileDisplay(), Twig_Node_Module\compileGetParent(), Twig_Node_Module\compileIsTraitable(), Twig_Node_Module\compileMacros(), Twig_Node_Module\compileTemplate(), Twig_Node_Expression_BlockReference\compileTemplateCall(), Twig_NodeVisitor_Sandbox\doEnterNode(), Twig_NodeVisitor_Escaper\doEnterNode(), Twig_Profiler_NodeVisitor_Profiler\doLeaveNode(), Twig_NodeVisitor_Sandbox\doLeaveNode(), Twig_NodeVisitor_SafeAnalysis\doLeaveNode(), Twig_NodeVisitor_Escaper\escapePrintNode(), Twig_TokenParser_For\parse(), Twig_NodeVisitor_Escaper\preEscapeFilterNode(), and Twig_Node_SandboxedPrint\removeNodeFilter().

    {
        if (!array_key_exists($name, $this->nodes)) {
            throw new LogicException(sprintf('Node "%s" does not exist for Node "%s".', $name, get_class($this)));
        }

        return $this->nodes[$name];
    }

Here is the caller graph for this function:

getNodeTag()

Twig_Node::getNodeTag

(

)

Implements Twig_NodeInterface.

Definition at line 136 of file Node.php.

References $tag.

Referenced by Twig_NodeVisitor_Sandbox\doEnterNode().

    {
        return $this->tag;
    }

Here is the caller graph for this function:

getTemplateLine()

Twig_Node::getTemplateLine

(

)

Definition at line 121 of file Node.php.

References $lineno.

Referenced by Twig_Node_Expression_NullCoalesce\__construct(), Twig_Node_Expression_Filter_Default\__construct(), Twig_Node_Expression_Test_Defined\__construct(), Twig_Node_Expression_Array\addElement(), Twig_Node_Embed\addGetTemplate(), Twig_Node_Include\addGetTemplate(), Twig_Node_Import\compile(), Twig_Extensions_Node_Trans\compileString(), Twig_Node_Expression_BlockReference\compileTemplateCall(), Twig_NodeVisitor_Sandbox\doEnterNode(), Twig_NodeVisitor_Optimizer\doLeaveNode(), Twig_NodeVisitor_Escaper\escapePrintNode(), Twig_TokenParser_For\parse(), Twig_Parser\setBlock(), and Twig_Parser\setMacro().

    {
        return $this->lineno;
    }

Here is the caller graph for this function:

getTemplateName()

Twig_Node::getTemplateName

(

)

Definition at line 229 of file Node.php.

References $name.

Referenced by Twig_Node_Embed\addGetTemplate(), Twig_Node_Include\addGetTemplate(), Twig_Node_Import\compile(), Twig_Node_Expression_BlockReference\compileTemplateCall(), Twig_NodeVisitor_Escaper\doEnterNode(), and Twig_Profiler_NodeVisitor_Profiler\doLeaveNode().

    {
        return $this->name;
    }

Here is the caller graph for this function:

hasAttribute()

Twig_Node::hasAttribute

(

$name

)

Returns

bool

Definition at line 144 of file Node.php.

References $name.

Referenced by Twig_Node_Expression_Call\compileArguments(), Twig_Node_Expression_Call\compileCallable(), Twig_Node_Expression_Call\getArguments(), and Twig_Node_Expression_Call\getCallableParameters().

    {
        return array_key_exists($name, $this->attributes);
    }

Here is the caller graph for this function:

hasNode()

Twig_Node::hasNode

(

$name

)

Returns

bool

Definition at line 178 of file Node.php.

References $name.

Referenced by Twig_Node_Include\addTemplateArguments(), Twig_Node_Expression_GetAttr\compile(), Twig_Node_Expression_Test_Constant\compile(), Twig_Node_With\compile(), Twig_Node_If\compile(), Twig_Node_For\compile(), Twig_Extensions_Node_Trans\compile(), Twig_Node_Expression_Call\compileArguments(), Twig_Node_Expression_BlockReference\compileBlockArguments(), Twig_Node_Module\compileConstructor(), Twig_Node_Module\compileDisplay(), Twig_Node_Module\compileGetParent(), Twig_Node_Module\compileIsTraitable(), Twig_Node_Module\compileTemplate(), Twig_Node_Expression_BlockReference\compileTemplateCall(), and Twig_Node_Expression_Call\getCallableParameters().

    {
        return array_key_exists($name, $this->nodes);
    }

Here is the caller graph for this function:

removeAttribute()

Twig_Node::removeAttribute

(

$name

)

Definition at line 170 of file Node.php.

References $name.

    {
        unset($this->attributes[$name]);
    }

removeNode()

Twig_Node::removeNode

(

$name

)

Definition at line 204 of file Node.php.

References $name.

    {
        unset($this->nodes[$name]);
    }

setAttribute()

Twig_Node::setAttribute	(		$name,
			$value
	)

Parameters

string	$name
mixed	$value

Definition at line 165 of file Node.php.

References $name.

Referenced by Twig_Node_Expression_MethodCall\__construct(), Twig_Node_Set\__construct(), Twig_Node_Embed\__construct(), Twig_Node_Expression_Test_Defined\changeIgnoreStrictCheck(), Twig_Node_Expression_Function\compile(), Twig_Node_Expression_Filter\compile(), Twig_Node_Expression_Test\compile(), and Twig_Node_Module\setIndex().

    {
        $this->attributes[$name] = $value;
    }

Here is the caller graph for this function:

setFilename()

Twig_Node::setFilename

(

$name

)

Deprecated:

since 1.27 (to be removed in 2.0)

Definition at line 237 of file Node.php.

References $name, and setTemplateName().

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

        $this->setTemplateName($name);
    }

Here is the call graph for this function:

setNode()

Twig_Node::setNode	(		$name,
			$node = null
	)

Definition at line 195 of file Node.php.

References $name.

Referenced by Twig_Node_Set\__construct(), Twig_Profiler_NodeVisitor_Profiler\doLeaveNode(), Twig_NodeVisitor_Sandbox\doLeaveNode(), and Twig_NodeVisitor_Escaper\preEscapeFilterNode().

    {
        if (!$node instanceof Twig_NodeInterface) {
            @trigger_error(sprintf('Using "%s" for the value of node "%s" of "%s" is deprecated since version 1.25 and will be removed in 2.0.', is_object($node) ? get_class($node) : null === $node ? 'null' : gettype($node), $name, get_class($this)), E_USER_DEPRECATED);
        }

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

Here is the caller graph for this function:

setTemplateName()

Twig_Node::setTemplateName

(

$name

)

Definition at line 219 of file Node.php.

References $name.

Referenced by Twig_Node_Module\__construct(), and setFilename().

    {
        $this->name = $name;
        foreach ($this->nodes as $node) {
            if (null !== $node) {
                $node->setTemplateName($name);
            }
        }
    }

Here is the caller graph for this function:

toXml()

Twig_Node::toXml

(

$asDom = false

)

Deprecated:

since 1.16.1 (to be removed in 2.0)

Definition at line 82 of file Node.php.

References $n, $name, and $xml.

    {
        @trigger_error(sprintf('%s is deprecated since version 1.16.1 and will be removed in 2.0.', __METHOD__), E_USER_DEPRECATED);

        $dom = new DOMDocument('1.0', 'UTF-8');
        $dom->formatOutput = true;
        $dom->appendChild($xml = $dom->createElement('twig'));

        $xml->appendChild($node = $dom->createElement('node'));
        $node->setAttribute('class', get_class($this));

        foreach ($this->attributes as $name => $value) {
            $node->appendChild($attribute = $dom->createElement('attribute'));
            $attribute->setAttribute('name', $name);
            $attribute->appendChild($dom->createTextNode($value));
        }

        foreach ($this->nodes as $name => $n) {
            if (null === $n) {
                continue;
            }

            $child = $n->toXml(true)->getElementsByTagName('node')->item(0);
            $child = $dom->importNode($child, true);
            $child->setAttribute('name', $name);

            $node->appendChild($child);
        }

        return $asDom ? $dom : $dom->saveXML();
    }

Field Documentation

$attributes

Twig_Node::$attributes

protected

Definition at line 21 of file Node.php.

Referenced by __construct(), and __toString().

$lineno

Twig_Node::$lineno

protected

Definition at line 22 of file Node.php.

Referenced by Twig_Node_Expression_Function\__construct(), Twig_Node_Expression_MethodCall\__construct(), Twig_Node_Expression_NullCoalesce\__construct(), Twig_Node_Expression_TempName\__construct(), Twig_Node_Expression_Test\__construct(), Twig_Node_Expression_Binary\__construct(), Twig_Node_Expression_Conditional\__construct(), Twig_Node_Expression_GetAttr\__construct(), Twig_Node_Expression_Filter\__construct(), Twig_Node_Expression_Constant\__construct(), Twig_Node_Expression_Unary\__construct(), Twig_Node_Expression_Array\__construct(), Twig_Node_SetTemp\__construct(), Twig_Node_ForLoop\__construct(), Twig_Node_Import\__construct(), Twig_Node_Do\__construct(), Twig_Node_Set\__construct(), Twig_Node_With\__construct(), Twig_Extensions_Node_Trans\__construct(), Twig_Node_Sandbox\__construct(), Twig_Node_Flush\__construct(), Twig_Node_Expression_Parent\__construct(), Twig_Node_Block\__construct(), Twig_Node_Print\__construct(), Twig_Node_Expression_Name\__construct(), Twig_Node_Include\__construct(), Twig_Node_Embed\__construct(), Twig_Node_If\__construct(), Twig_Node_Text\__construct(), Twig_Node_BlockReference\__construct(), Twig_Node_Macro\__construct(), Twig_Node_Spaceless\__construct(), Twig_Node_For\__construct(), Twig_Node_Expression_ExtensionReference\__construct(), Twig_Node_Expression_Filter_Default\__construct(), Twig_Node_Expression_BlockReference\__construct(), Twig_Node_AutoEscape\__construct(), Twig_Node_Expression_Test_Defined\__construct(), __construct(), getLine(), and getTemplateLine().

$name

Twig_Node::$name

private

Definition at line 25 of file Node.php.

Referenced by Twig_Node_Expression_Function\__construct(), Twig_Node_Expression_Test\__construct(), Twig_Node_Expression_TempName\__construct(), Twig_Node_SetTemp\__construct(), Twig_Profiler_Node_EnterProfile\__construct(), Twig_Node_Expression_Name\__construct(), Twig_Node_Block\__construct(), Twig_Node_Embed\__construct(), Twig_Node_BlockReference\__construct(), Twig_Node_Expression_Parent\__construct(), Twig_Node_Macro\__construct(), Twig_Node_Expression_ExtensionReference\__construct(), Twig_Node_Expression_Test_Defined\__construct(), Twig_Node_Module\__construct(), __construct(), __toString(), Twig_Node_Expression_Function\compile(), Twig_Node_Expression_Filter\compile(), Twig_Node_SetTemp\compile(), Twig_Node_Expression_Test\compile(), Twig_Node_Expression_Name\compile(), Twig_Node_CheckSecurity\compile(), Twig_Node_Macro\compile(), Twig_Node_Module\compileConstructor(), Twig_Node_Expression_Call\getArguments(), getAttribute(), getFilename(), getNode(), getTemplateName(), hasAttribute(), hasNode(), Twig_Node_Expression_Call\normalizeName(), removeAttribute(), removeNode(), setAttribute(), setFilename(), setNode(), setTemplateName(), and toXml().

$nodes

Twig_Node::$nodes

protected

Definition at line 20 of file Node.php.

Referenced by Twig_Node_Expression_Test\__construct(), Twig_Node_Expression_GetAttr\__construct(), Twig_Node_With\__construct(), Twig_Extensions_Node_Trans\__construct(), Twig_Node_If\__construct(), Twig_Node_Include\__construct(), Twig_Node_For\__construct(), Twig_Node_Expression_BlockReference\__construct(), Twig_Node_Module\__construct(), __construct(), and Twig_Node_Module\compileIsTraitable().

$tag

Twig_Node::$tag

protected

Definition at line 23 of file Node.php.

Referenced by Twig_Node_Expression_Filter\__construct(), Twig_Extensions_Node_Trans\__construct(), Twig_Node_ForLoop\__construct(), Twig_Node_Import\__construct(), Twig_Node_Do\__construct(), Twig_Node_Set\__construct(), Twig_Node_Sandbox\__construct(), Twig_Node_With\__construct(), Twig_Node_Flush\__construct(), Twig_Node_Block\__construct(), Twig_Node_If\__construct(), Twig_Node_BlockReference\__construct(), Twig_Node_Include\__construct(), Twig_Node_Print\__construct(), Twig_Node_Embed\__construct(), Twig_Node_Expression_Parent\__construct(), Twig_Node_Macro\__construct(), Twig_Node_Spaceless\__construct(), Twig_Node_For\__construct(), Twig_Node_Expression_BlockReference\__construct(), Twig_Node_Expression_ExtensionReference\__construct(), Twig_Node_Expression_Filter_Default\__construct(), Twig_Node_AutoEscape\__construct(), __construct(), and getNodeTag().

---

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

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