Diff Class Reference

Inheritance diagram for Diff:

Collaboration diagram for Diff:

Public Member Functions
	Diff ($from_lines, $to_lines)
	Constructor. More...
	reverse ()
	Compute reversed Diff. More...
	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...
	closing ()
	Get the closing set of lines. More...
	_check ($from_lines, $to_lines)
	Check a Diff for validity. More...

Data Fields
	$edits

Detailed Description

Definition at line 1202 of file class.WordLevelDiff.php.

Member Function Documentation

_check()

Diff::_check	(		$from_lines,
			$to_lines
	)

Check a Diff for validity.

This is here only for debugging purposes.

Definition at line 1309 of file class.WordLevelDiff.php.

                                                 {
                $fname = 'Diff::_check';
                //wfProfileIn( $fname );
                if (serialize($from_lines) != serialize($this->orig()))
                        trigger_error("Reconstructed original doesn't match", E_USER_ERROR);
                if (serialize($to_lines) != serialize($this->closing()))
                        trigger_error("Reconstructed closing doesn't match", E_USER_ERROR);
 
                $rev = $this->reverse();
                if (serialize($to_lines) != serialize($rev->orig()))
                        trigger_error("Reversed original doesn't match", E_USER_ERROR);
                if (serialize($from_lines) != serialize($rev->closing()))
                        trigger_error("Reversed closing doesn't match", E_USER_ERROR);
 
 
                $prevtype = 'none';
                foreach ($this->edits as $edit) {
                        if ( $prevtype == $edit->type )
                                trigger_error("Edit sequence is non-optimal", E_USER_ERROR);
                        $prevtype = $edit->type;
                }
 
                $lcs = $this->lcs();
                trigger_error('Diff okay: LCS = '.$lcs, E_USER_NOTICE);
                //wfProfileOut( $fname );
        }

References closing(), lcs(), orig(), and reverse().

Here is the call graph for this function:

closing()

Diff::closing

(

)

Get the closing set of lines.

This reconstructs the $to_lines parameter passed to the constructor.

Returns

array The sequence of strings.

Reimplemented in WordLevelDiff.

Definition at line 1294 of file class.WordLevelDiff.php.

                           {
                $lines = array();
 
                foreach ($this->edits as $edit) {
                        if ($edit->closing)
                                array_splice($lines, sizeof($lines), 0, $edit->closing);
                }
                return $lines;
        }

Referenced by _check().

Here is the caller graph for this function:

Diff()

Diff::Diff	(		$from_lines,
			$to_lines
	)

Constructor.

Computes diff between sequences of strings.

Parameters

$from_lines	array An array of strings. (Typically these are lines from a file.)
$to_lines	array An array of strings.

Definition at line 1214 of file class.WordLevelDiff.php.

                                              {
                $eng = new _DiffEngine;
                $this->edits = $eng->diff($from_lines, $to_lines);
                //$this->_check($from_lines, $to_lines);
        }

References _DiffEngine\diff().

Referenced by MappedDiff\MappedDiff().

Here is the call graph for this function:

Here is the caller graph for this function:

isEmpty()

Diff::isEmpty

(

)

Check for empty diff.

Returns

bool True iff two sequences were identical.

Definition at line 1244 of file class.WordLevelDiff.php.

                            {
                foreach ($this->edits as $edit) {
                        if ($edit->type != 'copy')
                                return false;
                }
                return true;
        }

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 1259 of file class.WordLevelDiff.php.

                        {
                $lcs = 0;
                foreach ($this->edits as $edit) {
                        if ($edit->type == 'copy')
                                $lcs += sizeof($edit->orig);
                }
                return $lcs;
        }

Referenced by _check().

Here is the caller graph for this function:

orig()

Diff::orig

(

)

Get the original set of lines.

This reconstructs the $from_lines parameter passed to the constructor.

Returns

array The original sequence of strings.

Reimplemented in WordLevelDiff.

Definition at line 1276 of file class.WordLevelDiff.php.

                        {
                $lines = array();
 
                foreach ($this->edits as $edit) {
                        if ($edit->orig)
                                array_splice($lines, sizeof($lines), 0, $edit->orig);
                }
                return $lines;
        }

Referenced by _check().

Here is the caller graph for this function:

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 1230 of file class.WordLevelDiff.php.

                            {
                $rev = $this;
                $rev->edits = array();
                foreach ($this->edits as $edit) {
                        $rev->edits[] = $edit->reverse();
                }
                return $rev;
        }

Referenced by _check().

Here is the caller graph for this function:

Field Documentation

$edits

Diff::$edits

Definition at line 1204 of file class.WordLevelDiff.php.

Referenced by MappedDiff\MappedDiff().

---

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

• Services/COPage/mediawikidiff/class.WordLevelDiff.php