class DiffFormatter (View source)

A class to format Diffs

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

document

Properties

$show_header

Should a block header be shown?

$leading_context_lines

Number of leading context "lines" to preserve.

$trailing_context_lines

Number of trailing context "lines" to preserve.

protected array $line_stats

The line stats.

Methods

string
format(Diff $diff)

Format a diff.

_block($xbeg, $xlen, $ybeg, $ylen, $edits)

No description

_start_diff()

No description

_end_diff()

No description

_block_header($xbeg, $xlen, $ybeg, $ylen)

No description

_start_block($header)

No description

_end_block()

No description

_lines($lines, $prefix = ' ')

No description

_context($lines)

No description

_added($lines)

No description

_deleted($lines)

No description

_changed($orig, $closing)

No description

Details

string format(Diff $diff)

Format a diff.

Parameters

Diff $diff

A Diff object.

Return Value

string

The formatted output.

protected _block($xbeg, $xlen, $ybeg, $ylen, $edits)

No description

Parameters

$xbeg
$xlen
$ybeg
$ylen
$edits

protected _start_diff()

No description

protected _end_diff()

No description

protected _block_header($xbeg, $xlen, $ybeg, $ylen)

No description

Parameters

$xbeg
$xlen
$ybeg
$ylen

protected _start_block($header)

No description

Parameters

$header

protected _end_block()

No description

protected _lines($lines, $prefix = ' ')

No description

Parameters

$lines
$prefix

protected _context($lines)

No description

Parameters

$lines

protected _added($lines)

No description

Parameters

$lines

protected _deleted($lines)

No description

Parameters

$lines

protected _changed($orig, $closing)

No description

Parameters

$orig
$closing