/vendor/twig/twig/lib/Twig/Error.php
PHP | 267 lines | 154 code | 38 blank | 75 comment | 42 complexity | dd537f74157a45c0e45005cc861fbd56 MD5 | raw file
- <?php
- /*
- * This file is part of Twig.
- *
- * (c) Fabien Potencier
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- /**
- * 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>
- */
- class Twig_Error extends Exception
- {
- private $lineno;
- private $name;
- private $rawMessage;
- private $sourcePath;
- private $sourceCode;
- /**
- * Constructor.
- *
- * Set both the line number and the name to false to
- * disable automatic guessing of the original template name
- * and line number.
- *
- * Set the line number to -1 to enable its automatic guessing.
- * Set the name to null to enable its automatic guessing.
- *
- * By default, automatic guessing is enabled.
- *
- * @param string $message The error message
- * @param int $lineno The template line where the error occurred
- * @param Twig_Source|string|null $source The source context where the error occurred
- * @param Exception $previous The previous exception
- */
- public function __construct($message, $lineno = -1, $source = null, Exception $previous = null)
- {
- parent::__construct('', 0, $previous);
- if (null === $source) {
- $name = null;
- } elseif (!$source instanceof Twig_Source) {
- // for compat with the Twig C ext., passing the template name as string is accepted
- $name = $source;
- } else {
- $name = $source->getName();
- $this->sourceCode = $source->getCode();
- $this->sourcePath = $source->getPath();
- }
- $this->lineno = $lineno;
- $this->name = $name;
- if (-1 === $lineno || null === $name || null === $this->sourcePath) {
- $this->guessTemplateInfo();
- }
- $this->rawMessage = $message;
- $this->updateRepr();
- }
- /**
- * Gets the raw message.
- *
- * @return string The raw message
- */
- public function getRawMessage()
- {
- return $this->rawMessage;
- }
- /**
- * Gets the template line where the error occurred.
- *
- * @return int The template line
- */
- public function getTemplateLine()
- {
- return $this->lineno;
- }
- /**
- * Sets the template line where the error occurred.
- *
- * @param int $lineno The template line
- */
- public function setTemplateLine($lineno)
- {
- $this->lineno = $lineno;
- $this->updateRepr();
- }
- /**
- * Gets the source context of the Twig template where the error occurred.
- *
- * @return Twig_Source|null
- */
- public function getSourceContext()
- {
- return $this->name ? new Twig_Source($this->sourceCode, $this->name, $this->sourcePath) : null;
- }
- /**
- * Sets the source context of the Twig template where the error occurred.
- */
- public function setSourceContext(Twig_Source $source = null)
- {
- 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()
- {
- $this->guessTemplateInfo();
- $this->updateRepr();
- }
- public function appendMessage($rawMessage)
- {
- $this->rawMessage .= $rawMessage;
- $this->updateRepr();
- }
- private function updateRepr()
- {
- $this->message = $this->rawMessage;
- if ($this->sourcePath && $this->lineno > 0) {
- $this->file = $this->sourcePath;
- $this->line = $this->lineno;
- return;
- }
- $dot = false;
- if ('.' === substr($this->message, -1)) {
- $this->message = substr($this->message, 0, -1);
- $dot = true;
- }
- $questionMark = false;
- if ('?' === substr($this->message, -1)) {
- $this->message = substr($this->message, 0, -1);
- $questionMark = true;
- }
- if ($this->name) {
- if (is_string($this->name) || (is_object($this->name) && method_exists($this->name, '__toString'))) {
- $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()
- {
- $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 Twig_Template && 'Twig_Template' !== get_class($trace['object'])) {
- $currentClass = get_class($trace['object']);
- $isEmbedContainer = 0 === strpos($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();
- // hhvm has a bug where eval'ed files comes out as the current directory
- if (is_dir($file)) {
- $file = '';
- }
- $exceptions = array($e = $this);
- while ($e = $e->getPrevious()) {
- $exceptions[] = $e;
- }
- while ($e = array_pop($exceptions)) {
- $traces = $e->getTrace();
- array_unshift($traces, array('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;
- }
- }
- }
- }
- }
- }