CodeExtension

class CodeExtension extends AbstractExtension

Twig extension relate to PHP code and used by the profiler and the default exception templates.

Methods

__construct(string|FileLinkFormatter $fileLinkFormat, string $rootDir, string $charset)
getFilters()

{@inheritdoc}

abbrClass($class)
abbrMethod($method)
string formatArgs(array $args)

Formats an array as a string.

string formatArgsAsText(array $args)

Formats an array as a string.

string fileExcerpt(string $file, int $line, int $srcContext = 3)

Returns an excerpt of a code file around the given line number.

string formatFile(string $file, int $line, string $text = null)

Formats a file path.

string|false getFileLink(string $file, int $line)

Returns the link for a given file/line pair.

formatFileFromText($text)
formatLogMessage($message, array $context)
getName()

{@inheritdoc}

Details

__construct(string|FileLinkFormatter $fileLinkFormat, string $rootDir, string $charset)

Parameters

string|FileLinkFormatter $fileLinkFormat The format for links to source files
string $rootDir The project root directory
string $charset The charset

getFilters()

{@inheritdoc}

abbrClass($class)

Parameters

$class

abbrMethod($method)

Parameters

$method

string formatArgs(array $args)

Formats an array as a string.

Parameters

array $args The argument array

Return Value

string

string formatArgsAsText(array $args)

Formats an array as a string.

Parameters

array $args The argument array

Return Value

string

string fileExcerpt(string $file, int $line, int $srcContext = 3)

Returns an excerpt of a code file around the given line number.

Parameters

string $file A file path
int $line The selected line number
int $srcContext The number of displayed lines around or -1 for the whole file

Return Value

string An HTML string

string formatFile(string $file, int $line, string $text = null)

Formats a file path.

Parameters

string $file An absolute file path
int $line The line number
string $text Use this text for the link rather than the file path

Return Value

string

Returns the link for a given file/line pair.

Parameters

string $file An absolute file path
int $line The line number

Return Value

string|false A link or false

formatFileFromText($text)

Parameters

$text

formatLogMessage($message, array $context)

Parameters

$message
array $context

getName()

{@inheritdoc}

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Bridge/Twig/Extension/CodeExtension.html