cwbit/cakephp-revisions

A revision-tracking plugin for CakePHP 3. Developed at CakeFest2015.

cakephp-revisions

CakePHP Revisions plugin (CakeFest 2015), _(*1)

A Plugin for CakePHP 3.x that allows you to track Revisions to Tables (at the entity level) in your Application, _(*2)

Requirements

• CakePHP 3.x

Installation

[Using Composer], _(*3)

Add the plugin to your project's composer.json - something like this:, _(*4)

{
    "require": {
        "cwbit/cakephp-revisions": "dev-master"
    }
}

Because this plugin has the type cakephp-plugin set in it's own composer.json composer knows to install it inside your /plugins directory (rather than in the usual 'Vendor' folder). It is recommended that you add /plugins/Revisions to your cake app's .gitignore file. (Why? read this.), _(*5)

[Manual], _(*6)

• Download and unzip the repo (see the download button somewhere on this git page)
• Copy the resulting folder into plugins
• Rename the folder you just copied to Revisions

[GIT Submodule], _(*7)

In your app directory type:, _(*8)

git submodule add -b master git://github.com/cwbit/cakephp-revisions.git plugins/Revisions
git submodule init
git submodule update

[GIT Clone], _(*9)

In your plugins directory type:, _(*10)

git clone -b master git://github.com/cwbit/cakephp-revisions.git Revisions

Enable plugin

In 3.0 you need to enable the plugin your config/bootstrap.php file:, _(*11)

    Plugin::load('Revisions');

If you are already using Plugin::loadAll();, then this is not necessary., _(*12)

Usage

Add the Behavior to any Table you want to track versions of, _(*13)

1. Track any/all Revisions
2. Explicity watch for changes to certain fields (whitelist)
3. Ignore changes made to certain fields (blacklist)

Basic Implementation

The Basic Implementation will fire any time any field on the entity is modified., _(*14)

    public function initialize(){
        parent::initialize();

        $this->addBehavior('Revisions.Revisions');
    }

WATCHed Implementation

You can also explicitly tell the Plugin to only trigger version control if specific field(s) have been modified., _(*15)

    public function initialize(){
        parent::initialize();

        $this->addBehavior('Revisions.Revisions', [
            'watch' => [
                'name', # trigger if,
                'foo',  # and only if, 
                'bar'   # any of these fields are changed 
                ],   
            ]);
    }

IGNOREd Implementation

You can also explicitly tell the Plugin to ignore modifications to certain fields. The version control will only trigger if at least one other (non-ignored) field has been changed., _(*16)

    public function initialize(){
        parent::initialize();

        $this->addBehavior('Revisions.Revisions', [
            'ignore' => [
                'bigBlob',  # only trigger if something 
                'created',  # OTHER than these fields 
                'modified', # was changed
                ],   
        ]);
    }

Adding Revision Review

The Plugin also comes with the ability to view all revisions and restore to any given point in time., _(*17)

To enable this functionality, add and customize the following line in any view, _(*18)

= $this->Element('Revisions.Revisions/index', [
        'id' => $entity->id,    # replace with actual entity variable
        'model' => 'examples',  # replace with actual model
        'limit' => 10,          # optional
    ]);?>