Add $modx->deprecated method to log usage of deprecated methods #14127
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
This is to be used as a standardised way to mark functionality as deprecated, by calling it from within the deprecated function with at least the version it was marked as deprecated in. Additional information like the calling function is automatically added, to ease identifying code that needs to be updated. If the deprecated function cannot be automatically determined properly (e.g. the deprecated function is a snippet, which would show up as "include" in "modScript" being deprecated, or if a deprecation pertains about the usage of a full object) the third param can be provided to manually name the deprecated function.
Jako
previously requested changes
Nov 4, 2018
…t we cannot yet deprecate It's still in use in the core, so would cause an entry to the log on each manager request, which needs to be resolved first in a spearate PR that handles the removal of modAction.
Looking forward to the day we can use short syntax all over the core. :D
Mark-H
added
area-core
pr/review-needed
opengeek
approved these changes
Nov 5, 2018
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.
What does it do?
This PR adds a new method to the modX object,
deprecated, which is to be used to log usage of deprecated methods across the core. Each unique message (deprecated method + caller) is only logged once per request. A setting is added that allows disabling the logging.I've also done a search for
@deprecateddocblocks, and added appropriate messages in various locations. Some code was deprecated way back in 2.1, so I look forward to seeing that removed in 3.0.Why is it needed?
As we get ready to cleanup some code with 3.0, it's important users can be sure their site can be safely upgraded. Old or custom extras may use functionality that is no longer supported and will be removed in 3.0, which will require manual intervention.
The
deprecatedmethod will allow a site to function normally with the deprecated methods still available in 2.7, but thanks to the logging the site owner will have more information on what should be taken care of first.Related issue(s)/PR(s)
#13199, which mentions some deprecated methods for 3.0.