*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
if ( class_exists( METHOD_ID ) ) {
return;
}
/**
* @since 1.0.0
*/
class alopeyk_woocommerce_shipping_method extends WC_Shipping_Method {
/**
* @since 1.0.0
*/
public function __construct() {
$this->id = METHOD_ID;
$this->method_title = __( 'Alopeyk', 'alopeyk-woocommerce-shipping' );
$this->method_description = __( 'By filling the following fields and checking enabled field, Alopeyk On-demand Delivery will be included in WooCommerce shop shipping methods.', 'alopeyk-woocommerce-shipping' );
$this->required_fields = array( 'api_key', 'store_name', 'store_phone', 'store_lat', 'store_lng', 'store_address', 'store_city' );
$this->errors = new WP_Error();
$this->init();
}
/**
* @since 1.0.0
*/
function init() {
$this->title = $this->get_option( 'title', __( 'Alopeyk', 'alopeyk-woocommerce-shipping' ) );
$this->enabled = $this->get_option( 'enabled', 'no' );
$this->wrong_key = $this->get_option( 'wrong_key', 'no' );
foreach ( $this->required_fields as $required_field ) {
$this->{$required_field} = $this->get_option( $required_field );
}
$this->set_helpers();
$this->init_form_fields();
$this->init_settings();
add_action( 'woocommerce_update_options_shipping_' . $this->id, array( $this, 'process_admin_options' ) );
}
/**
* @since 1.0.0
*/
public function init_form_fields() {
$form_fields = array(
'enabled' => array(
'title' => __( 'Enable/Disable', 'alopeyk-woocommerce-shipping' ),
'type' => 'checkbox',
'label' => __( 'Enable Alopeyk shipping', 'alopeyk-woocommerce-shipping' ),
'default' => 'no',
),
'api_key' => array(
'title' => __( 'API Key', 'alopeyk-woocommerce-shipping' ),
'type' => 'text',
'default' => '',
'description' => sprintf( __( 'Please contact Alopeyk to get one.', 'alopeyk-woocommerce-shipping' ), $this->helpers->get_support_url() ),
'custom_attributes' => array(
'required' => 'required'
)
),
);
if ( ! empty( $this->api_key ) && $this->wrong_key != 'yes' ) {
$form_fields['title'] = array(
'title' => __( 'Method Title', 'alopeyk-woocommerce-shipping' ),
'type' => 'text',
'default' => __( 'Alopeyk', 'alopeyk-woocommerce-shipping'),
'description' => __( 'This controls the title which the user will see during checkout proccess.', 'alopeyk-woocommerce-shipping' ),
);
$form_fields['store_options_title_spacer'] = array(
'type' => 'title',
'title' => ' '
);
$form_fields['store_options_title'] = array(
'title' => __( 'Store Details', 'alopeyk-woocommerce-shipping' ),
'type' => 'title',
);
$form_fields['store_name'] = array(
'title' => __( 'Store Name', 'alopeyk-woocommerce-shipping' ),
'type' => 'text',
'description' => __( 'This is your store\'s name.', 'alopeyk-woocommerce-shipping' ),
'custom_attributes' => array(
'required' => 'required'
)
);
$form_fields['store_number'] = array(
'title' => __( 'Store Number', 'alopeyk-woocommerce-shipping' ),
'type' => 'text',
'description' => __( 'This is your store\'s number.', 'alopeyk-woocommerce-shipping' ),
'custom_attributes' => array(
'pattern' => '\d*',
)
);
$form_fields['store_unit'] = array(
'title' => __( 'Store Unit', 'alopeyk-woocommerce-shipping' ),
'type' => 'text',
'description' => __( 'This is your store\'s unit.', 'alopeyk-woocommerce-shipping' ),
'custom_attributes' => array(
'pattern' => '\d*',
)
);
$form_fields['store_phone'] = array(
'title' => __( 'Store Phone', 'alopeyk-woocommerce-shipping' ),
'type' => 'text',
'description' => __( 'This is your store\'s phone.', 'alopeyk-woocommerce-shipping' ),
'custom_attributes' => array(
'required' => 'required',
'maxlength'=> '11',
'pattern' => '\d*',
)
);
$form_fields['store_lat'] = array(
'title' => __( 'Store Latitude', 'alopeyk-woocommerce-shipping' ),
'type' => 'text',
'description' => __( 'Latitude for specified store address.', 'alopeyk-woocommerce-shipping' ),
'custom_attributes' => array(
'required' => 'required'
)
);
$form_fields['store_lng'] = array(
'title' => __( 'Store Longitude', 'alopeyk-woocommerce-shipping' ),
'type' => 'text',
'description' => __( 'Longitude for specified store address.', 'alopeyk-woocommerce-shipping' ),
'custom_attributes' => array(
'required' => 'required'
)
);
$form_fields['store_city'] = array(
'title' => __( 'Store City', 'alopeyk-woocommerce-shipping' ),
'type' => 'hidden',
'class' => 'disabled hide-parent-row',
'default' => '',
'css' => 'pointer-events: none;',
'description' => __( 'This will be automatically fetched when you specify your store location via moving below map marker.', 'alopeyk-woocommerce-shipping' ),
);
$form_fields['store_address'] = array(
'title' => __( 'Store Address', 'alopeyk-woocommerce-shipping' ),
'type' => 'hidden',
'class' => 'disabled',
'default' => '',
'css' => 'pointer-events: none;',
'description' => __( 'Please specify the exact address for your stock, because it will be used as origin address. The origin address will later be used for picking the packages by the courier and calculation of dynamic shipping cost.', 'alopeyk-woocommerce-shipping' ),
'custom_attributes' => array(
'data-autocomplete-placeholder' => __( 'Please enter your address ...', 'alopeyk-woocommerce-shipping' )
)
);
$form_fields['store_description'] = array(
'title' => __( 'Origin Description', 'alopeyk-woocommerce-shipping' ),
'type' => 'textarea',
'description' => __( 'This will be used as origin description shown on couriers device. In most cases it consists of store address details.', 'alopeyk-woocommerce-shipping' ),
);
$form_fields['map_options_title_spacer'] = array(
'type' => 'title',
'title' => ' '
);
$form_fields['map_options_title'] = array(
'title' => __( 'Map Options', 'alopeyk-woocommerce-shipping' ),
'type' => 'title',
);
$form_fields['cedarmap_api_key'] = array(
'title' => __( 'Cedar Maps API Key', 'alopeyk-woocommerce-shipping' ),
'type' => 'text',
'description' => __( 'It is highly recommended to get a specific API key from this link for your store.', 'alopeyk-woocommerce-shipping' ),
);
$form_fields['map_marker'] = array(
'title' => __( 'Marker Image', 'alopeyk-woocommerce-shipping' ),
'type' => 'hidden',
'class' => 'input-upload',
'description' => __( 'You can upload your desired marker image here to be used instead of Cedar\'s default marker image on address maps around your store.', 'alopeyk-woocommerce-shipping' ),
'custom_attributes' => array(
'data-upload-label' => __( 'Upload', 'alopeyk-woocommerce-shipping' ),
'data-remove-label' => '',
)
);
$form_fields['cost_options_title_spacer'] = array(
'type' => 'title',
'title' => ' '
);
$form_fields['cost_options_title'] = array(
'title' => __( 'Cost Options', 'alopeyk-woocommerce-shipping' ),
'type' => 'title',
);
$form_fields['cost_type'] = array(
'title' => __( 'Cost Type', 'alopeyk-woocommerce-shipping' ),
'type' => 'select',
'options' => array(
'dynamic' => __( 'Dynamic Cost', 'alopeyk-woocommerce-shipping' ),
'static' => __( 'Static Cost', 'alopeyk-woocommerce-shipping' )
),
'default' => 'dynamic',
'description' => __( 'This option will specify that whether the shipping cost is a static value or should be fetched from Alopeyk API.', 'alopeyk-woocommerce-shipping' ),
);
$form_fields['static_cost_type'] = array(
'title' => __( 'Static Cost Type', 'alopeyk-woocommerce-shipping' ),
'type' => 'select',
'options' => array(
'percentage' => __( 'Percentage', 'alopeyk-woocommerce-shipping' ),
'fixed' => __( 'Fixed', 'alopeyk-woocommerce-shipping' )
),
'default' => 'fixed',
'description' => __( 'This option will specify that wether the shipping cost is a fixed value or a percentage of cart price.', 'alopeyk-woocommerce-shipping' ),
);
$form_fields['static_cost_fixed'] = array(
'title' => __( 'Fixed Cost', 'alopeyk-woocommerce-shipping' ),
'type' => 'text',
'default' => '0',
'description' => __( 'This option defines the fixed cost should be added to total cart amount. (IRR)', 'alopeyk-woocommerce-shipping' ),
);
$form_fields['static_cost_percentage'] = array(
'title' => __( 'Percentage Cost', 'alopeyk-woocommerce-shipping' ),
'type' => 'text',
'default' => '0',
'description' => __( 'This option defines the percentage of cart amount that should be added to total cart amount.', 'alopeyk-woocommerce-shipping' ),
);
$form_fields['transport_types_settings'] = array(
'title' => __( 'Transportation Type Settings', 'alopeyk-woocommerce-shipping' ),
'type' => 'title',
);
foreach ( $this->helpers->get_transport_types( false ) as $key => $transport_type ) {
$form_fields['pt_' . $key] = array(
'title' => __( 'Ship via', 'alopeyk-woocommerce-shipping' ) . ' ' . __( $transport_type['label'], 'alopeyk-woocommerce-shipping' ),
'type' => 'checkbox',
'default' => 'yes',
'label' => __( 'Enabled', 'alopeyk-woocommerce-shipping' ),
'description' => sprintf( __( 'Total weight of the package should be up to %s kg and its width, height and length should be up to %s, %s and %s centimeters respectively to be allowed to be shipped by this method.', 'alopeyk-woocommerce-shipping' ), $transport_type['limits']['max_weight']/1000, $transport_type['limits']['max_width'], $transport_type['limits']['max_height'], $transport_type['limits']['max_length'] ),
);
}
$form_fields['auto_type'] = array(
'title' => __( 'Smart Switch', 'alopeyk-woocommerce-shipping' ),
'type' => 'checkbox',
'default' => 'yes',
'label' => __( 'Show only most optimal shipping method', 'alopeyk-woocommerce-shipping' ),
'description' => __( 'If not enabled, all possible shipping methods will be shown in the checkout page.', 'alopeyk-woocommerce-shipping' ),
'custom_attributes' => array(
'data-checkbox-toggle-target' => 'toggler-checkbox-id-auto_type_price',
),
);
$form_fields['auto_type_static'] = array(
'title' => __( ' ', 'alopeyk-woocommerce-shipping' ),
'type' => 'checkbox',
'default' => 'yes',
'label' => __( 'Use default price set for choosing most optimal method', 'alopeyk-woocommerce-shipping' ),
'description' => __( 'If not enabled, real-time price will be fetched from Alopeyk’s API for each shipping method in order to choose the most optimal one. This may make the process a bit slower.', 'alopeyk-woocommerce-shipping' ),
'custom_attributes' => array(
'data-checkbox-toggle-id' => 'toggler-checkbox-id-auto_type_price',
),
);
$form_fields['order_options_title_spacer'] = array(
'type' => 'title',
'title' => ' '
);
$form_fields['order_options_title'] = array(
'title' => __( 'Order Options', 'alopeyk-woocommerce-shipping' ),
'type' => 'title',
);
$form_fields[ 'status_change' ] = array(
'title' => __( 'Status Change', 'alopeyk-woocommerce-shipping' ),
'label' => __( 'Enabled', 'alopeyk-woocommerce-shipping' ),
'type' => 'checkbox',
'default' => 'yes',
'description' => __( 'Check this checkbox only if you want WooCommerce orders\' status to be changed based on changes being made in Alopeyk delivery status.', 'alopeyk-woocommerce-shipping' ),
);
$form_fields[ 'customer_dashboard' ] = array(
'title' => __( 'Dashboard Tracking', 'alopeyk-woocommerce-shipping' ),
'label' => __( 'Enabled', 'alopeyk-woocommerce-shipping' ),
'type' => 'checkbox',
'default' => 'yes',
'description' => __( 'Check this checkbox only if you want your customers to be able to track their delivering from their account dashboard.', 'alopeyk-woocommerce-shipping' ),
);
$form_fields[ 'tehran_timezone' ] = array(
'title' => __( 'Use Tehran TimeZone', 'alopeyk-woocommerce-shipping' ),
'label' => __( 'Enabled', 'alopeyk-woocommerce-shipping' ),
'type' => 'checkbox',
'default' => 'yes',
'description' => __( 'Check this checkbox only if you want to use “Tehran TomeZone” for Alopeyk orders, otherwise default Wordpress timezone will be used.', 'alopeyk-woocommerce-shipping' ),
);
$form_fields['refresh_options_title_spacer'] = array(
'type' => 'title',
'title' => ' '
);
$form_fields['refresh_options_title'] = array(
'title' => __( 'Refresh Options', 'alopeyk-woocommerce-shipping' ),
'type' => 'title',
);
$form_fields[ 'refresh_cron_interval' ] = array(
'title' => __( 'Cron Interval', 'alopeyk-woocommerce-shipping' ),
'label' => __( 'Enabled' ),
'type' => 'text',
'default' => '10',
'description' => __( 'The number of seconds between each request for fetching the latest status of an active order. It is highly recommended to be more than 10.', 'alopeyk-woocommerce-shipping' ),
'placeholder' => '10',
'custom_attributes' => array(
'pattern' => '\d*'
)
);
$form_fields[ 'refresh_admin_interval' ] = array(
'title' => __( 'Admin Refresh Interval', 'alopeyk-woocommerce-shipping' ),
'type' => 'text',
'default' => '10',
'description' => __( 'The number of seconds between refreshes in admin panel for bringing latest order details to the screen. It is highly recommended to be more than 10.', 'alopeyk-woocommerce-shipping' ),
'placeholder' => '10',
'custom_attributes' => array(
'pattern' => '\d*'
)
);
$form_fields[ 'refresh_public_interval' ] = array(
'title' => __( 'Front Refresh Interval', 'alopeyk-woocommerce-shipping' ),
'type' => 'text',
'default' => '10',
'description' => __( 'The number of seconds between refreshes in customer dashboard for bringing latest order details to the screen. It is highly recommended to be more than 10.', 'alopeyk-woocommerce-shipping' ),
'placeholder' => '10',
'custom_attributes' => array(
'pattern' => '\d*'
)
);
if ( is_admin() ) {
$wc_payment_gateways = @WC()->payment_gateways;
if ( $wc_payment_gateways ) {
$gateways = $wc_payment_gateways->get_available_payment_gateways();
if ( $gateways && count( $gateways ) ) {
$form_fields['payment_options_title_spacer'] = array(
'type' => 'title',
'title' => ' '
);
$form_fields['payment_options_title'] = array(
'title' => __( 'Payment Options', 'alopeyk-woocommerce-shipping' ),
'type' => 'title',
);
foreach ( $gateways as $gateway ) {
$form_fields[ 'return_' . $gateway->id ] = array(
'title' => $gateway->title,
'label' => __( 'Has return', 'alopeyk-woocommerce-shipping' ),
'type' => 'checkbox',
'default' => $gateway->id == 'cod' ? 'yes' : 'no',
'description' => __( 'Check this checkbox only if you need this payment method to have return trip. For example if want the courier to take the money from the customer after delivering the package and bring it back to your store.', 'alopeyk-woocommerce-shipping' ),
'custom_attributes' => array(
'data-checkbox-toggle-target' => 'toggler-checkbox-id-' . $gateway->id
)
);
$form_fields[ 'return_' . $gateway->id . '_customer' ] = array(
'label' => __( 'Customer should pay for return cost', 'alopeyk-woocommerce-shipping' ),
'type' => 'checkbox',
'default' => 'no',
'description' => __( 'Check this checkbox only if you want customers to pay for return costs whenever this payment method is chosen. If not checked, the cost will be deducted from your Alopeyk account.', 'alopeyk-woocommerce-shipping' ),
'custom_attributes' => array(
'data-checkbox-toggle-id' => 'toggler-checkbox-id-' . $gateway->id,
'data-checkbox-toggle-target' => 'toggler-checkbox-id-' . $gateway->id . '-child'
)
);
$form_fields[ 'return_' . $gateway->id . '_customer_alert' ] = array(
'label' => __( 'Warn customer about price change', 'alopeyk-woocommerce-shipping' ),
'type' => 'checkbox',
'default' => 'yes',
'description' => __( 'Check this checkbox only if you want inform customers about the return cost that will be added to total price.', 'alopeyk-woocommerce-shipping' ),
'custom_attributes' => array(
'data-checkbox-toggle-id' => 'toggler-checkbox-id-' . $gateway->id . '-child'
)
);
}
}
}
}
}
$this->form_fields = $form_fields;
}
/**
* @since 1.0.0
*/
public function admin_options() {
if ( $this->wrong_key == 'yes' && ! empty( $this->api_key ) ) {
$this->errors->add( 'wrong_key', __( 'The API key is not valid.', 'alopeyk-woocommerce-shipping' ) );
}
$empty_fields = array();
foreach ( $this->required_fields as $required_field ) {
if ( isset( $this->form_fields[ $required_field ] ) && empty( $this->{$required_field} ) ) {
$empty_fields[] = $this->form_fields[ $required_field ]['title'];
}
}
if ( count( $empty_fields ) ) {
$this->empty_fields_string = '';
$empty_fields = array_map( function ( $field, $index ) use ( $empty_fields ) {
$this->empty_fields_string .= ( $index == 0 ? '' : ( $index == count( $empty_fields ) - 1 ? ' ' . __( 'and', 'alopeyk-woocommerce-shipping' ) . ' ' : __( ',', 'alopeyk-woocommerce-shipping' ) . ' ' ) ) . '' . $field . '';
return $field;
}, $empty_fields, array_keys( $empty_fields ) );
$this->errors->add( 'missing', sprintf( __( 'Please fill %s field(s), otherwise Alopeyk shipping method cannot be enabled.', 'alopeyk-woocommerce-shipping' ), $this->empty_fields_string ) );
}
foreach ( $this->errors->get_error_messages() as $error ) {
echo '';
}
parent::admin_options();
}
/**
* @since 1.0.0
*/
public function set_helpers() {
$this->helpers = new Alopeyk_WooCommerce_Shipping_Common();
}
/**
* @since 1.0.0
* @param array $package
* @return array
*/
public function get_package_data( $package ) {
$package = (object) $package;
$weights = array( WC()->cart->cart_contents_weight );
$destinations = array( $package->destination );
$dimensions = array();
$contents = $package->contents;
$total_volume = 0;
if ( count( $contents ) ) {
$dimensions = array_map( function( $content ) use ( $total_volume ) {
$width = (float) $content['data']->get_width();
$height = (float) $content['data']->get_height();
$length = (float) $content['data']->get_length();
return array(
'width' => $width,
'height' => $height,
'length' => $length,
'volume' => $width * $height * $length,
'quantity' => $content['quantity']
);
}, $contents );
$total_volume = array_sum( array_column( $dimensions, 'volume' ) );
}
$transport_types = $this->helpers->get_transport_types();
foreach ( $transport_types as $key => $transport_type ) {
$overflowed_state = $this->helpers->has_overflow( $weights, $dimensions, get_option( 'woocommerce_weight_unit' ), get_option( 'woocommerce_dimension_unit' ), $key );
$overflowed[$key] = $overflowed_state;
}
$subtotal = isset( $package->cart_subtotal ) ? $package->cart_subtotal : 0;
$payment_method = $package->active_payment_method;
$package = array(
'extra' => $package,
'weights' => $weights,
'dimensions' => $dimensions,
'destinations' => $destinations,
'overflowed' => serialize( $overflowed ),
'subtotal' => $subtotal,
'payment_method' => $payment_method,
'total_volume' => $total_volume,
'total_weight' => $weights[0],
);
WC()->session->set( 'package_data', $package );
return $package;
}
/**
* @since 1.0.0
* @param array $package
*/
public function calculate_shipping( $package = array() ) {
WC()->session->set( 'return_cost', 0 );
if ( $package && count( $package ) ) {
$package = $this->get_package_data( $package );
$transport_types = $this->helpers->get_transport_types();
$min_price = INF;
$rates = array();
$shipping_methods = array();
$shipping_infos = array();
$selected_type_id = 0;
foreach ( $transport_types as $key => $transport_type ) {
$shipping = (object) $this->helpers->calculate_shipping( $package, $key, null, null, false, true );
if ( isset( $shipping->cost ) ) {
$shipping_methods[] = $key;
$shipping_infos[$key] = $shipping;
$method_title = $this->title . ' (' . $this->helpers->get_transport_type_name( $shipping->type ) . ')';
$rate = array(
'id' => $this->id .'-'. $key,
'label' => $method_title,
'cost' => $this->helpers->normalize_price( $shipping->cost ),
);
if ( $this->helpers->get_option( 'auto_type', 'yes' ) == 'yes' ) {
$rates[] = $rate;
if ( $this->helpers->get_option( 'auto_type_static', 'yes' ) == 'yes' ) {
$selected_type_id = 1;
break;
} elseif ( $rate['cost'] < $min_price ) {
$selected_type_id = count( $rates );
$min_price = $rate['cost'];
}
} else {
$selected_type_id = -1;
$this->add_rate( $rate );
}
}
}
if ( $selected_type_id != 0 ){
if ( $selected_type_id == -1 ){
$shipping_method = explode( '-', WC()->session->get( 'chosen_shipping_methods' )[0] )[1];
} else {
$shipping_method = $shipping_methods[ $selected_type_id - 1 ];
$this->add_rate( $rates[ $selected_type_id - 1 ] );
}
$shipping = (object) $this->helpers->calculate_shipping( $package, $shipping_method, null, null, true, $shipping_infos[$shipping_method] );
if ( $shipping->cost_type == 'dynamic' ) {
$cost_details = (object) $shipping->cost_details;
WC()->session->set( 'return_cost', $this->helpers->normalize_price( $cost_details->price_with_return - $cost_details->price ) );
}
}
}
}
/**
* @since 1.0.0
* @param array $package
* @return boolean
*/
public function is_available( $package = array() ){
WC()->session->set( 'return_cost', 0 );
if ( $package && count( $package ) ) {
$transport_types = $this->helpers->get_transport_types();
foreach ( $transport_types as $key => $transport_type ) {
if ( $this->helpers->is_available( $this->get_package_data( $package ), $key ) ) {
return true;
}
}
}
return false;
}
/**
* @since 1.0.0
* @return array
*/
public function process_admin_options() {
$this->init_settings();
$post_data = $this->get_post_data();
$fields = $this->get_form_fields();
foreach ( $fields as $key => $field ) {
if ( 'title' != $this->get_field_type( $field ) ) {
try {
$this->settings[ $key ] = $this->get_field_value( $key, $field, $post_data );
} catch ( Exception $e ) {
$this->add_error( $e->getMessage() );
}
}
}
$api_key = $this->get_field_value( 'api_key', $fields['api_key'], $post_data );
if ( ! empty( $api_key ) ) {
if ( $this->helpers->authenticate( true, $api_key, true ) && $user_data = $this->helpers->get_user_data() ) {
$phone = isset( $fields['store_phone'] ) ? $this->get_field_value( 'store_phone', $fields['store_phone'], $post_data ) : '';
$name = isset( $fields['store_name'] ) ? $this->get_field_value( 'store_name', $fields['store_name'], $post_data ) : '';
if ( empty( $phone ) ) {
$this->settings[ 'store_phone' ] = $user_data->phone;
}
if ( empty( $name ) ) {
$this->settings[ 'store_name' ] = $user_data->firstname . ' ' . $user_data->lastname;
}
$this->settings[ 'wrong_key' ] = 'no';
} else {
$this->settings[ 'enabled' ] = 'no';
$this->settings[ 'wrong_key' ] = 'yes';
}
}
$empty_fields = array();
foreach ( $this->required_fields as $required_field ) {
if ( ! isset( $this->settings[$required_field] ) || empty( $this->settings[$required_field] ) ) {
$this->settings[ 'enabled' ] = 'no';
break;
}
}
return update_option( $this->get_option_key(), apply_filters( 'woocommerce_settings_api_sanitized_fields_' . $this->id, $this->settings ) );
}
}