File manager

? PNG %k25u25%fgd5n! File manager

File manager - Edit - /home/garrdnwk/public_html/wp-content/plugins/woocommerce/includes/gateways/cod/class-wc-gateway-cod.php

Back
<?php /** * Class WC_Gateway_COD file. * * @package WooCommerce\Gateways / use Automattic\Jetpack\Constants; use Automattic\WooCommerce\Enums\OrderStatus; use Automattic\WooCommerce\Internal\Admin\Settings\Utils as SettingsUtils; if ( ! defined( 'ABSPATH' ) ) { exit; // Exit if accessed directly. } /* * Cash on Delivery Gateway. * * Provides a Cash on Delivery Payment Gateway. * * @class WC_Gateway_COD * @extends WC_Payment_Gateway * @version 2.1.0 * @package WooCommerce\Classes\Payment / class WC_Gateway_COD extends WC_Payment_Gateway { /* * Unique ID for this gateway. * * @var string / const ID = 'cod'; /* * Gateway instructions that will be added to the thank you page and emails. * * @var string / public $instructions; /* * Enable for shipping methods. * * @var array / public $enable_for_methods; /* * Enable for virtual products. * * @var bool / public $enable_for_virtual; /* * Constructor for the gateway. / public function __construct() { // Setup general properties. $this->setup_properties(); // Load the settings. $this->init_form_fields(); $this->init_settings(); // Get settings. $this->title = $this->get_option( 'title' ); $this->description = $this->get_option( 'description' ); $this->instructions = $this->get_option( 'instructions' ); $this->enable_for_methods = $this->get_option( 'enable_for_methods', array() ); $this->enable_for_virtual = $this->get_option( 'enable_for_virtual', 'yes' ) === 'yes'; // Actions. add_action( 'woocommerce_update_options_payment_gateways_' . $this->id, array( $this, 'process_admin_options' ) ); add_action( 'woocommerce_thankyou_' . $this->id, array( $this, 'thankyou_page' ) ); add_filter( 'woocommerce_payment_complete_order_status', array( $this, 'change_payment_complete_order_status' ), 10, 3 ); // Customer Emails. add_action( 'woocommerce_email_before_order_table', array( $this, 'email_instructions' ), 10, 3 ); } /* * Setup general properties for the gateway. / protected function setup_properties() { $this->id = self::ID; $this->icon = apply_filters( 'woocommerce_cod_icon', '' ); $this->method_title = __( 'Cash on delivery', 'woocommerce' ); $this->method_description = __( 'Let your shoppers pay upon delivery — by cash or other methods of payment.', 'woocommerce' ); $this->has_fields = false; } /* * Initialise Gateway Settings Form Fields. / public function init_form_fields() { $this->form_fields = array( 'enabled' => array( 'title' => __( 'Enable/Disable', 'woocommerce' ), 'label' => __( 'Enable cash on delivery', 'woocommerce' ), 'type' => 'checkbox', 'description' => '', 'default' => 'no', ), 'title' => array( 'title' => __( 'Title', 'woocommerce' ), 'type' => 'safe_text', 'description' => __( 'Payment method description that the customer will see on your checkout.', 'woocommerce' ), 'default' => __( 'Cash on delivery', 'woocommerce' ), 'desc_tip' => true, ), 'description' => array( 'title' => __( 'Description', 'woocommerce' ), 'type' => 'textarea', 'description' => __( 'Payment method description that the customer will see on your website.', 'woocommerce' ), 'default' => __( 'Pay with cash upon delivery.', 'woocommerce' ), 'desc_tip' => true, ), 'instructions' => array( 'title' => __( 'Instructions', 'woocommerce' ), 'type' => 'textarea', 'description' => __( 'Instructions that will be added to the thank you page.', 'woocommerce' ), 'default' => __( 'Pay with cash upon delivery.', 'woocommerce' ), 'desc_tip' => true, ), 'enable_for_methods' => array( 'title' => __( 'Enable for shipping methods', 'woocommerce' ), 'type' => 'multiselect', 'class' => 'wc-enhanced-select', 'css' => 'width: 400px;', 'default' => '', 'description' => __( 'If COD is only available for certain methods, set it up here. Leave blank to enable for all methods.', 'woocommerce' ), 'options' => $this->load_shipping_method_options(), 'desc_tip' => true, 'custom_attributes' => array( 'data-placeholder' => __( 'Select shipping methods', 'woocommerce' ), ), ), 'enable_for_virtual' => array( 'title' => __( 'Accept for virtual orders', 'woocommerce' ), 'label' => __( 'Accept COD if the order is virtual', 'woocommerce' ), 'type' => 'checkbox', 'default' => 'yes', ), ); } /* * Check If The Gateway Is Available For Use. * * @return bool / public function is_available() { $is_virtual = true; $shipping_methods = array(); // Get shipping methods from the cart or order. if ( is_wc_endpoint_url( 'order-pay' ) ) { $order = wc_get_order( absint( get_query_var( 'order-pay' ) ) ); $shipping_methods = $order ? $order->get_shipping_methods() : array(); $is_virtual = ! count( $shipping_methods ); } elseif ( WC()->cart && WC()->cart->needs_shipping() ) { $shipping_methods = WC()->cart->get_shipping_methods(); $is_virtual = false; } // If COD is not enabled for virtual orders and the order does not need shipping, return false. if ( ! $this->enable_for_virtual && $is_virtual ) { return false; } // Return early if: // - There are no shipping methods resrictions in place. // - The order is virtual so needs no shipping. // - Shipping methods are not set yet. if ( empty( $this->enable_for_methods ) \|\| $is_virtual \|\| ! $shipping_methods ) { return parent::is_available(); } // Get the selected shipping method ids. This works on both WC_Shipping_Rate and WC_Order_Item_Shipping class instances. $canonical_rate_ids = array_unique( array_values( array_map( function ( $shipping_method ) { return $shipping_method && is_callable( array( $shipping_method, 'get_method_id' ) ) && is_callable( array( $shipping_method, 'get_instance_id' ) ) ? $shipping_method->get_method_id() . ':' . $shipping_method->get_instance_id() : null; }, $shipping_methods ) ) ); if ( ! count( $this->get_matching_rates( $canonical_rate_ids ) ) ) { return false; } return parent::is_available(); } /* * Checks to see whether or not the admin settings are being accessed by the current request. * * @return bool / private function is_accessing_settings() { if ( is_admin() ) { if ( ! is_wc_admin_settings_page() ) { return false; } // phpcs:disable WordPress.Security.NonceVerification if ( ! isset( $_REQUEST['tab'] ) \|\| 'checkout' !== $_REQUEST['tab'] ) { return false; } if ( ! isset( $_REQUEST['section'] ) \|\| self::ID !== $_REQUEST['section'] ) { return false; } // phpcs:enable WordPress.Security.NonceVerification return true; } if ( Constants::is_true( 'REST_REQUEST' ) ) { global $wp; if ( isset( $wp->query_vars['rest_route'] ) && false !== strpos( $wp->query_vars['rest_route'], '/payment_gateways' ) ) { return true; } } return false; } /* * Loads all of the shipping method options for the enable_for_methods field. * * @return array / private function load_shipping_method_options() { // Since this is expensive, we only want to do it if we're actually on the settings page. if ( ! $this->is_accessing_settings() ) { return array(); } $data_store = WC_Data_Store::load( 'shipping-zone' ); $raw_zones = $data_store->get_zones(); $zones = array(); foreach ( $raw_zones as $raw_zone ) { $zones[] = new WC_Shipping_Zone( $raw_zone ); } $zones[] = new WC_Shipping_Zone( 0 ); $options = array(); foreach ( WC()->shipping()->load_shipping_methods() as $method ) { $options[ $method->get_method_title() ] = array(); // Translators: %1$s shipping method name. $options[ $method->get_method_title() ][ $method->id ] = sprintf( __( 'Any "%1$s" method', 'woocommerce' ), $method->get_method_title() ); foreach ( $zones as $zone ) { $shipping_method_instances = $zone->get_shipping_methods(); foreach ( $shipping_method_instances as $shipping_method_instance_id => $shipping_method_instance ) { if ( $shipping_method_instance->id !== $method->id ) { continue; } $option_id = $shipping_method_instance->get_rate_id(); // Translators: %1$s shipping method title, %2$s shipping method id. $option_instance_title = sprintf( __( '%1$s (#%2$s)', 'woocommerce' ), $shipping_method_instance->get_title(), $shipping_method_instance_id ); // Translators: %1$s zone name, %2$s shipping method instance name. $option_title = sprintf( __( '%1$s – %2$s', 'woocommerce' ), $zone->get_id() ? $zone->get_zone_name() : __( 'Other locations', 'woocommerce' ), $option_instance_title ); $options[ $method->get_method_title() ][ $option_id ] = $option_title; } } } return $options; } /* * Indicates whether a rate exists in an array of canonically-formatted rate IDs that activates this gateway. * * @since 3.4.0 * * @param array $rate_ids Rate ids to check. * @return array / private function get_matching_rates( $rate_ids ) { // First, match entries in 'method_id:instance_id' format. Then, match entries in 'method_id' format by stripping off the instance ID from the candidates. return array_unique( array_merge( array_intersect( $this->enable_for_methods, $rate_ids ), array_intersect( $this->enable_for_methods, array_unique( array_map( 'wc_get_string_before_colon', $rate_ids ) ) ) ) ); } /* * Process the payment and return the result. * * @param int $order_id Order ID. * @return array / public function process_payment( $order_id ) { $order = wc_get_order( $order_id ); if ( $order->get_total() > 0 ) { /* * Filter the order status for COD orders. * * @since 2.6.0 * * @param string $order_status Default status for COD orders. / $process_payment_status = apply_filters( 'woocommerce_cod_process_payment_order_status', $order->has_downloadable_item() ? OrderStatus::ON_HOLD : OrderStatus::PROCESSING, $order ); // Mark as processing or on-hold (payment won't be taken until delivery). $order->update_status( $process_payment_status, __( 'Payment to be made upon delivery.', 'woocommerce' ) ); } else { $order->payment_complete(); } // Remove cart. WC()->cart->empty_cart(); // Return thankyou redirect. return array( 'result' => 'success', 'redirect' => $this->get_return_url( $order ), ); } /* * Output for the order received page. / public function thankyou_page() { if ( $this->instructions ) { echo wp_kses_post( wpautop( wptexturize( $this->instructions ) ) ); } } /* * Change payment complete order status to completed for COD orders. * * @since 3.1.0 * @param string $status Current order status. * @param int $order_id Order ID. * @param WC_Order\|false $order Order object. * @return string / public function change_payment_complete_order_status( $status, $order_id = 0, $order = false ) { if ( $order && self::ID === $order->get_payment_method() ) { $status = OrderStatus::COMPLETED; } return $status; } /* * Add content to the WC emails. * * @param WC_Order $order Order object. * @param bool $sent_to_admin Sent to admin. * @param bool $plain_text Email format: plain text or HTML. / public function email_instructions( $order, $sent_to_admin, $plain_text = false ) { if ( $this->instructions && ! $sent_to_admin && $this->id === $order->get_payment_method() ) { echo wp_kses_post( wpautop( wptexturize( $this->instructions ) ) . PHP_EOL ); } } /* * Get the settings URL for the gateway. * * @return string The settings page URL for the gateway. */ public function get_settings_url() { // Search for a WC_Settings_Payment_Gateways instance in the settings pages. $payments_settings_page = null; foreach ( WC_Admin_Settings::get_settings_pages() as $settings_page ) { if ( $settings_page instanceof WC_Settings_Payment_Gateways ) { $payments_settings_page = $settings_page; break; } } // If no instance found, return the default settings URL (the Reactified page). if ( empty( $payments_settings_page ) ) { return SettingsUtils::wc_payments_settings_url( '/' . WC_Settings_Payment_Gateways::OFFLINE_SECTION_NAME . '/' . $this->id ); } $should_use_react_settings_page = $payments_settings_page->should_render_react_section( WC_Settings_Payment_Gateways::COD_SECTION_NAME ); // We must not include both the path and the section query parameter, as this can cause weird behavior. return SettingsUtils::wc_payments_settings_url( $should_use_react_settings_page ? '/' . WC_Settings_Payment_Gateways::OFFLINE_SECTION_NAME . '/' . $this->id : null, $should_use_react_settings_page ? array() : array( 'section' => $this->id ) ); } }