Twig_NodeVisitor_Optimizer Class Reference

Twig_NodeVisitor_Optimizer tries to optimizes the AST. More...

Inheritance diagram for Twig_NodeVisitor_Optimizer:

Collaboration diagram for Twig_NodeVisitor_Optimizer:

Public Member Functions
	__construct ($optimizers=-1)
	getPriority ()
	Returns the priority for this visitor. More...
Public Member Functions inherited from Twig_BaseNodeVisitor
	enterNode (Twig_NodeInterface $node, Twig_Environment $env)
	Called before child nodes are visited. More...
	leaveNode (Twig_NodeInterface $node, Twig_Environment $env)
	Called after child nodes are visited. More...

Data Fields
const	OPTIMIZE_ALL = -1
const	OPTIMIZE_NONE = 0
const	OPTIMIZE_FOR = 2
const	OPTIMIZE_RAW_FILTER = 4
const	OPTIMIZE_VAR_ACCESS = 8

Protected Member Functions
	doEnterNode (Twig_Node $node, Twig_Environment $env)
	doLeaveNode (Twig_Node $node, Twig_Environment $env)
	optimizeVariables (Twig_NodeInterface $node, Twig_Environment $env)
	optimizePrintNode (Twig_NodeInterface $node, Twig_Environment $env)
	Optimizes print nodes. More...
	optimizeRawFilter (Twig_NodeInterface $node, Twig_Environment $env)
	Removes "raw" filters. More...
	enterOptimizeFor (Twig_NodeInterface $node, Twig_Environment $env)
	Optimizes "for" tag by removing the "loop" variable creation whenever possible. More...
	leaveOptimizeFor (Twig_NodeInterface $node, Twig_Environment $env)
	Optimizes "for" tag by removing the "loop" variable creation whenever possible. More...
	addLoopToCurrent ()
	addLoopToAll ()
Protected Member Functions inherited from Twig_BaseNodeVisitor
	doEnterNode (Twig_Node $node, Twig_Environment $env)
	Called before child nodes are visited. More...
	doLeaveNode (Twig_Node $node, Twig_Environment $env)
	Called after child nodes are visited. More...

Protected Attributes
	$loops = array()
	$loopsTargets = array()
	$optimizers
	$prependedNodes = array()
	$inABody = false

Detailed Description

Twig_NodeVisitor_Optimizer tries to optimizes the AST.

This visitor is always the last registered one.

You can configure which optimizations you want to activate via the optimizer mode.

Author

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

Definition at line 24 of file Optimizer.php.

Constructor & Destructor Documentation

__construct()

Twig_NodeVisitor_Optimizer::__construct

(

$optimizers = -1

)

Parameters

int

$optimizers

The optimizer mode

Definition at line 41 of file Optimizer.php.

References $optimizers.

    {
        if (!is_int($optimizers) || $optimizers > (self::OPTIMIZE_FOR | self::OPTIMIZE_RAW_FILTER | self::OPTIMIZE_VAR_ACCESS)) {
            throw new InvalidArgumentException(sprintf('Optimizer mode "%s" is not valid.', $optimizers));
        }

        $this->optimizers = $optimizers;
    }

Member Function Documentation

addLoopToAll()

Twig_NodeVisitor_Optimizer::addLoopToAll ( )

protected

Definition at line 240 of file Optimizer.php.

Referenced by enterOptimizeFor().

    {
        foreach ($this->loops as $loop) {
            $loop->setAttribute('with_loop', true);
        }
    }

Here is the caller graph for this function:

addLoopToCurrent()

Twig_NodeVisitor_Optimizer::addLoopToCurrent ( )

protected

Definition at line 235 of file Optimizer.php.

Referenced by enterOptimizeFor().

    {
        $this->loops[0]->setAttribute('with_loop', true);
    }

Here is the caller graph for this function:

doEnterNode()

Twig_NodeVisitor_Optimizer::doEnterNode ( Twig_Node  $node, Twig_Environment  $env  )

protected

Definition at line 50 of file Optimizer.php.

References enterOptimizeFor(), Twig_Environment\hasExtension(), Twig_Environment\isStrictVariables(), and optimizeVariables().

    {
        if (self::OPTIMIZE_FOR === (self::OPTIMIZE_FOR & $this->optimizers)) {
            $this->enterOptimizeFor($node, $env);
        }

        if (PHP_VERSION_ID < 50400 && self::OPTIMIZE_VAR_ACCESS === (self::OPTIMIZE_VAR_ACCESS & $this->optimizers) && !$env->isStrictVariables() && !$env->hasExtension('Twig_Extension_Sandbox')) {
            if ($this->inABody) {
                if (!$node instanceof Twig_Node_Expression) {
                    if ('Twig_Node' !== get_class($node)) {
                        array_unshift($this->prependedNodes, array());
                    }
                } else {
                    $node = $this->optimizeVariables($node, $env);
                }
            } elseif ($node instanceof Twig_Node_Body) {
                $this->inABody = true;
            }
        }

        return $node;
    }

