Add consistency between checkTemplateFileExists functions, #22586
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
Add consistency between
checkTemplateFileExists
functions, resolving phpdoc issues in the process.Before
Each
checkTemplateFileExists
method in core is fundamentally performing the same job (on different components). Therefore it makes sense for the method comment to match.In doing so, these methods have a consistent signature, accepting either
string|null
for$suffix
.The primary benefit of this is that the method in
CRM/Profile/Form.php
is now correctly documented as accepting astring
for$suffix
.After
Consistency added.