CodeExtension

class CodeExtension extends Twig_Extension

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

Methods

	__construct(string $fileLinkFormat, string $rootDir, string $charset) Constructor.
	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) 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	getFileLink(string $file, int $line) Returns the link for a given file/line pair.
	formatFileFromText($text)
	getName() {@inheritdoc}

Details

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

Constructor.

Parameters

string	$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)

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

Parameters

string	$file	A file path
int	$line	The selected line number

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

string getFileLink(string $file, int $line)

Returns the link for a given file/line pair.

Parameters

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

Return Value

string

A link of false

formatFileFromText($text)

Parameters

$text

getName()

{@inheritdoc}

Links:

http://api.symfony.com/master/Symfony/Bridge/Twig/Extension/CodeExtension.html

doc_Symfony

2025-01-10 15:47:30

Comments