Twig_Node_Module Class Reference

Represents a module node. More...

Inheritance diagram for Twig_Node_Module:

Collaboration diagram for Twig_Node_Module:

Public Member Functions
	__construct (Twig_NodeInterface $body, Twig_Node_Expression $parent=null, Twig_NodeInterface $blocks, Twig_NodeInterface $macros, Twig_NodeInterface $traits, $embeddedTemplates, $name, $source='')
	setIndex ($index)
	compile (Twig_Compiler $compiler)
	Compiles the node to PHP. More...
Public Member Functions inherited from Twig_Node
	__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 ()
	compile (Twig_Compiler $compiler)
	Compiles the node to PHP. More...
	getLine ()
	getNodeTag ()

Protected Member Functions
	compileTemplate (Twig_Compiler $compiler)
	compileGetParent (Twig_Compiler $compiler)
	compileClassHeader (Twig_Compiler $compiler)
	compileConstructor (Twig_Compiler $compiler)

Private Attributes
	$source

Additional Inherited Members
Protected Attributes inherited from Twig_Node
	$nodes
	$attributes
	$lineno
	$tag

Detailed Description

Represents a module node.

Consider this class as being final. If you need to customize the behavior of the generated class, consider adding nodes to the following nodes: display_start, display_end, constructor_start, constructor_end, and class_end.

Author

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

Definition at line 22 of file Module.php.

Constructor & Destructor Documentation

__construct()

Twig_Node_Module::__construct	(	Twig_NodeInterface	$body,
		Twig_Node_Expression	$parent = null,
		Twig_NodeInterface	$blocks,
		Twig_NodeInterface	$macros,
		Twig_NodeInterface	$traits,
			$embeddedTemplates,
			$name,
			$source = ''
	)

Definition at line 26 of file Module.php.

    {
        if (!$name instanceof Twig_Source) {
            @trigger_error(sprintf('Passing a string as the $name argument of %s() is deprecated since version 1.27. Pass a Twig_Source instance instead.', __METHOD__), E_USER_DEPRECATED);
            $this->source = new Twig_Source($source, $name);
        } else {
            $this->source = $name;
        }
 
        $nodes = array(
            'body' => $body,
            'blocks' => $blocks,
            'macros' => $macros,
            'traits' => $traits,
            'display_start' => new Twig_Node(),
            'display_end' => new Twig_Node(),
            'constructor_start' => new Twig_Node(),
            'constructor_end' => new Twig_Node(),
            'class_end' => new Twig_Node(),
        );
        if (null !== $parent) {
            $nodes['parent'] = $parent;
        }
 
        // embedded templates are set as attributes so that they are only visited once by the visitors
        parent::__construct($nodes, array(
            // source to be remove in 2.0
            'source' => $this->source->getCode(),
            // filename to be remove in 2.0 (use getTemplateName() instead)
            'filename' => $this->source->getName(),
            'index' => null,
            'embedded_templates' => $embeddedTemplates,
        ), 1);
 
        // populate the template name of all node children
        $this->setTemplateName($this->source->getName());
    }

References Twig_Node\$name, Twig_Node\$nodes, $source, and Twig_Node\setTemplateName().

Here is the call graph for this function:

Member Function Documentation

compile()

Twig_Node_Module::compile

(

Twig_Compiler

$compiler

)

Compiles the node to PHP.

Reimplemented from Twig_Node.

Definition at line 69 of file Module.php.

    {
        $this->compileTemplate($compiler);
 
        foreach ($this->getAttribute('embedded_templates') as $template) {
            $compiler->subcompile($template);
        }
    }

References $template, compileTemplate(), Twig_Node\getAttribute(), and Twig_Compiler\subcompile().

Here is the call graph for this function:

compileClassHeader()

Twig_Node_Module::compileClassHeader ( Twig_Compiler  $compiler )

protected

