class Error
Same name in this branch
- 11.1.x vendor/phpunit/phpunit/src/Framework/TestStatus/Error.php \PHPUnit\Framework\TestStatus\Error
- 11.1.x vendor/nikic/php-parser/lib/PhpParser/Node/Expr/Error.php \PhpParser\Node\Expr\Error
- 11.1.x vendor/nikic/php-parser/lib/PhpParser/Error.php \PhpParser\Error
- 11.1.x core/lib/Drupal/Core/Utility/Error.php \Drupal\Core\Utility\Error
Twig base exception.
This exception class and its children must only be used when an error occurs during the loading of a template, when a syntax error is detected in a template, or when rendering a template. Other errors must use regular PHP exception classes (like when the template cache directory is not writable for instance).
To help debugging template issues, this class tracks the original template name and line where the error occurred.
Whenever possible, you must set these information (original template name and line number) yourself by passing them to the constructor. If some or all these information are not available from where you throw the exception, then this class will guess them automatically (when the line number is set to -1 and/or the name is set to null). As this is a costly operation, this can be disabled by passing false for both the name and the line number when creating a new instance of this class.
@author Fabien Potencier <fabien@symfony.com>
Hierarchy
- class \Twig\Error\Error extends \Twig\Error\Exception
Expanded class hierarchy of Error
4 files declare their use of Error
- Environment.php in vendor/
twig/ twig/ src/ Environment.php - IntegrationTestCase.php in vendor/
twig/ twig/ src/ Test/ IntegrationTestCase.php - SecurityError.php in vendor/
twig/ twig/ src/ Sandbox/ SecurityError.php - Template.php in vendor/
twig/ twig/ src/ Template.php
60 string references to 'Error'
- AbstractWebDriver::curl in vendor/
lullabot/ php-webdriver/ lib/ WebDriver/ AbstractWebDriver.php - Curl request to webdriver server.
- Application::doRun in vendor/
symfony/ console/ Application.php - Runs the current application.
- Auditor::audit in vendor/
composer/ composer/ src/ Composer/ Advisory/ Auditor.php - Checkstyle::generateFileReport in vendor/
squizlabs/ php_codesniffer/ src/ Reports/ Checkstyle.php - Generate a partial report for a single processed file.
- Code::generateFileReport in vendor/
squizlabs/ php_codesniffer/ src/ Reports/ Code.php - Generate a partial report for a single processed file.
File
-
vendor/
twig/ twig/ src/ Error/ Error.php, line 39
Namespace
Twig\ErrorView source
class Error extends \Exception {
private $lineno;
private $name;
private $rawMessage;
private $sourcePath;
private $sourceCode;
/**
* Constructor.
*
* By default, automatic guessing is enabled.
*
* @param string $message The error message
* @param int $lineno The template line where the error occurred
* @param Source|null $source The source context where the error occurred
*/
public function __construct(string $message, int $lineno = -1, ?Source $source = null, ?\Throwable $previous = null) {
parent::__construct('', 0, $previous);
if (null === $source) {
$name = null;
}
else {
$name = $source->getName();
$this->sourceCode = $source->getCode();
$this->sourcePath = $source->getPath();
}
$this->lineno = $lineno;
$this->name = $name;
$this->rawMessage = $message;
$this->updateRepr();
}
public function getRawMessage() : string {
return $this->rawMessage;
}
public function getTemplateLine() : int {
return $this->lineno;
}
public function setTemplateLine(int $lineno) : void {
$this->lineno = $lineno;
$this->updateRepr();
}
public function getSourceContext() : ?Source {
return $this->name ? new Source($this->sourceCode, $this->name, $this->sourcePath) : null;
}
public function setSourceContext(?Source $source = null) : void {
if (null === $source) {
$this->sourceCode = $this->name = $this->sourcePath = null;
}
else {
$this->sourceCode = $source->getCode();
$this->name = $source->getName();
$this->sourcePath = $source->getPath();
}
$this->updateRepr();
}
public function guess() : void {
$this->guessTemplateInfo();
$this->updateRepr();
}
public function appendMessage($rawMessage) : void {
$this->rawMessage .= $rawMessage;
$this->updateRepr();
}
private function updateRepr() : void {
$this->message = $this->rawMessage;
if ($this->sourcePath && $this->lineno > 0) {
$this->file = $this->sourcePath;
$this->line = $this->lineno;
return;
}
$dot = false;
if (str_ends_with($this->message, '.')) {
$this->message = substr($this->message, 0, -1);
$dot = true;
}
$questionMark = false;
if (str_ends_with($this->message, '?')) {
$this->message = substr($this->message, 0, -1);
$questionMark = true;
}
if ($this->name) {
if (\is_string($this->name) || $this->name instanceof \Stringable) {
$name = \sprintf('"%s"', $this->name);
}
else {
$name = json_encode($this->name);
}
$this->message .= \sprintf(' in %s', $name);
}
if ($this->lineno && $this->lineno >= 0) {
$this->message .= \sprintf(' at line %d', $this->lineno);
}
if ($dot) {
$this->message .= '.';
}
if ($questionMark) {
$this->message .= '?';
}
}
private function guessTemplateInfo() : void {
$template = null;
$templateClass = null;
$backtrace = debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS | \DEBUG_BACKTRACE_PROVIDE_OBJECT);
foreach ($backtrace as $trace) {
if (isset($trace['object']) && $trace['object'] instanceof Template) {
$currentClass = \get_class($trace['object']);
$isEmbedContainer = null === $templateClass ? false : str_starts_with($templateClass, $currentClass);
if (null === $this->name || $this->name == $trace['object']->getTemplateName() && !$isEmbedContainer) {
$template = $trace['object'];
$templateClass = \get_class($trace['object']);
}
}
}
// update template name
if (null !== $template && null === $this->name) {
$this->name = $template->getTemplateName();
}
// update template path if any
if (null !== $template && null === $this->sourcePath) {
$src = $template->getSourceContext();
$this->sourceCode = $src->getCode();
$this->sourcePath = $src->getPath();
}
if (null === $template || $this->lineno > -1) {
return;
}
$r = new \ReflectionObject($template);
$file = $r->getFileName();
$exceptions = [
$e = $this,
];
while ($e = $e->getPrevious()) {
$exceptions[] = $e;
}
while ($e = array_pop($exceptions)) {
$traces = $e->getTrace();
array_unshift($traces, [
'file' => $e->getFile(),
'line' => $e->getLine(),
]);
while ($trace = array_shift($traces)) {
if (!isset($trace['file']) || !isset($trace['line']) || $file != $trace['file']) {
continue;
}
foreach ($template->getDebugInfo() as $codeLine => $templateLine) {
if ($codeLine <= $trace['line']) {
// update template line
$this->lineno = $templateLine;
return;
}
}
}
}
}
}
Members
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
Error::$lineno | private | property | |
Error::$name | private | property | |
Error::$rawMessage | private | property | |
Error::$sourceCode | private | property | |
Error::$sourcePath | private | property | |
Error::appendMessage | public | function | |
Error::getRawMessage | public | function | |
Error::getSourceContext | public | function | |
Error::getTemplateLine | public | function | |
Error::guess | public | function | |
Error::guessTemplateInfo | private | function | |
Error::setSourceContext | public | function | |
Error::setTemplateLine | public | function | |
Error::updateRepr | private | function | |
Error::__construct | public | function | Constructor. |