API Split apart Versioned and Staged

silverstripe · Oct 29, 2024 · e987568 · e987568
1 parent a7e5891
commit e987568
Show file tree

Hide file tree

Showing 45 changed files with 58 additions and 50 deletions.
diff --git a/_config/versionedextension.yml b/_config/versionedextension.yml
@@ -19,4 +19,4 @@ Name: versioned-table
 ---
 SilverStripe\ORM\DataQuery:
   extensions:
-    - SilverStripe\Versioned\VersionedTableDataQueryExtension
+    - SilverStripe\Versioned\Staged\VersionedTableDataQueryExtension
diff --git a/_config/versionedownership.yml b/_config/versionedownership.yml
@@ -3,16 +3,16 @@ Name: versionedownership
 ---
 SilverStripe\ORM\DataObject:
   extensions:
-    RecursivePublishable: SilverStripe\Versioned\RecursivePublishable
+    RecursivePublishable: SilverStripe\Versioned\Staged\RecursivePublishable
 
 SilverStripe\Core\Injector\Injector:
-  SilverStripe\Versioned\RecursiveStagesInterface:
-    class: SilverStripe\Versioned\RecursiveStagesService
+  SilverStripe\Versioned\Staged\RecursiveStagesInterface:
+    class: SilverStripe\Versioned\Staged\RecursiveStagesService
 ---
 Name: versionedownership-admin
 OnlyIf:
   ModuleExists: silverstripe/admin
 ---
 SilverStripe\Admin\LeftAndMain:
   extensions:
-    RecursivePublishableHandler: SilverStripe\Versioned\RecursivePublishableHandler
+    RecursivePublishableHandler: SilverStripe\Versioned\Staged\RecursivePublishableHandler
diff --git a/_config/versionedrequestprocessors.yml b/_config/versionedrequestprocessors.yml
@@ -8,4 +8,4 @@ SilverStripe\Core\Injector\Injector:
   SilverStripe\Control\Director:
     properties:
       Middlewares:
-        VersionedMiddleware: '%$SilverStripe\Versioned\VersionedHTTPMiddleware'
+        VersionedMiddleware: '%$SilverStripe\Versioned\Staged\VersionedHTTPMiddleware'
diff --git a/src/ChangeSet.php → src/Staged/ChangeSet.php b/src/ChangeSet.php → src/Staged/ChangeSet.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace SilverStripe\Versioned;
+namespace SilverStripe\Versioned\Staged;
 
 use BadMethodCallException;
 use Exception;

diff --git a/src/ChangeSetItem.php → src/Staged/ChangeSetItem.php b/src/ChangeSetItem.php → src/Staged/ChangeSetItem.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace SilverStripe\Versioned;
+namespace SilverStripe\Versioned\Staged;
 
 use BadMethodCallException;
 use InvalidArgumentException;
@@ -17,6 +17,7 @@
 use SilverStripe\Security\Member;
 use SilverStripe\Security\Permission;
 use SilverStripe\Security\Security;
