Base class for diff formatters. More...
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 () | |
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 36 of file DiffFormatter.php.
Member Function Documentation
| DiffFormatter::added | ( | $ | lines | ) | [protected] |
- Parameters:
-
string[] $lines
Reimplemented in TableDiffFormatter, and UnifiedDiffFormatter.
Definition at line 222 of file DiffFormatter.php.
| DiffFormatter::block | ( | $ | xbeg, |
| $ | xlen, | ||
| $ | ybeg, | ||
| $ | ylen, | ||
| &$ | edits | ||
| ) | [protected] |
- Parameters:
-
int $xbeg int $xlen int $ybeg int $ylen array $edits
- Exceptions:
-
MWException If the edit type is not known.
Definition at line 130 of file DiffFormatter.php.
| DiffFormatter::blockHeader | ( | $ | xbeg, |
| $ | xlen, | ||
| $ | ybeg, | ||
| $ | ylen | ||
| ) | [protected] |
- Parameters:
-
int $xbeg int $xlen int $ybeg int $ylen
- Returns:
- string
Reimplemented in UnifiedDiffFormatter, and TableDiffFormatter.
Definition at line 172 of file DiffFormatter.php.
| 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 TableDiffFormatter, and UnifiedDiffFormatter.
Definition at line 239 of file DiffFormatter.php.
| DiffFormatter::context | ( | $ | lines | ) | [protected] |
- Parameters:
-
string[] $lines
Reimplemented in TableDiffFormatter.
Definition at line 215 of file DiffFormatter.php.
| DiffFormatter::deleted | ( | $ | lines | ) | [protected] |
- Parameters:
-
string[] $lines
Reimplemented in TableDiffFormatter, and UnifiedDiffFormatter.
Definition at line 229 of file DiffFormatter.php.
| DiffFormatter::endBlock | ( | ) | [protected] |
Called at the end of a block of connected edits.
This default implementation does nothing.
Reimplemented in TableDiffFormatter.
Definition at line 197 of file DiffFormatter.php.
| DiffFormatter::endDiff | ( | ) | [protected] |
- Returns:
- string
Definition at line 157 of file DiffFormatter.php.
| DiffFormatter::format | ( | $ | diff | ) |
Format a diff.
- Parameters:
-
Diff $diff
- Returns:
- string The formatted output.
Reimplemented in ArrayDiffFormatter.
Definition at line 57 of file DiffFormatter.php.
| DiffFormatter::lines | ( | $ | lines, |
| $ | prefix = ' ' |
||
| ) | [protected] |
Writes all (optionally prefixed) lines to the output buffer, separated by newlines.
- Parameters:
-
string[] $lines string $prefix
Definition at line 206 of file DiffFormatter.php.
| 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 TableDiffFormatter.
Definition at line 189 of file DiffFormatter.php.
| DiffFormatter::startDiff | ( | ) | [protected] |
Definition at line 150 of file DiffFormatter.php.
Member Data Documentation
int 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.
Reimplemented in UnifiedDiffFormatter.
Definition at line 42 of file DiffFormatter.php.
int 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.
Reimplemented in UnifiedDiffFormatter.
Definition at line 48 of file DiffFormatter.php.
The documentation for this class was generated from the following file:
- includes/diff/DiffFormatter.php
