Make it easy to add payment info to \Drupal\commerce_payment\Exception\PaymentGatewayException

Problem/Motivation

Now that we're logging failed payment let's make it easy to attach payments to the exception so we can get extra information.

This will allow reports about fail payments to track problems with specific card types.

Proposed resolution

PaymentGatewayException::createForPayment() to make passing payment info to the failed payment event easier.

Once this has landed I'll be working on

• Paypal: #3412365: Use PaymentGatewayException:: createForPayment()
• Stripe: #3423811: Use PaymentGatewayException:: createForPayment()
• Braintree: #3410198: Use PaymentGatewayException:: createForPayment()
• Authorize.net: #3425496: Use PaymentGatewayException:: createForPayment()
• Square: #3425498: Use PaymentGatewayException:: createForPayment()

Remaining tasks

None

User interface changes

None

API changes

New method PaymentGatewayException::createForPayment() that attaches a payment or payment method to an exception. This in turn allows this information to get to the \Drupal\commerce_payment\Event\FailedPaymentEvent so there's more context about what has failed - if the payment gateway provides it.

Data model changes

None