+use SilverStripe\Versioned\Versioned;
 
 /**
  * A single line in a changeset

diff --git a/src/RecursivePublishable.php → src/Staged/RecursivePublishable.php b/src/RecursivePublishable.php → src/Staged/RecursivePublishable.php
@@ -1,7 +1,7 @@
 <?php
 
 
-namespace SilverStripe\Versioned;
+namespace SilverStripe\Versioned\Staged;
 
 use InvalidArgumentException;
 use SilverStripe\Core\ClassInfo;
@@ -12,6 +12,8 @@
 use SilverStripe\ORM\FieldType\DBDatetime;
 use SilverStripe\ORM\Queries\SQLUpdate;
 use SilverStripe\Model\List\SS_List;
+use SilverStripe\Versioned\Versioned;
+use SilverStripe\Versioned\ReadingMode;
 
 /**
  * Provides owns / owned_by and recursive publishing API for all objects.
@@ -84,7 +86,7 @@ public function publishRecursive()
             );
 
             $changeset->write();
-            $changeset->addObject($owner);
+            $changeset->addObject($owner); // will add a ChangeSetItem to $changeset->Changes()
 
             $result = $changeset->publish(true);
             if (!$result) {

diff --git a/src/RecursivePublishableHandler.php → src/Staged/RecursivePublishableHandler.php b/src/RecursivePublishableHandler.php → src/Staged/RecursivePublishableHandler.php
@@ -1,10 +1,11 @@
 <?php
 
-namespace SilverStripe\Versioned;
+namespace SilverStripe\Versioned\Staged;
 
 use SilverStripe\Admin\LeftAndMain;
 use SilverStripe\Core\Extension;
 use SilverStripe\ORM\DataObject;
+use SilverStripe\Versioned\Versioned;
 
 /**
  * Provides recursive publishable behaviour for LeftAndMain and GridFieldDetailForm_ItemRequest

diff --git a/src/RecursiveStagesInterface.php → src/Staged/RecursiveStagesInterface.php b/src/RecursiveStagesInterface.php → src/Staged/RecursiveStagesInterface.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace SilverStripe\Versioned;
+namespace SilverStripe\Versioned\Staged;
 
 use SilverStripe\ORM\DataObject;
 

diff --git a/src/RecursiveStagesService.php → src/Staged/RecursiveStagesService.php b/src/RecursiveStagesService.php → src/Staged/RecursiveStagesService.php
@@ -1,11 +1,12 @@
 <?php
 
-namespace SilverStripe\Versioned;
+namespace SilverStripe\Versioned\Staged;
 
 use SilverStripe\Core\Injector\Injectable;
 use SilverStripe\Core\Injector\Injector;
 use SilverStripe\Core\Resettable;
 use SilverStripe\ORM\DataObject;
+use SilverStripe\Versioned\Versioned;
 
 /**
  * Functionality for detecting the need of publishing nested objects owned by common parent / ancestor object

diff --git a/src/VersionedHTTPMiddleware.php → src/Staged/VersionedHTTPMiddleware.php b/src/VersionedHTTPMiddleware.php → src/Staged/VersionedHTTPMiddleware.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace SilverStripe\Versioned;
+namespace SilverStripe\Versioned\Staged;
 
 use SilverStripe\Control\Controller;
 use SilverStripe\Control\Director;
@@ -10,6 +10,7 @@
 use SilverStripe\Core\Convert;
 use SilverStripe\ORM\FieldType\DBField;
 use SilverStripe\Security\Security;
+use SilverStripe\Versioned\Versioned;
 
 /**
  * Initialises the versioned stage when a request is made.

diff --git a/src/VersionedTableDataQueryExtension.php → ...aged/VersionedTableDataQueryExtension.php b/src/VersionedTableDataQueryExtension.php → ...aged/VersionedTableDataQueryExtension.php
@@ -1,11 +1,12 @@
 <?php
 
-namespace SilverStripe\Versioned;
+namespace SilverStripe\Versioned\Staged;
 
 use SilverStripe\Core\Extensible;
 use SilverStripe\Core\Extension;
 use SilverStripe\Core\Injector\Injector;
 use SilverStripe\ORM\DataQuery;
+use SilverStripe\Versioned\Versioned;
 
 /**
  * Applies correct stage to tables

diff --git a/src/Versioned.php b/src/Versioned.php
@@ -26,6 +26,7 @@
 use SilverStripe\Security\Permission;
 use SilverStripe\Security\Security;
 use SilverStripe\View\TemplateGlobalProvider;
+use SilverStripe\Versioned\Staged\RecursiveStagesInterface;
 
 /**
  * The Versioned extension allows your DataObjects to have several versions,

diff --git a/tests/php/ChangeSetItemTest.php b/tests/php/ChangeSetItemTest.php
@@ -2,7 +2,7 @@
 
 namespace SilverStripe\Versioned\Tests;
 
-use SilverStripe\Versioned\ChangeSetItem;
+use SilverStripe\Versioned\Staged\ChangeSetItem;
 use SilverStripe\Dev\SapphireTest;
 
 class ChangeSetItemTest extends SapphireTest

diff --git a/tests/php/ChangeSetTest.php b/tests/php/ChangeSetTest.php
@@ -7,8 +7,8 @@
 use SebastianBergmann\Comparator\ComparisonFailure;
 use SilverStripe\Dev\SapphireTest;
 use SilverStripe\ORM\DataObject;
-use SilverStripe\Versioned\ChangeSet;
-use SilverStripe\Versioned\ChangeSetItem;
+use SilverStripe\Versioned\Staged\ChangeSet;
+use SilverStripe\Versioned\Staged\ChangeSetItem;
 use SilverStripe\Versioned\Tests\ChangeSetTest\BaseObject;
 use SilverStripe\Versioned\Tests\ChangeSetTest\ChangeSetSyncStub;
 use SilverStripe\Versioned\Tests\ChangeSetTest\MidObject;

diff --git a/tests/php/ChangeSetTest/ChangeSetSyncStub.php b/tests/php/ChangeSetTest/ChangeSetSyncStub.php
@@ -2,7 +2,7 @@
 namespace SilverStripe\Versioned\Tests\ChangeSetTest;
 
 use SilverStripe\Dev\TestOnly;
-use SilverStripe\Versioned\ChangeSet;
+use SilverStripe\Versioned\Staged\ChangeSet;
 
 class ChangeSetSyncStub extends ChangeSet implements TestOnly
 {

diff --git a/tests/php/PolymorphicVersionedOwnershipTest/PolymorphicIntermediary.php b/tests/php/PolymorphicVersionedOwnershipTest/PolymorphicIntermediary.php
@@ -4,7 +4,7 @@
 
 use SilverStripe\Dev\TestOnly;
 use SilverStripe\ORM\DataObject;
-use SilverStripe\Versioned\RecursivePublishable;
+use SilverStripe\Versioned\Staged\RecursivePublishable;
 use SilverStripe\Versioned\Versioned;
 
 /**

diff --git a/tests/php/PolymorphicVersionedOwnershipTest/PolymorphicOwned.php b/tests/php/PolymorphicVersionedOwnershipTest/PolymorphicOwned.php
@@ -4,7 +4,7 @@
 
 use SilverStripe\Dev\TestOnly;
 use SilverStripe\ORM\DataObject;
-use SilverStripe\Versioned\RecursivePublishable;
+use SilverStripe\Versioned\Staged\RecursivePublishable;
 use SilverStripe\Versioned\Versioned;
 
 /**

diff --git a/tests/php/PolymorphicVersionedOwnershipTest/PolymorphicOwner.php b/tests/php/PolymorphicVersionedOwnershipTest/PolymorphicOwner.php
@@ -4,7 +4,7 @@
 
 use SilverStripe\Dev\TestOnly;
 use SilverStripe\ORM\DataObject;
-use SilverStripe\Versioned\RecursivePublishable;
+use SilverStripe\Versioned\Staged\RecursivePublishable;
 use SilverStripe\Versioned\Versioned;
 
 /**

diff --git a/tests/php/PublishRecursive/PublishRecursiveTest.php b/tests/php/PublishRecursive/PublishRecursiveTest.php
@@ -4,7 +4,7 @@
 
 use SilverStripe\Dev\SapphireTest;
 use SilverStripe\ORM\Queries\SQLSelect;
-use SilverStripe\Versioned\RecursivePublishable;
+use SilverStripe\Versioned\Staged\RecursivePublishable;
 use SilverStripe\Versioned\Versioned;
 
 class PublishRecursiveTest extends SapphireTest

diff --git a/tests/php/VersionedDeletedVersionsTest.php b/tests/php/VersionedDeletedVersionsTest.php
@@ -5,7 +5,7 @@
 use SilverStripe\Dev\SapphireTest;
 use SilverStripe\ORM\FieldType\DBDatetime;
 use SilverStripe\ORM\Queries\SQLSelect;
-use SilverStripe\Versioned\RecursivePublishable;
+use SilverStripe\Versioned\Staged\RecursivePublishable;
 use SilverStripe\Versioned\Tests\VersionsDeletedVersionsTest\CompanyOfficeLocation;
 use SilverStripe\Versioned\Tests\VersionsDeletedVersionsTest\CompanyPage;
 use SilverStripe\Versioned\Tests\VersionsDeletedVersionsTest\GalleryBlock;

diff --git a/tests/php/VersionedGridFieldItemRequestTest/UnversionedObject.php b/tests/php/VersionedGridFieldItemRequestTest/UnversionedObject.php
@@ -4,7 +4,7 @@
 
 use SilverStripe\Dev\TestOnly;
 use SilverStripe\ORM\DataObject;
-use SilverStripe\Versioned\RecursivePublishable;
+use SilverStripe\Versioned\Staged\RecursivePublishable;
 
 /**
  * @mixin RecursivePublishable

diff --git a/tests/php/VersionedGridFieldItemRequestTest/UnversionedOwner.php b/tests/php/VersionedGridFieldItemRequestTest/UnversionedOwner.php
@@ -4,7 +4,7 @@
 
 use SilverStripe\Dev\TestOnly;
 use SilverStripe\ORM\DataObject;
-use SilverStripe\Versioned\RecursivePublishable;
+use SilverStripe\Versioned\Staged\RecursivePublishable;
 
 /**
  * @mixin RecursivePublishable

diff --git a/tests/php/VersionedGridFieldItemRequestTest/VersionedObject.php b/tests/php/VersionedGridFieldItemRequestTest/VersionedObject.php
@@ -4,7 +4,7 @@
 
 use SilverStripe\Dev\TestOnly;
 use SilverStripe\ORM\DataObject;
-use SilverStripe\Versioned\RecursivePublishable;
+use SilverStripe\Versioned\Staged\RecursivePublishable;
 use SilverStripe\Versioned\Versioned;
 
 /**

diff --git a/tests/php/VersionedGridFieldItemRequestTest/VersionedOwner.php b/tests/php/VersionedGridFieldItemRequestTest/VersionedOwner.php
@@ -4,7 +4,7 @@
 
 use SilverStripe\Dev\TestOnly;
 use SilverStripe\ORM\DataObject;
-use SilverStripe\Versioned\RecursivePublishable;
+use SilverStripe\Versioned\Staged\RecursivePublishable;
 use SilverStripe\Versioned\Versioned;
 
 /**

diff --git a/tests/php/VersionedManyManyThroughListTest/VersionedObject.php b/tests/php/VersionedManyManyThroughListTest/VersionedObject.php
@@ -5,7 +5,7 @@
 use SilverStripe\Dev\TestOnly;
 use SilverStripe\ORM\DataObject;
 use SilverStripe\ORM\ManyManyThroughList;
-use SilverStripe\Versioned\RecursivePublishable;
+use SilverStripe\Versioned\Staged\RecursivePublishable;
 use SilverStripe\Versioned\Versioned;
 
 /**

diff --git a/tests/php/VersionedOwnershipTest.php b/tests/php/VersionedOwnershipTest.php
@@ -2,8 +2,8 @@
 
 namespace SilverStripe\Versioned\Tests;
 
-use SilverStripe\Versioned\ChangeSet;
-use SilverStripe\Versioned\ChangeSetItem;
+use SilverStripe\Versioned\Staged\ChangeSet;
+use SilverStripe\Versioned\Staged\ChangeSetItem;
 use SilverStripe\Versioned\Tests\VersionedOwnershipTest\Attachment;
 use SilverStripe\Versioned\Tests\VersionedOwnershipTest\Banner;
 use SilverStripe\Versioned\Tests\VersionedOwnershipTest\Image;

diff --git a/tests/php/VersionedOwnershipTest/Attachment.php b/tests/php/VersionedOwnershipTest/Attachment.php
@@ -4,7 +4,7 @@
 
 use SilverStripe\Dev\TestOnly;
 use SilverStripe\ORM\DataObject;
-use SilverStripe\Versioned\RecursivePublishable;
+use SilverStripe\Versioned\Staged\RecursivePublishable;
 use SilverStripe\Versioned\Versioned;
 
 /**

diff --git a/tests/php/VersionedOwnershipTest/Banner.php b/tests/php/VersionedOwnershipTest/Banner.php
@@ -4,7 +4,7 @@
 
 use SilverStripe\Dev\TestOnly;
 use SilverStripe\ORM\DataObject;
-use SilverStripe\Versioned\RecursivePublishable;
+use SilverStripe\Versioned\Staged\RecursivePublishable;
 use SilverStripe\Versioned\Versioned;
 
 /**

diff --git a/tests/php/VersionedOwnershipTest/CustomRelation.php b/tests/php/VersionedOwnershipTest/CustomRelation.php
@@ -5,7 +5,7 @@
 use SilverStripe\Dev\TestOnly;
 use SilverStripe\ORM\DataList;
 use SilverStripe\ORM\DataObject;
-use SilverStripe\Versioned\RecursivePublishable;
+use SilverStripe\Versioned\Staged\RecursivePublishable;
 use SilverStripe\Versioned\Versioned;
 
 /**

diff --git a/tests/php/VersionedOwnershipTest/Image.php b/tests/php/VersionedOwnershipTest/Image.php
@@ -4,7 +4,7 @@
 
 use SilverStripe\Dev\TestOnly;
 use SilverStripe\ORM\DataObject;
-use SilverStripe\Versioned\RecursivePublishable;
+use SilverStripe\Versioned\Staged\RecursivePublishable;
 use SilverStripe\Versioned\Versioned;
 
 /**

diff --git a/tests/php/VersionedOwnershipTest/OwnedByUnversioned.php b/tests/php/VersionedOwnershipTest/OwnedByUnversioned.php
@@ -4,7 +4,7 @@
 
 use SilverStripe\Dev\TestOnly;
 use SilverStripe\ORM\DataObject;
-use SilverStripe\Versioned\RecursivePublishable;
+use SilverStripe\Versioned\Staged\RecursivePublishable;
 use SilverStripe\Versioned\Versioned;
 
 /**

diff --git a/tests/php/VersionedOwnershipTest/Related.php b/tests/php/VersionedOwnershipTest/Related.php
@@ -4,7 +4,7 @@
 
 use SilverStripe\Dev\TestOnly;
 use SilverStripe\ORM\DataObject;
-use SilverStripe\Versioned\RecursivePublishable;
+use SilverStripe\Versioned\Staged\RecursivePublishable;
 use SilverStripe\Versioned\Versioned;
 
 /**

diff --git a/tests/php/VersionedOwnershipTest/RelatedMany.php b/tests/php/VersionedOwnershipTest/RelatedMany.php
@@ -4,7 +4,7 @@
 
 use SilverStripe\Dev\TestOnly;
 use SilverStripe\ORM\DataObject;
-use SilverStripe\Versioned\RecursivePublishable;
+use SilverStripe\Versioned\Staged\RecursivePublishable;
 use SilverStripe\Versioned\Versioned;
 
 /**

diff --git a/tests/php/VersionedOwnershipTest/TestObject.php b/tests/php/VersionedOwnershipTest/TestObject.php
@@ -4,7 +4,7 @@
 
 use SilverStripe\Dev\TestOnly;
 use SilverStripe\ORM\DataObject;
-use SilverStripe\Versioned\RecursivePublishable;
+use SilverStripe\Versioned\Staged\RecursivePublishable;
 use SilverStripe\Versioned\Versioned;
 
 /**

diff --git a/tests/php/VersionedOwnershipTest/TestPage.php b/tests/php/VersionedOwnershipTest/TestPage.php
@@ -5,7 +5,7 @@
 use SilverStripe\Dev\TestOnly;
 use SilverStripe\ORM\DataList;
 use SilverStripe\ORM\DataObject;
-use SilverStripe\Versioned\RecursivePublishable;
+use SilverStripe\Versioned\Staged\RecursivePublishable;
 use SilverStripe\Versioned\Versioned;
 
 /**

diff --git a/tests/php/VersionedOwnershipTest/UnversionedOwner.php b/tests/php/VersionedOwnershipTest/UnversionedOwner.php
@@ -4,7 +4,7 @@
 
 use SilverStripe\Dev\TestOnly;
 use SilverStripe\ORM\DataObject;
-use SilverStripe\Versioned\RecursivePublishable;
+use SilverStripe\Versioned\Staged\RecursivePublishable;
 
 /**
  * @mixin RecursivePublishable

diff --git a/tests/php/VersionedTest.php b/tests/php/VersionedTest.php
@@ -22,7 +22,7 @@
 use SilverStripe\ORM\DB;
 use SilverStripe\ORM\FieldType\DBDatetime;
 use SilverStripe\Security\IdentityStore;
-use SilverStripe\Versioned\ChangeSet;
+use SilverStripe\Versioned\Staged\ChangeSet;
 use SilverStripe\Versioned\Versioned;
 
 class VersionedTest extends SapphireTest

diff --git a/tests/php/VersionedTest/ChangeSetTestObject.php b/tests/php/VersionedTest/ChangeSetTestObject.php
@@ -6,7 +6,7 @@
 use SilverStripe\ORM\DataObject;
 use SilverStripe\ORM\HasManyList;
 use SilverStripe\ORM\ManyManyList;
-use SilverStripe\Versioned\RecursivePublishable;
+use SilverStripe\Versioned\Staged\RecursivePublishable;
 use SilverStripe\Versioned\Versioned;
 use SilverStripe\ORM\Hierarchy\Hierarchy;