2011-08-10 17:11:11 +00:00
< ? php
2018-03-07 18:28:57 +00:00
/**
* Class WC_Shipping_Free_Shipping file .
*
* @ package WooCommerce\Shipping
*/
2014-09-20 19:44:32 +00:00
if ( ! defined ( 'ABSPATH' ) ) {
2015-12-11 14:11:12 +00:00
exit ;
2014-09-20 19:44:32 +00:00
}
2013-02-20 17:14:46 +00:00
2011-08-10 17:11:11 +00:00
/**
2015-11-03 13:31:20 +00:00
* Free Shipping Method .
2012-08-14 22:43:48 +00:00
*
2015-11-03 13:31:20 +00:00
* A simple shipping method for free shipping .
2011-08-10 17:11:11 +00:00
*
2014-11-20 00:43:09 +00:00
* @ class WC_Shipping_Free_Shipping
2015-12-11 14:11:12 +00:00
* @ version 2.6 . 0
2014-11-20 00:43:09 +00:00
* @ package WooCommerce / Classes / Shipping
2012-08-14 22:43:48 +00:00
*/
2012-12-31 18:25:09 +00:00
class WC_Shipping_Free_Shipping extends WC_Shipping_Method {
2012-08-14 22:43:48 +00:00
2016-07-19 12:05:25 +00:00
/**
* Min amount to be valid .
*
* @ var integer
*/
2015-12-11 14:11:12 +00:00
public $min_amount = 0 ;
2015-02-03 16:03:28 +00:00
2016-07-19 12:05:25 +00:00
/**
* Requires option .
*
* @ var string
*/
public $requires = '' ;
2015-02-03 16:03:28 +00:00
2013-08-12 21:09:04 +00:00
/**
2015-12-11 14:11:12 +00:00
* Constructor .
2016-07-19 12:05:25 +00:00
*
* @ param int $instance_id Shipping method instance .
2013-08-12 21:09:04 +00:00
*/
2015-12-11 14:11:12 +00:00
public function __construct ( $instance_id = 0 ) {
2016-07-19 12:05:25 +00:00
$this -> id = 'free_shipping' ;
$this -> instance_id = absint ( $instance_id );
2016-10-12 10:16:30 +00:00
$this -> method_title = __ ( 'Free shipping' , 'woocommerce' );
$this -> method_description = __ ( 'Free shipping is a special method which can be triggered with coupons and minimum spends.' , 'woocommerce' );
2016-07-19 12:05:25 +00:00
$this -> supports = array (
2015-12-14 16:56:39 +00:00
'shipping-zones' ,
2016-03-24 18:31:39 +00:00
'instance-settings' ,
'instance-settings-modal' ,
2015-12-11 14:11:12 +00:00
);
2015-12-14 16:56:39 +00:00
2016-07-19 12:05:25 +00:00
$this -> init ();
}
/**
* Initialize free shipping .
*/
public function init () {
// Load the settings.
$this -> init_form_fields ();
$this -> init_settings ();
// Define user set variables.
2019-10-05 23:16:22 +00:00
$this -> title = $this -> get_option ( 'title' );
$this -> min_amount = $this -> get_option ( 'min_amount' , 0 );
$this -> requires = $this -> get_option ( 'requires' );
$this -> ignore_discounts = $this -> get_option ( 'ignore_discounts' );
2016-07-19 12:05:25 +00:00
// Actions.
2015-12-16 13:52:46 +00:00
add_action ( 'woocommerce_update_options_shipping_' . $this -> id , array ( $this , 'process_admin_options' ) );
2019-05-20 10:56:01 +00:00
add_action ( 'admin_footer' , array ( 'WC_Shipping_Free_Shipping' , 'enqueue_admin_js' ), 10 ); // Priority needs to be higher than wc_print_js (25).
2015-12-14 16:56:39 +00:00
}
2013-08-12 21:09:04 +00:00
/**
2016-07-19 12:05:25 +00:00
* Init form fields .
2013-08-12 21:09:04 +00:00
*/
2016-07-19 12:05:25 +00:00
public function init_form_fields () {
$this -> instance_form_fields = array (
2018-03-07 18:04:56 +00:00
'title' => array (
2016-07-19 12:05:25 +00:00
'title' => __ ( 'Title' , 'woocommerce' ),
'type' => 'text' ,
'description' => __ ( 'This controls the title which the user sees during checkout.' , 'woocommerce' ),
'default' => $this -> method_title ,
'desc_tip' => true ,
2014-11-20 00:43:09 +00:00
),
2018-03-07 18:04:56 +00:00
'requires' => array (
2016-10-12 10:16:30 +00:00
'title' => __ ( 'Free shipping requires...' , 'woocommerce' ),
2016-07-19 12:05:25 +00:00
'type' => 'select' ,
'class' => 'wc-enhanced-select' ,
'default' => '' ,
'options' => array (
'' => __ ( 'N/A' , 'woocommerce' ),
'coupon' => __ ( 'A valid free shipping coupon' , 'woocommerce' ),
'min_amount' => __ ( 'A minimum order amount' , 'woocommerce' ),
'either' => __ ( 'A minimum order amount OR a coupon' , 'woocommerce' ),
'both' => __ ( 'A minimum order amount AND a coupon' , 'woocommerce' ),
),
2014-11-20 00:43:09 +00:00
),
2012-11-28 19:54:04 +00:00
'min_amount' => array (
2016-10-12 10:16:30 +00:00
'title' => __ ( 'Minimum order amount' , 'woocommerce' ),
2016-07-19 12:05:25 +00:00
'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 ,
),
2019-10-05 23:16:22 +00:00
'ignore_discounts' => array (
2020-04-21 15:25:12 +00:00
'title' => __ ( 'Coupons discounts' , 'woocommerce' ),
2020-04-21 16:45:25 +00:00
'label' => __ ( 'Don\'t ignore coupons discounts' , 'woocommerce' ),
2019-10-05 23:16:22 +00:00
'type' => 'checkbox' ,
2020-04-21 15:25:12 +00:00
'description' => __ ( 'If checked, Free shipping will still be offered even if the cart amount after coupon is applied is less than the minimum required.' , 'woocommerce' ),
2019-10-05 23:16:22 +00:00
'default' => 'no' ,
'desc_tip' => true ,
),
2014-11-20 00:43:09 +00:00
);
2016-07-19 12:05:25 +00:00
}
2016-02-08 11:44:08 +00:00
2013-08-12 21:09:04 +00:00
/**
2015-12-11 14:11:12 +00:00
* Get setting form fields for instances of this shipping method within zones .
2016-07-19 12:05:25 +00:00
*
2015-12-11 14:11:12 +00:00
* @ return array
2013-08-12 21:09:04 +00:00
*/
2015-12-11 14:11:12 +00:00
public function get_instance_form_fields () {
2016-07-19 12:05:25 +00:00
return parent :: get_instance_form_fields ();
2013-08-12 21:09:04 +00:00
}
2011-11-28 15:50:19 +00:00
2013-08-12 21:09:04 +00:00
/**
2015-12-11 14:11:12 +00:00
* See if free shipping is available based on the package and cart .
2016-07-19 12:05:25 +00:00
*
* @ param array $package Shipping package .
2013-08-12 21:09:04 +00:00
* @ return bool
*/
2015-05-15 13:16:44 +00:00
public function is_available ( $package ) {
2014-11-20 00:43:09 +00:00
$has_coupon = false ;
2012-11-28 19:54:04 +00:00
$has_met_min_amount = false ;
2012-01-06 11:36:19 +00:00
2018-03-07 18:28:57 +00:00
if ( in_array ( $this -> requires , array ( 'coupon' , 'either' , 'both' ), true ) ) {
$coupons = WC () -> cart -> get_coupons ();
if ( $coupons ) {
2013-10-18 17:10:55 +00:00
foreach ( $coupons as $code => $coupon ) {
2016-02-25 16:36:39 +00:00
if ( $coupon -> is_valid () && $coupon -> get_free_shipping () ) {
2012-11-28 19:54:04 +00:00
$has_coupon = true ;
2015-12-11 14:11:12 +00:00
break ;
2014-11-20 00:43:09 +00:00
}
2012-05-03 13:00:45 +00:00
}
}
2012-11-28 19:54:04 +00:00
}
2012-08-14 22:43:48 +00:00
2018-03-07 18:28:57 +00:00
if ( in_array ( $this -> requires , array ( 'min_amount' , 'either' , 'both' ), true ) ) {
2016-04-18 10:39:00 +00:00
$total = WC () -> cart -> get_displayed_subtotal ();
2012-08-14 22:43:48 +00:00
2017-12-15 13:39:35 +00:00
if ( WC () -> cart -> display_prices_including_tax () ) {
2019-10-08 22:17:49 +00:00
$total = $total - WC () -> cart -> get_discount_tax ();
2019-10-05 23:16:22 +00:00
}
if ( 'no' === $this -> ignore_discounts ) {
2019-10-08 22:17:49 +00:00
$total = $total - WC () -> cart -> get_discount_total ();
2016-06-23 12:45:50 +00:00
}
2019-10-08 22:17:49 +00:00
$total = round ( $total , wc_get_price_decimals () );
2014-11-20 00:43:09 +00:00
if ( $total >= $this -> min_amount ) {
2013-10-15 16:19:30 +00:00
$has_met_min_amount = true ;
2014-11-20 00:43:09 +00:00
}
2012-11-28 19:54:04 +00:00
}
2012-08-14 22:43:48 +00:00
2012-11-28 19:54:04 +00:00
switch ( $this -> requires ) {
2018-03-07 18:04:56 +00:00
case 'min_amount' :
2015-12-11 14:11:12 +00:00
$is_available = $has_met_min_amount ;
2016-07-19 12:05:25 +00:00
break ;
2018-03-07 18:04:56 +00:00
case 'coupon' :
2015-12-11 14:11:12 +00:00
$is_available = $has_coupon ;
2016-07-19 12:05:25 +00:00
break ;
2018-03-07 18:04:56 +00:00
case 'both' :
2015-12-11 14:11:12 +00:00
$is_available = $has_met_min_amount && $has_coupon ;
2016-07-19 12:05:25 +00:00
break ;
2018-03-07 18:04:56 +00:00
case 'either' :
2015-12-11 14:11:12 +00:00
$is_available = $has_met_min_amount || $has_coupon ;
2016-07-19 12:05:25 +00:00
break ;
2018-03-07 18:04:56 +00:00
default :
2012-05-03 13:00:45 +00:00
$is_available = true ;
2016-07-19 12:05:25 +00:00
break ;
2012-05-03 13:00:45 +00:00
}
2012-08-14 22:43:48 +00:00
2017-08-11 20:36:18 +00:00
return apply_filters ( 'woocommerce_shipping_' . $this -> id . '_is_available' , $is_available , $package , $this );
2013-08-12 21:09:04 +00:00
}
/**
2015-12-11 14:11:12 +00:00
* Called to calculate shipping rates for this method . Rates can be added using the add_rate () method .
2016-07-19 12:05:25 +00:00
*
2015-12-11 14:11:12 +00:00
* @ uses WC_Shipping_Method :: add_rate ()
2016-07-19 12:05:25 +00:00
*
* @ param array $package Shipping package .
2013-08-12 21:09:04 +00:00
*/
2015-12-18 17:10:58 +00:00
public function calculate_shipping ( $package = array () ) {
2018-03-07 18:04:56 +00:00
$this -> add_rate (
array (
'label' => $this -> title ,
'cost' => 0 ,
'taxes' => false ,
'package' => $package ,
)
);
2013-08-12 21:09:04 +00:00
}
2019-05-20 10:56:01 +00:00
/**
* Enqueue JS to handle free shipping options .
*
* Static so that ' s enqueued only once .
*/
public static function enqueue_admin_js () {
2019-06-20 12:07:52 +00:00
wc_enqueue_js (
" jQuery( function( $ ) {
function wcFreeShippingShowHideMinAmountField ( el ) {
var form = $ ( el ) . closest ( 'form' );
var minAmountField = $ ( '#woocommerce_free_shipping_min_amount' , form ) . closest ( 'tr' );
2019-10-05 23:16:22 +00:00
var ignoreDiscountField = $ ( '#woocommerce_free_shipping_ignore_discounts' , form ) . closest ( 'tr' );
2019-06-20 12:07:52 +00:00
if ( 'coupon' === $ ( el ) . val () || '' === $ ( el ) . val () ) {
minAmountField . hide ();
2019-10-05 23:16:22 +00:00
ignoreDiscountField . hide ();
2019-06-20 12:07:52 +00:00
} else {
minAmountField . show ();
2019-10-05 23:16:22 +00:00
ignoreDiscountField . show ();
2019-05-20 10:56:01 +00:00
}
2019-06-20 12:07:52 +00:00
}
2019-05-20 10:56:01 +00:00
2019-06-20 12:07:52 +00:00
$ ( document . body ) . on ( 'change' , '#woocommerce_free_shipping_requires' , function () {
wcFreeShippingShowHideMinAmountField ( this );
});
// Change while load.
$ ( '#woocommerce_free_shipping_requires' ) . change ();
$ ( document . body ) . on ( 'wc_backbone_modal_loaded' , function ( evt , target ) {
if ( 'wc-modal-shipping-method-settings' === target ) {
wcFreeShippingShowHideMinAmountField ( $ ( '#wc-backbone-modal-dialog #woocommerce_free_shipping_requires' , evt . currentTarget ) );
}
} );
}); "
);
2019-05-20 10:56:01 +00:00
}
2014-09-20 19:44:32 +00:00
}