Here is the call graph for this function:

doLeaveNode()

Twig_NodeVisitor_Optimizer::doLeaveNode ( Twig_Node  $node, Twig_Environment  $env  )

protected

Definition at line 73 of file Optimizer.php.

References $name, $nodes, $prependedNodes, Twig_Node\getTemplateLine(), Twig_Environment\hasExtension(), Twig_Environment\isStrictVariables(), leaveOptimizeFor(), optimizePrintNode(), and optimizeRawFilter().

    {
        $expression = $node instanceof Twig_Node_Expression;

        if (self::OPTIMIZE_FOR === (self::OPTIMIZE_FOR & $this->optimizers)) {
            $this->leaveOptimizeFor($node, $env);
        }

        if (self::OPTIMIZE_RAW_FILTER === (self::OPTIMIZE_RAW_FILTER & $this->optimizers)) {
            $node = $this->optimizeRawFilter($node, $env);
        }

        $node = $this->optimizePrintNode($node, $env);

        if (self::OPTIMIZE_VAR_ACCESS === (self::OPTIMIZE_VAR_ACCESS & $this->optimizers) && !$env->isStrictVariables() && !$env->hasExtension('Twig_Extension_Sandbox')) {
            if ($node instanceof Twig_Node_Body) {
                $this->inABody = false;
            } elseif ($this->inABody) {
                if (!$expression && 'Twig_Node' !== get_class($node) && $prependedNodes = array_shift($this->prependedNodes)) {
                    $nodes = array();
                    foreach (array_unique($prependedNodes) as $name) {
                        $nodes[] = new Twig_Node_SetTemp($name, $node->getTemplateLine());
                    }

                    $nodes[] = $node;
                    $node = new Twig_Node($nodes);
                }
            }
        }

        return $node;
    }

Here is the call graph for this function:

enterOptimizeFor()

Twig_NodeVisitor_Optimizer::enterOptimizeFor ( Twig_NodeInterface  $node, Twig_Environment  $env  )

protected

Optimizes "for" tag by removing the "loop" variable creation whenever possible.

Definition at line 162 of file Optimizer.php.

References $loopsTargets, addLoopToAll(), and addLoopToCurrent().

