silvercommerce/versionhistoryfield

Field that hows a simple version history of a versioned DataObject.

Installs: 4 597

Dependents: 2

Suggesters: 0

Security: 0

Stars: 0

Watchers: 4

Forks: 0

Open Issues: 0

Type:silverstripe-vendormodule

1.0.2 2018-12-04 16:10 UTC

This package is auto-updated.

Last update: 2024-05-05 03:47:37 UTC


README

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;
    }

    ...
}