Support passing old method name into deprecatedFunctionWarning #17552
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
|
(Standard links)
|
CRM/Core/Error.php
Outdated
| @@ -1035,12 +1035,17 @@ public static function isAPIError($error, $type = CRM_Core_Error::FATAL_ERROR) { | |||
| * | |||
| * @param $newMethod | |||
| * description of new method (eg. "buildOptions() method in the appropriate BAO object"). | |||
| * @param $oldMethod | |||
There was a problem hiding this comment.
@mattwire my only issue is this comment block - can we add the type (string) here?
mattwire
force-pushed
the
deprecatedfunctionwarning
branch
from
1a00cd2
to
5a0aaa1
Compare
|
The other thing is that the thing that's deprecated is not always a function. Sometimes it's a param. |
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.
Overview
When I originally added this function it replaced a lot of adhoc, inconsistent log messages that were doing the same thing. We are now using this function extensively to indicate that things are deprecated but it does not always work because the calling method is not always the deprecated one. Eg. see #17456 for an example (there are already examples in core where we are doing similar but overriding the
$newMethodtext to include the name of the old method etc.Before
Doesn't work well when caller is not the deprecated method.
After
Works well when caller is deprecated and when caller is not deprecated.
Technical Details
Add an optional second param
$oldMethodComments
@eileenmcnaughton