woocommerce/includes/shipping/flat-rate/class-wc-shipping-flat-rate...

351 lines
10 KiB
PHP
Raw Normal View History

2011-08-10 17:11:11 +00:00
<?php
if ( ! defined( 'ABSPATH' ) ) {
2015-06-12 15:19:43 +00:00
exit;
}
2013-02-20 17:14:46 +00:00
2011-08-10 17:11:11 +00:00
/**
2015-11-03 13:31:20 +00:00
* Flat Rate Shipping Method.
2012-08-14 22:43:48 +00:00
*
* @class WC_Shipping_Flat_Rate
2015-06-12 15:19:43 +00:00
* @version 2.4.0
2012-08-14 22:43:48 +00:00
* @package WooCommerce/Classes/Shipping
* @author WooThemes
*/
class WC_Shipping_Flat_Rate extends WC_Shipping_Method {
2012-08-14 22:43:48 +00:00
/** @var string cost passed to [fee] shortcode */
protected $fee_cost = '';
2015-06-15 14:24:51 +00:00
/**
2015-11-03 13:31:20 +00:00
* Constructor.
2012-08-14 22:43:48 +00:00
*/
public function __construct() {
2015-06-12 15:19:43 +00:00
$this->id = 'flat_rate';
$this->method_title = __( 'Flat Rate', 'woocommerce' );
$this->method_description = __( 'Flat Rate Shipping lets you charge a fixed rate for shipping.', 'woocommerce' );
$this->init();
add_action( 'woocommerce_update_options_shipping_' . $this->id, array( $this, 'process_admin_options' ) );
2015-06-15 11:01:24 +00:00
add_action( 'woocommerce_flat_rate_shipping_add_rate', array( $this, 'calculate_extra_shipping' ), 10, 3 );
}
2012-08-14 22:43:48 +00:00
/**
* init function.
*/
public function init() {
2011-11-28 15:50:19 +00:00
// Load the settings.
2013-01-02 13:38:33 +00:00
$this->init_form_fields();
2011-11-28 15:50:19 +00:00
$this->init_settings();
2012-08-14 22:43:48 +00:00
2011-11-28 15:50:19 +00:00
// Define user set variables
2015-06-12 15:19:43 +00:00
$this->title = $this->get_option( 'title' );
$this->availability = $this->get_option( 'availability' );
$this->countries = $this->get_option( 'countries' );
$this->tax_status = $this->get_option( 'tax_status' );
2015-06-15 14:24:51 +00:00
$this->cost = $this->get_option( 'cost' );
$this->type = $this->get_option( 'type', 'class' );
$this->options = $this->get_option( 'options', false ); // @deprecated in 2.4.0
}
2011-11-28 15:50:19 +00:00
/**
2015-11-03 13:31:20 +00:00
* Initialise Settings Form Fields.
*/
public function init_form_fields() {
$this->form_fields = include( 'includes/settings-flat-rate.php' );
}
2012-08-14 22:43:48 +00:00
2015-06-12 15:19:43 +00:00
/**
2015-11-03 13:31:20 +00:00
* Evaluate a cost from a sum/string.
2015-06-12 15:19:43 +00:00
* @param string $sum
* @param array $args
* @return string
*/
2015-06-16 13:08:46 +00:00
protected function evaluate_cost( $sum, $args = array() ) {
2015-06-12 15:19:43 +00:00
include_once( 'includes/class-wc-eval-math.php' );
$locale = localeconv();
$decimals = array( wc_get_price_decimal_separator(), $locale['decimal_point'], $locale['mon_decimal_point'] );
2015-06-15 14:24:51 +00:00
$this->fee_cost = $args['cost'];
// Expand shortcodes
add_shortcode( 'fee', array( $this, 'fee' ) );
$sum = do_shortcode( str_replace(
2015-06-12 15:19:43 +00:00
array(
'[qty]',
'[cost]'
),
array(
$args['qty'],
$args['cost']
),
$sum
) );
2015-06-12 15:19:43 +00:00
2015-06-15 14:24:51 +00:00
remove_shortcode( 'fee', array( $this, 'fee' ) );
// Remove whitespace from string
$sum = preg_replace( '/\s+/', '', $sum );
// Remove locale from string
$sum = str_replace( $decimals, '.', $sum );
// Trim invalid start/end characters
$sum = rtrim( ltrim( $sum, "\t\n\r\0\x0B+*/" ), "\t\n\r\0\x0B+-*/" );
// Do the math
2015-06-15 14:24:51 +00:00
return $sum ? WC_Eval_Math::evaluate( $sum ) : 0;
}
/**
2015-11-03 13:31:20 +00:00
* Work out fee (shortcode).
2015-06-15 14:24:51 +00:00
* @param array $atts
* @return string
*/
public function fee( $atts ) {
$atts = shortcode_atts( array(
'percent' => '',
'min_fee' => ''
), $atts );
$calculated_fee = 0;
if ( $atts['percent'] ) {
$calculated_fee = $this->fee_cost * ( floatval( $atts['percent'] ) / 100 );
}
if ( $atts['min_fee'] && $calculated_fee < $atts['min_fee'] ) {
$calculated_fee = $atts['min_fee'];
}
return $calculated_fee;
2015-06-12 15:19:43 +00:00
}
/**
* calculate_shipping function.
*
* @param array $package (default: array())
*/
public function calculate_shipping( $package = array() ) {
2015-06-12 15:19:43 +00:00
$rate = array(
'id' => $this->id,
'label' => $this->title,
'cost' => 0,
);
2015-06-12 15:19:43 +00:00
// Calculate the costs
$has_costs = false; // True when a cost is set. False if all costs are blank strings.
$cost = $this->get_option( 'cost' );
if ( $cost !== '' ) {
$has_costs = true;
2015-06-16 13:08:46 +00:00
$rate['cost'] = $this->evaluate_cost( $cost, array(
'qty' => $this->get_package_item_qty( $package ),
'cost' => $package['contents_cost']
) );
}
2015-06-12 15:19:43 +00:00
// Add shipping class costs
$found_shipping_classes = $this->find_shipping_classes( $package );
2015-06-15 14:24:51 +00:00
$highest_class_cost = 0;
2012-11-27 16:22:47 +00:00
2015-06-12 15:19:43 +00:00
foreach ( $found_shipping_classes as $shipping_class => $products ) {
2015-06-15 14:24:51 +00:00
$class_cost_string = $shipping_class ? $this->get_option( 'class_cost_' . $shipping_class, '' ) : $this->get_option( 'no_class_cost', '' );
if ( $class_cost_string === '' ) {
2015-06-15 14:24:51 +00:00
continue;
}
$has_costs = true;
2015-06-16 13:08:46 +00:00
$class_cost = $this->evaluate_cost( $class_cost_string, array(
2015-06-15 14:24:51 +00:00
'qty' => array_sum( wp_list_pluck( $products, 'quantity' ) ),
'cost' => array_sum( wp_list_pluck( $products, 'line_total' ) )
) );
2012-11-27 16:22:47 +00:00
2015-06-15 14:24:51 +00:00
if ( $this->type === 'class' ) {
$rate['cost'] += $class_cost;
} else {
$highest_class_cost = $class_cost > $highest_class_cost ? $class_cost : $highest_class_cost;
}
}
2012-11-27 16:22:47 +00:00
2015-06-15 14:24:51 +00:00
if ( $this->type === 'order' && $highest_class_cost ) {
$rate['cost'] += $highest_class_cost;
}
2015-06-12 15:19:43 +00:00
// Add the rate
if ( $has_costs ) {
$this->add_rate( $rate );
}
2015-06-12 15:19:43 +00:00
/**
2015-11-03 13:31:20 +00:00
* Developers can add additional flat rates based on this one via this action since @version 2.4.
2015-06-12 15:19:43 +00:00
*
2015-11-03 13:31:20 +00:00
* Previously there were (overly complex) options to add additional rates however this was not user.
2015-06-12 15:19:43 +00:00
* friendly and goes against what Flat Rate Shipping was originally intended for.
*
* This example shows how you can add an extra rate based on this flat rate via custom function:
*
* add_action( 'woocommerce_flat_rate_shipping_add_rate', 'add_another_custom_flat_rate', 10, 2 );
*
* function add_another_custom_flat_rate( $method, $rate ) {
* $new_rate = $rate;
2015-11-03 13:31:20 +00:00
* $new_rate['id'] .= ':' . 'custom_rate_name'; // Append a custom ID.
* $new_rate['label'] = 'Rushed Shipping'; // Rename to 'Rushed Shipping'.
* $new_rate['cost'] += 2; // Add $2 to the cost.
2015-06-12 15:19:43 +00:00
*
2015-11-03 13:31:20 +00:00
* // Add it to WC.
2015-06-12 15:19:43 +00:00
* $method->add_rate( $new_rate );
2015-11-03 13:31:20 +00:00
* }.
2015-06-12 15:19:43 +00:00
*/
do_action( 'woocommerce_' . $this->id . '_shipping_add_rate', $this, $rate, $package );
}
2012-11-27 16:22:47 +00:00
/**
2015-11-03 13:31:20 +00:00
* Get items in package.
* @param array $package
* @return int
*/
public function get_package_item_qty( $package ) {
$total_quantity = 0;
foreach ( $package['contents'] as $item_id => $values ) {
if ( $values['quantity'] > 0 && $values['data']->needs_shipping() ) {
$total_quantity += $values['quantity'];
}
}
return $total_quantity;
}
2012-11-27 16:22:47 +00:00
/**
* Finds and returns shipping classes and the products with said class.
* @param mixed $package
* @return array
*/
public function find_shipping_classes( $package ) {
$found_shipping_classes = array();
foreach ( $package['contents'] as $item_id => $values ) {
if ( $values['data']->needs_shipping() ) {
$found_class = $values['data']->get_shipping_class();
if ( ! isset( $found_shipping_classes[ $found_class ] ) ) {
$found_shipping_classes[ $found_class ] = array();
}
$found_shipping_classes[ $found_class ][ $item_id ] = $values;
}
}
return $found_shipping_classes;
}
2015-06-15 11:01:24 +00:00
/**
2015-11-03 13:31:20 +00:00
* Adds extra calculated flat rates.
2015-06-15 11:01:24 +00:00
*
* @deprecated 2.4.0
*
* Additonal rates defined like this:
2015-11-03 13:31:20 +00:00
* Option Name | Additional Cost [+- Percents%] | Per Cost Type (order, class, or item).
2015-06-15 11:01:24 +00:00
*/
public function calculate_extra_shipping( $method, $rate, $package ) {
if ( $this->options ) {
$options = array_filter( (array) explode( "\n", $this->options ) );
foreach ( $options as $option ) {
$this_option = array_map( 'trim', explode( WC_DELIMITER, $option ) );
if ( sizeof( $this_option ) !== 3 ) {
continue;
}
$extra_rate = $rate;
$extra_rate['id'] = $this->id . ':' . urldecode( sanitize_title( $this_option[0] ) );
$extra_rate['label'] = $this_option[0];
$extra_cost = $this->get_extra_cost( $this_option[1], $this_option[2], $package );
if ( is_array( $extra_rate['cost'] ) ) {
$extra_rate['cost']['order'] = $extra_rate['cost']['order'] + $extra_cost;
} else {
$extra_rate['cost'] += $extra_cost;
}
$this->add_rate( $extra_rate );
}
}
}
/**
* Calculate the percentage adjustment for each shipping rate.
*
* @deprecated 2.4.0
* @param float $cost
* @param float $percent_adjustment
* @param string $percent_operator
* @param float $base_price
* @return float
*/
public function calc_percentage_adjustment( $cost, $percent_adjustment, $percent_operator, $base_price ) {
if ( '+' == $percent_operator ) {
$cost += $percent_adjustment * $base_price;
} else {
$cost -= $percent_adjustment * $base_price;
}
return $cost;
}
/**
2015-11-03 13:31:20 +00:00
* Get extra cost.
2015-06-15 11:01:24 +00:00
*
* @deprecated 2.4.0
* @param string $cost_string
* @param string $type
* @param array $package
* @return float
*/
public function get_extra_cost( $cost_string, $type, $package ) {
$cost = $cost_string;
$cost_percent = false;
$pattern =
'/' . // start regex
'(\d+\.?\d*)' . // capture digits, optionally capture a `.` and more digits
'\s*' . // match whitespace
'(\+|-)' . // capture the operand
'\s*'. // match whitespace
'(\d+\.?\d*)'. // capture digits, optionally capture a `.` and more digits
'\%/'; // match the percent sign & end regex
if ( preg_match( $pattern, $cost_string, $this_cost_matches ) ) {
$cost_operator = $this_cost_matches[2];
$cost_percent = $this_cost_matches[3] / 100;
$cost = $this_cost_matches[1];
}
switch ( $type ) {
case 'class' :
$cost = $cost * sizeof( $this->find_shipping_classes( $package ) );
break;
case 'item' :
$cost = $cost * $this->get_package_item_qty( $package );
break;
}
if ( $cost_percent ) {
switch ( $type ) {
case 'class' :
$shipping_classes = $this->find_shipping_classes( $package );
foreach ( $shipping_classes as $shipping_class => $items ){
foreach ( $items as $item_id => $values ) {
$cost = $this->calc_percentage_adjustment( $cost, $cost_percent, $cost_operator, $values['line_total'] );
}
}
break;
case 'item' :
foreach ( $package['contents'] as $item_id => $values ) {
if ( $values['data']->needs_shipping() ) {
$cost = $this->calc_percentage_adjustment( $cost, $cost_percent, $cost_operator, $values['line_total'] );
}
2015-06-15 11:01:24 +00:00
}
break;
case 'order' :
$cost = $this->calc_percentage_adjustment( $cost, $cost_percent, $cost_operator, $package['contents_cost'] );
break;
}
}
return $cost;
}
}