woocommerce/includes/shipping/local-delivery/class-wc-shipping-local-del...

264 lines
7.0 KiB
PHP
Raw Normal View History

2012-05-26 16:25:07 +00:00
<?php
2013-02-20 17:14:46 +00:00
if ( ! defined( 'ABSPATH' ) ) exit; // Exit if accessed directly
2012-05-26 16:25:07 +00:00
/**
* Local Delivery Shipping Method
2012-08-14 22:43:48 +00:00
*
2012-05-26 16:25:07 +00:00
* A simple shipping method allowing local delivery as a shipping method
*
* @class WC_Shipping_Local_Delivery
* @version 2.0.0
2012-08-14 22:43:48 +00:00
* @package WooCommerce/Classes/Shipping
* @author WooThemes
*/
class WC_Shipping_Local_Delivery extends WC_Shipping_Method {
2012-08-14 22:43:48 +00:00
/**
* __construct function.
*
* @access public
* @return void
*/
function __construct() {
2012-05-26 16:25:07 +00:00
$this->id = 'local_delivery';
2012-10-16 09:45:33 +00:00
$this->method_title = __( 'Local Delivery', 'woocommerce' );
2012-05-26 16:25:07 +00:00
$this->init();
2012-08-14 22:43:48 +00:00
}
/**
* init function.
*
* @access public
* @return void
*/
function init() {
2012-08-14 22:43:48 +00:00
2012-05-26 16:25:07 +00:00
// Load the settings.
2013-01-02 13:38:33 +00:00
$this->init_form_fields();
2012-05-26 16:25:07 +00:00
$this->init_settings();
2012-08-14 22:43:48 +00:00
2012-05-26 16:25:07 +00:00
// Define user set variables
$this->title = $this->get_option( 'title' );
$this->type = $this->get_option( 'type' );
$this->fee = $this->get_option( 'fee' );
$this->type = $this->get_option( 'type' );
$this->codes = $this->get_option( 'codes' );
$this->availability = $this->get_option( 'availability' );
$this->countries = $this->get_option( 'countries' );
2012-08-14 22:43:48 +00:00
add_action( 'woocommerce_update_options_shipping_' . $this->id, array( $this, 'process_admin_options' ) );
2012-05-26 16:25:07 +00:00
}
2012-08-14 22:43:48 +00:00
/**
* calculate_shipping function.
*
* @access public
* @param array $package (default: array())
* @return void
*/
2012-05-26 16:25:07 +00:00
function calculate_shipping( $package = array() ) {
2012-08-14 22:43:48 +00:00
2012-05-26 16:25:07 +00:00
$shipping_total = 0;
$fee = ( trim( $this->fee ) == '' ) ? 0 : $this->fee;
2012-08-14 22:43:48 +00:00
2012-05-26 16:25:07 +00:00
if ( $this->type =='fixed' ) $shipping_total = $this->fee;
2012-08-14 22:43:48 +00:00
2012-05-26 16:25:07 +00:00
if ( $this->type =='percent' ) $shipping_total = $package['contents_cost'] * ( $this->fee / 100 );
2012-08-14 22:43:48 +00:00
2012-05-26 16:25:07 +00:00
if ( $this->type == 'product' ) {
2013-11-25 14:01:32 +00:00
foreach ( WC()->cart->get_cart() as $item_id => $values ) {
2012-05-26 16:25:07 +00:00
$_product = $values['data'];
2012-08-14 22:43:48 +00:00
2012-05-26 16:25:07 +00:00
if ( $values['quantity'] > 0 && $_product->needs_shipping() )
$shipping_total += $this->fee * $values['quantity'];
}
}
2012-08-14 22:43:48 +00:00
2012-05-26 16:25:07 +00:00
$rate = array(
'id' => $this->id,
'label' => $this->title,
'cost' => $shipping_total
);
2012-08-14 22:43:48 +00:00
$this->add_rate($rate);
2012-05-26 16:25:07 +00:00
}
2012-08-14 22:43:48 +00:00
/**
* init_form_fields function.
*
* @access public
* @return void
*/
2012-05-26 16:25:07 +00:00
function init_form_fields() {
$this->form_fields = array(
2012-05-26 16:25:07 +00:00
'enabled' => array(
'title' => __( 'Enable', 'woocommerce' ),
'type' => 'checkbox',
'label' => __( 'Enable local delivery', 'woocommerce' ),
'default' => 'no'
2012-08-14 22:43:48 +00:00
),
2012-05-26 16:25:07 +00:00
'title' => array(
'title' => __( 'Title', 'woocommerce' ),
'type' => 'text',
'description' => __( 'This controls the title which the user sees during checkout.', 'woocommerce' ),
'default' => __( 'Local Delivery', 'woocommerce' ),
'desc_tip' => true,
2012-05-26 16:25:07 +00:00
),
'type' => array(
'title' => __( 'Fee Type', 'woocommerce' ),
'type' => 'select',
'description' => __( 'How to calculate delivery charges', 'woocommerce' ),
'default' => 'fixed',
'options' => array(
'fixed' => __( 'Fixed amount', 'woocommerce' ),
2012-10-16 09:45:33 +00:00
'percent' => __( 'Percentage of cart total', 'woocommerce' ),
'product' => __( 'Fixed amount per product', 'woocommerce' ),
2012-05-26 16:25:07 +00:00
),
'desc_tip' => true,
2012-05-26 16:25:07 +00:00
),
'fee' => array(
'title' => __( 'Delivery Fee', 'woocommerce' ),
'type' => 'price',
'description' => __( 'What fee do you want to charge for local delivery, disregarded if you choose free. Leave blank to disable.', 'woocommerce' ),
'default' => '',
'desc_tip' => true,
'placeholder' => wc_format_localized_price( 0 )
2012-05-26 16:25:07 +00:00
),
'codes' => array(
'title' => __( 'Zip/Post Codes', 'woocommerce' ),
'type' => 'textarea',
'description' => __( 'What zip/post codes would you like to offer delivery to? Separate codes with a comma. Accepts wildcards, e.g. P* will match a postcode of PE30.', 'woocommerce' ),
'default' => '',
'desc_tip' => true,
'placeholder' => '12345, 56789 etc'
2012-05-26 16:25:07 +00:00
),
'availability' => array(
'title' => __( 'Method availability', 'woocommerce' ),
'type' => 'select',
'default' => 'all',
2012-05-26 16:25:07 +00:00
'class' => 'availability',
'options' => array(
'all' => __( 'All allowed countries', 'woocommerce' ),
'specific' => __( 'Specific Countries', 'woocommerce' )
2012-05-26 16:25:07 +00:00
)
),
'countries' => array(
'title' => __( 'Specific Countries', 'woocommerce' ),
'type' => 'multiselect',
2012-05-26 16:25:07 +00:00
'class' => 'chosen_select',
'css' => 'width: 450px;',
'default' => '',
2013-11-25 14:01:32 +00:00
'options' => WC()->countries->get_shipping_countries(),
2013-10-11 14:27:04 +00:00
'custom_attributes' => array(
2013-10-11 14:30:10 +00:00
'data-placeholder' => __( 'Select some countries', 'woocommerce' )
2013-10-11 14:27:04 +00:00
)
2012-08-14 22:43:48 +00:00
)
2012-05-26 16:25:07 +00:00
);
}
2012-08-14 22:43:48 +00:00
/**
* admin_options function.
*
* @access public
* @return void
*/
2012-05-26 16:25:07 +00:00
function admin_options() {
global $woocommerce; ?>
<h3><?php echo $this->method_title; ?></h3>
2012-10-16 09:45:33 +00:00
<p><?php _e( 'Local delivery is a simple shipping method for delivering orders locally.', 'woocommerce' ); ?></p>
2012-05-26 16:25:07 +00:00
<table class="form-table">
<?php $this->generate_settings_html(); ?>
</table> <?php
2012-05-26 16:25:07 +00:00
}
2012-08-14 22:43:48 +00:00
/**
* is_available function.
*
* @access public
* @param array $package
* @return bool
*/
function is_available( $package ) {
2012-08-14 22:43:48 +00:00
if ($this->enabled=="no") return false;
2012-08-14 22:43:48 +00:00
2012-05-26 16:25:07 +00:00
// If post codes are listed, let's use them.
$codes = '';
if ( $this->codes != '' ) {
foreach( explode( ',', $this->codes ) as $code ) {
$codes[] = $this->clean( $code );
2012-05-26 16:25:07 +00:00
}
}
2012-11-27 16:22:47 +00:00
if ( is_array( $codes ) ) {
2012-11-27 16:22:47 +00:00
$found_match = false;
2012-11-27 16:22:47 +00:00
if ( in_array( $this->clean( $package['destination']['postcode'] ), $codes ) )
$found_match = true;
// Pattern match
if ( ! $found_match ) {
$customer_postcode = $this->clean( $package['destination']['postcode'] );
foreach ($codes as $c) {
$pattern = '/^'.str_replace('_', '[0-9a-zA-Z]', $c).'$/i';
if(preg_match($pattern, $customer_postcode)) {
$found_match = true;
break;
}
}
}
2012-11-27 16:22:47 +00:00
// Wildcard search
if ( ! $found_match ) {
2012-11-27 16:22:47 +00:00
$customer_postcode = $this->clean( $package['destination']['postcode'] );
$customer_postcode_length = strlen( $customer_postcode );
2012-11-27 16:22:47 +00:00
for ( $i = 0; $i <= $customer_postcode_length; $i++ ) {
2012-11-27 16:22:47 +00:00
if ( in_array( $customer_postcode, $codes ) )
$found_match = true;
2012-11-27 16:22:47 +00:00
$customer_postcode = substr( $customer_postcode, 0, -2 ) . '*';
}
}
2012-11-27 16:22:47 +00:00
if ( ! $found_match )
2012-05-26 16:25:07 +00:00
return false;
}
2012-08-14 22:43:48 +00:00
2013-03-03 17:07:31 +00:00
// Either post codes not setup, or post codes are in array... so lefts check countries for backwards compatibility.
if ( $this->availability == 'specific' )
2012-05-26 16:25:07 +00:00
$ship_to_countries = $this->countries;
else
2013-11-25 14:01:32 +00:00
$ship_to_countries = array_keys( WC()->countries->get_shipping_countries() );
2012-05-26 16:25:07 +00:00
if (is_array($ship_to_countries))
if (!in_array( $package['destination']['country'] , $ship_to_countries))
return false;
2012-08-14 22:43:48 +00:00
2012-05-26 16:25:07 +00:00
// Yay! We passed!
return apply_filters( 'woocommerce_shipping_' . $this->id . '_is_available', true );
}
/**
* clean function.
*
* @access public
* @param mixed $code
* @return string
*/
function clean( $code ) {
return str_replace( '-', '', sanitize_title( $code ) ) . ( strstr( $code, '*' ) ? '*' : '' );
}
2012-08-14 22:43:48 +00:00
}