woocommerce/includes/abstracts/abstract-wc-shipping-method...

234 lines
6.4 KiB
PHP
Raw Normal View History

2011-08-09 15:16:18 +00:00
<?php
2013-02-20 17:14:46 +00:00
if ( ! defined( 'ABSPATH' ) ) exit; // Exit if accessed directly
2011-08-10 17:11:11 +00:00
/**
* WooCommerce Shipping Method Class
2012-08-12 14:12:52 +00:00
*
2011-08-10 17:11:11 +00:00
* Extended by shipping methods to handle shipping calculations etc.
*
2012-01-27 16:38:39 +00:00
* @class WC_Shipping_Method
2012-08-14 22:43:48 +00:00
* @version 1.6.4
2013-02-20 17:14:46 +00:00
* @package WooCommerce/Abstracts
* @category Abstract Class
2012-08-14 22:43:48 +00:00
* @author WooThemes
2012-08-12 14:12:52 +00:00
*/
abstract class WC_Shipping_Method extends WC_Settings_API {
2012-08-12 14:12:52 +00:00
2012-08-15 17:08:42 +00:00
/** @var string Unique ID for the shipping method - must be set. */
2012-08-14 22:43:48 +00:00
var $id;
2012-08-15 17:08:42 +00:00
/** @var int Optional instance ID. */
2012-08-14 22:43:48 +00:00
var $number;
2012-08-15 17:08:42 +00:00
/** @var string Method title */
2012-08-14 22:43:48 +00:00
var $method_title;
2012-08-15 17:08:42 +00:00
/** @var string User set title */
2012-08-14 22:43:48 +00:00
var $title;
2012-08-12 14:12:52 +00:00
2012-08-15 17:08:42 +00:00
/** @var bool True if the method is available. */
2011-08-09 15:16:18 +00:00
var $availability;
2012-08-14 22:43:48 +00:00
2012-08-15 17:08:42 +00:00
/** @var array Array of countries this method is enabled for. */
var $countries = array();
2012-08-12 14:12:52 +00:00
2012-08-15 17:08:42 +00:00
/** @var string If 'taxable' tax will be charged for this method (if applicable) */
2012-08-14 22:43:48 +00:00
var $tax_status = 'taxable';
2012-08-12 14:12:52 +00:00
2012-08-15 17:08:42 +00:00
/** @var mixed Fees for the method */
2012-08-14 22:43:48 +00:00
var $fee = 0;
2012-08-15 17:08:42 +00:00
/** @var float Minimum fee for the method */
2012-08-14 22:43:48 +00:00
var $minimum_fee = null;
2012-08-15 17:08:42 +00:00
/** @var bool Enabled for disabled */
2012-08-14 22:43:48 +00:00
var $enabled = false;
2012-08-15 17:08:42 +00:00
/** @var bool Whether the method has settings or not (In WooCommerce > Settings > Shipping) */
2012-08-14 22:43:48 +00:00
var $has_settings = true;
2012-08-15 17:08:42 +00:00
/** @var array Features this method supports. */
2012-08-14 22:43:48 +00:00
var $supports = array(); // Features this method supports.
2012-08-15 17:08:42 +00:00
/** @var array This is an array of rates - methods must populate this array to register shipping costs */
2012-08-14 22:43:48 +00:00
var $rates = array();
2012-08-12 14:12:52 +00:00
/**
* Whether or not we need to calculate tax on top of the shipping rate
* @return boolean
*/
public function is_taxable() {
return ( get_option( 'woocommerce_calc_taxes' ) == 'yes' && $this->tax_status == 'taxable' && ! WC()->customer->is_vat_exempt() );
}
/**
* Add a rate
*
2012-08-14 22:43:48 +00:00
* Add a shipping rate. If taxes are not set they will be calculated based on cost.
*
* @access public
* @param array $args (default: array())
* @return void
*/
function add_rate( $args = array() ) {
2012-08-12 14:12:52 +00:00
$defaults = array(
2012-01-14 16:42:04 +00:00
'id' => '', // ID for the rate
'label' => '', // Label for the rate
'cost' => '0', // Amount or array of costs (per item shipping)
'taxes' => '', // Pass taxes, nothing to have it calculated for you, or 'false' to calc no tax
'calc_tax' => 'per_order' // Calc tax per_order or per_item. Per item needs an array of costs
);
$args = wp_parse_args( $args, $defaults );
2012-08-12 14:12:52 +00:00
extract( $args );
2012-08-12 14:12:52 +00:00
// Id and label are required
2012-05-29 12:32:54 +00:00
if ( ! $id || ! $label ) return;
2012-08-12 14:12:52 +00:00
2012-01-14 16:42:04 +00:00
// Handle cost
$total_cost = round( ( is_array( $cost ) ) ? array_sum( $cost ) : $cost, absint( get_option( 'woocommerce_price_num_decimals' ) ) );
2012-08-12 14:12:52 +00:00
// Taxes - if not an array and not set to false, calc tax based on cost and passed calc_tax variable
2013-03-03 17:07:31 +00:00
// This saves shipping methods having to do complex tax calculations
if ( ! is_array( $taxes ) && $taxes !== false && $total_cost > 0 && $this->is_taxable() ) {
2012-08-12 14:12:52 +00:00
$taxes = array();
2012-08-12 14:12:52 +00:00
2012-05-29 12:32:54 +00:00
switch ( $calc_tax ) {
2012-08-12 14:12:52 +00:00
case "per_item" :
2012-08-12 14:12:52 +00:00
2012-01-14 16:42:04 +00:00
// If we have an array of costs we can look up each items tax class and add tax accordingly
2012-05-29 12:32:54 +00:00
if ( is_array( $cost ) ) {
2012-08-12 14:12:52 +00:00
2013-11-25 14:01:32 +00:00
$cart = WC()->cart->get_cart();
2012-08-12 14:12:52 +00:00
2012-05-29 12:32:54 +00:00
foreach ( $cost as $cost_key => $amount ) {
2012-08-12 14:12:52 +00:00
if ( ! isset( $cart[ $cost_key ] ) )
2012-05-29 12:32:54 +00:00
continue;
2012-08-12 14:12:52 +00:00
2012-05-29 12:32:54 +00:00
$_product = $cart[ $cost_key ]['data'];
2012-08-12 14:12:52 +00:00
$rates = WC_Tax::get_shipping_tax_rates( $_product->get_tax_class() );
$item_taxes = WC_Tax::calc_shipping_tax( $amount, $rates );
2012-08-12 14:12:52 +00:00
// Sum the item taxes
2012-05-29 12:32:54 +00:00
foreach ( array_keys( $taxes + $item_taxes ) as $key )
$taxes[ $key ] = ( isset( $item_taxes[ $key ] ) ? $item_taxes[ $key ] : 0 ) + ( isset( $taxes[ $key ] ) ? $taxes[ $key ] : 0 );
2012-08-12 14:12:52 +00:00
2012-05-29 12:32:54 +00:00
}
2012-08-12 14:12:52 +00:00
// Add any cost for the order - order costs are in the key 'order'
2012-05-29 12:32:54 +00:00
if ( isset( $cost['order'] ) ) {
2012-08-12 14:12:52 +00:00
$rates = WC_Tax::get_shipping_tax_rates();
$item_taxes = WC_Tax::calc_shipping_tax( $cost['order'], $rates );
2012-08-12 14:12:52 +00:00
2012-02-29 11:49:39 +00:00
// Sum the item taxes
2012-05-29 12:32:54 +00:00
foreach ( array_keys( $taxes + $item_taxes ) as $key )
$taxes[ $key ] = ( isset( $item_taxes[ $key ] ) ? $item_taxes[ $key ] : 0 ) + ( isset( $taxes[ $key ] ) ? $taxes[ $key ] : 0 );
2012-02-29 11:49:39 +00:00
}
2012-01-14 16:42:04 +00:00
2012-05-29 12:32:54 +00:00
}
2012-01-14 16:42:04 +00:00
break;
2012-08-12 14:12:52 +00:00
default :
2012-08-12 14:12:52 +00:00
$rates = WC_Tax::get_shipping_tax_rates();
$taxes = WC_Tax::calc_shipping_tax( $total_cost, $rates );
2012-08-12 14:12:52 +00:00
break;
2012-08-12 14:12:52 +00:00
2012-05-29 12:32:54 +00:00
}
2012-08-12 14:12:52 +00:00
2012-05-29 12:32:54 +00:00
}
2012-11-07 16:54:38 +00:00
$this->rates[] = new WC_Shipping_Rate( $id, $label, $total_cost, $taxes, $this->id );
}
2012-08-12 14:12:52 +00:00
2012-08-14 22:43:48 +00:00
/**
* has_settings function.
*
* @access public
2013-11-28 12:54:19 +00:00
* @return bool
2012-08-14 22:43:48 +00:00
*/
2012-05-29 12:32:54 +00:00
function has_settings() {
2013-11-28 13:12:08 +00:00
return ( $this->has_settings );
2012-05-29 12:32:54 +00:00
}
2012-08-12 14:12:52 +00:00
2012-08-14 22:43:48 +00:00
/**
* is_available function.
*
* @param array $package
* @return bool
*/
public function is_available( $package ) {
if ( "no" == $this->enabled ) {
return false;
}
2012-08-12 14:12:52 +00:00
// Country availability
switch ( $this->availability ) {
case 'specific' :
case 'including' :
2013-11-25 14:01:32 +00:00
$ship_to_countries = array_intersect( $this->countries, array_keys( WC()->countries->get_shipping_countries() ) );
break;
case 'excluding' :
$ship_to_countries = array_diff( array_keys( WC()->countries->get_shipping_countries() ), $this->countries );
break;
default :
2013-11-25 14:01:32 +00:00
$ship_to_countries = array_keys( WC()->countries->get_shipping_countries() );
break;
}
2012-08-12 14:12:52 +00:00
if ( ! in_array( $package['destination']['country'], $ship_to_countries ) ) {
return false;
}
2012-08-12 14:12:52 +00:00
return apply_filters( 'woocommerce_shipping_' . $this->id . '_is_available', true, $package );
2012-08-12 14:12:52 +00:00
}
/**
* Return the gateways title
2012-08-12 14:12:52 +00:00
*
* @return string
*/
public function get_title() {
return apply_filters( 'woocommerce_shipping_method_title', $this->title, $this->id );
}
2012-08-12 14:12:52 +00:00
/**
* get_fee function.
2012-08-12 14:12:52 +00:00
*
* @access public
* @param mixed $fee
* @param mixed $total
* @return float
*/
2011-09-06 11:18:22 +00:00
function get_fee( $fee, $total ) {
if ( strstr( $fee, '%' ) ) :
$fee = ( $total / 100 ) * str_replace( '%', '', $fee );
2011-08-09 15:16:18 +00:00
endif;
if ( ! empty( $this->minimum_fee ) && $this->minimum_fee > $fee ) $fee = $this->minimum_fee;
return $fee;
2012-08-12 14:12:52 +00:00
}
2012-05-29 12:32:54 +00:00
/**
* Check if a shipping method supports a given feature.
2012-08-12 14:12:52 +00:00
*
* Methods should override this to declare support (or lack of support) for a feature.
*
2012-05-29 12:32:54 +00:00
* @param $feature string The name of a feature to test support for.
2012-08-12 14:12:52 +00:00
* @return bool True if the gateway supports the feature, false otherwise.
2012-05-29 12:32:54 +00:00
* @since 1.5.7
*/
function supports( $feature ) {
return apply_filters( 'woocommerce_shipping_method_supports', in_array( $feature, $this->supports ) ? true : false, $feature, $this );
2012-05-29 12:32:54 +00:00
}
2013-11-28 13:12:08 +00:00
}