API Deprecate Versioned::canArchive() #461
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
GuySartorelli
commented
Aug 13, 2024
| 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)); |
There was a problem hiding this comment.
extendedCan() will result in calling extendCanArchive() which is also deprecated, so we need to wrap this call too.
GuySartorelli
commented
Aug 13, 2024
Comment on lines
+1535
to
+1540
| /** | ||
| * @deprecated 5.3.0 Will be removed without equivalent functionality. | ||
| */ | ||
| protected function extendCanArchive() | ||
| { | ||
| Deprecation::notice('5.3.0', 'Will be removed without equivalent functionality.'); |
There was a problem hiding this comment.
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.
This was referenced Aug 13, 2024
Merged
emteknetnz
requested changes
Aug 14, 2024
GuySartorelli
force-pushed
the
pulls/2/deprecate-canarchive
branch
2 times, most recently
from
77003f3
to
3eefaa5
Compare
GuySartorelli
commented
Aug 14, 2024
src/GridFieldArchiveAction.php
Outdated
Comment on lines
199
to
205
| if (!$record->hasMethod('canArchive') || !$record->canArchive()) { | ||
| if (!$record->hasMethod('canArchive')) { | ||
| return null; | ||
| } | ||
| $canArchive = !Deprecation::withNoReplacement(fn() => $record->canArchive()); | ||
| if ($canArchive) { |
There was a problem hiding this comment.
Had to separate these conditions to comply with #461 (comment)
emteknetnz
requested changes
Aug 14, 2024
GuySartorelli
force-pushed
the
pulls/2/deprecate-canarchive
branch
from
3eefaa5
to
07851ca
Compare
emteknetnz
approved these changes
Aug 15, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For versioned records, there is no concept of "deleting" the record - it's either being archived, unpublished, or in rare cases removed from draft but left published.
Previously the
canDelete()method has been used to check if a record can be removed from draft specifically for versioned records - which is such a rare edge case it almost doesn't bare thinking about, especially given there's no way to do that purely by interacting with the UI, nor with the web API endpoints available in core or supported modules.Instead,
canDelete()should be used to check if the record can be archived. This reduces cognitive load for developers and is a step towards simplifying the overly-complex versioning system. This is also in keeping with other mechanisms, such ascascade_deleteswhich cascades archiving for versioned records.Issue
canArchive()method for CMS 6 #447