CRM_Financial_Form_PaymentProcessorFormTrait
Trait implements functions to retrieve payment processor related values.
Note that any functions on this class that are supported to be used from outside of core are specifically tagged.
Table of Contents
Methods
- getPaymentProcessorID() : int|null
- Get the ID for the in-use payment processor.
- getPaymentProcessorMode() : string|null
- Get the mode (test or live) of the payment processor.
- getPaymentProcessorValue() : mixed
- Get the value for a field relating to the in-use payment processor.
- getAvailablePaymentProcessorIDS() : false|array<string|int, mixed>
- Get the payment processor IDs available on the form.
- getAvailablePaymentProcessors() : array<string|int, mixed>
- Get the payment processors that are available on the form.
- getPaymentProcessorObject() : CRM_Core_Payment
- Get the payment processor object for the submission, returning the manual one for offline payments.
Methods
getPaymentProcessorID()
Get the ID for the in-use payment processor.
public
getPaymentProcessorID() : int|null
APIYes
Return values
int|nullgetPaymentProcessorMode()
Get the mode (test or live) of the payment processor.
public
getPaymentProcessorMode() : string|null
APIYes
Tags
Return values
string|null —test or live
getPaymentProcessorValue()
Get the value for a field relating to the in-use payment processor.
public
getPaymentProcessorValue(string $fieldName) : mixed
APIYes
All values returned in apiv4 format. Escaping may be required.
Parameters
- $fieldName : string
Tags
getAvailablePaymentProcessorIDS()
Get the payment processor IDs available on the form.
protected
getAvailablePaymentProcessorIDS() : false|array<string|int, mixed>
Return values
false|array<string|int, mixed>getAvailablePaymentProcessors()
Get the payment processors that are available on the form.
protected
getAvailablePaymentProcessors() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getPaymentProcessorObject()
Get the payment processor object for the submission, returning the manual one for offline payments.
protected
getPaymentProcessorObject() : CRM_Core_Payment