class SandboxNodeVisitor
@author Fabien Potencier <fabien@symfony.com>
@internal
Hierarchy
- class \Twig\NodeVisitor\SandboxNodeVisitor implements \Twig\NodeVisitor\NodeVisitorInterface
Expanded class hierarchy of SandboxNodeVisitor
1 file declares its use of SandboxNodeVisitor
- SandboxExtension.php in vendor/
twig/ twig/ src/ Extension/ SandboxExtension.php
File
-
vendor/
twig/ twig/ src/ NodeVisitor/ SandboxNodeVisitor.php, line 37
Namespace
Twig\NodeVisitorView source
final class SandboxNodeVisitor implements NodeVisitorInterface {
private $inAModule = false;
/** @var array<string, int> */
private $tags;
/** @var array<string, int> */
private $filters;
/** @var array<string, int> */
private $functions;
private $needsToStringWrap = false;
public function enterNode(Node $node, Environment $env) : Node {
if ($node instanceof ModuleNode) {
$this->inAModule = true;
$this->tags = [];
$this->filters = [];
$this->functions = [];
return $node;
}
elseif ($this->inAModule) {
// look for tags
if ($node->getNodeTag() && !isset($this->tags[$node->getNodeTag()])) {
$this->tags[$node->getNodeTag()] = $node->getTemplateLine();
}
// look for filters
if ($node instanceof FilterExpression && !isset($this->filters[$node->getAttribute('name')])) {
$this->filters[$node->getAttribute('name')] = $node->getTemplateLine();
}
// look for functions
if ($node instanceof FunctionExpression && !isset($this->functions[$node->getAttribute('name')])) {
$this->functions[$node->getAttribute('name')] = $node->getTemplateLine();
}
// the .. operator is equivalent to the range() function
if ($node instanceof RangeBinary && !isset($this->functions['range'])) {
$this->functions['range'] = $node->getTemplateLine();
}
if ($node instanceof PrintNode) {
$this->needsToStringWrap = true;
$this->wrapNode($node, 'expr');
}
if ($node instanceof SetNode && !$node->getAttribute('capture')) {
$this->needsToStringWrap = true;
}
// wrap outer nodes that can implicitly call __toString()
if ($this->needsToStringWrap) {
if ($node instanceof ConcatBinary) {
$this->wrapNode($node, 'left');
$this->wrapNode($node, 'right');
}
if ($node instanceof FilterExpression) {
$this->wrapNode($node, 'node');
$this->wrapArrayNode($node, 'arguments');
}
if ($node instanceof FunctionExpression) {
$this->wrapArrayNode($node, 'arguments');
}
}
}
return $node;
}
public function leaveNode(Node $node, Environment $env) : ?Node {
if ($node instanceof ModuleNode) {
$this->inAModule = false;
$node->setNode('constructor_end', new Nodes([
new CheckSecurityCallNode(),
$node->getNode('constructor_end'),
]));
$node->setNode('class_end', new Nodes([
new CheckSecurityNode($this->filters, $this->tags, $this->functions),
$node->getNode('class_end'),
]));
}
elseif ($this->inAModule) {
if ($node instanceof PrintNode || $node instanceof SetNode) {
$this->needsToStringWrap = false;
}
}
return $node;
}
private function wrapNode(Node $node, string $name) : void {
$expr = $node->getNode($name);
if (($expr instanceof NameExpression || $expr instanceof GetAttrExpression) && !$expr->isGenerator()) {
// Simplify in 4.0 as the spread attribute has been removed there
$new = new CheckToStringNode($expr);
if ($expr->hasAttribute('spread')) {
$new->setAttribute('spread', $expr->getAttribute('spread'));
}
$node->setNode($name, $new);
}
elseif ($expr instanceof SpreadUnary) {
$this->wrapNode($expr, 'node');
}
elseif ($expr instanceof ArrayExpression) {
foreach ($expr as $name => $_) {
$this->wrapNode($expr, $name);
}
}
}
private function wrapArrayNode(Node $node, string $name) : void {
$args = $node->getNode($name);
foreach ($args as $name => $_) {
$this->wrapNode($args, $name);
}
}
public function getPriority() : int {
return 0;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
SandboxNodeVisitor::$filters | private | property | @var array<string, int> | |
SandboxNodeVisitor::$functions | private | property | @var array<string, int> | |
SandboxNodeVisitor::$inAModule | private | property | ||
SandboxNodeVisitor::$needsToStringWrap | private | property | ||
SandboxNodeVisitor::$tags | private | property | @var array<string, int> | |
SandboxNodeVisitor::enterNode | public | function | Called before child nodes are visited. | Overrides NodeVisitorInterface::enterNode |
SandboxNodeVisitor::getPriority | public | function | Returns the priority for this visitor. | Overrides NodeVisitorInterface::getPriority |
SandboxNodeVisitor::leaveNode | public | function | Called after child nodes are visited. | Overrides NodeVisitorInterface::leaveNode |
SandboxNodeVisitor::wrapArrayNode | private | function | ||
SandboxNodeVisitor::wrapNode | private | function |