class Twig_Compiler in Zircon Profile 8

Compiles a node to PHP code.

@author Fabien Potencier <[e-mail]>

Hierarchy

• class \Twig_Compiler implements Twig_CompilerInterface

File

vendor/twig/twig/lib/Twig/Compiler.php, line 18

class Twig_Compiler implements Twig_CompilerInterface {
  protected $lastLine;
  protected $source;
  protected $indentation;
  protected $env;
  protected $debugInfo = array();
  protected $sourceOffset;
  protected $sourceLine;
  protected $filename;

  /**
   * Constructor.
   *
   * @param Twig_Environment $env The twig environment instance
   */
  public function __construct(Twig_Environment $env) {
    $this->env = $env;
  }
  public function getFilename() {
    return $this->filename;
  }

  /**
   * Returns the environment instance related to this compiler.
   *
   * @return Twig_Environment The environment instance
   */
  public function getEnvironment() {
    return $this->env;
  }

  /**
   * Gets the current PHP code after compilation.
   *
   * @return string The PHP code
   */
  public function getSource() {
    return $this->source;
  }

  /**
   * Compiles a node.
   *
   * @param Twig_NodeInterface $node        The node to compile
   * @param int                $indentation The current indentation
   *
   * @return Twig_Compiler The current compiler instance
   */
  public function compile(Twig_NodeInterface $node, $indentation = 0) {
    $this->lastLine = null;
    $this->source = '';
    $this->debugInfo = array();
    $this->sourceOffset = 0;

    // source code starts at 1 (as we then increment it when we encounter new lines)
    $this->sourceLine = 1;
    $this->indentation = $indentation;
    if ($node instanceof Twig_Node_Module) {
      $this->filename = $node
        ->getAttribute('filename');
    }
    $node
      ->compile($this);
    return $this;
  }
  public function subcompile(Twig_NodeInterface $node, $raw = true) {
    if (false === $raw) {
      $this
        ->addIndentation();
    }
    $node
      ->compile($this);
    return $this;
  }

  /**
   * Adds a raw string to the compiled code.
   *
   * @param string $string The string
   *
   * @return Twig_Compiler The current compiler instance
   */
  public function raw($string) {
    $this->source .= $string;
    return $this;
  }

  /**
   * Writes a string to the compiled code by adding indentation.
   *
   * @return Twig_Compiler The current compiler instance
   */
  public function write() {
    $strings = func_get_args();
    foreach ($strings as $string) {
      $this
        ->addIndentation();
      $this->source .= $string;
    }
    return $this;
  }

  /**
   * Appends an indentation to the current PHP code after compilation.
   *
   * @return Twig_Compiler The current compiler instance
   */
  public function addIndentation() {
    $this->source .= str_repeat(' ', $this->indentation * 4);
    return $this;
  }

  /**
   * Adds a quoted string to the compiled code.
   *
   * @param string $value The string
   *
   * @return Twig_Compiler The current compiler instance
   */
  public function string($value) {
    $this->source .= sprintf('"%s"', addcslashes($value, "\0\t\"\$\\"));
    return $this;
  }

  /**
   * Returns a PHP representation of a given value.
   *
   * @param mixed $value The value to convert
   *
   * @return Twig_Compiler The current compiler instance
   */
  public function repr($value) {
    if (is_int($value) || is_float($value)) {
      if (false !== ($locale = setlocale(LC_NUMERIC, 0))) {
        setlocale(LC_NUMERIC, 'C');
      }
      $this
        ->raw($value);
      if (false !== $locale) {
        setlocale(LC_NUMERIC, $locale);
      }
    }
    elseif (null === $value) {
      $this
        ->raw('null');
    }
    elseif (is_bool($value)) {
      $this
        ->raw($value ? 'true' : 'false');
    }
    elseif (is_array($value)) {
      $this
        ->raw('array(');
      $first = true;
      foreach ($value as $key => $v) {
        if (!$first) {
          $this
            ->raw(', ');
        }
        $first = false;
        $this
          ->repr($key);
        $this
          ->raw(' => ');
        $this
          ->repr($v);
      }
      $this
        ->raw(')');
    }
    else {
      $this
        ->string($value);
    }
    return $this;
  }

