woocommerce/includes/shipping/free-shipping/class-wc-shipping-free-ship...

238 lines
5.8 KiB
PHP

<?php
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly
}
/**
* Free Shipping Method
*
* A simple shipping method for free shipping
*
* @class WC_Shipping_Free_Shipping
* @version 2.3.0
* @package WooCommerce/Classes/Shipping
* @author WooThemes
*/
class WC_Shipping_Free_Shipping extends WC_Shipping_Method {
/**
* __construct function.
*
* @return void
*/
function __construct() {
$this->id = 'free_shipping';
$this->method_title = __( 'Free Shipping', 'woocommerce' );
$this->init();
}
/**
* init function.
*
* @return void
*/
function init() {
// Load the settings.
$this->init_form_fields();
$this->init_settings();
// Define user set variables
$this->enabled = $this->get_option( 'enabled' );
$this->title = $this->get_option( 'title' );
$this->min_amount = $this->get_option( 'min_amount', 0 );
$this->availability = $this->get_option( 'availability' );
$this->countries = $this->get_option( 'countries' );
$this->requires = $this->get_option( 'requires' );
// Actions
add_action( 'woocommerce_update_options_shipping_' . $this->id, array( $this, 'process_admin_options' ) );
}
/**
* Initialise Gateway Settings Form Fields
*
* @return void
*/
function init_form_fields() {
$this->form_fields = array(
'enabled' => array(
'title' => __( 'Enable/Disable', 'woocommerce' ),
'type' => 'checkbox',
'label' => __( 'Enable Free Shipping', 'woocommerce' ),
'default' => 'yes'
),
'title' => array(
'title' => __( 'Method Title', 'woocommerce' ),
'type' => 'text',
'description' => __( 'This controls the title which the user sees during checkout.', 'woocommerce' ),
'default' => __( 'Free Shipping', 'woocommerce' ),
'desc_tip' => true,
),
'availability' => array(
'title' => __( 'Method availability', 'woocommerce' ),
'type' => 'select',
'default' => 'all',
'class' => 'availability',
'options' => array(
'all' => __( 'All allowed countries', 'woocommerce' ),
'specific' => __( 'Specific Countries', 'woocommerce' )
)
),
'countries' => array(
'title' => __( 'Specific Countries', 'woocommerce' ),
'type' => 'multiselect',
'class' => 'chosen_select',
'css' => 'width: 450px;',
'default' => '',
'options' => WC()->countries->get_shipping_countries(),
'custom_attributes' => array(
'data-placeholder' => __( 'Select some countries', 'woocommerce' )
)
),
'requires' => array(
'title' => __( 'Free Shipping Requires...', 'woocommerce' ),
'type' => 'select',
'default' => '',
'options' => array(
'' => __( 'N/A', 'woocommerce' ),
'coupon' => __( 'A valid free shipping coupon', 'woocommerce' ),
'min_amount' => __( 'A minimum order amount (defined below)', 'woocommerce' ),
'either' => __( 'A minimum order amount OR a coupon', 'woocommerce' ),
'both' => __( 'A minimum order amount AND a coupon', 'woocommerce' ),
)
),
'min_amount' => array(
'title' => __( 'Minimum Order Amount', 'woocommerce' ),
'type' => 'price',
'placeholder' => wc_format_localized_price( 0 ),
'description' => __( 'Users will need to spend this amount to get free shipping (if enabled above).', 'woocommerce' ),
'default' => '0',
'desc_tip' => true
)
);
}
/**
* Admin Panel Options
* - Options for bits like 'title' and availability on a country-by-country basis
*
* @since 1.0.0
* @return void
*/
public function admin_options() {
?>
<h3><?php _e( 'Free Shipping', 'woocommerce' ); ?></h3>
<table class="form-table">
<?php
// Generate the HTML For the settings form.
$this->generate_settings_html();
?>
</table><!--/.form-table-->
<?php
}
/**
* is_available function.
*
* @param mixed $package
* @return bool
*/
function is_available( $package ) {
if ( 'no' == $this->enabled ) {
return false;
}
if ( 'specific' == $this->availability ) {
$ship_to_countries = $this->countries;
} else {
$ship_to_countries = array_keys( WC()->countries->get_shipping_countries() );
}
if ( is_array( $ship_to_countries ) && ! in_array( $package['destination']['country'], $ship_to_countries ) ) {
return false;
}
// Enabled logic
$is_available = false;
$has_coupon = false;
$has_met_min_amount = false;
if ( in_array( $this->requires, array( 'coupon', 'either', 'both' ) ) ) {
if ( $coupons = WC()->cart->get_coupons() ) {
foreach ( $coupons as $code => $coupon ) {
if ( $coupon->is_valid() && $coupon->enable_free_shipping() ) {
$has_coupon = true;
}
}
}
}
if ( in_array( $this->requires, array( 'min_amount', 'either', 'both' ) ) && isset( WC()->cart->cart_contents_total ) ) {
if ( WC()->cart->prices_include_tax ) {
$total = WC()->cart->cart_contents_total + array_sum( WC()->cart->taxes );
} else {
$total = WC()->cart->cart_contents_total;
}
if ( $total >= $this->min_amount ) {
$has_met_min_amount = true;
}
}
switch ( $this->requires ) {
case 'min_amount' :
if ( $has_met_min_amount ) {
$is_available = true;
}
break;
case 'coupon' :
if ( $has_coupon ) {
$is_available = true;
}
break;
case 'both' :
if ( $has_met_min_amount && $has_coupon ) {
$is_available = true;
}
break;
case 'either' :
if ( $has_met_min_amount || $has_coupon ) {
$is_available = true;
}
break;
default :
$is_available = true;
break;
}
return apply_filters( 'woocommerce_shipping_' . $this->id . '_is_available', $is_available, $package );
}
/**
* calculate_shipping function.
*
* @return array
*/
function calculate_shipping() {
$args = array(
'id' => $this->id,
'label' => $this->title,
'cost' => 0,
'taxes' => false
);
$this->add_rate( $args );
}
}