API Deprecate API which will be removed in CMS 6 #1868
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
Dec 8, 2024
| @@ -71,6 +71,7 @@ public function getCMSEditLinkForManagedDataObject(DataObject $obj, string $reci | |||
|
|
|||
| /** | |||
| * Get a link to edit this DataObject in the CMS. | |||
| * @deprecated 2.4.0 Will be replaced with SilverStripe\ORM\DataObject::getCMSEditLink() and updateCMSEditLink() | |||
There was a problem hiding this comment.
This should have been done along-side #1809
GuySartorelli
commented
Dec 8, 2024
Comment on lines
-1736
to
1754
| /** @deprecated */ | ||
| // Using session for this is deprecated - see https://github.com/silverstripe/silverstripe-admin/pull/19 | ||
| $session = $this->getRequest()->getSession(); | ||
| return $session->get($this->sessionNamespace() . ".currentPage") ?: null; |
There was a problem hiding this comment.
Will remove this and from setCurrentRecordID() in the related CMS 6 PRs.
7 tasks
GuySartorelli
force-pushed
the
pulls/2/deprecations-cmsmain
branch
from
40b4345 to
54f3513
Compare
GuySartorelli
commented
Dec 9, 2024
| * Sets the ID for the current record which can be retrieved later through {@link currentRecordID()}. | ||
| * Keep in mind that setting an ID through GET/POST or as a URL parameter will overrule this value. | ||
| */ | ||
| public function setCurrentRecordID(?int $id): void |
There was a problem hiding this comment.
Note CMSMain explicitly passes in null, so we have to allow that.
GuySartorelli
commented
Dec 9, 2024
| * Uses {@link getRecord()} and {@link currentRecordID()} | ||
| * to get the currently selected record. | ||
| */ | ||
| public function currentRecord(): ?DataObject |
There was a problem hiding this comment.
This will be null before an edit page is opened, e.g. in CMSMain before selecting a page.
emteknetnz
requested changes
Dec 9, 2024
code/LeftAndMain.php
Outdated
| /** | ||
| * ID of the current record for this request | ||
| */ | ||
| protected ?int $recordID = null; |
There was a problem hiding this comment.
Won't the fact we're suddenly no longer updating $pageID lead to it potentially breaking any subclasses that rely on it?
Seems like we should continue to use $pageID for now, and then rename that to $recordID in CMS 6
GuySartorelli
force-pushed
the
pulls/2/deprecations-cmsmain
branch
from
54f3513 to
877dc3a
Compare
emteknetnz
approved these changes
Dec 10, 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.
Issue
SiteTreeinCMSMainsilverstripe-cms#2947