' . sprintf( __( '%1$sWooCommerce Aramex is almost ready.%2$s To get started, %3$senter your Aramex account details%4$s.', 'woocommerce-shipping-aramex' ), '', '', '', '' ) . '
' . sprintf( __( '%1$sYour server does not have the %3$sSOAP Client%4$s enabled.%2$s Please contact your web hosting provider and request that SOAP be enabled.', 'woocommerce-shipping-aramex' ), '', '', '', '' ) . '
woocommerce/logs/' . $this->id . '-' . sanitize_file_name( wp_hash( $this->id ) ) . '.txt' ),
),
);
}
/**
* Generate an array of available time options.
*
* @since 1.0.0
* @return array Time options.
*/
private function _get_time_options() {
$response = array();
for ( $i = 0; $i <= 23; $i++ ) {
$value = str_pad( $i, 2, '0', STR_PAD_LEFT );
$response[ $value . ':00' ] = $value . ':00';
$response[ $value . ':15' ] = $value . ':15';
$response[ $value . ':30' ] = $value . ':30';
$response[ $value . ':45' ] = $value . ':45';
}
return $response;
}
/**
* Check whether this shipping method is available or not.
*
* @param array $package Package.
*
* @return bool Returns true if available.
*/
public function is_available( $package ) {
if ( empty( $package['destination']['country'] ) ) {
return false;
}
return apply_filters( 'woocommerce_shipping_' . $this->id . '_is_available', true, $package );
}
/**
* Render the admin settings.
*
* @todo there are some SOAP notices renderer scattered, make sure to
* consolidate in a single location.
*
* @since 1.0.0
* @version 1.0.2
*/
public function admin_options() {
if ( ! extension_loaded( 'soap' ) ) {
?>
Note: the SOAP extension must be loaded for Aramex shipping to work. Contact your hosting company, ISP or systems administrator and request that the soap extension be activated.
test ) { return $this->get_test_client_info(); } return array( 'AccountCountryCode' => WC()->countries->get_base_country(), 'AccountEntity' => $this->account_entity, 'AccountNumber' => $this->account_number, 'AccountPin' => $this->account_pin, 'UserName' => $this->account_user_name, 'Password' => $this->account_password, 'Version' => 'V1.0', ); } /** * Get test client info. * * @return array Client info. */ public function get_test_client_info() { return array( 'AccountCountryCode' => '', 'AccountEntity' => '', 'AccountNumber' => '', 'AccountPin' => '', 'UserName' => 'testingapi@aramex.com', 'Password' => 'R123456789$r', 'Version' => 'v1.0', ); } /** * Get parameters for origin address when requesting rates calculation. * * @return array Origin address. */ public function rates_get_origin_address() { return array( 'Line1' => $this->account_address1, 'Line2' => $this->account_address2, 'Line3' => $this->account_address3, 'City' => $this->account_city, 'StateOrProvinceCode' => $this->account_province_code, 'PostCode' => $this->account_post_code, 'CountryCode' => WC()->countries->get_base_country(), ); } /** * Exchange rates calculator * * @param array $params Request params. * * @return mixed Response. */ public function calculate_rates( $params ) { try { $params['ClientInfo'] = $this->get_client_info(); $params['OriginAddress'] = $this->rates_get_origin_address(); $debugParams = $params; unset( $debugParams['ClientInfo']['Password'] ); /* translators: placeholder is dumped API request parameters. */ $this->log_debug( sprintf( __( 'Aramex calculate rates API request params:%s', 'woocommerce-shipping-aramex' ), print_r( $debugParams, true ) ) ); $soap_client = new SoapClient( WC_Aramex()->plugin_dir . '/wsdl/aramex-rates-calculator-wsdl.wsdl', array( 'trace' => 1, ) ); $results = $soap_client->CalculateRate( $params ); /* translators: placeholder is dumped response from API. */ $this->log_debug( sprintf( __( 'Aramex calculate rates API response:
%s', 'woocommerce-shipping-aramex' ), print_r( $results, true ) ) ); return $results; } catch ( SoapFault $e ) { /* translators: placeholder is SOAP error message. */ $this->log_debug( sprintf( __( 'Aramex SOAP error: %s.', 'woocommerce-shipping-aramex' ), $e->getMessage() ), 'error' ); return null; } } /** * Get params for rates calculator request. * * @since 1.0.2 * @version 1.0.2 * * @param array $package Package to calculate. * * @return array Request params. */ public function get_calculate_rates_params( $package ) { return array( 'Transaction' => array( 'Reference1' => time(), ), 'DestinationAddress' => array( 'Line1' => WC()->customer->get_shipping_address(), 'Line2' => WC()->customer->get_shipping_address_2(), 'City' => WC()->customer->get_shipping_city(), 'StateOrProvinceCode' => WC()->customer->get_shipping_state(), 'PostCode' => WC()->customer->get_shipping_postcode(), 'CountryCode' => WC()->customer->get_shipping_country(), ), 'ShipmentDetails' => array( 'PaymentType' => 'P', 'ProductGroup' => $this->get_package_product_group( $package ), 'ProductType' => $this->get_package_product_type( $package ), 'NumberOfPieces' => WC()->cart->cart_contents_count, 'ActualWeight' => array( 'Value' => wc_get_weight( WC()->cart->cart_contents_weight, 'kg' ), 'Unit' => 'KG', // Aramex accepts KG and LB, use KG here for weight-related. ), 'ChargeableWeight' => array( 'Value' => wc_get_weight( WC()->cart->cart_contents_weight, 'kg' ), 'Unit' => 'KG', // Aramex accepts KG and LB, use KG here for weight-related. ), ), ); } /** * Calculate shipping for a given package. * * @param array $package Package to calculate the cost. */ public function calculate_shipping( $package = array() ) { $this->calculate_shipping_check_cart_items(); // Use box packing if box packing enabled and user custom boxes exist. // Otherwise calculate per item. if ( 'yes' === $this->enable_box_packing && ! empty( $this->boxes ) ) { $this->log_debug( __( 'Aramex calculate shipping cost with box packing.', 'woocommerce-shipping-aramex' ) ); $this->calculate_shipping_with_box_packing( $package ); } else { $this->log_debug( __( 'Aramex calculate shipping cost per item based.', 'woocommerce-shipping-aramex' ) ); $this->calculate_shipping_per_item( $package ); } } /** * Check items in cart before calculate the shipping costs. * * This will log any notices or errors. * * @since 1.0.2 * @version 1.0.2 */ protected function calculate_shipping_check_cart_items() { foreach ( WC()->cart->get_cart() as $item ) { $product = wc_get_product( $item['product_id'] ); if ( ! $product->needs_shipping() ) { /* translators: item is item's title */ $this->log_debug( sprintf( __( 'Aramex: Product %s is virtual. Skipping.', 'woocommerce-shipping-aramex' ), $product->get_title() ) ); continue; } if ( ! $product->has_dimensions() ) { /* translators: item is item's title */ $this->log_debug( sprintf( __( 'Aramex error: There is no dimension for product %s.', 'woocommerce-shipping-aramex' ), $product->get_title() ), 'error' ); } // Check for weight. if ( ! $product->get_weight() ) { /* translators: item is item's title */ $this->log_debug( sprintf( __( 'Aramex error: There is no weight for product %s.', 'woocommerce-shipping-aramex' ), $product->get_title() ), 'error' ); } } } /** * Calculate shipping costs with box packing enabled. * * @since 1.0.2 * @version 1.0.2 * * @param array $package Package to calculate. */ protected function calculate_shipping_with_box_packing( $package ) { if ( ! class_exists( 'WC_Boxpack' ) ) { require_once( WC_Aramex()->plugin_dir . '/includes/box-packer/class-wc-boxpack.php' ); } $boxpack = new WC_Boxpack(); // Define boxes. foreach ( $this->boxes as $box ) { // Convert dimension to cm and weight to kg as Aramex accept those // units. $b = $boxpack->add_box( wc_get_dimension( $box['outer_length'], 'cm' ), wc_get_dimension( $box['outer_width'], 'cm' ), wc_get_dimension( $box['outer_height'], 'cm' ), wc_get_weight( $box['box_weight'], 'kg' ) ); $b->set_inner_dimensions( wc_get_dimension( $box['inner_length'], 'cm' ), wc_get_dimension( $box['inner_width'], 'cm' ), wc_get_dimension( $box['inner_height'], 'cm' ) ); if ( $box['max_weight'] ) { $b->set_max_weight( wc_get_weight( $box['max_weight'], 'kg' ) ); } if ( ! empty( $box['name'] ) ) { $b->set_id( $box['name'] ); } } // Add items to defined boxes. foreach ( $package['contents'] as $item_id => $values ) { if ( ! $values['data']->needs_shipping() ) { continue; } $has_dimensions_and_weight = ( $values['data']->get_length() && $values['data']->get_height() && $values['data']->get_width() && $values['data']->get_weight() ); if ( ! $has_dimensions_and_weight ) { $this->log_debug( __( 'Aramex error: Product missing dimensions or weight. Abort box packing calculation.', 'woocommerce-shipping-aramex' ), 'error' ); return; } for ( $i = 0; $i < $values['quantity']; $i ++ ) { // Convert dimension to cm and weight to kg as Aramex accept those // units. $boxpack->add_item( wc_get_dimension( $values['data']->get_length(), 'cm' ), wc_get_dimension( $values['data']->get_height(), 'cm' ), wc_get_dimension( $values['data']->get_width(), 'cm' ), wc_get_weight( $values['data']->get_weight(), 'kg' ), $values['data']->get_price() ); } } // Pack it. $boxpack->pack(); $box_packages = $boxpack->get_packages(); // Nothing fits. if ( empty( $box_packages ) ) { $this->log_debug( __( 'Aramex: no box fits for the pacakge.', 'woocommerce-shipping-aramex' ) ); return; } $params = $this->get_calculate_rates_params( $package ); $items = array(); $total_weight = 0; foreach ( $box_packages as $key => $box_package ) { /* translators: 1) box package index 2) box package contents */ $this->log_debug( sprintf( __( 'Aramex box package #%1$s:
%2$s', 'woocommerce-shipping-aramex' ), $key, print_r( $box_package, true ) ) ); // Convert weight to kg as Aramex accepts that. $items[] = array( 'Weight' => array( 'Unit' => 'KG', 'Value' => wc_get_weight( $box_package->weight, 'kg' ), ), 'Quantity' => 1, ); $total_weight += $box_package->weight; } $params['ShipmentDetails']['Items'] = $items; $params['ShipmentDetails']['ActualWeight']['Value'] = $total_weight; $params['ShipmentDetails']['ChargeableWeight']['Value'] = $total_weight; $params['ShipmentDetails']['NumberOfPieces'] = count( $box_packages ); $results = $this->calculate_rates( $params ); if ( ! is_null( $results ) && empty( $results->HasErrors ) ) { $rate = array( 'label' => $this->title, 'cost' => empty( $results->TotalAmount->Value ) ? 0.0 : $results->TotalAmount->Value, 'calc_tax' => 'per_item', 'package' => $package, ); // Register the rate. $this->add_rate( $rate ); } else { /* translators: placeholder is dumped response from API. */ $this->log_debug( sprintf( __( 'Aramex calculate rates API response:
%s', 'woocommerce-shipping-aramex' ), print_r( $results, true ) ) ); } } /** * Calculate shipping cost per item. * * @since 1.0.2 * @version 1.0.2 * * @param array $package Package to calculate. */ protected function calculate_shipping_per_item( $package ) { $items = array(); foreach ( $package['contents'] as $values ) { if ( ! $values['data']->needs_shipping() ) { continue; } $has_dimensions_and_weight = ( $values['data']->get_length() && $values['data']->get_height() && $values['data']->get_width() && $values['data']->get_weight() ); if ( $has_dimensions_and_weight ) { // Convert weight to kg as Aramex accepts that. $items[] = array( 'Weight' => array( 'Unit' => 'KG', 'Value' => $values['quantity'] * wc_get_weight( $values['data']->get_weight(), 'kg' ), ), 'Quantity' => $values['quantity'], ); } } if ( empty( $items ) ) { $this->log_debug( __( 'Aramex: no pacakge to calculate.', 'woocommerce-shipping-aramex' ) ); return; } $params = $this->get_calculate_rates_params( $package ); $params['ShipmentDetails']['Items'] = $items; $results = $this->calculate_rates( $params ); if ( ! is_null( $results ) && empty( $results->HasErrors ) ) { $this->log_debug( __( 'Found rates from Aramex.', 'woocommerce-shipping-aramex' ) ); $rate = array( 'label' => $this->title, 'cost' => empty( $results->TotalAmount->Value ) ? 0.0 : $results->TotalAmount->Value, 'calc_tax' => 'per_item', ); // Register the rate. $this->add_rate( $rate ); } else { $this->log_debug( __( 'No rates returned from Aramex.', 'woocommerce-shipping-aramex' ) ); } } /** * Get product type, to be passed to Aramex, from a given package. * * For product group domestic ('DOM') valid product type is only 'OND', otherwise * use selected product type in setting instance. * * @since 1.0.2 * @version 1.0.2 * * @param array $package Package to check. See `self::calculate_shipping`. * * @return string Product type. */ protected function get_package_product_type( $package ) { return ( WC()->countries->get_base_country() !== $package['destination']['country'] ) ? $this->aramex_product_type : 'OND'; } /** * Get product type, to be passed to Aramex, from a given order. * * For product group domestic ('DOM') valid product type is only 'OND', otherwise * use selected product type in setting instance. * * @since 1.0.2 * @version 1.0.2 * * @param WC_Order $order Order to check. * * @return string Product type. */ protected function get_order_product_type( WC_Order $order ) { $destination = version_compare( WC_VERSION, '3.0', '<' ) ? $order->shipping_country : $order->get_shipping_country(); return WC()->countries->get_base_country() !== $destination ? $this->aramex_product_type : 'OND'; } /** * Get product group, to be passed to Aramex, from a given package. * * @since 1.0.2 * @version 1.0.2 * * @param array $package Package to check. See `self::calculate_shipping`. * * @return string Product group. */ protected function get_package_product_group( array $package ) { return ( WC()->countries->get_base_country() !== $package['destination']['country'] ) ? 'EXP' : 'DOM'; } /** * Get product group, to be passed to Aramex, from a given order. * * @since 1.0.2 * @version 1.0.2 * * @param WC_Order $order Order to check. * * @return string Product group. */ protected function get_order_product_group( WC_Order $order ) { $destination = version_compare( WC_VERSION, '3.0', '<' ) ? $order->shipping_country : $order->get_shipping_country(); return WC()->countries->get_base_country() !== $destination ? 'EXP' : 'DOM'; } /** * Log debug message. * * @since 1.0.2 * @version 1.0.2 * * @param string $message Debug message. * @param string $type Debug message type. */ public function log_debug( $message, $type = 'notice' ) { if ( 'yes' !== $this->debug ) { return; } // Make sure only admin can see the notice. The check for wc_add_notice // is necessary in case it's called from non front-end request where // `wc_add_notice` is not available. if ( current_user_can( 'manage_options' ) && function_exists( 'wc_add_notice' ) ) { wc_add_notice( $message, $type ); } if ( empty( $this->log ) ) { $this->log = new WC_Logger(); } $this->log->add( $this->id, $message ); } }