MediaWiki master
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Wikimedia\Diff\DiffFormatter Class Reference
DifferenceEngine

Base class for diff formatters. More...

Inherited by Wikimedia\Diff\ArrayDiffFormatter, Wikimedia\Diff\TableDiffFormatter, and Wikimedia\Diff\UnifiedDiffFormatter.

Public Member Functions

 format ( $diff)
 Format a diff.
 

Protected Member Functions

 added ( $lines)
 
 block ( $xbeg, $xlen, $ybeg, $ylen, &$edits)
 
 blockHeader ( $xbeg, $xlen, $ybeg, $ylen)
 
 changed ( $orig, $closing)
 Writes the two sets of lines to the output buffer, separated by "---" and a newline.
 
 context ( $lines)
 
 deleted ( $lines)
 
 endBlock ()
 Called at the end of a block of connected edits.
 
 endDiff ()
 
 lines ( $lines, $prefix=' ')
 Writes all (optionally prefixed) lines to the output buffer, separated by newlines.
 
 startBlock ( $header)
 Called at the start of a block of connected edits.
 
 startDiff ()
 
 writeOutput ( $text)
 Writes a string to the output buffer.
 

Protected Attributes

int $leadingContextLines = 0
 Number of leading context "lines" to preserve.
 
int $trailingContextLines = 0
 Number of trailing context "lines" to preserve.
 

Detailed Description

Base class for diff formatters.

This class formats the diff in classic diff format. It is intended that this class be customized via inheritance, to obtain fancier outputs.

Todo
document

Definition at line 40 of file DiffFormatter.php.

Member Function Documentation

◆ added()

Wikimedia\Diff\DiffFormatter::added ( $lines)
protected
Parameters
string[]$lines

Reimplemented in Wikimedia\Diff\TableDiffFormatter, and Wikimedia\Diff\UnifiedDiffFormatter.

Definition at line 233 of file DiffFormatter.php.

References $lines, and Wikimedia\Diff\DiffFormatter\lines().

Referenced by Wikimedia\Diff\DiffFormatter\block(), and Wikimedia\Diff\DiffFormatter\changed().

◆ block()

Wikimedia\Diff\DiffFormatter::block ( $xbeg,
$xlen,
$ybeg,
$ylen,
& $edits )
protected
Parameters
int$xbeg
int$xlen
int$ybeg
int$ylen
array&$edits

Definition at line 134 of file DiffFormatter.php.

References Wikimedia\Diff\DiffFormatter\added(), Wikimedia\Diff\DiffFormatter\blockHeader(), Wikimedia\Diff\DiffFormatter\changed(), Wikimedia\Diff\DiffFormatter\context(), Wikimedia\Diff\DiffFormatter\deleted(), Wikimedia\Diff\DiffFormatter\endBlock(), and Wikimedia\Diff\DiffFormatter\startBlock().

Referenced by Wikimedia\Diff\DiffFormatter\format().

◆ blockHeader()

Wikimedia\Diff\DiffFormatter::blockHeader ( $xbeg,
$xlen,
$ybeg,
$ylen )
protected
Parameters
int$xbeg
int$xlen
int$ybeg
int$ylen
Returns
string

Reimplemented in Wikimedia\Diff\TableDiffFormatter, and Wikimedia\Diff\UnifiedDiffFormatter.

Definition at line 183 of file DiffFormatter.php.

Referenced by Wikimedia\Diff\DiffFormatter\block().

◆ changed()

Wikimedia\Diff\DiffFormatter::changed ( $orig,
$closing )
protected

Writes the two sets of lines to the output buffer, separated by "---" and a newline.

Parameters
string[]$orig
string[]$closing

Reimplemented in Wikimedia\Diff\TableDiffFormatter, and Wikimedia\Diff\UnifiedDiffFormatter.

Definition at line 250 of file DiffFormatter.php.

References Wikimedia\Diff\DiffFormatter\added(), Wikimedia\Diff\DiffFormatter\deleted(), and Wikimedia\Diff\DiffFormatter\writeOutput().

Referenced by Wikimedia\Diff\DiffFormatter\block().

◆ context()

Wikimedia\Diff\DiffFormatter::context ( $lines)
protected
Parameters
string[]$lines

Reimplemented in Wikimedia\Diff\TableDiffFormatter.

Definition at line 226 of file DiffFormatter.php.

References $lines, and Wikimedia\Diff\DiffFormatter\lines().

Referenced by Wikimedia\Diff\DiffFormatter\block().

◆ deleted()

