API Delete deprecated canArchive method

silverstripe · Aug 13, 2024 · fade1ca · fade1ca
1 parent a8522c9
commit fade1ca
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 42 deletions.
diff --git a/src/GridFieldArchiveAction.php b/src/GridFieldArchiveAction.php
@@ -11,6 +11,7 @@
 use SilverStripe\Forms\GridField\GridFieldDeleteAction;
 use SilverStripe\ORM\DataObject;
 use SilverStripe\ORM\ValidationException;
+use SilverStripe\View\ViewableData;
 
 /**
  * This class is a {@link GridField} component that replaces the delete action
@@ -176,7 +177,7 @@ public function handleAction(GridField $gridField, $actionName, $arguments, $dat
                 return;
             }
 
-            if (!$item->canArchive()) {
+            if (!$item->canDelete()) {
                 throw new ValidationException(
                     _t(__CLASS__ . '.ArchivePermissionsFailure', "No archive permissions")
                 );
@@ -190,13 +191,13 @@ public function handleAction(GridField $gridField, $actionName, $arguments, $dat
      * Returns the GridField_FormAction if archive can be performed
      *
      * @param GridField $gridField
-     * @param DataObject $record
+     * @param ViewableData $record
      * @return GridField_FormAction|null
      */
     public function getArchiveAction($gridField, $record)
     {
-        /* @var DataObject|Versioned $record */
-        if (!$record->hasMethod('canArchive') || !$record->canArchive()) {
+        /** @var ViewableData|Versioned $record */
+        if (!$record->has_extension(Versioned::class) || !$record->canDelete()) {
             return null;
         }
 

diff --git a/src/Versioned.php b/src/Versioned.php
@@ -1494,45 +1494,19 @@ protected function extendCanUnpublish()
 
     /**
      * Check if the current user is allowed to archive this record.
-     * If extended, ensure that both canDelete and canUnpublish are extended also
      *
-     * @param Member $member
-     * @return bool
+     * We're intentionally using the canDelete check for archiving,
+     * since there's no concept of "deleting" a versioned record
+     * and having separate permission checks was confusing and easy
+     * to forget.
      */
-    public function canArchive($member = null)
+    public function canDelete($member = null): ?bool
     {
-        if (!$member) {
-            $member = Security::getCurrentUser();
-        }
-
-        // Standard mechanism for accepting permission changes from extensions
-        $owner = $this->owner;
-        $extended = $owner->extendedCan('canArchive', $member);
-        if ($extended !== null) {
-            return $extended;
-        }
-
-        // Admin permissions allow
-        if (Permission::checkMember($member, "ADMIN")) {
-            return true;
-        }
-
-        // Check if this record can be deleted from stage
-        if (!$owner->canDelete($member)) {
-            return false;
-        }
-
-        // Check if we can delete from live
-        if (!$owner->canUnpublish($member)) {
+        // If the user isn't allowed to unpublish, they're definitely
+        // not allowed to archive live content.
+        if ($this->hasStages() && $this->isPublished() && !$this->getOwner()->canUnpublish($member)) {
             return false;
         }
-
-        return true;
-    }
-
-    protected function extendCanArchive()
-    {
-        // Prevent canArchive() extending itself
         return null;
     }
 
@@ -1821,7 +1795,7 @@ public function publishSingle()
     /**
      * Removes the record from both live and stage
      *
-     * User code should call {@see canArchive()} prior to invoking this method.
+     * User code should call {@see canDelete()} prior to invoking this method.
      *
      * @return bool Success
      */

diff --git a/src/VersionedGridFieldItemRequest.php b/src/VersionedGridFieldItemRequest.php
@@ -118,7 +118,7 @@ public function doArchive($data, $form)
     {
         /** @var Versioned|DataObject $record */
         $record = $this->getRecord();
-        if (!$record->canArchive()) {
+        if (!$record->canDelete()) {
             return $this->httpError(403);
         }
 
@@ -293,7 +293,7 @@ protected function addVersionedButtons(DataObject $record, FieldList $actions)
         $canPublish = $record->canPublish();
         $canUnpublish = $record->canUnpublish();
         $canEdit = $record->canEdit();
-        $canArchive = $record->canArchive();
+        $canDelete = $record->canDelete();
 
         // "save", supports an alternate state that is still clickable, but notifies the user that the action is not needed.
         $noChangesClasses = 'btn-outline-primary font-icon-tick';
@@ -377,7 +377,7 @@ protected function addVersionedButtons(DataObject $record, FieldList $actions)
         }
 
         // "archive" action
-        if (($isOnDraft || $isPublished) && $canArchive) {
+        if (($isOnDraft || $isPublished) && $canDelete) {
             // Replace "delete" action
             $actions->removeByName('action_doDelete');
             $title = $isPublished