===== Acts as versioned plugin for Akelos Active Records =====


This plugin adds versioning capabilities to you Active Record Models.



==== Installation ====

  ./script/plugin install acts_as_versioned


==== Enabling versioning in your models ====

Say you have a Chapter model and you want to keep the latest 20 modifications for each chapter.

==== Adding the acts as behaviour to your Chapter model ====

//./app/models/chapter.php//

<code php>
<?php

class Chapter extends ActiveRecord
{
    var $acts_as = array('versioned' => array('limit'=>10));
}
 
?>
</code>

==== Modifying your ''chapters'' table to add a version number and create a ''chapter_versions'' table ====

//./app/installers/chapter_installer.php//

<code php>
<?php

Ak::import('Chapter');
Ak::loadPlugins();

class ChapterInstaller extends AkInstaller
{
    function up_1()
    {
        //.....
    }

    function up_2()
    {
        $Chapter =& new Chapter();
        $Chapter->versioned->createVersionedTable();
    }

    function down_1()
    {
        //.....
    }

    function down_2()
    {
        $Chapter =& new Chapter();
        $Chapter->versioned->dropVersionedTable();
    }
}

?>
</code>

==== Using your brand new versioning system ====

  * Behaviour handler
   <code php>$Chapter->versioned</code>
  * Loads versions, pass true to force a db reload
   <code php>$Chapter->versioned->load()</code>
  * Rolling back a version
   <code php>$Chapter->versioned->revertToVersion(3);</code>
  * Same as find() but scoped to older versions
   <code php>$Chapter->versioned->find();</code>
  * An array with your versions
   <code php>$Chapter->versions</code>
  * Next versioned item if exists
   <code php>$Chapter->versions[2]->getNext();</code>
  * Previous versioned item if exists 
   <code php>$Chapter->versions[2]->getPrevious();</code>