Wikimedia\Diff\DiffFormatter::deleted ( $lines)
protected
Parameters
string[]$lines

Reimplemented in Wikimedia\Diff\TableDiffFormatter, and Wikimedia\Diff\UnifiedDiffFormatter.

Definition at line 240 of file DiffFormatter.php.

References $lines, and Wikimedia\Diff\DiffFormatter\lines().

Referenced by Wikimedia\Diff\DiffFormatter\block(), and Wikimedia\Diff\DiffFormatter\changed().

◆ endBlock()

Wikimedia\Diff\DiffFormatter::endBlock ( )
protected

Called at the end of a block of connected edits.

This default implementation does nothing.

Reimplemented in Wikimedia\Diff\TableDiffFormatter.

Definition at line 208 of file DiffFormatter.php.

Referenced by Wikimedia\Diff\DiffFormatter\block().

◆ endDiff()

Wikimedia\Diff\DiffFormatter::endDiff ( )
protected
Returns
string

Definition at line 168 of file DiffFormatter.php.

Referenced by Wikimedia\Diff\DiffFormatter\format().

◆ format()

Wikimedia\Diff\DiffFormatter::format ( $diff)

Format a diff.

Parameters
Diff$diff
Returns
string The formatted output.

Reimplemented in Wikimedia\Diff\ArrayDiffFormatter.

Definition at line 66 of file DiffFormatter.php.

References Wikimedia\Diff\DiffFormatter\$leadingContextLines, Wikimedia\Diff\DiffFormatter\$trailingContextLines, Wikimedia\Diff\DiffFormatter\block(), Wikimedia\Diff\DiffFormatter\endDiff(), and Wikimedia\Diff\DiffFormatter\startDiff().

◆ lines()

Wikimedia\Diff\DiffFormatter::lines ( $lines,
$prefix = ' ' )
protected

Writes all (optionally prefixed) lines to the output buffer, separated by newlines.

Parameters
string[]$lines
string$prefix

Reimplemented in Wikimedia\Diff\UnifiedDiffFormatter.

Definition at line 217 of file DiffFormatter.php.

References $lines, and Wikimedia\Diff\DiffFormatter\writeOutput().

Referenced by Wikimedia\Diff\DiffFormatter\added(), Wikimedia\Diff\DiffFormatter\context(), and Wikimedia\Diff\DiffFormatter\deleted().

◆ startBlock()

Wikimedia\Diff\DiffFormatter::startBlock ( $header)
protected

Called at the start of a block of connected edits.

This default implementation writes the header and a newline to the output buffer.

Parameters
string$header

Reimplemented in Wikimedia\Diff\TableDiffFormatter.

Definition at line 200 of file DiffFormatter.php.

References $header, and Wikimedia\Diff\DiffFormatter\writeOutput().

Referenced by Wikimedia\Diff\DiffFormatter\block().

◆ startDiff()

Wikimedia\Diff\DiffFormatter::startDiff ( )
protected

Definition at line 152 of file DiffFormatter.php.

Referenced by Wikimedia\Diff\DiffFormatter\format().

◆ writeOutput()

Wikimedia\Diff\DiffFormatter::writeOutput ( $text)
protected

Writes a string to the output buffer.

Parameters
string$text

Definition at line 161 of file DiffFormatter.php.

Referenced by Wikimedia\Diff\TableDiffFormatter\added(), Wikimedia\Diff\DiffFormatter\changed(), Wikimedia\Diff\TableDiffFormatter\changed(), Wikimedia\Diff\TableDiffFormatter\context(), Wikimedia\Diff\TableDiffFormatter\deleted(), Wikimedia\Diff\DiffFormatter\lines(), Wikimedia\Diff\UnifiedDiffFormatter\lines(), Wikimedia\Diff\DiffFormatter\startBlock(), and Wikimedia\Diff\TableDiffFormatter\startBlock().

Member Data Documentation

◆ $leadingContextLines

int Wikimedia\Diff\DiffFormatter::$leadingContextLines = 0
protected

Number of leading context "lines" to preserve.

This should be left at zero for this class, but subclasses may want to set this to other values.

Definition at line 47 of file DiffFormatter.php.

Referenced by Wikimedia\Diff\DiffFormatter\format().

◆ $trailingContextLines

int Wikimedia\Diff\DiffFormatter::$trailingContextLines = 0
protected

Number of trailing context "lines" to preserve.

This should be left at zero for this class, but subclasses may want to set this to other values.

Definition at line 54 of file DiffFormatter.php.

Referenced by Wikimedia\Diff\DiffFormatter\format().

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