Twig_Error Class Reference

Twig base exception. More...

Inheritance diagram for Twig_Error:

Collaboration diagram for Twig_Error:

Public Member Functions
	__construct ($message, $lineno=-1, $source=null, Exception $previous=null)
	Constructor. More...
	getRawMessage ()
	Gets the raw message. More...
	getTemplateFile ()
	Gets the logical name where the error occurred. More...
	setTemplateFile ($name)
	Sets the logical name where the error occurred. More...
	getTemplateName ()
	Gets the logical name where the error occurred. More...
	setTemplateName ($name)
	Sets the logical name where the error occurred. More...
	getTemplateLine ()
	Gets the template line where the error occurred. More...
	setTemplateLine ($lineno)
	Sets the template line where the error occurred. More...
	getSourceContext ()
	Gets the source context of the Twig template where the error occurred. More...
	setSourceContext (Twig_Source $source=null)
	Sets the source context of the Twig template where the error occurred. More...
	guess ()
	__call ($method, $arguments)
	For PHP < 5.3.0, provides access to the getPrevious() method. More...
	appendMessage ($rawMessage)

Protected Member Functions
	updateRepr ()
	guessTemplateInfo ()

Protected Attributes
	$lineno
	$filename
	$rawMessage
	$previous

Private Attributes
	$sourcePath
	$sourceCode

Detailed Description

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 fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

Definition at line 34 of file Error.php.

Constructor & Destructor Documentation

__construct()

Twig_Error::__construct	(		$message,
			$lineno = -1,
			$source = null,
		Exception	$previous = null
	)

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.

Parameters

string	$message	The error message
int	$lineno	The template line where the error occurred
Twig_Source | string | null	$source	The source context where the error occurred
Exception	$previous	The previous exception

Definition at line 62 of file Error.php.

References $lineno, $message, $name, $previous, $source, guessTemplateInfo(), and updateRepr().

    {
        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();
        }
        if (PHP_VERSION_ID < 50300) {
            $this->previous = $previous;
            parent::__construct('');
        } else {
            parent::__construct('', 0, $previous);
        }

        $this->lineno = $lineno;
        $this->filename = $name;

        if (-1 === $lineno || null === $name || null === $this->sourcePath) {
            $this->guessTemplateInfo();
        }

        $this->rawMessage = $message;

        $this->updateRepr();
    }

Here is the call graph for this function:

Member Function Documentation

__call()

Twig_Error::__call	(		$method,
			$arguments
	)

For PHP < 5.3.0, provides access to the getPrevious() method.

Parameters

string	$method	The method name
array	$arguments	The parameters to be passed to the method

Returns

Exception The previous exception or null

Exceptions

BadMethodCallException

Definition at line 228 of file Error.php.

References $previous.

    {
        if ('getprevious' == strtolower($method)) {
            return $this->previous;
        }

        throw new BadMethodCallException(sprintf('Method "Twig_Error::%s()" does not exist.', $method));
    }

appendMessage()

Twig_Error::appendMessage

(

$rawMessage

)

Definition at line 237 of file Error.php.

References $rawMessage, and updateRepr().

