Symfony2 API
Class

Symfony\Bundle\FrameworkBundle\Templating\Helper\CodeHelper

class CodeHelper extends Helper

CodeHelper.

Methods

setCharset(string $charset)

Sets the default charset.

 from Helper
string getCharset()

Gets the default charset.

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

Constructor.
string formatArgsAsText(array $args)

Formats an array as a string.
abbrClass($class)

abbrMethod($method)

string formatArgs(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, integer $line, string $text = null)

Formats a file path.
string getFileLink(string $file, integer $line)

Returns the link for a given file/line pair.
formatFileFromText($text)

string getName()

Returns the canonical name of this helper.

Details

in Helper at line 35
public setCharset(string $charset)

Sets the default charset.

Parameters

string $charset The charset

in Helper at line 47
public string getCharset()

Gets the default charset.

Return Value

string The default charset

at line 38
public __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

at line 52
public string formatArgsAsText(array $args)

Formats an array as a string.

Parameters

array $args The argument array

Return Value

string

at line 57
public abbrClass($class)

Parameters

$class

at line 65
public abbrMethod($method)

Parameters

$method

at line 86
public string formatArgs(array $args)

Formats an array as a string.

Parameters

array $args The argument array

Return Value

string

at line 122
public 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

at line 157
public string formatFile(string $file, integer $line, string $text = null)

Formats a file path.

Parameters

string $file An absolute file path
integer $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
integer $line The line number

Return Value

string A link of false

at line 194
public formatFileFromText($text)

Parameters

$text

at line 208
public string getName()

Returns the canonical name of this helper.

Return Value

string The canonical name