  /**
   * Adds debugging information.
   *
   * @param Twig_NodeInterface $node The related twig node
   *
   * @return Twig_Compiler The current compiler instance
   */
  public function addDebugInfo(Twig_NodeInterface $node) {
    if ($node
      ->getLine() != $this->lastLine) {
      $this
        ->write(sprintf("// line %d\n", $node
        ->getLine()));

      // when mbstring.func_overload is set to 2
      // mb_substr_count() replaces substr_count()
      // but they have different signatures!
      if ((int) ini_get('mbstring.func_overload') & 2) {

        // this is much slower than the "right" version
        $this->sourceLine += mb_substr_count(mb_substr($this->source, $this->sourceOffset), "\n");
      }
      else {
        $this->sourceLine += substr_count($this->source, "\n", $this->sourceOffset);
      }
      $this->sourceOffset = strlen($this->source);
      $this->debugInfo[$this->sourceLine] = $node
        ->getLine();
      $this->lastLine = $node
        ->getLine();
    }
    return $this;
  }
  public function getDebugInfo() {
    ksort($this->debugInfo);
    return $this->debugInfo;
  }

  /**
   * Indents the generated code.
   *
   * @param int $step The number of indentation to add
   *
   * @return Twig_Compiler The current compiler instance
   */
  public function indent($step = 1) {
    $this->indentation += $step;
    return $this;
  }

  /**
   * Outdents the generated code.
   *
   * @param int $step The number of indentation to remove
   *
   * @return Twig_Compiler The current compiler instance
   *
   * @throws LogicException When trying to outdent too much so the indentation would become negative
   */
  public function outdent($step = 1) {

    // can't outdent by more steps than the current indentation level
    if ($this->indentation < $step) {
      throw new LogicException('Unable to call outdent() as the indentation would become negative');
    }
    $this->indentation -= $step;
    return $this;
  }
  public function getVarName() {
    return sprintf('__internal_%s', hash('sha256', uniqid(mt_rand(), true), false));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Twig_Compiler::$debugInfo	protected	property
Twig_Compiler::$env	protected	property
Twig_Compiler::$filename	protected	property
Twig_Compiler::$indentation	protected	property
Twig_Compiler::$lastLine	protected	property
Twig_Compiler::$source	protected	property
Twig_Compiler::$sourceLine	protected	property
Twig_Compiler::$sourceOffset	protected	property
Twig_Compiler::addDebugInfo	public	function	Adds debugging information.
Twig_Compiler::addIndentation	public	function	Appends an indentation to the current PHP code after compilation.
Twig_Compiler::compile	public	function	Compiles a node. Overrides Twig_CompilerInterface::compile
Twig_Compiler::getDebugInfo	public	function
Twig_Compiler::getEnvironment	public	function	Returns the environment instance related to this compiler.
Twig_Compiler::getFilename	public	function
Twig_Compiler::getSource	public	function	Gets the current PHP code after compilation. Overrides Twig_CompilerInterface::getSource
Twig_Compiler::getVarName	public	function
Twig_Compiler::indent	public	function	Indents the generated code.
Twig_Compiler::outdent	public	function	Outdents the generated code.
Twig_Compiler::raw	public	function	Adds a raw string to the compiled code.
Twig_Compiler::repr	public	function	Returns a PHP representation of a given value.
Twig_Compiler::string	public	function	Adds a quoted string to the compiled code.
Twig_Compiler::subcompile	public	function
Twig_Compiler::write	public	function	Writes a string to the compiled code by adding indentation.
Twig_Compiler::__construct	public	function	Constructor.