class-wc-shipping-legacy-local-pickup.php
6.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
<?php
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly
}
/**
* Local Pickup Shipping Method.
*
* This class is here for backwards commpatility for methods existing before zones existed.
*
* @deprecated 2.6.0
* @version 2.3.0
* @package WooCommerce/Classes/Shipping
* @author WooThemes
*/
class WC_Shipping_Legacy_Local_Pickup extends WC_Shipping_Method {
/**
* Constructor.
*/
public function __construct() {
$this->id = 'legacy_local_pickup';
$this->method_title = __( 'Local Pickup (Legacy)', 'woocommerce' );
$this->method_description = sprintf( __( '<strong>This method is deprecated in 2.6.0 and will be removed in future versions - we recommend disabling it and instead setting up a new rate within your <a href="%s">Shipping Zones</a>.</strong>', 'woocommerce' ), admin_url( 'admin.php?page=wc-settings&tab=shipping' ) );
$this->init();
}
/**
* Process and redirect if disabled.
*/
public function process_admin_options() {
parent::process_admin_options();
if ( 'no' === $this->settings[ 'enabled' ] ) {
wp_redirect( admin_url( 'admin.php?page=wc-settings&tab=shipping§ion=options' ) );
exit;
}
}
/**
* Return the name of the option in the WP DB.
* @since 2.6.0
* @return string
*/
public function get_option_key() {
return $this->plugin_id . 'local_pickup' . '_settings';
}
/**
* init function.
*/
public function init() {
// Load the settings.
$this->init_form_fields();
$this->init_settings();
// 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' );
// Actions
add_action( 'woocommerce_update_options_shipping_' . $this->id, array( $this, 'process_admin_options' ) );
}
/**
* calculate_shipping function.
*/
public function calculate_shipping( $package = array() ) {
$rate = array(
'id' => $this->id,
'label' => $this->title,
'package' => $package,
);
$this->add_rate( $rate );
}
/**
* init_form_fields function.
*/
public function init_form_fields() {
$this->form_fields = array(
'enabled' => array(
'title' => __( 'Enable', 'woocommerce' ),
'type' => 'checkbox',
'label' => __( 'Once disabled, this legacy method will no longer be available.', 'woocommerce' ),
'default' => 'no'
),
'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,
),
'codes' => array(
'title' => __( 'Allowed ZIP/Post Codes', 'woocommerce' ),
'type' => 'text',
'desc_tip' => __( 'What ZIP/post codes are available for local pickup?', 'woocommerce' ),
'default' => '',
'description' => __( 'Separate codes with a comma. Accepts wildcards, e.g. <code>P*</code> will match a postcode of PE30. Also accepts a pattern, e.g. <code>NG1___</code> would match NG1 1AA but not NG10 1AA', 'woocommerce' ),
'placeholder' => 'e.g. 12345, 56789'
),
'availability' => array(
'title' => __( 'Method availability', 'woocommerce' ),
'type' => 'select',
'default' => 'all',
'class' => 'availability wc-enhanced-select',
'options' => array(
'all' => __( 'All allowed countries', 'woocommerce' ),
'specific' => __( 'Specific Countries', 'woocommerce' )
)
),
'countries' => array(
'title' => __( 'Specific Countries', 'woocommerce' ),
'type' => 'multiselect',
'class' => 'wc-enhanced-select',
'css' => 'width: 450px;',
'default' => '',
'options' => WC()->countries->get_shipping_countries(),
'custom_attributes' => array(
'data-placeholder' => __( 'Select some countries', 'woocommerce' )
)
)
);
}
/**
* Get postcodes for this method.
* @return array
*/
public function get_valid_postcodes() {
$codes = array();
if ( $this->codes != '' ) {
foreach( explode( ',', $this->codes ) as $code ) {
$codes[] = strtoupper( trim( $code ) );
}
}
return $codes;
}
/**
* See if a given postcode matches valid postcodes.
* @param string postcode
* @param string country code
* @return boolean
*/
public function is_valid_postcode( $postcode, $country ) {
$codes = $this->get_valid_postcodes();
$postcode = $this->clean( $postcode );
$formatted_postcode = wc_format_postcode( $postcode, $country );
if ( in_array( $postcode, $codes ) || in_array( $formatted_postcode, $codes ) ) {
return true;
}
// Pattern matching
foreach ( $codes as $c ) {
$pattern = '/^' . str_replace( '_', '[0-9a-zA-Z]', preg_quote( $c ) ) . '$/i';
if ( preg_match( $pattern, $postcode ) ) {
return true;
}
}
// Wildcard search
$wildcard_postcode = $formatted_postcode . '*';
$postcode_length = strlen( $formatted_postcode );
for ( $i = 0; $i < $postcode_length; $i++ ) {
if ( in_array( $wildcard_postcode, $codes ) ) {
return true;
}
$wildcard_postcode = substr( $wildcard_postcode, 0, -2 ) . '*';
}
return false;
}
/**
* See if the method is available.
*
* @param array $package
* @return bool
*/
public function is_available( $package ) {
$is_available = "yes" === $this->enabled;
if ( $is_available && $this->get_valid_postcodes() ) {
$is_available = $this->is_valid_postcode( $package['destination']['postcode'], $package['destination']['country'] );
}
if ( $is_available ) {
if ( $this->availability === 'specific' ) {
$ship_to_countries = $this->countries;
} else {
$ship_to_countries = array_keys( WC()->countries->get_shipping_countries() );
}
if ( is_array( $ship_to_countries ) && ! in_array( $package['destination']['country'], $ship_to_countries ) ) {
$is_available = false;
}
}
return apply_filters( 'woocommerce_shipping_' . $this->id . '_is_available', $is_available, $package );
}
/**
* clean function.
*
* @access public
* @param mixed $code
* @return string
*/
public function clean( $code ) {
return str_replace( '-', '', sanitize_title( $code ) ) . ( strstr( $code, '*' ) ? '*' : '' );
}
}