Referenced by doEnterNode().

    {
        if ($node instanceof Twig_Node_For) {
            // disable the loop variable by default
            $node->setAttribute('with_loop', false);
            array_unshift($this->loops, $node);
            array_unshift($this->loopsTargets, $node->getNode('value_target')->getAttribute('name'));
            array_unshift($this->loopsTargets, $node->getNode('key_target')->getAttribute('name'));
        } elseif (!$this->loops) {
            // we are outside a loop
            return;
        }

        // when do we need to add the loop variable back?

        // the loop variable is referenced for the current loop
        elseif ($node instanceof Twig_Node_Expression_Name && 'loop' === $node->getAttribute('name')) {
            $node->setAttribute('always_defined', true);
            $this->addLoopToCurrent();
        }

        // optimize access to loop targets
        elseif ($node instanceof Twig_Node_Expression_Name && in_array($node->getAttribute('name'), $this->loopsTargets)) {
            $node->setAttribute('always_defined', true);
        }

        // block reference
        elseif ($node instanceof Twig_Node_BlockReference || $node instanceof Twig_Node_Expression_BlockReference) {
            $this->addLoopToCurrent();
        }

        // include without the only attribute
        elseif ($node instanceof Twig_Node_Include && !$node->getAttribute('only')) {
            $this->addLoopToAll();
        }

        // include function without the with_context=false parameter
        elseif ($node instanceof Twig_Node_Expression_Function
            && 'include' === $node->getAttribute('name')
            && (!$node->getNode('arguments')->hasNode('with_context')
                 || false !== $node->getNode('arguments')->getNode('with_context')->getAttribute('value')
               )
        ) {
            $this->addLoopToAll();
        }

        // the loop variable is referenced via an attribute
        elseif ($node instanceof Twig_Node_Expression_GetAttr
            && (!$node->getNode('attribute') instanceof Twig_Node_Expression_Constant
                || 'parent' === $node->getNode('attribute')->getAttribute('value')
               )
            && (true === $this->loops[0]->getAttribute('with_loop')
                || ($node->getNode('node') instanceof Twig_Node_Expression_Name
                    && 'loop' === $node->getNode('node')->getAttribute('name')
                   )
               )
        ) {
            $this->addLoopToAll();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPriority()

Twig_NodeVisitor_Optimizer::getPriority

(

)

Returns the priority for this visitor.

Priority should be between -10 and 10 (0 is the default).

Returns

int The priority level

Implements Twig_NodeVisitorInterface.

Definition at line 247 of file Optimizer.php.

    {
        return 255;
    }

leaveOptimizeFor()

Twig_NodeVisitor_Optimizer::leaveOptimizeFor ( Twig_NodeInterface  $node, Twig_Environment  $env  )

protected

Optimizes "for" tag by removing the "loop" variable creation whenever possible.

Definition at line 226 of file Optimizer.php.

Referenced by doLeaveNode().

    {
        if ($node instanceof Twig_Node_For) {
            array_shift($this->loops);
            array_shift($this->loopsTargets);
            array_shift($this->loopsTargets);
        }
    }

Here is the caller graph for this function:

optimizePrintNode()

Twig_NodeVisitor_Optimizer::optimizePrintNode ( Twig_NodeInterface  $node, Twig_Environment  $env  )

protected

Optimizes print nodes.

It replaces:

• "echo $this->render(Parent)Block()" with "$this->display(Parent)Block()"

Returns

Twig_NodeInterface

Definition at line 126 of file Optimizer.php.

Referenced by doLeaveNode().

    {
        if (!$node instanceof Twig_Node_Print) {
            return $node;
        }

        $exprNode = $node->getNode('expr');
        if (
            $exprNode instanceof Twig_Node_Expression_BlockReference ||
            $exprNode instanceof Twig_Node_Expression_Parent
        ) {
            $exprNode->setAttribute('output', true);

            return $exprNode;
        }

        return $node;
    }

Here is the caller graph for this function:

optimizeRawFilter()

Twig_NodeVisitor_Optimizer::optimizeRawFilter ( Twig_NodeInterface  $node, Twig_Environment  $env  )

protected

Removes "raw" filters.

Returns

Twig_NodeInterface

Definition at line 150 of file Optimizer.php.

Referenced by doLeaveNode().

    {
        if ($node instanceof Twig_Node_Expression_Filter && 'raw' == $node->getNode('filter')->getAttribute('value')) {
            return $node->getNode('node');
        }

        return $node;
    }

Here is the caller graph for this function:

optimizeVariables()

Twig_NodeVisitor_Optimizer::optimizeVariables ( Twig_NodeInterface  $node, Twig_Environment  $env  )

protected

Definition at line 106 of file Optimizer.php.

Referenced by doEnterNode().

    {
        if ('Twig_Node_Expression_Name' === get_class($node) && $node->isSimple()) {
            $this->prependedNodes[0][] = $node->getAttribute('name');

            return new Twig_Node_Expression_TempName($node->getAttribute('name'), $node->getTemplateLine());
        }

        return $node;
    }

Here is the caller graph for this function:

Field Documentation

$inABody

Twig_NodeVisitor_Optimizer::$inABody = false

protected

Definition at line 36 of file Optimizer.php.

$loops

Twig_NodeVisitor_Optimizer::$loops = array()

protected

Definition at line 32 of file Optimizer.php.

$loopsTargets

Twig_NodeVisitor_Optimizer::$loopsTargets = array()

protected

Definition at line 33 of file Optimizer.php.

Referenced by enterOptimizeFor().

$optimizers

Twig_NodeVisitor_Optimizer::$optimizers

protected

Definition at line 34 of file Optimizer.php.

Referenced by __construct().

$prependedNodes

Twig_NodeVisitor_Optimizer::$prependedNodes = array()

protected

Definition at line 35 of file Optimizer.php.

Referenced by doLeaveNode().

OPTIMIZE_ALL

const Twig_NodeVisitor_Optimizer::OPTIMIZE_ALL = -1

Definition at line 26 of file Optimizer.php.

OPTIMIZE_FOR

const Twig_NodeVisitor_Optimizer::OPTIMIZE_FOR = 2

Definition at line 28 of file Optimizer.php.

OPTIMIZE_NONE

const Twig_NodeVisitor_Optimizer::OPTIMIZE_NONE = 0

Definition at line 27 of file Optimizer.php.

OPTIMIZE_RAW_FILTER

const Twig_NodeVisitor_Optimizer::OPTIMIZE_RAW_FILTER = 4

Definition at line 29 of file Optimizer.php.

OPTIMIZE_VAR_ACCESS

const Twig_NodeVisitor_Optimizer::OPTIMIZE_VAR_ACCESS = 8

Definition at line 30 of file Optimizer.php.

---

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

• libs/composer/vendor/twig/twig/lib/Twig/NodeVisitor/Optimizer.php