\Twig\ErrorSyntaxError

Exception thrown when a syntax error occurs during lexing or parsing of a template.

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.

Summary

Methods
Properties
Constants
addSuggestions()
__construct()
getRawMessage()
getTemplateLine()
setTemplateLine()
getSourceContext()
setSourceContext()
guess()
appendMessage()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
updateRepr()
guessTemplateInfo()
$lineno
$name
$rawMessage
$sourcePath
$sourceCode
N/A

Properties

$lineno

$lineno : 

Type

$name

$name : 

Type

$rawMessage

$rawMessage : 

Type

$sourcePath

$sourcePath : 

Type

$sourceCode

$sourceCode : 

Type

Methods

addSuggestions()

addSuggestions(string  $name, array  $items) 

Tweaks the error message to include suggestions.

Parameters

string $name

The original name of the item that does not exist

array $items

An array of possible items

__construct()

__construct(string  $message, integer  $lineno = -1, \Twig_Source|string|null  $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

integer $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

getRawMessage()

getRawMessage() : string

Gets the raw message.

Returns

string —

The raw message

getTemplateLine()

getTemplateLine() : integer

Gets the template line where the error occurred.

Returns

integer —

The template line

setTemplateLine()

setTemplateLine(integer  $lineno) 

Sets the template line where the error occurred.

Parameters

integer $lineno

The template line

getSourceContext()

getSourceContext() : \Twig_Source|null

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

Returns

\Twig_Source|null

setSourceContext()

setSourceContext(\Twig_Source  $source = null) 

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

Parameters

\Twig_Source $source

guess()

guess() 

appendMessage()

appendMessage(  $rawMessage) 

Parameters

$rawMessage

updateRepr()

updateRepr() 

guessTemplateInfo()

guessTemplateInfo()