eZPublish  4.7
eZDiff Class Reference

eZDiff provides an access point the diff system More...

Public Member Functions

diff ($fromData, $toData)
 
 engineType ($typeString)
 
 eZDiff ($diffEngineType=false)
 
 getDiffEngineType ()
 
 initDiffEngine ()
 
 setDiffEngineType ($diffEngineType)
 

Public Attributes

 $DIFF_TYPE
 The allowed input on which to diff. More...
 
 $DiffEngine
 Variable holding the diff engine type. More...
 
 $DiffEngineInstance
 The instance of the diff engine class. More...
 

Detailed Description

eZDiff provides an access point the diff system

The eZDiff class is responsible for accessing and loading the correct diff engine when a datatype makes a call to eZDiff library.

Member Function Documentation

& eZDiff::diff (   $fromData,
  $toData 
)

Perform a diff operation on the provided set of data. A valid diff engine have to be specified, before this can be run.

Returns
An eZDiffContent object with the detected changes
eZDiff::engineType (   $typeString)
Returns
Internal id of engine type given in $typeString
eZDiff::eZDiff (   $diffEngineType = false)

Instantiates the eZDiff object

Parameters
$diffEngineTypeThe type of diff engine to initialize at start
eZDiff::getDiffEngineType ( )
Returns
The diff engine type used in this instance.
eZDiff::initDiffEngine ( )

Returns diff engine of $type

eZDiff::setDiffEngineType (   $diffEngineType)

Set the diff engine to be used for diffing.

Parameters
$diffEngineTypeThe type of diff engine to intitialize

Member Data Documentation

eZDiff::$DIFF_TYPE
Initial value:
= array( 'text' => 0,
'xml' => 1,
'container' => 2 )

The allowed input on which to diff.

eZDiff::$DiffEngine

Variable holding the diff engine type.

Referenced by getDiffEngineType().

eZDiff::$DiffEngineInstance

The instance of the diff engine class.

Referenced by diff().


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