class Compiler
Same name in this branch
- 11.1.x vendor/composer/composer/src/Composer/Compiler.php \Composer\Compiler
- 11.1.x vendor/symfony/dependency-injection/Compiler/Compiler.php \Symfony\Component\DependencyInjection\Compiler\Compiler
@author Fabien Potencier <fabien@symfony.com>
Hierarchy
- class \Twig\Compiler
Expanded class hierarchy of Compiler
99 files declare their use of Compiler
- AbstractBinary.php in vendor/
twig/ twig/ src/ Node/ Expression/ Binary/ AbstractBinary.php - AbstractUnary.php in vendor/
twig/ twig/ src/ Node/ Expression/ Unary/ AbstractUnary.php - AddBinary.php in vendor/
twig/ twig/ src/ Node/ Expression/ Binary/ AddBinary.php - AndBinary.php in vendor/
twig/ twig/ src/ Node/ Expression/ Binary/ AndBinary.php - ArrayExpression.php in vendor/
twig/ twig/ src/ Node/ Expression/ ArrayExpression.php
File
-
vendor/
twig/ twig/ src/ Compiler.php, line 20
Namespace
TwigView source
class Compiler {
private $lastLine;
private $source;
private $indentation;
private $debugInfo = [];
private $sourceOffset;
private $sourceLine;
private $varNameSalt = 0;
private $didUseEcho = false;
private $didUseEchoStack = [];
public function __construct(Environment $env) {
}
public function getEnvironment() : Environment {
return $this->env;
}
public function getSource() : string {
return $this->source;
}
/**
* @return $this
*/
public function reset(int $indentation = 0) {
$this->lastLine = null;
$this->source = '';
$this->debugInfo = [];
$this->sourceOffset = 0;
// source code starts at 1 (as we then increment it when we encounter new lines)
$this->sourceLine = 1;
$this->indentation = $indentation;
$this->varNameSalt = 0;
return $this;
}
/**
* @return $this
*/
public function compile(Node $node, int $indentation = 0) {
$this->reset($indentation);
$this->didUseEchoStack[] = $this->didUseEcho;
try {
$this->didUseEcho = false;
$node->compile($this);
if ($this->didUseEcho) {
trigger_deprecation('twig/twig', '3.9', 'Using "%s" is deprecated, use "yield" instead in "%s", then flag the class with #[\\Twig\\Attribute\\YieldReady].', $this->didUseEcho, \get_class($node));
}
return $this;
} finally {
$this->didUseEcho = array_pop($this->didUseEchoStack);
}
}
/**
* @return $this
*/
public function subcompile(Node $node, bool $raw = true) {
if (!$raw) {
$this->source .= str_repeat(' ', $this->indentation * 4);
}
$this->didUseEchoStack[] = $this->didUseEcho;
try {
$this->didUseEcho = false;
$node->compile($this);
if ($this->didUseEcho) {
trigger_deprecation('twig/twig', '3.9', 'Using "%s" is deprecated, use "yield" instead in "%s", then flag the class with #[\\Twig\\Attribute\\YieldReady].', $this->didUseEcho, \get_class($node));
}
return $this;
} finally {
$this->didUseEcho = array_pop($this->didUseEchoStack);
}
}
/**
* Adds a raw string to the compiled code.
*
* @return $this
*/
public function raw(string $string) {
$this->checkForEcho($string);
$this->source .= $string;
return $this;
}
/**
* Writes a string to the compiled code by adding indentation.
*
* @return $this
*/
public function write(...$strings) {
foreach ($strings as $string) {
$this->checkForEcho($string);
$this->source .= str_repeat(' ', $this->indentation * 4) . $string;
}
return $this;
}
/**
* Adds a quoted string to the compiled code.
*
* @return $this
*/
public function string(string $value) {
$this->source .= \sprintf('"%s"', addcslashes($value, "\x00\t\"\$\\"));
return $this;
}
/**
* Returns a PHP representation of a given value.
*
* @return $this
*/
public function repr($value) {
if (\is_int($value) || \is_float($value)) {
if (false !== ($locale = setlocale(\LC_NUMERIC, '0'))) {
setlocale(\LC_NUMERIC, 'C');
}
$this->raw(var_export($value, true));
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;
}
/**
* @return $this
*/
public function addDebugInfo(Node $node) {
if ($node->getTemplateLine() != $this->lastLine) {
$this->write(\sprintf("// line %d\n", $node->getTemplateLine()));
$this->sourceLine += substr_count($this->source, "\n", $this->sourceOffset);
$this->sourceOffset = \strlen($this->source);
$this->debugInfo[$this->sourceLine] = $node->getTemplateLine();
$this->lastLine = $node->getTemplateLine();
}
return $this;
}
public function getDebugInfo() : array {
ksort($this->debugInfo);
return $this->debugInfo;
}
/**
* @return $this
*/
public function indent(int $step = 1) {
$this->indentation += $step;
return $this;
}
/**
* @return $this
*
* @throws \LogicException When trying to outdent too much so the indentation would become negative
*/
public function outdent(int $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() : string {
return \sprintf('_v%d', $this->varNameSalt++);
}
private function checkForEcho(string $string) : void {
if ($this->didUseEcho) {
return;
}
$this->didUseEcho = preg_match('/^\\s*+(echo|print)\\b/', $string, $m) ? $m[1] : false;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
Compiler::$debugInfo | private | property | |
Compiler::$didUseEcho | private | property | |
Compiler::$didUseEchoStack | private | property | |
Compiler::$indentation | private | property | |
Compiler::$lastLine | private | property | |
Compiler::$source | private | property | |
Compiler::$sourceLine | private | property | |
Compiler::$sourceOffset | private | property | |
Compiler::$varNameSalt | private | property | |
Compiler::addDebugInfo | public | function | |
Compiler::checkForEcho | private | function | |
Compiler::compile | public | function | |
Compiler::getDebugInfo | public | function | |
Compiler::getEnvironment | public | function | |
Compiler::getSource | public | function | |
Compiler::getVarName | public | function | |
Compiler::indent | public | function | |
Compiler::outdent | public | function | |
Compiler::raw | public | function | Adds a raw string to the compiled code. |
Compiler::repr | public | function | Returns a PHP representation of a given value. |
Compiler::reset | public | function | |
Compiler::string | public | function | Adds a quoted string to the compiled code. |
Compiler::subcompile | public | function | |
Compiler::write | public | function | Writes a string to the compiled code by adding indentation. |
Compiler::__construct | public | function |