Referenced by Twig_Error_Loader\__construct(), Twig_Error_Syntax\addSuggestions(), and Twig_Parser\subparse().

    {
        $this->rawMessage .= $rawMessage;
        $this->updateRepr();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRawMessage()

Twig_Error::getRawMessage

(

)

Gets the raw message.

Returns

string The raw message

Definition at line 98 of file Error.php.

References $rawMessage.

    {
        return $this->rawMessage;
    }

getSourceContext()

Twig_Error::getSourceContext

(

)

Gets the source context of the Twig template where the error occurred.

Returns

Twig_Source|null

Definition at line 191 of file Error.php.

Referenced by Twig_Template\displayBlock(), Twig_Template\displayWithErrorHandling(), Twig_Template\loadTemplate(), Twig_Parser\parse(), Twig_Tests_ErrorTest\testTwigExceptionAddsFileAndLine(), Twig_Tests_ErrorTest\testTwigExceptionGuessWithExceptionAndArrayLoader(), Twig_Tests_ErrorTest\testTwigExceptionGuessWithExceptionAndFilesystemLoader(), Twig_Tests_ErrorTest\testTwigExceptionGuessWithMissingVarAndArrayLoader(), and Twig_Tests_ErrorTest\testTwigExceptionGuessWithMissingVarAndFilesystemLoader().

    {
        return $this->filename ? new Twig_Source($this->sourceCode, $this->filename, $this->sourcePath) : null;
    }

Here is the caller graph for this function:

getTemplateFile()

Twig_Error::getTemplateFile

(

)

Gets the logical name where the error occurred.

Returns

string The name

Deprecated:

since 1.27 (to be removed in 2.0). Use getSourceContext() instead.

Definition at line 110 of file Error.php.

References $filename.

    {
        @trigger_error(sprintf('The "%s" method is deprecated since version 1.27 and will be removed in 2.0. Use getSourceContext() instead.', __METHOD__), E_USER_DEPRECATED);

        return $this->filename;
    }

getTemplateLine()

Twig_Error::getTemplateLine

(

)

Gets the template line where the error occurred.

Returns

int The template line

Definition at line 169 of file Error.php.

References $lineno.

Referenced by Twig_Template\displayBlock(), Twig_Template\displayWithErrorHandling(), Twig_Template\loadTemplate(), Twig_Parser\parse(), Twig_Tests_ErrorTest\testTwigExceptionAddsFileAndLine(), Twig_Tests_ErrorTest\testTwigExceptionGuessWithExceptionAndArrayLoader(), Twig_Tests_ErrorTest\testTwigExceptionGuessWithExceptionAndFilesystemLoader(), Twig_Tests_ErrorTest\testTwigExceptionGuessWithMissingVarAndArrayLoader(), and Twig_Tests_ErrorTest\testTwigExceptionGuessWithMissingVarAndFilesystemLoader().

    {
        return $this->lineno;
    }

Here is the caller graph for this function:

getTemplateName()

Twig_Error::getTemplateName

(

)

Gets the logical name where the error occurred.

Returns

string The name

Deprecated:

since 1.29 (to be removed in 2.0). Use getSourceContext() instead.

Definition at line 140 of file Error.php.

References $filename.

Referenced by guessTemplateInfo().

    {
        @trigger_error(sprintf('The "%s" method is deprecated since version 1.29 and will be removed in 2.0. Use getSourceContext() instead.', __METHOD__), E_USER_DEPRECATED);

        return $this->filename;
    }

Here is the caller graph for this function:

guess()

Twig_Error::guess

(

)

Definition at line 212 of file Error.php.

References guessTemplateInfo(), and updateRepr().

Referenced by Twig_Template\displayBlock(), Twig_Template\displayWithErrorHandling(), Twig_Template\getParent(), and Twig_Template\loadTemplate().

    {
        $this->guessTemplateInfo();
        $this->updateRepr();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

guessTemplateInfo()

Twig_Error::guessTemplateInfo ( )

protected

Definition at line 294 of file Error.php.

References $exceptions, $r, $template, and getTemplateName().

Referenced by __construct(), and guess().

    {
        $template = null;
        $templateClass = null;

        if (PHP_VERSION_ID >= 50306) {
            $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS | DEBUG_BACKTRACE_PROVIDE_OBJECT);
        } else {
            $backtrace = debug_backtrace();
        }

        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->filename || ($this->filename == $trace['object']->getTemplateName() && !$isEmbedContainer)) {
                    $template = $trace['object'];
                    $templateClass = get_class($trace['object']);
                }
            }
        }

        // update template name
        if (null !== $template && null === $this->filename) {
            $this->filename = $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 = array($e = $this);
        while (($e instanceof self || method_exists($e, 'getPrevious')) && $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;
                    }
                }
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setSourceContext()

Twig_Error::setSourceContext

(

Twig_Source

$source = null

)

Sets the source context of the Twig template where the error occurred.

Definition at line 199 of file Error.php.

References $source, and updateRepr().

