API Deprecate and update code in preparation for CMS 6 #3023
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
Nov 11, 2024
Comment on lines
+139
to
141
| * @deprecated 5.4.0 will be moved to SilverStripe\ORM\Hierarchy\Hierarchy->cache_allowedChildren | ||
| */ | ||
| protected static $_allowedChildren = []; |
There was a problem hiding this comment.
We don't really have a process for deprecating non-config properties - and this one is very unlikely to be used by downstream devs anyway. I won't mention it in the changelog unless asked to.
GuySartorelli
commented
Nov 11, 2024
Comment on lines
+26
to
29
| /** | ||
| * @deprecated 5.4.0 use class_description instead. | ||
| */ | ||
| private static $description = 'Redirects requests to another location'; |
There was a problem hiding this comment.
Note that while I have added the deprecation notice to subclasses to ensure notices are emitted appropriately, I will only mention the config on SiteTree being deprecated in the changelog.
GuySartorelli
force-pushed
the
pulls/5/deprecation-sitetree1
branch
from
78dadc2
to
32b21de
Compare
GuySartorelli
commented
Nov 11, 2024
| * | ||
| * @return string|null | ||
| */ | ||
| public function i18n_classDescription() |
There was a problem hiding this comment.
i18n_classDescription() is removed here but will now exist on a parent class, so no need to deprecate.
This was referenced Nov 11, 2024
emteknetnz
requested changes
Nov 13, 2024
emteknetnz
approved these changes
Nov 14, 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.
Needs silverstripe/silverstripe-framework#11461 for CI to go green - please merge that PR first.
This PR deprecates code that will be removed in #3022, and adds the new
class_descriptionconfig.Note that there are a lot of methods in #3022 which are being removed from
SiteTreebut are being added to a superclass or to theHierarchyextension in silverstripe/silverstripe-framework#11460. TheHierarchyextension is required to be onSiteTreefor that class and CMSMain to work correctly, so the effect is that the methods are not removed from a downstream developer POV.Downstream developers can still override the methods in subclasses and call
parent::whatever()as though the method was directly implemented onSiteTree.Issue
SiteTreeinCMSMain#2947