TableDiffFormatter Class Reference

MediaWiki default table style diff formatter. More...

Inheritance diagram for TableDiffFormatter:

Collaboration diagram for TableDiffFormatter:

Public Member Functions
	__construct ()
Public Member Functions inherited from DiffFormatter
	format ( $diff)
	Format a diff.

Static Public Member Functions
static	escapeWhiteSpace ( $msg)

Protected Member Functions
	added ( $lines)
	Writes all lines to the output buffer, each enclosed in .
	addedLine ( $line)
	HTML-escape parameter before calling this.
	blockHeader ( $xbeg, $xlen, $ybeg, $ylen)
	changed ( $orig, $closing)
	Writes the two sets of lines to the output buffer, each enclosed in .
	context ( $lines)
	Writes all lines to the output buffer, each enclosed in .
	contextLine ( $line)
	HTML-escape parameter before calling this.
	deleted ( $lines)
	Writes all lines to the output buffer, each enclosed in .
	deletedLine ( $line)
	HTML-escape parameter before calling this.
	emptyLine ()
	endBlock ()
	Called at the end of a block of connected edits.
	lines ( $lines, $prefix=' ', $color='white')
	startBlock ( $header)
	Writes the header to the output buffer.
	wrapLine ( $marker, $class, $line)
Protected Member Functions inherited from DiffFormatter
	block ( $xbeg, $xlen, $ybeg, $ylen, &$edits)
	endDiff ()
	lines ( $lines, $prefix=' ')
	Writes all (optionally prefixed) lines to the output buffer, separated by newlines.
	startDiff ()
	writeOutput ( $text)
	Writes a string to the output buffer.

Additional Inherited Members
Protected Attributes inherited from DiffFormatter
int	$leadingContextLines = 0
	Number of leading context "lines" to preserve.
int	$trailingContextLines = 0
	Number of trailing context "lines" to preserve.

Detailed Description

MediaWiki default table style diff formatter.

Todo:

document @newable

Definition at line 33 of file TableDiffFormatter.php.

Constructor & Destructor Documentation

__construct()

TableDiffFormatter::__construct

(

)

Definition at line 35 of file TableDiffFormatter.php.

Member Function Documentation

added()

TableDiffFormatter::added (   $lines )

protected

Writes all lines to the output buffer, each enclosed in .

Parameters

string[]

$lines

Reimplemented from DiffFormatter.

Definition at line 157 of file TableDiffFormatter.php.

References $line, $lines, addedLine(), emptyLine(), and DiffFormatter\writeOutput().

addedLine()

TableDiffFormatter::addedLine (   $line )

protected

HTML-escape parameter before calling this.

Parameters

string

$line

Returns

string

Definition at line 103 of file TableDiffFormatter.php.

References $line, and wrapLine().

Referenced by added(), and changed().

blockHeader()

TableDiffFormatter::blockHeader (   $xbeg,   $xlen,   $ybeg,   $ylen  )

protected

Parameters

int	$xbeg
int	$xlen
int	$ybeg
int	$ylen

Returns

string

Reimplemented from DiffFormatter.

Definition at line 61 of file TableDiffFormatter.php.

changed()

TableDiffFormatter::changed (   $orig,   $closing  )

protected

Writes the two sets of lines to the output buffer, each enclosed in .

Parameters

string[]	$orig
string[]	$closing

Reimplemented from DiffFormatter.

Definition at line 197 of file TableDiffFormatter.php.

References addedLine(), deletedLine(), emptyLine(), and DiffFormatter\writeOutput().

context()

TableDiffFormatter::context (   $lines )

protected

Writes all lines to the output buffer, each enclosed in .

Parameters

string[]

$lines

Reimplemented from DiffFormatter.

Definition at line 183 of file TableDiffFormatter.php.

References $line, $lines, contextLine(), and DiffFormatter\writeOutput().

contextLine()

TableDiffFormatter::contextLine (   $line )

protected

HTML-escape parameter before calling this.

Parameters

string

$line

Returns

string

Definition at line 125 of file TableDiffFormatter.php.

References $line, and wrapLine().

Referenced by context().

deleted()

TableDiffFormatter::deleted (   $lines )

protected

Writes all lines to the output buffer, each enclosed in .

Parameters

string[]

$lines

Reimplemented from DiffFormatter.

Definition at line 170 of file TableDiffFormatter.php.

References $line, $lines, deletedLine(), emptyLine(), and DiffFormatter\writeOutput().

deletedLine()

TableDiffFormatter::deletedLine (   $line )

protected

HTML-escape parameter before calling this.

Parameters

string

$line

Returns

string

Definition at line 114 of file TableDiffFormatter.php.

References $line, and wrapLine().

Referenced by changed(), and deleted().

emptyLine()

TableDiffFormatter::emptyLine ( )

protected

Returns

string

Definition at line 148 of file TableDiffFormatter.php.

Referenced by added(), changed(), and deleted().

endBlock()

TableDiffFormatter::endBlock ( )

protected

Called at the end of a block of connected edits.

This default implementation does nothing.

Reimplemented from DiffFormatter.

Definition at line 85 of file TableDiffFormatter.php.

escapeWhiteSpace()

static TableDiffFormatter::escapeWhiteSpace (   $msg )

static

Parameters

string

$msg

Returns

mixed

Definition at line 45 of file TableDiffFormatter.php.

Referenced by wrapLine().

lines()

TableDiffFormatter::lines (   $lines,   $prefix = ' ',   $color = 'white'  )

protected

Parameters

string[]	$lines
string	$prefix
string	$color

Definition at line 93 of file TableDiffFormatter.php.

startBlock()

TableDiffFormatter::startBlock (   $header )

protected

Writes the header to the output buffer.

Parameters

string

$header

Reimplemented from DiffFormatter.

Definition at line 81 of file TableDiffFormatter.php.

References $header, and DiffFormatter\writeOutput().

wrapLine()

TableDiffFormatter::wrapLine (   $marker,   $class,   $line  )

protected

Parameters

string	$marker
string	$class	Unused
string	$line

Returns

string

Definition at line 136 of file TableDiffFormatter.php.

References $line, and escapeWhiteSpace().

Referenced by addedLine(), contextLine(), and deletedLine().

---

The documentation for this class was generated from the following file:

• includes/diff/TableDiffFormatter.php