Docs For Class Text_Diff

Description

A class to render Diffs in different formats.

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

$Horde: framework/Text_Diff/Diff/Renderer.php,v 1.12 2005/12/16 11:07:33 jan Exp $

Located in /sources/diff.php (line 1364)

Direct descendents

Class	Description
Text_Diff_Renderer_inline	"Inline" diff renderer.
Text_Diff_Renderer_unified	"Unified" diff renderer.

Variable Summary

mixed $_leading_context_lines

mixed $_trailing_context_lines

Method Summary

Text_Diff_Renderer Text_Diff_Renderer ([ $params = array()])

array getParams ()

string render (Text_Diff $diff)

void _added ( $lines)

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

void _blockHeader ( $xbeg, $xlen, $ybeg, $ylen)

void _changed ( $orig, $final)

void _context ( $lines)

void _deleted ( $lines, [ $words = false])

void _endBlock ()

void _endDiff ()

void _lines ( $lines, [ $prefix = ' '], [ $encode = true])

void _startBlock ( $header)

void _startDiff ()

Variables

mixed $_leading_context_lines (line 1372)

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.

Redefined in descendants as:

Text_Diff_Renderer_inline::$_leading_context_lines : Number of leading context "lines" to preserve.
Text_Diff_Renderer_unified::$_leading_context_lines : Number of leading context "lines" to preserve.

mixed $_trailing_context_lines (line 1380)

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.

Redefined in descendants as:

Text_Diff_Renderer_inline::$_trailing_context_lines : Number of trailing context "lines" to preserve.
Text_Diff_Renderer_unified::$_trailing_context_lines : Number of trailing context "lines" to preserve.

Methods

Constructor Text_Diff_Renderer (line 1385)

Constructor.

Text_Diff_Renderer Text_Diff_Renderer ([ $params = array()])

$params

getParams (line 1400)

Get any renderer parameters.

return: All parameters of this renderer object.

array getParams ()

render (line 1419)

Renders a diff.

return: The formatted output.

string render (Text_Diff $diff)

Text_Diff $diff: A Text_Diff object.

_added (line 1553)

void _added ( $lines)

$lines

Redefined in descendants as:

_block (line 1479)

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

$xbeg
$xlen
$ybeg
$ylen
&$edits

_blockHeader (line 1516)

void _blockHeader ( $xbeg, $xlen, $ybeg, $ylen)

$xbeg
$xlen
$ybeg
$ylen

Redefined in descendants as:

_changed (line 1564)

void _changed ( $orig, $final)

$orig
$final

Redefined in descendants as:

_context (line 1548)

void _context ( $lines)

$lines

_deleted (line 1558)

void _deleted ( $lines, [ $words = false])

$lines
$words

Redefined in descendants as:

_endBlock (line 1533)

void _endBlock ()

_endDiff (line 1511)

void _endDiff ()

_lines (line 1538)

void _lines ( $lines, [ $prefix = ' '], [ $encode = true])

$lines
$prefix
$encode

Redefined in descendants as:

Text_Diff_Renderer_inline::_lines()

_startBlock (line 1528)

void _startBlock ( $header)

$header

Redefined in descendants as:

Text_Diff_Renderer_inline::_startBlock()

_startDiff (line 1506)

void _startDiff ()

Class Text_Diff_Renderer