Class DataDifferencer

Utility class to render views of the differences between two data objects (or two versions of the same data object).

Construcing a diff object is done as follows:

$fromRecord = Versioned::get_version('SiteTree', $pageID, $fromVersion);
$toRecord = Versioned::get_version('SiteTree, $pageID, $toVersion);
$diff = new DataDifferencer($fromRecord, $toRecord);

And then it can be used in a number of ways. You can use the ChangedFields() method in a template:

<dl class="diff">
<% control Diff.ChangedFields %>
   <dt>$Title</dt>
   <dd>$Diff</dd>
<% end_control %>
</dl>

Or you can get the diff'ed content as another DataObject, that you can insert into a form.

$form->loadDataFrom($diff->diffedData());

If there are fields whose changes you aren't interested in, you can ignore them like so:

$diff->ignoreFields('AuthorID', 'Status');

Object

ViewableData implements IteratorAggregate

DataDifferencer

Package: sapphire\misc
Located at sapphire/core/model/DataDifferencer.php

Methods summary

`public`	# `__construct( mixed $fromRecord, mixed $toRecord )` Construct a DataDifferencer to show the changes between $fromRecord and $toRecord. If $fromRecord is null, this will represent a "creation". Construct a DataDifferencer to show the changes between $fromRecord and $toRecord. If $fromRecord is null, this will represent a "creation". Overrides `Object::__construct`
`public`	# `ignoreFields( mixed $ignoredFields )` Specify some fields to ignore changes from. Repeated calls are cumulative. Specify some fields to ignore changes from. Repeated calls are cumulative. Parameters `$ignoredFields` $ignoredFields An array of field names to ignore. Alternatively, pass the field names as separate args.
`public`	# `diffedData( )` Get a DataObject with altered values replaced with HTML diff strings, incorporating <ins> and <del> tags. Get a DataObject with altered values replaced with HTML diff strings, incorporating <ins> and <del> tags.
`public`	# `ChangedFields( )` Get a DataObjectSet of the changed fields. Each element is an array data containing - Name: The field name - Title: The human-readable field title - Diff: An HTML diff showing the changes - From: The older version of the field - To: The newer version of the field Get a DataObjectSet of the changed fields. Each element is an array data containing - Name: The field name - Title: The human-readable field title - Diff: An HTML diff showing the changes - From: The older version of the field - To: The newer version of the field
`public`	# `changedFieldNames( )` Get an array of the names of every fields that has changed. This is simpler than `DataDifferencer::ChangedFields()` Get an array of the names of every fields that has changed. This is simpler than `DataDifferencer::ChangedFields()`