CodeHelper::getName()

string getName() Returns the canonical name of this helper. Return Value string The canonical name

CodeHelper::getFileLink()

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

CodeHelper::formatArgsAsText()

string formatArgsAsText(array $args) Formats an array as a string. Parameters array $args The argument array Return Value string

CodeHelper::abbrClass()

abbrClass($class) Parameters $class

CodeHelper::formatFile()

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

CodeHelper::abbrMethod()

abbrMethod($method) Parameters $method

CodeHelper::formatArgs()

string formatArgs(array $args) Formats an array as a string. Parameters array $args The argument array Return Value string

CodeHelper::fileExcerpt()

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

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,

CodeExtension::getName()

getName() {@inheritdoc}