Skip to content

Simple field that lists changes made to an associated "Versioned" DataObject

License

Notifications You must be signed in to change notification settings

silvercommerce/versionhistoryfield

Repository files navigation

SilverStripe VersionHistoryField

Scrutinizer Code Quality

Simple field that lists changes made to an associated "Versioned" DataObject

Designed to be used with SilverCommerce Estimates, Invoices and contacts, but should work equally well with any other DataObject

Installing

Install via composer:

composer require silvercommerce/versionhistoryfield

Then flush

Usage

You can add this field to any form that represents a DataObject that uses Versioned. It will output a simple list of changes. For example, to add to YourObject::getCMSFields() use:

class YourDataObject extends DataObject
{
    ...

    public function getCMSFields()
    {
        $fields = parent::getCMSFields();

        $fields->addFieldToTab(
            "Root.History",
            VersionHistoryField::create(
                "History",
                _t("SilverCommerce\VersionHistoryField.History", "History"),
                $this
            )->addExtraClass("stacked") // make the field full width
        );

        return $fields;
    }

    ...
}

About

Simple field that lists changes made to an associated "Versioned" DataObject

Resources

License

Stars

Watchers

Forks

Packages

No packages published