woocommerce/includes/shipping/local-pickup/class-wc-shipping-local-pic...

226 lines
5.6 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 Pickup Shipping Method
2012-08-14 22:43:48 +00:00
*
2012-05-26 16:25:07 +00:00
* A simple shipping method allowing free pickup as a shipping method
*
* @class WC_Shipping_Local_Pickup
* @version 2.0.0
2012-08-14 22:43:48 +00:00
* @package WooCommerce/Classes/Shipping
* @author WooThemes
*/
class WC_Shipping_Local_Pickup extends WC_Shipping_Method {
2012-05-26 16:25:07 +00:00
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_pickup';
2012-10-16 09:45:33 +00:00
$this->method_title = __( 'Local Pickup', '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->enabled = $this->get_option( 'enabled' );
$this->title = $this->get_option( 'title' );
$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
// Actions
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
* @return void
*/
function calculate_shipping() {
2012-05-26 16:25:07 +00:00
$rate = array(
'id' => $this->id,
'label' => $this->title,
);
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() {
global $woocommerce;
$this->form_fields = array(
2012-05-26 16:25:07 +00:00
'enabled' => array(
'title' => __( 'Enable', 'woocommerce' ),
'type' => 'checkbox',
'label' => __( 'Enable local pickup', '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 Pickup', 'woocommerce' ),
'desc_tip' => true,
2012-05-26 16:25:07 +00:00
),
2012-11-27 11:25:21 +00:00
'codes' => array(
'title' => __( 'Zip/Post Codes', 'woocommerce' ),
2012-11-27 11:25:21 +00:00
'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-11-27 11:25:21 +00:00
),
2012-05-26 16:25:07 +00:00
'availability' => array(
'title' => __( 'Method availability', 'woocommerce' ),
'type' => 'select',
'default' => 'all',
'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',
'class' => 'chosen_select',
'css' => 'width: 450px;',
'default' => '',
2013-10-11 14:27:04 +00:00
'options' => $woocommerce->countries->get_shipping_countries(),
'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-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 pickup is a simple method which allows the customer to pick up their order themselves.', '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 ) {
global $woocommerce;
2012-11-27 16:22:47 +00:00
$is_available = true;
2012-11-27 16:22:47 +00:00
if ( $this->enabled == "no" ) {
2012-11-27 16:22:47 +00:00
$is_available = false;
2012-11-27 16:22:47 +00:00
} else {
2012-11-27 11:25:21 +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-11-27 16:22:47 +00:00
2012-11-27 11:25:21 +00:00
if ( is_array( $codes ) ) {
2012-11-27 16:22:47 +00:00
2012-11-27 11:25:21 +00:00
$found_match = false;
2012-11-27 16:22:47 +00:00
2012-11-27 11:25:21 +00:00
if ( in_array( $this->clean( $package['destination']['postcode'] ), $codes ) )
$found_match = true;
2012-11-27 16:22:47 +00:00
2012-11-27 11:25:21 +00:00
// Wildcard search
if ( ! $found_match ) {
2012-11-27 16:22:47 +00:00
2012-11-27 11:25:21 +00:00
$customer_postcode = $this->clean( $package['destination']['postcode'] );
$customer_postcode_length = strlen( $customer_postcode );
2012-11-27 16:22:47 +00:00
2012-11-27 11:25:21 +00:00
for ( $i = 0; $i <= $customer_postcode_length; $i++ ) {
2012-11-27 16:22:47 +00:00
if ( in_array( $customer_postcode, $codes ) )
2012-11-27 11:25:21 +00:00
$found_match = true;
2012-11-27 16:22:47 +00:00
2012-11-27 11:25:21 +00:00
$customer_postcode = substr( $customer_postcode, 0, -2 ) . '*';
}
}
2012-11-27 16:22:47 +00:00
2012-11-27 11:25:21 +00:00
if ( ! $found_match ) {
2012-11-27 16:22:47 +00:00
2012-11-27 11:25:21 +00:00
$is_available = false;
2012-11-27 16:22:47 +00:00
2012-11-27 11:25:21 +00:00
} else {
2012-11-27 16:22:47 +00:00
if ( $this->availability == 'specific' )
2012-11-27 11:25:21 +00:00
$ship_to_countries = $this->countries;
else
$ship_to_countries = array_keys( $woocommerce->countries->get_shipping_countries() );
2012-11-27 16:22:47 +00:00
2012-11-27 11:25:21 +00:00
if ( is_array( $ship_to_countries ) && ! in_array( $package['destination']['country'], $ship_to_countries ) ) {
$is_available = false;
}
2012-11-27 16:22:47 +00:00
2012-11-27 11:25:21 +00:00
}
} else {
if ( $this->availability == 'specific' )
$ship_to_countries = $this->countries;
else
$ship_to_countries = array_keys( $woocommerce->countries->get_shipping_countries() );
if ( is_array( $ship_to_countries ) && ! in_array( $package['destination']['country'], $ship_to_countries ) ) {
$is_available = false;
}
}
2012-11-27 16:22:47 +00:00
}
2012-06-05 08:13:25 +00:00
return apply_filters( 'woocommerce_shipping_' . $this->id . '_is_available', $is_available, $package );
}
2012-11-27 16:22:47 +00:00
/**
* clean function.
*
* @access public
* @param mixed $code
* @return string
*/
function clean( $code ) {
return str_replace( '-', '', sanitize_title( $code ) ) . ( strstr( $code, '*' ) ? '*' : '' );
}
2012-11-27 16:22:47 +00:00
}