CodeHelper

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)

Constructor.

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

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

string getName()

Returns the canonical name of this helper.

Return Value

string

The canonical name