woocommerce/payment-gateway/api/class-sv-wc-payment-gateway-api-response-message-helper.php
<?php
/**
* WooCommerce Payment Gateway Framework
*
* This source file is subject to the GNU General Public License v3.0
* that is bundled with this package in the file license.txt.
* It is also available through the world-wide-web at this URL:
* http://www.gnu.org/licenses/gpl-3.0.html
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@skyverge.com so we can send you a copy immediately.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade the plugin to newer
* versions in the future. If you wish to customize the plugin for your
* needs please refer to http://www.skyverge.com
*
* @package SkyVerge/WooCommerce/Payment-Gateway/API
* @author SkyVerge
* @copyright Copyright (c) 2013-2024, SkyVerge, Inc.
* @license http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0
*/
namespace SkyVerge\WooCommerce\PluginFramework\v5_12_4;
defined( 'ABSPATH' ) or exit;
if ( ! class_exists( '\\SkyVerge\\WooCommerce\\PluginFramework\\v5_12_4\\SV_WC_Payment_Gateway_API_Response_Message_Helper' ) ) :
/**
* WooCommerce Payment Gateway API Response Message Helper
*
* This utility class is meant to provide a standard set of error messages to be
* displayed to the customer during checkout.
*
* Most gateways define a plethora of error conditions, some of which a customer
* can resolve on their own, and others which must be handled by the admin/
* merchant. It's not always clear which conditions should be reported to a
* customer, or what the best wording is. This utility class seeks to ease
* the development burden of handling customer-facing error messages by
* defining a set of common error conditions/messages which can be used by
* nearly any gateway.
*
* This class, or a subclass, should be instantiated by the API response object,
* which will use a gateway-specific mapping of error conditions to message,
* and returned by the `SV_WC_Payment_Gateway_API_Response::get_user_message()`
* method implementation. Add new common/generic codes and messages to this
* base class as they are encountered during gateway integration development,
* and use a subclass to include any gateway-specific codes/messages.
*
* @since 2.2.0
*/
#[\AllowDynamicProperties]
class SV_WC_Payment_Gateway_API_Response_Message_Helper {
/**
* Returns a message appropriate for a frontend user. This should be used
* to provide enough information to a user to allow them to resolve an
* issue on their own, but not enough to help nefarious folks fishing for
* info.
*
* @since 2.2.0
*
* @param string[] $message_ids array of string $message_id's which identify the message(s) to return
* @return string a user message, combining all $message_ids
*/
public function get_user_messages( $message_ids ) {
$messages = array();
foreach ( $message_ids as $message_id ) {
$messages[] = $this->get_user_message( $message_id );
}
$messages = implode( ' ', $messages );
return trim( $messages );
}
/**
* Returns a message appropriate for a frontend user. This should be used
* to provide enough information to a user to allow them to resolve an
* issue on their own, but not enough to help nefarious folks fishing for
* info.
*
* @since 2.2.0
* @param string $message_id identifies the message to return
* @return string a user message
*/
public function get_user_message( $message_id ) {
$message = null;
switch ( $message_id ) {
// generic messages
case 'error': $message = esc_html__( 'An error occurred, please try again or try an alternate form of payment', 'woocommerce-plugin-framework' ); break;
case 'decline': $message = esc_html__( 'We cannot process your order with the payment information that you provided. Please use a different payment account or an alternate payment method.', 'woocommerce-plugin-framework' ); break;
case 'held_for_review': $message = esc_html__( 'This order is being placed on hold for review. Please contact us to complete the transaction.', 'woocommerce-plugin-framework' ); break;
/* missing/invalid info */
// csc
case 'held_for_incorrect_csc': $message = esc_html_x( 'This order is being placed on hold for review due to an incorrect card verification number. You may contact the store to complete the transaction.', 'Credit or debit card CSC/CVC/CVV','woocommerce-plugin-framework' ); break;
case 'csc_invalid': $message = esc_html_x( 'The card verification number is invalid, please try again.', 'Credit or debit card CSC/CVC/CVV', 'woocommerce-plugin-framework' ); break;
case 'csc_missing': $message = esc_html_x( 'Please enter your card verification number and try again.', 'Credit or debit card CSC/CVC/CVV', 'woocommerce-plugin-framework' ); break;
// card type
case 'card_type_not_accepted': $message = esc_html_x( 'That card type is not accepted, please use an alternate card or other form of payment.', 'Credit or debit card', 'woocommerce-plugin-framework' ); break;
case 'card_type_invalid': $message = esc_html_x( 'The card type is invalid or does not correlate with the credit card number. Please try again or use an alternate card or other form of payment.', 'Credit or debit card', 'woocommerce-plugin-framework' ); break;
case 'card_type_missing': $message = esc_html_x( 'Please select the card type and try again.', 'Credit or debit card', 'woocommerce-plugin-framework' ); break;
// card number
case 'card_number_type_invalid': $message = esc_html_x( 'The card type is invalid or does not correlate with the credit card number. Please try again or use an alternate card or other form of payment.', 'Credit or debit card', 'woocommerce-plugin-framework' ); break;
case 'card_number_invalid': $message = esc_html_x( 'The card number is invalid, please re-enter and try again.', 'Credit or debit card', 'woocommerce-plugin-framework' ); break;
case 'card_number_missing': $message = esc_html_x( 'Please enter your card number and try again.', 'Credit or debit card','woocommerce-plugin-framework' ); break;
// card expiry
case 'card_expiry_invalid': $message = esc_html_x( 'The card expiration date is invalid, please re-enter and try again.', 'Credit or debit card (whole date issue)', 'woocommerce-plugin-framework' ); break;
case 'card_expiry_month_invalid': $message = esc_html_x( 'The card expiration month is invalid, please re-enter and try again.', 'Credit or debit card', 'woocommerce-plugin-framework' ); break;
case 'card_expiry_year_invalid': $message = esc_html_x( 'The card expiration year is invalid, please re-enter and try again.', 'Credit or debit card', 'woocommerce-plugin-framework' ); break;
case 'card_expiry_missing': $message = esc_html_x( 'Please enter your card expiration date and try again.', 'Credit or debit card','woocommerce-plugin-framework' ); break;
// bank
case 'bank_aba_invalid': $message_id = esc_html__( 'The bank routing number is invalid, please re-enter and try again.', 'woocommerce-plugin-framework' ); break;
case 'bank_account_number_invalid': $message_id = esc_html__( 'The bank account number is invalid, please re-enter and try again.', 'woocommerce-plugin-framework' ); break;
/* decline reasons */
case 'card_expired': $message = esc_html_x( 'The provided card is expired, please use an alternate card or other form of payment.', 'Credit or debit card', 'woocommerce-plugin-framework' ); break;
case 'card_declined': $message = esc_html_x( 'The provided card was declined, please use an alternate card or other form of payment.', 'Credit or debit card', 'woocommerce-plugin-framework' ); break;
case 'insufficient_funds': $message = esc_html_x( 'Insufficient funds in account, please use an alternate card or other form of payment.', 'Credit or debit card', 'woocommerce-plugin-framework' ); break;
case 'card_inactive': $message = esc_html_x( 'The card is inactivate or not authorized for card-not-present transactions, please use an alternate card or other form of payment.', 'Credit or debit card', 'woocommerce-plugin-framework' ); break;
case 'credit_limit_reached': $message = esc_html_x( 'The credit limit for the card has been reached, please use an alternate card or other form of payment.', 'Credit or debit card', 'woocommerce-plugin-framework' ); break;
case 'csc_mismatch': $message = esc_html_x( 'The card verification number does not match. Please re-enter and try again.', 'Credit or debit card CSC/CVC/CVV', 'woocommerce-plugin-framework' ); break;
case 'avs_mismatch': $message = esc_html_x( 'The provided address does not match the billing address for cardholder. Please verify the address and try again.', 'Credit or debit card', 'woocommerce-plugin-framework' ); break;
}
/**
* Payment Gateway API Response User Message Filter.
*
* Allow actors to modify the error message returned to a user when a transaction
* has encountered an error and the admin has enabled the "show detailed
* decline messages" setting
*
* @since 2.2.0
* @param string $message message to show to user
* @param string $message_id machine code for the message, e.g. card_expired
* @param SV_WC_Payment_Gateway_API_Response_Message_Helper $this instance
*/
return apply_filters( 'wc_payment_gateway_transaction_response_user_message', $message, $message_id, $this );
}
}
endif;