Add deprected warning to apparently unused functions #20192
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
It looks like one check function is only ever called by the other, and the other isn't called from anywhere. What these functions are supposed to do is unclear. The code comment appears to be wrong; the variable $str is not a permission string but is inserted into a query as civicrm_acl.object_table.
|
(Standard links)
|
|
OK - I couldn't spot anything & a deprecation is low-risk |
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
This pair of functions do not appear to be called from anywhere. Marking as deprecated for eventual removal.
Technical Details
It looks like one check function is only ever called by the other, and the other isn't called from anywhere.
What these functions are supposed to do is unclear.
The code comment appears to be wrong; the variable
$stris not a permission string but is inserted into a query ascivicrm_acl.object_table.Comments
That's clear as mud to me, but if they're unused we can just get rid of them.
For that matter, the whole
CRM_ACL_APIclass makes very little sense to me. It's an internal class, not an api, but it's named API, and it does some obscure things with no documentation.