Changeset 7389

Timestamp:

02/07/08 14:11:48 (10 months ago)

Author:

francois

Message:

sfPropelVersionableBehaviorPlugin Added addVersion method and refactored the behavior to keep D.R.Y.

Files:

• plugins/sfPropelVersionableBehaviorPlugin/trunk/README (modified) (4 diffs)
• plugins/sfPropelVersionableBehaviorPlugin/trunk/config/config.php (modified) (1 diff)
• plugins/sfPropelVersionableBehaviorPlugin/trunk/lib/sfPropelVersionableBehavior.class.php (modified) (5 diffs)
• plugins/sfPropelVersionableBehaviorPlugin/trunk/test/unit/PropelVersionableBehaviorTest.php (modified) (6 diffs)

plugins/sfPropelVersionableBehaviorPlugin/trunk/README

@@ -32 +32 @@
-<column name="version" type="INTEGER" required="true" />
-or
-
+
-version: { type: integer, required: true }
-    }}}
@@ -168 +168 @@
-}}}
-
+Alternativley, you can choose to disable the automated creation of a new version at each save for all models by changing the application configuration:
+
+{{{
+# config/app.yml
+all:
+  sfPropelVersionableBehaviorPlugin:
+    auto_versioning: false
+}}}
+
+In this case, you still have the way to manually create a new version of an object:
+
+{{{
+#!php
+<?php
+
+$article->setTitle('Please version me even thoug auto_versioning is false');
+$article->addVersion();
+$article->save(); // article is saved and a new version is created
+}}}
+
-== Public API ==
-
@@ -178 +198 @@
- * `void toVersion(integer $version_number)`: Populates the properties of the current object with values from the requested version. Beware that saving the object afterwards will create a new version (and not update the previous version).
- * `array getAllVersions()`: Returns all versions of the object in an ordered array
+ * `void addVersion()`: Increments the object's version number (without saving it) and creates a new ResourceVersion record. To be used when versionConditionMet() is false
- * `ResourceVersion getLastResourceVersion()`: Returns the object's last version object
- * `array getAllResourceVersions()`: Returns all version objects in an array
@@ -201 +222 @@
-== Changelog ==
-
-
-
+
+
+
- * francois: More explicit documentation on installation
- * francois: Added a few unit tests

plugins/sfPropelVersionableBehaviorPlugin/trunk/config/config.php

@@ -40 +40 @@
-    'getVersion'
-  ),
+  array (
+    'sfPropelVersionableBehavior',
+    'addVersion'
+  ),
-));

plugins/sfPropelVersionableBehaviorPlugin/trunk/lib/sfPropelVersionableBehavior.class.php

@@ -141 +141 @@
-    return $objects;
-  }
+  
+  /**
+   * Increments the object's version number (without saving it) and creates a new ResourceVersion record.
+   * To be used when versionConditionMet() is false
+   * 
+   * @param      BaseObject   $resource
+   */
+  public function addVersion(BaseObject $resource)
+  {
+    if (self::versionConditionMet($resource))
+    {
+      throw new Exception("Impossible to use addVersion() when auto_versioning is on and versionConditionMet() is true");
+    }
+    self::incrementVersion($resource);
+    self::createResourceVersion($resource);
+  }
-
-# ---- GETTERS & SETTERS
@@ -179 +195 @@
-    if (self::versionConditionMet($resource))
-    {
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
-  /**
-   * This hook is called juste after object is saved. It takes care of creating a new version of resource.
@@ -199 +208 @@
-    if (self::versionConditionMet($resource))
-    {
-
-
-
-
-
-
-
+
+
+
+
-  /**
-   * This hook is called just after a resource is deleted and takes care of deleting its version history.
@@ -219 +225 @@
-# ---- HELPER METHODS
-
+  /**
+   * Increments the version number of the current object or initializes it
+   *
+   * @param      BaseObject    $resource
+   */
+  public function incrementVersion(BaseObject $resource)
+  {
+    if ($version = $resource->getLastResourceVersion())
+    {
+      $resource->setVersion($version->getNumber() + 1);
+    }
+    else
+    {
+      $resource->setVersion(1);
+    }
+  }
+
+  /**
+   * Creates a new ResourceVersion record based on the object
+   *
+   * @param      BaseObject    $resource
+   */
+  public function createResourceVersion(BaseObject $resource)
+  {
+    $version = new ResourceVersion();
+    $version->populateFromObject($resource);
+    $version->setNumber($resource->getVersion());
+    $version->save();
+  }
+  
-  /**
-   * Returns a resource populated with attribute values of given version.
@@ -285 +321 @@
-  public static function versionConditionMet(BaseObject $resource)
-  {
+    if(!sfConfig::get('app_sfPropelVersionableBehaviorPlugin_auto_versioning', true))
+    {
+      return false;
+    }
+    
-    if (!$method = self::$condition_method)
-    {

plugins/sfPropelVersionableBehaviorPlugin/trunk/test/unit/PropelVersionableBehaviorTest.php

@@ -78 +78 @@
-)));
-
-26
+30
-
-// save()
@@ -108 +108 @@
-$t->is($r->getLastResourceVersion()->getResourceInstance()->getByName($test_class_title_column, BasePeer::TYPE_FIELDNAME), 'V2', 'getLastVersion() returns last version of resource');
-
+// conditional versioning
+$t->diag('conditional versioning');
-$r->setByName($test_class_title_column, 'do not version me', BasePeer::TYPE_FIELDNAME);
-$r->save();
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-// toVersion()
@@ -119 +143 @@
-$t->is($r->getByName($test_class_title_column, BasePeer::TYPE_FIELDNAME), 'V1', 'toVersion() sets resource attributes to appropriate values');
-$r->save();
-3
+4
-try
-{
-  $r->toVersion(0);
-  $t->fail('toVersion() throws an exception when requested version does not exist');
-
-
-
+
-  $t->pass('toVersion() throws an exception when requested version does not exist');
-}
@@ -133 +155 @@
-$t->diag('getAllResourceVersions()');
-
-4
+5
-$r->save();
-$all_versions = $r->getAllResourceVersions();
-V1', 'V4
-4
+this time, please version me, but manually', 'V1', 'V5
+5
-$versions_titles = array();
-foreach($all_versions as $v)
@@ -148 +170 @@
-$t->diag('getAllVersions()');
-$all_object_versions = $r->getAllVersions();
-4
+5
-$versions_titles = array();
-$versions_versions = array();
@@ -157 +179 @@
-}
-$t->is($versions_titles, $target_versions, 'getAllVersions() returns the right versions');
-
+, 5
-
-// delete()