Docs For Class Text

[line 20]
General API for generating and formatting diffs - the differences between two sequences of strings.

The original PHP version of this code was written by Geoffrey T. Dairiki <dairiki@dairiki.org>, and is used/adapted with his permission.

$Horde: framework/Text_Diff/Diff.php,v 1.26 2008/01/04 10:07:49 jan Exp $

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://opensource.org/licenses/lgpl-license.php.

Author: Geoffrey T. Dairiki <dairiki@dairiki.org>

Text_Diff (Constructor) [line 38]

Text_Diff Text_Diff(
string
$engine, array
$params)

Computes diffs between sequences of strings.

Parameters:

string	`$engine`	—	Name of the diffing engine to use. 'auto' will automatically select the best.
array	`$params`	—	Parameters to pass to the diffing engine. Normally an array of two arrays, each containing the lines from a file.

[ Top ]

getDiff [line 62]

void getDiff(
)

Returns the array of differences.

[ Top ]

getFinal [line 153]

array getFinal(
)

Gets the final set of lines.

This reconstructs the $to_lines parameter passed to the constructor.

Return: The sequence of strings.

[ Top ]

getOriginal [line 135]

array getOriginal(
)

Gets the original set of lines.

This reconstructs the $from_lines parameter passed to the constructor.

Return: The original sequence of strings.

[ Top ]

isEmpty [line 100]

boolean isEmpty(
)

Checks for an empty diff.

Return: True if two sequences were identical.

[ Top ]

lcs [line 117]

integer lcs(
)

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

This is mostly for diagnostic purposes.

Return: The length of the LCS.

[ Top ]

reverse [line 81]

Text_Diff reverse(
)

Computes a reversed diff.

Example:

 $diff = new Text_Diff($lines1, $lines2);

 $rev = $diff->reverse();

Return: A Diff object representing the inverse of the original diff. Note that we purposely don't return a reference here, since this essentially is a clone() method.

[ Top ]

trimNewlines [line 171]

void trimNewlines(

&$line, integer
$key, string
$line)

Removes trailing newlines from a line of text. This is meant to be used with array_walk().

Parameters:

string	`$line`	—	The line to trim.
integer	`$key`	—	The index of the line in the array. Not used.
	`&$line`	—

[ Top ]

_getTempDir [line 186]

string _getTempDir(
)

Determines the location of the system temporary directory.

Return: A directory name which can be used for temp files. Returns false if one could not be found.
Access: protected

[ Top ]

Class: Text_Diff

Class Overview

Author(s):

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Method Detail

Text_Diff (Constructor) [line 38]

Parameters:

getDiff [line 62]

getFinal [line 153]

getOriginal [line 135]

isEmpty [line 100]

lcs [line 117]

reverse [line 81]

trimNewlines [line 171]

Parameters:

_getTempDir [line 186]