class-wc-gateway-cheque.php
202 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Class WC_Gateway_Cheque file. |
| 4 | * |
| 5 | * @package WooCommerce\Gateways |
| 6 | */ |
| 7 | |
| 8 | use Automattic\WooCommerce\Enums\OrderStatus; |
| 9 | use Automattic\WooCommerce\Internal\Admin\Settings\Utils as SettingsUtils; |
| 10 | |
| 11 | if ( ! defined( 'ABSPATH' ) ) { |
| 12 | exit; // Exit if accessed directly. |
| 13 | } |
| 14 | |
| 15 | /** |
| 16 | * Cheque Payment Gateway. |
| 17 | * |
| 18 | * Provides a Cheque Payment Gateway, mainly for testing purposes. |
| 19 | * |
| 20 | * @class WC_Gateway_Cheque |
| 21 | * @extends WC_Payment_Gateway |
| 22 | * @version 2.1.0 |
| 23 | * @package WooCommerce\Classes\Payment |
| 24 | */ |
| 25 | class WC_Gateway_Cheque extends WC_Payment_Gateway { |
| 26 | |
| 27 | /** |
| 28 | * Unique ID for this gateway. |
| 29 | * |
| 30 | * @var string |
| 31 | */ |
| 32 | const ID = 'cheque'; |
| 33 | |
| 34 | /** |
| 35 | * Gateway instructions that will be added to the thank you page and emails. |
| 36 | * |
| 37 | * @var string |
| 38 | */ |
| 39 | public $instructions; |
| 40 | |
| 41 | /** |
| 42 | * Constructor for the gateway. |
| 43 | */ |
| 44 | public function __construct() { |
| 45 | $this->id = self::ID; |
| 46 | $this->icon = apply_filters( 'woocommerce_cheque_icon', '' ); |
| 47 | $this->has_fields = false; |
| 48 | $this->method_title = _x( 'Check payments', 'Check payment method', 'woocommerce' ); |
| 49 | $this->method_description = __( 'Take payments in person via checks. This offline gateway can also be useful to test purchases.', 'woocommerce' ); |
| 50 | |
| 51 | // Load the settings. |
| 52 | $this->init_form_fields(); |
| 53 | $this->init_settings(); |
| 54 | |
| 55 | // Define user set variables. |
| 56 | $this->title = $this->get_option( 'title' ); |
| 57 | $this->description = $this->get_option( 'description' ); |
| 58 | $this->instructions = $this->get_option( 'instructions' ); |
| 59 | |
| 60 | // Actions. |
| 61 | add_action( 'woocommerce_update_options_payment_gateways_' . $this->id, array( $this, 'process_admin_options' ) ); |
| 62 | add_action( 'woocommerce_thankyou_cheque', array( $this, 'thankyou_page' ) ); |
| 63 | |
| 64 | // Customer Emails. |
| 65 | add_action( 'woocommerce_email_before_order_table', array( $this, 'email_instructions' ), 10, 3 ); |
| 66 | } |
| 67 | |
| 68 | /** |
| 69 | * Initialise Gateway Settings Form Fields. |
| 70 | */ |
| 71 | public function init_form_fields() { |
| 72 | |
| 73 | $this->form_fields = array( |
| 74 | 'enabled' => array( |
| 75 | 'title' => __( 'Enable/Disable', 'woocommerce' ), |
| 76 | 'type' => 'checkbox', |
| 77 | 'label' => __( 'Enable check payments', 'woocommerce' ), |
| 78 | 'default' => 'no', |
| 79 | ), |
| 80 | 'title' => array( |
| 81 | 'title' => __( 'Title', 'woocommerce' ), |
| 82 | 'type' => 'safe_text', |
| 83 | 'description' => __( 'This controls the title which the user sees during checkout.', 'woocommerce' ), |
| 84 | 'default' => _x( 'Check payments', 'Check payment method', 'woocommerce' ), |
| 85 | 'desc_tip' => true, |
| 86 | ), |
| 87 | 'description' => array( |
| 88 | 'title' => __( 'Description', 'woocommerce' ), |
| 89 | 'type' => 'textarea', |
| 90 | 'description' => __( 'Payment method description that the customer will see on your checkout.', 'woocommerce' ), |
| 91 | 'default' => __( 'Please send a check to Store Name, Store Street, Store Town, Store State / County, Store Postcode.', 'woocommerce' ), |
| 92 | 'desc_tip' => true, |
| 93 | ), |
| 94 | 'instructions' => array( |
| 95 | 'title' => __( 'Instructions', 'woocommerce' ), |
| 96 | 'type' => 'textarea', |
| 97 | 'description' => __( 'Instructions that will be added to the thank you page and emails.', 'woocommerce' ), |
| 98 | 'default' => '', |
| 99 | 'desc_tip' => true, |
| 100 | ), |
| 101 | ); |
| 102 | } |
| 103 | |
| 104 | /** |
| 105 | * Output for the order received page. |
| 106 | */ |
| 107 | public function thankyou_page() { |
| 108 | if ( $this->instructions ) { |
| 109 | echo wp_kses_post( wpautop( wptexturize( $this->instructions ) ) ); |
| 110 | } |
| 111 | } |
| 112 | |
| 113 | /** |
| 114 | * Add content to the WC emails. |
| 115 | * |
| 116 | * @access public |
| 117 | * @param WC_Order $order Order object. |
| 118 | * @param bool $sent_to_admin Sent to admin. |
| 119 | * @param bool $plain_text Email format: plain text or HTML. |
| 120 | */ |
| 121 | public function email_instructions( $order, $sent_to_admin, $plain_text = false ) { |
| 122 | if ( $this->instructions && ! $sent_to_admin && self::ID === $order->get_payment_method() ) { |
| 123 | /** |
| 124 | * Filter the email instructions order status. |
| 125 | * |
| 126 | * @since 7.4 |
| 127 | * |
| 128 | * @param string $status The default status. |
| 129 | * @param object $order The order object. |
| 130 | */ |
| 131 | $instructions_order_status = apply_filters( 'woocommerce_cheque_email_instructions_order_status', OrderStatus::ON_HOLD, $order ); |
| 132 | if ( $order->has_status( $instructions_order_status ) ) { |
| 133 | echo wp_kses_post( wpautop( wptexturize( $this->instructions ) ) . PHP_EOL ); |
| 134 | } |
| 135 | } |
| 136 | } |
| 137 | |
| 138 | /** |
| 139 | * Process the payment and return the result. |
| 140 | * |
| 141 | * @param int $order_id Order ID. |
| 142 | * @return array |
| 143 | */ |
| 144 | public function process_payment( $order_id ) { |
| 145 | |
| 146 | $order = wc_get_order( $order_id ); |
| 147 | |
| 148 | if ( $order->get_total() > 0 ) { |
| 149 | /** |
| 150 | * Filter the order status for cheque payment. |
| 151 | * |
| 152 | * @since 3.6.0 |
| 153 | * |
| 154 | * @param string $status The default status. |
| 155 | * @param object $order The order object. |
| 156 | */ |
| 157 | $process_payment_status = apply_filters( 'woocommerce_cheque_process_payment_order_status', OrderStatus::ON_HOLD, $order ); |
| 158 | // Mark as on-hold (we're awaiting the cheque). |
| 159 | $order->update_status( $process_payment_status, _x( 'Awaiting check payment.', 'Check payment method', 'woocommerce' ) ); |
| 160 | } else { |
| 161 | $order->payment_complete(); |
| 162 | } |
| 163 | |
| 164 | // Remove cart. |
| 165 | WC()->cart->empty_cart(); |
| 166 | |
| 167 | // Return thankyou redirect. |
| 168 | return array( |
| 169 | 'result' => 'success', |
| 170 | 'redirect' => $this->get_return_url( $order ), |
| 171 | ); |
| 172 | } |
| 173 | |
| 174 | /** |
| 175 | * Get the settings URL for the gateway. |
| 176 | * |
| 177 | * @return string The settings page URL for the gateway. |
| 178 | */ |
| 179 | public function get_settings_url() { |
| 180 | // Search for a WC_Settings_Payment_Gateways instance in the settings pages. |
| 181 | $payments_settings_page = null; |
| 182 | foreach ( WC_Admin_Settings::get_settings_pages() as $settings_page ) { |
| 183 | if ( $settings_page instanceof WC_Settings_Payment_Gateways ) { |
| 184 | $payments_settings_page = $settings_page; |
| 185 | break; |
| 186 | } |
| 187 | } |
| 188 | // If no instance found, return the default settings URL (the Reactified page). |
| 189 | if ( empty( $payments_settings_page ) ) { |
| 190 | return SettingsUtils::wc_payments_settings_url( '/' . WC_Settings_Payment_Gateways::OFFLINE_SECTION_NAME . '/' . $this->id ); |
| 191 | } |
| 192 | |
| 193 | $should_use_react_settings_page = $payments_settings_page->should_render_react_section( WC_Settings_Payment_Gateways::CHEQUE_SECTION_NAME ); |
| 194 | |
| 195 | // We must not include both the path and the section query parameter, as this can cause weird behavior. |
| 196 | return SettingsUtils::wc_payments_settings_url( |
| 197 | $should_use_react_settings_page ? '/' . WC_Settings_Payment_Gateways::OFFLINE_SECTION_NAME . '/' . $this->id : null, |
| 198 | $should_use_react_settings_page ? array() : array( 'section' => $this->id ) |
| 199 | ); |
| 200 | } |
| 201 | } |
| 202 |