Definition at line 153 of file Module.php.

    {
        $compiler
            ->write("\n\n")
            // if the template name contains */, add a blank to avoid a PHP parse error
            ->write('/* '.str_replace('*/', '* /', $this->source->getName())." */\n")
            ->write('class '.$compiler->getEnvironment()->getTemplateClass($this->source->getName(), $this->getAttribute('index')))
            ->raw(sprintf(" extends %s\n", $compiler->getEnvironment()->getBaseTemplateClass()))
            ->write("{\n")
            ->indent()
        ;
    }

References Twig_Compiler\getEnvironment(), and Twig_Compiler\write().

Referenced by compileTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

compileConstructor()

Twig_Node_Module::compileConstructor ( Twig_Compiler  $compiler )

protected

Definition at line 166 of file Module.php.

References $i, $key, Twig_Node\$name, Twig_Compiler\addDebugInfo(), compileLoadTemplate(), Twig_Node\count(), Twig_Node\getNode(), Twig_Node\hasNode(), Twig_Compiler\indent(), Twig_Compiler\outdent(), and Twig_Compiler\write().

Referenced by compileTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

compileGetParent()

Twig_Node_Module::compileGetParent ( Twig_Compiler  $compiler )

protected

Definition at line 118 of file Module.php.

    {
        if (!$this->hasNode('parent')) {
            return;
        }
        $parent = $this->getNode('parent');
 
        $compiler
            ->write("protected function doGetParent(array \$context)\n", "{\n")
            ->indent()
            ->addDebugInfo($parent)
            ->write('return ')
        ;
 
        if ($parent instanceof Twig_Node_Expression_Constant) {
            $compiler->subcompile($parent);
        } else {
            $compiler
                ->raw('$this->loadTemplate(')
                ->subcompile($parent)
                ->raw(', ')
                ->repr($this->source->getName())
                ->raw(', ')
                ->repr($parent->getTemplateLine())
                ->raw(')')
            ;
        }
 
        $compiler
            ->raw(";\n")
            ->outdent()
            ->write("}\n\n")
        ;
    }

References Twig_Node\getNode(), Twig_Node\hasNode(), Twig_Compiler\raw(), Twig_Compiler\subcompile(), and Twig_Compiler\write().

Referenced by compileTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

compileTemplate()

Twig_Node_Module::compileTemplate ( Twig_Compiler  $compiler )

protected

Definition at line 78 of file Module.php.

    {
        if (!$this->getAttribute('index')) {
            $compiler->write('<?php');
        }
 
        $this->compileClassHeader($compiler);
 
        if (
            count($this->getNode('blocks'))
            || count($this->getNode('traits'))
            || !$this->hasNode('parent')
            || $this->getNode('parent') instanceof Twig_Node_Expression_Constant
            || count($this->getNode('constructor_start'))
            || count($this->getNode('constructor_end'))
        ) {
            $this->compileConstructor($compiler);
        }
 
        $this->compileGetParent($compiler);
 
        $this->compileDisplay($compiler);
 
        $compiler->subcompile($this->getNode('blocks'));
 
        $this->compileMacros($compiler);
 
        $this->compileGetTemplateName($compiler);
 
        $this->compileIsTraitable($compiler);
 
        $this->compileDebugInfo($compiler);
 
        $this->compileGetSource($compiler);
 
        $this->compileGetSourceContext($compiler);
 
        $this->compileClassFooter($compiler);
    }

References compileClassFooter(), compileClassHeader(), compileConstructor(), compileDebugInfo(), compileDisplay(), compileGetParent(), compileGetSource(), compileGetSourceContext(), compileGetTemplateName(), compileIsTraitable(), compileMacros(), Twig_Node\count(), Twig_Node\getAttribute(), Twig_Node\getNode(), Twig_Node\hasNode(), Twig_Compiler\subcompile(), and Twig_Compiler\write().

Referenced by compile().

Here is the call graph for this function:

Here is the caller graph for this function:

setIndex()

Twig_Node_Module::setIndex

(

$index

)

Definition at line 64 of file Module.php.

    {
        $this->setAttribute('index', $index);
    }

References $index, and Twig_Node\setAttribute().

Here is the call graph for this function:

Field Documentation

$source

Twig_Node_Module::$source

private

Definition at line 24 of file Module.php.

Referenced by __construct().

---

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

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