Twig_Node_Macro Class Reference

Represents a macro node. More...

Inheritance diagram for Twig_Node_Macro:

Collaboration diagram for Twig_Node_Macro:

Public Member Functions
	__construct ($name, Twig_NodeInterface $body, Twig_NodeInterface $arguments, $lineno, $tag=null)
	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 ()

Data Fields
const	VARARGS_NAME = 'varargs'

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

Detailed Description

Represents a macro node.

Author

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

Definition at line 17 of file Macro.php.

Constructor & Destructor Documentation

__construct()

Twig_Node_Macro::__construct	(		$name,
		Twig_NodeInterface	$body,
		Twig_NodeInterface	$arguments,
			$lineno,
			$tag = null
	)

Definition at line 21 of file Macro.php.

References Twig_Node\$lineno, Twig_Node\$name, Twig_Node\$tag, and array.

    {
        foreach ($arguments as $argumentName => $argument) {
            if (self::VARARGS_NAME === $argumentName) {
                throw new Twig_Error_Syntax(sprintf('The argument "%s" in macro "%s" cannot be defined because the variable "%s" is reserved for arbitrary arguments.', self::VARARGS_NAME, $name, self::VARARGS_NAME), $argument->getTemplateLine());
            }
        }

        parent::__construct(array('body' => $body, 'arguments' => $arguments), array('name' => $name), $lineno, $tag);
    }

Member Function Documentation

compile()

Twig_Node_Macro::compile

(

Twig_Compiler

$compiler

)

Compiles the node to PHP.

Implements Twig_NodeInterface.

Definition at line 32 of file Macro.php.

References Twig_Node\$name, Twig_Compiler\addDebugInfo(), Twig_Node\count(), Twig_Node\getAttribute(), Twig_Node\getNode(), Twig_Compiler\outdent(), Twig_Compiler\raw(), and Twig_Compiler\write().

    {
        $compiler
            ->addDebugInfo($this)
            ->write(sprintf('public function get%s(', $this->getAttribute('name')))
        ;

        $count = count($this->getNode('arguments'));
        $pos = 0;
        foreach ($this->getNode('arguments') as $name => $default) {
            $compiler
                ->raw('$__'.$name.'__ = ')
                ->subcompile($default)
            ;

            if (++$pos < $count) {
                $compiler->raw(', ');
            }
        }

        if (PHP_VERSION_ID >= 50600) {
            if ($count) {
                $compiler->raw(', ');
            }

            $compiler->raw('...$__varargs__');
        }

        $compiler
            ->raw(")\n")
            ->write("{\n")
            ->indent()
        ;

        $compiler
            ->write("\$context = \$this->env->mergeGlobals(array(\n")
            ->indent()
        ;

        foreach ($this->getNode('arguments') as $name => $default) {
            $compiler
                ->write('')
                ->string($name)
                ->raw(' => $__'.$name.'__')
                ->raw(",\n")
            ;
        }

        $compiler
            ->write('')
            ->string(self::VARARGS_NAME)
            ->raw(' => ')
        ;

        if (PHP_VERSION_ID >= 50600) {
            $compiler->raw("\$__varargs__,\n");
        } else {
            $compiler
                ->raw('func_num_args() > ')
                ->repr($count)
                ->raw(' ? array_slice(func_get_args(), ')
                ->repr($count)
                ->raw(") : array(),\n")
            ;
        }

        $compiler
            ->outdent()
            ->write("));\n\n")
            ->write("\$blocks = array();\n\n")
            ->write("ob_start();\n")
            ->write("try {\n")
            ->indent()
            ->subcompile($this->getNode('body'))
            ->outdent()
            ->write("} catch (Exception \$e) {\n")
            ->indent()
            ->write("ob_end_clean();\n\n")
            ->write("throw \$e;\n")
            ->outdent()
            ->write("} catch (Throwable \$e) {\n")
            ->indent()
            ->write("ob_end_clean();\n\n")
            ->write("throw \$e;\n")
            ->outdent()
            ->write("}\n\n")
            ->write("return ('' === \$tmp = ob_get_clean()) ? '' : new Twig_Markup(\$tmp, \$this->env->getCharset());\n")
            ->outdent()
            ->write("}\n\n")
        ;
    }

Here is the call graph for this function:

Field Documentation

VARARGS_NAME

const Twig_Node_Macro::VARARGS_NAME = 'varargs'

Definition at line 19 of file Macro.php.

---

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

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