Docs4dev
Docs
symfony / 4.1 / symfony / bundle / frameworkbundle / templating / helper / codehelper.html

CodeHelper

class CodeHelper extends Helper

Properties

protected $charset
protected $fileLinkFormat
protected $rootDir

Methods

setCharset(string $charset)

Sets the default charset.

 from Helper
string getCharset()

Gets the default charset.

 from Helper
__construct(string|FileLinkFormatter $fileLinkFormat, string $rootDir, string $charset)
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, 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)
string getName()

Returns the canonical name of this helper.
static fixCodeMarkup($line)

Details

setCharset(string $charset)

Sets the default charset.

Parameters

string $charset The charset

string getCharset()

Gets the default charset.

Return Value

string The default charset

__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

string formatArgsAsText(array $args)

Formats an array as a string.

Parameters

array $args The argument array

Return Value

string

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

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

string getName()

Returns the canonical name of this helper.

Return Value

string The canonical name

static protected fixCodeMarkup($line)

Parameters

$line

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Bundle/FrameworkBundle/Templating/Helper/CodeHelper.html