Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

API Deprecate Versioned::canArchive() #461

Merged
merged 1 commit into from
Aug 15, 2024
Merged

API Deprecate Versioned::canArchive() #461

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions src/GridFieldArchiveAction.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
namespace SilverStripe\Versioned;

use SilverStripe\Control\Controller;
use SilverStripe\Dev\Deprecation;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridField_ActionMenuItem;
use SilverStripe\Forms\GridField\GridField_ActionProvider;
Expand Down Expand Up @@ -176,7 +177,8 @@ public function handleAction(GridField $gridField, $actionName, $arguments, $dat
return;
}

if (!$item->canArchive()) {
$canArchive = Deprecation::withNoReplacement(fn() => $item->canArchive());
if (!$canArchive) {
throw new ValidationException(
_t(__CLASS__ . '.ArchivePermissionsFailure', "No archive permissions")
);
Expand All @@ -196,7 +198,11 @@ public function handleAction(GridField $gridField, $actionName, $arguments, $dat
public function getArchiveAction($gridField, $record)
{
/* @var DataObject|Versioned $record */
if (!$record->hasMethod('canArchive') || !$record->canArchive()) {
if (!$record->hasMethod('canArchive')) {
return null;
}
$canArchive = Deprecation::withNoReplacement(fn() => $record->canArchive());
if (!$canArchive) {
return null;
}

Expand Down
8 changes: 7 additions & 1 deletion src/Versioned.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1498,16 +1498,18 @@ protected function extendCanUnpublish()
*
* @param Member $member
* @return bool
* @deprecated 5.3.0 Use canDelete() instead.
*/
public function canArchive($member = null)
{
Deprecation::notice('5.3.0', 'Use canDelete() instead.');
if (!$member) {
$member = Security::getCurrentUser();
}

// Standard mechanism for accepting permission changes from extensions
$owner = $this->owner;
$extended = $owner->extendedCan('canArchive', $member);
$extended = Deprecation::withNoReplacement(fn() => $owner->extendedCan('canArchive', $member));
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

extendedCan() will result in calling extendCanArchive() which is also deprecated, so we need to wrap this call too.

if ($extended !== null) {
return $extended;
}
Expand All @@ -1530,8 +1532,12 @@ public function canArchive($member = null)
return true;
}

/**
* @deprecated 5.3.0 Will be removed without equivalent functionality.
*/
protected function extendCanArchive()
{
Deprecation::notice('5.3.0', 'Will be removed without equivalent functionality.');
Comment on lines +1535 to +1540
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

protected methods are part of our definition of public API so we need to deprecate this even though nobody is likely to be calling it directly and it's effectively a no-op.

// Prevent canArchive() extending itself
return null;
}
Expand Down
6 changes: 4 additions & 2 deletions src/VersionedGridFieldItemRequest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
use SilverStripe\CMS\Controllers\CMSMain;
use SilverStripe\Control\HTTPResponse;
use SilverStripe\Core\Convert;
use SilverStripe\Dev\Deprecation;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\Form;
use SilverStripe\Forms\FormAction;
Expand Down Expand Up @@ -118,7 +119,8 @@ public function doArchive($data, $form)
{
/** @var Versioned|DataObject $record */
$record = $this->getRecord();
if (!$record->canArchive()) {
$canArchive = Deprecation::withNoReplacement(fn() => $record->canArchive());
if (!$canArchive) {
return $this->httpError(403);
}

Expand Down Expand Up @@ -293,7 +295,7 @@ protected function addVersionedButtons(DataObject $record, FieldList $actions)
$canPublish = $record->canPublish();
$canUnpublish = $record->canUnpublish();
$canEdit = $record->canEdit();
$canArchive = $record->canArchive();
$canArchive = Deprecation::withNoReplacement(fn() => $record->canArchive());

// "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';
Expand Down
Loading