NFC - Deprecate duplicate function #12602
Merged
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.
Summary
As @eileenmcnaughton noted in civicrm/org.civicrm.module.cividiscount#173, there are 2 basically identical functions. This PR deprecates one of them.
Technical Details
Grepping around, both functions are used equally often, but according to the git history, the one in
CRM_Core_DAO
is much older. I was tempted to favor that one because of its grandfatherly status, but I thinkCRM_Core_BAO_SchemaHandler
is a better location, so I'm favoring that one to reduce bloat inCRM_Core_DAO
.The one in
CRM_Core_DAO
had an additional param so I copied it over to the favored function.I've also pushed up stricter validation; switching from "String" which performs no validation to "Alphanumeric" which checks against the only sensible characters a table column ought to contain.