class Twig_Node_SandboxedModule in Translation template extractor 6.3

Represents a module node.

@author Fabien Potencier <[e-mail]>

Hierarchy

• class \Twig_Node implements Twig_NodeInterface
  • class \Twig_Node_Module
    • class \Twig_Node_SandboxedModule

File

vendor/Twig/Node/SandboxedModule.php, line 18

class Twig_Node_SandboxedModule extends Twig_Node_Module {
  protected $usedFilters;
  protected $usedTags;
  protected $usedFunctions;
  public function __construct(Twig_Node_Module $node, array $usedFilters, array $usedTags, array $usedFunctions) {
    parent::__construct($node
      ->getNode('body'), $node
      ->getNode('parent'), $node
      ->getNode('blocks'), $node
      ->getNode('macros'), $node
      ->getNode('traits'), $node
      ->getAttribute('embedded_templates'), $node
      ->getAttribute('filename'));
    $this
      ->setAttribute('index', $node
      ->getAttribute('index'));
    $this->usedFilters = $usedFilters;
    $this->usedTags = $usedTags;
    $this->usedFunctions = $usedFunctions;
  }
  protected function compileDisplayBody(Twig_Compiler $compiler) {
    $compiler
      ->write("\$this->checkSecurity();\n");
    parent::compileDisplayBody($compiler);
  }
  protected function compileDisplayFooter(Twig_Compiler $compiler) {
    parent::compileDisplayFooter($compiler);
    $tags = $filters = $functions = array();
    foreach (array(
      'tags',
      'filters',
      'functions',
    ) as $type) {
      foreach ($this->{'used' . ucfirst($type)} as $name => $node) {
        if ($node instanceof Twig_Node) {
          ${$type}[$name] = $node
            ->getLine();
        }
        else {
          ${$type}[$node] = null;
        }
      }
    }
    $compiler
      ->write("protected function checkSecurity()\n", "{\n")
      ->indent()
      ->write("\$tags = ")
      ->repr(array_filter($tags))
      ->raw(";\n")
      ->write("\$filters = ")
      ->repr(array_filter($filters))
      ->raw(";\n")
      ->write("\$functions = ")
      ->repr(array_filter($functions))
      ->raw(";\n\n")
      ->write("try {\n")
      ->indent()
      ->write("\$this->env->getExtension('sandbox')->checkSecurity(\n")
      ->indent()
      ->write(!$tags ? "array(),\n" : "array('" . implode("', '", array_keys($tags)) . "'),\n")
      ->write(!$filters ? "array(),\n" : "array('" . implode("', '", array_keys($filters)) . "'),\n")
      ->write(!$functions ? "array()\n" : "array('" . implode("', '", array_keys($functions)) . "')\n")
      ->outdent()
      ->write(");\n")
      ->outdent()
      ->write("} catch (Twig_Sandbox_SecurityError \$e) {\n")
      ->indent()
      ->write("\$e->setTemplateFile(\$this->getTemplateName());\n\n")
      ->write("if (\$e instanceof Twig_Sandbox_SecurityNotAllowedTagError && isset(\$tags[\$e->getTagName()])) {\n")
      ->indent()
      ->write("\$e->setTemplateLine(\$tags[\$e->getTagName()]);\n")
      ->outdent()
      ->write("} elseif (\$e instanceof Twig_Sandbox_SecurityNotAllowedFilterError && isset(\$filters[\$e->getFilterName()])) {\n")
      ->indent()
      ->write("\$e->setTemplateLine(\$filters[\$e->getFilterName()]);\n")
      ->outdent()
      ->write("} elseif (\$e instanceof Twig_Sandbox_SecurityNotAllowedFunctionError && isset(\$functions[\$e->getFunctionName()])) {\n")
      ->indent()
      ->write("\$e->setTemplateLine(\$functions[\$e->getFunctionName()]);\n")
      ->outdent()
      ->write("}\n\n")
      ->write("throw \$e;\n")
      ->outdent()
      ->write("}\n")
      ->outdent()
      ->write("}\n\n");
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Twig_Node::$attributes	protected	property
Twig_Node::$lineno	protected	property
Twig_Node::$nodes	protected	property
Twig_Node::$tag	protected	property
Twig_Node::count	public	function
Twig_Node::getAttribute	public	function	Gets an attribute.
Twig_Node::getIterator	public	function
Twig_Node::getLine	public	function	Overrides Twig_NodeInterface::getLine
Twig_Node::getNode	public	function	Gets a node by name.
Twig_Node::getNodeTag	public	function	Overrides Twig_NodeInterface::getNodeTag
Twig_Node::hasAttribute	public	function	Returns true if the attribute is defined.
Twig_Node::hasNode	public	function	Returns true if the node with the given identifier exists.
Twig_Node::removeAttribute	public	function	Removes an attribute.
Twig_Node::removeNode	public	function	Removes a node by name.
Twig_Node::setAttribute	public	function	Sets an attribute.
Twig_Node::setNode	public	function	Sets a node.
Twig_Node::toXml Deprecated	public	function
Twig_Node::__toString	public	function
Twig_Node_Module::compile	public	function	Compiles the node to PHP. Overrides Twig_Node::compile
Twig_Node_Module::compileClassFooter	protected	function
Twig_Node_Module::compileClassHeader	protected	function
Twig_Node_Module::compileConstructor	protected	function
Twig_Node_Module::compileDebugInfo	protected	function
Twig_Node_Module::compileDisplayHeader	protected	function
Twig_Node_Module::compileGetParent	protected	function
Twig_Node_Module::compileGetTemplateName	protected	function
Twig_Node_Module::compileIsTraitable	protected	function
Twig_Node_Module::compileLoadTemplate	protected	function
Twig_Node_Module::compileMacros	protected	function
Twig_Node_Module::compileTemplate	protected	function
Twig_Node_Module::setIndex	public	function
Twig_Node_SandboxedModule::$usedFilters	protected	property
Twig_Node_SandboxedModule::$usedFunctions	protected	property
Twig_Node_SandboxedModule::$usedTags	protected	property
Twig_Node_SandboxedModule::compileDisplayBody	protected	function	Overrides Twig_Node_Module::compileDisplayBody
Twig_Node_SandboxedModule::compileDisplayFooter	protected	function	Overrides Twig_Node_Module::compileDisplayFooter
Twig_Node_SandboxedModule::__construct	public	function	Constructor. Overrides Twig_Node_Module::__construct