MediaWiki  master
Diff Class Reference

Class representing a 'diff' between two sequences of strings. More...

Inheritance diagram for Diff:
Collaboration diagram for Diff:

Public Member Functions

 __construct ( $from_lines, $to_lines)
 Computes diff between sequences of strings. More...
 
 closing ()
 Get the closing set of lines. More...
 
 getEdits ()
 
 isEmpty ()
 Check for empty diff. More...
 
 lcs ()
 Compute the length of the Longest Common Subsequence (LCS). More...
 
 orig ()
 Get the original set of lines. More...
 
 reverse ()
 Compute reversed Diff. More...
 

Public Attributes

DiffOp [] $edits
 

Protected Attributes

int $bailoutComplexity = 0
 If this diff complexity is exceeded, a ComplexityException is thrown 0 means no limit. More...
 

Detailed Description

Class representing a 'diff' between two sequences of strings.

Access:
private

Definition at line 32 of file Diff.php.

Constructor & Destructor Documentation

◆ __construct()

Diff::__construct (   $from_lines,
  $to_lines 
)

Computes diff between sequences of strings.

Parameters
string[]$from_lines An array of strings. Typically these are lines from a file.
string[]$to_lines An array of strings.
Exceptions

Definition at line 53 of file Diff.php.

References DiffEngine\setBailoutComplexity().

Member Function Documentation

◆ closing()

Diff::closing ( )

Get the closing set of lines.

This reconstructs the $to_lines parameter passed to the constructor.

Returns
string[] The sequence of strings.

Definition at line 149 of file Diff.php.

References $lines.

◆ getEdits()

Diff::getEdits ( )
Returns
DiffOp[]

Definition at line 62 of file Diff.php.

References $edits.

◆ isEmpty()

Diff::isEmpty ( )

Check for empty diff.

Returns
bool True if two sequences were identical.

Definition at line 93 of file Diff.php.

◆ lcs()

Diff::lcs ( )

Compute the length of the Longest Common Subsequence (LCS).

This is mostly for diagnostic purposed.

Returns
int The length of the LCS.

Definition at line 110 of file Diff.php.

◆ orig()

Diff::orig ( )

Get the original set of lines.

This reconstructs the $from_lines parameter passed to the constructor.

Returns
string[] The original sequence of strings.

Definition at line 129 of file Diff.php.

References $lines.

◆ reverse()

Diff::reverse ( )

Compute reversed Diff.

SYNOPSIS:

$diff = new Diff($lines1, $lines2); $rev = $diff->reverse();

Returns
Object A Diff object representing the inverse of the original diff.

Definition at line 77 of file Diff.php.

Member Data Documentation

◆ $bailoutComplexity

int Diff::$bailoutComplexity = 0
protected

If this diff complexity is exceeded, a ComplexityException is thrown 0 means no limit.

Definition at line 43 of file Diff.php.

◆ $edits

DiffOp [] Diff::$edits

Definition at line 37 of file Diff.php.

Referenced by getEdits().


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