Referenced by Twig_Environment\compileSource(), Twig_Template\displayBlock(), Twig_Template\displayWithErrorHandling(), Twig_Template\getParent(), Twig_Template\loadTemplate(), and Twig_Parser\parse().

    {
        if (null === $source) {
            $this->sourceCode = $this->filename = $this->sourcePath = null;
        } else {
            $this->sourceCode = $source->getCode();
            $this->filename = $source->getName();
            $this->sourcePath = $source->getPath();
        }

        $this->updateRepr();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setTemplateFile()

Twig_Error::setTemplateFile

(

$name

)

Sets the logical name where the error occurred.

Parameters

string

$name

The name

Deprecated:

since 1.27 (to be removed in 2.0). Use setSourceContext() instead.

Definition at line 124 of file Error.php.

References $name, and updateRepr().

    {
        @trigger_error(sprintf('The "%s" method is deprecated since version 1.27 and will be removed in 2.0. Use setSourceContext() instead.', __METHOD__), E_USER_DEPRECATED);

        $this->filename = $name;

        $this->updateRepr();
    }

Here is the call graph for this function:

setTemplateLine()

Twig_Error::setTemplateLine

(

$lineno

)

Sets the template line where the error occurred.

Parameters

int

$lineno

The template line

Definition at line 179 of file Error.php.

References $lineno, and updateRepr().

Referenced by Twig_Error_Loader\__construct(), Twig_Template\displayBlock(), Twig_Template\displayWithErrorHandling(), Twig_Template\loadTemplate(), and Twig_Parser\parse().

    {
        $this->lineno = $lineno;

        $this->updateRepr();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setTemplateName()

Twig_Error::setTemplateName

(

$name

)

Sets the logical name where the error occurred.

Parameters

string

$name

The name

Deprecated:

since 1.29 (to be removed in 2.0). Use setSourceContext() instead.

Definition at line 154 of file Error.php.

References $name, and updateRepr().

    {
        @trigger_error(sprintf('The "%s" method is deprecated since version 1.29 and will be removed in 2.0. Use setSourceContext() instead.', __METHOD__), E_USER_DEPRECATED);

        $this->filename = $name;
        $this->sourceCode = $this->sourcePath = null;

        $this->updateRepr();
    }

Here is the call graph for this function:

updateRepr()

Twig_Error::updateRepr ( )

protected

Definition at line 246 of file Error.php.

References $lineno, $name, $rawMessage, and $sourcePath.

Referenced by __construct(), appendMessage(), guess(), setSourceContext(), setTemplateFile(), setTemplateLine(), and setTemplateName().

    {
        $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->filename) {
            if (is_string($this->filename) || (is_object($this->filename) && method_exists($this->filename, '__toString'))) {
                $name = sprintf('"%s"', $this->filename);
            } else {
                $name = json_encode($this->filename);
            }
            $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 .= '?';
        }
    }

Here is the caller graph for this function:

Field Documentation

$filename

Twig_Error::$filename

protected

Definition at line 38 of file Error.php.

Referenced by Twig_Sandbox_SecurityNotAllowedFilterError\__construct(), Twig_Sandbox_SecurityNotAllowedFunctionError\__construct(), Twig_Sandbox_SecurityNotAllowedTagError\__construct(), Twig_Sandbox_SecurityNotAllowedMethodError\__construct(), Twig_Sandbox_SecurityNotAllowedPropertyError\__construct(), getTemplateFile(), and getTemplateName().

$lineno

Twig_Error::$lineno

protected

Definition at line 36 of file Error.php.

Referenced by Twig_Sandbox_SecurityNotAllowedFilterError\__construct(), Twig_Sandbox_SecurityNotAllowedTagError\__construct(), Twig_Sandbox_SecurityNotAllowedFunctionError\__construct(), Twig_Sandbox_SecurityNotAllowedPropertyError\__construct(), Twig_Sandbox_SecurityNotAllowedMethodError\__construct(), __construct(), getTemplateLine(), setTemplateLine(), and updateRepr().

$previous

Twig_Error::$previous

protected

Definition at line 40 of file Error.php.

Referenced by __call(), Twig_Sandbox_SecurityNotAllowedFilterError\__construct(), Twig_Sandbox_SecurityNotAllowedTagError\__construct(), Twig_Sandbox_SecurityNotAllowedFunctionError\__construct(), Twig_Sandbox_SecurityNotAllowedPropertyError\__construct(), Twig_Sandbox_SecurityNotAllowedMethodError\__construct(), Twig_Error_Loader\__construct(), and __construct().

$rawMessage

Twig_Error::$rawMessage

protected

Definition at line 39 of file Error.php.

Referenced by appendMessage(), getRawMessage(), and updateRepr().

$sourceCode

Twig_Error::$sourceCode

private

Definition at line 43 of file Error.php.

$sourcePath

Twig_Error::$sourcePath

private

Definition at line 42 of file Error.php.

Referenced by updateRepr().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/twig/twig/lib/Twig/Error.php