Add help text to payment processor subject field #15590
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.
Overview
Improves consistency by adding a help icon to the subject field on the "Settings - Payment Processor" form (CiviCRM Admin bar -> Adminster -> System Settings -> Payment Processors add or edit a payment processor).
NOTE: None of the processors that ship with core use a subject field, but the template for the field lives in core and other payment processors rely on it including:
The labels for the subject field vary from payment processor to payment processor depending on how the 'subject_label' is defined in the metadata but the field template is the same.
Before
No blue help icon next to the subject field on the "Settings - Payment Processor" form.
In this example (a site with https://github.com/eileenmcnaughton/nz.co.fuzion.omnipaymultiprocessor installed and the Payment Processor Type "Omnipay - Paybox System" selected) the subject field has the label "Rang":

After
With this change a blue help icon appears next to the subject field on the "Settings - Payment Processor" form. Payment processor developers can populate the help text with a
templates/CRM/Admin/Page/PaymentProcessor.extra.hlp
file like thisExample: Site with TSYS processor set up where the Subject label is "Merchant Site ID" a blue help icon shows up next to it.
