SilverStripe\VersionedAdmin\Forms\DiffField

Complexity

Total Complexity

6

Size/Duplication

Total Lines	75
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	setComparisonField()	0	5	1
A	getSchemaDataDefaults()	0	5	1
A	Value()	0	5	1
A	getOutdatedField()	0	5	1
A	getComparisonField()	0	3	1
A	getSchemaStateDefaults()	0	17	1

<?php

namespace SilverStripe\VersionedAdmin\Forms;

use SilverStripe\Forms\FormField;
use SilverStripe\Forms\HTMLReadonlyField;
use SilverStripe\View\Parsers\Diff;

/**
 * This form field is both a field object in it's own right, and a decorator for another field type.
 * It is used to render differences between two data entries into the field type it wraps
 * e.g. a TextField with the value "Old data" can be transformed with {@see DiffTransformation}
 * and then having setValue called again to load in "New data" - this field will then render
 * the value "<ins>New</ins> <del>Old</del> data". Most useful in historic version comparisons
 * {@see SilverStripe\Versioned\Versioned}
 */
class DiffField extends HTMLReadonlyField
{
    /**
     * @var FormField Holds the field used as the 'To' (the newer) data for the diff.
     */
    protected $comparisonField;

    /**
     * @param FormField $field
     * @return $this
     */
    public function setComparisonField(FormField $field)
    {
        $this->comparisonField = $field;
        $this->setFailover($this->comparisonField);
        return $this;
    }

    /**
     * @return FormField
     */
    public function getComparisonField()
    {
        return $this->comparisonField;
    }

    public function Value()
    {
        $oldValue = $this->getOutdatedField()->Value();
        $newValue = $this->getComparisonField()->Value();
        return Diff::compareHTML($oldValue, $newValue);
    }

    /**
     * This function is so named not in the manner of chronology,
     * but rather in terms of succession.
     * That is to say the 'outdated' field may in fact be for a newer
     * value in terms of chronology, but a diff shows what it takes to
     * turn one value _into_ another... and in this case the 'from' field
     * value is succeeded by the 'to' value - it becomes 'outdated'.
     *
     * @return FormField
     */
    public function getOutdatedField()
    {
        $newField = clone $this->getComparisonField();
        $newField->setValue($this->value);
        return $newField;
    }

    public function getSchemaDataDefaults()
    {
        return array_merge(
            $this->getComparisonField()->getSchemaDataDefaults(),
            parent::getSchemaDataDefaults()
        );
    }

    public function getSchemaStateDefaults()
    {
        $fromValue = $this->getOutdatedField()->Value();
        $toField = $this->getComparisonField();
        $toValue = $toField->Value();

        $state = array_merge(
            $toField->getSchemaStateDefaults(),
            parent::getSchemaStateDefaults(),
            ['value' => $this->Value()]
        );
        $state['data']['diff'] = [
            'from' => $fromValue,
            'to' => $toValue,
        ];

        return $state;
    }
}