' + message + '
'+e+"
")}},o(document).ready(function(){t.dhl_parcel_finder.init()})}(jQuery,window.germanized); \ No newline at end of file diff --git a/packages/woocommerce-germanized-dhl/assets/js/parcel-locator.js b/packages/woocommerce-germanized-dhl/assets/js/parcel-locator.js new file mode 100644 index 000000000..8995b6902 --- /dev/null +++ b/packages/woocommerce-germanized-dhl/assets/js/parcel-locator.js @@ -0,0 +1,400 @@ + +window.germanized = window.germanized || {}; +window.germanized.dhl_parcel_locator = window.germanized.dhl_parcel_locator || {}; + +( function( $, germanized ) { + + /** + * Core + */ + germanized.dhl_parcel_locator = { + + params: {}, + parcelShops: [], + wrapper: '', + + init: function () { + var self = germanized.dhl_parcel_locator; + self.params = wc_gzd_dhl_parcel_locator_params; + self.wrapper = self.params.wrapper; + + $( document ) + .on( 'change.dhl', self.wrapper + ' #shipping_address_type', self.refreshAddressType ) + .on( 'change.dhl', self.wrapper + ' #shipping_address_1', self.onChangeAddress ) + .on( 'change.dhl', self.wrapper + ' #ship-to-different-address-checkbox', self.onChangeShipping ) + .on( 'change.dhl', self.wrapper + ' #shipping_country', self.refreshAvailability ); + + $( document.body ).on( 'updated_checkout', self.afterRefreshCheckout ); + + self.refreshAvailability(); + self.refreshAddressType(); + }, + + isCheckout: function() { + var self = germanized.dhl_parcel_locator; + + return self.params.is_checkout; + }, + + afterRefreshCheckout: function() { + var self = germanized.dhl_parcel_locator; + + var params = { + 'security': self.params.parcel_locator_data_nonce, + 'action' : 'woocommerce_gzd_dhl_parcel_locator_refresh_shipping_data' + }; + + $.ajax({ + type: "POST", + url: self.params.ajax_url, + data: params, + success: function( data ) { + // Update shipping method data from session + self.params['methods'] = data.methods; + self.refreshAvailability(); + }, + error: function( data ) { + self.refreshAvailability(); + }, + dataType: 'json' + }); + }, + + refreshAvailability: function() { + var self = germanized.dhl_parcel_locator, + shippingMethod = self.getShippingMethod(), + methodData = self.getShippingMethodData( shippingMethod ); + + if ( ! self.isAvailable() ) { + $( self.wrapper + ' #shipping_address_type' ).val( 'regular' ).trigger( 'change' ); + $( self.wrapper + ' #shipping_address_type_field' ).hide(); + } else { + var $typeField = $( self.wrapper + ' #shipping_address_type' ); + var selected = $typeField.val(); + + if ( self.isCheckout() ) { + $typeField.html( '' ); + + if ( methodData ) { + $.each( methodData.address_type_options, function( name, title ) { + $typeField.append( $( '', { + value: name, + text : title + })); + }); + + if ( $typeField.find( 'option[value="' + selected + '"]' ).length > 0 ) { + $typeField.find( 'option[value="' + selected + '"]' ).prop( 'selected', true ); + } + + $typeField.trigger( 'change' ); + } + } + + if ( $typeField.find( 'option' ).length > 0 ) { + $( self.wrapper + ' #shipping_address_type_field' ).show(); + } else { + $( self.wrapper + ' #shipping_address_type_field' ).hide(); + } + + $( document.body ).trigger( 'woocommerce_gzd_dhl_location_available_pickup_types_changed' ); + } + }, + + onChangeShipping: function() { + var self = germanized.dhl_parcel_locator, + $checkbox = $( this ); + + if ( $checkbox.is( ':checked' ) ) { + self.refreshAvailability(); + + if ( self.isEnabled() ) { + self.refreshAddressType(); + } + } + }, + + onChangeAddress: function() { + var self = germanized.dhl_parcel_locator; + + if ( self.isEnabled() ) { + self.formatAddress(); + } + }, + + formatAddress: function() { + var needsValidation = false, + self = germanized.dhl_parcel_locator, + $addressField = $( self.wrapper + ' #shipping_address_1' ), + address = $addressField.val(); + + if ( address.length > 0 ) { + if ( $.isNumeric( address ) ) { + needsValidation = true; + } else if ( self.addressIsPackstation() || self.addressIsPostOffice() || self.addressIsParcelShop() ) { + + } else { + $addressField.val( '' ); + } + } + + if ( needsValidation ) { + self.validateAddress( address ); + } + + self.refreshCustomerNumberStatus(); + }, + + addressIsPackstation: function() { + var self = germanized.dhl_parcel_locator, + addressVal = $( self.wrapper + ' #shipping_address_1' ).val().toLowerCase(); + + if ( addressVal.indexOf( self.params.i18n.packstation.toLowerCase() ) >= 0 ) { + return true; + } + + return false; + }, + + addressIsPostOffice: function() { + var self = germanized.dhl_parcel_locator, + addressVal = $( self.wrapper + ' #shipping_address_1' ).val().toLowerCase(); + + if ( addressVal.indexOf( self.params.i18n.postoffice.toLowerCase() ) >= 0 ) { + return true; + } + + return false; + }, + + addressIsParcelShop: function() { + var self = germanized.dhl_parcel_locator, + addressVal = $( self.wrapper + ' #shipping_address_1' ).val().toLowerCase(); + + if ( addressVal.indexOf( self.params.i18n.parcelshop.toLowerCase() ) >= 0 ) { + return true; + } + + return false; + }, + + shippingMethodSupportsPickupType: function( method, pickupType ) { + var self = germanized.dhl_parcel_locator, + data = self.getShippingMethodData( method ), + supports = false; + + if ( data ) { + if ( $.inArray( pickupType, data.supports ) !== -1 ) { + supports = true; + } + } + + return supports; + }, + + customerNumberIsMandatory: function() { + var self = germanized.dhl_parcel_locator; + + if ( ! self.isEnabled() ) { + return false; + } + + if ( self.addressIsPackstation() ) { + return true; + } else if ( self.addressIsParcelShop() ) { + return false; + } else if ( self.addressIsPostOffice() ) { + return false; + } + + return false; + }, + + refreshCustomerNumberStatus: function() { + var self = germanized.dhl_parcel_locator, + $field = $( self.wrapper + ' #shipping_dhl_postnumber_field' ); + + if ( self.customerNumberIsMandatory() ) { + if ( ! $field.find( 'label span' ).length || ( ! $field.find( 'label span' ).hasClass( 'required' ) ) ) { + $field.find( 'label' ).append( ' *' ); + } + + $field.find( 'label span.optional' ).hide(); + $field.addClass( 'validate-required' ); + } else { + $field.find( 'label span.required' ).remove(); + $field.find( 'label span.optional' ).show(); + + $field.removeClass( 'validate-required woocommerce-invalid woocommerce-invalid-required-field' ); + } + }, + + validateAddress: function( addressData ) { + var self = germanized.dhl_parcel_locator, + params = { + 'action' : 'woocommerce_gzd_dhl_parcel_locator_validate_address', + 'address' : addressData, + 'security': self.params.parcel_locator_nonce + }; + + $.ajax({ + type: "POST", + url: self.params.ajax_url, + data: params, + success: function( data ) { + if ( data.valid ) { + $( self.wrapper + ' #shipping_address_1' ).val( data.address ); + self.refreshCustomerNumberStatus(); + } else { + $( self.wrapper + ' #shipping_address_1' ).val( '' ); + } + }, + error: function( data ) {}, + dataType: 'json' + }); + }, + + getShippingMethodData: function( method ) { + var self = germanized.dhl_parcel_locator; + + if ( self.params.methods.hasOwnProperty( method ) ) { + return self.params.methods[ method ]; + } + + return false; + }, + + refreshAddressType: function() { + var self = germanized.dhl_parcel_locator, + $addressField = $( self.wrapper + ' #shipping_address_1_field' ), + $addressInput = $( self.wrapper + ' #shipping_address_1' ), + shippingMethod = self.getShippingMethod(), + methodData = self.getShippingMethodData( shippingMethod ), + address = $addressInput.val(), + $spans; + + if ( self.isEnabled() ) { + + if ( methodData ) { + $addressInput.data( 'label-dhl', methodData.street_label ); + $addressInput.data( 'placeholder-dhl', methodData.street_placeholder ); + $addressInput.data( 'desc-dhl', methodData.finder_button ); + } + + $( self.wrapper + ' #shipping_dhl_postnumber_field' ).show(); + + if ( $addressInput.data( 'label-dhl' ) ) { + $spans = $addressField.find( 'label span, label abbr' ); + + $addressField.find( 'label' ).html( $addressInput.data( 'label-dhl' ) + ' ' ); + $addressField.find( 'label' ).append( $spans ); + } + + if ( $addressInput.data( 'placeholder-dhl' ) ) { + $addressInput.attr( 'placeholder', $addressInput.data( 'placeholder-dhl' ) ); + } + + if ( $addressInput.data( 'desc-dhl' ) ) { + $addressField.find( '.dhl-desc' ).remove(); + $addressField.find( '.woocommerce-input-wrapper' ).after( '' + $addressInput.data( 'desc-dhl' ) + '
' ); + } + + if ( address.length > 0 ) { + self.formatAddress(); + } + } else { + $( self.wrapper + ' #shipping_dhl_postnumber_field' ).hide(); + + if ( $addressInput.data( 'label-regular' ) ) { + $spans = $addressField.find( 'label span, label abbr' ); + + $addressField.find( 'label' ).html( $addressInput.data( 'label-regular' ) + ' ' ); + $addressField.find( 'label' ).append( $spans ); + } + + if ( $addressInput.data( 'placeholder-regular' ) ) { + $addressInput.attr( 'placeholder', $addressInput.data( 'placeholder-regular' ) ); + } + + $addressField.find( '.dhl-desc' ).remove(); + } + }, + + isEnabled: function() { + var self = germanized.dhl_parcel_locator; + + return self.isAvailable() && $( self.wrapper + ' #shipping_address_type' ).val() === 'dhl'; + }, + + getShippingMethod: function( pwithInstanceId ) { + var current = ''; + var withInstanceId = pwithInstanceId ? pwithInstanceId : true; + + if ( $( 'select.shipping_method' ).length > 0 ) { + current = $( 'select.shipping_method' ).val(); + } else if ( $( 'input[name^="shipping_method"]:checked' ).length > 0 ) { + current = $( 'input[name^="shipping_method"]:checked' ).val(); + } else if ( $( 'input[name^="shipping_method"][type="hidden"]' ).length > 0 ) { + current = $( 'input[name^="shipping_method"][type="hidden"]' ).val(); + } + + if ( ! withInstanceId ) { + if ( 'undefined' !== typeof current && current.length > 0 ) { + var currentParts = current.split(':'); + + if ( currentParts.length > 0 ) { + current = currentParts[0]; + } + } + } else { + // In case an instance id is needed but missing - assume 0 as instance id + if ( 'undefined' !== typeof current && current.length > 0 ) { + var currentParts = current.split(':'); + + if ( currentParts.length <= 1 ) { + current = current + ':0'; + } + } + } + + return current; + }, + + pickupTypeIsAvailable: function( pickupType ) { + var self = germanized.dhl_parcel_locator, + shippingMethod = self.getShippingMethod(), + isAvailable = true; + + if ( ! self.shippingMethodSupportsPickupType( shippingMethod, pickupType ) ) { + isAvailable = false; + } + + return isAvailable; + }, + + isAvailable: function() { + var self = germanized.dhl_parcel_locator, + shippingCountry = $( self.wrapper + ' #shipping_country' ).val(), + shippingMethod = self.getShippingMethod(), + methodData = self.getShippingMethodData( shippingMethod ), + isAvailable = true; + + if ( $.inArray( shippingCountry, self.params.supported_countries ) === -1 ) { + isAvailable = false; + } + + if ( self.isCheckout() ) { + if ( ! methodData || methodData.supports.length === 0 ) { + isAvailable = false; + } + } + + return isAvailable; + } + }; + + $( document ).ready( function() { + germanized.dhl_parcel_locator.init(); + }); + +})( jQuery, window.germanized ); diff --git a/packages/woocommerce-germanized-dhl/assets/js/parcel-locator.min.js b/packages/woocommerce-germanized-dhl/assets/js/parcel-locator.min.js new file mode 100644 index 000000000..8ae25b855 --- /dev/null +++ b/packages/woocommerce-germanized-dhl/assets/js/parcel-locator.min.js @@ -0,0 +1 @@ +window.germanized=window.germanized||{},window.germanized.dhl_parcel_locator=window.germanized.dhl_parcel_locator||{},function(s,i){i.dhl_parcel_locator={params:{},parcelShops:[],wrapper:"",init:function(){var e=i.dhl_parcel_locator;e.params=wc_gzd_dhl_parcel_locator_params,e.wrapper=e.params.wrapper,s(document).on("change.dhl",e.wrapper+" #shipping_address_type",e.refreshAddressType).on("change.dhl",e.wrapper+" #shipping_address_1",e.onChangeAddress).on("change.dhl",e.wrapper+" #ship-to-different-address-checkbox",e.onChangeShipping).on("change.dhl",e.wrapper+" #shipping_country",e.refreshAvailability),s(document.body).on("updated_checkout",e.afterRefreshCheckout),e.refreshAvailability(),e.refreshAddressType()},isCheckout:function(){return i.dhl_parcel_locator.params.is_checkout},afterRefreshCheckout:function(){var a=i.dhl_parcel_locator,e={security:a.params.parcel_locator_data_nonce,action:"woocommerce_gzd_dhl_parcel_locator_refresh_shipping_data"};s.ajax({type:"POST",url:a.params.ajax_url,data:e,success:function(e){a.params.methods=e.methods,a.refreshAvailability()},error:function(e){a.refreshAvailability()},dataType:"json"})},refreshAvailability:function(){var e=i.dhl_parcel_locator,a=e.getShippingMethod(),r=e.getShippingMethodData(a);if(e.isAvailable()){var d=s(e.wrapper+" #shipping_address_type"),p=d.val();e.isCheckout()&&(d.html(""),r&&(s.each(r.address_type_options,function(e,a){d.append(s("",{value:e,text:a}))}),0'+d.data("desc-dhl")+"
")),0-
+ *
- A4 + *
- 910-300-700 + *
- 910-300-700-oZ + *
- 910-300-600 + *
- 910-300-610 + *
- 910-300-710 + *
- 100x70mm (Warenpost only) + *
accessed.', 'dhl', 'woocommerce-germanized' ), admin_url( 'admin.php?page=wc-status&tab=dhl' ) ) ); ?>
' . _x( 'This label has been generated by the DHL for WooCommerce Plugin and is shown for legacy purposes.', 'dhl', 'woocommerce-germanized' ) . '
'; + echo '' . _x( 'Download label', 'dhl', 'woocommerce-germanized' ) . ''; + } + } + + public static function get_legacy_label_download_url( $order_id ) { + $url = add_query_arg( array( 'action' => 'wc-gzd-dhl-download-legacy-label', 'order_id' => $order_id, 'force' => 'yes' ), wp_nonce_url( admin_url(), 'dhl-download-legacy-label' ) ); + + return $url; + } + + public static function download_legacy_label() { + if( isset( $_GET['action'] ) && 'wc-gzd-dhl-download-legacy-label' === $_GET['action'] ) { + if ( isset( $_GET['order_id'] ) && wp_verify_nonce( $_REQUEST['_wpnonce'], 'dhl-download-legacy-label' ) ) { + $order_id = absint( $_GET['order_id'] ); + $args = \Vendidero\Germanized\Shipments\Labels\DownloadHandler::parse_args( array( + 'force' => wc_string_to_bool( isset( $_GET['force'] ) ? wc_clean( $_GET['force'] ) : false ) + ) ); + + if ( current_user_can( 'edit_shop_orders' ) ) { + if ( $order = wc_get_order( $order_id ) ) { + $meta = (array) $order->get_meta( '_pr_shipment_dhl_label_tracking' ); + + if ( ! empty( $meta ) ) { + $path = $meta['label_path']; + + if ( file_exists( $path ) ) { + $filename = basename( $path ); + + \Vendidero\Germanized\Shipments\Labels\DownloadHandler::download( $path, $filename, $args['force'] ); + } + } + } + } + } + } + } + + public static function admin_scripts() { + global $post; + + $screen = get_current_screen(); + $screen_id = $screen ? $screen->id : ''; + $suffix = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min'; + + wp_register_script( 'wc-gzd-admin-dhl-internetmarke', Package::get_assets_url() . '/js/admin-internetmarke' . $suffix . '.js', array( 'jquery' ), Package::get_version() ); + wp_register_script( 'wc-gzd-admin-deutsche-post-label', Package::get_assets_url() . '/js/admin-deutsche-post-label' . $suffix . '.js', array( 'wc-gzd-admin-shipment-label-backbone' ), Package::get_version() ); + + if ( wp_script_is( 'wc-gzd-admin-shipment-label-backbone', 'enqueued' ) ) { + wp_enqueue_script( 'wc-gzd-admin-deutsche-post-label' ); + + wp_localize_script( + 'wc-gzd-admin-deutsche-post-label', + 'wc_gzd_admin_deutsche_post_label_params', + array( + 'refresh_label_preview_nonce' => wp_create_nonce( 'wc-gzd-dhl-refresh-deutsche-post-label-preview' ), + ) + ); + } + + // Shipping zone methods + if ( 'woocommerce_page_wc-settings' === $screen_id && isset( $_GET['provider'] ) && 'deutsche_post' === $_GET['provider'] ) { + wp_enqueue_script( 'wc-gzd-admin-dhl-internetmarke' ); + } + } + + public static function admin_styles() { + global $wp_scripts; + + $screen = get_current_screen(); + $screen_id = $screen ? $screen->id : ''; + $suffix = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min'; + + // Register admin styles. + wp_register_style( 'woocommerce_gzd_dhl_admin', Package::get_assets_url() . '/css/admin' . $suffix . '.css', array( 'woocommerce_admin_styles' ), Package::get_version() ); + + // Admin styles for WC pages only. + if ( in_array( $screen_id, self::get_screen_ids() ) ) { + wp_enqueue_style( 'woocommerce_gzd_dhl_admin' ); + } + } + + protected static function get_table_screen_ids() { + return array( + 'woocommerce_page_wc-gzd-shipments', + 'woocommerce_page_wc-gzd-return-shipments' + ); + } + + public static function get_screen_ids() { + $screen_ids = self::get_table_screen_ids(); + + foreach ( wc_get_order_types() as $type ) { + $screen_ids[] = $type; + $screen_ids[] = 'edit-' . $type; + } + + return $screen_ids; + } +} diff --git a/packages/woocommerce-germanized-dhl/src/Admin/Importer/DHL.php b/packages/woocommerce-germanized-dhl/src/Admin/Importer/DHL.php new file mode 100644 index 000000000..c169892c8 --- /dev/null +++ b/packages/woocommerce-germanized-dhl/src/Admin/Importer/DHL.php @@ -0,0 +1,190 @@ +get_customer_number(); + } + + return ( ( ! empty( $options ) && empty( $user ) && 'yes' !== $imported && Package::base_country_is_supported() ) ? true : false ); + } + + public static function is_plugin_enabled() { + return class_exists( 'PR_DHL_WC' ) ? true : false; + } + + public static function import_settings() { + $old_settings = (array) get_option( 'woocommerce_pr_dhl_paket_settings' ); + $dhl = Package::get_dhl_shipping_provider(); + + if ( ! $dhl ) { + return false; + } + + $settings_mapping = array( + 'account_num' => 'account_number', + 'participation_V01PAK' => 'participation_V01PAK', + 'participation_V01PRIO' => 'participation_V01PRIO', + 'participation_V06PAK' => 'participation_V06PAK', + 'participation_V55PAK' => 'participation_V55PAK', + 'participation_V54EPAK' => 'participation_V54EPAK', + 'participation_V53WPAK' => 'participation_V53WPAK', + 'participation_return' => 'participation_return', + 'api_user' => 'api_username', + 'api_pwd' => 'api_password', + 'default_product_dom' => 'label_default_product_dom', + 'default_product_int' => 'label_default_product_int', + 'default_print_codeable' => 'label_address_codeable_only', + 'bank_holder' => 'bank_holder', + 'bank_name' => 'bank_name', + 'bank_iban' => 'bank_iban', + 'bank_bic' => 'bank_bic', + 'bank_ref' => 'bank_ref', + 'bank_ref_2' => 'bank_ref_2', + 'preferred_day' => 'PreferredDay_enable', + 'preferred_day_cost' => 'PreferredDay_cost', + 'preferred_day_cutoff' => 'PreferredDay_cutoff_time', + 'preferred_exclusion_mon' => 'PreferredDay_exclusion_mon', + 'preferred_exclusion_tue' => 'PreferredDay_exclusion_tue', + 'preferred_exclusion_wed' => 'PreferredDay_exclusion_wed', + 'preferred_exclusion_thu' => 'PreferredDay_exclusion_thu', + 'preferred_exclusion_fri' => 'PreferredDay_exclusion_fri', + 'preferred_exclusion_sat' => 'PreferredDay_exclusion_sat', + 'preferred_location' => 'PreferredLocation_enable', + 'preferred_neighbour' => 'PreferredNeighbour_enable', + 'payment_gateway' => 'preferred_payment_gateways_excluded', + 'display_packstation' => 'parcel_pickup_packstation_enable', + 'display_parcelshop' => 'parcel_pickup_parcelshop_enable', + 'display_post_office' => 'parcel_pickup_postoffice_enable', + 'parcel_limit' => 'parcel_pickup_map_max_results', + 'google_maps_api_key' => 'parcel_pickup_map_api_password', + ); + + // Bulk update settings + foreach( $settings_mapping as $setting_old_key => $setting_new_key ) { + if ( isset( $old_settings[ 'dhl_' . $setting_old_key ] ) && ! empty( $old_settings[ 'dhl_' . $setting_old_key ] ) ) { + $dhl->update_setting( $setting_new_key, $old_settings[ 'dhl_' . $setting_old_key ] ); + } + } + + /** + * Default address update + */ + foreach( array( 'shipper', 'return' ) as $address_type ) { + $plain_address = array( + 'company' => 'company', + 'address_city' => 'city', + 'address_zip' => 'postcode', + 'phone' => 'phone', + 'email' => 'email', + ); + + foreach( $plain_address as $prop => $new_prop ) { + $prop_name = $address_type . '_' . $prop; + + if ( ! empty( $old_settings[ 'dhl_' . $prop_name ] ) ) { + update_option( "woocommerce_gzd_shipments_{$address_type}_address_{$new_prop}", $old_settings[ 'dhl_' . $prop_name ] ); + } + } + + if ( ! empty( $old_settings["dhl_{$address_type}_address"] ) ) { + $address_1 = $old_settings["dhl_{$address_type}_address"] . ' ' . ( isset( $old_settings["dhl_{$address_type}_address_no"] ) ? $old_settings["dhl_{$address_type}_address_no"] : '' ); + + update_option( "woocommerce_gzd_shipments_{$address_type}_address_address_1", $address_1 ); + } + + if ( ! empty( $old_settings["dhl_{$address_type}_name"] ) ) { + $name = explode( " ", $old_settings["dhl_{$address_type}_name"] ); + $name_first = $name; + $first_name = implode( ' ', array_splice( $name_first, 0, ( sizeof( $name ) - 1 ) ) ); + $last_name = $name[ sizeof( $name ) - 1 ]; + + update_option( "woocommerce_gzd_shipments_{$address_type}_address_first_name", $first_name ); + update_option( "woocommerce_gzd_shipments_{$address_type}_address_last_name", $last_name ); + } + } + + // Enable maps if API key exists + if ( isset( $settings['dhl_google_maps_api_key'] ) && ! empty( $settings['dhl_google_maps_api_key'] ) ) { + $dhl->update_setting( 'parcel_pickup_map_enable', 'yes' ); + } + + // Shipper state to country ISO mapping + $countries = WC()->countries; + $shipper_country = ( isset( $old_settings['dhl_shipper_address_state'] ) && ! empty( $old_settings['dhl_shipper_address_state'] ) ) ? $old_settings['dhl_shipper_address_state'] : ''; + $return_country = ( isset( $old_settings['dhl_return_address_state'] ) && ! empty( $old_settings['dhl_return_address_state'] ) ) ? $old_settings['dhl_return_address_state'] : ''; + $isos = ( $countries ) ? $countries->get_countries() : array(); + + if ( ! empty( $shipper_country ) && ! empty( $isos ) ) { + if ( ( $key = array_search( $shipper_country, $isos ) ) !== false ) { + update_option( "woocommerce_gzd_shipments_shipper_address_country", $key ); + } + } + + if ( ! empty( $return_country ) && ! empty( $isos ) ) { + if ( ( $key = array_search( $return_country, $isos ) ) !== false ) { + update_option( "woocommerce_gzd_shipments_return_address_country", $key ); + } + } + + $dhl->save(); + + return true; + } + + public static function import_order_data( $limit = 10, $offset = 0 ) { + + $orders = wc_get_orders( array( + 'limit' => $limit, + 'offset' => $offset, + 'orderby' => 'date', + 'order' => 'DESC', + 'type' => 'shop_order' + ) ); + + if ( ! empty( $orders ) ) { + foreach( $orders as $order ) { + + if ( ! $order->get_meta( '_shipping_address_type' ) ) { + + // Update order pickup type from official DHL plugin + if ( self::order_has_pickup( $order ) ) { + + $order->update_meta_data( '_shipping_address_type', 'dhl' ); + $order->update_meta_data( '_shipping_dhl_postnumber', $order->get_meta( '_shipping_dhl_postnum' ) ); + + // Remove data to make sure we do not show data twice + $order->delete_meta_data( '_shipping_dhl_address_type' ); + $order->delete_meta_data( '_shipping_dhl_postnum' ); + + $order->save(); + } + } + } + } + } + + protected static function order_has_pickup( $order ) { + $pos_ps = stripos( $order->get_shipping_address_1(), 'Packstation' ); + $pos_fl = stripos( $order->get_shipping_address_1(), 'Postfiliale' ); + + if ( $pos_ps !== false || $pos_fl !== false ) { + return true; + } + + return false; + } +} diff --git a/packages/woocommerce-germanized-dhl/src/Admin/Importer/Internetmarke.php b/packages/woocommerce-germanized-dhl/src/Admin/Importer/Internetmarke.php new file mode 100644 index 000000000..2704059c7 --- /dev/null +++ b/packages/woocommerce-germanized-dhl/src/Admin/Importer/Internetmarke.php @@ -0,0 +1,53 @@ +get_api_username(); + } + + return ( ( ! empty( $options ) && empty( $user ) && 'yes' !== $imported && Package::base_country_is_supported() ) ? true : false ); + } + + public static function is_plugin_enabled() { + return defined( 'WCDPI_PLUGIN_FILE' ) ? true : false; + } + + public static function import_settings() { + $old_settings = array_merge( (array) get_option( '_wcdpi_settings_portokasse' ), (array) get_option( '_wcdpi_settings_internetmarke_1c4a' ) ); + + $settings_mapping = array( + '_wcdpi_portokasse_email' => 'api_username', + '_wcdpi_portokasse_password' => 'api_password', + ); + + $deutsche_post = Package::get_deutsche_post_shipping_provider(); + + if ( ! $deutsche_post ) { + return false; + } + + // Bulk update settings + foreach( $settings_mapping as $setting_old_key => $setting_new_key ) { + if ( isset( $old_settings[ $setting_old_key ] ) ) { + $deutsche_post->update_setting( $setting_new_key, $old_settings[ $setting_old_key ] ); + } + } + + $deutsche_post->save(); + return true; + } +} diff --git a/packages/woocommerce-germanized-dhl/src/Admin/Status.php b/packages/woocommerce-germanized-dhl/src/Admin/Status.php new file mode 100644 index 000000000..3146b5831 --- /dev/null +++ b/packages/woocommerce-germanized-dhl/src/Admin/Status.php @@ -0,0 +1,95 @@ + +| + + | +||
|---|---|---|
|
+ + '; + } else { + echo ' ' . esc_html_x( 'Unable to connect to the URL. Please make sure that your webhost allows outgoing connections to that specific URL.', 'dhl', 'woocommerce-germanized' ) . ''; + } + ?> + | +|
', $dimensions ), + ) ); + + return $formatted; + } + + public function get_page_formats( $force_refresh = false ) { + if ( is_null( $this->page_formats ) ) { + $this->page_formats = get_transient( 'wc_gzd_dhl_im_page_formats' ); + + if ( ! $this->page_formats || $force_refresh ) { + $this->page_formats = array(); + + try { + $this->page_formats = $this->api->retrievePageFormats(); + + set_transient( 'wc_gzd_dhl_im_page_formats', $this->page_formats, DAY_IN_SECONDS ); + } catch( \Exception $e ) { + Package::log( 'Error while refreshing Internetmarke page formats: ' . $e->getMessage() ); + } + + $page_formats = $this->page_formats; + } else { + $page_formats = $this->page_formats; + } + } else { + $page_formats = $this->page_formats; + } + + return $page_formats; + } + + public function get_page_format_list() { + $formats = $this->get_page_formats(); + $options = array(); + + foreach( $formats as $format ) { + if ( ! $format->isIsAddressPossible() ) { + continue; + } + + $options[ $format->getId() ] = $format->getName(); + } + + return $options; + } + + public function get_product_services( $im_product_id ) { + $this->load_products(); + + $product_id = $this->get_product_id( $im_product_id ); + + if ( $product_id ) { + return $this->products->get_product_services( $product_id ); + } + + return array(); + } + + public function get_product_code( $maybe_parent_product_code, $services = array() ) { + $this->load_products(); + + $product_id = $this->get_product_id( $maybe_parent_product_code ); + + if ( $product_id ) { + $new_product_data = $this->products->get_product_data_by_services( $product_id, $services ); + + if ( $new_product_data ) { + return $new_product_data->product_code; + } else { + return false; + } + } + + return $maybe_parent_product_code; + } + + public function preview_stamp( $product_id, $address_type = 'FrankingZone', $image_id = null ) { + $preview_url = false; + + try { + if ( $this->is_warenpost_international( $product_id ) ) { + if ( $this->is_warenpost_international_eu( $product_id ) ) { + $preview_url = trailingslashit( Package::get_assets_url() ) . 'img/wp-int-eu-preview.png'; + } else { + $preview_url = trailingslashit( Package::get_assets_url() ) . 'img/wp-int-preview.png'; + } + } else { + $preview_url = $this->api->retrievePreviewVoucherPng( $product_id, $address_type, $image_id ); + } + } catch( \Exception $e ) {} + + return $preview_url; + } + + /** + * @param DeutschePost $label + * + * @return mixed + */ + public function get_label( &$label ) { + if ( $label->is_warenpost_international() ) { + $result = $this->create_or_update_wp_int_label( $label ); + } else { + $result = $this->create_or_update_default_label( $label ); + } + + $this->invalidate_balance(); + + return $result; + } + + protected function get_wp_int_api() { + if ( is_null( $this->wp_int_api ) ) { + $this->wp_int_api = new ImWarenpostIntRest(); + } + + return $this->wp_int_api; + } + + /** + * @param DeutschePost $label + * + * @return mixed + */ + protected function create_or_update_wp_int_label( &$label ) { + if ( empty( $label->get_wp_int_awb() ) ) { + return $this->get_wp_int_api()->create_label( $label ); + } else { + try { + $pdf = $this->get_wp_int_api()->get_pdf( $label->get_wp_int_awb() ); + + if ( ! $pdf ) { + throw new \Exception( _x( 'Error while fetching label PDF', 'dhl', 'woocommerce-germanized' ) ); + } + } catch( \Exception $e ) { + return $this->get_wp_int_api()->create_label( $label ); + } + + return true; + } + } + + /** + * @param DeutschePost $label + * + * @return mixed + */ + protected function create_or_update_default_label( &$label ) { + if ( empty( $label->get_shop_order_id() ) ) { + return $this->create_default_label( $label ); + } else { + if ( ! $this->auth() ) { + throw new \Exception( $this->get_authentication_error() ); + } + + try { + $stamp = $this->api->retrieveOrder( $this->get_user()->getUserToken(), $label->get_shop_order_id() ); + } catch( \Exception $e ) { + return $this->create_default_label( $label ); + } + + return $this->update_default_label( $label, $stamp ); + } + } + + public function get_refund_api() { + if ( is_null( $this->refund_api ) ) { + $this->refund_api = new ImRefundSoap( $this->partner, array(), Package::get_wsdl_file( Package::get_internetmarke_refund_url() ) ); + } + + return $this->refund_api; + } + + /** + * @param DeutschePost $label + * + * @return false|int + */ + public function refund_label( $label ) { + try { + if ( $label->is_warenpost_international() ) { + return $this->refund_wp_int_label( $label ); + } else { + return $this->refund_default_label( $label ); + } + } catch( \Exception $e ) { + throw new \Exception( sprintf( _x( 'Could not refund post label: %s', 'dhl', 'woocommerce-germanized' ), $e->getMessage() ) ); + } + } + + /** + * @param DeutschePost $label + * + * @return false|int + * @throws \Exception + */ + protected function refund_default_label( $label ) { + $refund = $this->get_refund_api(); + + if ( ! $refund ) { + throw new \Exception( _x( 'Refund API could not be instantiated', 'dhl', 'woocommerce-germanized' ) ); + } + + $refund_id = $refund->createRetoureId(); + + if ( $refund_id ) { + $user = $refund->authenticateUser( Package::get_internetmarke_username(), Package::get_internetmarke_password() ); + + if ( $user ) { + $transaction_id = $refund->retoureVouchers( $user->getUserToken(), $refund_id, $label->get_shop_order_id() ); + } + + Package::log( sprintf( 'Refunded DP label %s: %s', $label->get_number(), $transaction_id ) ); + + return $transaction_id; + } + } + + /** + * @param DeutschePost $label + * + * @return false|int + * @throws \Exception + */ + protected function refund_wp_int_label( $label ) { + return false; + } + + /** + * @param DeutschePost $label + * + * @return mixed + */ + public function delete_label( &$label ) { + if ( ! empty( $label->get_shop_order_id() ) ) { + $transaction_id = $this->refund_label( $label ); + + if ( false !== $transaction_id ) { + $this->invalidate_balance(); + } + + /** + * Action fires before deleting a Deutsche Post PDF label through an API call. + * + * @param DeutschePost $label The label object. + * + * @since 3.2.0 + * @package Vendidero/Germanized/DHL + */ + do_action( 'woocommerce_gzd_dhl_deutsche_post_label_api_before_delete', $label ); + + $label->set_number( '' ); + $label->set_wp_int_awb( '' ); + $label->set_wp_int_barcode( '' ); + $label->set_shop_order_id( '' ); + + /** + * Action fires after deleting a Deutsche Post PDF label through an API call. + * + * @param DeutschePost $label The label object. + * + * @since 3.2.0 + * @package Vendidero/Germanized/DHL + */ + do_action( 'woocommerce_gzd_dhl_deutsche_post_label_api_deleted', $label ); + + return $label; + } + + return false; + } + + protected function get_shipment_address_prop( $shipment, $prop, $address_type = '' ) { + $getter = "get_{$prop}"; + + if ( ! empty( $address_type ) ) { + $getter = "get_{$address_type}_{$prop}"; + } + + if ( is_callable( array( $shipment, $getter ) ) ) { + return $shipment->$getter(); + } else { + return ''; + } + } + + protected function get_shipment_address_data( $shipment, $address_type = '' ) { + $person_name = new PersonName( '', '', $this->get_shipment_address_prop( $shipment, 'first_name', $address_type ), $this->get_shipment_address_prop( $shipment, 'last_name', $address_type ) ); + + if ( $this->get_shipment_address_prop( $shipment, 'company', $address_type ) ) { + $name = new Name( null, new CompanyName( $this->get_shipment_address_prop( $shipment, 'company', $address_type ), $receiver_person_name ) ); + } else { + $name = new Name( $person_name, null ); + } + + $additional = $this->get_shipment_address_prop( $shipment, 'address_2', $address_type ); + + if ( 'simple' === $shipment->get_type() && $shipment->send_to_external_pickup( 'packstation' ) ) { + $additional = ParcelLocator::get_postnumber_by_shipment( $shipment ); + } + + $address = new Address( + $additional, + $this->get_shipment_address_prop( $shipment, 'address_street', $address_type ), + $this->get_shipment_address_prop( $shipment, 'address_street_number', $address_type ), + $this->get_shipment_address_prop( $shipment, 'postcode', $address_type ), + $this->get_shipment_address_prop( $shipment, 'city', $address_type ), + Package::get_country_iso_alpha3( $this->get_shipment_address_prop( $shipment, 'country', $address_type ) ) + ); + + $named_address = new \baltpeter\Internetmarke\NamedAddress( $name, $address ); + + return $named_address; + } + + protected function get_setting_address_data() { + $person_name = new PersonName( '', '', Package::get_setting( 'shipper_first_name' ), Package::get_setting( 'shipper_last_name' ) ); + $sender_country = Package::get_country_iso_alpha3( Package::get_setting( 'shipper_country' ) ); + + if ( Package::get_setting( 'shipper_company' ) ) { + $name = new Name( null, new CompanyName( Package::get_setting( 'shipper_company' ), $person_name ) ); + } else { + $name = new Name( $person_name, null ); + } + + $address = new Address( '', Package::get_setting( 'shipper_street' ), Package::get_setting( 'shipper_street_number' ), Package::get_setting( 'shipper_postcode' ), Package::get_setting( 'shipper_city' ), $sender_country ); + $sender = new \baltpeter\Internetmarke\NamedAddress( $name, $address ); + + return $sender; + } + + /** + * @param DeutschePost|DeutschePostReturn $label + */ + protected function create_default_label( &$label ) { + $shipment = $label->get_shipment(); + + if ( ! $shipment ) { + throw new \Exception( sprintf( _x( 'Could not fetch shipment %d.', 'dhl', 'woocommerce-germanized' ), $label->get_shipment_id() ) ); + } + + if ( 'return' === $label->get_type() ) { + $sender = $this->get_shipment_address_data( $shipment, 'sender' ); + $receiver = $this->get_setting_address_data(); + + $address_binding = new \baltpeter\Internetmarke\AddressBinding( $sender, $receiver ); + } else { + $sender = $this->get_setting_address_data(); + $receiver = $this->get_shipment_address_data( $shipment ); + + $address_binding = new \baltpeter\Internetmarke\AddressBinding( $sender, $receiver ); + } + + if ( ! $this->auth() ) { + throw new \Exception( $this->get_authentication_error() ); + } + + try { + $shop_order_id = $this->api->createShopOrderId( $this->get_user()->getUserToken() ); + + if ( ! $shop_order_id ) { + throw new \Exception( _x( 'Error while generating shop order id.', 'dhl', 'woocommerce-germanized' ) ); + } + + $label->set_shop_order_id( $shop_order_id ); + + $position = new \baltpeter\Internetmarke\Position( + /** + * Adjust the Deutsche Post (Internetmarke) label print X position. + * + * @param mixed $x The x axis position. + * @param DeutschePost $label The label instance. + * @param Shipment $shipment The shipment instance. + * + * @since 3.4.5 + * @package Vendidero/Germanized/DHL + */ + apply_filters( 'woocommerce_gzd_deutsche_post_label_api_position_x', Package::get_setting( 'deutsche_post_label_position_x' ), $label, $shipment ), + /** + * Adjust the Deutsche Post (Internetmarke) label print Y position. + * + * @param mixed $y The y axis position. + * @param DeutschePost $label The label instance. + * @param Shipment $shipment The shipment instance. + * + * @since 3.4.5 + * @package Vendidero/Germanized/DHL + */ + apply_filters( 'woocommerce_gzd_deutsche_post_label_api_position_y', Package::get_setting( 'deutsche_post_label_position_y' ), $label, $shipment ), + apply_filters( 'woocommerce_gzd_deutsche_post_label_api_page_number', 1, $label, $shipment ) + ); + + $order_item = new \baltpeter\Internetmarke\OrderItem( $label->get_product_id(), null, $address_binding, $position, 'AddressZone' ); + $stamp = $this->api->checkoutShoppingCartPdf( $this->get_user()->getUserToken(), $label->get_page_format(), array( $order_item ), $label->get_stamp_total(), $shop_order_id, null, true, 2 ); + + return $this->update_default_label( $label, $stamp ); + } catch( \Exception $e ) { + throw new \Exception( sprintf( _x( 'Error while trying to purchase the stamp. Please manually refresh your product database and try again.', 'dhl', 'woocommerce-germanized' ), Package::get_deutsche_post_shipping_provider()->get_edit_link( 'label' ) ) ); + } + } + + /** + * @param DeutschePost $label + * @param \stdClass $stamp + * + * @return mixed + * @throws \Exception + */ + protected function update_default_label( &$label, $stamp ) { + if ( isset( $stamp->link ) ) { + + $label->set_original_url( $stamp->link ); + $voucher_list = $stamp->shoppingCart->voucherList; + + if ( ! empty( $voucher_list->voucher ) ) { + foreach ( $voucher_list->voucher as $i => $voucher ) { + + if ( isset( $voucher->trackId ) ) { + $label->set_number( $voucher->trackId ); + } else { + $label->set_number( $voucher->voucherId ); + } + + $label->set_voucher_id( $voucher->voucherId ); + } + } + + if ( isset( $stamp->manifestLink ) ) { + $label->set_manifest_url( $stamp->manifestLink ); + } + + $label->save(); + $result = $label->download_label_file( $stamp->link ); + + if ( ! $result ) { + throw new \Exception( _x( 'Error while downloading the PDF stamp.', 'dhl', 'woocommerce-germanized' ) ); + } + + $label->save(); + + return $label; + } else { + throw new \Exception( _x( 'Invalid stamp response.', 'dhl', 'woocommerce-germanized' ) ); + } + } + + public function update_products() { + $this->load_products(); + + return $this->products->update(); + } +} diff --git a/packages/woocommerce-germanized-dhl/src/Api/LabelSoap.php b/packages/woocommerce-germanized-dhl/src/Api/LabelSoap.php new file mode 100644 index 000000000..ebeab3ea1 --- /dev/null +++ b/packages/woocommerce-germanized-dhl/src/Api/LabelSoap.php @@ -0,0 +1,675 @@ +get_auth_api()->get_access_token( Package::get_gk_api_user(), Package::get_gk_api_signature() ); + } + + public function test_connection() { + + } + + /** + * @param Label\DHL $label + * + * @return mixed + * @throws Exception + */ + public function get_label( &$label ) { + if ( empty( $label->get_number() ) ) { + return $this->create_label( $label ); + } else { + $soap_request = array( + 'Version' => array( + 'majorRelease' => '3', + 'minorRelease' => '1' + ), + 'shipmentNumber' => $label->get_number(), + 'labelResponseType' => 'B64', + ); + + try { + $soap_client = $this->get_access_token(); + Package::log( '"getLabel" called with: ' . print_r( $soap_request, true ) ); + + $response_body = $soap_client->getLabel( $soap_request ); + Package::log( 'Response: Successful' ); + + } catch ( Exception $e ) { + Package::log( 'Response Error: ' . $e->getMessage() ); + throw $e; + } + + // Label not found + if ( 2000 === $response_body->Status->statusCode ) { + return $this->create_label( $label ); + } else { + return $this->update_label( $label, $response_body->Status, $response_body ); + } + } + } + + /** + * @param Label\DHL $label + * + * @return mixed + * + * @throws Exception + */ + public function create_label( &$label ) { + try { + $soap_request = $this->get_create_label_request( $label ); + $soap_client = $this->get_access_token(); + Package::log( '"createShipmentOrder" called with: ' . print_r( $soap_request, true ) ); + + $response_body = $soap_client->createShipmentOrder( $soap_request ); + Package::log( 'Response: Successful' ); + + } catch ( Exception $e ) { + Package::log( 'Response Error: ' . $e->getMessage() ); + + switch( $e->getMessage() ) { + case "Unauthorized": + throw new Exception( _x( 'Your DHL API credentials seem to be invalid. Please check your DHL settings.', 'dhl', 'woocommerce-germanized' ) ); + break; + case "SOAP-ERROR: Encoding: object has no 'customsTariffNumber' property": + case "SOAP-ERROR: Encoding: object has no 'countryCodeOrigin' property": + throw new Exception( _x( 'Your products are missing data relevant for custom declarations. Please provide missing DHL fields (country of origin, HS code) in your product data > shipping tab.', 'dhl', 'woocommerce-germanized' ) ); + break; + } + + throw $e; + } + + if ( ! isset( $response_body->Status ) || ! isset( $response_body->CreationState ) ) { + + if ( isset( $response_body->Status ) && ! empty( $response_body->Status->statusText ) ) { + throw new Exception( sprintf( _x( 'There was an error contacting the DHL API: %s.', 'dhl', 'woocommerce-germanized' ), $response_body->Status->statusText ) ); + } + + throw new Exception( _x( 'An error ocurred while contacting the DHL API. Please consider enabling the sandbox mode.', 'dhl', 'woocommerce-germanized' ) ); + } + + return $this->update_label( $label, $response_body->Status, $response_body->CreationState ); + } + + /** + * @param Label\DHL $label + * @param $status + * @param $response_body + * + * @return mixed + * @throws Exception + */ + protected function update_label( &$label, $status, $response_body ) { + if ( 0 !== $status->statusCode ) { + if ( isset( $response_body->LabelData->Status ) && isset( $response_body->LabelData->Status->statusMessage ) ) { + $messages = (array) $response_body->LabelData->Status->statusMessage; + $messages = implode( "\n", array_unique( $messages ) ); + + throw new Exception( $messages ); + } else { + throw new Exception( _x( 'There was an error generating the label. Please try again or consider switching to sandbox mode.', 'dhl', 'woocommerce-germanized' ) ); + } + } else { + $return_label = false; + + try { + + if ( isset( $response_body->shipmentNumber ) ) { + $label->set_number( $response_body->shipmentNumber ); + } + + // Make sure the label does exist from this point on so that the parent id is available for returns. + $label->save(); + + // Create separate return label + if ( isset( $response_body->returnShipmentNumber ) ) { + $return_label = $label->get_inlay_return_label(); + + if ( ! $return_label ) { + if ( $return_label = Factory::get_label( 0, $label->get_shipping_provider(), 'inlay_return' ) ) { + $return_label->set_parent_id( $label->get_id() ); + $return_label->set_shipment_id( $label->get_shipment_id() ); + $return_label->set_shipping_provider( $label->get_shipping_provider() ); + + if ( $shipment = $label->get_shipment() ) { + $return_label->set_sender_address( $shipment->get_address() ); + } + } + } + + if ( $return_label ) { + $return_label->set_number( $response_body->returnShipmentNumber ); + } + } + + $default_file = base64_decode( $response_body->LabelData->labelData ); + $return_file = false; + + // Try to split the PDF to extract return label + if ( $return_label ) { + $splitter = $splitter = new PDFSplitter( $default_file, true ); + $pdfs = $splitter->split(); + + if ( $pdfs && ! empty( $pdfs ) && sizeof( $pdfs ) > 1 ) { + $return_file = $pdfs[1]; + } + + if ( $return_file ) { + $return_label->upload_label_file( $return_file ); + } + + $return_label->save(); + } + + // Store the downloaded label as default file + $path = $label->upload_label_file( $default_file, 'default' ); + + // Merge export label into label path so that by default the shop owner downloads the merged file + if ( isset( $response_body->LabelData->exportLabelData ) ) { + + // Save export file + $label->upload_label_file( base64_decode( $response_body->LabelData->exportLabelData ), 'export' ); + + // Merge files + $merger = new PDFMerger(); + $merger->add( $label->get_default_file() ); + $merger->add( $label->get_export_file() ); + + $filename_label = $label->get_filename(); + $file = $merger->output( $filename_label, 'S' ); + + $label->upload_label_file( $file ); + } else { + $label->set_path( $path ); + } + + } catch( Exception $e ) { + // Delete the label dues to errors. + $label->delete(); + + throw new Exception( _x( 'Error while creating and uploading the label', 'dhl', 'woocommerce-germanized' ) ); + } + + return $label; + } + } + + /** + * @param Label\DHL $label + * + * @throws Exception + */ + protected function delete_label_call( &$label ) { + $soap_request = array( + 'Version' => array( + 'majorRelease' => '3', + 'minorRelease' => '1' + ), + 'shipmentNumber' => $label->get_number() + ); + + try { + Package::log( '"deleteShipmentOrder" called with: ' . print_r( $soap_request, true ) ); + + $soap_client = $this->get_access_token(); + $response_body = $soap_client->deleteShipmentOrder( $soap_request ); + + Package::log( 'Response Body: ' . print_r( $response_body, true ) ); + + } catch ( Exception $e ) { + throw $e; + } + + /** + * Action fires after deleting a DHL PDF label through an API call. + * + * @param Label\DHL $label The label object. + * + * @since 3.0.0 + * @package Vendidero/Germanized/DHL + */ + do_action( 'woocommerce_gzd_dhl_label_api_deleted', $label ); + + if ( 0 !== $response_body->Status->statusCode ) { + throw new Exception( sprintf( _x( 'Could not delete label - %s', 'dhl', 'woocommerce-germanized' ), $response_body->Status->statusMessage ) ); + } + + return $label; + } + + /** + * @param Label\DHL $label + * + * @throws Exception + */ + public function delete_label( &$label ) { + try { + if ( ! empty( $label->get_number() ) ) { + return $this->delete_label_call( $label ); + } + } catch ( Exception $e ) { + throw $e; + } + + return false; + } + + protected function get_account_number( $dhl_product ) { + $product_number = preg_match('!\d+!', $dhl_product, $matches ); + + if ( $product_number ) { + $account_number = Package::get_setting( 'account_number' ) . $matches[0] . Package::get_participation_number( $dhl_product ); + + return $account_number; + } else { + throw new Exception( _x( 'Could not create account number - no product number.', 'dhl', 'woocommerce-germanized' ) ); + } + } + + protected function get_return_account_number() { + $product_number = self::DHL_RETURN_PRODUCT; + $account_number = Package::get_setting( 'account_number' ) . $product_number . Package::get_participation_number( 'return' ); + + return $account_number; + } + + /** + * @param Label\DHL $label + * @return array + * + * @throws Exception + */ + protected function get_create_label_request( $label ) { + $shipment = $label->get_shipment(); + + if ( ! $shipment ) { + throw new Exception( sprintf( _x( 'Could not fetch shipment %d.', 'dhl', 'woocommerce-germanized' ), $label->get_shipment_id() ) ); + } + + $services = array(); + $bank_data = array(); + + foreach( $label->get_services() as $service ) { + + $services[ $service ] = array( + 'active' => 1 + ); + + switch ( $service ) { + case 'AdditionalInsurance': + $services[ $service ]['insuranceAmount'] = $shipment->get_total(); + break; + case 'IdentCheck': + $services[ $service ]['Ident']['surname'] = $shipment->get_last_name(); + $services[ $service ]['Ident']['givenName'] = $shipment->get_first_name(); + $services[ $service ]['Ident']['dateOfBirth'] = $label->get_ident_date_of_birth() ? $label->get_ident_date_of_birth()->date( 'Y-m-d' ) : ''; + $services[ $service ]['Ident']['minimumAge'] = $label->get_ident_min_age(); + break; + case 'CashOnDelivery': + $services[ $service ]['codAmount'] = $label->get_cod_total(); + + $bank_data_map = array( + 'bank_holder' => 'accountOwner', + 'bank_name' => 'bankName', + 'bank_iban' => 'iban', + 'bank_ref' => 'note1', + 'bank_ref_2' => 'note2', + 'bank_bic' => 'bic' + ); + + $ref_replacements = wc_gzd_dhl_get_label_payment_ref_placeholder( $shipment ); + + foreach ( $bank_data_map as $key => $value ) { + if ( $setting_value = Package::get_setting( $key ) ) { + $bank_data[ $value ] = $setting_value; + + if ( in_array( $key, array( 'bank_ref', 'bank_ref_2' ) ) ) { + $bank_data[ $value ] = str_replace( array_keys( $ref_replacements ), array_values( $ref_replacements ), $bank_data[ $value ] ); + } + } + } + break; + case 'PreferredDay': + $services[ $service ]['details'] = $label->get_preferred_day() ? $label->get_preferred_day()->date( 'Y-m-d' ) : ''; + break; + case 'VisualCheckOfAge': + $services[ $service ]['type'] = $label->get_visual_min_age(); + break; + case 'PreferredLocation': + $services[ $service ]['details'] = $label->get_preferred_location(); + break; + case 'PreferredNeighbour': + $services[ $service ]['details'] = $label->get_preferred_neighbor(); + break; + case 'ParcelOutletRouting': + if ( ! empty( $shipment->get_email() ) ) { + $services[ $service ]['details'] = $shipment->get_email(); + } + break; + } + } + + $dhl_label_body = array( + 'Version' => array( + 'majorRelease' => '3', + 'minorRelease' => '1' + ), + 'labelResponseType' => 'B64', + 'ShipmentOrder' => array ( + 'sequenceNumber' => $label->get_shipment_id(), + 'Shipment' => array( + 'ShipmentDetails' => array( + 'product' => $label->get_product_id(), + 'accountNumber' => self::get_account_number( $label->get_product_id() ), + 'customerReference' => wc_gzd_dhl_get_label_customer_reference( $label, $shipment ), + 'shipmentDate' => Package::get_date_de_timezone( 'Y-m-d' ), + 'ShipmentItem' => array( + 'weightInKG' => $label->get_weight(), + 'lengthInCM' => $label->has_dimensions() ? $label->get_length() : '', + 'widthInCM' => $label->has_dimensions() ? $label->get_width() : '', + 'heightInCM' => $label->has_dimensions() ? $label->get_height() : '', + ), + 'Service' => $services, + 'Notification' => ( apply_filters( 'woocommerce_gzd_dhl_label_api_enable_notification', $label->has_email_notification(), $label ) && ! empty( $shipment->get_email() ) ) ? array( 'recipientEmailAddress' => $shipment->get_email() ) : array(), + 'BankData' => $bank_data, + ), + 'Receiver' => array( + 'name1' => $shipment->get_company() ? $shipment->get_company() : $shipment->get_formatted_full_name(), + 'Address' => array( + 'name2' => $shipment->get_company() ? $shipment->get_formatted_full_name() : '', + /** + * By default the name3 parameter is used to transmit the additional + * address field to the DHL API. You may adjust the field value by using this filter. + * + * @param string $value The field value. + * @param Label\DHL $label The label instance. + * + * @since 3.0.3 + * @package Vendidero/Germanized/DHL + */ + 'name3' => apply_filters( 'woocommerce_gzd_dhl_label_api_receiver_name3', wc_gzd_dhl_get_label_shipment_address_addition( $shipment ), $label ), + 'streetName' => $shipment->get_address_street(), + 'streetNumber' => wc_gzd_dhl_get_label_shipment_street_number( $shipment ), + 'zip' => $shipment->get_postcode(), + 'city' => $shipment->get_city(), + 'Origin' => array( + 'countryISOCode' => $shipment->get_country(), + 'state' => wc_gzd_dhl_format_label_state( $shipment->get_state(), $shipment->get_country() ) + ) + ), + 'Communication' => array( + /** + * Choose whether to transmit the full name of the shipment receiver as contactPerson + * while creating a label. + * + * @param string $name The name of the shipmen receiver. + * @param Label\DHL $label The label instance. + * + * @since 3.0.5 + * @package Vendidero/Germanized/DHL + */ + 'contactPerson' => apply_filters( 'woocommerce_gzd_dhl_label_api_communication_contact_person', $shipment->get_formatted_full_name(), $label ), + /** + * Choose whether to transfer the phone number to DHL on creating a label. + * By default the phone number is not transmitted. + * + * @param string $phone The phone number. + * @param Label\DHL $label The label instance. + * + * @since 3.0.3 + * @package Vendidero/Germanized/DHL + */ + 'phone' => apply_filters( 'woocommerce_gzd_dhl_label_api_communication_phone', '', $label ), + /** + * Choose whether to transfer the email to DHL on creating a label. + * By default the email is only transmitted if the customer opted in. + * + * This email address is not used to notify the customer via DHL. It is only + * meant for communicaton purposes. + * + * @param string $email The email. + * @param Label\DHL $label The label instance. + * + * @since 3.0.3 + * @package Vendidero/Germanized/DHL + */ + 'email' => apply_filters( 'woocommerce_gzd_dhl_label_api_communication_email', $label->has_email_notification() ? $shipment->get_email() : '', $label ), + ) + ) + ) + ) + ); + + /** + * This filter allows using a ShipperReference configured in the GKP instead of transmitting + * the shipper data from the DHL settings. Use this filter carefully and make sure that the + * reference exists. + * + * @param string $shipper_reference The shipper reference from the GKP. + * @param Label\DHL $label The label instance. + * + * @since 3.0.5 + * @package Vendidero/Germanized/DHL + */ + $shipper_reference = apply_filters( 'woocommerce_gzd_dhl_label_api_shipper_reference', '', $label ); + + if ( ! empty( $shipper_reference ) ) { + $dhl_label_body['ShipmentOrder']['Shipment']['ShipperReference'] = $shipper_reference; + } else { + $name1 = apply_filters( 'woocommerce_gzd_dhl_label_api_shipper_name1', Package::get_setting( 'shipper_company' ) ? Package::get_setting( 'shipper_company' ) : Package::get_setting( 'shipper_name' ), $label ); + $name2 = apply_filters( 'woocommerce_gzd_dhl_label_api_shipper_name2', Package::get_setting( 'shipper_company' ) ? Package::get_setting( 'shipper_name' ) : '', $label ); + + $dhl_label_body['ShipmentOrder']['Shipment']['Shipper'] = array( + 'Name' => array( + 'name1' => $name1, + 'name2' => $name2, + ), + 'Address' => array( + 'streetName' => apply_filters( 'woocommerce_gzd_dhl_label_api_shipper_street_name', Package::get_setting( 'shipper_street' ), $label ), + 'streetNumber' => apply_filters( 'woocommerce_gzd_dhl_label_api_shipper_street_number', Package::get_setting( 'shipper_street_number' ), $label ), + 'zip' => apply_filters( 'woocommerce_gzd_dhl_label_api_shipper_zip', Package::get_setting( 'shipper_postcode' ), $label ), + 'city' => apply_filters( 'woocommerce_gzd_dhl_label_api_shipper_city', Package::get_setting( 'shipper_city' ), $label ), + 'Origin' => array( + 'countryISOCode' => apply_filters( 'woocommerce_gzd_dhl_label_api_shipper_country', Package::get_setting( 'shipper_country' ), $label ), + 'state' => apply_filters( 'woocommerce_gzd_dhl_label_api_shipper_state', wc_gzd_dhl_format_label_state( Package::get_setting( 'shipper_state' ), Package::get_setting( 'shipper_country' ) ), $label ), + ) + ), + 'Communication' => array( + 'phone' => apply_filters( 'woocommerce_gzd_dhl_label_api_shipper_phone', Package::get_setting( 'contact_phone' ), $label ), + 'email' => apply_filters( 'woocommerce_gzd_dhl_label_api_shipper_email', Package::get_setting( 'contact_email' ), $label ), + 'contactPerson' => apply_filters( 'woocommerce_gzd_dhl_label_api_shipper_contact_person', Package::get_setting( 'shipper_name' ), $label ), + ) + ); + } + + $label_custom_format = wc_gzd_dhl_get_custom_label_format( $label ); + $label_custom_return_format = wc_gzd_dhl_get_custom_label_format( $label, 'inlay_return' ); + + if ( ! empty( $label_custom_format ) ) { + $dhl_label_body['labelFormat'] = $label_custom_format; + } + + if ( ! empty( $label_custom_return_format ) ) { + $dhl_label_body['labelFormatRetoure'] = $label_custom_return_format; + } + + if ( $shipment->send_to_external_pickup( array_keys( wc_gzd_dhl_get_pickup_types() ) ) ) { + // Address is NOT needed if using a parcel shop + unset( $dhl_label_body['ShipmentOrder']['Shipment']['Receiver']['Address'] ); + + $parcel_shop = array( + 'zip' => $shipment->get_postcode(), + 'city' => $shipment->get_city(), + 'Origin' => array( + 'countryISOCode' => $shipment->get_country(), + 'state' => wc_gzd_dhl_format_label_state( $shipment->get_state(), $shipment->get_country() ) + ) + ); + + $address_number = filter_var( $shipment->get_address_1(), FILTER_SANITIZE_NUMBER_INT ); + + if ( $shipment->send_to_external_pickup( 'packstation' ) ) { + $parcel_shop['postNumber'] = ParcelLocator::get_postnumber_by_shipment( $shipment ); + $parcel_shop['packstationNumber'] = $address_number; + + $dhl_label_body['ShipmentOrder']['Shipment']['Receiver']['Packstation'] = $parcel_shop; + } + + if ( $shipment->send_to_external_pickup( 'postoffice' ) || $shipment->send_to_external_pickup( 'parcelshop' ) ) { + if ( $post_number = ParcelLocator::get_postnumber_by_shipment( $shipment ) ) { + $parcel_shop['postNumber'] = $post_number; + unset( $dhl_label_body['ShipmentOrder']['Shipment']['Receiver']['Communication']['email'] ); + } + + $parcel_shop['postfilialNumber'] = $address_number; + $dhl_label_body['ShipmentOrder']['Shipment']['Receiver']['Postfiliale'] = $parcel_shop; + } + } + + if ( $label->has_inlay_return() ) { + $dhl_label_body['ShipmentOrder']['Shipment']['ShipmentDetails']['returnShipmentAccountNumber'] = self::get_return_account_number(); + $dhl_label_body['ShipmentOrder']['Shipment']['ShipmentDetails']['returnShipmentReference'] = wc_gzd_dhl_get_inlay_return_label_reference( $label, $shipment ); + + $dhl_label_body['ShipmentOrder']['Shipment']['ReturnReceiver'] = array( + 'Name' => array( + 'name1' => $label->get_return_company() ? $label->get_return_company() : $label->get_return_formatted_full_name(), + 'name2' => $label->get_return_company() ? $label->get_return_formatted_full_name() : '' + ), + 'Address' => array( + 'streetName' => $label->get_return_street(), + 'streetNumber' => $label->get_return_street_number(), + 'zip' => $label->get_return_postcode(), + 'city' => $label->get_return_city(), + 'Origin' => array( + 'countryISOCode' => $label->get_return_country(), + 'state' => wc_gzd_dhl_format_label_state( $label->get_return_state(), $label->get_return_country() ), + ) + ), + 'Communication' => array( + 'contactPerson' => $label->get_return_formatted_full_name(), + 'phone' => $label->get_return_phone(), + 'email' => $label->get_return_email() + ) + ); + } + + if ( $label->codeable_address_only() ) { + $dhl_label_body['ShipmentOrder']['PrintOnlyIfCodeable'] = array( 'active' => 1 ); + } + + if ( Package::is_crossborder_shipment( $shipment->get_country() ) ) { + + if ( sizeof( $shipment->get_items() ) > self::DHL_MAX_ITEMS ) { + throw new Exception( sprintf( _x( 'Only %s shipment items can be processed, your shipment has %s items.', 'dhl', 'woocommerce-germanized' ), self::DHL_MAX_ITEMS, sizeof( $shipment->get_items() ) ) ); + } + + $customs_label_data = wc_gzd_dhl_get_shipment_customs_data( $label ); + $customs_items = array(); + + foreach( $customs_label_data['items'] as $item_id => $item_data ) { + $customs_items[] = array( + 'description' => $item_data['description'], + 'countryCodeOrigin' => $item_data['origin_code'], + 'customsTariffNumber' => $item_data['tariff_number'], + 'amount' => $item_data['quantity'], + /** + * netWeightInKG is defined as the weight per item (e.g. 2 items in case the quantity equals 2). + */ + 'netWeightInKG' => $item_data['single_weight_in_kg'], + /** + * Single product value per item + */ + 'customsValue' => $item_data['single_value'] + ); + } + + $customs_data = array( + 'termsOfTrade' => $label->get_duties(), + 'additionalFee' => $customs_label_data['additional_fee'], + 'exportTypeDescription' => $customs_label_data['export_type_description'], + 'placeOfCommital' => $customs_label_data['place_of_commital'], + 'ExportDocPosition' => $customs_items, + /** + * Filter to allow adjusting the export type of a DHL label (for customs). Could be: + *
-
+ *
- OTHER + *
- PRESENT + *
- COMMERCIAL_SAMPLE + *
- DOCUMENT + *
- RETURN_OF_GOODS + *
- COMMERCIAL_GOODS + *
+
+ format( $format );
+
+ return $date_formatted;
+ } catch( Exception $e ) {
+ return date( $format );
+ }
+ }
+
+ public static function get_holidays( $country = 'DE' ) {
+ if ( empty( self::$holidays ) ) {
+ self::$holidays = include self::get_path() . '/i18n/holidays.php';
+ }
+
+ $holidays = self::$holidays;
+
+ if ( ! empty( $country ) ) {
+ $holidays = array_key_exists( $country, self::$holidays ) ? self::$holidays[ $country ] : array();
+ }
+
+ /**
+ * Filter to adjust dates regarded as holidays for a certain country.
+ *
+ * @param array $holidays Array containing dates in Y-m-d format.
+ * @param string $country The country as ISO code.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/DHL
+ */
+ return apply_filters( 'woocommerce_gzd_dhl_holidays', $holidays, $country );
+ }
+
+ /**
+ * Register custom tables within $wpdb object.
+ */
+ private static function define_tables() {
+ global $wpdb;
+
+ // List of tables without prefixes.
+ $tables = array(
+ 'gzd_dhl_labelmeta' => 'woocommerce_gzd_dhl_labelmeta',
+ 'gzd_dhl_labels' => 'woocommerce_gzd_dhl_labels',
+ 'gzd_dhl_im_products' => 'woocommerce_gzd_dhl_im_products',
+ 'gzd_dhl_im_product_services' => 'woocommerce_gzd_dhl_im_product_services',
+ );
+
+ foreach ( $tables as $name => $table ) {
+ $wpdb->$name = $wpdb->prefix . $table;
+ $wpdb->tables[] = $table;
+ }
+ }
+
+ public static function maybe_set_upload_dir() {
+ // Create a dir suffix
+ if ( ! get_option( 'woocommerce_gzd_dhl_upload_dir_suffix', false ) ) {
+ self::$upload_dir_suffix = substr( self::generate_key(), 0, 10 );
+ update_option( 'woocommerce_gzd_dhl_upload_dir_suffix', self::$upload_dir_suffix );
+ } else {
+ self::$upload_dir_suffix = get_option( 'woocommerce_gzd_dhl_upload_dir_suffix' );
+ }
+ }
+
+ public static function is_enabled() {
+ return ( self::is_dhl_enabled() || self::is_deutsche_post_enabled() );
+ }
+
+ public static function is_dhl_enabled() {
+ $is_enabled = false;
+
+ if ( $provider = self::get_dhl_shipping_provider() ) {
+ $is_enabled = $provider->is_activated();
+ }
+
+ return $is_enabled;
+ }
+
+ public static function get_country_iso_alpha3( $country_code ) {
+ if ( empty( self::$iso ) ) {
+ self::$iso = include self::get_path() . '/i18n/iso.php';
+ }
+
+ $iso = self::$iso;
+
+ if ( isset( $iso[ $country_code ] ) ) {
+ return $iso[ $country_code ];
+ }
+
+ return $country_code;
+ }
+
+ private static function includes() {
+ include_once self::get_path() . '/includes/wc-gzd-dhl-core-functions.php';
+ include_once self::get_path() . '/includes/wc-gzd-dhl-legacy-functions.php';
+
+ if ( self::is_enabled() ) {
+ if ( is_admin() ) {
+ Admin\Admin::init();
+ }
+
+ if ( ParcelLocator::is_enabled() ) {
+ ParcelLocator::init();
+ }
+
+ /**
+ * Additional services are only available for DHL products
+ */
+ if ( self::is_dhl_enabled() && ParcelServices::is_enabled() ) {
+ ParcelServices::init();
+ }
+
+ Ajax::init();
+ }
+ }
+
+ public static function init_hooks() {
+ // Filter templates
+ add_filter( 'woocommerce_gzd_default_plugin_template', array( __CLASS__, 'filter_templates' ), 10, 3 );
+
+ // Register additional label types
+ add_filter( 'woocommerce_gzd_shipment_label_types', array( __CLASS__, 'register_label_types' ), 10 );
+
+ // Sync shipment items
+ add_action( 'woocommerce_gzd_shipment_item_synced', array( __CLASS__, 'sync_item_meta' ), 10, 3 );
+ }
+
+ /**
+ * @param ShipmentItem $item
+ * @param \WC_Order_Item $order_item
+ * @param $args
+ */
+ public static function sync_item_meta( $item, $order_item, $args ) {
+ if ( $product = $item->get_product() ) {
+ $dhl_product = wc_gzd_dhl_get_product( $product );
+
+ $item->update_meta_data( '_dhl_hs_code', $dhl_product->get_hs_code() );
+ $item->update_meta_data( '_dhl_manufacture_country', $dhl_product->get_manufacture_country() );
+ }
+ }
+
+ public static function register_label_types( $types ) {
+ $types[] = 'inlay_return';
+
+ return $types;
+ }
+
+ public static function filter_templates( $path, $template_name ) {
+ if ( file_exists( self::get_path() . '/templates/' . $template_name ) ) {
+ $path = self::get_path() . '/templates/' . $template_name;
+ }
+
+ return $path;
+ }
+
+ public static function get_default_bank_account_data( $data_key = '' ) {
+ $bacs = get_option( 'woocommerce_bacs_accounts' );
+
+ if ( ! empty( $bacs ) && is_array( $bacs ) ) {
+ $data = $bacs[0];
+
+ if ( isset( $data[ 'account_' . $data_key ] ) ) {
+ return $data[ 'account_' . $data_key ];
+ } elseif ( isset( $data[ $data_key ] ) ) {
+ return $data[ $data_key ];
+ }
+ }
+
+ return '';
+ }
+
+ /**
+ * @return false|DHL
+ */
+ public static function get_dhl_shipping_provider() {
+ $provider = wc_gzd_get_shipping_provider( 'dhl' );
+
+ if ( ! is_a( $provider, '\Vendidero\Germanized\DHL\ShippingProvider\DHL' ) ) {
+ return false;
+ }
+
+ return $provider;
+ }
+
+ /**
+ * @return false|DeutschePost
+ */
+ public static function get_deutsche_post_shipping_provider() {
+ $provider = wc_gzd_get_shipping_provider( 'deutsche_post' );
+
+ if ( ! is_a( $provider, '\Vendidero\Germanized\DHL\ShippingProvider\DeutschePost' ) ) {
+ return false;
+ }
+
+ return $provider;
+ }
+
+ public static function eur_to_cents( $price ) {
+ return round( $price * 100 );
+ }
+
+ public static function cents_to_eur( $price ) {
+ return $price > 0 ? $price / 100 : 0;
+ }
+
+ public static function add_shipping_provider_class_name( $class_names ) {
+ $class_names['dhl'] = '\Vendidero\Germanized\DHL\ShippingProvider\DHL';
+ $class_names['deutsche_post'] = '\Vendidero\Germanized\DHL\ShippingProvider\DeutschePost';
+
+ return $class_names;
+ }
+
+ public static function install() {
+ self::on_shipments_init();
+ Install::install();
+ }
+
+ public static function install_integration() {
+ self::install();
+ }
+
+ public static function is_integration() {
+ return class_exists( 'WooCommerce_Germanized' ) ? true : false;
+ }
+
+ public static function register_data_stores( $stores ) {
+ $stores['dhl-legacy-label'] = 'Vendidero\Germanized\DHL\Legacy\DataStores\Label';
+
+ return $stores;
+ }
+
+ public static function get_api() {
+ if ( is_null( self::$api ) ) {
+ self::$api = new Paket( self::get_base_country() );
+ }
+
+ return self::$api;
+ }
+
+ public static function get_internetmarke_api() {
+ if ( is_null( self::$im_api ) && self::is_deutsche_post_enabled() ) {
+ self::$im_api = new Internetmarke();
+ }
+
+ return self::$im_api;
+ }
+
+ /**
+ * Return the version of the package.
+ *
+ * @return string
+ */
+ public static function get_version() {
+ return self::VERSION;
+ }
+
+ /**
+ * Return the path to the package.
+ *
+ * @return string
+ */
+ public static function get_path() {
+ return dirname( __DIR__ );
+ }
+
+ public static function get_template_path() {
+ return 'woocommerce-germanized/';
+ }
+
+ /**
+ * Return the path to the package.
+ *
+ * @return string
+ */
+ public static function get_url() {
+ return plugins_url( '', __DIR__ );
+ }
+
+ public static function get_assets_url() {
+ return self::get_url() . '/assets';
+ }
+
+ public static function is_debug_mode() {
+ $is_debug_mode = ( defined( 'WC_GZD_DHL_DEBUG' ) && WC_GZD_DHL_DEBUG );
+
+ if ( ! $is_debug_mode && ( $provider = self::get_dhl_shipping_provider() ) ) {
+ $is_debug_mode = $provider->is_sandbox();
+ }
+
+ return $is_debug_mode;
+ }
+
+ public static function enable_logging() {
+ return ( defined( 'WC_GZD_DHL_LOG_ENABLE' ) && WC_GZD_DHL_LOG_ENABLE ) || self::is_debug_mode();
+ }
+
+ private static function define_constant( $name, $value ) {
+ if ( ! defined( $name ) ) {
+ define( $name, $value );
+ }
+ }
+
+ public static function get_app_id() {
+ return 'woo_germanized_2';
+ }
+
+ public static function get_app_token() {
+ return '8KdXFjxwY0I1oOEo28Jk997tS5Rkky';
+ }
+
+ public static function get_geschaeftskunden_portal_url() {
+ return 'https://www.dhl-geschaeftskundenportal.de';
+ }
+
+ public static function get_internetmarke_main_url() {
+ return 'https://internetmarke.deutschepost.de/OneClickForAppV3?wsdl';
+ }
+
+ public static function get_warenpost_international_rest_url() {
+ return 'https://api.deutschepost.com';
+ }
+
+ public static function get_internetmarke_products_url() {
+ return 'https://prodws.deutschepost.de:8443/ProdWSProvider_1_1/prodws?wsdl';
+ }
+
+ public static function get_internetmarke_refund_url() {
+ return 'https://internetmarke.deutschepost.de/OneClickForRefund?wsdl';
+ }
+
+ public static function get_internetmarke_partner_id() {
+ return 'AVHGE';
+ }
+
+ public static function get_internetmarke_token() {
+ return 'l4e0TNkqpGKd0YIhyuz3m4vzEek1iZY4';
+ }
+
+ public static function get_internetmarke_key_phase() {
+ return 1;
+ }
+
+ public static function get_internetmarke_product_username() {
+ return 'vendidero';
+ }
+
+ public static function get_internetmarke_product_password() {
+ return 'A&5%bk?dx8';
+ }
+
+ public static function get_internetmarke_product_mandant_id() {
+ return 'VENDIDERO';
+ }
+
+ public static function is_deutsche_post_enabled() {
+ $is_enabled = false;
+
+ if ( $provider = self::get_deutsche_post_shipping_provider() ) {
+ $is_enabled = $provider->is_activated();
+ }
+
+ return $is_enabled;
+ }
+
+ public static function get_internetmarke_username() {
+ if ( self::is_debug_mode() && defined( 'WC_GZD_DHL_IM_SANDBOX_USER' ) ) {
+ return WC_GZD_DHL_IM_SANDBOX_USER;
+ } else {
+ return self::get_setting( 'deutsche_post_api_username' );
+ }
+ }
+
+ public static function get_internetmarke_warenpost_int_ekp() {
+ $ekp = self::get_setting( 'deutsche_post_warenpost_int_ekp' );
+
+ if ( empty( $ekp ) ) {
+ $ekp = '0000012207';
+ }
+
+ return $ekp;
+ }
+
+ /**
+ * The Warenpost International API (necessary for customs forms)
+ * needs separate Sandbox credentials. In live mode the Portokasse credentials are being used.
+ *
+ * @return string
+ */
+ public static function get_internetmarke_warenpost_int_username() {
+ if ( self::is_debug_mode() && defined( 'WC_GZD_DHL_IM_WP_SANDBOX_USER' ) ) {
+ return WC_GZD_DHL_IM_WP_SANDBOX_USER;
+ } else {
+ return self::get_setting( 'deutsche_post_api_username' );
+ }
+ }
+
+ public static function get_internetmarke_password() {
+ if ( self::is_debug_mode() && defined( 'WC_GZD_DHL_IM_SANDBOX_PASSWORD' ) ) {
+ return WC_GZD_DHL_IM_SANDBOX_PASSWORD;
+ } else {
+ return self::get_setting( 'deutsche_post_api_password' );
+ }
+ }
+
+ public static function get_internetmarke_warenpost_int_password() {
+ if ( self::is_debug_mode() && defined( 'WC_GZD_DHL_IM_WP_SANDBOX_PASSWORD' ) ) {
+ return WC_GZD_DHL_IM_WP_SANDBOX_PASSWORD;
+ } else {
+ return self::get_setting( 'deutsche_post_api_password' );
+ }
+ }
+
+ /**
+ * CIG Authentication (basic auth) user. In Sandbox mode use Developer ID and password of entwickler.dhl.de
+ *
+ * @return mixed|string|void
+ */
+ public static function get_cig_user() {
+ $debug_user = defined( 'WC_GZD_DHL_SANDBOX_USER' ) ? WC_GZD_DHL_SANDBOX_USER : self::get_setting( 'api_sandbox_username' );
+ $debug_user = strtolower( $debug_user );
+
+ return self::is_debug_mode() ? $debug_user : self::get_app_id();
+ }
+
+ /**
+ * CIG Authentication (basic auth) password. In Sandbox mode use Developer ID and password of entwickler.dhl.de
+ *
+ * @return mixed|string|void
+ */
+ public static function get_cig_password() {
+ $debug_pwd = defined( 'WC_GZD_DHL_SANDBOX_PASSWORD' ) ? WC_GZD_DHL_SANDBOX_PASSWORD : self::get_setting( 'api_sandbox_password' );
+
+ return self::is_debug_mode() ? $debug_pwd : self::get_app_token();
+ }
+
+ /**
+ * GK Auth user
+ *
+ * @return mixed|string|void
+ */
+ public static function get_gk_api_user() {
+ $user = self::is_debug_mode() ? '2222222222_01' : self::get_setting( 'api_username' );
+
+ return strtolower( $user );
+ }
+
+ /**
+ * GK Auth password
+ *
+ * @return mixed|string|void
+ */
+ public static function get_gk_api_signature() {
+ return self::is_debug_mode() ? 'pass' : self::get_setting( 'api_password' );
+ }
+
+ /**
+ * Retoure Auth user
+ *
+ * @return mixed|string|void
+ */
+ public static function get_retoure_api_user() {
+ $user = self::is_debug_mode() ? '2222222222_Customer' : self::get_setting( 'api_username' );
+
+ return strtolower( $user );
+ }
+
+ public static function get_return_receivers() {
+ $receiver = self::get_setting( 'retoure_receiver_ids' );
+
+ if ( ! empty( $receiver ) ) {
+ return (array) $receiver;
+ } else {
+ return array();
+ }
+ }
+
+ public static function get_return_receiver_by_slug( $slug ) {
+ $receivers = self::get_return_receivers();
+
+ if ( array_key_exists( sanitize_key( $slug ), $receivers ) ) {
+ return $receivers[ $slug ];
+ }
+
+ return false;
+ }
+
+ public static function get_return_receiver_by_country( $country ) {
+ $receivers = self::get_return_receivers();
+ $country_receiver = false;
+ $fallback_receiver = false;
+
+ foreach( $receivers as $receiver ) {
+
+ if ( ! $fallback_receiver && empty( $receiver['country'] ) ) {
+ $fallback_receiver = $receiver;
+ }
+
+ if ( $receiver['country'] === $country ) {
+ $country_receiver = $receiver;
+ }
+ }
+
+ if ( ! $country_receiver ) {
+ $country_receiver = $fallback_receiver;
+ }
+
+ /**
+ * Returns the DHL retoure receiver id for a certain country.
+ *
+ * @param array $receiver The receiver to be used for the retoure.
+ * @param string $country The country code of the retoure.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/DHL
+ */
+ return apply_filters( 'woocommerce_gzd_dhl_retoure_receiver', $country_receiver, $country );
+ }
+
+ /**
+ * Retoure Auth signature
+ *
+ * @return mixed|string|void
+ */
+ public static function get_retoure_api_signature() {
+ return self::is_debug_mode() ? 'uBQbZ62!ZiBiVVbhc' : self::get_setting( 'api_password' );
+ }
+
+ public static function get_cig_url() {
+ return self::is_debug_mode() ? 'https://cig.dhl.de/services/sandbox/soap' : 'https://cig.dhl.de/services/production/soap';
+ }
+
+ public static function get_rest_url() {
+ return self::is_debug_mode() ? 'https://cig.dhl.de/services/sandbox/rest' : 'https://cig.dhl.de/services/production/rest';
+ }
+
+ public static function get_gk_api_url() {
+ return self::is_debug_mode() ? 'https://cig.dhl.de/cig-wsdls/com/dpdhl/wsdl/geschaeftskundenversand-api/3.1/geschaeftskundenversand-api-3.1.wsdl' : 'https://cig.dhl.de/cig-wsdls/com/dpdhl/wsdl/geschaeftskundenversand-api/3.1/geschaeftskundenversand-api-3.1.wsdl';
+ }
+
+ public static function get_parcel_finder_api_url() {
+ return self::is_debug_mode() ? 'https://cig.dhl.de/cig-wsdls/com/dpdhl/wsdl/standortsuche-api/1.1/standortsuche-api-1.1.wsdl' : 'https://cig.dhl.de/cig-wsdls/com/dpdhl/wsdl/standortsuche-api/1.1/standortsuche-api-1.1.wsdl';
+ }
+
+ public static function get_business_portal_url() {
+ return 'https://www.dhl-geschaeftskundenportal.de';
+ }
+
+ /**
+ * Generate a unique key.
+ *
+ * @return string
+ */
+ protected static function generate_key() {
+ $key = array( ABSPATH, time() );
+ $constants = array( 'AUTH_KEY', 'SECURE_AUTH_KEY', 'LOGGED_IN_KEY', 'NONCE_KEY', 'AUTH_SALT', 'SECURE_AUTH_SALT', 'LOGGED_IN_SALT', 'NONCE_SALT', 'SECRET_KEY' );
+
+ foreach ( $constants as $constant ) {
+ if ( defined( $constant ) ) {
+ $key[] = constant( $constant );
+ }
+ }
+
+ shuffle( $key );
+
+ return md5( serialize( $key ) );
+ }
+
+ public static function get_upload_dir_suffix() {
+ return self::$upload_dir_suffix;
+ }
+
+ public static function get_upload_dir() {
+
+ self::set_upload_dir_filter();
+ $upload_dir = wp_upload_dir();
+ self::unset_upload_dir_filter();
+
+ /**
+ * Filter to adjust the DHL label upload directory. By default
+ * DHL labels are stored in a custom directory under wp-content/uploads.
+ *
+ * @param array $upload_dir Array containing `wp_upload_dir` data.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/DHL
+ */
+ return apply_filters( 'woocommerce_gzd_dhl_upload_dir', $upload_dir );
+ }
+
+ public static function get_relative_upload_dir( $path ) {
+
+ self::set_upload_dir_filter();
+ $path = _wp_relative_upload_path( $path );
+ self::unset_upload_dir_filter();
+
+ /**
+ * Filter to retrieve the DHL label relative upload path.
+ *
+ * @param array $path Relative path.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/DHL
+ */
+ return apply_filters( 'woocommerce_gzd_dhl_relative_upload_dir', $path );
+ }
+
+ public static function set_upload_dir_filter() {
+ add_filter( 'upload_dir', array( __CLASS__, "filter_upload_dir" ), 150, 1 );
+ }
+
+ public static function get_file_by_path( $file ) {
+ // If the file is relative, prepend upload dir.
+ if ( $file && 0 !== strpos( $file, '/' ) && ( ( $uploads = Package::get_upload_dir() ) && false === $uploads['error'] ) ) {
+ $file = $uploads['basedir'] . "/$file";
+
+ return $file;
+ } else {
+ return $file;
+ }
+ }
+
+ public static function get_wsdl_file( $wsdl_link ) {
+ if ( self::is_debug_mode() ) {
+ return $wsdl_link;
+ }
+
+ $main_file = basename( $wsdl_link );
+ $required_files = array( $main_file );
+
+ // Some WSDLs may require multiple files
+ if ( strpos( $wsdl_link, 'geschaeftskundenversand-api' ) !== false ) {
+ $required_files = array(
+ $main_file,
+ str_replace( '.wsdl', '-schema-cis_base.xsd', $main_file ),
+ str_replace( '.wsdl', '-schema-bcs_base.xsd', $main_file ),
+ );
+ }
+
+ $file_link = $wsdl_link;
+ $transient = 'wc_gzd_dhl_wsdl_' . sanitize_key( $main_file );
+ $new_file_name = $main_file;
+ $files_exist = true;
+ $is_zip = false;
+
+ // Renew files every 14 days
+ $transient_valid = DAY_IN_SECONDS * 14;
+
+ if ( sizeof( $required_files ) > 1 ) {
+ $file_link = str_replace( '.wsdl', '.zip', $file_link );
+ $new_file_name = str_replace( '.wsdl', '.zip', $new_file_name );
+ $is_zip = true;
+ }
+
+ /**
+ * Check if all required files exist locally
+ */
+ foreach( $required_files as $file ) {
+ $inner_transient = 'wc_gzd_dhl_wsdl_' . sanitize_key( $file );
+ $file_path = get_transient( $inner_transient );
+
+ if ( $file_path ) {
+ $file_path = \Vendidero\Germanized\Shipments\Package::get_file_by_path( $file_path );
+ }
+
+ if ( ! $file_path || ! file_exists( $file_path ) ) {
+ $files_exist = false;
+ }
+ }
+
+ $file_path = get_transient( $transient );
+
+ /**
+ * This filter may be used to force loading an alternate (local) WSDL file
+ * for a certain API endpoint. By default we are trying to locally store necessary files
+ * to reduce API calls. Transients/files are renewed once per day.
+ *
+ * @param boolean|string $alternate_file In case an alternate file should be used this must be the absolute path.
+ * @param string $wsdl_link The link to the original WSDL file.
+ *
+ * @since 3.1.2
+ * @package Vendidero/Germanized/DHL
+ */
+ $alternate_file = apply_filters( 'woocommerce_gzd_dhl_alternate_wsdl_file', false, $wsdl_link );
+
+ if ( ( $files_exist && $file_path ) || $alternate_file ) {
+ $wsdl_link = $alternate_file ? $alternate_file : \Vendidero\Germanized\Shipments\Package::get_file_by_path( $file_path );
+ } else {
+
+ if ( ! function_exists( 'download_url' ) ) {
+ include_once( ABSPATH . 'wp-admin/includes/file.php' );
+ }
+
+ if ( function_exists( 'download_url' ) && function_exists( 'unzip_file' ) ) {
+ /**
+ * Some URLs like https://prodws.deutschepost.de:8443/ProdWSProvider_1_1/prodws?wsdl might
+ * be rejected due to not using standard SSL ports, e.g.: 8443. Allow them anyway.
+ */
+ add_filter( 'http_request_args', function( $args, $url ) use ( $file_link ) {
+ if ( $url === $file_link ) {
+ $args['reject_unsafe_urls'] = false;
+ }
+
+ return $args;
+ }, 10, 2 );
+
+ $tmp_file = download_url( $file_link, 1500 );
+
+ if ( ! is_wp_error( $tmp_file ) ) {
+
+ $uploads = \Vendidero\Germanized\Shipments\Package::get_upload_dir();
+ $new_file = $uploads['path'] . "/$new_file_name";
+ $has_copied = @copy( $tmp_file, $new_file );
+
+ if ( $has_copied ) {
+
+ if ( $is_zip ) {
+ global $wp_filesystem;
+
+ if ( ! $wp_filesystem ) {
+ WP_Filesystem();
+ }
+
+ $unzipfile = unzip_file( $new_file, $uploads['path'] );
+
+ if ( ! is_wp_error( $unzipfile ) ) {
+ $files_exist = true;
+ $new_wsdl_link = false;
+
+ foreach( $required_files as $file ) {
+ $transient = 'wc_gzd_dhl_wsdl_' . sanitize_key( $file );
+ $file_path = $uploads['path'] . "/$file";
+
+ if ( file_exists( $file_path ) ) {
+ set_transient( $transient, \Vendidero\Germanized\Shipments\Package::get_relative_upload_dir( $file_path ), $transient_valid );
+
+ if ( $file === $main_file ) {
+ $new_wsdl_link = $file_path;
+ }
+ } else {
+ $files_exist = false;
+ }
+ }
+
+ if ( $files_exist && $new_wsdl_link ) {
+ $wsdl_link = $new_wsdl_link;
+ }
+ }
+
+ @unlink( $new_file );
+ } else {
+ $transient = 'wc_gzd_dhl_wsdl_' . sanitize_key( $main_file );
+ $file_path = $uploads['path'] . "/$main_file";
+
+ if ( file_exists( $file_path ) ) {
+ set_transient( $transient, \Vendidero\Germanized\Shipments\Package::get_relative_upload_dir( $file_path ), $transient_valid );
+ $wsdl_link = $file_path;
+ }
+ }
+
+ @unlink( $tmp_file );
+ }
+ }
+ }
+ }
+
+ return $wsdl_link;
+ }
+
+ public static function unset_upload_dir_filter() {
+ remove_filter( 'upload_dir', array( __CLASS__, "filter_upload_dir" ), 150 );
+ }
+
+ public static function filter_upload_dir( $args ) {
+ $upload_base = trailingslashit( $args['basedir'] );
+ $upload_url = trailingslashit( $args['baseurl'] );
+
+ /**
+ * Filter to adjust the DHL label upload path. By default
+ * DHL labels are stored in a custom directory under wp-content/uploads.
+ *
+ * @param string $path Path to the upload directory.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/DHL
+ */
+ $args['basedir'] = apply_filters( 'woocommerce_gzd_dhl_upload_path', $upload_base . 'wc-gzd-dhl-' . self::get_upload_dir_suffix() );
+ /**
+ * Filter to adjust the DHL label upload URL. By default
+ * DHL labels are stored in a custom directory under wp-content/uploads.
+ *
+ * @param string $url URL to the upload directory.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/DHL
+ */
+ $args['baseurl'] = apply_filters( 'woocommerce_gzd_dhl_upload_url', $upload_url . 'wc-gzd-dhl-' . self::get_upload_dir_suffix() );
+
+ $args['path'] = $args['basedir'] . $args['subdir'];
+ $args['url'] = $args['baseurl'] . $args['subdir'];
+
+ return $args;
+ }
+
+ public static function get_participation_number( $product ) {
+ return self::get_setting( 'participation_' . $product );
+ }
+
+ /**
+ * @param $name
+ * @param bool|ShippingMethod $method
+ *
+ * @return mixed|void
+ */
+ public static function get_setting( $name, $shipment = false, $default = false ) {
+ $is_dp = false;
+ $value = $default;
+
+ if ( substr( $name, 0, 4 ) === 'dhl_' ) {
+ $name = substr( $name, 4 );
+ } elseif( substr( $name, 0, 14 ) === 'deutsche_post_' ) {
+ $name = substr( $name, 14 );
+ $is_dp = true;
+ }
+
+ if ( ! $is_dp && self::is_debug_mode() ) {
+ if( 'api_username' === $name ) {
+ $name = 'api_sandbox_username';
+ } elseif( 'api_password' === $name ) {
+ $name = 'api_sandbox_password';
+ } elseif( 'account_number' === $name ) {
+ return '2222222222';
+ }
+ }
+
+ if ( ! $is_dp ) {
+ if ( $provider = Package::get_dhl_shipping_provider() ) {
+ if ( $shipment ) {
+ $value = $provider->get_shipment_setting( $shipment, $name, $default );
+ } else {
+ $value = $provider->get_setting( $name, $default );
+ }
+ }
+ } else {
+ if ( $provider = Package::get_deutsche_post_shipping_provider() ) {
+ if ( $shipment ) {
+ $value = $provider->get_shipment_setting( $shipment, $name, $default );
+ } else {
+ $value = $provider->get_setting( $name, $default );
+ }
+ }
+ }
+
+ return $value;
+ }
+
+ public static function log( $message, $type = 'info' ) {
+ $logger = wc_get_logger();
+ $enable_logging = self::enable_logging() ? true : false;
+
+ if ( ! $logger ) {
+ return false;
+ }
+
+ /**
+ * Filter that allows adjusting whether to enable or disable
+ * logging for the DHL package (e.g. API requests).
+ *
+ * @param boolean $enable_logging True if logging should be enabled. False otherwise.
+ *
+ * @package Vendidero/Germanized/DHL
+ */
+ if ( ! apply_filters( 'woocommerce_gzd_dhl_enable_logging', $enable_logging ) ) {
+ return false;
+ }
+
+ if ( ! is_callable( array( $logger, $type ) ) ) {
+ $type = 'info';
+ }
+
+ $logger->{$type}( $message, array( 'source' => 'woocommerce-germanized-dhl' ) );
+ }
+
+ public static function get_available_countries() {
+ return array( 'DE' => _x( 'Germany', 'dhl', 'woocommerce-germanized' ) );
+ }
+
+ public static function get_base_country() {
+ $base_location = wc_get_base_location();
+ $base_country = $base_location['country'];
+
+ /**
+ * Filter to adjust the DHL base country.
+ *
+ * @param string $country The country as ISO code.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/DHL
+ */
+ return apply_filters( 'woocommerce_gzd_dhl_base_country', $base_country );
+ }
+
+ public static function get_us_territories() {
+ return self::$us_territories;
+ }
+
+ /**
+ * Function return whether the sender and receiver country is the same territory
+ */
+ public static function is_shipping_domestic( $country_receiver ) {
+ // If base is US territory
+ if ( in_array( self::get_base_country(), self::get_us_territories() ) ) {
+ // ...and destination is US territory, then it is "domestic"
+ if ( in_array( $country_receiver, self::get_us_territories() ) ) {
+ return true;
+ } else {
+ return false;
+ }
+ } elseif ( $country_receiver == self::get_base_country() ) {
+ return true;
+ } else {
+ return false;
+ }
+ }
+
+ /**
+ * Check if it is an EU shipment
+ */
+ public static function is_eu_shipment( $country_receiver ) {
+ if ( self::is_shipping_domestic( $country_receiver ) ) {
+ return false;
+ }
+
+ if ( in_array( $country_receiver, self::get_eu_countries() ) ) {
+ return true;
+ } else {
+ return false;
+ }
+ }
+
+ protected static function get_eu_countries() {
+ $countries = WC()->countries->get_european_union_countries();
+
+ if ( in_array( 'GB', $countries ) ) {
+ $countries = array_diff( $countries, array( 'GB' ) );
+ }
+
+ return $countries;
+ }
+
+ /**
+ * Function return whether the sender and receiver country is "crossborder" i.e. needs CUSTOMS declarations (outside EU)
+ */
+ public static function is_crossborder_shipment( $country_receiver ) {
+ if ( self::is_shipping_domestic( $country_receiver ) ) {
+ return false;
+ }
+
+ // Is sender country in EU...
+ if ( in_array( self::get_base_country(), self::get_eu_countries() ) ) {
+ // ... and receiver country is in EU means NOT crossborder!
+ if ( in_array( $country_receiver, self::get_eu_countries() ) ) {
+ return false;
+ } else {
+ return true;
+ }
+ } else {
+ return true;
+ }
+ }
+}
diff --git a/packages/woocommerce-germanized-dhl/src/ParcelLocator.php b/packages/woocommerce-germanized-dhl/src/ParcelLocator.php
new file mode 100644
index 000000000..8ea489c8d
--- /dev/null
+++ b/packages/woocommerce-germanized-dhl/src/ParcelLocator.php
@@ -0,0 +1,1126 @@
+ _x( 'Address Type', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'select',
+ 'options' => self::get_address_types(),
+ 'description' => _x( 'Select whether delivery to DHL locations should be enabled.', 'dhl', 'woocommerce-germanized' ),
+ 'class' => '',
+ 'priority' => 50,
+ );
+ $fields['shipping']['fields']['shipping_dhl_postnumber'] = array(
+ 'label' => _x( 'Postnumber', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'description' => _x( 'In case delivery to packstation is selected please fill in the corresponding DHL post number.', 'dhl', 'woocommerce-germanized' ),
+ 'priority' => 60,
+ );
+ return $fields;
+ }
+
+ public static function manipulate_address_fields( $fields ) {
+ global $wp;
+
+ if ( ! self::is_available() ) {
+ return $fields;
+ }
+
+ if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
+ return $fields;
+ }
+
+ $nonce_key = ( isset( $_REQUEST['woocommerce-edit-address-nonce'] ) ? 'woocommerce-edit-address-nonce' : '_wpnonce' );
+
+ if ( empty( $_POST['action'] ) || 'edit_address' !== $_POST['action'] || empty( $_REQUEST[ $nonce_key ] ) || ! wp_verify_nonce( $_REQUEST[ $nonce_key ], 'woocommerce-edit_address' ) ) {
+ return $fields;
+ }
+
+ $user_id = get_current_user_id();
+
+ if ( $user_id <= 0 ) {
+ return $fields;
+ }
+
+ if ( isset( $_POST['shipping_address_type'] ) && 'dhl' === $_POST['shipping_address_type'] ) {
+ $fields['shipping_address_1']['label'] = self::get_pickup_type_address_label();
+ }
+
+ return $fields;
+ }
+
+ public static function validate_address_postnumber( $value ) {
+
+ if ( ! self::is_available() ) {
+ return $value;
+ }
+
+ $shipping_country = isset( $_POST['shipping_country'] ) ? wc_clean( $_POST['shipping_country'] ) : '';
+ $shipping_address_type = isset( $_POST['shipping_address_type'] ) ? wc_clean( $_POST['shipping_address_type'] ) : 'regular';
+
+ // Not a supported country
+ if ( ! in_array( $shipping_country, self::get_supported_countries() ) ) {
+ return '';
+ }
+
+ if ( 'dhl' === $shipping_address_type ) {
+ $args = array(
+ 'address_1' => isset( $_POST['shipping_address_1'] ) ? wc_clean( $_POST['shipping_address_1'] ) : '',
+ 'postnumber' => isset( $_POST['shipping_dhl_postnumber'] ) ? wc_clean( $_POST['shipping_dhl_postnumber'] ) : '',
+ 'postcode' => isset( $_POST['shipping_postcode'] ) ? wc_clean( $_POST['shipping_postcode'] ) : '',
+ 'city' => isset( $_POST['shipping_city'] ) ? wc_clean( $_POST['shipping_city'] ) : '',
+ 'country' => isset( $_POST['shipping_country'] ) ? wc_clean( $_POST['shipping_country'] ) : '',
+ );
+
+ $result = self::validate_address( $args );
+
+ if ( is_wp_error( $result ) ) {
+ return '';
+ }
+ } else {
+ return '';
+ }
+
+ return self::remove_whitespace( $value );
+ }
+
+ public static function validate_address_fields( $value ) {
+
+ if ( ! self::is_available() ) {
+ return $value;
+ }
+
+ $shipping_country = isset( $_POST['shipping_country'] ) ? wc_clean( $_POST['shipping_country'] ) : '';
+ $shipping_address_type = isset( $_POST['shipping_address_type'] ) ? wc_clean( $_POST['shipping_address_type'] ) : 'regular';
+
+ // Not a supported country
+ if ( ! in_array( $shipping_country, self::get_supported_countries() ) ) {
+ return 'regular';
+ }
+
+ if ( ! array_key_exists( $shipping_address_type, self::get_address_types() ) ) {
+ wc_add_notice( _x( 'Invalid address type.', 'dhl', 'woocommerce-germanized' ), 'error' );
+ }
+
+ if ( 'dhl' === $shipping_address_type ) {
+ $args = array(
+ 'address_1' => isset( $_POST['shipping_address_1'] ) ? wc_clean( $_POST['shipping_address_1'] ) : '',
+ 'postnumber' => isset( $_POST['shipping_dhl_postnumber'] ) ? wc_clean( $_POST['shipping_dhl_postnumber'] ) : '',
+ 'postcode' => isset( $_POST['shipping_postcode'] ) ? wc_clean( $_POST['shipping_postcode'] ) : '',
+ 'city' => isset( $_POST['shipping_city'] ) ? wc_clean( $_POST['shipping_city'] ) : '',
+ 'country' => isset( $_POST['shipping_country'] ) ? wc_clean( $_POST['shipping_country'] ) : '',
+ );
+
+ $result = self::validate_address( $args );
+
+ if ( is_wp_error( $result ) ) {
+ foreach( $result->get_error_messages() as $mesage ) {
+ wc_add_notice( $mesage, 'error' );
+ }
+ }
+ }
+
+ return $value;
+ }
+
+ /**
+ * @param $send_to_pickup
+ * @param $types
+ * @param Shipment $shipment
+ */
+ public static function shipment_has_pickup( $send_to_pickup, $types, $shipment ) {
+ $data = $shipment->get_address();
+
+ if ( isset( $data['address_type'] ) && 'dhl' === $data['address_type'] ) {
+ foreach( $types as $type ) {
+ if ( wc_gzd_dhl_is_pickup_type( $shipment->get_address_1(), $type ) ) {
+ return true;
+ }
+ }
+ }
+
+ return $send_to_pickup;
+ }
+
+ public static function get_postnumber_by_shipment( $shipment ) {
+ if ( is_numeric( $shipment ) ) {
+ $shipment = wc_gzd_get_shipment( $shipment );
+ }
+
+ $postnumber = '';
+
+ if ( $shipment ) {
+ $address = $shipment->get_address();
+
+ if ( isset( $address['dhl_postnumber'] ) ) {
+ $postnumber = $address['dhl_postnumber'];
+ }
+ }
+
+ return self::remove_whitespace( $postnumber );
+ }
+
+ /**
+ * @param WC_Order $order
+ * @param $data
+ */
+ public static function maybe_remove_order_data( $order, $data ) {
+ if ( ! self::order_has_pickup( $order ) ) {
+ $order->delete_meta_data( '_shipping_dhl_postnumber' );
+ $order->update_meta_data( '_shipping_dhl_address_type', 'regular' );
+ }
+ }
+
+ public static function get_supported_countries() {
+ /**
+ * Filter to enable DHL parcel shop delivery for certain countries.
+ *
+ * @param array $country_codes Array of country codes which support DHL parcel shop delivery.
+ *
+ * @package Vendidero/Germanized/DHL
+ */
+ $codes = apply_filters( 'woocommerce_gzd_dhl_parcel_locator_countries', array( 'DE', 'AT' ) );
+
+ return $codes;
+ }
+
+ /**
+ * @param $data
+ * @param $type
+ * @param WC_Order $order
+ *
+ * @return mixed
+ */
+ public static function add_order_address_data( $data, $type, $order ) {
+ if ( 'shipping' === $type ) {
+ if ( self::order_has_pickup( $order ) ) {
+ $data['dhl_postnumber'] = self::get_postnumber_by_order( $order );
+ $data['address_type'] = self::get_shipping_address_type_by_order( $order );
+ }
+ }
+
+ return $data;
+ }
+
+ public static function set_address_format( $formats ) {
+ foreach( self::get_supported_countries() as $country ) {
+
+ if ( ! array_key_exists( $country, $formats ) ) {
+ continue;
+ }
+
+ $format = $formats[ $country ];
+ $format = str_replace( "{name}", "{name}\n{dhl_postnumber}", $format );
+
+ $formats[ $country ] = $format;
+ }
+
+ return $formats;
+ }
+
+ public static function set_formatted_shipping_address( $fields, $order ) {
+ if ( ! empty( $fields ) && is_array( $fields ) ) {
+ $fields['dhl_postnumber'] = '';
+
+ if ( wc_gzd_dhl_order_has_pickup( $order ) ) {
+ $fields['dhl_postnumber'] = self::get_postnumber_by_order( $order );
+ }
+ }
+
+ return $fields;
+ }
+
+ public static function get_postnumber_by_order( $order ) {
+ if ( is_numeric( $order ) ) {
+ $order = wc_get_order( $order );
+ }
+
+ $post_number = '';
+
+ if ( $order ) {
+ if ( $order->get_meta( '_shipping_dhl_postnumber' ) ) {
+ $post_number = $order->get_meta( '_shipping_dhl_postnumber' );
+ }
+ }
+
+ /**
+ * Filter to adjust the DHL postnumber for a certain order.
+ *
+ * @param string $post_number The post number.
+ * @param WC_Order $order The order object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/DHL
+ */
+ return apply_filters( 'woocommerce_gzd_dhl_order_postnumber', $post_number, $order );
+ }
+
+ public static function get_shipping_address_type_by_order( $order ) {
+ if ( is_numeric( $order ) ) {
+ $order = wc_get_order( $order );
+ }
+
+ $address_type = 'regular';
+
+ if ( $order ) {
+ if ( $type = $order->get_meta( '_shipping_address_type' ) ) {
+ if ( array_key_exists( $type, self::get_address_types() ) ) {
+ $address_type = $type;
+ }
+ }
+ }
+
+ return $address_type;
+ }
+
+ public static function order_has_pickup( $order ) {
+ if ( is_numeric( $order ) ) {
+ $order = wc_get_order( $order );
+ }
+
+ $has_pickup = false;
+
+ if ( $order ) {
+ $address_type = self::get_shipping_address_type_by_order( $order );
+ $number = self::get_postnumber_by_order( $order );
+ $type = self::get_pickup_type_by_order( $order );
+ $country = $order->get_shipping_country();
+
+ if ( ! empty( $country ) && in_array( $country, self::get_supported_countries() ) && 'dhl' === $address_type && ! empty( $number ) && ! empty( $type ) ) {
+ $has_pickup = true;
+ }
+ }
+
+ return $has_pickup;
+ }
+
+ public static function get_pickup_type_by_order( $order ) {
+ if ( is_numeric( $order ) ) {
+ $order = wc_get_order( $order );
+ }
+
+ $pickup_type = '';
+
+ if ( $order ) {
+ if ( $address = $order->get_shipping_address_1() ) {
+ $pickup_types = wc_gzd_dhl_get_pickup_types();
+
+ foreach( $pickup_types as $pickup_tmp_type => $label ) {
+ if ( wc_gzd_dhl_is_pickup_type( $address, $pickup_tmp_type ) ) {
+ $pickup_type = $pickup_tmp_type;
+ break;
+ }
+ }
+ }
+ }
+
+ /**
+ * Filter to adjust the DHL pickup type e.g. packstation for a certain order.
+ *
+ * @see wc_gzd_dhl_get_pickup_types()
+ *
+ * @param string $pickup_type The pickup type.
+ * @param WC_Order $order The order object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/DHL
+ */
+ return apply_filters( 'woocommerce_gzd_dhl_order_pickup_type', $pickup_type, $order );
+ }
+
+ public static function get_postnumber_by_user( $user ) {
+ if ( is_numeric( $user ) ) {
+ $user = get_user_by( 'ID', $user );
+ }
+
+ $post_number = '';
+
+ if ( $user ) {
+
+ if ( get_user_meta( $user->ID, 'shipping_dhl_postnumber', true ) ) {
+ $post_number = get_user_meta( $user->ID, 'shipping_dhl_postnumber', true );
+ }
+
+ if ( get_user_meta( $user->ID, 'shipping_parcelshop_post_number', true ) ) {
+ $post_number = get_user_meta( $user->ID, 'shipping_parcelshop_post_number', true );
+ }
+ }
+
+ /**
+ * Filter to adjust the DHL postnumber for a certain user.
+ *
+ * @param string $post_number The post number.
+ * @param WP_User $user The user object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/DHL
+ */
+ return apply_filters( 'woocommerce_gzd_dhl_user_postnumber', $post_number, $user );
+ }
+
+ public static function set_formatted_billing_address( $fields, $order ) {
+
+ if ( ! empty( $fields ) && is_array( $fields ) ) {
+ $fields['dhl_postnumber'] = '';
+ }
+
+ return $fields;
+ }
+
+ public static function set_formatted_address( $placeholder, $args ) {
+ if ( isset( $args['dhl_postnumber'] ) ) {
+ $placeholder['{dhl_postnumber}'] = $args['dhl_postnumber'];
+ $placeholder['{dhl_postnumber_upper}'] = strtoupper( $args['dhl_postnumber'] );
+ } else {
+ $placeholder['{dhl_postnumber}'] = '';
+ $placeholder['{dhl_postnumber}'] = '';
+ }
+ return $placeholder;
+ }
+
+ public static function set_user_address( $address, $customer_id, $name ) {
+ if ( 'shipping' === $name ) {
+ if ( $post_number = self::get_postnumber_by_user( $customer_id ) ) {
+ $address['dhl_postnumber'] = $post_number;
+ }
+ }
+ return $address;
+ }
+
+ public static function manipulate_checkout_fields() {
+ if ( 'dhl' === WC()->checkout()->get_value( 'shipping_address_type' ) ) {
+ add_filter( 'woocommerce_checkout_fields', array( __CLASS__, 'switch_street_label' ), 10, 1 );
+ } else {
+ remove_filter( 'woocommerce_checkout_fields', array( __CLASS__, 'switch_street_label' ), 10 );
+ }
+ }
+
+ public static function switch_street_label( $fields ) {
+ $fields['shipping']['shipping_address_1']['label'] = self::get_type_text( ' / ' );
+
+ return $fields;
+ }
+
+ protected static function get_rate_with_instance_id( $rate_id ) {
+ if ( strpos( $rate_id, ':' ) === false ) {
+ $rate_id = $rate_id . ':0';
+ }
+
+ return $rate_id;
+ }
+
+ public static function get_shipping_method_data( $from_session = false ) {
+
+ if ( $from_session ) {
+ return WC()->session->get( 'dhl_shipping_method_data', array() );
+ }
+
+ if ( WC()->session ) {
+ unset( WC()->session->dhl_shipping_method_data );
+ }
+
+ $packages = WC()->shipping()->get_packages();
+ $data = array();
+
+ foreach( $packages as $package ) {
+ $rates = $package['rates'];
+
+ foreach( $rates as $rate ) {
+ if ( $method = wc_gzd_dhl_get_shipping_method( $rate ) ) {
+ $supports = array();
+
+ foreach( wc_gzd_dhl_get_pickup_types() as $pickup_type => $title ) {
+ $getter = "is_{$pickup_type}_enabled";
+
+ if ( $method->$getter() ) {
+ $supports[] = $pickup_type;
+ }
+ }
+
+ $data[ self::get_rate_with_instance_id( $rate->id ) ] = array(
+ 'supports' => $supports,
+ 'address_type_options' => self::get_address_types( $method ),
+ 'finder_button' => self::get_button( $method ),
+ 'street_label' => self::get_pickup_type_address_label( $method ),
+ 'street_placeholder' => self::get_pickup_type_address_placeholder( $method ),
+ );
+ }
+ }
+ }
+
+ if ( WC()->session ) {
+ WC()->session->set( 'dhl_shipping_method_data', $data );
+ }
+
+ return $data;
+ }
+
+ protected static function remove_whitespace( $str ) {
+ return trim( preg_replace('/\s+/', '', $str ) );
+ }
+
+ public static function format_address_data( $data ) {
+ if ( isset( $data['shipping_dhl_postnumber'] ) ) {
+ $data['shipping_dhl_postnumber'] = self::remove_whitespace( $data['shipping_dhl_postnumber'] );
+ }
+
+ return $data;
+ }
+
+ public static function validate_checkout() {
+ if ( ! self::is_available() ) {
+ return;
+ }
+
+ $data = WC_Checkout::instance()->get_posted_data();
+ $errors = new WP_Error();
+
+ // Validate input only if "ship to different address" flag is set
+ if ( ! isset( $data['ship_to_different_address'] ) || ! $data['ship_to_different_address'] ) {
+ return;
+ }
+
+ $shipping_country = isset( $data['shipping_country'] ) ? $data['shipping_country'] : '';
+ $shipping_address_type = isset( $data['shipping_address_type'] ) ? wc_clean( $data['shipping_address_type'] ) : 'regular';
+
+ if ( empty( $shipping_address_type ) ) {
+ $shipping_address_type = 'regular';
+ }
+
+ // Not a supported country
+ if ( ! in_array( $shipping_country, self::get_supported_countries() ) ) {
+ $data['shipping_dhl_postnumber'] = '';
+ return;
+ }
+
+ if ( ! array_key_exists( $shipping_address_type, self::get_address_types() ) ) {
+ $errors->add( 'validation', _x( 'Invalid address type.', 'dhl', 'woocommerce-germanized' ) );
+ }
+
+ if ( 'dhl' === $shipping_address_type ) {
+
+ $args = array(
+ 'address_1' => isset( $data['shipping_address_1'] ) ? wc_clean( $data['shipping_address_1'] ) : '',
+ 'postnumber' => isset( $data['shipping_dhl_postnumber'] ) ? wc_clean( $data['shipping_dhl_postnumber'] ) : '',
+ 'postcode' => isset( $data['shipping_postcode'] ) ? wc_clean( $data['shipping_postcode'] ) : '',
+ 'city' => isset( $data['shipping_city'] ) ? wc_clean( $data['shipping_city'] ) : '',
+ 'country' => isset( $data['shipping_country'] ) ? wc_clean( $data['shipping_country'] ) : '',
+ );
+
+ $result = self::validate_address( $args );
+
+ if ( is_wp_error( $result ) ) {
+ foreach( $result->get_error_messages() as $mesage ) {
+ $errors->add( 'validation', $mesage );
+ }
+ }
+ }
+
+ if ( wc_gzd_dhl_wp_error_has_errors( $errors ) ) {
+ foreach( $errors->get_error_messages() as $message ) {
+ wc_add_notice( $message, 'error' );
+ }
+ }
+ }
+
+ protected static function get_available_pickup_types() {
+ $pickup_types = wc_gzd_dhl_get_pickup_types();
+
+ if ( isset( $pickup_types['packstation'] ) && ! self::is_packstation_enabled() ) {
+ unset( $pickup_types['packstation'] );
+ }
+
+ if ( isset( $pickup_types['postoffice'] ) && ! self::is_postoffice_enabled() ) {
+ unset( $pickup_types['postoffice'] );
+ }
+
+ if ( isset( $pickup_types['parcelshop'] ) && ! self::is_parcelshop_enabled() ) {
+ unset( $pickup_types['parcelshop'] );
+ }
+
+ return $pickup_types;
+ }
+
+ protected static function validate_address( $args ) {
+ $args = wp_parse_args( $args, array(
+ 'address_1' => '',
+ 'postnumber' => '',
+ 'postcode' => '',
+ 'city' => '',
+ 'country' => '',
+ ) );
+
+ $has_postnumber = false;
+
+ if ( ! empty( $args['postnumber'] ) ) {
+ $has_postnumber = true;
+
+ // Do only allow numeric input
+ $args['postnumber'] = preg_replace( "/[^0-9]/", "", $args['postnumber'] );
+ }
+
+ $error = new WP_Error();
+ $is_packstation = false;
+ $pickup_number = preg_replace( "/[^0-9]/", "", $args['address_1'] );
+
+ /**
+ * A number is required for the packstation/parcelshop/postoffice
+ */
+ if ( empty( $pickup_number ) && ! empty( $args['address_1'] ) ) {
+ $error->add( 'validation', sprintf( _x( 'Please provide a valid number within the %s field.', 'dhl', 'woocommerce-germanized' ), self::get_type_text( ' / ' ) ) );
+ }
+
+ if ( wc_gzd_dhl_is_pickup_type( $args['address_1'], 'packstation' ) ) {
+ $is_packstation = true;
+
+ if ( ! self::is_packstation_enabled() ) {
+ $error->add( 'validation', _x( 'Sorry, but delivery to packstation is not available.', 'dhl', 'woocommerce-germanized' ) );
+ $is_packstation = false;
+ }
+ } elseif( wc_gzd_dhl_is_pickup_type( $args['address_1'], 'parcelshop' ) ) {
+ if ( ! self::is_parcelshop_enabled() ) {
+ $error->add( 'validation', _x( 'Sorry, but delivery to parcel shops is not available.', 'dhl', 'woocommerce-germanized' ) );
+ }
+ } elseif( wc_gzd_dhl_is_pickup_type( $args['address_1'], 'postoffice' ) ) {
+ if ( ! self::is_postoffice_enabled() ) {
+ $error->add( 'validation', _x( 'Sorry, but delivery to post offices is not available.', 'dhl', 'woocommerce-germanized' ) );
+ }
+ } else {
+ // Try validation
+ $valid = false;
+
+ if ( ! $valid ) {
+ $error->add( 'validation', sprintf( _x( 'Please indicate shipment to %s by one of the following values: %s.', 'dhl', 'woocommerce-germanized' ), self::get_type_text( ' / ' ), implode( ', ', array_unique( array_values( self::get_available_pickup_types() ) ) ) ) );
+ }
+ }
+
+ if ( $has_postnumber && ! empty( $args['postnumber'] ) ) {
+ $post_number_len = strlen( $args['postnumber'] );
+
+ if ( $post_number_len < 6 || $post_number_len > 12 ) {
+ $error->add( 'validation', _x( 'Your DHL customer number (Post number) is not valid. Please check your number.', 'dhl', 'woocommerce-germanized' ) );
+ }
+ } elseif( ( $is_packstation || $has_postnumber ) && empty( $args['postnumber'] ) ) {
+ $error->add( 'validation', _x( 'Your DHL customer number (Post number) is needed to ship to a packstation.', 'dhl', 'woocommerce-germanized' ) );
+ }
+
+ return wc_gzd_dhl_wp_error_has_errors( $error ) ? $error : true;
+ }
+
+ public static function add_inline_styles() {
+
+ // load scripts on checkout page only
+ if ( ! is_checkout() && ! is_wc_endpoint_url( 'edit-address' ) ) {
+ return;
+ }
+
+ echo '';
+ }
+
+ public static function localize_printed_scripts() {
+ /**
+ * Do not check for localized script as this script needs to be loadeed in footer to make sure
+ * that shipping method data (packages etc.) exist. This may lead to duplicate localizations (which is not a bug).
+ */
+ if ( wp_script_is( 'wc-gzd-parcel-locator-dhl' ) ) {
+ self::$localized_scripts[] = 'wc-gzd-parcel-locator-dhl';
+
+ wp_localize_script( 'wc-gzd-parcel-locator-dhl', 'wc_gzd_dhl_parcel_locator_params', array(
+ 'ajax_url' => admin_url( 'admin-ajax.php' ),
+ 'parcel_locator_nonce' => wp_create_nonce('dhl-parcel-locator' ),
+ 'parcel_locator_data_nonce' => wp_create_nonce('dhl-parcel-locator-shipping-data' ),
+ 'supported_countries' => self::get_supported_countries(),
+ 'methods' => is_checkout() ? self::get_shipping_method_data() : array(),
+ 'is_checkout' => is_checkout(),
+ 'pickup_types' => wc_gzd_dhl_get_pickup_types(),
+ 'i18n' => array_merge( wc_gzd_dhl_get_pickup_types(), array() ),
+ 'wrapper' => is_checkout() ? '.woocommerce-checkout' : '.woocommerce-address-fields',
+ ) );
+ }
+
+ if ( ! in_array( 'wc-gzd-parcel-finder-dhl', self::$localized_scripts, true ) && wp_script_is( 'wc-gzd-parcel-finder-dhl' ) ) {
+ self::$localized_scripts[] = 'wc-gzd-parcel-finder-dhl';
+
+ wp_localize_script( 'wc-gzd-parcel-finder-dhl', 'wc_gzd_dhl_parcel_finder_params', array(
+ 'parcel_finder_nonce' => wp_create_nonce('dhl-parcel-finder' ),
+ 'ajax_url' => admin_url( 'admin-ajax.php' ),
+ 'packstation_icon' => Package::get_assets_url() . '/img/packstation.png',
+ 'parcelshop_icon' => Package::get_assets_url() . '/img/parcelshop.png',
+ 'postoffice_icon' => Package::get_assets_url() . '/img/post_office.png',
+ 'api_key' => self::get_setting( 'map_api_password' ),
+ 'wrapper' => is_checkout() ? '.woocommerce-checkout' : '.woocommerce-address-fields',
+ 'i18n' => array_merge( wc_gzd_dhl_get_pickup_types(), array(
+ 'branch' => _x( 'Branch', 'dhl', 'woocommerce-germanized' ),
+ 'post_number' => _x( 'Postnumber ', 'dhl', 'woocommerce-germanized' ),
+ ) ),
+ ) );
+ }
+ }
+
+ public static function add_scripts() {
+
+ // load scripts on checkout page only
+ if ( ! is_checkout() && ! is_wc_endpoint_url( 'edit-address' ) ) {
+ return;
+ }
+
+ $deps = array( 'jquery' );
+ $suffix = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min';
+
+ if ( is_checkout() ) {
+ array_push( $deps, 'wc-checkout' );
+ }
+
+ wp_register_script( 'wc-gzd-parcel-locator-dhl', Package::get_assets_url() . '/js/parcel-locator' . $suffix . '.js', $deps, Package::get_version(), true );
+ wp_register_script( 'wc-gzd-parcel-finder-dhl', Package::get_assets_url() . '/js/parcel-finder' . $suffix . '.js', array( 'jquery-blockui', 'wc-gzd-parcel-locator-dhl' ), Package::get_version(), true );
+
+ wp_register_style( 'wc-gzd-parcel-finder-dhl', Package::get_assets_url() . '/css/parcel-finder' . $suffix . '.css', array(), Package::get_version() );
+
+ if ( self::has_map() ) {
+ wp_enqueue_script( 'wc-gzd-parcel-finder-dhl' );
+ wp_enqueue_style( 'wc-gzd-parcel-finder-dhl' );
+ }
+
+ wp_enqueue_script( 'wc-gzd-parcel-locator-dhl' );
+ }
+
+ protected static function disable_method_setting() {
+ $disable_method_check = ( is_account_page() || is_admin() );
+ $is_forced_checkout = isset( $_POST['is_checkout'] ) ? wc_string_to_bool( $_POST['is_checkout'] ) : true;
+
+ if ( is_ajax() && $is_forced_checkout ) {
+ $disable_method_check = false;
+ }
+
+ return $disable_method_check;
+ }
+
+ protected static function get_setting( $key, $check_method = true ) {
+ $option_key = 'parcel_pickup_' . $key;
+
+ /**
+ * Exclude non-overridable options to make sure they might be used for DP too (e.g. packstation maps)
+ */
+ if ( ! in_array( $option_key, array( 'parcel_pickup_map_enable', 'parcel_pickup_map_api_password', 'parcel_pickup_map_max_results' ) ) ) {
+ if ( $check_method && ( $method = wc_gzd_dhl_get_current_shipping_method() ) ) {
+ if ( 'parcel_pickup_packstation_enable' === $option_key ) {
+ return wc_bool_to_string( $method->is_packstation_enabled() );
+ } elseif ( 'parcel_pickup_parcelshop_enable' === $option_key ) {
+ return wc_bool_to_string( $method->is_parcelshop_enabled() );
+ } elseif ( 'parcel_pickup_postoffice_enable' === $option_key ) {
+ return wc_bool_to_string( $method->is_postoffice_enabled() );
+ } elseif ( ! self::disable_method_setting() ) {
+ /**
+ * Explicitly call available pickup getters instead of generic get_option method
+ * to support DP adjustments (packstation).
+ */
+ return $method->get_option( $option_key );
+ }
+ }
+ }
+
+ $setting = Package::get_setting( $option_key );
+
+ return $setting;
+ }
+
+ public static function is_enabled() {
+ return Package::base_country_supports( 'pickup' );
+ }
+
+ public static function is_available( $check_shipping_method = true ) {
+ return self::is_packstation_enabled( $check_shipping_method ) || self::is_parcelshop_enabled( $check_shipping_method ) || self::is_postoffice_enabled( $check_shipping_method );
+ }
+
+ public static function is_postoffice_enabled( $check_shipping_method = true ) {
+ return 'yes' === self::get_setting( 'postoffice_enable', $check_shipping_method );
+ }
+
+ public static function is_packstation_enabled( $check_shipping_method = true ) {
+ return 'yes' === self::get_setting( 'packstation_enable', $check_shipping_method );
+ }
+
+ public static function is_parcelshop_enabled( $check_shipping_method = true ) {
+ return 'yes' === self::get_setting( 'parcelshop_enable', $check_shipping_method );
+ }
+
+ public static function has_map( $check_shipping_method = true ) {
+ $api_key = self::get_setting( 'map_api_password', false );
+
+ return ( 'yes' === self::get_setting( 'map_enable', $check_shipping_method ) && ! empty( $api_key ) && Package::is_dhl_enabled() );
+ }
+
+ public static function get_max_results() {
+ return self::get_setting( 'map_max_results' );
+ }
+
+ protected static function get_street_placeholder( $method = false ) {
+ $type = '';
+ $text = '';
+
+ if ( ( $method && $method->is_packstation_enabled() ) || ( ! $method && self::is_packstation_enabled() ) ) {
+ $type = wc_gzd_dhl_get_pickup_type( 'packstation' );
+ } elseif ( ( $method && $method->is_parcelshop_enabled() ) || ( ! $method && self::is_parcelshop_enabled() ) ) {
+ $type = wc_gzd_dhl_get_pickup_type( 'parcelshop' );
+ } elseif ( ( $method && $method->is_postoffice_enabled() ) || ( ! $method && self::is_postoffice_enabled() ) ) {
+ $type = wc_gzd_dhl_get_pickup_type( 'postoffice' );
+ }
+
+ if ( ! empty( $type ) ) {
+ $text = sprintf( _x( 'e.g. %s 456', 'dhl', 'woocommerce-germanized' ), $type );
+ }
+
+ return $text;
+ }
+
+ /**
+ * @param string $sep
+ * @param bool $plural
+ * @param bool|ShippingMethod $method
+ *
+ * @return string
+ */
+ protected static function get_type_text( $sep = '', $plural = true, $method = false ) {
+ $search_types = '';
+
+ if ( empty( $sep ) ) {
+ $sep = '&';
+ }
+
+ if ( ( $method && $method->is_packstation_enabled() ) || ( ! $method && self::is_packstation_enabled() ) ) {
+ $search_types .= _x( 'Packstation', 'dhl', 'woocommerce-germanized' );
+ }
+
+ if ( ( $method && ( $method->is_parcelshop_enabled() || $method->is_postoffice_enabled() ) ) || ( ! $method && ( self::is_parcelshop_enabled() || self::is_postoffice_enabled() ) ) ) {
+ $branch_type = ( $plural ) ? _x( 'Branches', 'dhl', 'woocommerce-germanized' ) : _x( 'Branch', 'dhl', 'woocommerce-germanized' );
+ $search_types .= ( ! empty( $search_types ) ? ' ' . $sep . ' ' . $branch_type : $branch_type );
+ }
+
+ return $search_types;
+ }
+
+ public static function add_admin_shipping_fields( $fields ) {
+ $fields['address_type'] = array(
+ 'label' => _x( 'Address Type', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'select',
+ 'show' => false,
+ 'options' => self::get_address_types()
+ );
+
+ $fields['dhl_postnumber'] = array(
+ 'label' => _x( 'DHL customer number (Post number)', 'dhl', 'woocommerce-germanized' ),
+ 'show' => false,
+ 'type' => 'text',
+ );
+
+ return $fields;
+ }
+
+ public static function get_address_types( $method = false ) {
+ return array(
+ 'regular' => _x( 'Regular Address', 'dhl', 'woocommerce-germanized' ),
+ 'dhl' => self::get_type_text( ' / ', true, $method )
+ );
+ }
+
+ public static function add_shipping_fields( $fields ) {
+ /**
+ * On initial render make sure to not check the actual shipping method options for availability.
+ * Otherwise if the initial shipping method does not support DHL the fields are not even added to the checkout form.
+ */
+ if ( self::is_available( false ) ) {
+ $fields['shipping_address_type'] = array(
+ 'label' => _x( 'Address Type', 'dhl', 'woocommerce-germanized' ),
+ 'required' => false,
+ 'type' => 'select',
+ 'class' => array( 'shipping-dhl-address-type' ),
+ 'clear' => true,
+ 'priority' => 5,
+ 'options' => self::get_address_types(),
+ 'default' => 'regular',
+ );
+
+ $fields['shipping_dhl_postnumber'] = array(
+ 'label' => _x( 'DHL customer number (Post number)', 'dhl', 'woocommerce-germanized' ),
+ 'required' => false,
+ 'type' => 'text',
+ 'class' => array( 'shipping-dhl-postnumber' ),
+ 'description' => _x( 'Not yet a DHL customer?', 'dhl', 'woocommerce-germanized' ) . 'SOAPClient is required. Please contact your host and make sure that SOAPClient is installed.', 'dhl', 'woocommerce-germanize-dhl' ), 'https://www.php.net/manual/class.soapclient.php', admin_url( 'admin.php?page=wc-status' ) ); ?>
+' . _x( 'Register now', 'dhl', 'woocommerce-germanized' ) . '', + 'clear' => true, + 'priority' => 45, + ); + + $fields['shipping_address_1']['custom_attributes'] = ( isset( $fields['shipping_address_1']['custom_attributes'] ) ? $fields['shipping_address_1']['custom_attributes'] : array() ); + $fields['shipping_address_1']['custom_attributes']['data-label-dhl'] = self::get_pickup_type_address_label(); + $fields['shipping_address_1']['custom_attributes']['data-label-regular'] = $fields['shipping_address_1']['label']; + $fields['shipping_address_1']['custom_attributes']['data-placeholder-dhl'] = self::get_pickup_type_address_placeholder(); + $fields['shipping_address_1']['custom_attributes']['data-placeholder-regular'] = isset( $fields['shipping_address_1']['placeholder'] ) ? $fields['shipping_address_1']['placeholder'] : ''; + $fields['shipping_address_1']['custom_attributes']['data-desc-dhl'] = self::get_button(); + } + + return $fields; + } + + protected static function get_pickup_type_address_label( $method = false ) { + /** + * Filter to adjust the pickup type address label added + * to the address field when a certain pickup type was chosen. + * + * @param string $pickup_type_text The pickup type text. + * @param boolean|ShippingMethod $method The shipping method object if available. + * + * @since 3.0.0 + * @package Vendidero/Germanized/DHL + */ + return apply_filters( 'woocommerce_gzd_dhl_pickup_type_address_label', self::get_type_text( ' / ', false, $method ), $method ); + } + + protected static function get_pickup_type_address_placeholder( $method = false ) { + /** + * Filter to adjust the pickup type address placeholder added + * to the address field when a certain pickup type was chosen. + * + * @param string $pickup_type_text The pickup type placeholder text. + * @param boolean|ShippingMethod $method The shipping method object if available. + * + * @since 3.0.0 + * @package Vendidero/Germanized/DHL + */ + return apply_filters( 'woocommerce_gzd_dhl_pickup_type_address_placeholder', self::get_street_placeholder( $method ), $method ); + } + + protected static function get_icon( $type = 'packstation' ) { + return Package::get_assets_url() . '/img/' . $type . '.png'; + } + + protected static function get_button_text( $method = false ) { + $text = sprintf( _x( 'Search %s', 'dhl', 'woocommerce-germanized' ), self::get_type_text( '', true, $method ) ); + + return $text; + } + + protected static function get_button( $method = false ) { + $text = self::get_button_text( $method ); + + if ( self::has_map() ) { + return '' . $text . ''; + } else { + return '' . $text . ''; + } + } + + protected static function get_pickup_locator_link() { + return 'https://www.dhl.de/de/privatkunden/dhl-standorte-finden.html'; + } + + public static function add_button() { + echo self::get_button(); + } + + public static function add_form() { + + if ( ! is_checkout() && ! is_wc_endpoint_url( 'edit-address' ) ) { + return; + } + + $args = array( + 'img_packstation' => self::get_icon( 'packstation' ), + 'img_postoffice' => self::get_icon( 'post_office' ), + 'img_parcelshop' => self::get_icon( 'parcelshop' ), + 'is_packstation_enabled' => self::is_packstation_enabled(), + 'is_postoffice_enabled' => self::is_postoffice_enabled(), + 'is_parcelshop_enabled' => self::is_parcelshop_enabled(), + ); + + wc_get_template( 'checkout/dhl/parcel-finder.php', $args, Package::get_template_path(), Package::get_path() . '/templates/' ); + } + + public static function ajax_refresh_shipping_data() { + check_ajax_referer( 'dhl-parcel-locator-shipping-data', 'security' ); + + wp_send_json( array( + 'methods' => self::get_shipping_method_data( true ), + 'success' => true, + ) ); + } + + public static function ajax_validate_address() { + + check_ajax_referer( 'dhl-parcel-locator', 'security' ); + + $country = isset( $_POST['country'] ) ? wc_clean( $_POST['country'] ) : Package::get_base_country(); + $postcode = isset( $_POST['postcode'] ) ? wc_clean( $_POST['postcode'] ) : ''; + $city = isset( $_POST['city'] ) ? wc_clean( $_POST['city'] ) : ''; + $address = isset( $_POST['address'] ) ? wc_clean( $_POST['address'] ) : ''; + + wp_send_json( array( + 'valid' => true, + 'address' => $address, + 'success' => true, + ) ); + } + + public static function ajax_search() { + + check_ajax_referer( 'dhl-parcel-finder', 'security' ); + + $parcelfinder_country = isset( $_POST['dhl_parcelfinder_country'] ) ? wc_clean( $_POST['dhl_parcelfinder_country'] ) : Package::get_base_country(); + $parcelfinder_postcode = isset( $_POST['dhl_parcelfinder_postcode'] ) ? wc_clean( $_POST['dhl_parcelfinder_postcode'] ) : ''; + $parcelfinder_city = isset( $_POST['dhl_parcelfinder_city'] ) ? wc_clean( $_POST['dhl_parcelfinder_city'] ) : ''; + $parcelfinder_address = isset( $_POST['dhl_parcelfinder_address'] ) ? wc_clean( $_POST['dhl_parcelfinder_address'] ) : ''; + + $packstation_filter = wc_string_to_bool( isset( $_POST['dhl_parcelfinder_packstation_filter'] ) ? wc_clean( $_POST['dhl_parcelfinder_packstation_filter'] ) : 'no' ); + $parcelshop_filter = wc_string_to_bool( isset( $_POST['dhl_parcelfinder_parcelshop_filter'] ) ? wc_clean( $_POST['dhl_parcelfinder_parcelshop_filter'] ) : 'no' ); + $postoffice_filter = wc_string_to_bool( isset( $_POST['dhl_parcelfinder_postoffice_filter'] ) ? wc_clean( $_POST['dhl_parcelfinder_postoffice_filter'] ) : 'no' ); + + try { + $args = array( + 'address' => $parcelfinder_address, + 'zip' => $parcelfinder_postcode, + 'city' => $parcelfinder_city, + 'country' => empty( $parcelfinder_country ) ? Package::get_base_country() : $parcelfinder_country, + ); + + $error = new WP_Error(); + $types = array(); + + if ( $packstation_filter && self::is_packstation_enabled() ) { + $types[] = 'packstation'; + } + + if ( $parcelshop_filter && self::is_parcelshop_enabled() ) { + $types[] = 'parcelshop'; + } + + if ( $postoffice_filter && self::is_postoffice_enabled() ) { + $types[] = 'postoffice'; + } + + $parcel_res = Package::get_api()->get_parcel_location( $args, $types ); + + if ( empty( $parcel_res ) ) { + $error->add( 404, _x( 'No DHL locations found', 'dhl', 'woocommerce-germanized' ) ); + } + + if ( ! wc_gzd_dhl_wp_error_has_errors( $error ) ) { + wp_send_json( array( + 'parcel_shops' => $parcel_res, + 'success' => true, + ) ); + } else { + wp_send_json( array( + 'success' => false, + 'messages' => $error->get_error_messages(), + ) ); + } + } catch ( Exception $e ) { + $error = sprintf( _x( 'There was an error while communicating with DHL. Please manually find a %s or %s.', 'dhl', 'woocommerce-germanized' ), '' . _x( 'DHL location', 'dhl', 'woocommerce-germanized' ) . '', '' . _x( 'retry', 'dhl', 'woocommerce-germanized' ) . '' ); + + wp_send_json( array( + 'success' => false, + 'message' => Package::is_debug_mode() ? $e->getMessage() : $error, + ) ); + } + + wp_die(); + } +} diff --git a/packages/woocommerce-germanized-dhl/src/ParcelServices.php b/packages/woocommerce-germanized-dhl/src/ParcelServices.php new file mode 100644 index 000000000..dd42d058a --- /dev/null +++ b/packages/woocommerce-germanized-dhl/src/ParcelServices.php @@ -0,0 +1,394 @@ +has_preferred_day() ) { + $new_rows['preferred_day'] = array( + 'label' => _x( 'Preferred Day', 'dhl', 'woocommerce-germanized' ), + 'value' => wc_format_datetime( $dhl_order->get_preferred_day(), wc_date_format() ), + ); + } + + if ( $dhl_order->has_preferred_time() ) { + $new_rows['preferred_time'] = array( + 'label' => _x( 'Preferred Time', 'dhl', 'woocommerce-germanized' ), + 'value' => $dhl_order->get_preferred_time(), + ); + } + + if ( $dhl_order->has_preferred_location() ) { + $new_rows['preferred_location'] = array( + 'label' => _x( 'Preferred Location', 'dhl', 'woocommerce-germanized' ), + 'value' => $dhl_order->get_preferred_location(), + ); + } elseif( $dhl_order->has_preferred_neighbor() ) { + $new_rows['preferred_neighbor'] = array( + 'label' => _x( 'Preferred Neighbor', 'dhl', 'woocommerce-germanized' ), + 'value' => $dhl_order->get_preferred_neighbor_formatted_address(), + ); + } + } + + if ( ! empty( $new_rows ) ) { + + // Instert before payment method + $insert_before = array_search( 'payment_method', array_keys( $total_rows ) ); + + // If no payment method, insert before order total + if ( empty( $insert_before ) ) { + $insert_before = array_search( 'order_total', array_keys( $total_rows ) ); + } + + if ( empty( $insert_before ) ) { + $total_rows += $new_rows; + } else { + $first_array = array_splice( $total_rows, 0, $insert_before ); + $total_rows = array_merge( $first_array, $new_rows, $total_rows ); + } + } + + return $total_rows; + } + + public static function create_order( $order ) { + $posted_data = $_POST; + + if ( self::is_preferred_available() ) { + $data = self::get_data( $posted_data ); + + if ( ! wc_gzd_dhl_wp_error_has_errors( $data['errors'] ) ) { + $dhl_order = new Order( $order ); + + if ( ! empty( $data['preferred_day'] ) ) { + $dhl_order->set_preferred_day( $data['preferred_day'] ); + } + + if ( 'place' === $data['preferred_location_type'] && ! empty( $data['preferred_location'] ) ) { + $dhl_order->set_preferred_location( $data['preferred_location'] ); + } elseif ( 'neighbor' === $data['preferred_location_type'] && ! empty( $data['preferred_location_neighbor_name'] ) && ! empty( $data['preferred_location_neighbor_address'] ) ) { + $dhl_order->set_preferred_neighbor( $data['preferred_location_neighbor_name'] ); + $dhl_order->set_preferred_neighbor_address( $data['preferred_location_neighbor_address'] ); + } + } + } + } + + public static function validate( $data, $errors ) { + $posted_data = $_POST; + + if ( self::is_preferred_available() ) { + $data = self::get_data( $posted_data ); + + if ( wc_gzd_dhl_wp_error_has_errors( $data['errors'] ) ) { + foreach( $data['errors']->get_error_messages() as $message ) { + $errors->add( 'validation', $message ); + } + } + } + } + + /** + * @param \WC_Cart $cart + */ + public static function add_fees( $cart ) { + if ( ! $_POST || ( is_admin() && ! is_ajax() ) ) { + return; + } + + // POST information is either in a query string-like variable called 'post_data'... + if ( isset( $_POST['post_data'] ) ) { + parse_str( $_POST['post_data'], $post_data ); + } else { + $post_data = $_POST; + } + + if ( self::is_preferred_available( true ) ) { + $data = self::get_data( $post_data ); + + try { + if ( ! empty( $data['preferred_day'] ) ) { + if ( ! empty( $data['preferred_day_cost'] ) ) { + $cart->add_fee( _x( 'DHL Preferred Day', 'dhl', 'woocommerce-germanized' ), $data['preferred_day_cost'], true ); + } + } + } catch ( Exception $e ) {} + } + } + + public static function add_scripts() { + + // load scripts on checkout page only + if ( ! is_checkout() ) { + return; + } + + $deps = array( 'jquery', 'wc-checkout', 'jquery-tiptip' ); + $suffix = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min'; + + wp_register_script( 'jquery-tiptip', WC()->plugin_url() . '/assets/js/jquery-tiptip/jquery.tipTip' . $suffix . '.js', array( 'jquery' ), WC_VERSION, true ); + wp_register_script( 'wc-gzd-preferred-services-dhl', Package::get_assets_url() . '/js/preferred-services' . $suffix . '.js', $deps, Package::get_version(), true ); + wp_register_style( 'wc-gzd-preferred-services-dhl', Package::get_assets_url() . '/css/preferred-services' . $suffix . '.css', array(), Package::get_version() ); + + $excluded_gateways = self::get_excluded_payment_gateways(); + + wp_localize_script( 'wc-gzd-preferred-services-dhl', 'wc_gzd_dhl_preferred_services_params', array( + 'ajax_url' => admin_url( 'admin-ajax.php' ), + 'payment_gateways_excluded' => empty( $excluded_gateways ) ? false : true, + ) ); + + wp_enqueue_script( 'wc-gzd-preferred-services-dhl' ); + wp_enqueue_style( 'wc-gzd-preferred-services-dhl' ); + } + + protected static function get_excluded_payment_gateways() { + return (array) self::get_setting( 'payment_gateways_excluded' ); + } + protected static function payment_gateway_supports_services( $method ) { + $methods = self::get_excluded_payment_gateways(); + + if ( ! empty( $methods ) && in_array( $method, $methods ) ) { + return false; + } + + return true; + } + + protected static function get_preferred_day_cost() { + $cost = self::get_setting( 'PreferredDay_cost' ); + + if ( empty( $cost ) ) { + $cost = 0; + } + + return $cost; + } + + public static function is_preferred_day_excluded( $day ) { + if ( 'yes' === self::get_setting( 'PreferredDay_exclusion_' . $day ) ) { + return true; + } + + return false; + } + + public static function get_preferred_day_cutoff_time() { + $time = self::get_setting( 'PreferredDay_cutoff_time' ); + + return $time; + } + + public static function get_preferred_day_preparation_days() { + $days = self::get_setting( 'PreferredDay_preparation_days' ); + + if ( empty( $days ) || $days < 0 ) { + $days = 0; + } + + return $days; + } + + protected static function is_preferred_enabled() { + return self::is_preferred_day_enabled() || self::is_preferred_location_enabled() || self::is_preferred_neighbor_enabled(); + } + + protected static function is_preferred_available( $check_day_transfer = false ) { + $customer_country = WC()->customer->get_shipping_country(); + $chosen_payment_method = (array) WC()->session->get( 'chosen_payment_method' ); + $display_preferred = false; + + // Preferred options are only for Germany customers + if ( self::is_enabled() && 'DE' === $customer_country ) { + + if ( self::is_preferred_enabled() ) { + $display_preferred = true; + } + + foreach( $chosen_payment_method as $key => $method ) { + if ( ! self::payment_gateway_supports_services( $method ) ) { + $display_preferred = false; + break; + } + } + } + + return $display_preferred; + } + + protected static function get_data( $post_data ) { + $data = array( + 'preferred_day_enabled' => false, + 'preferred_location_enabled' => false, + 'preferred_neighbor_enabled' => false, + 'preferred_day' => '', + 'preferred_location_type' => 'none', + 'preferred_location' => '', + 'preferred_location_neighbor_name' => '', + 'preferred_location_neighbor_address' => '', + 'preferred_day_options' => WC()->session->get( 'dhl_preferred_day_options' ), + 'preferred_day_cost' => self::get_preferred_day_cost(), + ); + + $data['errors'] = new WP_Error(); + + if ( is_null( $data['preferred_day_options'] ) ) { + self::refresh_day_session(); + $data['preferred_day_options'] = WC()->session->get( 'dhl_preferred_day_options' ); + } + + try { + if ( self::is_preferred_day_enabled() ) { + $data['preferred_day_enabled'] = true; + + if ( isset( $post_data['dhl_preferred_day'] ) && ! empty( $post_data['dhl_preferred_day'] ) ) { + $day = wc_clean( $post_data['dhl_preferred_day'] ); + + if ( wc_gzd_dhl_is_valid_datetime( $day, 'Y-m-d' ) ) { + if ( ! empty( $data['preferred_day_options'] ) ) { + if ( array_key_exists( $day, $data['preferred_day_options'] ) ) { + $data['preferred_day'] = $day; + } + } + } + + if ( empty( $data['preferred_day'] ) ) { + $data['errors']->add( 'validation', _x( 'Sorry, but the preferred day you have chosen is no longer available.', 'dhl', 'woocommerce-germanized' ) ); + } + } + } + + if ( self::is_preferred_neighbor_enabled() ) { + $data['preferred_neighbor_enabled'] = true; + } + + if ( self::is_preferred_location_enabled() ) { + $data['preferred_location_enabled'] = true; + } + + if ( self::is_preferred_location_enabled() || self::is_preferred_neighbor_enabled() ) { + if ( isset( $post_data['dhl_preferred_location_type'] ) && 'none' !== $post_data['dhl_preferred_location_type'] ) { + if ( self::is_preferred_location_enabled() && 'place' === $post_data['dhl_preferred_location_type'] ) { + $location = isset( $post_data['dhl_preferred_location'] ) ? wc_clean( $post_data['dhl_preferred_location'] ) : ''; + + $data['preferred_location_type'] = 'place'; + + if ( ! empty( $location ) ) { + $data['preferred_location'] = $location; + } else { + $data['errors']->add( 'validation', _x( 'Please choose a preferred location.', 'dhl', 'woocommerce-germanized' ) ); + } + } elseif( self::is_preferred_neighbor_enabled() && 'neighbor' === $post_data['dhl_preferred_location_type'] ) { + $name = isset( $post_data['dhl_preferred_location_neighbor_name'] ) ? wc_clean( $post_data['dhl_preferred_location_neighbor_name'] ) : ''; + $address = isset( $post_data['dhl_preferred_location_neighbor_address'] ) ? wc_clean( $post_data['dhl_preferred_location_neighbor_address'] ) : ''; + + $data['preferred_location_type'] = 'neighbor'; + + if ( ! empty( $name ) && ! empty( $address ) ) { + $data['preferred_location_neighbor_name'] = $name; + $data['preferred_location_neighbor_address'] = $address; + } else { + $data['errors']->add( 'validation', _x( 'Please choose name and address of your preferred neighbor.', 'dhl', 'woocommerce-germanized' ) ); + } + } + } + } + + return $data; + } catch( Exception $e ) { + return $data; + } + } + + protected static function refresh_day_session() { + WC()->session->set( 'dhl_preferred_day_options', array() ); + + if ( self::is_preferred_day_enabled() ) { + $shipping_postcode = WC()->customer->get_shipping_postcode(); + + try { + if ( ! empty( $shipping_postcode ) ) { + WC()->session->set( 'dhl_preferred_day_options', Package::get_api()->get_preferred_available_days( $shipping_postcode ) ); + } + } catch( Exception $e ) {} + } + } + + public static function add_fields() { + $post_data = array(); + + if ( isset( $_POST['post_data'] ) ) { + parse_str( $_POST['post_data'], $post_data ); + } + + if ( self::is_preferred_available( true ) ) { + $data = self::get_data( $post_data ); + + self::refresh_day_session(); + + $data['preferred_day_options'] = WC()->session->get( 'dhl_preferred_day_options' ); + $data['logo_url'] = Package::get_assets_url() . '/img/dhl-official.png'; + + wc_get_template( 'checkout/dhl/preferred-services.php', $data, Package::get_template_path(), Package::get_path() . '/templates/' ); + } + } + + public static function is_enabled() { + return Package::base_country_supports( 'services' ); + } + + public static function is_preferred_day_enabled() { + return wc_string_to_bool( self::get_setting( 'PreferredDay_enable' ) ); + } + + public static function is_preferred_time_enabled() { + return wc_string_to_bool( self::get_setting( 'PreferredTime_enable' ) ); + } + + public static function is_preferred_location_enabled() { + return wc_string_to_bool( self::get_setting( 'PreferredLocation_enable' ) ); + } + + public static function is_preferred_neighbor_enabled() { + return wc_string_to_bool( self::get_setting( 'PreferredNeighbour_enable' ) ); + } + + protected static function get_setting( $key ) { + + if ( strpos( $key, 'Preferred' ) === false ) { + $key = 'preferred_' . $key; + } + + if ( $method = wc_gzd_dhl_get_current_shipping_method() ) { + if ( $method->has_option( $key ) ) { + return $method->get_option( $key ); + } elseif( strpos( $key, '_enable' ) !== false ) { + return false; + } + } + + $setting = Package::get_setting( $key ); + + return $setting; + } +} diff --git a/packages/woocommerce-germanized-dhl/src/Product.php b/packages/woocommerce-germanized-dhl/src/Product.php new file mode 100644 index 000000000..f48795e64 --- /dev/null +++ b/packages/woocommerce-germanized-dhl/src/Product.php @@ -0,0 +1,100 @@ +product = $product; + } + + /** + * Returns the Woo WC_Product original object + * + * @return object|WC_Product + */ + public function get_product() { + return $this->product; + } + + protected function get_forced_parent_product() { + if ( $this->product->is_type( 'variation' ) ) { + return wc_get_product( $this->product->get_parent_id() ); + } + + return $this->product; + } + + public function get_hs_code() { + return $this->get_forced_parent_product()->get_meta( '_dhl_hs_code', true ); + } + + public function get_manufacture_country() { + return $this->get_forced_parent_product()->get_meta( '_dhl_manufacture_country', true ); + } + + public function get_main_category() { + $ids = $this->get_forced_parent_product()->get_category_ids(); + $term_name = ''; + + if ( ! empty( $ids ) ) { + foreach ( $ids as $term_id ) { + $term = get_term( $term_id, 'product_cat' ); + + if ( empty( $term->slug ) ) { + continue; + } + + $term_name = $term->name; + break; + } + } + + return $term_name; + } + + public function set_hs_code( $code ) { + $this->product->update_meta_data( '_dhl_hs_code', $code ); + } + + public function set_manufacture_country( $country ) { + $this->product->update_meta_data( '_dhl_manufacture_country', $country ); + } + + /** + * Call child methods if the method does not exist. + * + * @param $method + * @param $args + * + * @return bool|mixed + */ + public function __call( $method, $args ) { + + if ( method_exists( $this->product, $method ) ) { + return call_user_func_array( array( $this->product, $method ), $args ); + } + + return false; + } +} diff --git a/packages/woocommerce-germanized-dhl/src/ShippingProvider/DHL.php b/packages/woocommerce-germanized-dhl/src/ShippingProvider/DHL.php new file mode 100644 index 000000000..e35ec63d1 --- /dev/null +++ b/packages/woocommerce-germanized-dhl/src/ShippingProvider/DHL.php @@ -0,0 +1,1709 @@ +get_meta( 'sandbox_mode', true ); + } + + public function get_customer_number() { + return $this->get_meta( 'account_number', true ); + } + + public function get_label_classname( $type ) { + if ( 'return' === $type ) { + return '\Vendidero\Germanized\DHL\Label\DHLReturn'; + } elseif ( 'inlay_return' === $type ) { + return '\Vendidero\Germanized\DHL\Label\DHLInlayReturn'; + } else { + return '\Vendidero\Germanized\DHL\Label\DHL'; + } + } + + public function supports_labels( $label_type, $shipment = false ) { + $label_types = array( 'simple' ); + + if ( $this->enable_retoure() ) { + $label_types[] = 'return'; + } + + return in_array( $label_type, $label_types ); + } + + public function supports_customer_return_requests() { + return $this->enable_retoure(); + } + + /** + * Some providers (e.g. DHL) create return labels automatically and the return + * address is chosen dynamically depending on the country. For that reason the return address + * might not show up within emails or in customer panel. + * + * @return bool + */ + public function hide_return_address() { + return false; + } + + public function get_api_username( $context = 'view' ) { + return $this->get_meta( 'api_username', true, $context ); + } + + public function set_api_username( $username ) { + $this->update_meta_data( 'api_username', strtolower( $username ) ); + } + + public function get_label_retoure_enable( $context = 'view' ) { + return wc_string_to_bool( $this->get_meta( 'label_retoure_enable', true, $context ) ); + } + + public function set_label_retoure_enable( $enable ) { + $this->update_meta_data( 'label_retoure_enable', wc_bool_to_string( $enable ) ); + } + + public function get_retoure_receiver_ids( $context = 'view' ) { + $ids = (array) $this->get_meta( 'retoure_receiver_ids', true, $context ); + + return array_filter( $ids ); + } + + public function set_retoure_receiver_ids( $ids ) { + $this->update_meta_data( 'retoure_receiver_ids', array_filter( (array) $ids ) ); + } + + public function get_api_sandbox_username( $context = 'view' ) { + return $this->get_meta( 'api_sandbox_username', true, $context ); + } + + public function set_api_sandbox_username( $username ) { + $this->update_meta_data( 'api_sandbox_username', strtolower( $username ) ); + } + + public function get_setting_sections() { + $sections = parent::get_setting_sections(); + + $sections['pickup'] = _x( 'Parcel Pickup', 'dhl', 'woocommerce-germanized' ); + $sections['preferred'] = _x( 'Preferred Services', 'dhl', 'woocommerce-germanized' ); + + return $sections; + } + + /** + * @param \Vendidero\Germanized\Shipments\Shipment $shipment + * + * @return array + */ + protected function get_return_label_fields( $shipment ) { + $default_args = $this->get_default_label_props( $shipment ); + + return array( + array( + 'id' => 'receiver_slug', + 'label' => _x( 'Receiver', 'dhl', 'woocommerce-germanized' ), + 'description' => '', + 'type' => 'select', + 'options' => wc_gzd_dhl_get_return_receivers(), + 'value' => isset( $default_args['receiver_slug'] ) ? $default_args['receiver_slug'] : '', + ) + ); + } + + /** + * @param \Vendidero\Germanized\Shipments\Shipment $shipment + * + * @return array + */ + protected function get_simple_label_fields( $shipment ) { + $settings = parent::get_simple_label_fields( $shipment ); + $dhl_order = wc_gzd_dhl_get_order( $shipment->get_order() ); + $default_args = $this->get_default_label_props( $shipment ); + + if ( $dhl_order->has_cod_payment() ) { + $settings = array_merge( $settings, array( + array( + 'id' => 'cod_total', + 'class' => 'wc_input_decimal', + 'label' => _x( 'COD Amount', 'dhl', 'woocommerce-germanized' ), + 'placeholder' => '', + 'description' => '', + 'value' => isset( $default_args['cod_total'] ) ? $default_args['cod_total'] : '', + 'type' => 'text' + ) + ) ); + } + + if ( Package::is_crossborder_shipment( $shipment->get_country() ) ) { + $settings = array_merge( $settings, array( + array( + 'id' => 'duties', + 'label' => _x( 'Duties', 'dhl', 'woocommerce-germanized' ), + 'description' => '', + 'value' => isset( $default_args['duties'] ) ? $default_args['duties'] : '', + 'options' => wc_gzd_dhl_get_duties(), + 'type' => 'select' + ) + ) ); + } + + $settings = array_merge( $settings, array( + array( + 'id' => 'codeable_address_only', + 'label' => _x( 'Valid address only', 'dhl', 'woocommerce-germanized' ), + 'placeholder' => '', + 'description' => '', + 'type' => 'checkbox', + 'value' => isset( $default_args['codeable_address_only'] ) ? wc_bool_to_string( $default_args['codeable_address_only'] ) : 'no', + 'wrapper_class' => 'form-field-checkbox' + ), + ) ); + + $services = array( + array( + 'id' => 'service_GoGreen', + 'label' => _x( 'GoGreen', 'dhl', 'woocommerce-germanized' ), + 'description' => '', + 'type' => 'checkbox', + 'value' => in_array( 'GoGreen', $default_args['services'] ) ? 'yes' : 'no', + 'wrapper_class' => 'form-field-checkbox', + 'custom_attributes' => wc_gzd_dhl_get_service_product_attributes( 'GoGreen' ) + ), + array( + 'id' => 'service_AdditionalInsurance', + 'label' => _x( 'Additional insurance', 'dhl', 'woocommerce-germanized' ), + 'description' => '', + 'type' => 'checkbox', + 'value' => in_array( 'AdditionalInsurance', $default_args['services'] ) ? 'yes' : 'no', + 'wrapper_class' => 'form-field-checkbox', + 'custom_attributes' => wc_gzd_dhl_get_service_product_attributes( 'AdditionalInsurance' ) + ) + ); + + if ( Package::is_shipping_domestic( $shipment->get_country() ) ) { + $preferred_days = array(); + + try { + $preferred_day_options = Package::get_api()->get_preferred_available_days( $shipment->get_postcode() ); + + if ( $preferred_day_options ) { + $preferred_days = $preferred_day_options; + } + } catch( \Exception $e ) {} + + $settings = array_merge( $settings, array( array( + 'id' => 'preferred_day', + 'label' => _x( 'Preferred Day', 'dhl', 'woocommerce-germanized' ), + 'description' => '', + 'value' => isset( $default_args['preferred_day'] ) ? $default_args['preferred_day'] : '', + 'options' => wc_gzd_dhl_get_preferred_days_select_options( $preferred_days, ( isset( $default_args['preferred_day'] ) ? $default_args['preferred_day'] : '' ) ), + 'type' => 'select' + ) ) ); + + if ( $dhl_order->has_preferred_location() ) { + $settings = array_merge( $settings, array( array( + 'id' => 'preferred_location', + 'label' => _x( 'Preferred Location', 'dhl', 'woocommerce-germanized' ), + 'placeholder' => '', + 'description' => '', + 'value' => isset( $default_args['preferred_location'] ) ? $default_args['preferred_location'] : '', + 'custom_attributes' => array( 'maxlength' => '80' ), + 'type' => 'text' + ) ) ); + } + + if ( $dhl_order->has_preferred_neighbor() ) { + $settings = array_merge( $settings, array( array( + 'id' => 'preferred_neighbor', + 'label' => _x( 'Preferred Neighbor', 'dhl', 'woocommerce-germanized' ), + 'placeholder' => '', + 'description' => '', + 'value' => isset( $default_args['preferred_neighbor'] ) ? $default_args['preferred_neighbor'] : '', + 'custom_attributes' => array( 'maxlength' => '80' ), + 'type' => 'text' + ) ) ); + } + + $settings = array_merge( $settings, array( + array( + 'id' => 'has_inlay_return', + 'label' => _x( 'Create inlay return label', 'dhl', 'woocommerce-germanized' ), + 'class' => 'checkbox show-if-trigger', + 'custom_attributes' => array( 'data-show-if' => '.show-if-has-return' ), + 'desc_tip' => true, + 'value' => isset( $default_args['has_inlay_return'] ) ? wc_bool_to_string( $default_args['has_inlay_return'] ) : 'no', + 'wrapper_class' => 'form-field-checkbox', + 'type' => 'checkbox' + ), + array( + 'id' => 'return_address[name]', + 'label' => _x( 'Name', 'dhl', 'woocommerce-germanized' ), + 'placeholder' => '', + 'description' => '', + 'value' => isset( $default_args['return_address']['name'] ) ? $default_args['return_address']['name'] : '', + 'type' => 'text', + 'wrapper_class' => 'show-if-has-return', + ), + array( + 'id' => 'return_address[company]', + 'label' => _x( 'Company', 'dhl', 'woocommerce-germanized' ), + 'placeholder' => '', + 'description' => '', + 'wrapper_class' => 'show-if-has-return', + 'type' => 'text', + 'value' => isset( $default_args['return_address']['company'] ) ? $default_args['return_address']['company'] : '', + ), + array( + 'id' => '', + 'type' => 'columns', + ), + array( + 'id' => 'return_address[street]', + 'label' => _x( 'Street', 'dhl', 'woocommerce-germanized' ), + 'placeholder' => '', + 'description' => '', + 'type' => 'text', + 'wrapper_class' => 'show-if-has-return column col-9', + 'value' => isset( $default_args['return_address']['street'] ) ? $default_args['return_address']['street'] : '', + ), + array( + 'id' => 'return_address[street_number]', + 'label' => _x( 'Street No', 'dhl', 'woocommerce-germanized' ), + 'placeholder' => '', + 'description' => '', + 'type' => 'text', + 'wrapper_class' => 'show-if-has-return column col-3', + 'value' => isset( $default_args['return_address']['street_number'] ) ? $default_args['return_address']['street_number'] : '', + ), + array( + 'id' => '', + 'type' => 'columns', + ), + array( + 'id' => 'return_address[postcode]', + 'label' => _x( 'Postcode', 'dhl', 'woocommerce-germanized' ), + 'placeholder' => '', + 'description' => '', + 'type' => 'text', + 'wrapper_class' => 'show-if-has-return column col-6', + 'value' => isset( $default_args['return_address']['postcode'] ) ? $default_args['return_address']['postcode'] : '', + ), + array( + 'id' => 'return_address[city]', + 'label' => _x( 'City', 'dhl', 'woocommerce-germanized' ), + 'placeholder' => '', + 'description' => '', + 'type' => 'text', + 'wrapper_class' => 'show-if-has-return column col-6', + 'value' => isset( $default_args['return_address']['city'] ) ? $default_args['return_address']['city'] : '', + ), + array( + 'id' => '', + 'type' => 'columns', + ), + array( + 'id' => 'return_address[phone]', + 'label' => _x( 'Phone', 'dhl', 'woocommerce-germanized' ), + 'placeholder' => '', + 'description' => '', + 'type' => 'text', + 'wrapper_class' => 'show-if-has-return column col-6', + 'value' => isset( $default_args['return_address']['phone'] ) ? $default_args['return_address']['phone'] : '', + ), + array( + 'id' => 'return_address[email]', + 'label' => _x( 'Email', 'dhl', 'woocommerce-germanized' ), + 'placeholder' => '', + 'description' => '', + 'type' => 'text', + 'wrapper_class' => 'show-if-has-return column col-6', + 'value' => isset( $default_args['return_address']['email'] ) ? $default_args['return_address']['email'] : '', + ), + array( + 'id' => '', + 'type' => 'columns_end', + ), + ) ); + + $services = array_merge( $services, array( + array( + 'id' => 'visual_min_age', + 'label' => _x( 'Age check', 'dhl', 'woocommerce-germanized' ), + 'description' => '', + 'type' => 'select', + 'value' => isset( $default_args['visual_min_age'] ) ? $default_args['visual_min_age'] : '', + 'options' => wc_gzd_dhl_get_visual_min_ages(), + 'custom_attributes' => wc_gzd_dhl_get_service_product_attributes( 'VisualCheckOfAge' ) + ), + ) ); + + if ( $dhl_order->supports_email_notification() ) { + $services = array_merge( $services, array( + array( + 'id' => 'service_ParcelOutletRouting', + 'label' => _x( 'Retail outlet routing', 'dhl', 'woocommerce-germanized' ), + 'description' => '', + 'type' => 'checkbox', + 'value' => in_array( 'ParcelOutletRouting', $default_args['services'] ) ? 'yes' : 'no', + 'wrapper_class' => 'form-field-checkbox', + 'custom_attributes' => wc_gzd_dhl_get_service_product_attributes( 'ParcelOutletRouting' ) + ) + ) ); + } + + if ( ! $dhl_order->has_preferred_neighbor() ) { + $services = array_merge( $services, array( + array( + 'id' => 'service_NoNeighbourDelivery', + 'label' => _x( 'No neighbor', 'dhl', 'woocommerce-germanized' ), + 'description' => '', + 'type' => 'checkbox', + 'value' => in_array( 'NoNeighbourDelivery', $default_args['services'] ) ? 'yes' : 'no', + 'wrapper_class' => 'form-field-checkbox', + 'custom_attributes' => wc_gzd_dhl_get_service_product_attributes( 'NoNeighbourDelivery' ) + ) + ) ); + } + + $services = array_merge( $services, array( + array( + 'id' => 'service_NamedPersonOnly', + 'label' => _x( 'Named person only', 'dhl', 'woocommerce-germanized' ), + 'description' => '', + 'type' => 'checkbox', + 'value' => in_array( 'NamedPersonOnly', $default_args['services'] ) ? 'yes' : 'no', + 'wrapper_class' => 'form-field-checkbox', + 'custom_attributes' => wc_gzd_dhl_get_service_product_attributes( 'NamedPersonOnly' ) + ), + array( + 'id' => 'service_BulkyGoods', + 'label' => _x( 'Bulky goods', 'dhl', 'woocommerce-germanized' ), + 'description' => '', + 'type' => 'checkbox', + 'value' => in_array( 'BulkyGoods', $default_args['services'] ) ? 'yes' : 'no', + 'wrapper_class' => 'form-field-checkbox', + 'custom_attributes' => wc_gzd_dhl_get_service_product_attributes( 'BulkyGoods' ) + ), + array( + 'id' => 'service_IdentCheck', + 'label' => _x( 'Identity check', 'dhl', 'woocommerce-germanized' ), + 'description' => '', + 'type' => 'checkbox', + 'class' => 'checkbox show-if-trigger', + 'value' => in_array( 'IdentCheck', $default_args['services'] ) ? 'yes' : 'no', + 'custom_attributes' => array_merge( array( 'data-show-if' => '.show-if-ident-check' ), wc_gzd_dhl_get_service_product_attributes( 'IdentCheck' ) ), + 'wrapper_class' => 'form-field-checkbox', + ), + array( + 'id' => '', + 'type' => 'columns', + ), + array( + 'id' => 'ident_date_of_birth', + 'label' => _x( 'Date of Birth', 'dhl', 'woocommerce-germanized' ), + 'placeholder' => '', + 'description' => '', + 'value' => isset( $default_args['ident_date_of_birth'] ) ? $default_args['ident_date_of_birth'] : '', + 'custom_attributes' => array( 'pattern' => '[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|1[0-9]|2[0-9]|3[01])', 'maxlength' => 10 ), + 'class' => 'short date-picker', + 'wrapper_class' => 'show-if-ident-check column col-6', + 'type' => 'text', + ), + array( + 'id' => 'ident_min_age', + 'label' => _x( 'Minimum age', 'dhl', 'woocommerce-germanized' ), + 'description' => '', + 'wrapper_class' => 'show-if-ident-check column col-6', + 'type' => 'select', + 'value' => isset( $default_args['ident_min_age'] ) ? $default_args['ident_min_age'] : '', + 'options' => wc_gzd_dhl_get_ident_min_ages(), + ), + array( + 'id' => '', + 'type' => 'columns_end', + ), + ) ); + } elseif( Package::is_crossborder_shipment( $shipment->get_country() ) ) { + $services = array_merge( $services, array( + array( + 'id' => 'service_Premium', + 'label' => _x( 'Premium', 'dhl', 'woocommerce-germanized' ), + 'description' => '', + 'value' => in_array( 'Premium', $default_args['services'] ) ? 'yes' : 'no', + 'wrapper_class' => 'form-field-checkbox', + 'type' => 'checkbox', + 'custom_attributes' => wc_gzd_dhl_get_service_product_attributes( 'Premium' ) + ) + ) ); + } + + $settings[] = array( + 'type' => 'services_start', + 'id' => '', + ); + + $settings = array_merge( $settings, $services ); + + return $settings; + } + + public function get_participation_number( $product ) { + return $this->get_setting( 'participation_' . $product, '' ); + } + + public function enable_retoure() { + return $this->get_label_retoure_enable(); + } + + /** + * @param Shipment $shipment + * @param $props + * + * @return \WP_Error|mixed + */ + protected function validate_label_request( $shipment, $props ) { + if ( 'return' === $shipment->get_type() ) { + $props = $this->validate_return_label_args( $shipment, $props ); + } else { + $props = $this->validate_simple_label_args( $shipment, $props ); + } + + return $props; + } + + /** + * @param Shipment $shipment + * @param $args + * + * @return \WP_Error|mixed + */ + protected function validate_return_label_args( $shipment, $args = array() ) { + $args = wp_parse_args( $args, array( + 'receiver_slug' => '', + ) ); + + $error = new \WP_Error(); + + $args['receiver_slug'] = sanitize_key( $args['receiver_slug'] ); + + if ( empty( $args['receiver_slug'] ) ) { + $error->add( 500, _x( 'Receiver is missing or does not exist.', 'dhl', 'woocommerce-germanized' ) ); + } + + if ( wc_gzd_dhl_wp_error_has_errors( $error ) ) { + return $error; + } + + return $args; + } + + /** + * @param Shipment $shipment + * @param $args + * + * @return \WP_Error|mixed + */ + protected function validate_simple_label_args( $shipment, $args = array() ) { + $args = wp_parse_args( $args, array( + 'preferred_day' => '', + 'preferred_location' => '', + 'preferred_neighbor' => '', + 'ident_date_of_birth' => '', + 'ident_min_age' => '', + 'visual_min_age' => '', + 'has_inlay_return' => 'no', + 'cod_total' => 0, + 'product_id' => '', + 'duties' => '', + 'services' => array(), + 'return_address' => array(), + ) ); + + $error = new \WP_Error(); + $dhl_order = wc_gzd_dhl_get_order( $shipment->get_order() ); + + // Do only allow valid services + if ( ! empty( $args['services'] ) ) { + $args['services'] = array_intersect( $args['services'], wc_gzd_dhl_get_services() ); + + foreach( $args['services'] as $key => $service ) { + /** + * Remove services that are not supported for this product + */ + if ( ! wc_gzd_dhl_product_supports_service( $args['product_id'], $service ) ) { + unset( $args['services'][ $key ] ); + } + } + + $args['services'] = array_values( $args['services'] ); + } + + // Check if return address has empty mandatory fields + if ( 'yes' === $args['has_inlay_return'] ) { + $args['return_address'] = wp_parse_args( $args['return_address'], array( + 'name' => '', + 'company' => '', + 'street' => '', + 'street_number' => '', + 'postcode' => '', + 'city' => '', + 'state' => '', + 'country' => Package::get_setting( 'return_country' ), + ) ); + + $mandatory = array( + 'street' => _x( 'Street', 'dhl', 'woocommerce-germanized' ), + 'postcode' => _x( 'Postcode', 'dhl', 'woocommerce-germanized' ), + 'city' => _x( 'City', 'dhl', 'woocommerce-germanized' ), + ); + + foreach( $mandatory as $mand => $title ) { + if ( empty( $args['return_address'][ $mand ] ) ) { + $error->add( 500, sprintf( _x( '%s of the return address is a mandatory field.', 'dhl', 'woocommerce-germanized' ), $title ) ); + } + } + + if ( empty( $args['return_address']['name'] ) && empty( $args['return_address']['company'] ) ) { + $error->add( 500, _x( 'Please either add a return company or name.', 'dhl', 'woocommerce-germanized' ) ); + } + } else { + unset( $args['return_address'] ); + unset( $args['has_inlay_return'] ); + } + + // No cash on delivery available + if ( ( $dhl_order && ! empty( $args['cod_total'] ) && ! $dhl_order->has_cod_payment() ) || empty( $args['cod_total'] ) ) { + unset( $args['cod_total'] ); + } + + if ( $dhl_order && ! empty( $args['cod_total'] ) && $dhl_order->has_cod_payment() && wc_gzd_dhl_product_supports_service( $args['product_id'], 'CashOnDelivery' ) ) { + $args['services'] = array_merge( $args['services'], array( 'CashOnDelivery' ) ); + } + + if ( ! empty( $args['preferred_day'] ) && wc_gzd_dhl_is_valid_datetime( $args['preferred_day'], 'Y-m-d' ) ) { + $args['services'] = array_merge( $args['services'], array( 'PreferredDay' ) ); + } else { + if ( ! empty( $args['preferred_day'] ) && ! wc_gzd_dhl_is_valid_datetime( $args['preferred_day'], 'Y-m-d' ) ) { + $error->add( 500, _x( 'Error while parsing preferred day.', 'dhl', 'woocommerce-germanized' ) ); + } + + $args['services'] = array_diff( $args['services'], array( 'PreferredDay' ) ); + + unset( $args['preferred_day'] ); + } + + if ( ! empty( $args['preferred_location'] ) ) { + $args['services'] = array_merge( $args['services'], array( 'PreferredLocation' ) ); + } else { + $args['services'] = array_diff( $args['services'], array( 'PreferredLocation' ) ); + unset( $args['preferred_location'] ); + } + + if ( ! empty( $args['preferred_neighbor'] ) ) { + $args['services'] = array_merge( $args['services'], array( 'PreferredNeighbour' ) ); + } else { + $args['services'] = array_diff( $args['services'], array( 'PreferredNeighbour' ) ); + unset( $args['preferred_neighbor'] ); + } + + if ( wc_gzd_dhl_product_supports_service( $args['product_id'], 'VisualCheckOfAge' ) ) { + if ( ! empty( $args['visual_min_age'] ) && wc_gzd_dhl_is_valid_visual_min_age( $args['visual_min_age'] ) ) { + $args['services'] = array_merge( $args['services'], array( 'VisualCheckOfAge' ) ); + } else { + if ( ! empty( $args['visual_min_age'] ) && ! wc_gzd_dhl_is_valid_visual_min_age( $args['visual_min_age'] ) ) { + $error->add( 500, _x( 'The visual min age check is invalid.', 'dhl', 'woocommerce-germanized' ) ); + } + + $args['services'] = array_diff( $args['services'], array( 'VisualCheckOfAge' ) ); + unset( $args['visual_min_age'] ); + } + } else { + unset( $args['visual_min_age'] ); + } + + // In case order does not support email notification - remove parcel outlet routing + if ( in_array( 'ParcelOutletRouting', $args['services'] ) ) { + if ( ! $dhl_order || ! $dhl_order->supports_email_notification() ) { + $args['services'] = array_diff( $args['services'], array( 'ParcelOutletRouting' ) ); + } + } + + if ( wc_gzd_dhl_product_supports_service( $args['product_id'], 'IdentCheck' ) ) { + if ( ! empty( $args['ident_min_age'] ) && wc_gzd_dhl_is_valid_ident_min_age( $args['ident_min_age'] ) ) { + $args['services'] = array_merge( $args['services'], array( 'IdentCheck' ) ); + } + + if ( in_array( 'IdentCheck', $args['services'] ) ) { + if ( ! empty( $args['ident_min_age'] ) && ! array_key_exists( $args['ident_min_age'], wc_gzd_dhl_get_ident_min_ages() ) ) { + $error->add( 500, _x( 'The ident min age check is invalid.', 'dhl', 'woocommerce-germanized' ) ); + } + + if ( ! empty( $args['ident_date_of_birth'] ) ) { + if ( ! wc_gzd_dhl_is_valid_datetime( $args['ident_date_of_birth'], 'Y-m-d' ) ) { + $error->add( 500, _x( 'There was an error parsing the date of birth for the identity check.', 'dhl', 'woocommerce-germanized' ) ); + } + } + + if ( empty( $args['ident_date_of_birth'] ) && empty( $args['ident_min_age'] ) ) { + $error->add( 500, _x( 'Either a minimum age or a date of birth must be added to the ident check.', 'dhl', 'woocommerce-germanized' ) ); + } + } else { + unset( $args['ident_min_age'] ); + unset( $args['ident_date_of_birth'] ); + } + } else { + unset( $args['ident_min_age'] ); + unset( $args['ident_date_of_birth'] ); + } + + // We don't need duties for non-cross-border shipments + if ( ! Package::is_crossborder_shipment( $shipment->get_country() ) ) { + unset( $args['duties'] ); + } + + if ( ! empty( $args['duties'] ) && ! array_key_exists( $args['duties'], wc_gzd_dhl_get_duties() ) ) { + $error->add( 500, sprintf( _x( '%s duties element does not exist.', 'dhl', 'woocommerce-germanized' ), $args['duties'] ) ); + } + + if ( wc_gzd_dhl_wp_error_has_errors( $error ) ) { + return $error; + } + + return $args; + } + + /** + * @param Shipment $shipment + * + * @return array + */ + protected function get_default_label_props( $shipment ) { + if ( 'return' === $shipment->get_type() ) { + $dhl_defaults = $this->get_default_return_label_props( $shipment ); + } else { + $dhl_defaults = $this->get_default_simple_label_props( $shipment ); + } + + $defaults = parent::get_default_label_props( $shipment ); + + return array_replace_recursive( $defaults, $dhl_defaults ); + } + + /** + * @param Shipment $shipment + * + * @return array + */ + protected function get_default_return_label_props( $shipment ) { + $defaults = array( + 'services' => array(), + 'receiver_slug' => wc_gzd_dhl_get_default_return_receiver_slug( $shipment->get_sender_country() ), + 'sender_address' => $shipment->get_sender_address(), + ); + + $defaults['sender_address'] = array_merge( $defaults['sender_address'], array( + 'name' => $shipment->get_formatted_sender_full_name(), + 'street' => $shipment->get_sender_address_street(), + 'street_number' => $shipment->get_sender_address_street_number(), + 'street_addition' => $shipment->get_sender_address_street_addition(), + ) ); + + return $defaults; + } + + /** + * @param \Vendidero\Germanized\Shipments\Shipment $shipment + */ + public function get_default_label_product( $shipment ) { + if ( 'simple' === $shipment->get_type() ) { + if ( Package::is_shipping_domestic( $shipment->get_country() ) ) { + return $this->get_shipment_setting( $shipment, 'label_default_product_dom' ); + } else { + return $this->get_shipment_setting( $shipment, 'label_default_product_int' ); + } + } + + return ''; + } + + /** + * @param Shipment $shipment + * + * @return array + */ + protected function get_default_simple_label_props( $shipment ) { + $dhl_order = wc_gzd_dhl_get_order( $shipment->get_order() ); + $product_id = $this->get_default_label_product( $shipment ); + + $defaults = array( + 'services' => array(), + 'codeable_address_only' => $this->get_shipment_setting( $shipment, 'label_address_codeable_only' ), + ); + + if ( $dhl_order && $dhl_order->supports_email_notification() ) { + $defaults['email_notification'] = 'yes'; + } + + if ( $dhl_order && $dhl_order->has_cod_payment() && wc_gzd_dhl_product_supports_service( $product_id, 'CashOnDelivery' ) ) { + $defaults['cod_total'] = $shipment->get_total(); + + /** + * This check is necessary to make sure only one label per order + * has the additional total (shipping total, fee total) added to the COD amount. + */ + $shipments = wc_gzd_get_shipments_by_order( $shipment->get_order_id() ); + $needs_additional_total = true; + + foreach( $shipments as $shipment ) { + if ( $existing_label = wc_gzd_dhl_get_shipment_label( $shipment, 'simple' ) ) { + + if ( $existing_label->cod_includes_additional_total() ) { + $needs_additional_total = false; + break; + } + } + } + + if ( $needs_additional_total ) { + $defaults['cod_total'] += round( $shipment->get_additional_total(), wc_get_price_decimals() ); + $defaults['cod_includes_additional_total'] = true; + } + } + + if ( Package::is_crossborder_shipment( $shipment->get_country() ) ) { + + $defaults['duties'] = $this->get_shipment_setting( $shipment, 'label_default_duty' ); + + } elseif ( Package::is_shipping_domestic( $shipment->get_country() ) ) { + + if ( Package::base_country_supports( 'services' ) ) { + + if ( $dhl_order && $dhl_order->has_preferred_day() ) { + $defaults['preferred_day'] = $dhl_order->get_preferred_day()->format( 'Y-m-d' ); + } + + if ( $dhl_order && $dhl_order->has_preferred_location() ) { + $defaults['preferred_location'] = $dhl_order->get_preferred_location(); + } + + if ( $dhl_order && $dhl_order->has_preferred_neighbor() ) { + $defaults['preferred_neighbor'] = $dhl_order->get_preferred_neighbor_formatted_address(); + } + + if ( wc_gzd_dhl_product_supports_service( $product_id, 'VisualCheckOfAge' ) ) { + $visual_min_age = $this->get_shipment_setting( $shipment, 'label_visual_min_age' ); + + if ( wc_gzd_dhl_is_valid_visual_min_age( $visual_min_age ) ) { + $defaults['services'][] = 'VisualCheckOfAge'; + $defaults['visual_min_age'] = $visual_min_age; + } + + if ( $dhl_order->needs_age_verification() && 'yes' === $this->get_shipment_setting( $shipment, 'label_auto_age_check_sync' ) ) { + $defaults['services'][] = 'VisualCheckOfAge'; + $defaults['visual_min_age'] = $dhl_order->get_min_age(); + } + } + + if ( wc_gzd_dhl_product_supports_service( $product_id, 'IdentCheck' ) ) { + $ident_min_age = $this->get_shipment_setting( $shipment, 'label_ident_min_age' ); + + if ( wc_gzd_dhl_is_valid_ident_min_age( $ident_min_age ) ) { + $defaults['services'][] = 'IdentCheck'; + $defaults['ident_min_age'] = $ident_min_age; + } + + /** + * Sync with order data but only in case no visual age has been synced already. + */ + if ( ! in_array( 'VisualCheckOfAge', $defaults['services'] ) ) { + if ( $dhl_order && $dhl_order->needs_age_verification() && 'yes' === $this->get_shipment_setting( $shipment, 'label_auto_age_check_ident_sync' ) ) { + $defaults['services'][] = 'IdentCheck'; + $defaults['ident_min_age'] = $dhl_order->get_min_age(); + } + } + } + + foreach( wc_gzd_dhl_get_services() as $service ) { + if ( ! wc_gzd_dhl_product_supports_service( $product_id, $service ) ) { + continue; + } + + // Combination is not available + if ( ( ! empty( $defaults['visual_min_age'] ) || ! empty( $defaults['ident_min_age'] ) ) && 'NamedPersonOnly' === $service ) { + continue; + } + + if ( 'yes' === $this->get_shipment_setting( $shipment, 'label_service_' . $service ) ) { + $defaults['services'][] = $service; + } + } + + // Demove duplicates + $defaults['services'] = array_unique( $defaults['services'] ); + } + + if ( Package::base_country_supports( 'returns' ) ) { + + $defaults['return_address'] = array( + 'name' => Package::get_setting( 'return_name' ), + 'company' => Package::get_setting( 'return_company' ), + 'street' => Package::get_setting( 'return_street' ), + 'street_number' => Package::get_setting( 'return_street_number' ), + 'postcode' => Package::get_setting( 'return_postcode' ), + 'city' => Package::get_setting( 'return_city' ), + 'phone' => Package::get_setting( 'return_phone' ), + 'email' => Package::get_setting( 'return_email' ), + ); + + if ( 'yes' === $this->get_shipment_setting( $shipment, 'label_auto_inlay_return_label' ) ) { + $defaults['has_inlay_return'] = 'yes'; + } + } + } + + if ( ! Package::is_shipping_domestic( $shipment->get_country() ) ) { + + foreach( wc_gzd_dhl_get_international_services() as $service ) { + + if ( ! wc_gzd_dhl_product_supports_service( $product_id, $service ) ) { + continue; + } + + if ( 'yes' === $this->get_shipment_setting( $shipment, 'label_service_' . $service ) ) { + $defaults['services'][] = $service; + } + } + + // Demove duplicates + $defaults['services'] = array_unique( $defaults['services'] ); + } + + return $defaults; + } + + /** + * @param \Vendidero\Germanized\Shipments\Shipment $shipment + */ + public function get_available_label_products( $shipment ) { + return wc_gzd_dhl_get_products( $shipment->get_country() ); + } + + /** + * @param \Vendidero\Germanized\Shipments\Shipment $shipment + */ + public function get_available_label_services( $shipment ) { + return wc_gzd_dhl_get_services(); + } + + protected function get_available_base_countries() { + return Package::get_available_countries(); + } + + protected function get_general_settings() { + $settings = array( + array( 'title' => '', 'type' => 'title', 'id' => 'dhl_general_options' ), + + array( + 'title' => _x( 'Customer Number (EKP)', 'dhl', 'woocommerce-germanized' ), + 'type' => 'text', + 'desc' => '
' . sprintf( _x( 'Your 10 digits DHL customer number, also called "EKP". Find your %s in the DHL business portal.', 'dhl', 'woocommerce-germanized' ), '' . _x( 'customer number', 'dhl', 'woocommerce-germanized' ) . '' ) . '
',
+ 'id' => 'account_number',
+ 'value' => $this->get_setting( 'account_number', '' ),
+ 'placeholder' => '1234567890',
+ 'custom_attributes' => array( 'maxlength' => '10' )
+ ),
+
+ array( 'type' => 'sectionend', 'id' => 'dhl_general_options' ),
+
+ array( 'title' => _x( 'API', 'dhl', 'woocommerce-germanized' ), 'type' => 'title', 'id' => 'dhl_api_options' ),
+
+ array(
+ 'title' => _x( 'Enable Sandbox', 'dhl', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Activate Sandbox mode for testing purposes.', 'dhl', 'woocommerce-germanized' ),
+ 'id' => 'sandbox_mode',
+ 'value' => wc_bool_to_string( $this->get_setting( 'sandbox_mode', 'no' ) ),
+ 'type' => 'gzd_toggle',
+ ),
+
+ array(
+ 'title' => _x( 'Live Username', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'desc' => '' . sprintf( _x( 'Your username (not your email address) to the DHL business customer portal. Please make sure to test your access data in advance %s.', 'dhl', 'woocommerce-germanized' ), '' . _x( 'here', 'dhl', 'woocommerce-germanized' ) . '' ) . '
',
+ 'id' => 'api_username',
+ 'default' => '',
+ 'value' => $this->get_setting( 'api_username', '' ),
+ 'custom_attributes' => array( 'data-show_if_sandbox_mode' => 'no', 'autocomplete' => 'new-password' )
+ ),
+
+ array(
+ 'title' => _x( 'Live Password', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'password',
+ 'desc' => '' . sprintf( _x( 'Your password to the DHL business customer portal. Please note the new assignment of the password to 3 (Standard User) or 12 (System User) months and make sure to test your access data in advance %s.', 'dhl', 'woocommerce-germanized' ), '' . _x( 'here', 'dhl', 'woocommerce-germanized' ) .'' ) . '
',
+ 'id' => 'api_password',
+ 'value' => $this->get_setting( 'api_password', '' ),
+ 'custom_attributes' => array( 'data-show_if_sandbox_mode' => 'no', 'autocomplete' => 'new-password' )
+ ),
+
+ array(
+ 'title' => _x( 'Sandbox Username', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'desc' => '' . sprintf( _x( 'Your username (not your email address) to the DHL developer portal. Please make sure to test your access data in advance %s.', 'dhl', 'woocommerce-germanized' ), '' . _x( 'here', 'dhl', 'woocommerce-germanized' ) . '' ) . '
',
+ 'id' => 'api_sandbox_username',
+ 'value' => $this->get_setting( 'api_sandbox_username', '' ),
+ 'custom_attributes' => array( 'data-show_if_sandbox_mode' => '', 'autocomplete' => 'new-password' )
+ ),
+
+ array(
+ 'title' => _x( 'Sandbox Password', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'password',
+ 'desc' => '' . sprintf( _x( 'Your password for the DHL developer portal. Please test your access data in advance %s.', 'dhl', 'woocommerce-germanized' ), '' . _x( 'here', 'dhl', 'woocommerce-germanized' ) .'' ) . '
',
+ 'id' => 'api_sandbox_password',
+ 'value' => $this->get_setting( 'api_sandbox_password', '' ),
+ 'custom_attributes' => array( 'data-show_if_sandbox_mode' => '', 'autocomplete' => 'new-password' )
+ ),
+
+ array( 'type' => 'sectionend', 'id' => 'dhl_api_options' ),
+
+ array( 'title' => _x( 'Products and Participation Numbers', 'dhl', 'woocommerce-germanized' ), 'type' => 'title', 'id' => 'dhl_api_options' ),
+ );
+
+ $dhl_products = array();
+
+ foreach( ( wc_gzd_dhl_get_products_domestic() + wc_gzd_dhl_get_products_international() ) as $product => $title ) {
+ $dhl_products[] = array(
+ 'title' => $title,
+ 'type' => 'text',
+ 'id' => 'participation_' . $product,
+ 'default' => '',
+ 'value' => $this->get_setting( 'participation_' . $product, '' ),
+ 'custom_attributes' => array( 'maxlength' => '2' ),
+ );
+ }
+
+ $dhl_products[] = array(
+ 'title' => _x( 'Inlay Returns', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'default' => '',
+ 'value' => $this->get_setting( 'participation_return', '' ),
+ 'custom_attributes' => array( 'maxlength' => '2' ),
+ );
+
+ $settings = array_merge( $settings, $dhl_products );
+
+ $settings = array_merge( $settings, array(
+ array( 'type' => 'sectionend', 'id' => 'dhl_product_options' ),
+ array( 'title' => _x( 'Tracking', 'dhl', 'woocommerce-germanized' ), 'type' => 'title', 'id' => 'tracking_options' ),
+ ) );
+
+ $general_settings = parent::get_general_settings();
+
+ return array_merge( $settings, $general_settings );
+ }
+
+ protected function get_pickup_settings() {
+ $settings = array(
+ array( 'title' => '', 'type' => 'title', 'id' => 'dhl_pickup_options', 'allow_override' => true ),
+
+ array(
+ 'title' => _x( 'Packstation', 'dhl', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Enable delivery to Packstation.', 'dhl', 'woocommerce-germanized' ),
+ 'desc_tip' => _x( 'Let customers choose a Packstation as delivery address.', 'dhl', 'woocommerce-germanized' ),
+ 'id' => 'parcel_pickup_packstation_enable',
+ 'value' => wc_bool_to_string( $this->get_setting( 'parcel_pickup_packstation_enable' ) ),
+ 'default' => 'yes',
+ 'type' => 'gzd_toggle',
+ ),
+
+ array(
+ 'title' => _x( 'Postoffice', 'dhl', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Enable delivery to Post Offices.', 'dhl', 'woocommerce-germanized' ),
+ 'desc_tip' => _x( 'Let customers choose a Post Office as delivery address.', 'dhl', 'woocommerce-germanized' ),
+ 'id' => 'parcel_pickup_postoffice_enable',
+ 'value' => wc_bool_to_string( $this->get_setting( 'parcel_pickup_postoffice_enable' ) ),
+ 'default' => 'yes',
+ 'type' => 'gzd_toggle',
+ ),
+
+ array(
+ 'title' => _x( 'Parcel Shop', 'dhl', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Enable delivery to Parcel Shops.', 'dhl', 'woocommerce-germanized' ),
+ 'desc_tip' => _x( 'Let customers choose a Parcel Shop as delivery address.', 'dhl', 'woocommerce-germanized' ),
+ 'id' => 'parcel_pickup_parcelshop_enable',
+ 'value' => wc_bool_to_string( $this->get_setting( 'parcel_pickup_parcelshop_enable' ) ),
+ 'default' => 'yes',
+ 'type' => 'gzd_toggle',
+ ),
+
+ array(
+ 'title' => _x( 'Map', 'dhl', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Let customers find a DHL location on a map.', 'dhl', 'woocommerce-germanized' ) . '' . _x( 'Enable this option to let your customers choose a pickup option from a map within the checkout. If this option is disabled a link to the DHL website is placed instead.', 'dhl', 'woocommerce-germanized' ) . '
',
+ 'id' => 'parcel_pickup_map_enable',
+ 'value' => wc_bool_to_string( $this->get_setting( 'parcel_pickup_map_enable' ) ),
+ 'default' => 'no',
+ 'type' => 'gzd_toggle',
+ 'allow_override' => false,
+ ),
+
+ array(
+ 'title' => _x( 'Google Maps Key', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'password',
+ 'id' => 'parcel_pickup_map_api_password',
+ 'custom_attributes' => array( 'data-show_if_parcel_pickup_map_enable' => '' ),
+ 'value' => $this->get_setting( 'parcel_pickup_map_api_password' ),
+ 'desc' => '' . sprintf( _x( 'To integrate a map within your checkout you\'ll need a valid API key for Google Maps. You may %s.', 'dhl', 'woocommerce-germanized' ), '' . _x( 'retrieve a new one', 'dhl', 'woocommerce-germanized' ) . '' ) . '
',
+ 'default' => '',
+ 'allow_override' => false,
+ ),
+
+ array(
+ 'title' => _x( 'Limit results', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'number',
+ 'id' => 'parcel_pickup_map_max_results',
+ 'custom_attributes' => array( 'data-show_if_parcel_pickup_map_enable' => '' ),
+ 'value' => $this->get_setting( 'parcel_pickup_map_max_results' ),
+ 'desc_tip' => _x( 'Limit the number of DHL locations shown on the map', 'dhl', 'woocommerce-germanized' ),
+ 'default' => 20,
+ 'css' => 'max-width: 60px;',
+ 'allow_override' => false,
+ ),
+
+ array( 'type' => 'sectionend', 'id' => 'dhl_pickup_options' ),
+ );
+
+ return $settings;
+ }
+
+ protected function get_preferred_settings() {
+ $wc_gateway_titles = array();
+
+ if ( function_exists( 'WC' ) && WC()->payment_gateways() ) {
+ $wc_payment_gateways = WC()->payment_gateways()->payment_gateways();
+ $wc_gateway_titles = wp_list_pluck( $wc_payment_gateways, 'method_title', 'id' );
+ }
+
+ $settings = array(
+ array( 'title' => '', 'type' => 'title', 'id' => 'preferred_options', 'allow_override' => true ),
+
+ array(
+ 'title' => _x( 'Preferred Day', 'dhl', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Enable preferred day delivery.', 'dhl', 'woocommerce-germanized' ) . '' . _x( 'Enabling this option will display options for the user to select their preferred day of delivery during the checkout.', 'dhl', 'woocommerce-germanized' ) . '
',
+ 'id' => 'PreferredDay_enable',
+ 'value' => wc_bool_to_string( $this->get_setting( 'PreferredDay_enable' ) ),
+ 'default' => 'yes',
+ 'type' => 'gzd_toggle',
+ ),
+
+ array(
+ 'title' => _x( 'Fee', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'desc' => _x( 'Insert gross value as surcharge for preferred day delivery. Insert 0 to offer service for free.', 'dhl', 'woocommerce-germanized' ),
+ 'desc_tip' => true,
+ 'id' => 'PreferredDay_cost',
+ 'value' => $this->get_setting( 'PreferredDay_cost' ),
+ 'default' => '1.2',
+ 'css' => 'max-width: 60px;',
+ 'class' => 'wc_input_decimal',
+ 'custom_attributes' => array( 'data-show_if_woocommerce_gzd_dhl_PreferredDay_enable' => '' )
+ ),
+
+ array(
+ 'title' => _x( 'Preferred Location', 'dhl', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Enable preferred location delivery.', 'dhl', 'woocommerce-germanized' ) . '' . _x( 'Enabling this option will display options for the user to select their preferred delivery location during the checkout.', 'dhl', 'woocommerce-germanized' ) . '
',
+ 'id' => 'PreferredLocation_enable',
+ 'value' => wc_bool_to_string( $this->get_setting( 'PreferredLocation_enable' ) ),
+ 'default' => 'yes',
+ 'type' => 'gzd_toggle',
+ ),
+
+ array(
+ 'title' => _x( 'Preferred Neighbor', 'dhl', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Enable preferred neighbor delivery.', 'dhl', 'woocommerce-germanized' ) . '' . _x( 'Enabling this option will display options for the user to deliver to their preferred neighbor during the checkout.', 'dhl', 'woocommerce-germanized' ) . '
',
+ 'id' => 'PreferredNeighbour_enable',
+ 'value' => wc_bool_to_string( $this->get_setting( 'PreferredNeighbour_enable' ) ),
+ 'default' => 'yes',
+ 'type' => 'gzd_toggle',
+ ),
+
+ array(
+ 'title' => _x( 'Cut-off time', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'time',
+ 'id' => 'PreferredDay_cutoff_time',
+ 'allow_override' => false,
+ 'value' => $this->get_setting( 'PreferredDay_cutoff_time' ),
+ 'desc' => '' . _x( 'The cut-off time is the latest possible order time up to which the minimum preferred day (day of order + 2 working days) can be guaranteed. As soon as the time is exceeded, the earliest preferred day displayed in the frontend will be shifted to one day later (day of order + 3 working days).', 'dhl', 'woocommerce-germanized' ) . '
',
+ 'default' => '12:00',
+ 'custom_attributes' => array( 'data-show_if_woocommerce_gzd_dhl_PreferredDay_enable' => '' )
+ ),
+
+ array(
+ 'title' => _x( 'Preparation days', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'number',
+ 'id' => 'PreferredDay_preparation_days',
+ 'allow_override' => false,
+ 'value' => $this->get_setting( 'PreferredDay_preparation_days' ),
+ 'desc' => '' . _x( 'If you need more time to prepare your shipments you might want to add a static preparation time to the possible starting date for preferred day delivery.', 'dhl', 'woocommerce-germanized' ) . '
',
+ 'default' => '0',
+ 'css' => 'max-width: 60px',
+ 'custom_attributes' => array( 'data-show_if_woocommerce_gzd_dhl_PreferredDay_enable' => '', 'min' => 0, 'max' => 3 )
+ ),
+
+ array(
+ 'title' => _x( 'Exclude days of transfer', 'dhl', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Monday', 'dhl', 'woocommerce-germanized' ),
+ 'desc_tip' => _x( 'Exclude days from transferring shipments to DHL.', 'dhl', 'woocommerce-germanized' ),
+ 'value' => wc_bool_to_string( $this->get_setting( 'PreferredDay_exclusion_mon' ) ),
+ 'id' => 'PreferredDay_exclusion_mon',
+ 'allow_override' => false,
+ 'type' => 'gzd_toggle',
+ 'default' => 'no',
+ 'checkboxgroup' => 'start',
+ 'custom_attributes' => array( 'data-show_if_woocommerce_gzd_dhl_PreferredDay_enable' => '' )
+ ),
+
+ array(
+ 'desc' => _x( 'Tuesday', 'dhl', 'woocommerce-germanized' ),
+ 'id' => 'PreferredDay_exclusion_tue',
+ 'value' => wc_bool_to_string( $this->get_setting( 'PreferredDay_exclusion_tue' ) ),
+ 'type' => 'gzd_toggle',
+ 'allow_override' => false,
+ 'default' => 'no',
+ 'checkboxgroup' => '',
+ 'custom_attributes' => array( 'data-show_if_woocommerce_gzd_dhl_PreferredDay_enable' => '' )
+ ),
+
+ array(
+ 'desc' => _x( 'Wednesday', 'dhl', 'woocommerce-germanized' ),
+ 'id' => 'PreferredDay_exclusion_wed',
+ 'value' => wc_bool_to_string( $this->get_setting( 'PreferredDay_exclusion_wed' ) ),
+ 'type' => 'gzd_toggle',
+ 'allow_override' => false,
+ 'default' => 'no',
+ 'checkboxgroup' => '',
+ 'custom_attributes' => array( 'data-show_if_woocommerce_gzd_dhl_PreferredDay_enable' => '' )
+ ),
+
+ array(
+ 'desc' => _x( 'Thursday', 'dhl', 'woocommerce-germanized' ),
+ 'id' => 'PreferredDay_exclusion_thu',
+ 'value' => wc_bool_to_string( $this->get_setting( 'PreferredDay_exclusion_thu' ) ),
+ 'type' => 'gzd_toggle',
+ 'allow_override' => false,
+ 'default' => 'no',
+ 'checkboxgroup' => '',
+ 'custom_attributes' => array( 'data-show_if_woocommerce_gzd_dhl_PreferredDay_enable' => '' )
+ ),
+
+ array(
+ 'desc' => _x( 'Friday', 'dhl', 'woocommerce-germanized' ),
+ 'id' => 'PreferredDay_exclusion_fri',
+ 'value' => wc_bool_to_string( $this->get_setting( 'PreferredDay_exclusion_fri' ) ),
+ 'type' => 'gzd_toggle',
+ 'allow_override' => false,
+ 'default' => 'no',
+ 'checkboxgroup' => '',
+ 'custom_attributes' => array( 'data-show_if_woocommerce_gzd_dhl_PreferredDay_enable' => '' )
+ ),
+
+ array(
+ 'desc' => _x( 'Saturday', 'dhl', 'woocommerce-germanized' ),
+ 'id' => 'PreferredDay_exclusion_sat',
+ 'value' => wc_bool_to_string( $this->get_setting( 'PreferredDay_exclusion_sat' ) ),
+ 'type' => 'gzd_toggle',
+ 'allow_override' => false,
+ 'default' => 'no',
+ 'checkboxgroup' => 'end',
+ 'custom_attributes' => array( 'data-show_if_woocommerce_gzd_dhl_PreferredDay_enable' => '' )
+ ),
+
+ array(
+ 'title' => _x( 'Exclude gateways', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'multiselect',
+ 'desc' => _x( 'Select payment gateways to be excluded from showing preferred services.', 'dhl', 'woocommerce-germanized' ),
+ 'desc_tip' => true,
+ 'allow_override' => false,
+ 'id' => 'preferred_payment_gateways_excluded',
+ 'value' => $this->get_setting( 'preferred_payment_gateways_excluded' ),
+ 'options' => $wc_gateway_titles,
+ 'class' => 'wc-enhanced-select',
+ ),
+
+ array( 'type' => 'sectionend', 'id' => 'preferred_options' ),
+ );
+
+ return $settings;
+ }
+
+ protected function get_label_settings() {
+ $select_dhl_product_dom = wc_gzd_dhl_get_products_domestic();
+ $select_dhl_product_int = wc_gzd_dhl_get_products_international();
+ $duties = wc_gzd_dhl_get_duties();
+ $ref_placeholders = wc_gzd_dhl_get_label_payment_ref_placeholder();
+ $ref_placeholders_str = implode( ', ', array_keys( $ref_placeholders ) );
+
+ $settings = array(
+ array( 'title' => '', 'title_method' => _x( 'Products', 'dhl', 'woocommerce-germanized' ), 'type' => 'title', 'id' => 'shipping_provider_dhl_label_options', 'allow_override' => true ),
+
+ array(
+ 'title' => _x( 'Domestic Default Service', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'select',
+ 'id' => 'label_default_product_dom',
+ 'default' => 'V01PAK',
+ 'value' => $this->get_setting( 'label_default_product_dom', 'V01PAK' ),
+ 'desc' => '' . _x( 'Please select your default DHL shipping service for domestic shipments that you want to offer to your customers (you can always change this within each individual shipment afterwards).', 'dhl', 'woocommerce-germanized' ) . '
',
+ 'options' => $select_dhl_product_dom,
+ 'class' => 'wc-enhanced-select',
+ ),
+
+ array(
+ 'title' => _x( 'Int. Default Service', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'select',
+ 'default' => 'V55PAK',
+ 'value' => $this->get_setting( 'label_default_product_int', 'V55PAK' ),
+ 'id' => 'label_default_product_int',
+ 'desc' => '' . _x( 'Please select your default DHL shipping service for cross-border shipments that you want to offer to your customers (you can always change this within each individual shipment afterwards).', 'dhl', 'woocommerce-germanized' ) . '
',
+ 'options' => $select_dhl_product_int,
+ 'class' => 'wc-enhanced-select',
+ ),
+
+ array(
+ 'title' => _x( 'Default Duty', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'select',
+ 'default' => 'DDP',
+ 'id' => 'label_default_duty',
+ 'value' => $this->get_setting( 'label_default_duty', 'DDP' ),
+ 'desc' => _x( 'Please select a default duty type.', 'dhl', 'woocommerce-germanized' ),
+ 'desc_tip' => true,
+ 'options' => $duties,
+ 'class' => 'wc-enhanced-select',
+ ),
+
+ array(
+ 'title' => _x( 'Codeable', 'dhl', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Generate label only if address can be automatically retrieved DHL.', 'dhl', 'woocommerce-germanized' ),
+ 'id' => 'label_address_codeable_only',
+ 'value' => $this->get_setting( 'label_address_codeable_only', 'no' ),
+ 'default' => 'no',
+ 'type' => 'gzd_toggle',
+ 'allow_override' => false,
+ 'desc_tip' => _x( 'Choose this option if you want to make sure that by default labels are only generated for codeable addresses.', 'dhl', 'woocommerce-germanized' ),
+ ),
+
+ array(
+ 'title' => _x( 'Force email', 'dhl', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Force transferring customer email to DHL.', 'dhl', 'woocommerce-germanized' ) . '' . _x( 'By default the customer email address is only transferred in case explicit consent has been given via a checkbox during checkout. You may force to transfer the customer email address during label creation to make sure your customers receive email notifications by DHL. Make sure to check your privacy policy and seek advice by a lawyer in case of doubt.', 'dhl', 'woocommerce-germanized' ) . '
',
+ 'id' => 'label_force_email_transfer',
+ 'value' => $this->get_setting( 'label_force_email_transfer', 'no' ),
+ 'default' => 'no',
+ 'allow_override' => false,
+ 'type' => 'gzd_toggle',
+ ),
+ array(
+ 'title' => _x( 'Inlay Returns', 'dhl', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Additionally create inlay return labels for shipments that support returns.', 'dhl', 'woocommerce-germanized' ),
+ 'id' => 'label_auto_inlay_return_label',
+ 'value' => $this->get_setting( 'label_auto_inlay_return_label', 'no' ),
+ 'default' => 'no',
+ 'type' => 'gzd_toggle',
+ ),
+
+ array( 'type' => 'sectionend', 'id' => 'shipping_provider_dhl_label_options' ),
+ );
+
+ $settings = array_merge( $settings, parent::get_label_settings() );
+
+ $settings = array_merge( $settings, array(
+ array( 'title' => _x( 'Retoure', 'dhl', 'woocommerce-germanized' ), 'type' => 'title', 'id' => 'dhl_retoure_options', 'desc' => sprintf( _x( 'Adjust handling of return shipments through the DHL Retoure API. Make sure that your %s contains DHL Retoure Online.', 'dhl', 'woocommerce-germanized' ), '' . _x( 'contract', 'dhl', 'woocommerce-germanized' ) . '' ) ),
+
+ array(
+ 'title' => _x( 'Retoure', 'dhl', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Enable creating labels for return shipments.', 'dhl', 'woocommerce-germanized' ) . '' . _x( 'By enabling this option you might generate retoure labels for return shipments and send them to your customer via email.', 'dhl', 'woocommerce-germanized' ) . '
',
+ 'id' => 'label_retoure_enable',
+ 'value' => wc_bool_to_string( $this->enable_retoure() ),
+ 'default' => 'yes',
+ 'type' => 'gzd_toggle',
+ ),
+
+ array(
+ 'type' => 'dhl_receiver_ids',
+ 'value' => $this->get_setting( 'retoure_receiver_ids', array() ),
+ 'id' => 'retoure_receiver_ids',
+ 'default' => array(),
+ ),
+
+ array( 'type' => 'sectionend', 'id' => 'dhl_retoure_options' ),
+
+ array( 'title' => _x( 'Default Services', 'dhl', 'woocommerce-germanized' ), 'allow_override' => true, 'type' => 'title', 'id' => 'dhl_label_default_services_options', 'desc' => sprintf( _x( 'Adjust services to be added to your labels by default. Find out more about these services.', 'dhl', 'woocommerce-germanized' ), 'https://www.dhl.de/de/geschaeftskunden/paket/leistungen-und-services/services/service-loesungen.html' ) ),
+ array(
+ 'title' => _x( 'GoGreen', 'dhl', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Enable the GoGreen Service by default.', 'dhl', 'woocommerce-germanized' ),
+ 'id' => 'label_service_GoGreen',
+ 'value' => wc_bool_to_string( $this->get_setting( 'label_service_GoGreen', 'no' ) ),
+ 'default' => 'no',
+ 'type' => 'gzd_toggle',
+ ),
+ array(
+ 'title' => _x( 'Additional Insurance', 'dhl', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Add an additional insurance to labels.', 'dhl', 'woocommerce-germanized' ),
+ 'id' => 'label_service_AdditionalInsurance',
+ 'value' => wc_bool_to_string( $this->get_setting( 'label_service_AdditionalInsurance', 'no' ) ),
+ 'default' => 'no',
+ 'type' => 'gzd_toggle',
+ ),
+ array(
+ 'title' => _x( 'Retail Outlet Routing', 'dhl', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Send undeliverable items to nearest retail outlet instead of immediate return.', 'dhl', 'woocommerce-germanized' ),
+ 'id' => 'label_service_ParcelOutletRouting',
+ 'value' => wc_bool_to_string( $this->get_setting( 'label_service_ParcelOutletRouting', 'no' ) ),
+ 'default' => 'no',
+ 'type' => 'gzd_toggle',
+ ),
+ array(
+ 'title' => _x( 'No Neighbor', 'dhl', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Do not deliver to neighbors.', 'dhl', 'woocommerce-germanized' ),
+ 'id' => 'label_service_NoNeighbourDelivery',
+ 'value' => wc_bool_to_string( $this->get_setting( 'label_service_NoNeighbourDelivery', 'no' ) ),
+ 'default' => 'no',
+ 'type' => 'gzd_toggle',
+ ),
+ array(
+ 'title' => _x( 'Named person only', 'dhl', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Do only delivery to named person.', 'dhl', 'woocommerce-germanized' ),
+ 'id' => 'label_service_NamedPersonOnly',
+ 'value' => wc_bool_to_string( $this->get_setting( 'label_service_NamedPersonOnly', 'no' ) ),
+ 'default' => 'no',
+ 'type' => 'gzd_toggle',
+ ),
+ array(
+ 'title' => _x( 'Bulky Goods', 'dhl', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Deliver as bulky goods.', 'dhl', 'woocommerce-germanized' ),
+ 'id' => 'label_service_BulkyGoods',
+ 'value' => wc_bool_to_string( $this->get_setting( 'label_service_BulkyGoods', 'no' ) ),
+ 'default' => 'no',
+ 'type' => 'gzd_toggle',
+ ),
+ array(
+ 'title' => _x( 'Minimum age (Visual check)', 'dhl', 'woocommerce-germanized' ),
+ 'id' => 'label_visual_min_age',
+ 'type' => 'select',
+ 'default' => '0',
+ 'value' => $this->get_setting( 'label_visual_min_age', '0' ),
+ 'options' => wc_gzd_dhl_get_visual_min_ages(),
+ 'desc_tip' => _x( 'Choose this option if you want to let DHL check your customer\'s age.', 'dhl', 'woocommerce-germanized' ),
+ ),
+ array(
+ 'title' => _x( 'Sync (Visual Check)', 'dhl', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Visually verify age if shipment contains applicable items.', 'dhl', 'woocommerce-germanized' ) . '' . sprintf( _x( 'Germanized offers an %s to be enabled for certain products and/or product categories. By checking this option labels for shipments with applicable items will automatically have the visual age check service enabled.', 'dhl', 'woocommerce-germanized' ), '' . _x( 'age verification checkbox', 'dhl', 'woocommerce-germanized' ) . '' ) . '
',
+ 'id' => 'label_auto_age_check_sync',
+ 'value' => wc_bool_to_string( $this->get_setting( 'label_auto_age_check_sync', 'yes' ) ),
+ 'default' => 'yes',
+ 'type' => 'gzd_toggle',
+ ),
+ array(
+ 'title' => _x( 'Minimum age (Ident check)', 'dhl', 'woocommerce-germanized' ),
+ 'id' => 'label_ident_min_age',
+ 'type' => 'select',
+ 'default' => '0',
+ 'value' => $this->get_setting( 'label_ident_min_age', '0' ),
+ 'options' => wc_gzd_dhl_get_ident_min_ages(),
+ 'desc_tip' => _x( 'Choose this option if you want to let DHL check your customer\'s identity and age.', 'dhl', 'woocommerce-germanized' ),
+ ),
+ array(
+ 'title' => _x( 'Sync (Ident Check)', 'dhl', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Verify identity and age if shipment contains applicable items.', 'dhl', 'woocommerce-germanized' ) . '' . sprintf( _x( 'Germanized offers an %s to be enabled for certain products and/or product categories. By checking this option labels for shipments with applicable items will automatically have the identity check service enabled.', 'dhl', 'woocommerce-germanized' ), '' . _x( 'age verification checkbox', 'dhl', 'woocommerce-germanized' ) . '' ) . '
',
+ 'id' => 'label_auto_age_check_ident_sync',
+ 'value' => wc_bool_to_string( $this->get_setting( 'label_auto_age_check_ident_sync', 'no' ) ),
+ 'default' => 'no',
+ 'type' => 'gzd_toggle',
+ ),
+ array(
+ 'title' => _x( 'Premium', 'dhl', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Premium delivery for international shipments.', 'dhl', 'woocommerce-germanized' ),
+ 'id' => 'label_service_Premium',
+ 'value' => wc_bool_to_string( $this->get_setting( 'label_service_Premium', 'no' ) ),
+ 'default' => 'no',
+ 'type' => 'gzd_toggle',
+ ),
+ array( 'type' => 'sectionend', 'id' => 'dhl_label_default_services_options' ),
+
+ array( 'title' => _x( 'Bank Account', 'dhl', 'woocommerce-germanized' ), 'type' => 'title', 'id' => 'dhl_bank_account_options', 'desc' => _x( 'Enter your bank details needed for services that use COD.', 'dhl', 'woocommerce-germanized' ) ),
+
+ array(
+ 'title' => _x( 'Holder', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'id' => 'bank_holder',
+ 'value' => $this->get_setting( 'bank_holder' ),
+ 'default' => Package::get_default_bank_account_data( 'name' ),
+ ),
+
+ array(
+ 'title' => _x( 'Bank Name', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'id' => 'bank_name',
+ 'value' => $this->get_setting( 'bank_name' ),
+ 'default' => Package::get_default_bank_account_data( 'bank_name' ),
+ ),
+
+ array(
+ 'title' => _x( 'IBAN', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'id' => 'bank_iban',
+ 'value' => $this->get_setting( 'bank_iban' ),
+ 'default' => Package::get_default_bank_account_data( 'iban' ),
+ ),
+
+ array(
+ 'title' => _x( 'BIC', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'id' => 'bank_bic',
+ 'value' => $this->get_setting( 'bank_bic' ),
+ 'default' => Package::get_default_bank_account_data( 'bic' ),
+ ),
+
+ array(
+ 'title' => _x( 'Payment Reference', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'id' => 'bank_ref',
+ 'custom_attributes' => array( 'maxlength' => '35' ),
+ 'value' => $this->get_setting( 'bank_ref' ),
+ 'desc' => '' . sprintf( _x( 'Use these placeholders to add info to the payment reference: %s. This text is limited to 35 characters.', 'dhl', 'woocommerce-germanized' ), '
',
+ 'default' => '{shipment_id}'
+ ),
+
+ array(
+ 'title' => _x( 'Payment Reference 2', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'id' => 'bank_ref_2',
+ 'custom_attributes' => array( 'maxlength' => '35' ),
+ 'value' => $this->get_setting( 'bank_ref_2' ),
+ 'desc' => '' . esc_html( $ref_placeholders_str ) . '' ) . '' . sprintf( _x( 'Use these placeholders to add info to the payment reference: %s. This text is limited to 35 characters.', 'dhl', 'woocommerce-germanized' ), '
',
+ 'default' => '{email}'
+ ),
+
+ array( 'type' => 'sectionend', 'id' => 'dhl_bank_account_options' ),
+ ) );
+
+ return $settings;
+ }
+
+ public function get_help_link() {
+ return 'https://vendidero.de/dokumentation/woocommerce-germanized/post-dhl';
+ }
+
+ public function get_signup_link() {
+ return 'https://www.dhl.de/de/geschaeftskunden/paket/plugin-kunde-werden/angebot-dhl-geschaeftskunden-online.html?source=woocommercegermanized';
+ }
+
+ public function get_settings_help_pointers( $section = '' ) {
+ $pointers = array();
+
+ if ( '' === $section ) {
+ $pointers = array(
+ 'pointers' => array(
+ 'account' => array(
+ 'target' => '#account_number',
+ 'next' => 'api',
+ 'next_url' => '',
+ 'next_trigger' => array(),
+ 'options' => array(
+ 'content' => '' . esc_html( $ref_placeholders_str ) . '' ) . '' . esc_html_x( 'Customer Number', 'dhl', 'woocommerce-germanized' ) . '
' . + '' . esc_html_x( 'Insert your DHL business customer number (EKP) here. If you are not yet a business customer you might want to create a new account first.', 'dhl', 'woocommerce-germanized' ) . '
', + 'position' => array( + 'edge' => 'left', + 'align' => 'left', + ), + ), + ), + 'api' => array( + 'target' => Package::is_debug_mode() ? '#api_sandbox_username' : '#api_username', + 'next' => '', + 'next_url' => add_query_arg( array( 'tutorial' => 'yes' ), $this->get_edit_link( 'label' ) ), + 'next_trigger' => array(), + 'options' => array( + 'content' => '' . esc_html_x( 'API Access', 'dhl', 'woocommerce-germanized' ) . '
' . + '' . esc_html_x( 'To create labels and embed DHL services, our software needs access to the API. You will need to fill out the username and password fields accordingly.', 'dhl', 'woocommerce-germanized' ) . '
', + 'position' => array( + 'edge' => 'left', + 'align' => 'left', + ), + ), + ), + ), + ); + } elseif( 'label' === $section ) { + $pointers = array( + 'pointers' => array( + 'inlay' => array( + 'target' => '#label_auto_inlay_return_label-toggle', + 'next' => 'retoure', + 'next_url' => '', + 'next_trigger' => array(), + 'options' => array( + 'content' => '' . esc_html_x( 'Inlay Returns', 'dhl', 'woocommerce-germanized' ) . '
' . + '' . esc_html_x( 'If you want to provide your customers with inlay return labels for your shipments you might enable this feature by default here.', 'dhl', 'woocommerce-germanized' ) . '
', + 'position' => array( + 'edge' => 'left', + 'align' => 'left', + ), + ), + ), + 'retoure' => array( + 'target' => '#label_retoure_enable-toggle', + 'next' => 'age_check', + 'next_url' => '', + 'next_trigger' => array(), + 'options' => array( + 'content' => '' . esc_html_x( 'Retoure', 'dhl', 'woocommerce-germanized' ) . '
' . + '' . esc_html_x( 'If you want to create DHL labels to returns you should activate this feature. Make sure that you have DHL Online Retoure activated in your contract.', 'dhl', 'woocommerce-germanized' ) . '
', + 'position' => array( + 'edge' => 'left', + 'align' => 'left', + ), + ), + ), + 'age_check' => array( + 'target' => '#label_auto_age_check_sync-toggle', + 'next' => '', + 'next_url' => add_query_arg( array( 'tutorial' => 'yes' ), $this->get_edit_link( 'automation' ) ), + 'next_trigger' => array(), + 'options' => array( + 'content' => '' . esc_html_x( 'Age verification', 'dhl', 'woocommerce-germanized' ) . '
' . + '' . esc_html_x( 'Use this feature to sync the Germanized age verification checkbox with the DHL visual minimum age verification service. As soon as applicable products are contained within the shipment, the service will be booked by default.', 'dhl', 'woocommerce-germanized' ) . '
', + 'position' => array( + 'edge' => 'left', + 'align' => 'left', + ), + ), + ), + ) + ); + } elseif( 'automation' === $section ) { + $pointers = array( + 'pointers' => array( + 'auto' => array( + 'target' => '#label_auto_enable-toggle', + 'next' => '', + 'next_url' => add_query_arg( array( 'tutorial' => 'yes' ), $this->get_edit_link( 'preferred' ) ), + 'next_trigger' => array(), + 'options' => array( + 'content' => '' . esc_html_x( 'Automation', 'dhl', 'woocommerce-germanized' ) . '
' . + '' . esc_html_x( 'You might want to save some time and let Germanized generate labels automatically as soon as a shipment switches to a certain status.', 'dhl', 'woocommerce-germanized' ) . '
', + 'position' => array( + 'edge' => 'left', + 'align' => 'left', + ), + ), + ) + ) + ); + } elseif( 'preferred' === $section ) { + $pointers = array( + 'pointers' => array( + 'day' => array( + 'target' => '#PreferredDay_enable-toggle', + 'next' => 'fee', + 'next_url' => '', + 'next_trigger' => array(), + 'options' => array( + 'content' => '' . esc_html_x( 'Preferred Day', 'dhl', 'woocommerce-germanized' ) . '
' . + '' . esc_html_x( 'Let your customers choose a preferred day (if the service is available at the customer\'s location) of delivery within your checkout.', 'dhl', 'woocommerce-germanized' ) . '
', + 'position' => array( + 'edge' => 'left', + 'align' => 'left', + ), + ), + ), + 'fee' => array( + 'target' => '#PreferredDay_cost', + 'next' => 'location', + 'next_url' => '', + 'next_trigger' => array(), + 'options' => array( + 'content' => '' . esc_html_x( 'Fee', 'dhl', 'woocommerce-germanized' ) . '
' . + '' . esc_html_x( 'Optionally charge your customers an additional fee for preferred services like preferred day.', 'dhl', 'woocommerce-germanized' ) . '
', + 'position' => array( + 'edge' => 'left', + 'align' => 'left', + ), + ), + ), + 'location' => array( + 'target' => '#PreferredLocation_enable-toggle', + 'next' => '', + 'next_url' => add_query_arg( array( 'tutorial' => 'yes' ), $this->get_edit_link( 'pickup' ) ), + 'next_trigger' => array(), + 'options' => array( + 'content' => '' . esc_html_x( 'Preferred Location', 'dhl', 'woocommerce-germanized' ) . '
' . + '' . esc_html_x( 'Allow your customers to send their parcels to a preferred location e.g. a neighbor. This service is free of charge for DHL shipments.', 'dhl', 'woocommerce-germanized' ) . '
', + 'position' => array( + 'edge' => 'left', + 'align' => 'left', + ), + ), + ), + ) + ); + } elseif( 'pickup' === $section ) { + $pointers = array( + 'pointers' => array( + 'day' => array( + 'target' => '#parcel_pickup_packstation_enable-toggle', + 'next' => 'map', + 'next_url' => '', + 'next_trigger' => array(), + 'options' => array( + 'content' => '' . esc_html_x( 'Packstation', 'dhl', 'woocommerce-germanized' ) . '
' . + '' . esc_html_x( 'Allow your customers to choose packstation (and/or other DHL location types as configured below) as shipping address.', 'dhl', 'woocommerce-germanized' ) . '
', + 'position' => array( + 'edge' => 'left', + 'align' => 'left', + ), + ), + ), + 'map' => array( + 'target' => '#parcel_pickup_map_enable-toggle', + 'next' => '', + 'next_url' => ProviderSettings::get_next_pointers_link( $this->get_name() ), + 'next_trigger' => array(), + 'options' => array( + 'content' => '' . esc_html_x( 'Map', 'dhl', 'woocommerce-germanized' ) . '
' . + '' . esc_html_x( 'This option adds a map overlay view to let your customers choose a DHL location from a map nearby. You\'ll need a valid Google Maps API key to enable the map view.', 'dhl', 'woocommerce-germanized' ) . '
', + 'position' => array( + 'edge' => 'left', + 'align' => 'left', + ), + ), + ), + ) + ); + } + + return $pointers; + } +} diff --git a/packages/woocommerce-germanized-dhl/src/ShippingProvider/DeutschePost.php b/packages/woocommerce-germanized-dhl/src/ShippingProvider/DeutschePost.php new file mode 100644 index 000000000..4267ecc64 --- /dev/null +++ b/packages/woocommerce-germanized-dhl/src/ShippingProvider/DeutschePost.php @@ -0,0 +1,583 @@ +get_shipping_country() ) { + return false; + } + + return parent::supports_customer_returns( $order ); + } + + public function supports_labels( $label_type, $shipment = false ) { + $label_types = array( 'simple', 'return' ); + + /** + * Return labels are only supported for DE + */ + if ( 'return' === $label_type && $shipment && 'return' === $shipment->get_type() && 'DE' !== $shipment->get_sender_country() ) { + return false; + } + + return in_array( $label_type, $label_types ); + } + + public function get_title( $context = 'view' ) { + return _x( 'Deutsche Post', 'dhl', 'woocommerce-germanized' ); + } + + public function get_name( $context = 'view' ) { + return 'deutsche_post'; + } + + public function get_description( $context = 'view' ) { + return _x( 'Integration for products of the Deutsche Post through Internetmarke.', 'dhl', 'woocommerce-germanized' ); + } + + public function get_default_tracking_url_placeholder() { + return 'https://www.deutschepost.de/sendung/simpleQueryResult.html?form.sendungsnummer={tracking_id}&form.einlieferungsdatum_tag={label_date_day}&form.einlieferungsdatum_monat={label_date_month}&form.einlieferungsdatum_jahr={label_date_year}'; + } + + public function get_api_username( $context = 'view' ) { + return $this->get_meta( 'api_username', true, $context ); + } + + public function set_api_username( $username ) { + $this->update_meta_data( 'api_username', strtolower( $username ) ); + } + + /** + * @param \Vendidero\Germanized\Shipments\Shipment $shipment + */ + public function get_available_label_products( $shipment ) { + return wc_gzd_dhl_get_deutsche_post_products( $shipment ); + } + + protected function get_available_base_countries() { + return Package::get_available_countries(); + } + + protected function get_general_settings() { + $settings = array( + array( 'title' => '', 'type' => 'title', 'id' => 'deutsche_post_general_options' ), + + array( + 'title' => _x( 'Username', 'dhl', 'woocommerce-germanized' ), + 'type' => 'text', + 'desc' => '' . sprintf( _x( 'Your credentials to the Portokasse. Please test your credentials before connecting.', 'dhl', 'woocommerce-germanized' ), 'https://portokasse.deutschepost.de/portokasse/#!/' ) . '
',
+ 'id' => 'api_username',
+ 'default' => '',
+ 'value' => $this->get_setting( 'api_username', '' ),
+ 'custom_attributes' => array( 'autocomplete' => 'new-password' )
+ ),
+
+ array(
+ 'title' => _x( 'Password', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'password',
+ 'id' => 'api_password',
+ 'default' => '',
+ 'value' => $this->get_setting( 'api_password', '' ),
+ 'custom_attributes' => array( 'autocomplete' => 'new-password' )
+ ),
+
+ array( 'type' => 'sectionend', 'id' => 'deutsche_post_general_options' ),
+ );
+
+ $settings = array_merge( $settings, array(
+ array( 'type' => 'sectionend', 'id' => 'dhl_product_options' ),
+
+ array( 'title' => _x( 'Tracking', 'dhl', 'woocommerce-germanized' ), 'type' => 'title', 'id' => 'tracking_options' ),
+ ) );
+
+ $general_settings = parent::get_general_settings();
+
+ return array_merge( $settings, $general_settings );
+ }
+
+ protected function get_label_settings() {
+ $api = Package::get_internetmarke_api();
+ $settings = parent::get_label_settings();
+
+ if ( $api && $api->is_configured() && $api->auth() && $api->is_available() ) {
+ $api->reload_products();
+
+ $balance = $api->get_balance( true );
+ $settings_url = $this->get_edit_link( 'label' );
+ $default_available_products = $api->get_default_available_products();
+
+ $settings = array_merge( $settings, array(
+ array( 'title' => _x( 'Portokasse', 'dhl', 'woocommerce-germanized' ), 'type' => 'title', 'id' => 'deutsche_post_portokasse_options' ),
+
+ array(
+ 'title' => _x( 'Balance', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'html',
+ 'html' => wc_price( Package::cents_to_eur( $balance ), array( 'currency' => 'EUR' ) ),
+ ),
+
+ array(
+ 'title' => _x( 'Charge (€)', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'html',
+ 'html' => $this->get_portokasse_charge_button(),
+ ),
+
+ array( 'type' => 'sectionend', 'id' => 'deutsche_post_portokasse_options' ),
+
+ array( 'title' => _x( 'Products', 'dhl', 'woocommerce-germanized' ), 'type' => 'title', 'id' => 'deutsche_post_product_options' ),
+
+ array(
+ 'title' => _x( 'Available Products', 'dhl', 'woocommerce-germanized' ),
+ 'id' => 'available_products',
+ 'class' => 'wc-enhanced-select',
+ 'desc' => '' . sprintf( _x( 'Choose the products you want to be available for your shipments from the list above. Manually refresh the product list to make sure it is up-to-date.', 'dhl', 'woocommerce-germanized' ), wp_nonce_url( add_query_arg( array( 'action' => 'wc-gzd-dhl-im-product-refresh' ), $settings_url ), 'wc-gzd-dhl-refresh-im-products' ) ) . '
',
+ 'type' => 'multiselect',
+ 'value' => $this->get_setting( 'available_products', $default_available_products ),
+ 'options' => $this->get_product_select_options(),
+ 'default' => $default_available_products,
+ ),
+ ) );
+
+ $products = wc_gzd_dhl_get_deutsche_post_products_domestic( false, false );
+
+ if ( ! empty( $products ) ) {
+ $settings = array_merge( $settings, array(
+ array(
+ 'title' => _x( 'Domestic Default Service', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'select',
+ 'default' => '',
+ 'value' => $this->get_setting( 'label_default_product_dom', '' ),
+ 'id' => 'label_default_product_dom',
+ 'desc' => '' . _x( 'Please select your default shipping service for domestic shipments that you want to offer to your customers (you can always change this within each individual shipment afterwards).', 'dhl', 'woocommerce-germanized' ) . '
',
+ 'options' => wc_gzd_dhl_get_deutsche_post_products_domestic( false, false ),
+ 'class' => 'wc-enhanced-select',
+ ),
+
+ array(
+ 'title' => _x( 'EU Default Service', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'select',
+ 'default' => '',
+ 'value' => $this->get_setting( 'label_default_product_eu', '' ),
+ 'id' => 'label_default_product_eu',
+ 'desc' => '' . _x( 'Please select your default shipping service for EU shipments that you want to offer to your customers.', 'dhl', 'woocommerce-germanized' ) . '
',
+ 'options' => wc_gzd_dhl_get_deutsche_post_products_eu( false, false ),
+ 'class' => 'wc-enhanced-select',
+ ),
+
+ array(
+ 'title' => _x( 'Int. Default Service', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'select',
+ 'default' => '',
+ 'value' => $this->get_setting( 'label_default_product_int', '' ),
+ 'id' => 'label_default_product_int',
+ 'desc' => '' . _x( 'Please select your default shipping service for cross-border shipments that you want to offer to your customers.', 'dhl', 'woocommerce-germanized' ) . '
',
+ 'options' => wc_gzd_dhl_get_deutsche_post_products_international( false, false ),
+ 'class' => 'wc-enhanced-select',
+ ),
+ ) );
+ }
+
+ $settings = array_merge( $settings, array(
+ array( 'type' => 'sectionend', 'id' => 'deutsche_post_product_options' ),
+
+ array( 'title' => _x( 'Printing', 'dhl', 'woocommerce-germanized' ), 'type' => 'title', 'id' => 'deutsche_post_print_options' ),
+
+ array(
+ 'title' => _x( 'Default Format', 'dhl', 'woocommerce-germanized' ),
+ 'id' => 'label_default_page_format',
+ 'class' => 'wc-enhanced-select',
+ 'desc' => '' . sprintf( _x( 'Choose a print format which will be selected by default when creating labels. Manually refresh available print formats to make sure the list is up-to-date.', 'dhl', 'woocommerce-germanized' ), wp_nonce_url( add_query_arg( array( 'action' => 'wc-gzd-dhl-im-page-formats-refresh' ), $settings_url ), 'wc-gzd-dhl-refresh-im-page-formats' ) ) . '
',
+ 'type' => 'select',
+ 'value' => $this->get_setting( 'label_default_page_format', 1 ),
+ 'options' => Package::get_internetmarke_api()->get_page_format_list(),
+ 'default' => 1,
+ ),
+ array(
+ 'title' => _x( 'Print X-axis column', 'dhl', 'woocommerce-germanized' ),
+ 'id' => 'label_position_x',
+ 'desc_tip' => _x( 'Adjust the print X-axis start column for the label.', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'number',
+ 'value' => $this->get_setting( 'label_position_x', 1 ),
+ 'custom_attributes' => array( 'min' => 0, 'step' => 1 ),
+ 'css' => 'max-width: 100px;',
+ 'default' => 1,
+ ),
+ array(
+ 'title' => _x( 'Print Y-axis column', 'dhl', 'woocommerce-germanized' ),
+ 'id' => 'label_position_y',
+ 'desc_tip' => _x( 'Adjust the print Y-axis start column for the label.', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'number',
+ 'value' => $this->get_setting( 'label_position_y', 1 ),
+ 'custom_attributes' => array( 'min' => 0, 'step' => 1 ),
+ 'css' => 'max-width: 100px;',
+ 'default' => 1,
+ ),
+
+ array( 'type' => 'sectionend', 'id' => 'deutsche_post_print_options' )
+ ) );
+ } elseif ( $api && $api->has_errors() ) {
+ $settings = array_merge( $settings, array(
+ array( 'title' => _x( 'API Error', 'dhl', 'woocommerce-germanized' ), 'type' => 'title', 'id' => 'deutsche_post_api_error', 'desc' => '' . implode( ", ", $api->get_errors()->get_error_messages() ) . '
' . sprintf( _x( 'The minimum amount is %s', 'dhl', 'woocommerce-germanized' ), wc_price( 10, array( 'currency' => 'EUR' ) ) ) . '
+ '; + + return $html; + } + + public function get_label_fields_html( $shipment ) { + $html = parent::get_label_fields_html( $shipment ); + $html .= ' +
+
+ ';
+
+ return $html;
+ }
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment
+ *
+ * @return array
+ */
+ protected function get_return_label_fields( $shipment ) {
+ return $this->get_simple_label_fields( $shipment );
+ }
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment
+ *
+ * @return array|\WP_Error
+ */
+ protected function get_simple_label_fields( $shipment ) {
+ $settings = parent::get_simple_label_fields( $shipment );
+ $default_args = $this->get_default_available_label_args( $shipment );
+ $products = $this->get_available_label_products( $shipment );
+ $is_wp_int = false;
+
+ /**
+ * Replace the product id (which might contain services) with the default parent id.
+ * Otherwise the correct (parent only) product would not be selected from the available products lists.
+ */
+ if ( ! empty( $default_args['product_id'] ) ) {
+ foreach( $settings as $key => $setting ) {
+ if ( 'product_id' === $setting['id'] ) {
+ $settings[ $key ]['value'] = $default_args['product_id'];
+ }
+ }
+
+ $is_wp_int = Package::get_internetmarke_api()->is_warenpost_international( $default_args['product_id'] );
+ }
+
+ if ( empty( $products ) ) {
+ return new \WP_Error( 'dp-label-missing-products', sprintf( _x( 'Sorry but none of your selected Deutsche Post Products is available for this shipment. Please verify your shipment data (e.g. weight) and try again.', 'dhl', 'woocommerce-germanized' ), $this->get_edit_link( 'label' ) ) );
+ }
+
+ $settings = array_merge( $settings, $this->get_available_additional_services( $default_args['product_id'], $default_args['services'] ) );
+
+ if ( ! $is_wp_int ) {
+ $settings = array_merge( $settings, array(
+ array(
+ 'id' => 'page_format',
+ 'label' => _x( 'Page Format', 'dhl', 'woocommerce-germanized' ),
+ 'description' => '',
+ 'type' => 'select',
+ 'options' => Package::get_internetmarke_api()->get_page_format_list(),
+ 'value' => isset( $default_args['page_format'] ) ? $default_args['page_format'] : '',
+ )
+ ) );
+ }
+
+ return $settings;
+ }
+
+ public function get_available_additional_services( $product_id, $selected_services = array() ) {
+ $im_product_id = Package::get_internetmarke_api()->get_product_id( $product_id );
+ $services = \Vendidero\Germanized\DHL\Package::get_internetmarke_api()->get_product_list()->get_services_for_product( $im_product_id, $selected_services );
+ $settings = array(
+ array(
+ 'id' => 'additional-services',
+ 'type' => 'wrapper',
+ )
+ );
+
+ foreach( $services as $service ) {
+ $settings[] = array(
+ 'id' => 'service_' . $service,
+ 'name' => 'services[]',
+ 'wrapper_class' => 'form-field-checkbox',
+ 'type' => 'checkbox',
+ 'label' => \Vendidero\Germanized\DHL\Package::get_internetmarke_api()->get_product_list()->get_additional_service_title( $service ),
+ 'cbvalue' => $service,
+ 'value' => in_array( $service, $selected_services ) ? $service : '',
+ );
+ }
+
+ $settings[] = array(
+ 'type' => 'wrapper_end',
+ );
+
+ return $settings;
+ }
+
+ protected function get_default_available_label_args( $shipment, $default_args = array() ) {
+ if ( empty( $default_args ) ) {
+ $default_args = $this->get_default_label_props( $shipment );
+ }
+
+ $im_all_products = wc_gzd_dhl_get_deutsche_post_products( $shipment, false );
+ $default_product = isset( $default_args['product_id'] ) ? $default_args['product_id'] : array_keys( $im_all_products )[0];
+ $selected_product = isset( $im_all_products[ $default_product ] ) ? $default_product : array_keys( $im_all_products )[0];
+ $selected_services = isset( $default_args['services'] ) ? $default_args['services'] : array();
+
+ if ( ! empty( $selected_product ) ) {
+ /**
+ * Do only override services in case the product is a child product and force parent code.
+ */
+ if ( ! Package::get_internetmarke_api()->product_code_is_parent( $selected_product ) ) {
+ $selected_services = Package::get_internetmarke_api()->get_product_services( $selected_product );
+ $selected_product = Package::get_internetmarke_api()->get_product_parent_code( $selected_product );
+ }
+ }
+
+ return array_replace_recursive( $default_args, array(
+ 'services' => $selected_services,
+ 'product_id' => $selected_product,
+ 'page_format' => $default_args['page_format']
+ ) );
+ }
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment
+ */
+ public function get_default_label_product( $shipment ) {
+ $country = $shipment->get_country();
+
+ if ( 'return' === $shipment->get_type() ) {
+ $country = $shipment->get_sender_country();
+ }
+
+ if ( Package::is_shipping_domestic( $country ) ) {
+ return $this->get_shipment_setting( $shipment, 'label_default_product_dom' );
+ } elseif( Package::is_eu_shipment( $country ) ) {
+ return $this->get_shipment_setting( $shipment, 'label_default_product_eu' );
+ } else {
+ return $this->get_shipment_setting( $shipment, 'label_default_product_int' );
+ }
+ }
+
+ protected function get_default_label_props( $shipment ) {
+ $dp_defaults = $this->get_default_simple_label_props( $shipment );
+ $defaults = parent::get_default_label_props( $shipment );
+ $defaults = array_replace_recursive( $defaults, $dp_defaults );
+
+ if ( ! empty( $defaults['product_id'] ) ) {
+ /**
+ * Get current services from the selected product.
+ */
+ $defaults['services'] = Package::get_internetmarke_api()->get_product_services( $defaults['product_id'] );
+
+ /**
+ * Force parent product by default to allow manually selecting services.
+ */
+ $defaults['product_id'] = Package::get_internetmarke_api()->get_product_parent_code( $defaults['product_id'] );
+ }
+
+ if ( ! empty( $defaults['product_id'] ) ) {
+ $defaults['stamp_total'] = Package::get_internetmarke_api()->get_product_total( $defaults['product_id'] );
+ }
+
+ return $defaults;
+ }
+
+ protected function get_default_simple_label_props( $shipment ) {
+ $defaults = array(
+ 'page_format' => $this->get_shipment_setting( $shipment, 'label_default_page_format' ),
+ 'stamp_total' => 0,
+ 'services' => array(),
+ );
+
+ return $defaults;
+ }
+
+ /**
+ * @param Shipment $shipment
+ *
+ * @return array
+ */
+ protected function get_default_return_label_props( $shipment ) {
+ $defaults = $this->get_default_simple_label_props( $shipment );
+ $defaults['sender_address'] = $shipment->get_address();
+
+ return $defaults;
+ }
+
+ /**
+ * @param Shipment $shipment
+ * @param $props
+ *
+ * @return \WP_Error|mixed
+ */
+ protected function validate_label_request( $shipment, $args = array() ) {
+ $args = wp_parse_args( $args, array(
+ 'page_format' => '',
+ 'product_id' => ''
+ ) );
+
+ $error = new \WP_Error();
+
+ if ( ! empty( $args['services'] ) ) {
+ /**
+ * Additional services are requested. Lets check whether the actual product exists and
+ * refresh the product code (to the child product code).
+ */
+ $im_product_code = Package::get_internetmarke_api()->get_product_code( $args['product_id'], $args['services'] );
+
+ if ( false === $im_product_code ) {
+ $error->add( 500, _x( 'The services chosen are not available for the current product.', 'dhl', 'woocommerce-germanized' ) );
+ } else {
+ $args['product_id'] = $im_product_code;
+ }
+ }
+
+ $available_products = wc_gzd_dhl_get_deutsche_post_products( $shipment, false );
+
+ /**
+ * Force the product to check to parent id because some services might not be explicitly added as
+ * available products.
+ */
+ $im_parent_code = Package::get_internetmarke_api()->get_product_parent_code( $args['product_id'] );
+
+ /**
+ * Check whether the product might not be available for the current shipment
+ */
+ if ( ! array_key_exists( $im_parent_code, $available_products ) ) {
+ /**
+ * In case no other products are available or this is a manual request - return error
+ */
+ if ( empty( $available_products ) || ( is_admin() && current_user_can( 'manage_woocommerce' ) ) ) {
+ $error->add( 500, sprintf( _x( 'Sorry but none of your selected Deutsche Post Products is available for this shipment. Please verify your shipment data (e.g. weight) and try again.', 'dhl', 'woocommerce-germanized' ), $this->get_edit_link( 'label' ) ) );
+ } else {
+ /**
+ * In case the chosen product is not available - use the first product available instead
+ * to prevent errors during automation (connected with the default product option which might not fit).
+ */
+ reset( $available_products );
+ $im_product_code = Package::get_internetmarke_api()->get_product_parent_code( key( $available_products ) );
+
+ if ( ! empty( $args['services'] ) ) {
+ $im_product_code_additional = Package::get_internetmarke_api()->get_product_code( $im_product_code, $args['services'] );
+
+ if ( false !== $im_product_code_additional ) {
+ $im_product_code = $im_product_code_additional;
+ }
+ }
+
+ $args['product_id'] = $im_product_code;
+ }
+ }
+
+ /**
+ * Refresh stamp total based on actual product.
+ */
+ if ( ! empty( $args['product_id'] ) ) {
+ $args['stamp_total'] = Package::get_internetmarke_api()->get_product_total( $args['product_id'] );
+ } else {
+ $error->add( 500, sprintf( _x( 'Deutsche Post product is missing for %s.', 'dhl', 'woocommerce-germanized' ), $shipment->get_id() ) );
+ }
+
+ if ( wc_gzd_dhl_wp_error_has_errors( $error ) ) {
+ return $error;
+ }
+
+ return $args;
+ }
+}
diff --git a/packages/woocommerce-germanized-dhl/src/ShippingProvider/ShippingMethod.php b/packages/woocommerce-germanized-dhl/src/ShippingProvider/ShippingMethod.php
new file mode 100644
index 000000000..8b034e101
--- /dev/null
+++ b/packages/woocommerce-germanized-dhl/src/ShippingProvider/ShippingMethod.php
@@ -0,0 +1,101 @@
+method = $method;
+ }
+
+ public function is_dhl_enabled() {
+ return $this->method->is_provider_enabled( 'dhl' );
+ }
+
+ public function is_deutsche_post_enabled() {
+ return $this->method->is_provider_enabled( 'deutsche_post' );
+ }
+
+ public function is_packstation_enabled() {
+ if ( $this->is_deutsche_post_enabled() ) {
+ return ParcelLocator::is_packstation_enabled( false );
+ } else {
+ return $this->method->get_option( 'dhl_parcel_pickup_packstation_enable' ) === 'yes' ? true : false;
+ }
+ }
+
+ public function is_postoffice_enabled() {
+ return $this->method->get_option( 'dhl_parcel_pickup_postoffice_enable' ) === 'yes' ? true : false;
+ }
+
+ public function is_parcelshop_enabled() {
+ return $this->method->get_option( 'dhl_parcel_pickup_parcelshop_enable' ) === 'yes' ? true : false;
+ }
+
+ public function get_enabled_preferred_services() {
+ if ( is_null( $this->preferred_services ) ) {
+ $services = wc_gzd_dhl_get_services();
+ $this->preferred_services = array();
+
+ if ( $this->is_dhl_enabled() ) {
+ foreach ( $services as $service ) {
+ if ( strpos( $service, 'Preferred' ) === false ) {
+ continue;
+ }
+
+ if ( $this->method->get_option( 'dhl_' . $service . '_enable' ) === 'yes' ) {
+ $this->preferred_services[] = $service;
+ }
+ }
+ }
+ }
+
+ return $this->preferred_services;
+ }
+
+ public function is_preferred_service_enabled( $service ) {
+ $services = $this->get_enabled_preferred_services();
+
+ return in_array( $service, $services ) && $this->is_dhl_enabled();
+ }
+
+ /**
+ * Call child methods if the method does not exist.
+ *
+ * @param $method
+ * @param $args
+ *
+ * @return bool|mixed
+ */
+ public function __call( $method, $args ) {
+ if ( method_exists( $this->method, $method ) ) {
+ return call_user_func_array( array( $this->method, $method ), $args );
+ }
+
+ return false;
+ }
+}
diff --git a/packages/woocommerce-germanized-dhl/templates/checkout/dhl/parcel-finder-result.php b/packages/woocommerce-germanized-dhl/templates/checkout/dhl/parcel-finder-result.php
new file mode 100644
index 000000000..19a508369
--- /dev/null
+++ b/packages/woocommerce-germanized-dhl/templates/checkout/dhl/parcel-finder-result.php
@@ -0,0 +1,49 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/packages/woocommerce-germanized-dhl/templates/checkout/dhl/parcel-finder.php b/packages/woocommerce-germanized-dhl/templates/checkout/dhl/parcel-finder.php
new file mode 100644
index 000000000..7837cb808
--- /dev/null
+++ b/packages/woocommerce-germanized-dhl/templates/checkout/dhl/parcel-finder.php
@@ -0,0 +1,69 @@
+
+
+gzd_name; ?>
+
+
+ address->street; ?> address->streetNo; ?>
+ address->zip; ?> address->city; ?>
+ + + gzd_type ) : ?> +
++ address->zip; ?> address->city; ?>
+ + + gzd_type ) : ?> +
+
+
+ gzd_opening_hours as $time ) : ?>
+ :
+ +
+
+ + +
+
+
+ : hasHandicappedAccess ? _x( 'Yes', 'dhl', 'woocommerce-germanized' ) : _x( 'No', 'dhl', 'woocommerce-germanized' ) ); ?>
+ : hasParkingArea ? _x( 'Yes', 'dhl', 'woocommerce-germanized' ) : _x( 'No', 'dhl', 'woocommerce-germanized' ) ); ?>
+
+
+
+
+
+ + : hasParkingArea ? _x( 'Yes', 'dhl', 'woocommerce-germanized' ) : _x( 'No', 'dhl', 'woocommerce-germanized' ) ); ?>
+
+
+
diff --git a/packages/woocommerce-germanized-dhl/templates/checkout/dhl/preferred-services.php b/packages/woocommerce-germanized-dhl/templates/checkout/dhl/preferred-services.php
new file mode 100644
index 000000000..11df4cc0f
--- /dev/null
+++ b/packages/woocommerce-germanized-dhl/templates/checkout/dhl/preferred-services.php
@@ -0,0 +1,109 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 
+
+
+
+
+
+
+Please choose your preferred delivery option.', 'dhl', 'woocommerce-germanized' ); ?>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+ $value ) :
+ $key = empty( $key ) ? '' : $key;
+ $week_day_num = empty( $key ) ? '-' : date('j', strtotime( $key ) );
+ $is_selected = $preferred_day === $key ? 'checked="checked"' : '';
+ ?>
+
- + /> + + + +
+
+
+
+
+
+
+ -
+
- + /> + + + +
- + /> + + + + +
- + /> + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ .shipment-content-wrapper {
+ display: block; }
+ .germanized-shipments #panel-order-shipments .order-shipment.active > .shipment-header > .right > .handlediv .toggle-indicator::before {
+ content: "\f142"; }
+ .germanized-shipments #panel-order-shipments .order-shipment .item-count {
+ margin-right: 1em; }
+ .germanized-shipments #panel-order-shipments .order-shipment .shipment-footer {
+ margin-top: 1em; }
+ .germanized-shipments #panel-order-shipments .order-shipment .shipment-footer .shipment-footer-inner {
+ display: flex;
+ flex-wrap: nowrap;
+ justify-content: flex-end;
+ padding: 0 .5em; }
+ .germanized-shipments #panel-order-shipments .order-shipment .shipment-footer .shipment-footer-inner a.shipment-footer-action {
+ margin-right: 1em; }
+ .germanized-shipments #panel-order-shipments .order-shipment .shipment-footer .shipment-footer-inner a.shipment-footer-action:last-child {
+ margin-right: 0; }
+ .germanized-shipments #panel-order-shipments .order-shipment .shipment-header {
+ color: #999;
+ background: #f8f8f8;
+ margin: 1.5em 0;
+ padding: .5em 1em;
+ cursor: pointer; }
+ .germanized-shipments #panel-order-shipments .order-shipment .shipment-header .shipment-status {
+ margin-left: 1em; }
+ .germanized-shipments #panel-order-shipments .order-shipment .shipment-header h3 {
+ margin: 0; }
+ .germanized-shipments #panel-order-shipments .order-shipment:first-child .shipment-header {
+ margin-top: 0; }
+ .germanized-shipments #panel-order-shipments .order-shipment.active > .shipment-header, .germanized-shipments #panel-order-shipments .order-shipment .shipment-header:hover {
+ background: #f3f3f3; }
+ .germanized-shipments #panel-order-shipments .order-shipment .shipment-content-wrapper {
+ display: none; }
+ .germanized-shipments #panel-order-shipments .order-shipment .shipment-content {
+ padding: 1em;
+ margin-top: -1.5em;
+ padding-bottom: 0; }
+ .germanized-shipments #panel-order-shipments .order-shipment .add-shipment-return {
+ display: none; }
+ .germanized-shipments #panel-order-shipments .order-shipment.is-returnable .add-shipment-return {
+ display: block; }
+ .germanized-shipments #panel-order-shipments .order-shipment p.form-row {
+ margin-bottom: 1.5em; }
+ .germanized-shipments #panel-order-shipments .order-shipment p.form-row.wc-gzd-shipment-packaging-wrapper {
+ margin-top: 0; }
+ .germanized-shipments #panel-order-shipments .order-shipment p.form-row input[type=text], .germanized-shipments #panel-order-shipments .order-shipment p.form-row input[type=number], .germanized-shipments #panel-order-shipments .order-shipment p.form-row input[type=email] {
+ height: 30px; }
+ .germanized-shipments #panel-order-shipments .order-shipment p.form-row select {
+ line-height: 30px;
+ height: 30px;
+ padding-top: 0;
+ padding-bottom: 0; }
+ .germanized-shipments #panel-order-shipments .order-shipment p.form-row label {
+ color: #999;
+ font-weight: 600; }
+ .germanized-shipments #panel-order-shipments .order-shipment p.form-row label .woocommerce-help-tip {
+ float: none; }
+ .germanized-shipments #panel-order-shipments .order-shipment .columns .column.column-spaced {
+ margin: 5px 0; }
+ .germanized-shipments #panel-order-shipments .order-shipment .columns .column h4 {
+ margin-bottom: .7em;
+ color: #999; }
+ .germanized-shipments #panel-order-shipments .order-shipment .columns .column h4 a {
+ color: #999;
+ text-decoration: none; }
+ .germanized-shipments #panel-order-shipments .order-shipment .shipment-items .shipment-item-list-wrapper .shipment-item-action {
+ text-align: right; }
+ .germanized-shipments #panel-order-shipments .order-shipment .shipment-items .shipment-item-list-wrapper .shipment-item-quantity input {
+ width: 50px;
+ text-align: center; }
+ .germanized-shipments #panel-order-shipments .order-shipment .shipment-items .shipment-item-list-wrapper .shipment-item-name p.form-row {
+ margin-bottom: 0;
+ margin-top: .5em; }
+ .germanized-shipments #panel-order-shipments .order-shipment .shipment-items .shipment-item-list-wrapper .shipment-item-heading {
+ padding: .5em;
+ color: #999;
+ background: #f8f8f8;
+ font-weight: 600; }
+ .germanized-shipments #panel-order-shipments .order-shipment .shipment-items .shipment-item-list-wrapper .shipment-item {
+ padding: .5em;
+ border-bottom: 1px solid #dfdfdf; }
+ .germanized-shipments #panel-order-shipments .order-shipment .shipment-items .shipment-item-list-wrapper .shipment-item:last-child {
+ border-bottom: none; }
+ .germanized-shipments #panel-order-shipments .order-shipment .shipment-items .shipment-item-list-wrapper .shipment-item:nth-child(2n) {
+ background: #f8f8f8; }
+ .germanized-shipments #panel-order-shipments .order-shipment .shipment-items .shipment-item-list-wrapper .shipment-item .columns {
+ align-items: center; }
+ .germanized-shipments #panel-order-shipments .order-shipment .shipment-item-actions {
+ display: flex;
+ padding: .7em .5em;
+ flex-wrap: nowrap;
+ justify-content: flex-end;
+ border-top: 1px solid #dfdfdf; }
+ .germanized-shipments #panel-order-shipments .order-shipment .shipment-item-actions .add-items {
+ margin-right: 1em; }
+ .germanized-shipments #panel-order-shipments .order-shipment .shipment-item-actions .woocommerce-help-tip {
+ margin-left: 0; }
+ .germanized-shipments #panel-order-shipments .order-shipment .add-items {
+ display: none; }
+ .germanized-shipments #panel-order-shipments .order-shipment .shipment-returns {
+ margin-top: .5em; }
+ .germanized-shipments #panel-order-shipments .order-shipment .shipment-returns .shipment-return .shipment-header {
+ background: transparent;
+ border-bottom: 1px solid #dfdfdf;
+ padding-left: 0;
+ padding-right: 0; }
+ .germanized-shipments #panel-order-shipments .order-shipment .shipment-returns .shipment-return .shipment-header h3 {
+ font-size: 1.1em; }
+ .germanized-shipments #panel-order-shipments .order-shipment .shipment-returns .shipment-return .shipment-content {
+ padding: 1em 0; }
+ .germanized-shipments #panel-order-shipments .order-shipment.needs-items .add-items {
+ display: block; }
+ .germanized-shipments #panel-order-shipments .form-row .input-inner-wrap {
+ clear: left;
+ margin: 0;
+ display: flex;
+ flex-wrap: nowrap; }
+ .germanized-shipments #panel-order-shipments .form-row .input-inner-wrap input {
+ margin-right: 1em; }
+ .germanized-shipments #panel-order-shipments .form-row .input-inner-wrap input:last-child {
+ margin-right: 0; }
+
+.germanized-shipments .title-spread {
+ display: flex;
+ flex-wrap: nowrap;
+ justify-content: space-between;
+ align-items: center; }
+ .germanized-shipments .title-spread .right, .germanized-shipments .title-spread .left {
+ display: inline-flex;
+ align-items: center; }
+
+.germanized-shipments .show-xs,
+.germanized-shipments .show-sm,
+.germanized-shipments .show-md,
+.germanized-shipments .show-lg,
+.germanized-shipments .show-xl {
+ display: none !important; }
+
+.germanized-shipments .columns {
+ display: flex;
+ flex-wrap: wrap;
+ margin-left: -1rem;
+ margin-right: -1rem; }
+ .germanized-shipments .columns.col-gapless {
+ margin-left: 0;
+ margin-right: 0; }
+ .germanized-shipments .columns.col-gapless > .column {
+ padding-left: 0;
+ padding-right: 0; }
+ .germanized-shipments .columns.col-oneline {
+ flex-wrap: nowrap;
+ overflow-x: auto; }
+
+.germanized-shipments .column {
+ flex: 1;
+ max-width: 100%;
+ padding-left: 1rem;
+ padding-right: 1rem; }
+ .germanized-shipments .column.col-12, .germanized-shipments .column.col-11, .germanized-shipments .column.col-10, .germanized-shipments .column.col-9, .germanized-shipments .column.col-8, .germanized-shipments .column.col-7, .germanized-shipments .column.col-6, .germanized-shipments .column.col-5, .germanized-shipments .column.col-4, .germanized-shipments .column.col-3, .germanized-shipments .column.col-2, .germanized-shipments .column.col-1, .germanized-shipments .column.col-auto {
+ flex: none; }
+
+.germanized-shipments .col-12 {
+ width: 100%; }
+
+.germanized-shipments .col-11 {
+ width: 91.66666667%; }
+
+.germanized-shipments .col-10 {
+ width: 83.33333333%; }
+
+.germanized-shipments .col-9 {
+ width: 75%; }
+
+.germanized-shipments .col-8 {
+ width: 66.66666667%; }
+
+.germanized-shipments .col-7 {
+ width: 58.33333333%; }
+
+.germanized-shipments .col-6 {
+ width: 50%; }
+
+.germanized-shipments .col-5 {
+ width: 41.66666667%; }
+
+.germanized-shipments .col-4 {
+ width: 33.33333333%; }
+
+.germanized-shipments .col-3 {
+ width: 25%; }
+
+.germanized-shipments .col-2 {
+ width: 16.66666667%; }
+
+.germanized-shipments .col-1 {
+ width: 8.33333333%; }
+
+.germanized-shipments .col-auto {
+ flex: 0 0 auto;
+ max-width: none;
+ width: auto; }
+
+.germanized-shipments .col-mx-auto {
+ margin-left: auto;
+ margin-right: auto; }
+
+.germanized-shipments .col-ml-auto {
+ margin-left: auto; }
+
+.germanized-shipments .col-mr-auto {
+ margin-right: auto; }
+
+@media (max-width: 1280px) {
+ .germanized-shipments .col-xl-12,
+ .germanized-shipments .col-xl-11,
+ .germanized-shipments .col-xl-10,
+ .germanized-shipments .col-xl-9,
+ .germanized-shipments .col-xl-8,
+ .germanized-shipments .col-xl-7,
+ .germanized-shipments .col-xl-6,
+ .germanized-shipments .col-xl-5,
+ .germanized-shipments .col-xl-4,
+ .germanized-shipments .col-xl-3,
+ .germanized-shipments .col-xl-2,
+ .germanized-shipments .col-xl-1,
+ .germanized-shipments .col-xl-auto {
+ flex: none; }
+ .germanized-shipments .col-xl-12 {
+ width: 100%; }
+ .germanized-shipments .col-xl-11 {
+ width: 91.66666667%; }
+ .germanized-shipments .col-xl-10 {
+ width: 83.33333333%; }
+ .germanized-shipments .col-xl-9 {
+ width: 75%; }
+ .germanized-shipments .col-xl-8 {
+ width: 66.66666667%; }
+ .germanized-shipments .col-xl-7 {
+ width: 58.33333333%; }
+ .germanized-shipments .col-xl-6 {
+ width: 50%; }
+ .germanized-shipments .col-xl-5 {
+ width: 41.66666667%; }
+ .germanized-shipments .col-xl-4 {
+ width: 33.33333333%; }
+ .germanized-shipments .col-xl-3 {
+ width: 25%; }
+ .germanized-shipments .col-xl-2 {
+ width: 16.66666667%; }
+ .germanized-shipments .col-xl-1 {
+ width: 8.33333333%; }
+ .germanized-shipments .col-xl-auto {
+ width: auto; }
+ .germanized-shipments .hide-xl {
+ display: none !important; }
+ .germanized-shipments .show-xl {
+ display: block !important; } }
+
+@media (max-width: 960px) {
+ .germanized-shipments .col-lg-12,
+ .germanized-shipments .col-lg-11,
+ .germanized-shipments .col-lg-10,
+ .germanized-shipments .col-lg-9,
+ .germanized-shipments .col-lg-8,
+ .germanized-shipments .col-lg-7,
+ .germanized-shipments .col-lg-6,
+ .germanized-shipments .col-lg-5,
+ .germanized-shipments .col-lg-4,
+ .germanized-shipments .col-lg-3,
+ .germanized-shipments .col-lg-2,
+ .germanized-shipments .col-lg-1,
+ .germanized-shipments .col-lg-auto {
+ flex: none; }
+ .germanized-shipments .col-lg-12 {
+ width: 100%; }
+ .germanized-shipments .col-lg-11 {
+ width: 91.66666667%; }
+ .germanized-shipments .col-lg-10 {
+ width: 83.33333333%; }
+ .germanized-shipments .col-lg-9 {
+ width: 75%; }
+ .germanized-shipments .col-lg-8 {
+ width: 66.66666667%; }
+ .germanized-shipments .col-lg-7 {
+ width: 58.33333333%; }
+ .germanized-shipments .col-lg-6 {
+ width: 50%; }
+ .germanized-shipments .col-lg-5 {
+ width: 41.66666667%; }
+ .germanized-shipments .col-lg-4 {
+ width: 33.33333333%; }
+ .germanized-shipments .col-lg-3 {
+ width: 25%; }
+ .germanized-shipments .col-lg-2 {
+ width: 16.66666667%; }
+ .germanized-shipments .col-lg-1 {
+ width: 8.33333333%; }
+ .germanized-shipments .col-lg-auto {
+ width: auto; }
+ .germanized-shipments .hide-lg {
+ display: none !important; }
+ .germanized-shipments .show-lg {
+ display: block !important; } }
+
+@media (max-width: 840px) {
+ .germanized-shipments .col-md-12,
+ .germanized-shipments .col-md-11,
+ .germanized-shipments .col-md-10,
+ .germanized-shipments .col-md-9,
+ .germanized-shipments .col-md-8,
+ .germanized-shipments .col-md-7,
+ .germanized-shipments .col-md-6,
+ .germanized-shipments .col-md-5,
+ .germanized-shipments .col-md-4,
+ .germanized-shipments .col-md-3,
+ .germanized-shipments .col-md-2,
+ .germanized-shipments .col-md-1,
+ .germanized-shipments .col-md-auto {
+ flex: none; }
+ .germanized-shipments .col-md-12 {
+ width: 100%; }
+ .germanized-shipments .col-md-11 {
+ width: 91.66666667%; }
+ .germanized-shipments .col-md-10 {
+ width: 83.33333333%; }
+ .germanized-shipments .col-md-9 {
+ width: 75%; }
+ .germanized-shipments .col-md-8 {
+ width: 66.66666667%; }
+ .germanized-shipments .col-md-7 {
+ width: 58.33333333%; }
+ .germanized-shipments .col-md-6 {
+ width: 50%; }
+ .germanized-shipments .col-md-5 {
+ width: 41.66666667%; }
+ .germanized-shipments .col-md-4 {
+ width: 33.33333333%; }
+ .germanized-shipments .col-md-3 {
+ width: 25%; }
+ .germanized-shipments .col-md-2 {
+ width: 16.66666667%; }
+ .germanized-shipments .col-md-1 {
+ width: 8.33333333%; }
+ .germanized-shipments .col-md-auto {
+ width: auto; }
+ .germanized-shipments .hide-md {
+ display: none !important; }
+ .germanized-shipments .show-md {
+ display: block !important; } }
+
+@media (max-width: 600px) {
+ .germanized-shipments .col-sm-12,
+ .germanized-shipments .col-sm-11,
+ .germanized-shipments .col-sm-10,
+ .germanized-shipments .col-sm-9,
+ .germanized-shipments .col-sm-8,
+ .germanized-shipments .col-sm-7,
+ .germanized-shipments .col-sm-6,
+ .germanized-shipments .col-sm-5,
+ .germanized-shipments .col-sm-4,
+ .germanized-shipments .col-sm-3,
+ .germanized-shipments .col-sm-2,
+ .germanized-shipments .col-sm-1,
+ .germanized-shipments .col-sm-auto {
+ flex: none; }
+ .germanized-shipments .col-sm-12 {
+ width: 100%; }
+ .germanized-shipments .col-sm-11 {
+ width: 91.66666667%; }
+ .germanized-shipments .col-sm-10 {
+ width: 83.33333333%; }
+ .germanized-shipments .col-sm-9 {
+ width: 75%; }
+ .germanized-shipments .col-sm-8 {
+ width: 66.66666667%; }
+ .germanized-shipments .col-sm-7 {
+ width: 58.33333333%; }
+ .germanized-shipments .col-sm-6 {
+ width: 50%; }
+ .germanized-shipments .col-sm-5 {
+ width: 41.66666667%; }
+ .germanized-shipments .col-sm-4 {
+ width: 33.33333333%; }
+ .germanized-shipments .col-sm-3 {
+ width: 25%; }
+ .germanized-shipments .col-sm-2 {
+ width: 16.66666667%; }
+ .germanized-shipments .col-sm-1 {
+ width: 8.33333333%; }
+ .germanized-shipments .col-sm-auto {
+ width: auto; }
+ .germanized-shipments .hide-sm {
+ display: none !important; }
+ .germanized-shipments .show-sm {
+ display: block !important; } }
+
+@media (max-width: 480px) {
+ .germanized-shipments .col-xs-12,
+ .germanized-shipments .col-xs-11,
+ .germanized-shipments .col-xs-10,
+ .germanized-shipments .col-xs-9,
+ .germanized-shipments .col-xs-8,
+ .germanized-shipments .col-xs-7,
+ .germanized-shipments .col-xs-6,
+ .germanized-shipments .col-xs-5,
+ .germanized-shipments .col-xs-4,
+ .germanized-shipments .col-xs-3,
+ .germanized-shipments .col-xs-2,
+ .germanized-shipments .col-xs-1,
+ .germanized-shipments .col-xs-auto {
+ flex: none; }
+ .germanized-shipments .col-xs-12 {
+ width: 100%; }
+ .germanized-shipments .col-xs-11 {
+ width: 91.66666667%; }
+ .germanized-shipments .col-xs-10 {
+ width: 83.33333333%; }
+ .germanized-shipments .col-xs-9 {
+ width: 75%; }
+ .germanized-shipments .col-xs-8 {
+ width: 66.66666667%; }
+ .germanized-shipments .col-xs-7 {
+ width: 58.33333333%; }
+ .germanized-shipments .col-xs-6 {
+ width: 50%; }
+ .germanized-shipments .col-xs-5 {
+ width: 41.66666667%; }
+ .germanized-shipments .col-xs-4 {
+ width: 33.33333333%; }
+ .germanized-shipments .col-xs-3 {
+ width: 25%; }
+ .germanized-shipments .col-xs-2 {
+ width: 16.66666667%; }
+ .germanized-shipments .col-xs-1 {
+ width: 8.33333333%; }
+ .germanized-shipments .col-xs-auto {
+ width: auto; }
+ .germanized-shipments .hide-xs {
+ display: none !important; }
+ .germanized-shipments .show-xs {
+ display: block !important; } }
\ No newline at end of file
diff --git a/packages/woocommerce-germanized-shipments/assets/css/admin.min.css b/packages/woocommerce-germanized-shipments/assets/css/admin.min.css
new file mode 100644
index 000000000..86e90e769
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/assets/css/admin.min.css
@@ -0,0 +1 @@
+.wc-modal-shipping-method-settings .form-table td .wc-gzd-additional-desc{margin-top:1em;line-height:1.5em;background:#efefef;padding:.5em;font-style:normal;font-size:13px;box-shadow:0 1px 1px 0 rgba(0,0,0,.1)}.germanized-create-label .notice-wrapper .notice{margin:0;margin-bottom:1em}.germanized-create-label .notice-wrapper .notice p{margin:.5em 0!important;padding:2px!important;font-size:13px;line-height:1.5}.germanized-create-label p.form-field{margin-bottom:5px!important;margin-top:5px!important}.germanized-create-label p.form-field:first-child,.germanized-create-label p.form-field:last-child{margin-bottom:5px!important;margin-top:5px!important}.germanized-create-label p.form-field:not(.column){display:inline-block;width:100%}.germanized-create-label .columns{margin-left:-.5rem!important;margin-right:-.5rem!important}.germanized-create-label .column{padding-left:.5rem!important;padding-right:.5rem!important}.germanized-create-label .hide-default,.germanized-create-label .show-if{display:none}.germanized-create-label .show-if label{color:#777}.germanized-create-label p.form-field label{width:100%;display:block;margin-bottom:5px;font-weight:700}.germanized-create-label p.form-field input[type=email],.germanized-create-label p.form-field input[type=text],.germanized-create-label p.form-field select{width:100%;max-width:100%}.germanized-create-label p.form-field.form-field-checkbox{display:flex;flex-wrap:wrap;flex-direction:row;justify-content:flex-start;margin-top:10px!important;margin-bottom:10px!important;align-items:center}.germanized-create-label p.form-field.form-field-checkbox label{width:auto;margin-left:.5em;font-weight:400;order:2;margin-bottom:0}.germanized-create-label p.form-field.form-field-checkbox input[type=checkbox]{order:1}.germanized-create-label p.form-field.form-field-checkbox .woocommerce-help-tip{order:3;margin-left:3px}.germanized-create-label p.form-field.form-field-checkbox .description{width:100%;margin-top:5px;color:#777;order:4;font-style:normal}table.wc-gzd-shipping-providers{margin-top:1.5em}table.wc-gzd-shipping-providers td,table.wc-gzd-shipping-providers th{display:table-cell!important;padding:1em!important;vertical-align:top;line-height:1.75em;font-size:14px}table.wc-gzd-shipping-providers th{font-weight:600}table.wc-gzd-shipping-providers td.wc-gzd-shipping-provider-activated,table.wc-gzd-shipping-providers th.wc-gzd-shipping-provider-activated{width:1%;text-align:center}table.wc-gzd-shipping-providers td.wc-gzd-shipping-provider-activated .status-disabled,table.wc-gzd-shipping-providers td.wc-gzd-shipping-provider-activated .status-enabled,table.wc-gzd-shipping-providers th.wc-gzd-shipping-provider-activated .status-disabled,table.wc-gzd-shipping-providers th.wc-gzd-shipping-provider-activated .status-enabled{display:inline-block;margin-top:3px}table.wc-gzd-shipping-providers td.wc-gzd-shipping-provider-actions,table.wc-gzd-shipping-providers th.wc-gzd-shipping-provider-actions{width:15%;text-align:right}table.wc-gzd-shipping-providers td.wc-gzd-shipping-provider-actions{display:flex;justify-content:flex-end;flex-wrap:wrap}table.wc-gzd-shipping-providers td.wc-gzd-shipping-provider-actions .button{margin-right:5px}table.wc-gzd-shipping-providers td.wc-gzd-shipping-provider-actions .button:last-child{margin-right:0}table.wc-gzd-shipping-providers td.wc-gzd-shipping-provider-title,table.wc-gzd-shipping-providers th.wc-gzd-shipping-provider-title{width:30ch}table.wc-gzd-shipping-providers tr:nth-child(odd) td{background:#f9f9f9}.order-return-status,.order-shipping-status,.shipment-status{background:#eee;padding:.2em .5em;font-size:.9em;border-radius:3px;display:inline-flex;white-space:nowrap}.order-return-status.status-draft,.order-return-status.status-open,.order-return-status.status-partially-returned,.order-return-status.status-partially-shipped,.order-return-status.status-processing,.order-return-status.status-requested,.order-shipping-status.status-draft,.order-shipping-status.status-open,.order-shipping-status.status-partially-returned,.order-shipping-status.status-partially-shipped,.order-shipping-status.status-processing,.order-shipping-status.status-requested,.shipment-status.status-draft,.shipment-status.status-open,.shipment-status.status-partially-returned,.shipment-status.status-partially-shipped,.shipment-status.status-processing,.shipment-status.status-requested{background:#f8dda7;color:#94660c}.order-return-status.status-not-shipped,.order-shipping-status.status-not-shipped,.shipment-status.status-not-shipped{background:#eba3a3;color:#761919}.order-return-status.status-delivered,.order-return-status.status-returned,.order-return-status.status-shipped,.order-shipping-status.status-delivered,.order-shipping-status.status-returned,.order-shipping-status.status-shipped,.shipment-status.status-delivered,.shipment-status.status-returned,.shipment-status.status-shipped{background:#c6e1c6;color:#5b841b}.order-return-status.shipment-type-return-status.status-shipped,.order-shipping-status.shipment-type-return-status.status-shipped,.shipment-status.shipment-type-return-status.status-shipped{background:#f8dda7;color:#94660c}.woocommerce_page_wc-gzd-return-shipments .tablenav .actions,.woocommerce_page_wc-gzd-shipments .tablenav .actions{overflow:visible}.woocommerce_page_wc-gzd-return-shipments .tablenav .select2-container,.woocommerce_page_wc-gzd-shipments .tablenav .select2-container{float:left;width:240px!important;font-size:14px;vertical-align:middle;margin:1px 6px 4px 1px}.woocommerce_page_wc-gzd-return-shipments .tablenav .select2-container .select2-selection--single,.woocommerce_page_wc-gzd-shipments .tablenav .select2-container .select2-selection--single{height:32px}.woocommerce_page_wc-gzd-return-shipments .tablenav .select2-container .select2-selection--single .select2-selection__rendered,.woocommerce_page_wc-gzd-shipments .tablenav .select2-container .select2-selection--single .select2-selection__rendered{line-height:29px}.woocommerce_page_wc-gzd-return-shipments .tablenav .select2-container .select2-selection--single .select2-selection__arrow,.woocommerce_page_wc-gzd-shipments .tablenav .select2-container .select2-selection--single .select2-selection__arrow{height:30px}.woocommerce_page_wc-gzd-return-shipments .tablenav input,.woocommerce_page_wc-gzd-return-shipments .tablenav select,.woocommerce_page_wc-gzd-shipments .tablenav input,.woocommerce_page_wc-gzd-shipments .tablenav select{line-height:1;height:32px}.woocommerce_page_wc-gzd-return-shipments .tablenav input,.woocommerce_page_wc-gzd-shipments .tablenav input{height:31px}.woocommerce_page_wc-gzd-return-shipments .tablenav #shipment-query-submit,.woocommerce_page_wc-gzd-shipments .tablenav #shipment-query-submit{margin:1px 8px 0 0}.woocommerce_page_wc-gzd-return-shipments #posts-filter .bulk-action-wrapper,.woocommerce_page_wc-gzd-shipments #posts-filter .bulk-action-wrapper{display:none;clear:both;margin:1em 0;float:left;width:50%}.woocommerce_page_wc-gzd-return-shipments #posts-filter .bulk-action-wrapper h4,.woocommerce_page_wc-gzd-shipments #posts-filter .bulk-action-wrapper h4{margin-top:0}.woocommerce_page_wc-gzd-return-shipments #posts-filter .bulk-action-wrapper progress,.woocommerce_page_wc-gzd-shipments #posts-filter .bulk-action-wrapper progress{width:100%;height:42px;margin:0 auto;display:block;-webkit-appearance:none;border:none;background:#f5f5f5;border:2px solid #eee;border-radius:4px;padding:0;box-shadow:0 1px 0 0 rgba(255,255,255,.2)}.woocommerce_page_wc-gzd-return-shipments #posts-filter .bulk-action-wrapper progress::-webkit-progress-bar,.woocommerce_page_wc-gzd-shipments #posts-filter .bulk-action-wrapper progress::-webkit-progress-bar{background:transparent none;border:0;border-radius:4px;padding:0;box-shadow:none}.woocommerce_page_wc-gzd-return-shipments #posts-filter .bulk-action-wrapper progress::-webkit-progress-value,.woocommerce_page_wc-gzd-shipments #posts-filter .bulk-action-wrapper progress::-webkit-progress-value{border-radius:3px;box-shadow:inset 0 1px 1px 0 rgba(255,255,255,.4);background:#a46497;background:linear-gradient(to bottom,#a46497,#66405f),#a46497;transition:width 1s ease}.woocommerce_page_wc-gzd-return-shipments #posts-filter .bulk-action-wrapper progress::-moz-progress-bar,.woocommerce_page_wc-gzd-shipments #posts-filter .bulk-action-wrapper progress::-moz-progress-bar{border-radius:3px;box-shadow:inset 0 1px 1px 0 rgba(255,255,255,.4);background:#a46497;background:linear-gradient(to bottom,#a46497,#66405f),#a46497;transition:width 1s ease}.woocommerce_page_wc-gzd-return-shipments #posts-filter .bulk-action-wrapper progress::-ms-fill,.woocommerce_page_wc-gzd-shipments #posts-filter .bulk-action-wrapper progress::-ms-fill{border-radius:3px;box-shadow:inset 0 1px 1px 0 rgba(255,255,255,.4);background:#a46497;background:linear-gradient(to bottom,#a46497,#66405f),#a46497;transition:width 1s ease}.woocommerce_page_wc-gzd-return-shipments #posts-filter.bulk-action-processing .bulk-action-wrapper,.woocommerce_page_wc-gzd-shipments #posts-filter.bulk-action-processing .bulk-action-wrapper{display:block}.woocommerce_page_wc-gzd-return-shipments .wp-list-table,.woocommerce_page_wc-gzd-shipments .wp-list-table{margin-top:1em}.woocommerce_page_wc-gzd-return-shipments .wp-list-table td,.woocommerce_page_wc-gzd-return-shipments .wp-list-table th,.woocommerce_page_wc-gzd-shipments .wp-list-table td,.woocommerce_page_wc-gzd-shipments .wp-list-table th{padding:.5em 1em;width:10ch;vertical-align:middle}.woocommerce_page_wc-gzd-return-shipments .wp-list-table tbody th,.woocommerce_page_wc-gzd-return-shipments .wp-list-table td,.woocommerce_page_wc-gzd-shipments .wp-list-table tbody th,.woocommerce_page_wc-gzd-shipments .wp-list-table td{line-height:26px}.woocommerce_page_wc-gzd-return-shipments .wp-list-table thead th,.woocommerce_page_wc-gzd-shipments .wp-list-table thead th{padding:.5em 1em}.woocommerce_page_wc-gzd-return-shipments .wp-list-table thead th.sortable a,.woocommerce_page_wc-gzd-return-shipments .wp-list-table thead th.sorted a,.woocommerce_page_wc-gzd-shipments .wp-list-table thead th.sortable a,.woocommerce_page_wc-gzd-shipments .wp-list-table thead th.sorted a{padding:0}.woocommerce_page_wc-gzd-return-shipments .wp-list-table thead th:last-child,.woocommerce_page_wc-gzd-shipments .wp-list-table thead th:last-child{padding-right:2em}.woocommerce_page_wc-gzd-return-shipments .wp-list-table .check-column,.woocommerce_page_wc-gzd-shipments .wp-list-table .check-column{width:16px;white-space:nowrap;padding:1em 1em 1em 1em!important;vertical-align:middle}.woocommerce_page_wc-gzd-return-shipments .wp-list-table .check-column input,.woocommerce_page_wc-gzd-shipments .wp-list-table .check-column input{vertical-align:text-top;margin:1px 0}.woocommerce_page_wc-gzd-return-shipments .wp-list-table td.column-title,.woocommerce_page_wc-gzd-shipments .wp-list-table td.column-title{font-weight:700}.woocommerce_page_wc-gzd-return-shipments .wp-list-table td.column-title .shipment-title-meta,.woocommerce_page_wc-gzd-shipments .wp-list-table td.column-title .shipment-title-meta{margin-top:0;font-weight:400;color:#999;font-size:12px}.woocommerce_page_wc-gzd-return-shipments .wp-list-table td.column-title .shipment-title-meta .shipment-tracking-id,.woocommerce_page_wc-gzd-shipments .wp-list-table td.column-title .shipment-title-meta .shipment-tracking-id{color:#999;display:block}.woocommerce_page_wc-gzd-return-shipments .wp-list-table .column-title,.woocommerce_page_wc-gzd-shipments .wp-list-table .column-title{width:20ch}.woocommerce_page_wc-gzd-return-shipments .wp-list-table .column-actions,.woocommerce_page_wc-gzd-shipments .wp-list-table .column-actions{width:10ch}.woocommerce_page_wc-gzd-return-shipments .wp-list-table .column-order,.woocommerce_page_wc-gzd-shipments .wp-list-table .column-order{width:10ch}.woocommerce_page_wc-gzd-return-shipments .wp-list-table .column-address a,.woocommerce_page_wc-gzd-return-shipments .wp-list-table .column-sender a,.woocommerce_page_wc-gzd-shipments .wp-list-table .column-address a,.woocommerce_page_wc-gzd-shipments .wp-list-table .column-sender a{color:#32373c}.woocommerce_page_wc-gzd-return-shipments .wp-list-table .shipment-status,.woocommerce_page_wc-gzd-shipments .wp-list-table .shipment-status{font-size:1em}.woocommerce_page_wc-gzd-return-shipments .wp-list-table .column-actions,.woocommerce_page_wc-gzd-shipments .wp-list-table .column-actions{text-align:right}.woocommerce_page_wc-gzd-return-shipments .wp-list-table .column-actions a.button,.woocommerce_page_wc-gzd-shipments .wp-list-table .column-actions a.button{text-indent:9999px;margin:2px 0 2px 4px;position:relative;display:inline-block;padding:0;height:2em;width:2em;overflow:hidden;vertical-align:middle}.woocommerce_page_wc-gzd-return-shipments .wp-list-table .column-actions a.button::after,.woocommerce_page_wc-gzd-shipments .wp-list-table .column-actions a.button::after{font-family:Dashicons;margin:0;margin-top:2px;speak:none;font-weight:400;font-variant:normal;text-transform:none;text-indent:0;position:absolute;top:0;left:0;width:100%;height:100%;text-align:center;line-height:1.85}.woocommerce_page_wc-gzd-return-shipments .wp-list-table .column-actions a.button.processing::after,.woocommerce_page_wc-gzd-shipments .wp-list-table .column-actions a.button.processing::after{font-family:WooCommerce;content:"\e00f"}.woocommerce_page_wc-gzd-return-shipments .wp-list-table .column-actions a.button.shipped::after,.woocommerce_page_wc-gzd-shipments .wp-list-table .column-actions a.button.shipped::after{content:"\f147"}.woocommerce_page_wc-gzd-return-shipments .wp-list-table .column-actions a.button.delivered::after,.woocommerce_page_wc-gzd-shipments .wp-list-table .column-actions a.button.delivered::after{content:"\f147"}.woocommerce_page_wc-gzd-return-shipments .wp-list-table .column-actions a.button.confirm::after,.woocommerce_page_wc-gzd-shipments .wp-list-table .column-actions a.button.confirm::after{content:"\f147"}.woocommerce_page_wc-gzd-return-shipments .wp-list-table .column-actions a.button.generate::after,.woocommerce_page_wc-gzd-shipments .wp-list-table .column-actions a.button.generate::after{content:"\f502"}.woocommerce_page_wc-gzd-return-shipments .wp-list-table .column-actions a.button.download::after,.woocommerce_page_wc-gzd-shipments .wp-list-table .column-actions a.button.download::after{content:"\f103"}.woocommerce_page_wc-gzd-return-shipments .wp-list-table .column-address,.woocommerce_page_wc-gzd-return-shipments .wp-list-table .column-sender,.woocommerce_page_wc-gzd-shipments .wp-list-table .column-address,.woocommerce_page_wc-gzd-shipments .wp-list-table .column-sender{width:20ch}.woocommerce_page_wc-gzd-return-shipments .wp-list-table .column-items,.woocommerce_page_wc-gzd-shipments .wp-list-table .column-items{width:20ch}.woocommerce_page_wc-gzd-return-shipments .wp-list-table #the-list .column-items table.wc-gzd-shipments-preview,.woocommerce_page_wc-gzd-shipments .wp-list-table #the-list .column-items table.wc-gzd-shipments-preview{font-size:.9em;border-spacing:0}.woocommerce_page_wc-gzd-return-shipments .wp-list-table #the-list .column-items table.wc-gzd-shipments-preview thead th,.woocommerce_page_wc-gzd-shipments .wp-list-table #the-list .column-items table.wc-gzd-shipments-preview thead th{color:#adadad;padding-top:0;font-size:1.1em}.woocommerce_page_wc-gzd-return-shipments .wp-list-table #the-list .column-items table.wc-gzd-shipments-preview tr td,.woocommerce_page_wc-gzd-shipments .wp-list-table #the-list .column-items table.wc-gzd-shipments-preview tr td{border-bottom:1px solid #ccc!important}.woocommerce_page_wc-gzd-return-shipments .wp-list-table #the-list .column-items table.wc-gzd-shipments-preview tr:last-child td,.woocommerce_page_wc-gzd-shipments .wp-list-table #the-list .column-items table.wc-gzd-shipments-preview tr:last-child td{border-bottom:none!important}.woocommerce_page_wc-gzd-return-shipments .wp-list-table #the-list .column-items table.wc-gzd-shipments-preview td,.woocommerce_page_wc-gzd-return-shipments .wp-list-table #the-list .column-items table.wc-gzd-shipments-preview th,.woocommerce_page_wc-gzd-shipments .wp-list-table #the-list .column-items table.wc-gzd-shipments-preview td,.woocommerce_page_wc-gzd-shipments .wp-list-table #the-list .column-items table.wc-gzd-shipments-preview th{padding:.3em 0;vertical-align:top;line-height:20px}.woocommerce_page_wc-gzd-return-shipments .wp-list-table #the-list .column-items table.wc-gzd-shipments-preview td.wc-gzd-shipment-item-column-name,.woocommerce_page_wc-gzd-return-shipments .wp-list-table #the-list .column-items table.wc-gzd-shipments-preview th.wc-gzd-shipment-item-column-name,.woocommerce_page_wc-gzd-shipments .wp-list-table #the-list .column-items table.wc-gzd-shipments-preview td.wc-gzd-shipment-item-column-name,.woocommerce_page_wc-gzd-shipments .wp-list-table #the-list .column-items table.wc-gzd-shipments-preview th.wc-gzd-shipment-item-column-name{width:70%}.woocommerce_page_wc-gzd-return-shipments .wp-list-table #the-list .column-items table.wc-gzd-shipments-preview td.wc-gzd-shipment-item-column-name small,.woocommerce_page_wc-gzd-return-shipments .wp-list-table #the-list .column-items table.wc-gzd-shipments-preview th.wc-gzd-shipment-item-column-name small,.woocommerce_page_wc-gzd-shipments .wp-list-table #the-list .column-items table.wc-gzd-shipments-preview td.wc-gzd-shipment-item-column-name small,.woocommerce_page_wc-gzd-shipments .wp-list-table #the-list .column-items table.wc-gzd-shipments-preview th.wc-gzd-shipment-item-column-name small{color:#999;font-size:12px}.woocommerce_page_wc-gzd-return-shipments .wp-list-table #the-list .column-items table.wc-gzd-shipments-preview td.wc-gzd-shipment-item-column-quantity,.woocommerce_page_wc-gzd-return-shipments .wp-list-table #the-list .column-items table.wc-gzd-shipments-preview th.wc-gzd-shipment-item-column-quantity,.woocommerce_page_wc-gzd-shipments .wp-list-table #the-list .column-items table.wc-gzd-shipments-preview td.wc-gzd-shipment-item-column-quantity,.woocommerce_page_wc-gzd-shipments .wp-list-table #the-list .column-items table.wc-gzd-shipments-preview th.wc-gzd-shipment-item-column-quantity{text-align:right;padding-right:.5em}#woocommerce-gzd-order-shipments .inside{margin:0;padding:0;display:block!important}#woocommerce-gzd-order-shipments .handlediv,#woocommerce-gzd-order-shipments .hndle,#woocommerce-gzd-order-shipments .postbox-header{display:none}#woocommerce-gzd-order-shipments .hide-default{display:none}.germanized-shipments *{box-sizing:border-box}.germanized-shipments #panel-order-shipments{padding:23px 0 0}.germanized-shipments #panel-order-shipments .panel-inner{padding:0 24px}.germanized-shipments #panel-order-shipments .panel-title-inner{padding-left:0;margin-top:1em;padding-right:0}.germanized-shipments #panel-order-shipments .panel-title{margin-bottom:1.5em}.germanized-shipments #panel-order-shipments .panel-title h2{margin:0;font-family:HelveticaNeue-Light,"Helvetica Neue Light","Helvetica Neue",sans-serif;font-size:21px;font-weight:400;line-height:1.2;text-shadow:1px 1px 1px #fff;padding:0}.germanized-shipments #panel-order-shipments .panel-footer{background:#f8f8f8;padding-top:1em;padding-bottom:1em;border-top:1px solid #dfdfdf;display:none}.germanized-shipments #panel-order-shipments .panel-footer .order-shipments-actions{display:flex;flex-wrap:nowrap;justify-content:space-between}.germanized-shipments #panel-order-shipments .panel-footer .order-shipments-actions .shipment-actions-left{display:flex;flex-wrap:wrap;justify-content:flex-start}.germanized-shipments #panel-order-shipments .panel-footer .order-shipments-actions .shipment-actions-left .button{margin-right:1em}.germanized-shipments #panel-order-shipments .panel-footer #order-shipments-save{display:none}.germanized-shipments #panel-order-shipments #order-return-shipment-add,.germanized-shipments #panel-order-shipments #order-shipment-add{display:none}.germanized-shipments #panel-order-shipments.needs-shipments .panel-footer{display:block}.germanized-shipments #panel-order-shipments.needs-shipments #order-shipment-add{display:block}.germanized-shipments #panel-order-shipments.needs-returns .panel-footer{display:block}.germanized-shipments #panel-order-shipments.needs-returns #order-return-shipment-add{display:block}.germanized-shipments #panel-order-shipments #order-shipments-list{margin-bottom:1.5em}.germanized-shipments #panel-order-shipments .delete{color:#a00}.germanized-shipments #panel-order-shipments .delete:hover{color:#dc3232;border:none}.germanized-shipments #panel-order-shipments .order-shipment a .woocommerce-help-tip{margin-right:3px}.germanized-shipments #panel-order-shipments .order-shipment .handlediv{display:inline-block;float:none;width:auto;height:auto}.germanized-shipments #panel-order-shipments .order-shipment .handlediv .toggle-indicator::before{content:"\f140"}.germanized-shipments #panel-order-shipments .order-shipment .wc-gzd-shipment-label h4{margin-top:0}.germanized-shipments #panel-order-shipments .order-shipment .wc-gzd-shipment-label .shipment-label-actions .shipment-label-actions-wrapper{display:flex;flex-wrap:wrap;justify-content:flex-start;margin-bottom:1em;align-items:center}.germanized-shipments #panel-order-shipments .order-shipment .wc-gzd-shipment-label .shipment-label-actions .shipment-label-actions-wrapper a{margin-right:1em}.germanized-shipments #panel-order-shipments .order-shipment .show-if{display:none}.germanized-shipments #panel-order-shipments .order-shipment.active>.shipment-content-wrapper{display:block}.germanized-shipments #panel-order-shipments .order-shipment.active>.shipment-header>.right>.handlediv .toggle-indicator::before{content:"\f142"}.germanized-shipments #panel-order-shipments .order-shipment .item-count{margin-right:1em}.germanized-shipments #panel-order-shipments .order-shipment .shipment-footer{margin-top:1em}.germanized-shipments #panel-order-shipments .order-shipment .shipment-footer .shipment-footer-inner{display:flex;flex-wrap:nowrap;justify-content:flex-end;padding:0 .5em}.germanized-shipments #panel-order-shipments .order-shipment .shipment-footer .shipment-footer-inner a.shipment-footer-action{margin-right:1em}.germanized-shipments #panel-order-shipments .order-shipment .shipment-footer .shipment-footer-inner a.shipment-footer-action:last-child{margin-right:0}.germanized-shipments #panel-order-shipments .order-shipment .shipment-header{color:#999;background:#f8f8f8;margin:1.5em 0;padding:.5em 1em;cursor:pointer}.germanized-shipments #panel-order-shipments .order-shipment .shipment-header .shipment-status{margin-left:1em}.germanized-shipments #panel-order-shipments .order-shipment .shipment-header h3{margin:0}.germanized-shipments #panel-order-shipments .order-shipment:first-child .shipment-header{margin-top:0}.germanized-shipments #panel-order-shipments .order-shipment .shipment-header:hover,.germanized-shipments #panel-order-shipments .order-shipment.active>.shipment-header{background:#f3f3f3}.germanized-shipments #panel-order-shipments .order-shipment .shipment-content-wrapper{display:none}.germanized-shipments #panel-order-shipments .order-shipment .shipment-content{padding:1em;margin-top:-1.5em;padding-bottom:0}.germanized-shipments #panel-order-shipments .order-shipment .add-shipment-return{display:none}.germanized-shipments #panel-order-shipments .order-shipment.is-returnable .add-shipment-return{display:block}.germanized-shipments #panel-order-shipments .order-shipment p.form-row{margin-bottom:1.5em}.germanized-shipments #panel-order-shipments .order-shipment p.form-row.wc-gzd-shipment-packaging-wrapper{margin-top:0}.germanized-shipments #panel-order-shipments .order-shipment p.form-row input[type=email],.germanized-shipments #panel-order-shipments .order-shipment p.form-row input[type=number],.germanized-shipments #panel-order-shipments .order-shipment p.form-row input[type=text]{height:30px}.germanized-shipments #panel-order-shipments .order-shipment p.form-row select{line-height:30px;height:30px;padding-top:0;padding-bottom:0}.germanized-shipments #panel-order-shipments .order-shipment p.form-row label{color:#999;font-weight:600}.germanized-shipments #panel-order-shipments .order-shipment p.form-row label .woocommerce-help-tip{float:none}.germanized-shipments #panel-order-shipments .order-shipment .columns .column.column-spaced{margin:5px 0}.germanized-shipments #panel-order-shipments .order-shipment .columns .column h4{margin-bottom:.7em;color:#999}.germanized-shipments #panel-order-shipments .order-shipment .columns .column h4 a{color:#999;text-decoration:none}.germanized-shipments #panel-order-shipments .order-shipment .shipment-items .shipment-item-list-wrapper .shipment-item-action{text-align:right}.germanized-shipments #panel-order-shipments .order-shipment .shipment-items .shipment-item-list-wrapper .shipment-item-quantity input{width:50px;text-align:center}.germanized-shipments #panel-order-shipments .order-shipment .shipment-items .shipment-item-list-wrapper .shipment-item-name p.form-row{margin-bottom:0;margin-top:.5em}.germanized-shipments #panel-order-shipments .order-shipment .shipment-items .shipment-item-list-wrapper .shipment-item-heading{padding:.5em;color:#999;background:#f8f8f8;font-weight:600}.germanized-shipments #panel-order-shipments .order-shipment .shipment-items .shipment-item-list-wrapper .shipment-item{padding:.5em;border-bottom:1px solid #dfdfdf}.germanized-shipments #panel-order-shipments .order-shipment .shipment-items .shipment-item-list-wrapper .shipment-item:last-child{border-bottom:none}.germanized-shipments #panel-order-shipments .order-shipment .shipment-items .shipment-item-list-wrapper .shipment-item:nth-child(2n){background:#f8f8f8}.germanized-shipments #panel-order-shipments .order-shipment .shipment-items .shipment-item-list-wrapper .shipment-item .columns{align-items:center}.germanized-shipments #panel-order-shipments .order-shipment .shipment-item-actions{display:flex;padding:.7em .5em;flex-wrap:nowrap;justify-content:flex-end;border-top:1px solid #dfdfdf}.germanized-shipments #panel-order-shipments .order-shipment .shipment-item-actions .add-items{margin-right:1em}.germanized-shipments #panel-order-shipments .order-shipment .shipment-item-actions .woocommerce-help-tip{margin-left:0}.germanized-shipments #panel-order-shipments .order-shipment .add-items{display:none}.germanized-shipments #panel-order-shipments .order-shipment .shipment-returns{margin-top:.5em}.germanized-shipments #panel-order-shipments .order-shipment .shipment-returns .shipment-return .shipment-header{background:0 0;border-bottom:1px solid #dfdfdf;padding-left:0;padding-right:0}.germanized-shipments #panel-order-shipments .order-shipment .shipment-returns .shipment-return .shipment-header h3{font-size:1.1em}.germanized-shipments #panel-order-shipments .order-shipment .shipment-returns .shipment-return .shipment-content{padding:1em 0}.germanized-shipments #panel-order-shipments .order-shipment.needs-items .add-items{display:block}.germanized-shipments #panel-order-shipments .form-row .input-inner-wrap{clear:left;margin:0;display:flex;flex-wrap:nowrap}.germanized-shipments #panel-order-shipments .form-row .input-inner-wrap input{margin-right:1em}.germanized-shipments #panel-order-shipments .form-row .input-inner-wrap input:last-child{margin-right:0}.germanized-shipments .title-spread{display:flex;flex-wrap:nowrap;justify-content:space-between;align-items:center}.germanized-shipments .title-spread .left,.germanized-shipments .title-spread .right{display:inline-flex;align-items:center}.germanized-shipments .show-lg,.germanized-shipments .show-md,.germanized-shipments .show-sm,.germanized-shipments .show-xl,.germanized-shipments .show-xs{display:none!important}.germanized-shipments .columns{display:flex;flex-wrap:wrap;margin-left:-1rem;margin-right:-1rem}.germanized-shipments .columns.col-gapless{margin-left:0;margin-right:0}.germanized-shipments .columns.col-gapless>.column{padding-left:0;padding-right:0}.germanized-shipments .columns.col-oneline{flex-wrap:nowrap;overflow-x:auto}.germanized-shipments .column{flex:1;max-width:100%;padding-left:1rem;padding-right:1rem}.germanized-shipments .column.col-1,.germanized-shipments .column.col-10,.germanized-shipments .column.col-11,.germanized-shipments .column.col-12,.germanized-shipments .column.col-2,.germanized-shipments .column.col-3,.germanized-shipments .column.col-4,.germanized-shipments .column.col-5,.germanized-shipments .column.col-6,.germanized-shipments .column.col-7,.germanized-shipments .column.col-8,.germanized-shipments .column.col-9,.germanized-shipments .column.col-auto{flex:none}.germanized-shipments .col-12{width:100%}.germanized-shipments .col-11{width:91.66666667%}.germanized-shipments .col-10{width:83.33333333%}.germanized-shipments .col-9{width:75%}.germanized-shipments .col-8{width:66.66666667%}.germanized-shipments .col-7{width:58.33333333%}.germanized-shipments .col-6{width:50%}.germanized-shipments .col-5{width:41.66666667%}.germanized-shipments .col-4{width:33.33333333%}.germanized-shipments .col-3{width:25%}.germanized-shipments .col-2{width:16.66666667%}.germanized-shipments .col-1{width:8.33333333%}.germanized-shipments .col-auto{flex:0 0 auto;max-width:none;width:auto}.germanized-shipments .col-mx-auto{margin-left:auto;margin-right:auto}.germanized-shipments .col-ml-auto{margin-left:auto}.germanized-shipments .col-mr-auto{margin-right:auto}@media (max-width:1280px){.germanized-shipments .col-xl-1,.germanized-shipments .col-xl-10,.germanized-shipments .col-xl-11,.germanized-shipments .col-xl-12,.germanized-shipments .col-xl-2,.germanized-shipments .col-xl-3,.germanized-shipments .col-xl-4,.germanized-shipments .col-xl-5,.germanized-shipments .col-xl-6,.germanized-shipments .col-xl-7,.germanized-shipments .col-xl-8,.germanized-shipments .col-xl-9,.germanized-shipments .col-xl-auto{flex:none}.germanized-shipments .col-xl-12{width:100%}.germanized-shipments .col-xl-11{width:91.66666667%}.germanized-shipments .col-xl-10{width:83.33333333%}.germanized-shipments .col-xl-9{width:75%}.germanized-shipments .col-xl-8{width:66.66666667%}.germanized-shipments .col-xl-7{width:58.33333333%}.germanized-shipments .col-xl-6{width:50%}.germanized-shipments .col-xl-5{width:41.66666667%}.germanized-shipments .col-xl-4{width:33.33333333%}.germanized-shipments .col-xl-3{width:25%}.germanized-shipments .col-xl-2{width:16.66666667%}.germanized-shipments .col-xl-1{width:8.33333333%}.germanized-shipments .col-xl-auto{width:auto}.germanized-shipments .hide-xl{display:none!important}.germanized-shipments .show-xl{display:block!important}}@media (max-width:960px){.germanized-shipments .col-lg-1,.germanized-shipments .col-lg-10,.germanized-shipments .col-lg-11,.germanized-shipments .col-lg-12,.germanized-shipments .col-lg-2,.germanized-shipments .col-lg-3,.germanized-shipments .col-lg-4,.germanized-shipments .col-lg-5,.germanized-shipments .col-lg-6,.germanized-shipments .col-lg-7,.germanized-shipments .col-lg-8,.germanized-shipments .col-lg-9,.germanized-shipments .col-lg-auto{flex:none}.germanized-shipments .col-lg-12{width:100%}.germanized-shipments .col-lg-11{width:91.66666667%}.germanized-shipments .col-lg-10{width:83.33333333%}.germanized-shipments .col-lg-9{width:75%}.germanized-shipments .col-lg-8{width:66.66666667%}.germanized-shipments .col-lg-7{width:58.33333333%}.germanized-shipments .col-lg-6{width:50%}.germanized-shipments .col-lg-5{width:41.66666667%}.germanized-shipments .col-lg-4{width:33.33333333%}.germanized-shipments .col-lg-3{width:25%}.germanized-shipments .col-lg-2{width:16.66666667%}.germanized-shipments .col-lg-1{width:8.33333333%}.germanized-shipments .col-lg-auto{width:auto}.germanized-shipments .hide-lg{display:none!important}.germanized-shipments .show-lg{display:block!important}}@media (max-width:840px){.germanized-shipments .col-md-1,.germanized-shipments .col-md-10,.germanized-shipments .col-md-11,.germanized-shipments .col-md-12,.germanized-shipments .col-md-2,.germanized-shipments .col-md-3,.germanized-shipments .col-md-4,.germanized-shipments .col-md-5,.germanized-shipments .col-md-6,.germanized-shipments .col-md-7,.germanized-shipments .col-md-8,.germanized-shipments .col-md-9,.germanized-shipments .col-md-auto{flex:none}.germanized-shipments .col-md-12{width:100%}.germanized-shipments .col-md-11{width:91.66666667%}.germanized-shipments .col-md-10{width:83.33333333%}.germanized-shipments .col-md-9{width:75%}.germanized-shipments .col-md-8{width:66.66666667%}.germanized-shipments .col-md-7{width:58.33333333%}.germanized-shipments .col-md-6{width:50%}.germanized-shipments .col-md-5{width:41.66666667%}.germanized-shipments .col-md-4{width:33.33333333%}.germanized-shipments .col-md-3{width:25%}.germanized-shipments .col-md-2{width:16.66666667%}.germanized-shipments .col-md-1{width:8.33333333%}.germanized-shipments .col-md-auto{width:auto}.germanized-shipments .hide-md{display:none!important}.germanized-shipments .show-md{display:block!important}}@media (max-width:600px){.germanized-shipments .col-sm-1,.germanized-shipments .col-sm-10,.germanized-shipments .col-sm-11,.germanized-shipments .col-sm-12,.germanized-shipments .col-sm-2,.germanized-shipments .col-sm-3,.germanized-shipments .col-sm-4,.germanized-shipments .col-sm-5,.germanized-shipments .col-sm-6,.germanized-shipments .col-sm-7,.germanized-shipments .col-sm-8,.germanized-shipments .col-sm-9,.germanized-shipments .col-sm-auto{flex:none}.germanized-shipments .col-sm-12{width:100%}.germanized-shipments .col-sm-11{width:91.66666667%}.germanized-shipments .col-sm-10{width:83.33333333%}.germanized-shipments .col-sm-9{width:75%}.germanized-shipments .col-sm-8{width:66.66666667%}.germanized-shipments .col-sm-7{width:58.33333333%}.germanized-shipments .col-sm-6{width:50%}.germanized-shipments .col-sm-5{width:41.66666667%}.germanized-shipments .col-sm-4{width:33.33333333%}.germanized-shipments .col-sm-3{width:25%}.germanized-shipments .col-sm-2{width:16.66666667%}.germanized-shipments .col-sm-1{width:8.33333333%}.germanized-shipments .col-sm-auto{width:auto}.germanized-shipments .hide-sm{display:none!important}.germanized-shipments .show-sm{display:block!important}}@media (max-width:480px){.germanized-shipments .col-xs-1,.germanized-shipments .col-xs-10,.germanized-shipments .col-xs-11,.germanized-shipments .col-xs-12,.germanized-shipments .col-xs-2,.germanized-shipments .col-xs-3,.germanized-shipments .col-xs-4,.germanized-shipments .col-xs-5,.germanized-shipments .col-xs-6,.germanized-shipments .col-xs-7,.germanized-shipments .col-xs-8,.germanized-shipments .col-xs-9,.germanized-shipments .col-xs-auto{flex:none}.germanized-shipments .col-xs-12{width:100%}.germanized-shipments .col-xs-11{width:91.66666667%}.germanized-shipments .col-xs-10{width:83.33333333%}.germanized-shipments .col-xs-9{width:75%}.germanized-shipments .col-xs-8{width:66.66666667%}.germanized-shipments .col-xs-7{width:58.33333333%}.germanized-shipments .col-xs-6{width:50%}.germanized-shipments .col-xs-5{width:41.66666667%}.germanized-shipments .col-xs-4{width:33.33333333%}.germanized-shipments .col-xs-3{width:25%}.germanized-shipments .col-xs-2{width:16.66666667%}.germanized-shipments .col-xs-1{width:8.33333333%}.germanized-shipments .col-xs-auto{width:auto}.germanized-shipments .hide-xs{display:none!important}.germanized-shipments .show-xs{display:block!important}}
\ No newline at end of file
diff --git a/packages/woocommerce-germanized-shipments/assets/css/admin.scss b/packages/woocommerce-germanized-shipments/assets/css/admin.scss
new file mode 100644
index 000000000..882bfb4fd
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/assets/css/admin.scss
@@ -0,0 +1,1318 @@
+@import '../../node_modules/spectre.css/src/variables';
+
+$layout-spacing: 1rem;
+
+.wc-modal-shipping-method-settings .form-table td .wc-gzd-additional-desc {
+ margin-top: 1em;
+ line-height: 1.5em;
+ background: #efefef;
+ padding: .5em;
+ font-style: normal;
+ font-size: 13px;
+ box-shadow: 0 1px 1px 0 rgba(0, 0, 0, 0.1);
+}
+
+.germanized-create-label {
+ .notice-wrapper {
+ .notice {
+ margin: 0;
+ margin-bottom: 1em;
+
+ p {
+ margin: 0.5em 0 !important;
+ padding: 2px !important;
+ font-size: 13px;
+ line-height: 1.5;
+ }
+ }
+ }
+
+ p.form-field {
+ &:first-child, &:last-child {
+ margin-bottom: 5px !important;
+ margin-top: 5px !important;
+ }
+ &:not(.column) {
+ display: inline-block;
+ width: 100%;
+ }
+
+ margin-bottom: 5px !important;
+ margin-top: 5px !important;
+ }
+
+ .columns {
+ margin-left: -.5rem !important;
+ margin-right: -.5rem !important;
+ }
+
+ .column {
+ padding-left: .5rem !important;
+ padding-right: .5rem !important;
+ }
+
+ .show-if, .hide-default {
+ display: none;
+ }
+
+ .show-if {
+ label {
+ color: #777;
+ }
+ }
+
+ p.form-field {
+ label {
+ width: 100%;
+ display: block;
+ margin-bottom: 5px;
+ font-weight: bold;
+ }
+ select, input[type=text], input[type=email] {
+ width: 100%;
+ max-width: 100%;
+ }
+
+ &.form-field-checkbox {
+ display: flex;
+ flex-wrap: wrap;
+ flex-direction: row;
+ justify-content: flex-start;
+ margin-top: 10px !important;
+ margin-bottom: 10px !important;
+ align-items: center;
+
+ label {
+ width: auto;
+ margin-left: .5em;
+ font-weight: normal;
+ order: 2;
+ margin-bottom: 0;
+ }
+
+ input[type=checkbox] {
+ order: 1;
+ }
+
+ .woocommerce-help-tip {
+ order: 3;
+ margin-left: 3px;
+ }
+
+ .description {
+ width: 100%;
+ margin-top: 5px;
+ color: #777;
+ order: 4;
+ font-style: normal;
+ }
+ }
+ }
+}
+
+table.wc-gzd-shipping-providers {
+ margin-top: 1.5em;
+
+ th, td {
+ display: table-cell !important;
+ padding: 1em !important;
+ vertical-align: top;
+ line-height: 1.75em;
+ font-size: 14px;
+ }
+
+ th {
+ font-weight: 600;
+ }
+
+ td.wc-gzd-shipping-provider-activated, th.wc-gzd-shipping-provider-activated {
+ width: 1%;
+ text-align: center;
+
+ .status-disabled, .status-enabled {
+ display: inline-block;
+ margin-top: 3px;
+ }
+ }
+
+ td.wc-gzd-shipping-provider-actions, th.wc-gzd-shipping-provider-actions {
+ width: 15%;
+ text-align: right;
+ }
+
+ td.wc-gzd-shipping-provider-actions {
+ display: flex;
+ justify-content: flex-end;
+ flex-wrap: wrap;
+
+ .button {
+ margin-right: 5px;
+
+ &:last-child {
+ margin-right: 0;
+ }
+ }
+ }
+
+ td.wc-gzd-shipping-provider-title, th.wc-gzd-shipping-provider-title {
+ width: 30ch;
+ }
+
+ tr:nth-child(odd) td {
+ background: #f9f9f9;
+ }
+}
+
+.shipment-status, .order-shipping-status, .order-return-status {
+ background: #eee;
+ padding: .2em .5em;
+ font-size: .9em;
+ border-radius: 3px;
+ display: inline-flex;
+ white-space: nowrap;
+
+ &.status-draft, &.status-processing, &.status-requested, &.status-partially-shipped, &.status-open, &.status-partially-returned {
+ background: #f8dda7;
+ color: #94660c;
+ }
+
+ &.status-not-shipped {
+ background: #eba3a3;
+ color: #761919;
+ }
+
+ &.status-delivered, &.status-shipped, &.status-shipped, &.status-returned {
+ background: #c6e1c6;
+ color: #5b841b;
+ }
+
+ &.shipment-type-return-status.status-shipped {
+ background: #f8dda7;
+ color: #94660c;
+ }
+}
+
+.woocommerce_page_wc-gzd-shipments, .woocommerce_page_wc-gzd-return-shipments {
+
+ .tablenav {
+ .actions {
+ overflow: visible;
+ }
+
+ .select2-container {
+ float: left;
+ width: 240px!important;
+ font-size: 14px;
+ vertical-align: middle;
+ margin: 1px 6px 4px 1px;
+
+ .select2-selection--single {
+ height: 32px;
+
+ .select2-selection__rendered {
+ line-height: 29px;
+ }
+
+ .select2-selection__arrow {
+ height: 30px;
+ }
+ }
+ }
+
+ select, input {
+ line-height: 1;
+ height: 32px;
+ }
+
+ input {
+ height: 31px;
+ }
+
+ #shipment-query-submit {
+ margin: 1px 8px 0 0;
+ }
+ }
+
+ #posts-filter {
+ .bulk-action-wrapper {
+ display: none;
+ clear: both;
+ margin: 1em 0;
+ float: left;
+ width: 50%;
+
+ h4 {
+ margin-top: 0;
+ }
+
+ progress {
+ width: 100%;
+ height: 42px;
+ margin: 0 auto;
+ display: block;
+ -webkit-appearance: none;
+ border: none;
+ background: #f5f5f5;
+ border: 2px solid #eee;
+ border-radius: 4px;
+ padding: 0;
+ box-shadow: 0 1px 0 0 rgba(255, 255, 255, 0.2);
+ }
+
+ progress::-webkit-progress-bar {
+ background: transparent none;
+ border: 0;
+ border-radius: 4px;
+ padding: 0;
+ box-shadow: none;
+ }
+
+ progress::-webkit-progress-value {
+ border-radius: 3px;
+ box-shadow: inset 0 1px 1px 0 rgba(255, 255, 255, 0.4);
+ background: #a46497;
+ background: linear-gradient(to bottom, #a46497, #66405f), #a46497;
+ transition: width 1s ease;
+ }
+
+ progress::-moz-progress-bar {
+ border-radius: 3px;
+ box-shadow: inset 0 1px 1px 0 rgba(255, 255, 255, 0.4);
+ background: #a46497;
+ background: linear-gradient(to bottom, #a46497, #66405f), #a46497;
+ transition: width 1s ease;
+ }
+
+ progress::-ms-fill {
+ border-radius: 3px;
+ box-shadow: inset 0 1px 1px 0 rgba(255, 255, 255, 0.4);
+ background: #a46497;
+ background: linear-gradient(to bottom, #a46497, #66405f), #a46497;
+ transition: width 1s ease;
+ }
+ }
+
+ &.bulk-action-processing {
+ .bulk-action-wrapper {
+ display: block;
+ }
+ }
+ }
+
+ .wp-list-table {
+ margin-top: 1em;
+
+ td, th {
+ padding: .5em 1em;
+ width: 10ch;
+ vertical-align: middle;
+ }
+
+ td, tbody th {
+ line-height: 26px;
+ }
+
+ thead {
+ th {
+ padding: .5em 1em;
+
+ &.sortable a, &.sorted a {
+ padding: 0;
+ }
+
+ &:last-child {
+ padding-right: 2em;
+ }
+ }
+ }
+
+ .check-column {
+ width: 16px;
+ white-space: nowrap;
+ padding: 1em 1em 1em 1em !important;
+ vertical-align: middle;
+
+ input {
+ vertical-align: text-top;
+ margin: 1px 0;
+ }
+ }
+
+ td.column-title {
+ font-weight: bold;
+
+ .shipment-title-meta {
+ margin-top: 0;
+ font-weight: normal;
+ color: #999;
+ font-size: 12px;
+
+ .shipment-tracking-id {
+ color: #999;
+ display: block;
+ }
+ }
+ }
+
+ .column-title {
+ width: 20ch;
+ }
+
+ .column-actions {
+ width: 10ch;
+ }
+
+ .column-order {
+ width: 10ch;
+ }
+
+ .column-address, .column-sender {
+ a {
+ color: #32373c;
+ }
+ }
+
+ .shipment-status {
+ font-size: 1em;
+ }
+
+ .column-actions {
+ text-align: right;
+
+ a.button {
+ text-indent: 9999px;
+ margin: 2px 0 2px 4px;
+ position: relative;
+ display: inline-block;
+ padding: 0;
+ height: 2em;
+ width: 2em;
+ overflow: hidden;
+ vertical-align: middle;
+
+ &::after {
+ font-family: Dashicons;
+ margin: 0;
+ margin-top: 2px;
+ speak: none;
+ font-weight: 400;
+ font-variant: normal;
+ text-transform: none;
+ text-indent: 0;
+ position: absolute;
+ top: 0;
+ left: 0;
+ width: 100%;
+ height: 100%;
+ text-align: center;
+ line-height: 1.85;
+ }
+
+ &.processing::after {
+ font-family: WooCommerce;
+ content: "\e00f";
+ }
+
+ &.shipped::after {
+ content: "\f147";
+ }
+
+ &.delivered::after {
+ content: "\f147";
+ }
+
+ &.confirm::after {
+ content: "\f147";
+ }
+
+ &.generate::after {
+ content: "\f502";
+ }
+
+ &.download::after {
+ content: "\f103";
+ }
+ }
+ }
+
+ .column-address, .column-sender {
+ width: 20ch;
+ }
+
+ .column-items {
+ width: 20ch;
+ }
+
+ #the-list {
+ .column-items {
+ table.wc-gzd-shipments-preview {
+ font-size: .9em;
+ border-spacing: 0;
+
+ thead {
+ th {
+ color: #adadad;
+ padding-top: 0;
+ font-size: 1.1em;
+ }
+ }
+
+ tr {
+ td {
+ border-bottom: 1px solid #ccc !important;
+ }
+
+ &:last-child {
+ td {
+ border-bottom: none !important;
+ }
+ }
+ }
+
+ th, td {
+ padding: .3em 0;
+ vertical-align: top;
+ line-height: 20px;
+
+ &.wc-gzd-shipment-item-column-name {
+ width: 70%;
+
+ small {
+ color: #999;
+ font-size: 12px;
+ }
+ }
+
+ &.wc-gzd-shipment-item-column-quantity {
+ text-align: right;
+ padding-right: .5em;
+ }
+ }
+ }
+ }
+ }
+ }
+}
+
+#woocommerce-gzd-order-shipments {
+ .inside {
+ margin: 0;
+ padding: 0;
+ display: block !important;
+ }
+
+ .hndle, .handlediv, .postbox-header {
+ display: none;
+ }
+
+ .hide-default {
+ display: none;
+ }
+}
+
+.germanized-shipments {
+ * {
+ box-sizing: border-box;
+ }
+
+ #panel-order-shipments {
+ padding: 23px 0 0;
+
+ .panel-inner {
+ padding: 0 24px;
+ }
+
+ .panel-title-inner {
+ padding-left: 0;
+ margin-top: 1em;
+ padding-right: 0;
+ }
+
+ .panel-title {
+ h2 {
+ margin: 0;
+ font-family: HelveticaNeue-Light,"Helvetica Neue Light","Helvetica Neue",sans-serif;
+ font-size: 21px;
+ font-weight: 400;
+ line-height: 1.2;
+ text-shadow: 1px 1px 1px #fff;
+ padding: 0;
+ }
+
+ margin-bottom: 1.5em;
+ }
+
+ .panel-footer {
+ background: #f8f8f8;
+ padding-top: 1em;
+ padding-bottom: 1em;
+ border-top: 1px solid #dfdfdf;
+ display: none;
+
+ .order-shipments-actions {
+ display: flex;
+ flex-wrap: nowrap;
+ justify-content: space-between;
+
+ .shipment-actions-left {
+ display: flex;
+ flex-wrap: wrap;
+ justify-content: flex-start;
+
+ .button {
+ margin-right: 1em;
+ }
+ }
+ }
+
+ #order-shipments-save {
+ display: none;
+ }
+ }
+
+ #order-shipment-add, #order-return-shipment-add {
+ display: none;
+ }
+
+ &.needs-shipments {
+ .panel-footer {
+ display: block;
+ }
+ #order-shipment-add {
+ display: block;
+ }
+ }
+
+ &.needs-returns {
+ .panel-footer {
+ display: block;
+ }
+ #order-return-shipment-add {
+ display: block;
+ }
+ }
+
+ #order-shipments-list {
+ margin-bottom: 1.5em;
+ }
+
+ .delete {
+ color: #a00;
+
+ &:hover {
+ color: #dc3232;
+ border: none;
+ }
+ }
+
+ .order-shipment {
+ a {
+ .woocommerce-help-tip {
+ margin-right: 3px;
+ }
+ }
+ .handlediv {
+ display: inline-block;
+ float: none;
+ width: auto;
+ height: auto;
+ .toggle-indicator {
+ &::before {
+ content: "\f140";
+ }
+ }
+ }
+
+ .wc-gzd-shipment-label {
+ h4 {
+ margin-top: 0;
+ }
+
+ .shipment-label-actions {
+ .shipment-label-actions-wrapper {
+ display: flex;
+ flex-wrap: wrap;
+ justify-content: flex-start;
+ margin-bottom: 1em;
+ align-items: center;
+
+ a {
+ margin-right: 1em;
+ }
+ }
+ }
+ }
+
+ .show-if {
+ display: none;
+ }
+
+ &.active {
+ > .shipment-content-wrapper {
+ display: block;
+ }
+
+ > .shipment-header > .right > .handlediv .toggle-indicator {
+ &::before {
+ content: "\f142";
+ }
+ }
+ }
+
+ .item-count {
+ margin-right: 1em;
+ }
+
+ .shipment-footer {
+ margin-top: 1em;
+
+ .shipment-footer-inner {
+ display: flex;
+ flex-wrap: nowrap;
+ justify-content: flex-end;
+ padding: 0 .5em;
+
+ a.shipment-footer-action {
+ margin-right: 1em;
+
+ &:last-child {
+ margin-right: 0;
+ }
+ }
+ }
+ }
+
+ .shipment-header {
+ color: #999;
+ background: #f8f8f8;
+ margin: 1.5em 0;
+ padding: .5em 1em;
+ cursor: pointer;
+
+ .shipment-status {
+ margin-left: 1em;
+ }
+
+ h3 {
+ margin: 0;
+ }
+ }
+
+ &:first-child {
+ .shipment-header {
+ margin-top: 0;
+ }
+ }
+
+ &.active > .shipment-header, .shipment-header:hover {
+ background: darken(#f8f8f8, 2%);
+ }
+
+ .shipment-content-wrapper {
+ display: none;
+ }
+
+ .shipment-content {
+ padding: 1em;
+ margin-top: -1.5em;
+ padding-bottom: 0;
+ }
+
+ .add-shipment-return {
+ display: none;
+ }
+
+ &.is-returnable {
+ .add-shipment-return {
+ display: block;
+ }
+ }
+
+ p.form-row {
+ margin-bottom: 1.5em;
+
+ &.wc-gzd-shipment-packaging-wrapper {
+ margin-top: 0;
+ }
+
+ input[type=text], input[type=number], input[type=email] {
+ height: 30px;
+ }
+
+ select {
+ line-height: 30px;
+ height: 30px;
+ padding-top: 0;
+ padding-bottom: 0;
+ }
+
+ label {
+ color: #999;
+ font-weight: 600;
+
+ .woocommerce-help-tip {
+ float: none;
+ }
+ }
+ }
+
+ .columns {
+ .column {
+ &.column-spaced {
+ margin: 5px 0;
+ }
+
+ h4 {
+ margin-bottom: .7em;
+ color: #999;
+
+ a {
+ color: #999;
+ text-decoration: none;
+ }
+ }
+ }
+ }
+
+ .column-shipment-documents {
+
+ }
+
+ .shipment-items {
+ .shipment-item-list-wrapper {
+ .shipment-item-action {
+ text-align: right;
+ }
+
+ .shipment-item-quantity {
+ input {
+ width: 50px;
+ text-align: center;
+ }
+ }
+
+ .shipment-item-name {
+ p.form-row {
+ margin-bottom: 0;
+ margin-top: .5em;
+ }
+ }
+
+ .shipment-item-heading {
+ padding: .5em;
+ color: #999;
+ background: #f8f8f8;
+ font-weight: 600;
+ }
+
+ .shipment-item {
+ padding: .5em;
+ border-bottom: 1px solid #dfdfdf;
+
+ &:last-child {
+ border-bottom: none;
+ }
+
+ &:nth-child(2n) {
+ background: #f8f8f8;
+ }
+
+ .columns {
+ align-items: center;
+ }
+ }
+ }
+ }
+
+ .shipment-item-actions {
+ display: flex;
+ padding: .7em .5em;
+ flex-wrap: nowrap;
+ justify-content: flex-end;
+ border-top: 1px solid #dfdfdf;
+
+ .add-items {
+ margin-right: 1em;
+ }
+
+ .woocommerce-help-tip {
+ margin-left: 0;
+ }
+ }
+
+ .add-items {
+ display: none;
+ }
+
+ .shipment-returns {
+ margin-top: .5em;
+
+ .shipment-return {
+ .shipment-header {
+ background: transparent;
+ border-bottom: 1px solid #dfdfdf;
+ padding-left: 0;
+ padding-right: 0;
+
+ h3 {
+ font-size: 1.1em;
+ }
+ }
+
+ .shipment-content {
+ padding: 1em 0;
+ }
+ }
+ }
+
+ &.needs-items {
+ .add-items {
+ display: block;
+ }
+ }
+ }
+
+ .form-row {
+ .input-inner-wrap {
+ clear: left;
+ margin: 0;
+ display: flex;
+ flex-wrap: nowrap;
+
+ input {
+ margin-right: 1em;
+
+ &:last-child {
+ margin-right: 0;
+ }
+ }
+ }
+ }
+ }
+
+ .title-spread {
+ display: flex;
+ flex-wrap: nowrap;
+ justify-content: space-between;
+ align-items: center;
+
+ .right, .left {
+ display: inline-flex;
+ align-items: center;
+ }
+ }
+
+ // Responsive breakpoint system
+ .show-xs,
+ .show-sm,
+ .show-md,
+ .show-lg,
+ .show-xl {
+ display: none !important;
+ }
+
+ // Responsive grid system
+ .columns {
+ display: flex;
+ flex-wrap: wrap;
+ margin-left: -$layout-spacing;
+ margin-right: -$layout-spacing;
+
+ &.col-gapless {
+ margin-left: 0;
+ margin-right: 0;
+
+ & > .column {
+ padding-left: 0;
+ padding-right: 0;
+ }
+ }
+ &.col-oneline {
+ flex-wrap: nowrap;
+ overflow-x: auto;
+ }
+ }
+ .column {
+ flex: 1;
+ max-width: 100%;
+ padding-left: $layout-spacing;
+ padding-right: $layout-spacing;
+
+ &.col-12,
+ &.col-11,
+ &.col-10,
+ &.col-9,
+ &.col-8,
+ &.col-7,
+ &.col-6,
+ &.col-5,
+ &.col-4,
+ &.col-3,
+ &.col-2,
+ &.col-1,
+ &.col-auto {
+ flex: none;
+ }
+ }
+ .col-12 {
+ width: 100%;
+ }
+ .col-11 {
+ width: 91.66666667%;
+ }
+ .col-10 {
+ width: 83.33333333%;
+ }
+ .col-9 {
+ width: 75%;
+ }
+ .col-8 {
+ width: 66.66666667%;
+ }
+ .col-7 {
+ width: 58.33333333%;
+ }
+ .col-6 {
+ width: 50%;
+ }
+ .col-5 {
+ width: 41.66666667%;
+ }
+ .col-4 {
+ width: 33.33333333%;
+ }
+ .col-3 {
+ width: 25%;
+ }
+ .col-2 {
+ width: 16.66666667%;
+ }
+ .col-1 {
+ width: 8.33333333%;
+ }
+ .col-auto {
+ flex: 0 0 auto;
+ max-width: none;
+ width: auto;
+ }
+ .col-mx-auto {
+ margin-left: auto;
+ margin-right: auto;
+ }
+ .col-ml-auto {
+ margin-left: auto;
+ }
+ .col-mr-auto {
+ margin-right: auto;
+ }
+ @media (max-width: $size-xl) {
+ .col-xl-12,
+ .col-xl-11,
+ .col-xl-10,
+ .col-xl-9,
+ .col-xl-8,
+ .col-xl-7,
+ .col-xl-6,
+ .col-xl-5,
+ .col-xl-4,
+ .col-xl-3,
+ .col-xl-2,
+ .col-xl-1,
+ .col-xl-auto {
+ flex: none;
+ }
+ .col-xl-12 {
+ width: 100%;
+ }
+ .col-xl-11 {
+ width: 91.66666667%;
+ }
+ .col-xl-10 {
+ width: 83.33333333%;
+ }
+ .col-xl-9 {
+ width: 75%;
+ }
+ .col-xl-8 {
+ width: 66.66666667%;
+ }
+ .col-xl-7 {
+ width: 58.33333333%;
+ }
+ .col-xl-6 {
+ width: 50%;
+ }
+ .col-xl-5 {
+ width: 41.66666667%;
+ }
+ .col-xl-4 {
+ width: 33.33333333%;
+ }
+ .col-xl-3 {
+ width: 25%;
+ }
+ .col-xl-2 {
+ width: 16.66666667%;
+ }
+ .col-xl-1 {
+ width: 8.33333333%;
+ }
+ .col-xl-auto {
+ width: auto;
+ }
+ .hide-xl {
+ display: none !important;
+ }
+ .show-xl {
+ display: block !important;
+ }
+ }
+ @media (max-width: $size-lg) {
+ .col-lg-12,
+ .col-lg-11,
+ .col-lg-10,
+ .col-lg-9,
+ .col-lg-8,
+ .col-lg-7,
+ .col-lg-6,
+ .col-lg-5,
+ .col-lg-4,
+ .col-lg-3,
+ .col-lg-2,
+ .col-lg-1,
+ .col-lg-auto {
+ flex: none;
+ }
+ .col-lg-12 {
+ width: 100%;
+ }
+ .col-lg-11 {
+ width: 91.66666667%;
+ }
+ .col-lg-10 {
+ width: 83.33333333%;
+ }
+ .col-lg-9 {
+ width: 75%;
+ }
+ .col-lg-8 {
+ width: 66.66666667%;
+ }
+ .col-lg-7 {
+ width: 58.33333333%;
+ }
+ .col-lg-6 {
+ width: 50%;
+ }
+ .col-lg-5 {
+ width: 41.66666667%;
+ }
+ .col-lg-4 {
+ width: 33.33333333%;
+ }
+ .col-lg-3 {
+ width: 25%;
+ }
+ .col-lg-2 {
+ width: 16.66666667%;
+ }
+ .col-lg-1 {
+ width: 8.33333333%;
+ }
+ .col-lg-auto {
+ width: auto;
+ }
+ .hide-lg {
+ display: none !important;
+ }
+ .show-lg {
+ display: block !important;
+ }
+ }
+ @media (max-width: $size-md) {
+ .col-md-12,
+ .col-md-11,
+ .col-md-10,
+ .col-md-9,
+ .col-md-8,
+ .col-md-7,
+ .col-md-6,
+ .col-md-5,
+ .col-md-4,
+ .col-md-3,
+ .col-md-2,
+ .col-md-1,
+ .col-md-auto {
+ flex: none;
+ }
+ .col-md-12 {
+ width: 100%;
+ }
+ .col-md-11 {
+ width: 91.66666667%;
+ }
+ .col-md-10 {
+ width: 83.33333333%;
+ }
+ .col-md-9 {
+ width: 75%;
+ }
+ .col-md-8 {
+ width: 66.66666667%;
+ }
+ .col-md-7 {
+ width: 58.33333333%;
+ }
+ .col-md-6 {
+ width: 50%;
+ }
+ .col-md-5 {
+ width: 41.66666667%;
+ }
+ .col-md-4 {
+ width: 33.33333333%;
+ }
+ .col-md-3 {
+ width: 25%;
+ }
+ .col-md-2 {
+ width: 16.66666667%;
+ }
+ .col-md-1 {
+ width: 8.33333333%;
+ }
+ .col-md-auto {
+ width: auto;
+ }
+ .hide-md {
+ display: none !important;
+ }
+ .show-md {
+ display: block !important;
+ }
+ }
+ @media (max-width: $size-sm) {
+ .col-sm-12,
+ .col-sm-11,
+ .col-sm-10,
+ .col-sm-9,
+ .col-sm-8,
+ .col-sm-7,
+ .col-sm-6,
+ .col-sm-5,
+ .col-sm-4,
+ .col-sm-3,
+ .col-sm-2,
+ .col-sm-1,
+ .col-sm-auto {
+ flex: none;
+ }
+ .col-sm-12 {
+ width: 100%;
+ }
+ .col-sm-11 {
+ width: 91.66666667%;
+ }
+ .col-sm-10 {
+ width: 83.33333333%;
+ }
+ .col-sm-9 {
+ width: 75%;
+ }
+ .col-sm-8 {
+ width: 66.66666667%;
+ }
+ .col-sm-7 {
+ width: 58.33333333%;
+ }
+ .col-sm-6 {
+ width: 50%;
+ }
+ .col-sm-5 {
+ width: 41.66666667%;
+ }
+ .col-sm-4 {
+ width: 33.33333333%;
+ }
+ .col-sm-3 {
+ width: 25%;
+ }
+ .col-sm-2 {
+ width: 16.66666667%;
+ }
+ .col-sm-1 {
+ width: 8.33333333%;
+ }
+ .col-sm-auto {
+ width: auto;
+ }
+ .hide-sm {
+ display: none !important;
+ }
+ .show-sm {
+ display: block !important;
+ }
+ }
+ @media (max-width: $size-xs) {
+ .col-xs-12,
+ .col-xs-11,
+ .col-xs-10,
+ .col-xs-9,
+ .col-xs-8,
+ .col-xs-7,
+ .col-xs-6,
+ .col-xs-5,
+ .col-xs-4,
+ .col-xs-3,
+ .col-xs-2,
+ .col-xs-1,
+ .col-xs-auto {
+ flex: none;
+ }
+ .col-xs-12 {
+ width: 100%;
+ }
+ .col-xs-11 {
+ width: 91.66666667%;
+ }
+ .col-xs-10 {
+ width: 83.33333333%;
+ }
+ .col-xs-9 {
+ width: 75%;
+ }
+ .col-xs-8 {
+ width: 66.66666667%;
+ }
+ .col-xs-7 {
+ width: 58.33333333%;
+ }
+ .col-xs-6 {
+ width: 50%;
+ }
+ .col-xs-5 {
+ width: 41.66666667%;
+ }
+ .col-xs-4 {
+ width: 33.33333333%;
+ }
+ .col-xs-3 {
+ width: 25%;
+ }
+ .col-xs-2 {
+ width: 16.66666667%;
+ }
+ .col-xs-1 {
+ width: 8.33333333%;
+ }
+ .col-xs-auto {
+ width: auto;
+ }
+ .hide-xs {
+ display: none !important;
+ }
+ .show-xs {
+ display: block !important;
+ }
+ }
+}
\ No newline at end of file
diff --git a/packages/woocommerce-germanized-shipments/assets/js/admin-shipment-label-backbone.js b/packages/woocommerce-germanized-shipments/assets/js/admin-shipment-label-backbone.js
new file mode 100644
index 000000000..9b720833f
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/assets/js/admin-shipment-label-backbone.js
@@ -0,0 +1,278 @@
+window.germanized = window.germanized || {};
+window.germanized.admin = window.germanized.admin || {};
+
+( function( $, admin ) {
+
+ /**
+ * Core
+ */
+ admin.shipment_label_backbone = {
+
+ params: {},
+
+ init: function () {
+ var self = germanized.admin.shipment_label_backbone;
+ self.params = wc_gzd_admin_shipment_label_backbone_params;
+
+ $( document )
+ .on( 'click', '.germanized-create-label .show-further-services', self.onExpandServices )
+ .on( 'click', '.germanized-create-label .show-fewer-services', self.onHideServices )
+ .on( 'change', '.germanized-create-label input.show-if-trigger', self.onShowIf )
+ .on( 'click', '.germanized-create-label .notice .notice-dismiss', self.onRemoveNotice )
+ .on( 'change', '.germanized-create-label #product_id', self.onChangeProductId );
+
+ $( document.body )
+ .on( 'wc_backbone_modal_loaded', self.backbone.init )
+ .on( 'wc_backbone_modal_response', self.backbone.response );
+ },
+
+ onChangeProductId: function() {
+ var self = germanized.admin.shipment_label_backbone;
+
+ self.showOrHideServices( $( this ).val() );
+ },
+
+ showOrHideServices: function( productId ) {
+ var $services = $( '.show-if-further-services' ).find( 'p.form-field' );
+
+ $services.each( function() {
+ var $service = $( this ),
+ $serviceField = $service.find( ':input' ),
+ supported = $serviceField.data( 'products-supported' ) ? $serviceField.data( 'products-supported' ).split( ',' ) : [],
+ isHidden = false;
+
+ if ( $serviceField.data( 'products-supported' ) ) {
+ isHidden = true;
+
+ if ( $.inArray( productId, supported ) !== -1 ) {
+ isHidden = false;
+ }
+ }
+
+ if ( isHidden ) {
+ $service.hide();
+ } else {
+ $service.show();
+ }
+ } );
+ },
+
+ onRemoveNotice: function() {
+ $( this ).parents( '.notice' ).slideUp( 150, function() {
+ $( this ).remove();
+ });
+ },
+
+ onShowIf: function() {
+ var $wrapper = $( this ).parents( '.germanized-create-label' ),
+ $show = $wrapper.find( $( this ).data( 'show-if' ) ),
+ $checkbox = $( this );
+
+ if ( $show.length > 0 ) {
+ if ( $checkbox.is( ':checked' ) ) {
+ $show.show();
+ } else {
+ $show.hide();
+ }
+
+ $( document.body ).trigger( 'wc_gzd_shipment_label_show_if' );
+ }
+ },
+
+ onExpandServices: function() {
+ var $wrapper = $( this ).parents( '.germanized-create-label' ).find( '.show-if-further-services' ),
+ $trigger = $( this ).parents( '.show-services-trigger' );
+
+ $wrapper.show();
+
+ $trigger.find( '.show-further-services' ).hide();
+ $trigger.find( '.show-fewer-services' ).show();
+
+ return false;
+ },
+
+ onHideServices: function() {
+ var $wrapper = $( this ).parents( '.germanized-create-label' ).find( '.show-if-further-services' ),
+ $trigger = $( this ).parents( '.show-services-trigger' );
+
+ $wrapper.hide();
+
+ $trigger.find( '.show-further-services' ).show();
+ $trigger.find( '.show-fewer-services' ).hide();
+
+ return false;
+ },
+
+ backbone: {
+
+ getShipmentId: function( target ) {
+ return target.replace( /^\D+/g, '' );
+ },
+
+ init: function( e, target ) {
+ if ( target.indexOf( 'wc-gzd-modal-create-shipment-label' ) !== -1 ) {
+ var self = germanized.admin.shipment_label_backbone.backbone,
+ backbone = germanized.admin.shipment_label_backbone,
+ $modal = $( '.germanized-create-label' ).parents( '.wc-backbone-modal-content' ),
+ shipmentId = self.getShipmentId( target ),
+ params = {
+ 'action' : 'woocommerce_gzd_create_shipment_label_form',
+ 'shipment_id': shipmentId,
+ 'security' : backbone.params.create_label_form_nonce
+ };
+
+ self.doAjax( params, $modal, self.onInitForm );
+ }
+ },
+
+ onAjaxSuccess: function( data ) {
+
+ },
+
+ onAjaxError: function( data ) {
+
+ },
+
+ doAjax: function( params, $wrapper, cSuccess, cError ) {
+ var self = germanized.admin.shipment_label_backbone.backbone,
+ backbone = germanized.admin.shipment_label_backbone,
+ $content = $wrapper.find( '.germanized-create-label' );
+
+ cSuccess = cSuccess || self.onAjaxSuccess;
+ cError = cError || self.onAjaxError;
+
+ if ( ! params.hasOwnProperty( 'shipment_id' ) ) {
+ params['shipment_id'] = $( '#wc-gzd-shipment-label-admin-shipment-id' ).val();
+ }
+
+ $wrapper.block({
+ message: null,
+ overlayCSS: {
+ background: '#fff',
+ opacity: 0.6
+ }
+ });
+
+ $wrapper.find( '.notice-wrapper' ).empty();
+
+ $.ajax({
+ type: "POST",
+ url: backbone.params.ajax_url,
+ data: params,
+ success: function( data ) {
+ if ( data.success ) {
+ if ( data.fragments ) {
+ $.each( data.fragments, function ( key, value ) {
+ $( key ).replaceWith( value );
+ });
+ }
+ $wrapper.unblock();
+ cSuccess.apply( $content, [ data ] );
+ } else {
+ $wrapper.unblock();
+ cError.apply( $content, [ data ] );
+
+ $.each( data.messages, function( i, message ) {
+ self.addNotice( message, 'error', $content );
+ });
+
+ // ScrollTo top of modal
+ $content.animate({
+ scrollTop: 0
+ }, 500 );
+ }
+ },
+ error: function( data ) {},
+ dataType: 'json'
+ });
+ },
+
+ onInitForm: function( data ) {
+ var self = germanized.admin.shipment_label_backbone.backbone,
+ shipmentId = data['shipment_id'],
+ $modal = $( '.germanized-create-label' );
+
+ $( document.body ).trigger( 'wc-enhanced-select-init' );
+ $( document.body ).trigger( 'wc-init-datepickers' );
+ $( document.body ).trigger( 'wc_gzd_shipment_label_after_init' );
+
+ $modal.find( 'input.show-if-trigger' ).trigger( 'change' );
+ $modal.find( '#product_id' ).trigger( 'change' );
+
+ $modal.parents( '.wc-backbone-modal' ).on( 'click', '#btn-ok', { 'shipmentId': shipmentId }, self.onSubmit );
+ $modal.parents( '.wc-backbone-modal' ).on( 'touchstart', '#btn-ok', { 'shipmentId': shipmentId }, self.onSubmit );
+ $modal.parents( '.wc-backbone-modal' ).on( 'keydown', { 'shipmentId': shipmentId }, self.onKeyDown );
+ },
+
+ getFormData: function( $form ) {
+ var data = {};
+
+ $.each( $form.serializeArray(), function( index, item ) {
+ if ( item.name.indexOf( '[]' ) !== -1 ) {
+ item.name = item.name.replace( '[]', '' );
+ data[ item.name ] = $.makeArray( data[ item.name ] );
+ data[ item.name ].push( item.value );
+ } else {
+ data[ item.name ] = item.value;
+ }
+ });
+
+ return data;
+ },
+
+ onSubmitSuccess: function( data ) {
+ var self = germanized.admin.shipment_label_backbone.backbone,
+ $modal = $( this ).parents( '.wc-backbone-modal-content' ),
+ shipmentId = data['shipment_id'];
+
+ $modal.find( '.modal-close' ).trigger( 'click' );
+
+ if ( $( 'div#shipment-' + shipmentId ).length > 0 ) {
+ germanized.admin.shipments.initShipment( shipmentId );
+ }
+ },
+
+ onKeyDown: function( e ) {
+ var self = germanized.admin.shipment_label_backbone.backbone,
+ button = e.keyCode || e.which;
+
+ // Enter key
+ if ( 13 === button && ! ( e.target.tagName && ( e.target.tagName.toLowerCase() === 'input' || e.target.tagName.toLowerCase() === 'textarea' ) ) ) {
+ self.onSubmit.apply( $( this ).find( 'button#btn-ok' ), [ e ] );
+ }
+ },
+
+ onSubmit: function( e ) {
+ var self = germanized.admin.shipment_label_backbone.backbone,
+ backbone = germanized.admin.shipment_label_backbone,
+ shipmentId = e.data.shipmentId,
+ $modal = $( this ).parents( '.wc-backbone-modal-content' ),
+ $content = $modal.find( '.germanized-create-label' ),
+ $form = $content.find( 'form' ),
+ params = self.getFormData( $form );
+
+ params['security'] = backbone.params.create_label_nonce;
+ params['shipment_id'] = shipmentId;
+ params['action'] = 'woocommerce_gzd_create_shipment_label';
+
+ self.doAjax( params, $modal, self.onSubmitSuccess );
+
+ e.preventDefault();
+ e.stopPropagation();
+ },
+
+ addNotice: function( message, noticeType, $wrapper ) {
+ $wrapper.find( '.notice-wrapper' ).append( '
+ composer install',
+ '' . esc_html( str_replace( ABSPATH, '', __DIR__ ) ) . ''
+ );
+ ?>
+
' + message + '
'+e+'
')},response:function(e,n,a){n.indexOf("wc-gzd-modal-create-shipment-label")}}},c(document).ready(function(){germanized.admin.shipment_label_backbone.init()})}(jQuery); \ No newline at end of file diff --git a/packages/woocommerce-germanized-shipments/assets/js/admin-shipment.js b/packages/woocommerce-germanized-shipments/assets/js/admin-shipment.js new file mode 100644 index 000000000..4af5a14c7 --- /dev/null +++ b/packages/woocommerce-germanized-shipments/assets/js/admin-shipment.js @@ -0,0 +1,525 @@ +window.germanized = window.germanized || {}; +window.germanized.admin = window.germanized.admin || {}; + +( function( $, admin ) { + + $.GermanizedShipment = function( shipmentId ) { + + /* + * Variables accessible + * in the class + */ + this.vars = { + $shipment : false, + params : {}, + id : '', + isEditable : true, + needsItems : true + }; + + /* + * Can access this.method + * inside other methods using + * root.method() + */ + this.root = this; + + /* + * Constructor + */ + this.construct = function( shipmentId ) { + this.vars.id = shipmentId; + this.vars.params = germanized.admin.shipments.getParams(); + + this.refreshDom(); + + $( document.body ) + .on( 'wc_backbone_modal_loaded', this.backbone.init.bind( this ) ) + .on( 'wc_backbone_modal_response', this.backbone.response.bind( this ) ); + }; + + this.refreshDom = function() { + this.vars.$shipment = $( '#order-shipments-list' ).find( '#shipment-' + this.getId() ); + + this.setNeedsItems( this.vars.$shipment.hasClass( 'needs-items' ) ); + this.setIsEditable( this.vars.$shipment.hasClass( 'is-editable' ) ); + this.onChangeProvider(); + + $( '#shipment-' + this.vars.id + ' #shipment-items-' + this.vars.id ).off(); + $( '#shipment-' + this.vars.id + ' #shipment-footer-' + this.vars.id ).off(); + $( '#shipment-' + this.vars.id + ' #shipment-shipping-provider-' + this.vars.id ).off(); + $( '#shipment-' + this.vars.id + ' #shipment-packaging-' + this.vars.id ).off(); + $( '#shipment-' + this.vars.id + ' .wc-gzd-shipment-label' ).off(); + + $( '#shipment-' + this.vars.id + ' #shipment-shipping-provider-' + this.vars.id ).on( 'change', this.onChangeProvider.bind( this ) ); + $( '#shipment-' + this.vars.id + ' #shipment-packaging-' + this.vars.id ).on( 'change', this.refreshDimensions.bind( this ) ); + + $( '#shipment-' + this.vars.id + ' #shipment-items-' + this.vars.id ) + .on( 'change', '.item-quantity', this.onChangeQuantity.bind( this ) ) + .on( 'click', 'a.remove-shipment-item', this.onRemoveItem.bind( this ) ) + .on( 'click', 'a.add-shipment-item', this.onAddItem.bind( this ) ) + .on( 'click', 'a.sync-shipment-items', this.onSyncItems.bind( this ) ); + + $( '#shipment-' + this.vars.id + ' #shipment-footer-' + this.vars.id ) + .on( 'click', '.send-return-shipment-notification', this.onSendReturnNotification.bind( this ) ) + .on( 'click', '.confirm-return-shipment', this.onConfirmReturnRequest.bind( this ) ); + + $( '#shipment-' + this.vars.id + ' .wc-gzd-shipment-label' ) + .on( 'click', '.create-shipment-label:not(.disabled)', this.onCreateLabel.bind( this ) ) + .on( 'click', '.remove-shipment-label', this.onRemoveLabel.bind( this ) ); + }; + + this.refreshDimensions = function() { + var $shipment = this.getShipment(), + $select = $shipment.find( '#shipment-packaging-' + this.getId() ), + $selected = $select.find( 'option:selected' ); + + // No packaging selected - allow manual dimension control + if ( '' === $selected.val() ) { + $shipment.find( '#shipment-length-' + this.getId() ).removeClass( 'disabled' ).prop( 'disabled', false ); + $shipment.find( '#shipment-length-' + this.getId() ).val( '' ); + + $shipment.find( '#shipment-width-' + this.getId() ).removeClass( 'disabled' ).prop( 'disabled', false ); + $shipment.find( '#shipment-width-' + this.getId() ).val( '' ); + + $shipment.find( '#shipment-height-' + this.getId() ).removeClass( 'disabled' ).prop( 'disabled', false ); + $shipment.find( '#shipment-height-' + this.getId() ).val( '' ); + } else { + $shipment.find( '#shipment-length-' + this.getId() ).addClass( 'disabled' ).prop( 'disabled', true ); + $shipment.find( '#shipment-length-' + this.getId() ).val( $selected.data( 'length' ) ); + + $shipment.find( '#shipment-width-' + this.getId() ).addClass( 'disabled' ).prop( 'disabled', true ); + $shipment.find( '#shipment-width-' + this.getId() ).val( $selected.data( 'width' ) ); + + $shipment.find( '#shipment-height-' + this.getId() ).addClass( 'disabled' ).prop( 'disabled', true ); + $shipment.find( '#shipment-height-' + this.getId() ).val( $selected.data( 'height' ) ); + } + }; + + this.blockPackaging = function() { + this.getShipmentContent().find( '.wc-gzd-shipment-packaging-wrapper' ).block({ + message: null, + overlayCSS: { + background: '#fff', + opacity: 0.6 + } + }); + }; + + this.unblockPackaging = function() { + this.getShipmentContent().find( '.wc-gzd-shipment-packaging-wrapper' ).unblock(); + }; + + this.refreshPackaging = function() { + var params = { + 'action' : 'woocommerce_gzd_refresh_shipment_packaging', + 'shipment_id' : this.getId(), + 'security' : germanized.admin.shipments.getParams().refresh_packaging_nonce + }; + + this.blockPackaging(); + germanized.admin.shipments.doAjax( params, this.unblockPackaging.bind( this ), this.unblockPackaging.bind( this ) ); + }; + + this.onSendReturnNotification = function() { + var params = { + 'action' : 'woocommerce_gzd_send_return_shipment_notification_email', + 'shipment_id' : this.getId(), + 'security' : germanized.admin.shipments.getParams().send_return_notification_nonce + }; + + this.block(); + germanized.admin.shipments.doAjax( params, this.unblock.bind( this ), this.unblock.bind( this ) ); + + return false; + }; + + this.onConfirmReturnRequest = function() { + var params = { + 'action' : 'woocommerce_gzd_confirm_return_request', + 'shipment_id' : this.getId(), + 'security' : germanized.admin.shipments.getParams().confirm_return_request_nonce + }; + + this.block(); + germanized.admin.shipments.doAjax( params, this.unblock.bind( this ), this.unblock.bind( this ) ); + + return false; + }; + + this.onRemoveLabel = function() { + var answer = window.confirm( germanized.admin.shipments.getParams().i18n_remove_label_notice ); + + if ( answer ) { + this.removeLabel(); + } + + return false; + }; + + this.removeLabel = function() { + var params = { + 'action' : 'woocommerce_gzd_remove_shipment_label', + 'shipment_id' : this.getId(), + 'security' : germanized.admin.shipments.getParams().remove_label_nonce + }; + + this.block(); + germanized.admin.shipments.doAjax( params, this.unblock.bind( this ), this.unblock.bind( this ) ); + }; + + this.onCreateLabel = function() { + var $shipment = this.getShipment(); + + $shipment.WCBackboneModal({ + template: 'wc-gzd-modal-create-shipment-label-' + this.getId() + }); + + return false; + }; + + this.onChangeProvider = function() { + var $shipment = this.getShipment(), + $select = $shipment.find( '#shipment-shipping-provider-' + this.getId() ), + $selected = $select.find( 'option:selected' ); + + $shipment.find( '.show-if-provider' ).hide(); + + if ( $selected.length > 0 && $selected.data( 'is-manual' ) && 'yes' === $selected.data( 'is-manual' ) ) { + $shipment.find( '.show-if-provider-is-manual' ).show(); + } + + $shipment.find( '.show-if-provider-' + $select.val() ).show(); + }; + + this.getShipment = function() { + return this.vars.$shipment; + }; + + this.getShipmentContent = function() { + return this.vars.$shipment.find( '> .shipment-content-wrapper > .shipment-content > .columns > div:not(.shipment-returns-data)' ); + }; + + this.onChangeQuantity = function( e ) { + var $quantity = $( e.target ), + $item = $quantity.parents( '.shipment-item' ), + itemId = $item.data( 'id' ), + newQuantity = $quantity.val(); + + this.blockItems(); + + var params = { + 'action' : 'woocommerce_gzd_limit_shipment_item_quantity', + 'shipment_id' : this.getId(), + 'item_id' : itemId, + 'quantity' : newQuantity + }; + + germanized.admin.shipments.doAjax( params, this.onChangeQuantitySuccess.bind( this ) ); + }; + + this.onChangeQuantitySuccess = function( data ) { + var $item = this.getShipment().find( '.shipment-item[data-id="' + data.item_id + '"]' ), + currentQty = $item.find( '.item-quantity' ).val(), + maxQuantity = data.max_quantity; + + if ( currentQty > maxQuantity ) { + $item.find( '.item-quantity' ).val( maxQuantity ); + } else if ( currentQty <= 0 ) { + $item.find( '.item-quantity' ).val( 1 ); + } + + this.refreshDom(); + this.unblockItems(); + }; + + this.setWeight = function( weight ) { + this.getShipment().find( '#shipment-weight-' + this.getId() ).attr( 'placeholder', weight ); + }; + + this.setLength = function( length ) { + this.getShipment().find( '#shipment-length-' + this.getId() ).attr( 'placeholder', length ); + }; + + this.setWidth = function( width ) { + this.getShipment().find( '#shipment-width-' + this.getId() ).attr( 'placeholder', width ); + }; + + this.setHeight = function( height ) { + this.getShipment().find( '#shipment-height-' + this.getId() ).attr( 'placeholder', height ); + }; + + this.setTotalWeight = function( weight ) { + + }; + + this.setIsEditable = function( isEditable ) { + var root = this; + + if ( typeof isEditable !== "boolean" ) { + isEditable = true; + } + + this.vars.isEditable = isEditable === true; + + if ( ! this.vars.isEditable ) { + this.getShipment().removeClass( 'is-editable' ); + this.getShipment().addClass( 'is-locked' ); + + // Disable inputs + this.getShipmentContent().find( '.remove-shipment-item ' ).hide(); + this.getShipmentContent().find( '.shipment-item-actions' ).hide(); + this.getShipmentContent().find( ':input:not([type=hidden])' ).prop( 'disabled', true ); + + $.each( this.vars.params.shipment_locked_excluded_fields, function( i, field ) { + root.getShipmentContent().find( ':input[name^=shipment_' + field + ']' ).prop( 'disabled', false ); + }); + + } else { + this.getShipment().addClass( 'is-editable' ); + this.getShipment().removeClass( 'is-locked' ); + + // Disable inputs + this.getShipmentContent().find( '.remove-shipment-item ' ).show(); + this.getShipmentContent().find( '.shipment-item-actions' ).show(); + this.getShipmentContent().find( ':input:not(.disabled):not([type=hidden])' ).prop( 'disabled', false ); + } + }; + + this.setNeedsItems = function( needsItems ) { + if ( typeof needsItems !== "boolean" ) { + needsItems = true; + } + + this.vars.needsItems = needsItems === true; + + if ( ! this.vars.needsItems ) { + this.getShipment().removeClass( 'needs-items' ); + } else { + this.getShipment().addClass( 'needs-items' ); + } + }; + + this.onSyncItems = function() { + this.syncItems(); + + return false; + }; + + this.syncItems = function() { + this.blockItems(); + + var params = { + 'action' : 'woocommerce_gzd_sync_shipment_items', + 'shipment_id': this.getId() + }; + + germanized.admin.shipments.doAjax( params, this.onSyncItemsSuccess.bind( this ), this.onSyncItemsError.bind( this ) ); + }; + + this.onSyncItemsSuccess = function( data ) { + this.unblockItems(); + }; + + this.onSyncItemsError = function( data ) { + this.unblockItems(); + }; + + this.onAddItem = function() { + + this.getShipment().WCBackboneModal({ + template: 'wc-gzd-modal-add-shipment-item-' + this.getId() + }); + + return false; + }; + + this.addItem = function( orderItemId, quantity ) { + quantity = quantity || 1; + + this.blockItems(); + + var params = { + 'action' : 'woocommerce_gzd_add_shipment_item', + 'shipment_id' : this.getId(), + 'original_item_id' : orderItemId, + 'quantity' : quantity + }; + + germanized.admin.shipments.doAjax( params, this.onAddItemSuccess.bind( this ), this.onAddItemError.bind( this ) ); + }; + + this.addReturn = function( items ) { + this.block(); + + var params = { + 'action' : 'woocommerce_gzd_add_shipment_return', + 'shipment_id' : this.getId() + }; + + $.extend( params, items ); + + germanized.admin.shipments.doAjax( params, this.onAddReturnSuccess.bind( this ), this.onAddReturnError.bind( this ) ); + }; + + this.onAddReturnSuccess = function( data ) { + this.getShipment().find( '.shipment-return-list' ).append( data.new_shipment ); + + this.refreshDom(); + germanized.admin.shipments.initShipments(); + + this.unblock(); + }; + + this.onAddReturnError = function( data ) { + this.unblock(); + }; + + this.onAddItemError = function( data ) { + this.unblockItems(); + }; + + this.onAddItemSuccess = function( data ) { + this.getShipmentContent().find( '.shipment-item-list' ).append( data.new_item ); + + this.refreshDom(); + this.unblockItems(); + }; + + this.onRemoveItem = function( e ) { + var $delete = $( e.target ), + $item = $delete.parents( '.shipment-item' ), + itemId = $item.data( 'id' ); + + if ( $item.length > 0 ) { + this.removeItem( itemId ); + } + + return false; + }; + + this.blockItems = function() { + this.getShipmentContent().find( '.shipment-items' ).block({ + message: null, + overlayCSS: { + background: '#fff', + opacity: 0.6 + } + }); + }; + + this.block = function() { + this.getShipment().block({ + message: null, + overlayCSS: { + background: '#fff', + opacity: 0.6 + } + }); + }; + + this.unblockItems = function() { + this.getShipmentContent().find( '.shipment-items' ).unblock(); + }; + + this.unblock = function() { + this.getShipment().unblock(); + }; + + this.removeItem = function( itemId ) { + var $item = this.getShipment().find( '.shipment-item[data-id="' + itemId + '"]' ); + + var params = { + 'action' : 'woocommerce_gzd_remove_shipment_item', + 'shipment_id' : this.getId(), + 'item_id' : itemId + }; + + this.blockItems(); + + germanized.admin.shipments.doAjax( params, this.onRemoveItemSuccess.bind( this ) ); + }; + + this.onRemoveItemSuccess = function( data ) { + var $item = this.getShipment().find( '.shipment-item[data-id="' + data['item_id'] + '"]' ); + + if ( $item.length > 0 ) { + $item.slideUp( 150, function() { + $( this ).remove(); + }); + } + + this.unblockItems(); + }; + + this.getId = function() { + return this.vars.id; + }; + + this.backbone = { + + onAddItemSuccess: function( data ) { + $select = $( 'select#wc-gzd-shipment-add-items-select' ); + $quantity = $( 'input#wc-gzd-shipment-add-items-quantity' ); + + $quantity.val( 1 ); + + $.each( data.items, function( id, item ) { + $select.append( '' ); + $quantity.data( 'max-quantity-' + id, item.max_quantity ); + }); + + $( '.wc-backbone-modal-content article' ).unblock(); + + $( document.body ).on( 'change', 'input#wc-gzd-shipment-add-items-quantity', function() { + var item_id = $select.val(), + quantity = $( this ).val(); + + if ( $quantity.data( 'max-quantity-' + item_id ) ) { + var maxQuantity = $quantity.data( 'max-quantity-' + item_id ); + + if ( quantity > maxQuantity ) { + $quantity.val( maxQuantity ); + } + } + }); + }, + + init: function ( e, target ) { + var id = this.getId(); + + if ( ( 'wc-gzd-modal-add-shipment-item-' + id ) === target ) { + + $( '.wc-backbone-modal-content article' ).block({ + message: null, + overlayCSS: { + background: '#fff', + opacity: 0.6 + } + }); + + germanized.admin.shipments.doAjax( { + 'action' : 'woocommerce_gzd_get_available_shipment_items', + 'shipment_id': id + }, this.backbone.onAddItemSuccess.bind( this ) ); + + return false; + } + }, + + response: function ( e, target, data ) { + var id = this.getId(); + + if ( ( 'wc-gzd-modal-add-shipment-item-' + id ) === target ) { + this.addItem( data.item_id, data.item_qty ); + } + } + }; + + /* + * Pass options when class instantiated + */ + this.construct( shipmentId ); + }; + +})( jQuery, window.germanized.admin ); diff --git a/packages/woocommerce-germanized-shipments/assets/js/admin-shipment.min.js b/packages/woocommerce-germanized-shipments/assets/js/admin-shipment.min.js new file mode 100644 index 000000000..5b17f9c69 --- /dev/null +++ b/packages/woocommerce-germanized-shipments/assets/js/admin-shipment.min.js @@ -0,0 +1 @@ +window.germanized=window.germanized||{},window.germanized.admin=window.germanized.admin||{},function(h){h.GermanizedShipment=function(t){this.vars={$shipment:!1,params:{},id:"",isEditable:!0,needsItems:!0},(this.root=this).construct=function(t){this.vars.id=t,this.vars.params=germanized.admin.shipments.getParams(),this.refreshDom(),h(document.body).on("wc_backbone_modal_loaded",this.backbone.init.bind(this)).on("wc_backbone_modal_response",this.backbone.response.bind(this))},this.refreshDom=function(){this.vars.$shipment=h("#order-shipments-list").find("#shipment-"+this.getId()),this.setNeedsItems(this.vars.$shipment.hasClass("needs-items")),this.setIsEditable(this.vars.$shipment.hasClass("is-editable")),this.onChangeProvider(),h("#shipment-"+this.vars.id+" #shipment-items-"+this.vars.id).off(),h("#shipment-"+this.vars.id+" #shipment-footer-"+this.vars.id).off(),h("#shipment-"+this.vars.id+" #shipment-shipping-provider-"+this.vars.id).off(),h("#shipment-"+this.vars.id+" #shipment-packaging-"+this.vars.id).off(),h("#shipment-"+this.vars.id+" .wc-gzd-shipment-label").off(),h("#shipment-"+this.vars.id+" #shipment-shipping-provider-"+this.vars.id).on("change",this.onChangeProvider.bind(this)),h("#shipment-"+this.vars.id+" #shipment-packaging-"+this.vars.id).on("change",this.refreshDimensions.bind(this)),h("#shipment-"+this.vars.id+" #shipment-items-"+this.vars.id).on("change",".item-quantity",this.onChangeQuantity.bind(this)).on("click","a.remove-shipment-item",this.onRemoveItem.bind(this)).on("click","a.add-shipment-item",this.onAddItem.bind(this)).on("click","a.sync-shipment-items",this.onSyncItems.bind(this)),h("#shipment-"+this.vars.id+" #shipment-footer-"+this.vars.id).on("click",".send-return-shipment-notification",this.onSendReturnNotification.bind(this)).on("click",".confirm-return-shipment",this.onConfirmReturnRequest.bind(this)),h("#shipment-"+this.vars.id+" .wc-gzd-shipment-label").on("click",".create-shipment-label:not(.disabled)",this.onCreateLabel.bind(this)).on("click",".remove-shipment-label",this.onRemoveLabel.bind(this))},this.refreshDimensions=function(){var t=this.getShipment(),i=t.find("#shipment-packaging-"+this.getId()).find("option:selected");""===i.val()?(t.find("#shipment-length-"+this.getId()).removeClass("disabled").prop("disabled",!1),t.find("#shipment-length-"+this.getId()).val(""),t.find("#shipment-width-"+this.getId()).removeClass("disabled").prop("disabled",!1),t.find("#shipment-width-"+this.getId()).val(""),t.find("#shipment-height-"+this.getId()).removeClass("disabled").prop("disabled",!1),t.find("#shipment-height-"+this.getId()).val("")):(t.find("#shipment-length-"+this.getId()).addClass("disabled").prop("disabled",!0),t.find("#shipment-length-"+this.getId()).val(i.data("length")),t.find("#shipment-width-"+this.getId()).addClass("disabled").prop("disabled",!0),t.find("#shipment-width-"+this.getId()).val(i.data("width")),t.find("#shipment-height-"+this.getId()).addClass("disabled").prop("disabled",!0),t.find("#shipment-height-"+this.getId()).val(i.data("height")))},this.blockPackaging=function(){this.getShipmentContent().find(".wc-gzd-shipment-packaging-wrapper").block({message:null,overlayCSS:{background:"#fff",opacity:.6}})},this.unblockPackaging=function(){this.getShipmentContent().find(".wc-gzd-shipment-packaging-wrapper").unblock()},this.refreshPackaging=function(){var t={action:"woocommerce_gzd_refresh_shipment_packaging",shipment_id:this.getId(),security:germanized.admin.shipments.getParams().refresh_packaging_nonce};this.blockPackaging(),germanized.admin.shipments.doAjax(t,this.unblockPackaging.bind(this),this.unblockPackaging.bind(this))},this.onSendReturnNotification=function(){var t={action:"woocommerce_gzd_send_return_shipment_notification_email",shipment_id:this.getId(),security:germanized.admin.shipments.getParams().send_return_notification_nonce};return this.block(),germanized.admin.shipments.doAjax(t,this.unblock.bind(this),this.unblock.bind(this)),!1},this.onConfirmReturnRequest=function(){var t={action:"woocommerce_gzd_confirm_return_request",shipment_id:this.getId(),security:germanized.admin.shipments.getParams().confirm_return_request_nonce};return this.block(),germanized.admin.shipments.doAjax(t,this.unblock.bind(this),this.unblock.bind(this)),!1},this.onRemoveLabel=function(){return window.confirm(germanized.admin.shipments.getParams().i18n_remove_label_notice)&&this.removeLabel(),!1},this.removeLabel=function(){var t={action:"woocommerce_gzd_remove_shipment_label",shipment_id:this.getId(),security:germanized.admin.shipments.getParams().remove_label_nonce};this.block(),germanized.admin.shipments.doAjax(t,this.unblock.bind(this),this.unblock.bind(this))},this.onCreateLabel=function(){return this.getShipment().WCBackboneModal({template:"wc-gzd-modal-create-shipment-label-"+this.getId()}),!1},this.onChangeProvider=function(){var t=this.getShipment(),i=t.find("#shipment-shipping-provider-"+this.getId()),e=i.find("option:selected");t.find(".show-if-provider").hide(),0' + message + '
'+e+'
')},getParams:function(){return germanized.admin.shipments.params},onRemoveShipment:function(){var e=germanized.admin.shipments,n=d(this).parents(".order-shipment").data("shipment");return window.confirm(e.getParams().i18n_remove_shipment_notice)&&e.removeShipment(n),!1},removeShipment:function(e){var n=germanized.admin.shipments,i={action:"woocommerce_gzd_remove_shipment",shipment_id:e};n.block(),n.doAjax(i,n.onRemoveShipmentSuccess,n.onRemoveShipmentError)},onRemoveShipmentSuccess:function(e){var n=germanized.admin.shipments,i=n.$wrapper.find("#shipment-"+e.shipment_id);0
+
diff --git a/packages/woocommerce-germanized-shipments/includes/admin/views/html-order-shipment-item-count.php b/packages/woocommerce-germanized-shipments/includes/admin/views/html-order-shipment-item-count.php
new file mode 100644
index 000000000..a825258a1
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/admin/views/html-order-shipment-item-count.php
@@ -0,0 +1,18 @@
+
+
+
+ get_shippable_item_count() ) > 0 ) :
+ $item_count = $shipment->get_item_count();
+ ?>
+
+
+
diff --git a/packages/woocommerce-germanized-shipments/includes/admin/views/html-order-shipment-item.php b/packages/woocommerce-germanized-shipments/includes/admin/views/html-order-shipment-item.php
new file mode 100644
index 000000000..8c46294d4
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/admin/views/html-order-shipment-item.php
@@ -0,0 +1,68 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + + +
+
+
+ + + + + has_packaging() ? 'disabled="disabled"' : '' ); ?> size="6" class="wc_input_decimal wc-gzd-shipment-dimension has_packaging() ? 'disabled' : '' ); ?>" value="get_length( 'edit' ) ) ); ?>" name="shipment_length[get_id() ); ?>]" id="shipment-length-get_id() ); ?>" placeholder="get_content_length() ) ); ?>" /> + has_packaging() ? 'disabled="disabled"' : '' ); ?> size="6" class="wc_input_decimal wc-gzd-shipment-dimension has_packaging() ? 'disabled' : '' ); ?>" value="get_width( 'edit' ) ) ); ?>" name="shipment_width[get_id() ); ?>]" id="shipment-width-get_id() ); ?>" placeholder="get_content_width() ) ); ?>" /> + has_packaging() ? 'disabled="disabled"' : '' ); ?> size="6" class="wc_input_decimal wc-gzd-shipment-dimension has_packaging() ? 'disabled' : '' ); ?>" value="get_height( 'edit' ) ) ); ?>" name="shipment_height[get_id() ); ?>]" id="shipment-height-get_id() ); ?>" placeholder="get_content_height() ) ); ?>" /> + +
++ + + +
+
+
+
+ + + +
+ + get_available_shipping_methods() ) > 1 ) : ?> ++ + +
+ + ++ + +
+ ++ + +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+
+ supports_label() && ( ( $label = $shipment->get_label() ) || $shipment->needs_label() ) ) :
+ include 'label/html-shipment-label.php';
+ endif;
+ ?>
+
+
+
+
+
+
+
+
+
+
+
diff --git a/packages/woocommerce-germanized-shipments/includes/admin/views/html-order-shipment-list.php b/packages/woocommerce-germanized-shipments/includes/admin/views/html-order-shipment-list.php
new file mode 100644
index 000000000..a3d4852c7
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/admin/views/html-order-shipment-list.php
@@ -0,0 +1,32 @@
+get_return_shipments();
+?>
+
+
+ get_simple_shipments() as $shipment ) :
+ $is_active = ( $active_shipment && $shipment->get_id() === $active_shipment ) ? true : false;
+
+ include 'html-order-shipment.php'; ?>
+
+
+
diff --git a/packages/woocommerce-germanized-shipments/includes/admin/views/html-order-shipment-packaging-select.php b/packages/woocommerce-germanized-shipments/includes/admin/views/html-order-shipment-packaging-select.php
new file mode 100644
index 000000000..5e1ff239e
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/admin/views/html-order-shipment-packaging-select.php
@@ -0,0 +1,34 @@
+get_available_packaging();
+$current_packaging_id = $shipment->get_packaging_id();
+$default_packaging_id = \Vendidero\Germanized\Shipments\Package::get_setting( 'default_packaging' );
+$default_packaging = ! empty( $default_packaging_id ) ? wc_gzd_get_packaging( $default_packaging_id ) : false;
+$default_exists_in_list = false;
+?>
+
diff --git a/packages/woocommerce-germanized-shipments/includes/admin/views/html-order-shipment.php b/packages/woocommerce-germanized-shipments/includes/admin/views/html-order-shipment.php
new file mode 100644
index 000000000..4eb5eedf5
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/admin/views/html-order-shipment.php
@@ -0,0 +1,31 @@
+
+
+
+
+ get_return_status() ); ?>
+
+
+
+ get_id() === $active_shipment ) ? true : false;
+ include 'html-order-shipment.php'; ?>
+
+
+
+
diff --git a/packages/woocommerce-germanized-shipments/includes/admin/views/html-order-shipments.php b/packages/woocommerce-germanized-shipments/includes/admin/views/html-order-shipments.php
new file mode 100644
index 000000000..a3cbab2b7
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/admin/views/html-order-shipments.php
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+
+ get_type() ), $shipment->get_id() ); ?>
+ get_status() ); ?> +
+
+
+
+
+
+
+
+
diff --git a/packages/woocommerce-germanized-shipments/includes/admin/views/html-settings-provider-list.php b/packages/woocommerce-germanized-shipments/includes/admin/views/html-settings-provider-list.php
new file mode 100644
index 000000000..70ddb120d
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/admin/views/html-settings-provider-list.php
@@ -0,0 +1,65 @@
+
+
+
+
+
+
+
+ get_shipping_status() ); ?>
+
+
+
+
+
+
+
+ | + | + | + | + |
|---|---|---|---|
| + get_title(); ?> + + | +
+ get_description(); ?> + |
+ + + | ++ get_help_link() ) : ?> + + + + + + | +
+
+
diff --git a/packages/woocommerce-germanized-shipments/includes/admin/views/label/html-shipment-label-backbone-form.php b/packages/woocommerce-germanized-shipments/includes/admin/views/label/html-shipment-label-backbone-form.php
new file mode 100644
index 000000000..1c63ed09f
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/admin/views/label/html-shipment-label-backbone-form.php
@@ -0,0 +1,17 @@
+
+
+ get_error_messages() as $message ) : ?>
+
+
+
+
+
+
+
+
+
+
diff --git a/packages/woocommerce-germanized-shipments/includes/admin/views/label/html-shipment-label-backbone.php b/packages/woocommerce-germanized-shipments/includes/admin/views/label/html-shipment-label-backbone.php
new file mode 100644
index 000000000..05e78672b
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/admin/views/label/html-shipment-label-backbone.php
@@ -0,0 +1,34 @@
+
+
+
diff --git a/packages/woocommerce-germanized-shipments/includes/admin/views/label/html-shipment-label.php b/packages/woocommerce-germanized-shipments/includes/admin/views/label/html-shipment-label.php
new file mode 100644
index 000000000..b36031d95
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/admin/views/label/html-shipment-label.php
@@ -0,0 +1,48 @@
+
+
+
+
diff --git a/packages/woocommerce-germanized-shipments/includes/emails/class-wc-gzd-email-customer-guest-return-shipment-request.php b/packages/woocommerce-germanized-shipments/includes/emails/class-wc-gzd-email-customer-guest-return-shipment-request.php
new file mode 100644
index 000000000..c8b524863
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/emails/class-wc-gzd-email-customer-guest-return-shipment-request.php
@@ -0,0 +1,212 @@
+customer_email = true;
+ $this->id = 'customer_guest_return_shipment_request';
+ $this->title = _x( 'Order guest return request', 'shipments', 'woocommerce-germanized' );
+ $this->description = _x( 'Order guest return request are sent to the customer after submitting a new return request as a guest.', 'shipments', 'woocommerce-germanized' );
+
+ $this->template_html = 'emails/customer-guest-return-shipment-request.php';
+ $this->template_plain = 'emails/plain/customer-guest-return-shipment-request.php';
+ $this->template_base = Package::get_path() . '/templates/';
+ $this->helper = function_exists( 'wc_gzd_get_email_helper' ) ? wc_gzd_get_email_helper( $this ) : false;
+
+ $this->placeholders = array(
+ '{site_title}' => $this->get_blogname(),
+ '{order_number}' => '',
+ '{order_date}' => '',
+ );
+
+ // Call parent constructor.
+ parent::__construct();
+ }
+
+ /**
+ * Get email subject.
+ *
+ * @since 3.1.0
+ * @return string
+ */
+ public function get_default_subject() {
+ return _x( 'Your return request to your order {order_number}', 'shipments', 'woocommerce-germanized' );
+ }
+
+ /**
+ * Get email heading.
+ *
+ * @since 3.1.0
+ * @return string
+ */
+ public function get_default_heading() {
+ return _x( 'Return request to your order: {order_number}', 'shipments', 'woocommerce-germanized' );
+ }
+
+ /**
+ * Switch Woo and Germanized locale
+ */
+ public function setup_locale() {
+
+ if ( $this->is_customer_email() && function_exists( 'wc_gzd_switch_to_site_locale' ) && apply_filters( 'woocommerce_email_setup_locale', true ) ) {
+ wc_gzd_switch_to_site_locale();
+ }
+
+ parent::setup_locale();
+ }
+
+ /**
+ * Restore Woo and Germanized locale
+ */
+ public function restore_locale() {
+
+ if ( $this->is_customer_email() && function_exists( 'wc_gzd_restore_locale' ) && apply_filters( 'woocommerce_email_restore_locale', true ) ) {
+ wc_gzd_restore_locale();
+ }
+
+ parent::restore_locale();
+ }
+
+ /**
+ * Trigger.
+ *
+ * @param int $order_id order ID.
+ */
+ public function trigger( $order_id ) {
+ if ( $this->helper ) {
+ $this->helper->setup_locale();
+ } else {
+ $this->setup_locale();
+ }
+
+ if ( $this->object = wc_get_order( $order_id ) ) {
+
+ $this->placeholders['{order_number}'] = $this->object->get_order_number();
+
+ if ( ( $order_shipment = wc_gzd_get_shipment_order( $this->object ) ) && ( $this->request_url = wc_gzd_get_order_customer_add_return_url( $this->object ) ) ) {
+ $this->recipient = $this->object->get_billing_email();
+ $this->placeholders['{order_date}'] = wc_format_datetime( $this->object->get_date_created() );
+ $this->placeholders['{order_number}'] = $this->object->get_order_number();
+ }
+ }
+
+ if ( $this->helper ) {
+ $this->helper->setup_email_locale();
+ }
+
+ if ( $this->is_enabled() && $this->get_recipient() ) {
+ $this->send( $this->get_recipient(), $this->get_subject(), $this->get_content(), $this->get_headers(), $this->get_attachments() );
+ }
+
+ if ( $this->helper ) {
+ $this->helper->restore_email_locale();
+ }
+
+ if ( $this->helper ) {
+ $this->helper->restore_locale();
+ } else {
+ $this->restore_locale();
+ }
+ }
+
+ /**
+ * Return content from the additional_content field.
+ *
+ * Displayed above the footer.
+ *
+ * @since 2.0.4
+ * @return string
+ */
+ public function get_additional_content() {
+ if ( is_callable( 'parent::get_additional_content' ) ) {
+ return parent::get_additional_content();
+ }
+
+ return '';
+ }
+
+ /**
+ * Get content html.
+ *
+ * @return string
+ */
+ public function get_content_html() {
+ return wc_get_template_html(
+ $this->template_html, array(
+ 'order' => $this->object,
+ 'add_return_request_url' => $this->request_url,
+ 'email_heading' => $this->get_heading(),
+ 'additional_content' => $this->get_additional_content(),
+ 'sent_to_admin' => false,
+ 'plain_text' => false,
+ 'email' => $this,
+ )
+ );
+ }
+
+ /**
+ * Get content plain.
+ *
+ * @return string
+ */
+ public function get_content_plain() {
+ return wc_get_template_html(
+ $this->template_plain, array(
+ 'order' => $this->object,
+ 'add_return_request_url' => $this->request_url,
+ 'email_heading' => $this->get_heading(),
+ 'additional_content' => $this->get_additional_content(),
+ 'sent_to_admin' => false,
+ 'plain_text' => true,
+ 'email' => $this,
+ )
+ );
+ }
+
+ /**
+ * Default content to show below main email content.
+ *
+ * @since 1.0.1
+ * @return string
+ */
+ public function get_default_additional_content() {
+ return '';
+ }
+ }
+
+endif;
+
+return new WC_GZD_Email_Customer_Guest_Return_Shipment_Request();
diff --git a/packages/woocommerce-germanized-shipments/includes/emails/class-wc-gzd-email-customer-return-shipment-delivered.php b/packages/woocommerce-germanized-shipments/includes/emails/class-wc-gzd-email-customer-return-shipment-delivered.php
new file mode 100644
index 000000000..a785a82e1
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/emails/class-wc-gzd-email-customer-return-shipment-delivered.php
@@ -0,0 +1,232 @@
+customer_email = true;
+ $this->id = 'customer_return_shipment_delivered';
+ $this->title = _x( 'Order return delivered', 'shipments', 'woocommerce-germanized' );
+ $this->description = _x( 'Order return notifications are sent to the customer after a return shipment has been returned (delivered) successfully.', 'shipments', 'woocommerce-germanized' );
+
+ $this->template_html = 'emails/customer-return-shipment-delivered.php';
+ $this->template_plain = 'emails/plain/customer-return-shipment-delivered.php';
+ $this->template_base = Package::get_path() . '/templates/';
+ $this->helper = function_exists( 'wc_gzd_get_email_helper' ) ? wc_gzd_get_email_helper( $this ) : false;
+
+ $this->placeholders = array(
+ '{site_title}' => $this->get_blogname(),
+ '{shipment_number}' => '',
+ '{order_number}' => '',
+ '{order_date}' => '',
+ '{date_sent}' => '',
+ );
+
+ // Triggers for this email.
+ add_action( 'woocommerce_gzd_return_shipment_status_processing_to_delivered_notification', array( $this, 'trigger' ), 10 );
+ add_action( 'woocommerce_gzd_return_shipment_status_shipped_to_delivered_notification', array( $this, 'trigger' ), 10 );
+
+ // Call parent constructor.
+ parent::__construct();
+ }
+
+ /**
+ * Get email subject.
+ *
+ * @since 3.1.0
+ * @return string
+ */
+ public function get_default_subject() {
+ return _x( 'Return to your order {order_number} has been received', 'shipments', 'woocommerce-germanized' );
+ }
+
+ /**
+ * Get email heading.
+ *
+ * @since 3.1.0
+ * @return string
+ */
+ public function get_default_heading() {
+ return _x( 'Received return to your order: {order_number}', 'shipments', 'woocommerce-germanized' );
+ }
+
+ /**
+ * Switch Woo and Germanized locale
+ */
+ public function setup_locale() {
+
+ if ( $this->is_customer_email() && function_exists( 'wc_gzd_switch_to_site_locale' ) && apply_filters( 'woocommerce_email_setup_locale', true ) ) {
+ wc_gzd_switch_to_site_locale();
+ }
+
+ parent::setup_locale();
+ }
+
+ /**
+ * Restore Woo and Germanized locale
+ */
+ public function restore_locale() {
+
+ if ( $this->is_customer_email() && function_exists( 'wc_gzd_restore_locale' ) && apply_filters( 'woocommerce_email_restore_locale', true ) ) {
+ wc_gzd_restore_locale();
+ }
+
+ parent::restore_locale();
+ }
+
+ /**
+ * Trigger.
+ *
+ * @param int $shipment_id Shipment ID.
+ * @param bool $is_confirmation
+ */
+ public function trigger( $shipment_id ) {
+ if ( $this->helper ) {
+ $this->helper->setup_locale();
+ } else {
+ $this->setup_locale();
+ }
+
+ if ( $this->shipment = wc_gzd_get_shipment( $shipment_id ) ) {
+
+ if ( 'return' !== $this->shipment->get_type() ) {
+ return;
+ }
+
+ $this->placeholders['{shipment_number}'] = $this->shipment->get_shipment_number();
+
+ if ( $order_shipment = wc_gzd_get_shipment_order( $this->shipment->get_order() ) ) {
+
+ $this->object = $this->shipment->get_order();
+ $this->recipient = $order_shipment->get_order()->get_billing_email();
+ $this->placeholders['{order_date}'] = wc_format_datetime( $order_shipment->get_order()->get_date_created() );
+ $this->placeholders['{order_number}'] = $order_shipment->get_order()->get_order_number();
+
+ if ( $this->shipment->get_date_sent() ) {
+ $this->placeholders['{date_sent}'] = wc_format_datetime( $this->shipment->get_date_sent() );
+ }
+ }
+ }
+
+ if ( $this->helper ) {
+ $this->helper->setup_email_locale();
+ }
+
+ if ( $this->is_enabled() && $this->get_recipient() ) {
+ $this->send( $this->get_recipient(), $this->get_subject(), $this->get_content(), $this->get_headers(), $this->get_attachments() );
+ }
+
+ if ( $this->helper ) {
+ $this->helper->restore_email_locale();
+ }
+
+ if ( $this->helper ) {
+ $this->helper->restore_locale();
+ } else {
+ $this->restore_locale();
+ }
+ }
+
+ /**
+ * Return content from the additional_content field.
+ *
+ * Displayed above the footer.
+ *
+ * @since 2.0.4
+ * @return string
+ */
+ public function get_additional_content() {
+ if ( is_callable( 'parent::get_additional_content' ) ) {
+ return parent::get_additional_content();
+ }
+
+ return '';
+ }
+
+ /**
+ * Get content html.
+ *
+ * @return string
+ */
+ public function get_content_html() {
+ return wc_get_template_html(
+ $this->template_html, array(
+ 'shipment' => $this->shipment,
+ 'order' => $this->object,
+ 'email_heading' => $this->get_heading(),
+ 'additional_content' => $this->get_additional_content(),
+ 'sent_to_admin' => false,
+ 'plain_text' => false,
+ 'email' => $this,
+ )
+ );
+ }
+
+ /**
+ * Get content plain.
+ *
+ * @return string
+ */
+ public function get_content_plain() {
+ return wc_get_template_html(
+ $this->template_plain, array(
+ 'shipment' => $this->shipment,
+ 'order' => $this->object,
+ 'email_heading' => $this->get_heading(),
+ 'additional_content' => $this->get_additional_content(),
+ 'sent_to_admin' => false,
+ 'plain_text' => true,
+ 'email' => $this,
+ )
+ );
+ }
+
+ /**
+ * Default content to show below main email content.
+ *
+ * @since 1.0.1
+ * @return string
+ */
+ public function get_default_additional_content() {
+ return '';
+ }
+ }
+
+endif;
+
+return new WC_GZD_Email_Customer_Return_Shipment_Delivered();
diff --git a/packages/woocommerce-germanized-shipments/includes/emails/class-wc-gzd-email-customer-return-shipment.php b/packages/woocommerce-germanized-shipments/includes/emails/class-wc-gzd-email-customer-return-shipment.php
new file mode 100644
index 000000000..372feb684
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/emails/class-wc-gzd-email-customer-return-shipment.php
@@ -0,0 +1,265 @@
+customer_email = true;
+ $this->id = 'customer_return_shipment';
+ $this->title = _x( 'Order return', 'shipments', 'woocommerce-germanized' );
+ $this->description = _x( 'Order return notifications are sent to the customer after a return shipment was marked as processing.', 'shipments', 'woocommerce-germanized' );
+
+ $this->template_html = 'emails/customer-return-shipment.php';
+ $this->template_plain = 'emails/plain/customer-return-shipment.php';
+ $this->template_base = Package::get_path() . '/templates/';
+ $this->helper = function_exists( 'wc_gzd_get_email_helper' ) ? wc_gzd_get_email_helper( $this ) : false;
+
+ $this->placeholders = array(
+ '{site_title}' => $this->get_blogname(),
+ '{shipment_number}' => '',
+ '{order_number}' => '',
+ '{order_date}' => '',
+ '{date_sent}' => '',
+ );
+
+ // Triggers for this email.
+ add_action( 'woocommerce_gzd_return_shipment_status_draft_to_processing_notification', array( $this, 'trigger' ), 10 );
+ add_action( 'woocommerce_gzd_return_shipment_status_requested_to_processing_notification', array( $this, 'trigger' ), 10 );
+
+ // Call parent constructor.
+ parent::__construct();
+ }
+
+ /**
+ * Get email subject.
+ *
+ * @since 3.1.0
+ * @return string
+ */
+ public function get_default_subject() {
+ return _x( 'Return to your order {order_number}', 'shipments', 'woocommerce-germanized' );
+ }
+
+ /**
+ * Get email heading.
+ *
+ * @since 3.1.0
+ * @return string
+ */
+ public function get_default_heading() {
+ return _x( 'Return to your order: {order_number}', 'shipments', 'woocommerce-germanized' );
+ }
+
+ /**
+ * Switch Woo and Germanized locale
+ */
+ public function setup_locale() {
+
+ if ( $this->is_customer_email() && function_exists( 'wc_gzd_switch_to_site_locale' ) && apply_filters( 'woocommerce_email_setup_locale', true ) ) {
+ wc_gzd_switch_to_site_locale();
+ }
+
+ parent::setup_locale();
+ }
+
+ /**
+ * Restore Woo and Germanized locale
+ */
+ public function restore_locale() {
+
+ if ( $this->is_customer_email() && function_exists( 'wc_gzd_restore_locale' ) && apply_filters( 'woocommerce_email_restore_locale', true ) ) {
+ wc_gzd_restore_locale();
+ }
+
+ parent::restore_locale();
+ }
+
+ /**
+ * Trigger.
+ *
+ * @param int $shipment_id Shipment ID.
+ * @param bool $is_confirmation
+ */
+ public function trigger( $shipment_id, $is_confirmation = false ) {
+ if ( $this->helper ) {
+ $this->helper->setup_locale();
+ } else {
+ $this->setup_locale();
+ }
+
+ $this->is_confirmation = $is_confirmation;
+
+ if ( $this->shipment = wc_gzd_get_shipment( $shipment_id ) ) {
+
+ if ( 'return' !== $this->shipment->get_type() ) {
+ return;
+ }
+
+ // Check if this is a customer request.
+ if ( $this->shipment->is_customer_requested() ) {
+ $this->is_confirmation = true;
+ }
+
+ $this->placeholders['{shipment_number}'] = $this->shipment->get_shipment_number();
+
+ if ( $order_shipment = wc_gzd_get_shipment_order( $this->shipment->get_order() ) ) {
+
+ $this->object = $this->shipment->get_order();
+ $this->recipient = $order_shipment->get_order()->get_billing_email();
+ $this->placeholders['{order_date}'] = wc_format_datetime( $order_shipment->get_order()->get_date_created() );
+ $this->placeholders['{order_number}'] = $order_shipment->get_order()->get_order_number();
+
+ if ( $this->shipment->get_date_sent() ) {
+ $this->placeholders['{date_sent}'] = wc_format_datetime( $this->shipment->get_date_sent() );
+ }
+ }
+ }
+
+ $this->id = 'customer_return_shipment';
+
+ if ( $this->helper ) {
+ $this->helper->setup_email_locale();
+ }
+
+ if ( $this->is_enabled() && $this->get_recipient() ) {
+ $this->send( $this->get_recipient(), $this->get_subject(), $this->get_content(), $this->get_headers(), $this->get_attachments() );
+ }
+
+ if ( $this->helper ) {
+ $this->helper->restore_email_locale();
+ }
+
+ if ( $this->helper ) {
+ $this->helper->restore_locale();
+ } else {
+ $this->restore_locale();
+ }
+ }
+
+ /**
+ * Return content from the additional_content field.
+ *
+ * Displayed above the footer.
+ *
+ * @since 2.0.4
+ * @return string
+ */
+ public function get_additional_content() {
+ if ( is_callable( 'parent::get_additional_content' ) ) {
+ return parent::get_additional_content();
+ }
+
+ return '';
+ }
+
+ /**
+ * Get content html.
+ *
+ * @return string
+ */
+ public function get_content_html() {
+ return wc_get_template_html(
+ $this->template_html, array(
+ 'shipment' => $this->shipment,
+ 'order' => $this->object,
+ 'is_confirmation' => $this->is_confirmation,
+ 'email_heading' => $this->get_heading(),
+ 'additional_content' => $this->get_additional_content(),
+ 'sent_to_admin' => false,
+ 'plain_text' => false,
+ 'email' => $this,
+ )
+ );
+ }
+
+ /**
+ * Get content plain.
+ *
+ * @return string
+ */
+ public function get_content_plain() {
+ return wc_get_template_html(
+ $this->template_plain, array(
+ 'shipment' => $this->shipment,
+ 'order' => $this->object,
+ 'is_confirmation' => $this->is_confirmation,
+ 'email_heading' => $this->get_heading(),
+ 'additional_content' => $this->get_additional_content(),
+ 'sent_to_admin' => false,
+ 'plain_text' => true,
+ 'email' => $this,
+ )
+ );
+ }
+
+ public function get_attachments() {
+ $attachments = array();
+
+ if ( $this->shipment->has_label() ) {
+ $label = $this->shipment->get_label();
+
+ if ( $file = $label->get_file() ) {
+ $attachments[] = $file;
+ }
+ }
+
+ return apply_filters( 'woocommerce_email_attachments', $attachments, $this->id, $this->object, $this );
+ }
+
+ /**
+ * Default content to show below main email content.
+ *
+ * @since 1.0.1
+ * @return string
+ */
+ public function get_default_additional_content() {
+ return '';
+ }
+ }
+
+endif;
+
+return new WC_GZD_Email_Customer_Return_Shipment();
diff --git a/packages/woocommerce-germanized-shipments/includes/emails/class-wc-gzd-email-customer-shipment.php b/packages/woocommerce-germanized-shipments/includes/emails/class-wc-gzd-email-customer-shipment.php
new file mode 100644
index 000000000..df29b8192
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/emails/class-wc-gzd-email-customer-shipment.php
@@ -0,0 +1,376 @@
+customer_email = true;
+ $this->id = 'customer_shipment';
+ $this->title = _x( 'Order shipped', 'shipments', 'woocommerce-germanized' );
+ $this->description = _x( 'Shipment notifications are sent to the customer when a shipment gets shipped.', 'shipments', 'woocommerce-germanized' );
+
+ $this->template_html = 'emails/customer-shipment.php';
+ $this->template_plain = 'emails/plain/customer-shipment.php';
+ $this->template_base = Package::get_path() . '/templates/';
+ $this->helper = function_exists( 'wc_gzd_get_email_helper' ) ? wc_gzd_get_email_helper( $this ) : false;
+
+ $this->placeholders = array(
+ '{site_title}' => $this->get_blogname(),
+ '{shipment_number}' => '',
+ '{order_number}' => '',
+ '{order_date}' => '',
+ '{date_sent}' => '',
+ );
+
+ // Triggers for this email.
+ if ( 'yes' === Package::get_setting( 'notify_enable' ) ) {
+ add_action( 'woocommerce_gzd_shipment_status_draft_to_shipped_notification', array( $this, 'trigger' ), 10 );
+ add_action( 'woocommerce_gzd_shipment_status_processing_to_shipped_notification', array( $this, 'trigger' ), 10 );
+ }
+
+ // Call parent constructor.
+ parent::__construct();
+ }
+
+ /**
+ * Get email subject.
+ *
+ * @param bool $partial Whether it is a partial refund or a full refund.
+ * @since 3.1.0
+ * @return string
+ */
+ public function get_default_subject( $partial = false ) {
+ if ( $partial ) {
+ return _x( 'Your {site_title} order #{order_number} has been partially shipped', 'shipments', 'woocommerce-germanized' );
+ } else {
+ return _x( 'Your {site_title} order #{order_number} has been shipped', 'shipments', 'woocommerce-germanized' );
+ }
+ }
+
+ /**
+ * Get email heading.
+ *
+ * @param bool $partial Whether it is a partial refund or a full refund.
+ * @since 3.1.0
+ * @return string
+ */
+ public function get_default_heading( $partial = false ) {
+ if ( $partial ) {
+ return _x( 'Partial shipment to your order: {order_number}', 'shipments', 'woocommerce-germanized' );
+ } else {
+ return _x( 'Shipment to your order: {order_number}', 'shipments', 'woocommerce-germanized' );
+ }
+ }
+
+ /**
+ * Get email subject.
+ *
+ * @return string
+ */
+ public function get_subject() {
+ if ( $this->partial_shipment ) {
+ $subject = $this->get_option( 'subject_partial', $this->get_default_subject( true ) );
+ } else {
+ $subject = $this->get_option( 'subject_full', $this->get_default_subject() );
+ }
+
+ /**
+ * Filter to adjust the email subject for a shipped Shipment.
+ *
+ * @param string $subject The subject.
+ * @param WC_GZD_Email_Customer_Shipment $email The email instance.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_email_subject_customer_shipment', $this->format_string( $subject ), $this->object );
+ }
+
+ /**
+ * Get email heading.
+ *
+ * @return string
+ */
+ public function get_heading() {
+ if ( $this->partial_shipment ) {
+ $heading = $this->get_option( 'heading_partial', $this->get_default_heading( true ) );
+ } else {
+ $heading = $this->get_option( 'heading_full', $this->get_default_heading() );
+ }
+
+ /**
+ * Filter to adjust the email heading for a shipped Shipment.
+ *
+ * @param string $heading The heading.
+ * @param WC_GZD_Email_Customer_Shipment $email The email instance.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_email_heading_customer_shipment', $this->format_string( $heading ), $this->object );
+ }
+
+ /**
+ * Switch Woo and Germanized locale
+ */
+ public function setup_locale() {
+
+ if ( $this->is_customer_email() && function_exists( 'wc_gzd_switch_to_site_locale' ) && apply_filters( 'woocommerce_email_setup_locale', true ) ) {
+ wc_gzd_switch_to_site_locale();
+ }
+
+ parent::setup_locale();
+ }
+
+ /**
+ * Restore Woo and Germanized locale
+ */
+ public function restore_locale() {
+
+ if ( $this->is_customer_email() && function_exists( 'wc_gzd_restore_locale' ) && apply_filters( 'woocommerce_email_restore_locale', true ) ) {
+ wc_gzd_restore_locale();
+ }
+
+ parent::restore_locale();
+ }
+
+ /**
+ * Trigger.
+ *
+ * @param int $shipment_id Shipment ID.
+ */
+ public function trigger( $shipment_id ) {
+ if ( $this->helper ) {
+ $this->helper->setup_locale();
+ } else {
+ $this->setup_locale();
+ }
+
+ $this->partial_shipment = false;
+
+ if ( $this->shipment = wc_gzd_get_shipment( $shipment_id ) ) {
+
+ $this->placeholders['{shipment_number}'] = $this->shipment->get_shipment_number();
+
+ if ( $order_shipment = wc_gzd_get_shipment_order( $this->shipment->get_order() ) ) {
+
+ $this->object = $this->shipment->get_order();
+
+ if ( $order_shipment->needs_shipping() || sizeof( $order_shipment->get_simple_shipments() ) > 1 ) {
+ $this->partial_shipment = true;
+ }
+
+ $this->recipient = $order_shipment->get_order()->get_billing_email();
+ $this->placeholders['{order_date}'] = wc_format_datetime( $order_shipment->get_order()->get_date_created() );
+ $this->placeholders['{order_number}'] = $order_shipment->get_order()->get_order_number();
+
+ if ( $this->shipment->get_date_sent() ) {
+ $this->placeholders['{date_sent}'] = wc_format_datetime( $this->shipment->get_date_sent() );
+ }
+ }
+ }
+
+ $this->id = $this->partial_shipment ? 'customer_partial_shipment' : 'customer_shipment';
+
+ if ( $this->helper ) {
+ $this->helper->setup_email_locale();
+ }
+
+ if ( $this->is_enabled() && $this->get_recipient() ) {
+ $this->send( $this->get_recipient(), $this->get_subject(), $this->get_content(), $this->get_headers(), $this->get_attachments() );
+ }
+
+ if ( $this->helper ) {
+ $this->helper->restore_email_locale();
+ }
+
+ if ( $this->helper ) {
+ $this->helper->restore_locale();
+ } else {
+ $this->restore_locale();
+ }
+ }
+
+ /**
+ * Return content from the additional_content field.
+ *
+ * Displayed above the footer.
+ *
+ * @since 2.0.4
+ * @return string
+ */
+ public function get_additional_content() {
+ if ( is_callable( 'parent::get_additional_content' ) ) {
+ return parent::get_additional_content();
+ }
+
+ return '';
+ }
+
+ /**
+ * Get content html.
+ *
+ * @return string
+ */
+ public function get_content_html() {
+ return wc_get_template_html(
+ $this->template_html, array(
+ 'shipment' => $this->shipment,
+ 'order' => $this->object,
+ 'partial_shipment' => $this->partial_shipment,
+ 'email_heading' => $this->get_heading(),
+ 'additional_content' => $this->get_additional_content(),
+ 'sent_to_admin' => false,
+ 'plain_text' => false,
+ 'email' => $this,
+ )
+ );
+ }
+
+ /**
+ * Get content plain.
+ *
+ * @return string
+ */
+ public function get_content_plain() {
+ return wc_get_template_html(
+ $this->template_plain, array(
+ 'shipment' => $this->shipment,
+ 'order' => $this->object,
+ 'partial_shipment' => $this->partial_shipment,
+ 'email_heading' => $this->get_heading(),
+ 'additional_content' => $this->get_additional_content(),
+ 'sent_to_admin' => false,
+ 'plain_text' => true,
+ 'email' => $this,
+ )
+ );
+ }
+
+ /**
+ * Default content to show below main email content.
+ *
+ * @since 1.0.1
+ * @return string
+ */
+ public function get_default_additional_content() {
+ return '';
+ }
+
+ /**
+ * Initialise settings form fields.
+ */
+ public function init_form_fields() {
+ /* translators: %s: list of placeholders */
+ $placeholder_text = sprintf( _x( 'Available placeholders: %s', 'shipments', 'woocommerce-germanized' ), 'get_shipping_provider() ) ); ?> has_label() && $shipment->get_tracking_id() ) ? Admin::get_shipment_tracking_html( $shipment ) : '' ); ?>
+ + +' . esc_html( implode( ', ', array_keys( $this->placeholders ) ) ) . '' );
+
+ $this->form_fields = array(
+ 'enabled' => array(
+ 'title' => _x( 'Enable/Disable', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'checkbox',
+ 'label' => _x( 'Enable this email notification', 'shipments', 'woocommerce-germanized' ),
+ 'default' => 'yes',
+ ),
+ 'subject_full' => array(
+ 'title' => _x( 'Full shipment subject', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'desc_tip' => true,
+ /* translators: %s: list of placeholders */
+ 'description' => sprintf( _x( 'Available placeholders: %s', 'shipments', 'woocommerce-germanized' ), '{site_title}, {order_date}, {order_number}, {shipment_number}, {date_sent}' ),
+ 'placeholder' => $this->get_default_subject(),
+ 'default' => '',
+ ),
+ 'subject_partial' => array(
+ 'title' => _x( 'Partial shipment subject', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'desc_tip' => true,
+ /* translators: %s: list of placeholders */
+ 'description' => sprintf( _x( 'Available placeholders: %s', 'shipments', 'woocommerce-germanized' ), '{site_title}, {order_date}, {order_number}, {shipment_number}, {date_sent}' ),
+ 'placeholder' => $this->get_default_subject( true ),
+ 'default' => '',
+ ),
+ 'heading_full' => array(
+ 'title' => _x( 'Full shipment email heading', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'desc_tip' => true,
+ /* translators: %s: list of placeholders */
+ 'description' => sprintf( _x( 'Available placeholders: %s', 'shipments', 'woocommerce-germanized' ), '{site_title}, {order_date}, {order_number}, {shipment_number}, {date_sent}' ),
+ 'placeholder' => $this->get_default_heading(),
+ 'default' => '',
+ ),
+ 'heading_partial' => array(
+ 'title' => _x( 'Partial shipment email heading', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'desc_tip' => true,
+ /* translators: %s: list of placeholders */
+ 'description' => sprintf( _x( 'Available placeholders: %s', 'shipments', 'woocommerce-germanized' ), '{site_title}, {order_date}, {order_number}, {shipment_number}, {date_sent}' ),
+ 'placeholder' => $this->get_default_heading( true ),
+ 'default' => '',
+ ),
+ 'additional_content' => array(
+ 'title' => _x( 'Additional content', 'shipments', 'woocommerce-germanized' ),
+ 'description' => _x( 'Text to appear below the main email content.', 'shipments', 'woocommerce-germanized' ) . ' ' . $placeholder_text,
+ 'css' => 'width:400px; height: 75px;',
+ 'placeholder' => _x( 'N/A', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'textarea',
+ 'default' => $this->get_default_additional_content(),
+ 'desc_tip' => true,
+ ),
+ 'email_type' => array(
+ 'title' => _x( 'Email type', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'select',
+ 'description' => _x( 'Choose which format of email to send.', 'shipments', 'woocommerce-germanized' ),
+ 'default' => 'html',
+ 'class' => 'email_type wc-enhanced-select',
+ 'options' => $this->get_email_type_options(),
+ 'desc_tip' => true,
+ ),
+ );
+ }
+ }
+
+endif;
+
+return new WC_GZD_Email_Customer_Shipment();
diff --git a/packages/woocommerce-germanized-shipments/includes/emails/class-wc-gzd-email-new-return-shipment-request.php b/packages/woocommerce-germanized-shipments/includes/emails/class-wc-gzd-email-new-return-shipment-request.php
new file mode 100644
index 000000000..ff6cec8d5
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/emails/class-wc-gzd-email-new-return-shipment-request.php
@@ -0,0 +1,216 @@
+id = 'new_return_shipment_request';
+ $this->title = _x( 'New order return request', 'shipments', 'woocommerce-germanized' );
+ $this->description = _x( 'New order return request emails are sent to chosen recipient(s) when a new return is requested.', 'shipments', 'woocommerce-germanized' );
+
+ $this->template_html = 'emails/admin-new-return-shipment-request.php';
+ $this->template_plain = 'emails/plain/admin-new-return-shipment-request.php';
+ $this->template_base = Package::get_path() . '/templates/';
+
+ $this->placeholders = array(
+ '{site_title}' => $this->get_blogname(),
+ '{shipment_number}' => '',
+ '{order_number}' => '',
+ '{order_date}' => '',
+ );
+
+ // Triggers for this email.
+ add_action( 'woocommerce_gzd_new_customer_return_shipment_request', array( $this, 'trigger' ), 10 );
+
+ // Call parent constructor.
+ parent::__construct();
+
+ // Other settings.
+ $this->recipient = $this->get_option( 'recipient', get_option( 'admin_email' ) );
+ }
+
+ /**
+ * Get email subject.
+ *
+ * @since 3.1.0
+ * @return string
+ */
+ public function get_default_subject() {
+ return _x( '[{site_title}]: New return request to #{order_number}', 'shipments', 'woocommerce-germanized' );
+ }
+
+ /**
+ * Get email heading.
+ *
+ * @since 3.1.0
+ * @return string
+ */
+ public function get_default_heading() {
+ return _x( 'New return request to: #{order_number}', 'shipments', 'woocommerce-germanized' );
+ }
+
+ /**
+ * Trigger.
+ *
+ * @param int|ReturnShipment $shipment_id Shipment ID.
+ */
+ public function trigger( $shipment_id ) {
+ $this->setup_locale();
+
+ if ( $this->shipment = wc_gzd_get_shipment( $shipment_id ) ) {
+
+ if ( 'return' !== $this->shipment->get_type() ) {
+ return;
+ }
+
+ $this->placeholders['{shipment_number}'] = $this->shipment->get_shipment_number();
+
+ if ( $order_shipment = wc_gzd_get_shipment_order( $this->shipment->get_order() ) ) {
+ $this->object = $this->shipment->get_order();
+ $this->placeholders['{order_date}'] = wc_format_datetime( $order_shipment->get_order()->get_date_created() );
+ $this->placeholders['{order_number}'] = $order_shipment->get_order()->get_order_number();
+ }
+ }
+
+ if ( $this->is_enabled() && $this->get_recipient() ) {
+ $this->send( $this->get_recipient(), $this->get_subject(), $this->get_content(), $this->get_headers(), $this->get_attachments() );
+ }
+
+ $this->restore_locale();
+ }
+
+ /**
+ * Return content from the additional_content field.
+ *
+ * Displayed above the footer.
+ *
+ * @since 2.0.4
+ * @return string
+ */
+ public function get_additional_content() {
+ if ( is_callable( 'parent::get_additional_content' ) ) {
+ return parent::get_additional_content();
+ }
+
+ return '';
+ }
+
+ /**
+ * Get content html.
+ *
+ * @return string
+ */
+ public function get_content_html() {
+ return wc_get_template_html(
+ $this->template_html, array(
+ 'shipment' => $this->shipment,
+ 'order' => $this->object,
+ 'email_heading' => $this->get_heading(),
+ 'additional_content' => $this->get_additional_content(),
+ 'sent_to_admin' => true,
+ 'plain_text' => false,
+ 'email' => $this,
+ )
+ );
+ }
+
+ /**
+ * Get content plain.
+ *
+ * @return string
+ */
+ public function get_content_plain() {
+ return wc_get_template_html(
+ $this->template_plain, array(
+ 'shipment' => $this->shipment,
+ 'order' => $this->object,
+ 'email_heading' => $this->get_heading(),
+ 'additional_content' => $this->get_additional_content(),
+ 'sent_to_admin' => true,
+ 'plain_text' => true,
+ 'email' => $this,
+ )
+ );
+ }
+
+ public function get_attachments() {
+ $attachments = array();
+
+ if ( $this->shipment->has_label() ) {
+ $label = $this->shipment->get_label();
+
+ if ( $file = $label->get_file() ) {
+ $attachments[] = $file;
+ }
+ }
+
+ return apply_filters( 'woocommerce_email_attachments', $attachments, $this->id, $this->object, $this );
+ }
+
+ /**
+ * Default content to show below main email content.
+ *
+ * @since 1.0.1
+ * @return string
+ */
+ public function get_default_additional_content() {
+ return '';
+ }
+
+ /**
+ * Initialise settings form fields.
+ */
+ public function init_form_fields() {
+ parent::init_form_fields();
+
+ $this->form_fields = array_merge( $this->form_fields, array(
+ 'recipient' => array(
+ 'title' => _x( 'Recipient(s)', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ /* translators: %s: WP admin email */
+ 'description' => sprintf( _x( 'Enter recipients (comma separated) for this email. Defaults to %s.', 'shipments', 'woocommerce-germanized' ), '' . esc_attr( get_option( 'admin_email' ) ) . '' ),
+ 'placeholder' => '',
+ 'default' => '',
+ 'desc_tip' => true,
+ ),
+ ) );
+ }
+ }
+
+endif;
+
+return new WC_GZD_Email_New_Return_Shipment_Request();
diff --git a/packages/woocommerce-germanized-shipments/includes/wc-gzd-label-functions.php b/packages/woocommerce-germanized-shipments/includes/wc-gzd-label-functions.php
new file mode 100644
index 000000000..0ab7ffee2
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/wc-gzd-label-functions.php
@@ -0,0 +1,147 @@
+get_labels();
+}
+
+function wc_gzd_get_label_type_by_shipment( $shipment ) {
+ $type = is_a( $shipment, '\Vendidero\Germanized\Shipments\Shipment' ) ? $shipment->get_type() : $shipment;
+
+ return apply_filters( "woocommerce_gzd_shipment_label_type", $type, $shipment );
+}
+
+function wc_gzd_get_shipment_label_types() {
+ return apply_filters( "woocommerce_gzd_shipment_label_types", array(
+ 'simple',
+ 'return'
+ ) );
+}
+
+function wc_gzd_get_label_by_shipment( $the_shipment, $type = '' ) {
+ $shipment_id = \Vendidero\Germanized\Shipments\ShipmentFactory::get_shipment_id( $the_shipment );
+ $label = false;
+
+ if ( $shipment_id ) {
+ $args = array(
+ 'shipment_id' => $shipment_id,
+ 'limit' => 1,
+ );
+
+ if ( ! empty( $type ) ) {
+ $args['type'] = $type;
+ }
+
+ $labels = wc_gzd_get_shipment_labels( $args );
+
+ if ( ! empty( $labels ) ) {
+ $label = $labels[0];
+ }
+ }
+
+ return apply_filters( "woocommerce_gzd_shipment_label_for_shipment", $label, $the_shipment );
+}
+
+/**
+ * @param false $the_label
+ * @param string $shipping_provider
+ * @param string $type
+ *
+ * @return \Vendidero\Germanized\Shipments\Interfaces\ShipmentLabel|boolean
+ */
+function wc_gzd_get_shipment_label( $the_label = false, $shipping_provider = '', $type = 'simple' ) {
+ return apply_filters( 'woocommerce_gzd_shipment_label', \Vendidero\Germanized\Shipments\Labels\Factory::get_label( $the_label, $shipping_provider, $type ), $the_label, $shipping_provider, $type );
+}
+
+/**
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment
+ * @param bool $net_weight
+ * @param string $unit
+ *
+ * @return float
+ */
+function wc_gzd_get_shipment_label_weight( $shipment, $net_weight = false, $unit = 'kg' ) {
+ $shipment_weight = $shipment->get_total_weight();
+ $shipment_content_weight = $shipment->get_weight();
+ $shipment_packaging_weight = $shipment->get_packaging_weight();
+
+ if ( ! empty( $shipment_weight ) ) {
+ $shipment_weight = wc_get_weight( $shipment_weight, $unit, $shipment->get_weight_unit() );
+ }
+
+ if ( ! empty( $shipment_content_weight ) ) {
+ $shipment_content_weight = wc_get_weight( $shipment_content_weight, $unit, $shipment->get_weight_unit() );
+ }
+
+ if ( ! empty( $shipment_packaging_weight ) ) {
+ $shipment_packaging_weight = wc_get_weight( $shipment_packaging_weight, $unit, $shipment->get_weight_unit() );
+ }
+
+ /**
+ * The net weight does not include packaging weight.
+ */
+ if ( $net_weight ) {
+ $shipment_packaging_weight = 0;
+ $shipment_weight = $shipment_content_weight;
+ }
+
+ if ( $provider = $shipment->get_shipping_provider_instance() ) {
+ $min_weight = wc_get_weight( $provider->get_shipment_setting( $shipment, 'label_minimum_shipment_weight' ), $unit, 'kg' );
+ $default_weight = wc_get_weight( $provider->get_shipment_setting( $shipment, 'label_default_shipment_weight' ), $unit, 'kg' );
+
+ if ( empty( $shipment_content_weight ) ) {
+ $shipment_weight = $default_weight;
+
+ if ( ! $net_weight ) {
+ $shipment_weight += $shipment_packaging_weight;
+ }
+ }
+
+ if ( $shipment_weight < $min_weight ) {
+ $shipment_weight = $min_weight;
+ }
+ }
+
+ return apply_filters( 'woocommerce_gzd_shipment_label_weight', $shipment_weight, $shipment, $unit );
+}
+
+/**
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment
+ * @param string $dimension
+ * @param string $unit
+ */
+function wc_gzd_get_shipment_label_dimensions( $shipment, $unit = 'cm' ) {
+ $dimensions = array(
+ 'length' => 0,
+ 'width' => 0,
+ 'height' => 0,
+ );
+
+ if ( $shipment->has_dimensions() ) {
+ $dimensions = $shipment->get_package_dimensions();
+
+ foreach( $dimensions as $key => $data ) {
+ $dimensions[ $key ] = wc_get_dimension( $data, $unit, $shipment->get_dimension_unit() );
+ }
+ }
+
+ return apply_filters( 'woocommerce_gzd_shipment_label_dimensions', $dimensions, $shipment, $unit );
+}
diff --git a/packages/woocommerce-germanized-shipments/includes/wc-gzd-packaging-functions.php b/packages/woocommerce-germanized-shipments/includes/wc-gzd-packaging-functions.php
new file mode 100644
index 000000000..39a3e0e6c
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/wc-gzd-packaging-functions.php
@@ -0,0 +1,60 @@
+ _x( 'Cardboard', 'shipments', 'woocommerce-germanized' ),
+ 'letter' => _x( 'Letter', 'shipments', 'woocommerce-germanized' )
+ );
+
+ return apply_filters( 'woocommerce_gzd_packaging_types', $types );
+}
+
+/**
+ * @return \Vendidero\Germanized\Shipments\Packaging[] $packaging_list
+ */
+function wc_gzd_get_packaging_list() {
+ $data_store = \WC_Data_Store::load( 'packaging' );
+ $list = $data_store->get_packaging_list();
+
+ return $list;
+}
+
+function wc_gzd_get_packaging_weight_unit() {
+ return apply_filters( 'woocommerce_gzd_packaging_weight_unit', 'kg' );
+}
+
+function wc_gzd_get_packaging_dimension_unit() {
+ return apply_filters( 'woocommerce_gzd_packaging_dimension_unit', 'cm' );
+}
+
+function wc_gzd_get_packaging_select() {
+ $list = wc_gzd_get_packaging_list();
+ $select = array(
+ '' => _x( 'None', 'shipments-packaging', 'woocommerce-germanized' ),
+ );
+
+ foreach( $list as $packaging ) {
+ $select[ $packaging->get_id() ] = $packaging->get_title();
+ }
+
+ return $select;
+}
diff --git a/packages/woocommerce-germanized-shipments/includes/wc-gzd-shipment-functions.php b/packages/woocommerce-germanized-shipments/includes/wc-gzd-shipment-functions.php
new file mode 100644
index 000000000..a774f3b49
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/wc-gzd-shipment-functions.php
@@ -0,0 +1,1323 @@
+countries ? WC()->countries->get_states( $country ) : array();
+ $formatted_state = ( $states && isset( $states[ $state ] ) ) ? $states[ $state ] : $state;
+
+ return $formatted_state;
+}
+
+function wc_gzd_get_shipment_order( $order ) {
+ if ( is_numeric( $order ) ) {
+ $order = wc_get_order( $order);
+ }
+
+ if ( is_a( $order, 'WC_Order' ) ) {
+ try {
+ return new Vendidero\Germanized\Shipments\Order( $order );
+ } catch ( Exception $e ) {
+ wc_caught_exception( $e, __FUNCTION__, func_get_args() );
+ return false;
+ }
+ }
+
+ return false;
+}
+
+function wc_gzd_get_shipment_label_title( $type, $plural = false ) {
+ $type_data = wc_gzd_get_shipment_type_data( $type );
+
+ return ( ! $plural ? $type_data['labels']['singular'] : $type_data['labels']['plural'] );
+}
+
+function wc_gzd_get_shipment_types() {
+ return array_keys( wc_gzd_get_shipment_type_data( false ) );
+}
+
+/**
+ * Get shipment type data by type.
+ *
+ * @param string $type type name.
+ * @return bool|array Details about the shipment type.
+ *
+ * @package Vendidero/Germanized/Shipments
+ */
+function wc_gzd_get_shipment_type_data( $type = false ) {
+ $types = apply_filters( 'woocommerce_gzd_shipment_type_data', array(
+ 'simple' => array(
+ 'class_name' => '\Vendidero\Germanized\Shipments\SimpleShipment',
+ 'labels' => array(
+ 'singular' => _x( 'Shipment', 'shipments', 'woocommerce-germanized' ),
+ 'plural' => _x( 'Shipments', 'shipments', 'woocommerce-germanized' ),
+ ),
+ ),
+ 'return' => array(
+ 'class_name' => '\Vendidero\Germanized\Shipments\ReturnShipment',
+ 'labels' => array(
+ 'singular' => _x( 'Return', 'shipments', 'woocommerce-germanized' ),
+ 'plural' => _x( 'Returns', 'shipments', 'woocommerce-germanized' ),
+ ),
+ ),
+ ) );
+
+ if ( $type && array_key_exists( $type, $types ) ) {
+ return $types[ $type ];
+ } elseif ( false === $type ) {
+ return $types;
+ } else {
+ return $types['simple'];
+ }
+}
+
+function wc_gzd_get_shipments_by_order( $order ) {
+ $shipments = array();
+
+ if ( $order_shipment = wc_gzd_get_shipment_order( $order ) ) {
+ $shipments = $order_shipment->get_shipments();
+ }
+
+ return $shipments;
+}
+
+function wc_gzd_get_shipment_order_shipping_statuses() {
+ $shipment_statuses = array(
+ 'gzd-not-shipped' => _x( 'Not shipped', 'shipments', 'woocommerce-germanized' ),
+ 'gzd-partially-shipped' => _x( 'Partially shipped', 'shipments', 'woocommerce-germanized' ),
+ 'gzd-shipped' => _x( 'Shipped', 'shipments', 'woocommerce-germanized' ),
+ );
+
+ /**
+ * Filter to adjust or add order shipping statuses.
+ * An order might retrieve a shipping status e.g. not shipped.
+ *
+ * @param array $shipment_statuses Available order shipping statuses.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_order_shipping_statuses', $shipment_statuses );
+}
+
+function wc_gzd_get_shipment_order_return_statuses() {
+ $shipment_statuses = array(
+ 'gzd-open' => _x( 'Open', 'shipments', 'woocommerce-germanized' ),
+ 'gzd-partially-returned' => _x( 'Partially returned', 'shipments', 'woocommerce-germanized' ),
+ 'gzd-returned' => _x( 'Returned', 'shipments', 'woocommerce-germanized' ),
+ );
+
+ /**
+ * Filter to adjust or add order return statuses.
+ * An order might retrieve a shipping status e.g. not shipped.
+ *
+ * @param array $shipment_statuses Available order return statuses.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_order_return_statuses', $shipment_statuses );
+}
+
+/**
+ * @param $instance_id
+ *
+ * @return ShippingProvider\Method
+ */
+function wc_gzd_get_shipping_provider_method( $instance_id ) {
+ $original_id = $instance_id;
+
+ if ( is_a( $original_id, 'WC_Shipping_Rate' ) ) {
+ $instance_id = $original_id->get_instance_id();
+ } elseif( ! is_numeric( $instance_id ) ) {
+ if ( strpos( $instance_id, ':' ) !== false ) {
+ $expl = explode( ':', $instance_id );
+ $instance_id = ( ( ! empty( $expl ) && sizeof( $expl ) > 1 ) ? (int) $expl[1] : 0 );
+ } else {
+ /**
+ * Plugins like Flexible Shipping use underscores to separate instance ids.
+ * Example: flexible_shipping_4_1. In this case, 4 ist the instance id. Let's find out.
+ */
+ $expl = explode( '_', $instance_id );
+ $numbers = array_values( array_filter( $expl, 'is_numeric' ) );
+
+ if ( ! empty( $numbers ) ) {
+ $instance_id = absint( $numbers[0] );
+ }
+ }
+ }
+
+ if ( ! empty( $instance_id ) ) {
+ // Make sure shipping zones are loaded
+ include_once WC_ABSPATH . 'includes/class-wc-shipping-zones.php';
+
+ /**
+ * Cache methods within frontend
+ */
+ if ( WC()->session && did_action( 'woocommerce_shipping_init' ) ) {
+ $cache_key = 'woocommerce_gzd_method_' . $instance_id;
+
+ if ( ! $method = WC()->session->get( $cache_key ) ) {
+ $method = WC_Shipping_Zones::get_shipping_method( $instance_id );
+
+ if ( $method ) {
+ WC()->session->set( $cache_key, $method );
+ }
+ }
+ } else {
+ $method = WC_Shipping_Zones::get_shipping_method( $instance_id );
+ }
+
+ if ( $method ) {
+ /**
+ * Filter to adjust the classname used to construct the shipping provider method
+ * which contains additional provider related settings useful for shipments.
+ *
+ * @param string $classname The classname.
+ * @param WC_Shipping_Method $method The shipping method instance.
+ *
+ * @since 3.0.6
+ * @package Vendidero/Germanized/Shipments
+ */
+ $classname = apply_filters( 'woocommerce_gzd_shipping_provider_method_classname', 'Vendidero\Germanized\Shipments\ShippingProvider\Method', $method );
+
+ return new $classname( $method );
+ }
+ }
+
+ // Load placeholder
+ $placeholder = new ShippingProvider\MethodPlaceholder( $original_id );
+
+ /**
+ * Filter to adjust the fallback shipping method to be loaded if no real
+ * shipping method was able to be constructed (e.g. a custom plugin is being used which
+ * replaces the default Woo shipping zones integration).
+ *
+ * @param ShippingProvider\MethodPlaceholder $placeholder The placeholder impl.
+ * @param string $original_id The shipping method id.
+ *
+ * @since 3.0.6
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipping_provider_method_fallback', $placeholder, $original_id );
+}
+
+function wc_gzd_get_current_shipping_provider_method() {
+ $chosen_shipping_methods = WC()->session ? WC()->session->get( 'chosen_shipping_methods' ) : array();
+
+ if ( ! empty( $chosen_shipping_methods ) ) {
+ $method = wc_gzd_get_shipping_provider_method( $chosen_shipping_methods[0] );
+
+ return $method;
+ }
+
+ return false;
+}
+
+function wc_gzd_get_shipment_order_shipping_status_name( $status ) {
+ if ( 'gzd-' !== substr( $status, 0, 4 ) ) {
+ $status = 'gzd-' . $status;
+ }
+
+ $status_name = '';
+ $statuses = wc_gzd_get_shipment_order_shipping_statuses();
+
+ if ( array_key_exists( $status, $statuses ) ) {
+ $status_name = $statuses[ $status ];
+ }
+
+ /**
+ * Filter to adjust the status name for a certain order shipping status.
+ *
+ * @see wc_gzd_get_shipment_order_shipping_statuses()
+ *
+ * @param string $status_name The status name.
+ * @param string $status The shipping status.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_order_shipping_status_name', $status_name, $status );
+}
+
+function wc_gzd_get_shipment_order_return_status_name( $status ) {
+ if ( 'gzd-' !== substr( $status, 0, 4 ) ) {
+ $status = 'gzd-' . $status;
+ }
+
+ $status_name = '';
+ $statuses = wc_gzd_get_shipment_order_return_statuses();
+
+ if ( array_key_exists( $status, $statuses ) ) {
+ $status_name = $statuses[ $status ];
+ }
+
+ /**
+ * Filter to adjust the status name for a certain order return status.
+ *
+ * @see wc_gzd_get_shipment_order_return_statuses()
+ *
+ * @param string $status_name The status name.
+ * @param string $status The return status.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_order_return_status_name', $status_name, $status );
+}
+
+/**
+ * Standard way of retrieving shipments based on certain parameters.
+ *
+ * @param array $args Array of args (above).
+ *
+ * @return Shipment[] The shipments found.
+ *@since 3.0.0
+ */
+function wc_gzd_get_shipments( $args ) {
+ $query = new Vendidero\Germanized\Shipments\ShipmentQuery( $args );
+
+ return $query->get_shipments();
+}
+
+function wc_gzd_get_shipment_customer_visible_statuses( $shipment_type = 'simple' ) {
+ $statuses = array_keys( wc_gzd_get_shipment_statuses() );
+ $statuses = array_diff( $statuses, array( 'gzd-draft' ) );
+
+ /**
+ * Filter to decide which shipment statuses should be visible to customers
+ * e.g. whether a shipment of a certain status should be shown or not.
+ *
+ * @param array $shipment_statuses The available shipment statuses.
+ * @param string $shipment_type The shipment type.
+ *
+ * @since 3.1.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipment_customer_visible_statuses', $statuses, $shipment_type );
+}
+
+/**
+ * Main function for returning shipments.
+ *
+ * @param mixed $the_shipment Object or shipment id.
+ *
+ * @return bool|SimpleShipment|ReturnShipment|Shipment
+ */
+function wc_gzd_get_shipment( $the_shipment ) {
+ return ShipmentFactory::get_shipment( $the_shipment );
+}
+
+/**
+ * Get all shipment statuses.
+ *
+ * @return array
+ */
+function wc_gzd_get_shipment_statuses() {
+ $shipment_statuses = array(
+ 'gzd-draft' => _x( 'Draft', 'shipments', 'woocommerce-germanized' ),
+ 'gzd-processing' => _x( 'Processing', 'shipments', 'woocommerce-germanized' ),
+ 'gzd-shipped' => _x( 'Shipped', 'shipments', 'woocommerce-germanized' ),
+ 'gzd-delivered' => _x( 'Delivered', 'shipments', 'woocommerce-germanized' ),
+ 'gzd-requested' => _x( 'Requested', 'shipments', 'woocommerce-germanized' ),
+ );
+
+ /**
+ * Add or adjust available Shipment statuses.
+ *
+ * @param array $shipment_statuses The available shipment statuses.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipment_statuses', $shipment_statuses );
+}
+
+/**
+ * @param Shipment $shipment
+ *
+ * @return mixed|void
+ */
+function wc_gzd_get_shipment_selectable_statuses( $shipment ) {
+ $shipment_statuses = wc_gzd_get_shipment_statuses();
+
+ if ( ! $shipment->has_status( 'requested' ) && isset( $shipment_statuses['gzd-requested'] ) ) {
+ unset( $shipment_statuses['gzd-requested'] );
+ }
+
+ /**
+ * Add or remove selectable shipment statuses for a certain shipment and/or shipment type.
+ *
+ * @param array $shipment_statuses The available shipment statuses.
+ * @param string $type The shipment type e.g. return.
+ * @param Shipment $shipment The shipment instance.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipment_selectable_statuses', $shipment_statuses, $shipment->get_type(), $shipment );
+}
+
+/**
+ * @param Order $order_shipment
+ * @param array $args
+ *
+ * @return ReturnShipment|WP_Error
+ */
+function wc_gzd_create_return_shipment( $order_shipment, $args = array() ) {
+ try {
+
+ if ( ! $order_shipment || ! is_a( $order_shipment, 'Vendidero\Germanized\Shipments\Order' ) ) {
+ throw new Exception( _x( 'Invalid order.', 'shipments', 'woocommerce-germanized' ) );
+ }
+
+ if ( ! $order_shipment->needs_return() ) {
+ throw new Exception( _x( 'This order is already fully returned.', 'shipments', 'woocommerce-germanized' ) );
+ }
+
+ $args = wp_parse_args( $args, array(
+ 'items' => array(),
+ 'props' => array(),
+ ) );
+
+ $shipment = ShipmentFactory::get_shipment( false, 'return' );
+
+ if ( ! $shipment ) {
+ throw new Exception( _x( 'Error while creating the shipment instance', 'shipments', 'woocommerce-germanized' ) );
+ }
+
+ // Make sure shipment knows its parent
+ $shipment->set_order_shipment( $order_shipment );
+ $shipment->sync( $args['props'] );
+ $shipment->sync_items( $args );
+ $shipment->save();
+
+ } catch ( Exception $e ) {
+ return new WP_Error( 'error', $e->getMessage() );
+ }
+
+ return $shipment;
+}
+
+/**
+ * @param Order $order_shipment
+ * @param array $args
+ *
+ * @return Shipment|WP_Error
+ */
+function wc_gzd_create_shipment( $order_shipment, $args = array() ) {
+ try {
+
+ if ( ! $order_shipment || ! is_a( $order_shipment, 'Vendidero\Germanized\Shipments\Order' ) ) {
+ throw new Exception( _x( 'Invalid shipment order', 'shipments', 'woocommerce-germanized' ) );
+ }
+
+ if ( ! $order = $order_shipment->get_order() ) {
+ throw new Exception( _x( 'Invalid shipment order', 'shipments', 'woocommerce-germanized' ) );
+ }
+
+ $args = wp_parse_args( $args, array(
+ 'items' => array(),
+ 'props' => array(),
+ ) );
+
+ $shipment = ShipmentFactory::get_shipment( false, 'simple' );
+
+ if ( ! $shipment ) {
+ throw new Exception( _x( 'Error while creating the shipment instance', 'shipments', 'woocommerce-germanized' ) );
+ }
+
+ $shipment->set_order_shipment( $order_shipment );
+ $shipment->sync( $args['props'] );
+ $shipment->sync_items( $args );
+ $shipment->save();
+
+ } catch ( Exception $e ) {
+ return new WP_Error( 'error', $e->getMessage() );
+ }
+
+ return $shipment;
+}
+
+function wc_gzd_create_shipment_item( $shipment, $order_item, $args = array() ) {
+ try {
+
+ if ( ! $order_item || ! is_a( $order_item, 'WC_Order_Item' ) ) {
+ throw new Exception( _x( 'Invalid order item', 'shipments', 'woocommerce-germanized' ) );
+ }
+
+ $item = new Vendidero\Germanized\Shipments\ShipmentItem();
+
+ $item->set_order_item_id( $order_item->get_id() );
+ $item->set_shipment( $shipment );
+ $item->sync( $args );
+ $item->save();
+
+ } catch ( Exception $e ) {
+ return new WP_Error( 'error', $e->getMessage() );
+ }
+
+ return $item;
+}
+
+function wc_gzd_allow_customer_return_empty_return_reason( $order ) {
+ return apply_filters( 'woocommerce_gzd_allow_customer_return_empty_return_reason', true, $order );
+}
+
+/**
+ * @param bool $allow_none
+ * @param bool|WC_Order_Item $order_item
+ *
+ * @return ReturnReason[]
+ */
+function wc_gzd_get_return_shipment_reasons( $order_item = false ) {
+ $reasons = Package::get_setting( 'return_reasons' );
+
+ if ( ! is_array( $reasons ) ) {
+ $reasons = array();
+ } else {
+ $reasons = array_filter( $reasons );
+ }
+
+ /**
+ * Filter that allows adjusting raw return reasons for a specific shipment (e.g. array containing reason data with code, reason and order).
+ *
+ * @param array $reasons Available return reasons.
+ * @param WC_Order_Item|false $order_item The order item object if available to further filter reasons.
+ *
+ * @since 3.1.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ $reasons = apply_filters( 'woocommerce_gzd_return_shipment_reasons_raw', $reasons, $order_item );
+ $instances = array();
+
+ foreach( $reasons as $reason ) {
+ $instances[] = new ReturnReason( $reason );
+ }
+
+ usort( $instances, '_wc_gzd_sort_return_shipment_reasons' );
+
+ /**
+ * Filter that allows to adjust available return reasons for a specific shipment.
+ *
+ * @param ReturnReason[] $reasons Available return reasons.
+ * @param WC_Order_Item|false $order_item The order item object if available to further filter reasons.
+ *
+ * @since 3.1.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_return_shipment_reasons', $instances, $order_item );
+}
+
+function wc_gzd_return_shipment_reason_exists( $maybe_reason, $shipment = false ) {
+ $reasons = wc_gzd_get_return_shipment_reasons( $shipment );
+ $exists = false;
+
+ foreach( $reasons as $reason ) {
+
+ if ( $reason->get_code() === $maybe_reason ) {
+ $exists = true;
+ break;
+ }
+ }
+
+ return $exists;
+}
+
+/**
+ * @param ReturnReason $a
+ * @param ReturnReason $b
+ */
+function _wc_gzd_sort_return_shipment_reasons( $a, $b ) {
+ if ( $a->get_order() == $b->get_order() ) {
+ return 0;
+ } elseif ( $a->get_order() > $b->get_order() ) {
+ return 1;
+ } else {
+ return -1;
+ }
+}
+
+/**
+ * @param WP_Error $error
+ *
+ * @return bool
+ */
+function wc_gzd_shipment_wp_error_has_errors( $error ) {
+ if ( is_callable( array( $error, 'has_errors' ) ) ) {
+ return $error->has_errors();
+ } else {
+ $errors = $error->errors;
+
+ return ( ! empty( $errors ) ? true : false );
+ }
+}
+
+/**
+ * @param Shipment $shipment
+ * @param ShipmentItem $shipment_item
+ * @param array $args
+ *
+ * @return ShipmentReturnItem|WP_Error
+ */
+function wc_gzd_create_return_shipment_item( $shipment, $shipment_item, $args = array() ) {
+
+ try {
+
+ if ( ! $shipment_item || ! is_a( $shipment_item, '\Vendidero\Germanized\Shipments\ShipmentItem' ) ) {
+ throw new Exception( _x( 'Invalid shipment item', 'shipments', 'woocommerce-germanized' ) );
+ }
+
+ $item = new Vendidero\Germanized\Shipments\ShipmentReturnItem();
+ $item->set_order_item_id( $shipment_item->get_order_item_id() );
+ $item->set_shipment( $shipment );
+ $item->sync( $args );
+ $item->save();
+
+ } catch ( Exception $e ) {
+ return new WP_Error( 'error', $e->getMessage() );
+ }
+
+ return $item;
+}
+
+function wc_gzd_get_shipment_editable_statuses() {
+ /**
+ * Filter that allows to adjust Shipment statuses which decide upon whether
+ * a Shipment is editable or not.
+ *
+ * @param array $statuses Statuses which should be considered as editable.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipment_editable_statuses', array( 'draft', 'requested', 'processing' ) );
+}
+
+function wc_gzd_split_shipment_street( $streetStr ) {
+ $return = array(
+ 'street' => $streetStr,
+ 'number' => '',
+ );
+
+ try {
+ $split = AddressSplitter::splitAddress( $streetStr );
+
+ $return['street'] = $split['streetName'];
+ $return['number'] = $split['houseNumber'];
+ $return['addition'] = isset( $split['additionToAddress2'] ) ? $split['additionToAddress2'] : '';
+
+ } catch( Exception $e ) {}
+
+ return $return;
+}
+
+function wc_gzd_get_shipping_providers() {
+ return ShippingProvider\Helper::instance()->get_shipping_providers();
+}
+
+function wc_gzd_get_shipping_provider( $name ) {
+ return ShippingProvider\Helper::instance()->get_shipping_provider( $name );
+}
+
+function wc_gzd_get_default_shipping_provider() {
+ $default = Package::get_setting( 'default_shipping_provider' );
+
+ /**
+ * Filter to adjust the default shipping provider used as a fallback for shipments
+ * for which no provider could be determined automatically (e.g. by the chosen shipping methid).
+ *
+ * @param string $title The shipping provider slug.
+ *
+ * @since 3.0.6
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_default_shipping_provider', $default );
+}
+
+function wc_gzd_get_shipping_provider_select() {
+ $providers = wc_gzd_get_shipping_providers();
+ $select = array(
+ '' => _x( 'None', 'shipments', 'woocommerce-germanized' ),
+ );
+
+ foreach( $providers as $provider ) {
+ if ( ! $provider->is_activated() ) {
+ continue;
+ }
+ $select[ $provider->get_name() ] = $provider->get_title();
+ }
+
+ return $select;
+}
+
+function wc_gzd_get_shipping_provider_title( $slug ) {
+ $providers = wc_gzd_get_shipping_providers();
+
+ if ( array_key_exists( $slug, $providers ) ) {
+ $title = $providers[ $slug ]->get_title();
+ } else {
+ $title = $slug;
+ }
+
+ /**
+ * Filter to adjust the title of a certain shipping provider e.g. DHL.
+ *
+ * @param string $title The shipping provider title.
+ * @param string $slug The shipping provider slug.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipping_provider_title', $title, $slug );
+}
+
+/**
+ * @param Shipment $shipment
+ */
+function wc_gzd_get_shipment_shipping_provider_title( $shipment ) {
+ $title = $shipment->get_shipping_provider_title();
+
+ if ( empty( $title ) ) {
+ $title = apply_filters( 'woocommerce_gzd_shipping_provider_unknown_title', _x( 'Unknown', 'shipments-shipping-provider', 'woocommerce-germanized' ) );
+ }
+
+ return $title;
+}
+
+function wc_gzd_get_shipping_provider_slug( $provider ) {
+ $providers = wc_gzd_get_shipping_providers();
+
+ if ( in_array( $provider, $providers ) ) {
+ $slug = array_search( $provider, $providers );
+ } elseif( array_key_exists( $provider, $providers ) ) {
+ $slug = $provider;
+ } else {
+ $slug = sanitize_key( $provider );
+ }
+
+ return $slug;
+}
+
+function _wc_gzd_shipments_keep_force_filename( $new_filename ) {
+ return isset( $GLOBALS['gzd_shipments_unique_filename'] ) ? $GLOBALS['gzd_shipments_unique_filename'] : $new_filename;
+}
+
+function wc_gzd_shipments_upload_data( $filename, $bits, $relative = true ) {
+ try {
+ Package::set_upload_dir_filter();
+ $GLOBALS['gzd_shipments_unique_filename'] = $filename;
+ add_filter( 'wp_unique_filename', '_wc_gzd_shipments_keep_force_filename', 10, 1 );
+
+ $tmp = wp_upload_bits( $filename,null, $bits );
+
+ unset( $GLOBALS['gzd_shipments_unique_filename'] );
+ remove_filter( 'wp_unique_filename', '_wc_gzd_shipments_keep_force_filename', 10 );
+ Package::unset_upload_dir_filter();
+
+ if ( isset( $tmp['file'] ) ) {
+ $path = $tmp['file'];
+
+ if ( $relative ) {
+ $path = Package::get_relative_upload_dir( $path );
+ }
+
+ return $path;
+ } else {
+ throw new Exception( _x( 'Error while uploading file.', 'shipments', 'woocommerce-germanized' ) );
+ }
+ } catch ( Exception $e ) {
+ return false;
+ }
+}
+
+/**
+ * @param Order $shipment_order
+ *
+ * @return array
+ */
+function wc_gzd_get_shipment_return_address( $shipment_order ) {
+ $country_state = wc_format_country_state_string( Package::get_setting( 'return_address_country' ) );
+
+ $address = array(
+ 'first_name' => Package::get_setting( 'return_address_first_name' ),
+ 'last_name' => Package::get_setting( 'return_address_last_name' ),
+ 'company' => Package::get_setting( 'return_address_company' ),
+ 'address_1' => Package::get_setting( 'return_address_address_1' ),
+ 'address_2' => Package::get_setting( 'return_address_address_2' ),
+ 'city' => Package::get_setting( 'return_address_city' ),
+ 'country' => $country_state['country'],
+ 'state' => $country_state['state'],
+ 'postcode' => Package::get_setting( 'return_address_postcode' ),
+ );
+
+ $address['email'] = get_option( 'admin_email' );
+
+ return $address;
+}
+
+/**
+ * @param WC_Order $order
+ */
+function wc_gzd_get_shipment_order_shipping_method_id( $order ) {
+ $methods = $order->get_shipping_methods();
+ $id = '';
+
+ if ( ! empty( $methods ) ) {
+ $method_vals = array_values( $methods );
+ $method = array_shift( $method_vals );
+
+ if ( $method ) {
+ $id = $method->get_method_id() . ':' . $method->get_instance_id();
+ }
+ }
+
+ /**
+ * Allows adjusting the shipping method id for a certain Order.
+ *
+ * @param string $id The shipping method id.
+ * @param WC_Order $order The order object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipment_order_shipping_method_id', $id, $order );
+}
+
+function wc_gzd_render_shipment_action_buttons( $actions ) {
+ $actions_html = '';
+
+ foreach ( $actions as $action ) {
+ if ( isset( $action['group'] ) ) {
+ $actions_html .= '';
+ } elseif ( isset( $action['action'], $action['url'], $action['name'] ) ) {
+ $target = isset( $action['target'] ) ? $action['target'] : '_self';
+
+ $actions_html .= sprintf( '%5$s', esc_attr( $action['action'] ), esc_url( $action['url'] ), esc_attr( isset( $action['title'] ) ? $action['title'] : $action['name'] ), $target, esc_html( $action['name'] ) );
+ }
+ }
+
+ return $actions_html;
+}
+
+function wc_gzd_get_shipment_status_name( $status ) {
+ if ( 'gzd-' !== substr( $status, 0, 4 ) ) {
+ $status = 'gzd-' . $status;
+ }
+
+ $status_name = '';
+ $statuses = wc_gzd_get_shipment_statuses();
+
+ if ( array_key_exists( $status, $statuses ) ) {
+ $status_name = $statuses[ $status ];
+ }
+
+ /**
+ * Filter to adjust the shipment status name or title.
+ *
+ * @param string $status_name The status name or title.
+ * @param integer $status The status slug.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipment_status_name', $status_name, $status );
+}
+
+function wc_gzd_get_shipment_sent_statuses() {
+ /**
+ * Filter to adjust which Shipment statuses should be considered as sent.
+ *
+ * @param array $statuses An array of statuses considered as shipped,
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipment_sent_statuses', array(
+ 'shipped',
+ 'delivered',
+ ) );
+}
+
+function wc_gzd_get_shipment_counts( $type = '' ) {
+ $counts = array();
+
+ foreach( array_keys( wc_gzd_get_shipment_statuses() ) as $status ) {
+ $counts[ $status ] = wc_gzd_get_shipment_count( $status, $type );
+ }
+
+ return $counts;
+}
+
+function wc_gzd_get_shipment_count( $status, $type = '' ) {
+ $count = 0;
+ $status = ( substr( $status, 0, 4 ) ) === 'gzd-' ? $status : 'gzd-' . $status;
+ $shipment_statuses = array_keys( wc_gzd_get_shipment_statuses() );
+
+ if ( ! in_array( $status, $shipment_statuses, true ) ) {
+ return 0;
+ }
+
+ $cache_key = WC_Cache_Helper::get_cache_prefix( 'shipments' ) . $status . $type;
+ $cached_count = wp_cache_get( $cache_key, 'counts' );
+
+ if ( false !== $cached_count ) {
+ return $cached_count;
+ }
+
+ $data_store = WC_Data_Store::load( 'shipment' );
+
+ if ( $data_store ) {
+ $count += $data_store->get_shipment_count( $status, $type );
+ }
+
+ wp_cache_set( $cache_key, $count, 'counts' );
+
+ return $count;
+}
+
+/**
+ * See if a string is a shipment status.
+ *
+ * @param string $maybe_status Status, including any gzd- prefix.
+ * @return bool
+ */
+function wc_gzd_is_shipment_status( $maybe_status ) {
+ $shipment_statuses = wc_gzd_get_shipment_statuses();
+
+ return isset( $shipment_statuses[ $maybe_status ] );
+}
+
+/**
+ * Main function for returning shipment items.
+ *
+ * @since 2.2
+ *
+ * @param mixed $the_item Object or shipment item id.
+ * @param string $item_type The shipment item type.
+ *
+ * @return bool|ShipmentItem
+ */
+function wc_gzd_get_shipment_item( $the_item = false, $item_type = 'simple' ) {
+ $item_id = wc_gzd_get_shipment_item_id( $the_item );
+
+ if ( ! $item_id ) {
+ return false;
+ }
+
+ $item_class = 'Vendidero\Germanized\Shipments\ShipmentItem';
+
+ if ( 'return' === $item_type ) {
+ $item_class = 'Vendidero\Germanized\Shipments\ShipmentReturnItem';
+ }
+
+ /**
+ * Filter to adjust the classname used to construct a ShipmentItem.
+ *
+ * @param string $classname The classname to be used.
+ * @param integer $item_id The shipment item id.
+ * @param string $item_type The shipment item type.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ $classname = apply_filters( 'woocommerce_gzd_shipment_item_class', $item_class, $item_id, $item_type );
+
+ if ( ! class_exists( $classname ) ) {
+ return false;
+ }
+
+ try {
+ return new $classname( $item_id );
+ } catch ( Exception $e ) {
+ wc_caught_exception( $e, __FUNCTION__, func_get_args() );
+ return false;
+ }
+}
+
+/**
+ * Get the shipment item ID depending on what was passed.
+ *
+ * @since 3.0.0
+ * @param mixed $item Item data to convert to an ID.
+ * @return int|bool false on failure
+ */
+function wc_gzd_get_shipment_item_id( $item ) {
+ if ( is_numeric( $item ) ) {
+ return $item;
+ } elseif ( $item instanceof Vendidero\Germanized\Shipments\ShipmentItem ) {
+ return $item->get_id();
+ } elseif ( ! empty( $item->shipment_item_id ) ) {
+ return $item->shipment_item_id;
+ } else {
+ return false;
+ }
+}
+
+/**
+ * Format dimensions for display.
+ *
+ * @since 3.0.0
+ * @param array $dimensions Array of dimensions.
+ * @return string
+ */
+function wc_gzd_format_shipment_dimensions( $dimensions, $unit = '' ) {
+ $dimension_string = implode( ' × ', array_filter( array_map( 'wc_format_localized_decimal', $dimensions ) ) );
+
+ if ( ! empty( $dimension_string ) ) {
+ $unit = empty( $unit ) ? get_option( 'woocommerce_dimension_unit' ) : $unit;
+ $dimension_string .= ' ' . $unit;
+ } else {
+ $dimension_string = _x( 'N/A', 'shipments', 'woocommerce-germanized' );
+ }
+
+ /**
+ * Filter to adjust the format of Shipment dimensions e.g. LxBxH.
+ *
+ * @param string $dimension_string The dimension string.
+ * @param array $dimensions Array containing the dimensions.
+ * @param string $unit The dimension unit.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_format_shipment_dimensions', $dimension_string, $dimensions, $unit );
+}
+
+/**
+ * Format a weight for display.
+ *
+ * @since 3.0.0
+ * @param float $weight Weight.
+ * @return string
+ */
+function wc_gzd_format_shipment_weight( $weight, $unit = '' ) {
+ $weight_string = wc_format_localized_decimal( $weight );
+
+ if ( ! empty( $weight_string ) ) {
+ $unit = empty( $unit ) ? get_option( 'woocommerce_weight_unit' ) : $unit;
+ $weight_string .= ' ' . $unit;
+ } else {
+ $weight_string = _x( 'N/A', 'shipments', 'woocommerce-germanized' );
+ }
+
+ /**
+ * Filter to adjust the format of Shipment weight.
+ *
+ * @param string $weight_string The weight string.
+ * @param string $weight The Shipment weight.
+ * @param string $unit The dimension unit.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_format_shipment_weight', $weight_string, $weight, $unit );
+}
+
+/**
+ * Get My Account > Shipments columns.
+ *
+ * @since 3.0.0
+ * @return array
+ */
+function wc_gzd_get_account_shipments_columns( $type = 'simple' ) {
+ /**
+ * Filter to adjust columns being used to display shipments in a table view on the customer
+ * account page.
+ *
+ * @param string[] $columns The columns in key => value pairs.
+ * @param string $type The shipment type e.g. simple or return.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ $columns = apply_filters(
+ 'woocommerce_gzd_account_shipments_columns',
+ array(
+ 'shipment-number' => _x( 'Shipment', 'shipments', 'woocommerce-germanized' ),
+ 'shipment-date' => _x( 'Date', 'shipments', 'woocommerce-germanized' ),
+ 'shipment-status' => _x( 'Status', 'shipments', 'woocommerce-germanized' ),
+ 'shipment-tracking' => _x( 'Tracking', 'shipments', 'woocommerce-germanized' ),
+ 'shipment-actions' => _x( 'Actions', 'shipments', 'woocommerce-germanized' ),
+ ), $type
+ );
+
+ return $columns;
+}
+
+function wc_gzd_get_order_customer_add_return_url( $order ) {
+
+ if ( ! $shipment_order = wc_gzd_get_shipment_order( $order ) ) {
+ return false;
+ }
+
+ $url = wc_get_endpoint_url( 'add-return-shipment', $shipment_order->get_order()->get_id(), wc_get_page_permalink( 'myaccount' ) );
+
+ if ( $shipment_order->get_order()->get_customer_id() <= 0 ) {
+ $key = $shipment_order->get_order_return_request_key();
+
+ if ( ! empty( $key ) ) {
+ $url = add_query_arg( array( 'key' => $key ), $url );
+ } else {
+ $url = '';
+ }
+ }
+
+ /**
+ * Filter to adjust the URL the customer (or guest) might access to add a return to a certain order.
+ *
+ * @param string $url The URL pointing to the add return page.
+ * @param Order $order The order object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( "woocommerce_gzd_shipments_add_return_shipment_url", $url, $shipment_order->get_order() );
+}
+
+/**
+ * @param WC_Order $order
+ *
+ * @return mixed
+ */
+function wc_gzd_order_is_customer_returnable( $order, $check_date = true ) {
+ $is_returnable = false;
+
+ if ( ! $shipment_order = wc_gzd_get_shipment_order( $order ) ) {
+ return false;
+ }
+
+ if ( $provider = wc_gzd_get_order_shipping_provider( $order ) ) {
+ $is_returnable = $provider->supports_customer_returns( $order );
+
+ if ( $shipment_order->get_order()->get_customer_id() <= 0 && ! $provider->supports_guest_returns() ) {
+ $is_returnable = false;
+ }
+ }
+
+ // Shipment is fully returned
+ if ( ! $shipment_order->needs_return() ) {
+ $is_returnable = false;
+ }
+
+ // Check days left for return
+ $maximum_days = Package::get_setting( 'customer_return_open_days' );
+
+ if ( $check_date && ! empty( $maximum_days ) ) {
+ $maximum_days = absint( $maximum_days );
+
+ if ( ! empty( $maximum_days ) ) {
+
+ $completed_date = $shipment_order->get_order()->get_date_created();
+
+ if ( $shipment_order->get_date_shipped() ) {
+ $completed_date = $shipment_order->get_date_shipped();
+ } elseif( $shipment_order->get_order()->get_date_completed() ) {
+ $completed_date = $shipment_order->get_order()->get_date_completed();
+ }
+
+ /**
+ * Filter to adjust the completed date of an order used to determine whether an order is
+ * still returnable by the customer or not. The date is constructed by checking for existence in the following order:
+ *
+ * 1. The date the order was shipped completely
+ * 2. The date the order was marked as completed
+ * 3. The date the order was created
+ *
+ * @param WC_DateTime $completed_date The order completed date.
+ * @param WC_Order $order The order instance.
+ *
+ * @since 3.1.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ $completed_date = apply_filters( 'woocommerce_gzd_order_return_completed_date', $completed_date, $shipment_order->get_order() );
+
+ if ( $completed_date ) {
+ $today = new WC_DateTime();
+ $diff = $today->diff( $completed_date );
+
+ if ( $diff->days > $maximum_days ) {
+ $is_returnable = false;
+ }
+ }
+ }
+ }
+
+ /**
+ * Filter to decide whether a customer might add return request to a certain order.
+ *
+ * @param bool $is_returnable Whether or not shipment supports customer added returns
+ * @param WC_Order $order The order instance for which the return shall be created.
+ * @param bool $check_date Whether to check for a maximum date or not.
+ *
+ * @since 3.1.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_order_is_returnable_by_customer', $is_returnable, $shipment_order->get_order(), $check_date );
+}
+
+/**
+ * @param $order
+ *
+ * @return bool|\Vendidero\Germanized\Shipments\Interfaces\ShippingProvider
+ */
+function wc_gzd_get_order_shipping_provider( $order ) {
+ if ( is_numeric( $order ) ) {
+ $order = wc_get_order( $order );
+ }
+
+ if ( ! $order ) {
+ return false;
+ }
+
+ $provider = false;
+
+ if ( $method = wc_gzd_get_shipping_provider_method( wc_gzd_get_shipment_order_shipping_method_id( $order ) ) ) {
+ $provider = $method->get_provider_instance();
+ }
+
+ /**
+ * Filters the shipping provider detected for a specific order.
+ *
+ * @param bool|\Vendidero\Germanized\Shipments\Interfaces\ShippingProvider $provider The shipping provider instance.
+ * @param WC_Order $order The order instance.
+ *
+ * @since 3.1.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_get_order_shipping_provider', $provider, $order );
+}
+
+function wc_gzd_get_customer_order_return_request_key() {
+ $key = ( isset( $_REQUEST['key'] ) ? wc_clean( wp_unslash( $_REQUEST['key'] ) ) : '' );
+
+ return $key;
+}
+
+function wc_gzd_customer_can_add_return_shipment( $order_id ) {
+ $can_view_shipments = false;
+
+ if ( isset( $_REQUEST['key'] ) && ! empty( $_REQUEST['key'] ) ) {
+ $key = wc_gzd_get_customer_order_return_request_key();
+
+ if ( ( $order_shipment = wc_gzd_get_shipment_order( $order_id ) ) && ! empty( $key ) ) {
+
+ if ( hash_equals( $order_shipment->get_order_return_request_key(), $key ) ) {
+ $can_view_shipments = true;
+ }
+ }
+ } elseif ( is_user_logged_in() ) {
+ $can_view_shipments = current_user_can( 'view_order', $order_id );
+ }
+
+ /**
+ * Filters whether a logged in user (or guest) might view shipments belonging to an order or not.
+ *
+ * @param bool $can_view_shipments Whether the user (or guest) might see shipments or not.
+ * @param integer $order_id The order id.
+ *
+ * @since 3.1.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_customer_can_view_shipments', $can_view_shipments, $order_id );
+}
+
+/**
+ * @param WC_Order|integer $order
+ */
+function wc_gzd_customer_return_needs_manual_confirmation( $order ) {
+ if ( is_numeric( $order ) ) {
+ $order = wc_get_order( $order );
+ }
+
+ if ( ! $order ) {
+ return true;
+ }
+
+ $needs_manual_confirmation = true;
+
+ if ( $provider = wc_gzd_get_order_shipping_provider( $order ) ) {
+ $needs_manual_confirmation = $provider->needs_manual_confirmation_for_returns();
+ }
+
+ /**
+ * Filter to decide whether a customer added return of a certain order
+ * needs manual confirmation by the shop manager or not.
+ *
+ * @param bool $needs_manual_confirmation Whether needs manual confirmation or not.
+ * @param WC_Order $order The order instance for which the return shall be created.
+ *
+ * @since 3.1.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_customer_return_needs_manual_confirmation', $needs_manual_confirmation, $order );
+ }
+
+/**
+ * Get account shipments actions.
+ *
+ * @since 3.2.0
+ * @param int|Shipment $shipment Shipment instance or ID.
+ * @return array
+ */
+function wc_gzd_get_account_shipments_actions( $shipment ) {
+
+ if ( ! is_object( $shipment ) ) {
+ $shipment_id = absint( $shipment );
+ $shipment = wc_gzd_get_shipment( $shipment_id );
+ }
+
+ if ( ! $shipment ) {
+ return array();
+ }
+
+ $actions = array(
+ 'view' => array(
+ 'url' => $shipment->get_view_shipment_url(),
+ 'name' => _x( 'View', 'shipments', 'woocommerce-germanized' ),
+ ),
+ );
+
+ if ( 'return' === $shipment->get_type() && $shipment->has_label() && ! $shipment->has_status( 'delivered' ) ) {
+ $actions['download-label'] = array(
+ 'url' => $shipment->get_label()->get_download_url(),
+ 'name' => _x( 'Download label', 'shipments', 'woocommerce-germanized' ),
+ );
+ }
+
+ /**
+ * Filter to adjust available actions in the shipments table view on the customer account page
+ * for a specific shipment.
+ *
+ * @param string[] $actions Available actions containing an id as key and a URL and name.
+ * @param Shipment $shipment The shipment instance.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_account_shipments_actions', $actions, $shipment );
+}
diff --git a/packages/woocommerce-germanized-shipments/includes/wc-gzd-shipment-template-hooks.php b/packages/woocommerce-germanized-shipments/includes/wc-gzd-shipment-template-hooks.php
new file mode 100644
index 000000000..3f211f474
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/wc-gzd-shipment-template-hooks.php
@@ -0,0 +1,28 @@
+ false,
+ 'show_image' => false,
+ 'image_size' => array( 32, 32 ),
+ 'plain_text' => false,
+ 'sent_to_admin' => false,
+ );
+
+ $args = wp_parse_args( $args, $defaults );
+ $template = $args['plain_text'] ? 'emails/plain/email-shipment-items.php' : 'emails/email-shipment-items.php';
+
+ wc_get_template(
+ $template,
+ /**
+ * Filter to adjust the arguments passed to retrieving ShipmentItems for display in an Email.
+ *
+ * @param array $args Array containing the arguments passed.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ apply_filters(
+ 'woocommerce_gzd_email_shipment_items_args',
+ array(
+ 'shipment' => $shipment,
+ 'items' => $shipment->get_items(),
+ 'show_sku' => $args['show_sku'],
+ 'show_image' => $args['show_image'],
+ 'image_size' => $args['image_size'],
+ 'plain_text' => $args['plain_text'],
+ 'sent_to_admin' => $args['sent_to_admin'],
+ )
+ )
+ );
+
+ /**
+ * Filter that allows adjusting the HTML output of the shipment email item table.
+ *
+ * @param string $html The HTML output.
+ * @param Shipment $shipment The shipment instance.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_email_shipment_items_table', ob_get_clean(), $shipment );
+ }
+}
+
+if ( ! function_exists( 'woocommerce_gzd_shipments_template_view_shipments' ) ) {
+
+ function woocommerce_gzd_shipments_template_view_shipments( $order_id ) {
+
+ if ( ( ! ( $order = wc_get_order( $order_id ) ) ) || ( ! current_user_can( 'view_order', $order_id ) ) ) {
+ echo '' . esc_html_x( 'Invalid order.', 'shipments', 'woocommerce-germanized' ) . ' ' . esc_html_x( 'My account', 'shipments', 'woocommerce-germanized' ) . '
';
+
+ return;
+ }
+
+ $shipments = wc_gzd_get_shipments( array(
+ 'order_id' => $order_id,
+ 'type' => 'simple',
+ 'status' => wc_gzd_get_shipment_customer_visible_statuses(),
+ ) );
+
+ $returns = wc_gzd_get_shipments( array(
+ 'order_id' => $order_id,
+ 'type' => 'return',
+ 'status' => wc_gzd_get_shipment_customer_visible_statuses( 'return' ),
+ ) );
+
+ wc_get_template(
+ 'myaccount/order-shipments.php',
+ array(
+ 'order_id' => $order_id,
+ 'order' => $order,
+ 'shipments' => $shipments,
+ 'returns' => $returns,
+ )
+ );
+ }
+}
+
+if ( ! function_exists( 'woocommerce_gzd_shipments_template_view_shipment' ) ) {
+
+ function woocommerce_gzd_shipments_template_view_shipment( $shipment_id ) {
+
+ if ( ( ! ( $shipment = wc_gzd_get_shipment( $shipment_id ) ) ) || ( ! current_user_can( 'view_order', $shipment->get_order_id() ) ) ) {
+ echo '' . esc_html_x( 'Invalid shipment.', 'shipments', 'woocommerce-germanized' ) . ' ' . esc_html_x( 'My account', 'shipments', 'woocommerce-germanized' ) . '
';
+
+ return;
+ }
+
+ wc_get_template(
+ 'myaccount/view-shipment.php',
+ array(
+ 'shipment' => $shipment,
+ 'shipment_id' => $shipment_id,
+ )
+ );
+ }
+}
+
+if ( ! function_exists( 'woocommerce_gzd_shipments_template_add_return_shipment' ) ) {
+
+ function woocommerce_gzd_shipments_template_add_return_shipment( $order_id ) {
+
+ if ( ( ! ( $order = wc_get_order( $order_id ) ) ) || ( ! wc_gzd_customer_can_add_return_shipment( $order_id ) ) ) {
+ echo '' . esc_html_x( 'Invalid order.', 'shipments', 'woocommerce-germanized' ) . ' ' . esc_html_x( 'My account', 'shipments', 'woocommerce-germanized' ) . '
';
+ return;
+ }
+
+ if ( ! wc_gzd_order_is_customer_returnable( $order_id ) ) {
+ echo '' . esc_html_x( 'Currently you cannot add new return requests to that order. If you have questions regarding the return of that order please contact us for further information.', 'shipments', 'woocommerce-germanized' ) . ( is_user_logged_in() ? ' ' . esc_html_x( 'View order', 'shipments', 'woocommerce-germanized' ) . '' : '' ) . '
';
+ return;
+ }
+
+ $notices = function_exists( 'wc_print_notices' ) ? wc_print_notices( true ) : '';
+
+ // Output notices in case notices have not been outputted yet.
+ if ( ! empty( $notices ) ) {
+ echo '' . $notices . '
';
+ }
+
+ wc_get_template(
+ 'myaccount/add-return-shipment.php',
+ array(
+ 'order' => $order,
+ 'order_id' => $order_id,
+ 'shipment_order' => wc_gzd_get_shipment_order( $order ),
+ )
+ );
+ }
+}
+
+if ( ! function_exists( 'woocommerce_gzd_shipment_details_table' ) ) {
+
+ function woocommerce_gzd_shipment_details_table( $shipment_id ) {
+ if ( ! $shipment_id ) {
+ return;
+ }
+
+ wc_get_template(
+ 'shipment/shipment-details.php',
+ array(
+ 'shipment_id' => $shipment_id,
+ )
+ );
+ }
+}
+
+if ( ! function_exists( 'woocommerce_gzd_return_shipments_template_instructions' ) ) {
+
+ function woocommerce_gzd_return_shipments_template_instructions( $shipment_id ) {
+ if ( $shipment = wc_gzd_get_shipment( $shipment_id ) ) {
+
+ if ( 'return' !== $shipment->get_type() ) {
+ return;
+ }
+
+ if ( ! $shipment->has_status( array( 'processing', 'sent' ) ) ) {
+ return;
+ }
+
+ wc_get_template(
+ 'shipment/shipment-return-instructions.php',
+ array(
+ 'shipment' => $shipment,
+ 'shipment_id' => $shipment_id,
+ )
+ );
+ }
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/license.txt b/packages/woocommerce-germanized-shipments/license.txt
new file mode 100644
index 000000000..16aa3cb39
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/license.txt
@@ -0,0 +1,699 @@
+WooCommerce Germanized Shipments
+
+Copyright 2019 by the contributors
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
+This program incorporates work covered by the following copyright and
+permission notices:
+
+ WooCommerce
+
+=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright © 2007 Free Software Foundation, Inc.
+
+ $value ) {
+ if ( isset( $value['id'] ) && $value['id'] == $id ) {
+ if ( ! empty( $type ) && $type !== $value['type'] ) {
+ continue;
+ }
+ return $key;
+ }
+ }
+ }
+
+ return false;
+ }
+
+ protected static function add_settings_after( $settings, $id, $insert = array(), $type = '' ) {
+ $key = self::get_setting_key_by_id( $settings, $id, $type );
+
+ if ( is_numeric( $key ) ) {
+ $key ++;
+ $settings = array_merge( array_merge( array_slice( $settings, 0, $key, true ), $insert ), array_slice( $settings, $key, count( $settings ) - 1, true ) );
+ } else {
+ $settings += $insert;
+ }
+
+ return $settings;
+ }
+
+ public static function register_endpoint_settings( $settings, $current_section ) {
+ if ( '' === $current_section ) {
+ $endpoints = array(
+ array(
+ 'title' => _x( 'View Shipments', 'shipments', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Endpoint for the "My account → View shipments" page.', 'shipments', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_gzd_shipments_view_shipments_endpoint',
+ 'type' => 'text',
+ 'default' => 'view-shipments',
+ 'desc_tip' => true,
+ ),
+ array(
+ 'title' => _x( 'View shipment', 'shipments', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Endpoint for the "My account → View shipment" page.', 'shipments', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_gzd_shipments_view_shipment_endpoint',
+ 'type' => 'text',
+ 'default' => 'view-shipment',
+ 'desc_tip' => true,
+ ),
+ array(
+ 'title' => _x( 'Add Return Shipment', 'shipments', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Endpoint for the "My account → Add return shipment" page.', 'shipments', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_gzd_shipments_add_return_shipment_endpoint',
+ 'type' => 'text',
+ 'default' => 'add-return-shipment',
+ 'desc_tip' => true,
+ ),
+ );
+
+ $settings = self::add_settings_after( $settings, 'woocommerce_myaccount_downloads_endpoint', $endpoints );
+ }
+
+ return $settings;
+ }
+
+ public static function menu_return_count() {
+ global $submenu;
+
+ if ( isset( $submenu['woocommerce'] ) ) {
+
+ /**
+ * Filter to adjust whether to include requested return count in admin menu or not.
+ *
+ * @param boolean $show_count Whether to show count or not.
+ *
+ * @since 3.1.3
+ * @package Vendidero/Germanized/Shipments
+ */
+ if ( apply_filters( 'woocommerce_gzd_shipments_include_requested_return_count_in_menu', true ) && current_user_can( 'manage_woocommerce' ) ) {
+ $return_count = wc_gzd_get_shipment_count( 'requested', 'return' );
+
+ if ( $return_count ) {
+ foreach ( $submenu['woocommerce'] as $key => $menu_item ) {
+ if ( 0 === strpos( $menu_item[0], _x( 'Returns', 'shipments', 'woocommerce-germanized' ) ) ) {
+ $submenu['woocommerce'][ $key ][0] .= ' ' . number_format_i18n( $return_count ) . ''; // WPCS: override ok.
+ break;
+ }
+ }
+ }
+ }
+ }
+ }
+
+ public static function get_admin_shipment_item_columns( $shipment ) {
+ $item_columns = array(
+ 'name' => array(
+ 'title' => _x( 'Item', 'shipments', 'woocommerce-germanized' ),
+ 'size' => 6,
+ 'order' => 5,
+ ),
+ 'quantity' => array(
+ 'title' => _x( 'Quantity', 'shipments', 'woocommerce-germanized' ),
+ 'size' => 3,
+ 'order' => 10,
+ ),
+ 'action' => array(
+ 'title' => _x( 'Actions', 'shipments', 'woocommerce-germanized' ),
+ 'size' => 3,
+ 'order' => 15,
+ ),
+ );
+
+ if ( 'return' === $shipment->get_type() ) {
+ $item_columns['return_reason'] = array(
+ 'title' => _x( 'Reason', 'shipments', 'woocommerce-germanized' ),
+ 'size' => 3,
+ 'order' => 7,
+ );
+
+ $item_columns['name']['size'] = 5;
+ $item_columns['quantity']['size'] = 2;
+ $item_columns['action']['size'] = 2;
+ }
+
+ uasort ( $item_columns, array( __CLASS__, '_sort_shipment_item_columns' ) );
+
+ /**
+ * Filter to adjust shipment item columns shown in admin view.
+ *
+ * @param array $item_columns The columns available.
+ * @param Shipment $shipment The shipment.
+ *
+ * @since 3.1.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipments_meta_box_shipment_item_columns', $item_columns, $shipment );
+ }
+
+ public static function _sort_shipment_item_columns( $a, $b ) {
+ if ( $a['order'] == $b['order'] ) {
+ return 0;
+ }
+ return ( $a['order'] < $b['order'] ) ? -1 : 1;
+ }
+
+ public static function save_packaging_list() {
+ $current_key_list = array();
+ $packaging_ids_after_save = array();
+
+ foreach( wc_gzd_get_packaging_list() as $pack ) {
+ $current_key_list[] = $pack->get_id();
+ }
+
+ // phpcs:disable WordPress.Security.NonceVerification.NoNonceVerification -- Nonce verification already handled in WC_Admin_Settings::save()
+ if ( isset( $_POST['packaging'] ) ) {
+ $packaging_post = wc_clean( wp_unslash( $_POST['packaging'] ) );
+ $order = 0;
+ $available_types = array_keys( wc_gzd_get_packaging_types() );
+
+ foreach( $packaging_post as $packaging ) {
+ $packaging = wc_clean( $packaging );
+ $packaging_id = isset( $packaging['packaging_id'] ) ? absint( $packaging['packaging_id'] ) : 0;
+ $packaging_obj = wc_gzd_get_packaging( $packaging_id );
+
+ if ( $packaging_obj ) {
+ $packaging_obj->set_props( array(
+ 'type' => ! in_array( $packaging['type'], $available_types ) ? 'cardboard' : $packaging['type'],
+ 'weight' => empty( $packaging['weight'] ) ? 0 : $packaging['weight'],
+ 'description' => empty( $packaging['description'] ) ? '' : $packaging['description'],
+ 'length' => empty( $packaging['length'] ) ? 0 : $packaging['length'],
+ 'width' => empty( $packaging['width'] ) ? 0 : $packaging['width'],
+ 'height' => empty( $packaging['height'] ) ? 0 : $packaging['height'],
+ 'max_content_weight' => empty( $packaging['max_content_weight'] ) ? 0 : $packaging['max_content_weight'],
+ 'order' => ++$order,
+ ) );
+
+ if ( empty( $packaging_obj->get_description() ) ) {
+ if ( $packaging_obj->get_id() > 0 ) {
+ $packaging_obj->delete( true );
+ continue;
+ } else {
+ continue;
+ }
+ }
+
+ $packaging_obj->save();
+ $packaging_ids_after_save[] = $packaging_obj->get_id();
+ }
+ }
+ }
+
+ $to_delete = array_diff( $current_key_list, $packaging_ids_after_save );
+
+ if ( ! empty( $to_delete ) ) {
+ foreach( $to_delete as $delete_id ) {
+ if ( $packaging = wc_gzd_get_packaging( $delete_id ) ) {
+ $packaging->delete( true );
+ }
+ }
+ }
+ }
+
+ public static function save_return_reasons( $tab, $current_section ) {
+ if ( '' !== $current_section ) {
+ return;
+ }
+
+ $reasons = array();
+
+ // phpcs:disable WordPress.Security.NonceVerification.NoNonceVerification -- Nonce verification already handled in WC_Admin_Settings::save()
+ if ( isset( $_POST['shipment_return_reason'] ) ) {
+
+ $reasons_post = wc_clean( wp_unslash( $_POST['shipment_return_reason'] ) );
+ $order = 0;
+
+ foreach( $reasons_post as $reason ) {
+ $code = isset( $reason['code'] ) ? $reason['code'] : '';
+ $reason_text = isset( $reason['reason'] ) ? $reason['reason'] : '';
+
+ if ( empty( $code ) ) {
+ $code = sanitize_title( $reason_text );
+ }
+
+ if ( ! empty( $reason_text ) ) {
+ $reasons[] = array(
+ 'order' => ++$order,
+ 'code' => $code,
+ 'reason' => $reason_text,
+ );
+ }
+ }
+ }
+ // phpcs:enable
+
+ update_option( 'woocommerce_gzd_shipments_return_reasons', $reasons );
+ }
+
+ public static function output_return_reasons_field( $value ) {
+ ob_start();
+ ?>
+ wp-content/uploads/' . $dirname . '' ); ?>
+
+
+
+ + output_notice(); + $_SERVER['REQUEST_URI'] = remove_query_arg( array( 'updated', 'changed', 'deleted', 'trashed', 'untrashed' ), $_SERVER['REQUEST_URI'] ); + ?> + + views(); ?> + + + + +
+
+
+ + + output_notice(); + $_SERVER['REQUEST_URI'] = remove_query_arg( array( 'updated', 'changed', 'deleted', 'trashed', 'untrashed' ), $_SERVER['REQUEST_URI'] ); + ?> + + views(); ?> + + + + +
+
+
+
+ + output_notice(); + $_SERVER['REQUEST_URI'] = remove_query_arg( array( 'updated', 'changed', 'deleted', 'trashed', 'untrashed' ), $_SERVER['REQUEST_URI'] ); + ?> + + views(); ?> + + + + +
+
+ id : '';
+ $suffix = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min';
+
+ // Register admin styles.
+ wp_register_style( 'woocommerce_gzd_shipments_admin', Package::get_assets_url() . '/css/admin' . $suffix . '.css', array( 'woocommerce_admin_styles' ), Package::get_version() );
+
+ // Admin styles for WC pages only.
+ if ( in_array( $screen_id, self::get_screen_ids() ) ) {
+ wp_enqueue_style( 'woocommerce_gzd_shipments_admin' );
+ }
+
+ if ( 'woocommerce_page_wc-settings' === $screen_id && isset( $_GET['tab'] ) && in_array( $_GET['tab'], array( 'germanized-shipments', 'germanized-shipping_provider' ) ) ) {
+ wp_enqueue_style( 'woocommerce_gzd_shipments_admin' );
+ }
+
+ // Shipping zone methods
+ if ( 'woocommerce_page_wc-settings' === $screen_id && isset( $_GET['tab'] ) && 'shipping' === $_GET['tab'] && isset( $_GET['zone_id'] ) ) {
+ wp_enqueue_style( 'woocommerce_gzd_shipments_admin' );
+ }
+ }
+
+ public static function admin_scripts() {
+ global $post;
+
+ $screen = get_current_screen();
+ $screen_id = $screen ? $screen->id : '';
+ $suffix = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min';
+
+ wp_register_script( 'wc-gzd-admin-shipment-label-backbone', Package::get_assets_url() . '/js/admin-shipment-label-backbone' . $suffix . '.js', array( 'jquery', 'woocommerce_admin', 'wc-backbone-modal' ), Package::get_version() );
+ wp_register_script( 'wc-gzd-admin-shipment', Package::get_assets_url() . '/js/admin-shipment' . $suffix . '.js', array( 'wc-gzd-admin-shipment-label-backbone' ), Package::get_version() );
+ wp_register_script( 'wc-gzd-admin-shipments', Package::get_assets_url() . '/js/admin-shipments' . $suffix . '.js', array( 'wc-admin-order-meta-boxes', 'wc-gzd-admin-shipment' ), Package::get_version() );
+ wp_register_script( 'wc-gzd-admin-shipments-table', Package::get_assets_url() . '/js/admin-shipments-table' . $suffix . '.js', array( 'woocommerce_admin', 'wc-gzd-admin-shipment-label-backbone' ), Package::get_version() );
+ wp_register_script( 'wc-gzd-admin-shipping-providers', Package::get_assets_url() . '/js/admin-shipping-providers' . $suffix . '.js', array( 'jquery' ), Package::get_version() );
+ wp_register_script( 'wc-gzd-admin-shipping-provider-method', Package::get_assets_url() . '/js/admin-shipping-provider-method' . $suffix . '.js', array( 'jquery' ), Package::get_version() );
+
+ // Orders.
+ if ( in_array( str_replace( 'edit-', '', $screen_id ), wc_get_order_types( 'order-meta-boxes' ) ) ) {
+
+ wp_enqueue_script( 'wc-gzd-admin-shipments' );
+ wp_enqueue_script( 'wc-gzd-admin-shipment' );
+
+ wp_localize_script(
+ 'wc-gzd-admin-shipments',
+ 'wc_gzd_admin_shipments_params',
+ array(
+ 'ajax_url' => admin_url( 'admin-ajax.php' ),
+ 'edit_shipments_nonce' => wp_create_nonce( 'edit-shipments' ),
+ 'order_id' => isset( $post->ID ) ? $post->ID : '',
+ 'shipment_locked_excluded_fields' => array( 'status' ),
+ 'i18n_remove_shipment_notice' => _x( 'Do you really want to delete the shipment?', 'shipments', 'woocommerce-germanized' ),
+ 'remove_label_nonce' => wp_create_nonce( 'remove-shipment-label' ),
+ 'edit_label_nonce' => wp_create_nonce( 'edit-shipment-label' ),
+ 'send_return_notification_nonce' => wp_create_nonce( 'send-return-shipment-notification' ),
+ 'refresh_packaging_nonce' => wp_create_nonce( 'refresh-shipment-packaging' ),
+ 'confirm_return_request_nonce' => wp_create_nonce( 'confirm-return-request' ),
+ 'i18n_remove_label_notice' => _x( 'Do you really want to delete the label?', 'shipments', 'woocommerce-germanized' ),
+ 'i18n_create_label_enabled' => _x( 'Create new label', 'shipments', 'woocommerce-germanized' ),
+ 'i18n_create_label_disabled' => _x( 'Please save the shipment before creating a new label', 'shipments', 'woocommerce-germanized' ),
+ )
+ );
+ }
+
+ // Table
+ if ( 'woocommerce_page_wc-gzd-shipments' === $screen_id || 'woocommerce_page_wc-gzd-return-shipments' === $screen_id ) {
+ wp_enqueue_script( 'wc-gzd-admin-shipments-table' );
+
+ $bulk_actions = array();
+
+ foreach( self::get_bulk_action_handlers() as $handler ) {
+ $bulk_actions[ sanitize_key( $handler->get_action() ) ] = array(
+ 'title' => $handler->get_title(),
+ 'nonce' => wp_create_nonce( $handler->get_nonce_name() ),
+ );
+ }
+
+ wp_localize_script(
+ 'wc-gzd-admin-shipments-table',
+ 'wc_gzd_admin_shipments_table_params',
+ array(
+ 'ajax_url' => admin_url( 'admin-ajax.php' ),
+ 'search_orders_nonce' => wp_create_nonce( 'search-orders' ),
+ 'bulk_actions' => $bulk_actions,
+ )
+ );
+ }
+
+ wp_localize_script(
+ 'wc-gzd-admin-shipment-label-backbone',
+ 'wc_gzd_admin_shipment_label_backbone_params',
+ array(
+ 'ajax_url' => admin_url( 'admin-ajax.php' ),
+ 'create_label_form_nonce' => wp_create_nonce( 'create-shipment-label-form' ),
+ 'create_label_nonce' => wp_create_nonce( 'create-shipment-label' ),
+ )
+ );
+
+ // Shipping provider settings
+ if ( 'woocommerce_page_wc-settings' === $screen_id && isset( $_GET['tab'] ) && 'germanized-shipping_provider' === $_GET['tab'] && empty( $_GET['provider'] ) ) {
+ wp_enqueue_script( 'wc-gzd-admin-shipping-providers' );
+
+ wp_localize_script(
+ 'wc-gzd-admin-shipping-providers',
+ 'wc_gzd_admin_shipping_providers_params',
+ array(
+ 'ajax_url' => admin_url( 'admin-ajax.php' ),
+ 'edit_shipping_providers_nonce' => wp_create_nonce( 'edit-shipping-providers' ),
+ 'remove_shipping_provider_nonce' => wp_create_nonce( 'remove-shipping-provider' ),
+ 'i18n_remove_shipping_provider_notice' => _x( 'Do you really want to delete the shipping provider? Some of your existing shipments might be linked to that provider and might need adjustments.', 'shipments', 'woocommerce-germanized' ),
+ )
+ );
+ }
+
+ // Shipping provider method
+ if ( 'woocommerce_page_wc-settings' === $screen_id && isset( $_GET['tab'] ) && 'shipping' === $_GET['tab'] && ( isset( $_GET['zone_id'] ) || isset( $_GET['instance_id'] ) ) ) {
+ wp_enqueue_script( 'wc-gzd-admin-shipping-provider-method' );
+ $providers = array_filter( array_keys( wc_gzd_get_shipping_provider_select() ) );
+
+ wp_localize_script(
+ 'wc-gzd-admin-shipping-provider-method',
+ 'wc_gzd_admin_shipping_provider_method_params',
+ array(
+ 'shipping_providers' => $providers,
+ )
+ );
+ }
+ }
+
+ /**
+ * @return BulkActionHandler[] $handler
+ */
+ public static function get_bulk_action_handlers() {
+ if ( is_null( self::$bulk_handlers ) ) {
+
+ self::$bulk_handlers = array();
+
+ /**
+ * Filter to register new BulkActionHandler for certain Shipment bulk actions.
+ *
+ * @param array $handlers Array containing key => classname.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ $handlers = apply_filters( 'woocommerce_gzd_shipments_table_bulk_action_handlers', array(
+ 'labels' => '\Vendidero\Germanized\Shipments\Admin\BulkLabel'
+ ) );
+
+ foreach( $handlers as $key => $handler ) {
+ self::$bulk_handlers[ $key ] = new $handler();
+ }
+ }
+
+ return self::$bulk_handlers;
+ }
+
+ public static function get_bulk_action_handler( $action ) {
+ $handlers = self::get_bulk_action_handlers();
+
+ return array_key_exists( $action, $handlers ) ? $handlers[ $action ] : false;
+ }
+
+ public static function get_screen_ids() {
+
+ $screen_ids = array(
+ 'woocommerce_page_wc-gzd-shipments',
+ 'woocommerce_page_wc-gzd-return-shipments',
+ );
+
+ foreach ( wc_get_order_types() as $type ) {
+ $screen_ids[] = $type;
+ $screen_ids[] = 'edit-' . $type;
+ }
+
+ return $screen_ids;
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Admin/BulkActionHandler.php b/packages/woocommerce-germanized-shipments/src/Admin/BulkActionHandler.php
new file mode 100644
index 000000000..1790e2d75
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Admin/BulkActionHandler.php
@@ -0,0 +1,163 @@
+notices = array_filter( (array) get_user_meta( get_current_user_id(), $this->get_notice_option_name(), true ) );
+ }
+
+ protected function get_notice_option_name() {
+ $action = sanitize_key( $this->get_action() );
+
+ return "woocommerce_gzd_shipments_{$action}_bulk_notices";
+ }
+
+ abstract public function get_title();
+
+ public function get_nonce_name() {
+ $action = sanitize_key( $this->get_action() );
+
+ return "woocommerce_gzd_shipments_{$action}";
+ }
+
+ public function get_shipment_type() {
+ return $this->type;
+ }
+
+ public function set_shipment_type( $type ) {
+ $this->type = $type;
+ }
+
+ public function get_success_redirect_url() {
+ $page = 'wc-gzd-shipments';
+
+ if ( 'simple' !== $this->get_shipment_type() ) {
+ $page = 'wc-gzd-' . $this->get_shipment_type() . '-shipments';
+ }
+
+ return admin_url( 'admin.php?page=' . $page . '&bulk_action_handling=finished¤t_bulk_action=' . sanitize_key( $this->get_action() ) );
+ }
+
+ public function get_step() {
+ return $this->step;
+ }
+
+ public function set_step( $step ) {
+ $this->step = $step;
+ }
+
+ public function get_notices( $type = 'error' ) {
+ $notices = array_key_exists( $type, $this->notices ) ? $this->notices[ $type ] : array();
+
+ return $notices;
+ }
+
+ public function get_success_message() {
+ return _x( 'Successfully processed shipments.', 'shipments', 'woocommerce-germanized' );
+ }
+
+ public function admin_handled() {
+
+ }
+
+ public function admin_after_error() {
+
+ }
+
+ public function add_notice( $notice, $type = 'error' ) {
+ if ( ! isset( $this->notices[ $type ] ) ) {
+ $this->notices[ $type ] = array();
+ }
+
+ $this->notices[ $type ][] = $notice;
+ }
+
+ public function update_notices() {
+ update_user_meta( get_current_user_id(), $this->get_notice_option_name(), $this->notices );
+ }
+
+ public function reset( $is_new = false ) {
+ delete_user_meta( get_current_user_id(), $this->get_notice_option_name() );
+ }
+
+ abstract public function get_action();
+
+ public function get_max_step() {
+ return (int) ceil( sizeof( $this->get_ids() ) / $this->get_limit() );
+ }
+
+ abstract public function get_limit();
+
+ public function get_total() {
+ return sizeof( $this->get_ids() );
+ }
+
+ abstract public function handle();
+
+ public function set_ids( $ids ) {
+ $this->ids = $ids;
+ }
+
+ public function get_ids() {
+ return $this->ids;
+ }
+
+ public function get_current_ids() {
+ return array_slice( $this->get_ids(), ( $this->get_step() - 1 ) * $this->get_limit(), $this->get_limit() );
+ }
+
+ /**
+ * Get count of records exported.
+ *
+ * @since 3.0.6
+ * @return int
+ */
+ public function get_total_processed() {
+ return ( $this->get_step() * $this->get_limit() );
+ }
+
+ /**
+ * Get total % complete.
+ *
+ * @since 3.0.6
+ * @return int
+ */
+ public function get_percent_complete() {
+ return floor( ( $this->get_total_processed() / $this->get_total() ) * 100 );
+ }
+
+ public function is_last_step() {
+ $current_step = $this->get_step();
+ $max_step = $this->get_max_step();
+
+ if ( $max_step === $current_step ) {
+ return true;
+ }
+
+ return false;
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Admin/BulkLabel.php b/packages/woocommerce-germanized-shipments/src/Admin/BulkLabel.php
new file mode 100644
index 000000000..3654eefce
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Admin/BulkLabel.php
@@ -0,0 +1,194 @@
+get_file_option_name(), true );
+
+ if ( $file ) {
+ $uploads = Package::get_upload_dir();
+ $path = trailingslashit( $uploads['basedir'] ) . $file;
+
+ return $path;
+ }
+
+ return '';
+ }
+
+ protected function update_file( $path ) {
+ update_user_meta( get_current_user_id(), $this->get_file_option_name(), $path );
+ }
+
+ protected function get_file_option_name() {
+ $action = sanitize_key( $this->get_action() );
+
+ return "woocommerce_gzd_shipments_{$action}_bulk_path";
+ }
+
+ public function get_filename() {
+ if ( $file = $this->get_file() ) {
+ return basename( $file );
+ }
+
+ return '';
+ }
+
+ public function reset( $is_new = false ) {
+ parent::reset( $is_new );
+
+ if ( $is_new ) {
+ delete_user_meta( get_current_user_id(), $this->get_file_option_name() );
+ delete_user_meta( get_current_user_id(), $this->get_files_option_name() );
+ }
+ }
+
+ protected function get_download_button() {
+ $download_button = '';
+
+ if ( ( $path = $this->get_file() ) && file_exists( $path ) ) {
+
+ $download_url = add_query_arg( array(
+ 'action' => 'wc-gzd-download-export-shipment-label',
+ 'force' => 'no'
+ ), wp_nonce_url( admin_url(), 'download-export-shipment-label' ) );
+
+ $download_button = '' . _x( 'Download labels', 'shipments', 'woocommerce-germanized' ) . '';
+ }
+
+ return $download_button;
+ }
+
+ public function get_success_message() {
+ $download_button = $this->get_download_button();
+
+ if ( empty( $download_button ) ) {
+ return sprintf( _x( 'The chosen shipments were not suitable for automatic label creation. Please check the shipping provider option of the corresponding shipments.', 'shipments', 'woocommerce-germanized' ), $download_button );
+ } else {
+ return sprintf( _x( 'Successfully generated labels. %s', 'shipments', 'woocommerce-germanized' ), $download_button );
+ }
+ }
+
+ public function admin_after_error() {
+ $download_button = $this->get_download_button();
+
+ if ( ! empty( $download_button ) ) {
+ echo '+ + output_notice(); + $_SERVER['REQUEST_URI'] = remove_query_arg( array( 'updated', 'changed', 'deleted', 'trashed', 'untrashed' ), $_SERVER['REQUEST_URI'] ); + ?> + + views(); ?> + + + + +
+
' . sprintf( _x( 'Labels partially generated. %s', 'shipments', 'woocommerce-germanized' ), $download_button ) . '
' . esc_html_x( 'Shipping Provider', 'shipments', 'woocommerce-germanized' ) . '
' . + '' . esc_html_x( 'You may find all the available shipping providers as a list here. Click on the link to edit the provider-specific settings.', 'shipments', 'woocommerce-germanized' ) . '
', + 'position' => array( + 'edge' => 'left', + 'align' => 'left', + ), + ), + ), + 'activate' => array( + 'target' => '.wc-gzd-setting-tab-rows tr:first-child .wc-gzd-shipping-provider-activated .woocommerce-gzd-input-toggle-trigger', + 'next' => 'new', + 'next_url' => '', + 'next_trigger' => array(), + 'options' => array( + 'content' => '' . esc_html_x( 'Activate', 'shipments', 'woocommerce-germanized' ) . '
' . + '' . esc_html_x( 'Activate or deactivate a shipping provider by toggling this button.', 'shipments', 'woocommerce-germanized' ) . '
', + 'position' => array( + 'edge' => 'right', + 'align' => 'left', + ), + ), + ), + 'new' => array( + 'target' => 'ul.wc-gzd-settings-breadcrumb .breadcrumb-item-active a.page-title-action:first', + 'next' => '', + 'next_url' => self::get_next_pointers_link(), + 'next_trigger' => array(), + 'options' => array( + 'content' => '' . esc_html_x( 'Add new', 'shipments', 'woocommerce-germanized' ) . '
' . + '' . esc_html_x( 'You may want to manually add a new shipping provider in case an automatic integration does not exist.', 'shipments', 'woocommerce-germanized' ) . '
', + 'position' => array( + 'edge' => 'top', + 'align' => 'top', + ), + ), + ), + ), + ); + } + + return $pointers; + } + + public static function get_description() { + if ( $provider = self::get_current_provider() ) { + return $provider->get_description( 'edit' ); + } + + return ''; + } + + public static function get_breadcrumb( $current_section = '' ) { + $provider = self::get_current_provider(); + + $breadcrumb[] = array( + 'class' => 'tab', + 'href' => $provider ? admin_url( 'admin.php?page=wc-settings&tab=germanized-shipping_provider' ) : '', + 'title' => ! $provider ? self::get_breadcrumb_label( _x( 'Shipping Provider', 'shipments', 'woocommerce-germanized' ) ) : _x( 'Shipping Provider', 'shipments', 'woocommerce-germanized' ) + ); + + if ( $provider = self::get_current_provider() ) { + $breadcrumb[] = array( + 'class' => 'section', + 'href' => ! empty( $current_section ) ? $provider->get_edit_link() : '', + 'title' => $provider->get_id() <= 0 ? self::get_breadcrumb_label( _x( 'New', 'shipments-shipping-provider', 'woocommerce-germanized' ), $current_section ) : self::get_breadcrumb_label( $provider->get_title(), $current_section ), + ); + } + + if ( ! empty( $current_section ) ) { + $breadcrumb[] = array( + 'class' => 'section', + 'href' => '', + 'title' => self::get_section_title( $current_section ), + ); + } + + return $breadcrumb; + } + + protected static function get_section_title( $section = '' ) { + $sections = self::get_sections(); + $section_label = isset( $sections[ $section ] ) ? $sections[ $section ] : ''; + + return $section_label; + } + + protected static function get_breadcrumb_label( $label, $current_section = '' ) { + $help_link = self::get_help_link(); + $provider = self::get_current_provider(); + + if ( $provider && empty( $current_section ) ) { + if ( ! empty( $help_link ) ) { + $label = $label . '' . _x( 'Learn more', 'shipments', 'woocommerce-germanized' ) . ''; + } + + if ( ! empty( $provider->get_signup_link() ) ) { + $label = $label . '' . _x( 'Not yet a customer?', 'shipments', 'woocommerce-germanized' ) . ''; + } + } elseif ( ! $provider ) { + $label = $label . '' . _x( 'Add provider', 'shipments', 'woocommerce-germanized' ) . ''; + + if ( ! empty( $help_link ) ) { + $label = $label . '' . _x( 'Learn more', 'shipments', 'woocommerce-germanized' ) . ''; + } + } + + return $label; + } + + public static function save( $section = '' ) { + if ( $provider = self::get_current_provider() ) { + $is_new = $provider->get_id() <= 0 ? true : false; + + $provider->update_settings( $section, null, false ); + + if ( $provider->get_id() <= 0 ) { + if ( empty( $provider->get_tracking_desc_placeholder( 'edit' ) ) ) { + $provider->set_tracking_desc_placeholder( $provider->get_default_tracking_desc_placeholder() ); + } + + if ( empty( $provider->get_tracking_url_placeholder( 'edit' ) ) ) { + $provider->set_tracking_url_placeholder( $provider->get_default_tracking_url_placeholder() ); + } + } + + $provider->save(); + + if ( $is_new ) { + $url = admin_url( 'admin.php?page=wc-settings&tab=germanized-shipping_provider&provider=' . $provider->get_name() ); + wp_safe_redirect( $url ); + } + } + } + + public static function get_settings( $current_section = '' ) { + if ( $provider = self::get_current_provider() ) { + return $provider->get_settings( $current_section ); + } else { + return array(); + } + } + + public static function output_providers() { + global $hide_save_button; + + $hide_save_button = true; + self::provider_screen(); + } + + protected static function provider_screen() { + $helper = Helper::instance(); + $providers = $helper->get_shipping_providers(); + + include_once Package::get_path() . '/includes/admin/views/html-settings-provider-list.php'; + } + + public static function get_sections() { + if ( $provider = self::get_current_provider() ) { + return $provider->get_setting_sections(); + } else { + return array(); + } + } +} diff --git a/packages/woocommerce-germanized-shipments/src/Admin/ReturnTable.php b/packages/woocommerce-germanized-shipments/src/Admin/ReturnTable.php new file mode 100644 index 000000000..e8f179bbb --- /dev/null +++ b/packages/woocommerce-germanized-shipments/src/Admin/ReturnTable.php @@ -0,0 +1,100 @@ +'; + $columns['title'] = _x( 'Title', 'shipments', 'woocommerce-germanized' ); + $columns['date'] = _x( 'Date', 'shipments', 'woocommerce-germanized' ); + $columns['status'] = _x( 'Status', 'shipments', 'woocommerce-germanized' ); + $columns['items'] = _x( 'Items', 'shipments', 'woocommerce-germanized' ); + $columns['sender'] = _x( 'Sender', 'shipments', 'woocommerce-germanized' ); + $columns['weight'] = _x( 'Weight', 'shipments', 'woocommerce-germanized' ); + $columns['dimensions'] = _x( 'Dimensions', 'shipments', 'woocommerce-germanized' ); + $columns['order'] = _x( 'Order', 'shipments', 'woocommerce-germanized' ); + $columns['actions'] = _x( 'Actions', 'shipments', 'woocommerce-germanized' ); + + return $columns; + } + + /** + * @param ReturnShipment $shipment + * @param $actions + * + * @return mixed + */ + protected function get_custom_actions( $shipment, $actions ) { + + if ( isset( $actions['shipped'] ) ) { + unset( $actions['shipped'] ); + } + + if ( ! $shipment->has_status( 'delivered' ) && ! $shipment->has_status( 'requested' ) ) { + $actions['received'] = array( + 'url' => wp_nonce_url( admin_url( 'admin-ajax.php?action=woocommerce_gzd_update_shipment_status&status=delivered&shipment_id=' . $shipment->get_id() ), 'update-shipment-status' ), + 'name' => _x( 'Delivered', 'shipments', 'woocommerce-germanized' ), + 'action' => 'delivered', + ); + } + + if ( $shipment->has_status( 'processing' ) ) { + $actions['email_notification'] = array( + 'url' => wp_nonce_url( admin_url( 'admin-ajax.php?action=woocommerce_gzd_send_return_shipment_notification_email&shipment_id=' . $shipment->get_id() ), 'send-return-shipment-notification' ), + 'name' => _x( 'Send notification to customer', 'shipments', 'woocommerce-germanized' ), + 'action' => 'send-return-notification email', + ); + } + + if ( $shipment->is_customer_requested() && $shipment->has_status( 'requested' ) ) { + $actions['confirm'] = array( + 'url' => wp_nonce_url( admin_url( 'admin-ajax.php?action=woocommerce_gzd_confirm_return_request&shipment_id=' . $shipment->get_id() ), 'confirm-return-request' ), + 'name' => _x( 'Confirm return request', 'shipments', 'woocommerce-germanized' ), + 'action' => 'confirm', + ); + } + + return $actions; + } + + public function get_main_page() { + return 'admin.php?page=wc-gzd-return-shipments'; + } + + protected function get_custom_bulk_actions( $actions ) { + $actions['confirm_requests'] = _x( 'Confirm open return requests', 'shipments', 'woocommerce-germanized' ); + + return $actions; + } + + /** + * Handles the post author column output. + * + * @since 4.3.0 + * + * @param ReturnShipment $shipment The current shipment object. + */ + public function column_sender( $shipment ) { + $address = $shipment->get_formatted_sender_address(); + + if ( $address ) { + echo '' . esc_html( preg_replace( '#' . esc_html_x( 'Manage shipments', 'shipments', 'woocommerce-germanized' ) . '
' . + '' . esc_html_x( 'To view all your existing shipments in a list you might follow this link or click on the shipments link within the WooCommerce sub-menu.', 'shipments', 'woocommerce-germanized' ) . '
', + 'position' => array( + 'edge' => 'left', + 'align' => 'left', + ), + ), + ), + 'default' => array( + 'target' => '#woocommerce_gzd_shipments_notify_enable-toggle', + 'next' => 'auto', + 'next_url' => '', + 'next_trigger' => array(), + 'options' => array( + 'content' => '' . esc_html_x( 'E-Mail Notification', 'shipments', 'woocommerce-germanized' ) . '
' . + '' . esc_html_x( 'By enabling this option customers receive an email notification as soon as a shipment is marked as shipped.', 'shipments', 'woocommerce-germanized' ) . '
', + 'position' => array( + 'edge' => 'left', + 'align' => 'left', + ), + ), + ), + 'auto' => array( + 'target' => '#woocommerce_gzd_shipments_auto_enable-toggle', + 'next' => 'returns', + 'next_url' => '', + 'next_trigger' => array(), + 'options' => array( + 'content' => '' . esc_html_x( 'Automation', 'shipments', 'woocommerce-germanized' ) . '
' . + '' . esc_html_x( 'Decide whether you want to automatically create shipments to orders reaching a specific status. You can always adjust your shipments by manually editing the shipment within the edit order screen.', 'shipments', 'woocommerce-germanized' ) . '
', + 'position' => array( + 'edge' => 'left', + 'align' => 'left', + ), + ), + ), + 'returns' => array( + 'target' => '#shipments_return_options-description', + 'next' => '', + 'next_url' => $next_url, + 'next_trigger' => array(), + 'options' => array( + 'content' => '' . esc_html_x( 'Returns', 'shipments', 'woocommerce-germanized' ) . '
' . + '' . sprintf( _x( 'Germanized can help you to minimize manual work while handling customer returns. Learn more about returns within our %s.', 'shipments', 'woocommerce-germanized' ), '' . _x( 'documentation', 'shipments', 'woocommerce-germanized' ) .'' ) . '
', + 'position' => array( + 'edge' => 'top', + 'align' => 'top', + ), + ), + ), + ), + ); + } + + return $pointers; + } + + protected static function get_general_settings() { + + $statuses = array_diff_key( wc_gzd_get_shipment_statuses(), array_flip( array( 'gzd-requested' ) ) ); + + $settings = array( + array( 'title' => '', 'type' => 'title', 'id' => 'shipments_options' ), + + array( + 'title' => _x( 'Notify', 'shipments', 'woocommerce-germanized' ), + 'desc' => _x( 'Notify customers about new shipments.', 'shipments', 'woocommerce-germanized' ) . '' . sprintf( _x( 'Notify customers by email as soon as a shipment is marked as shipped. %s the notification email.', 'shipments', 'woocommerce-germanized' ), '' . _x( 'Manage', 'shipments notification', 'woocommerce-germanized' ) .'' ) . '
',
+ 'id' => 'woocommerce_gzd_shipments_notify_enable',
+ 'default' => 'yes',
+ 'type' => 'gzd_toggle',
+ ),
+
+ array(
+ 'title' => _x( 'Default provider', 'shipments', 'woocommerce-germanized' ),
+ 'desc_tip' => _x( 'Select a default shipping provider which will be selected by default in case no provider could be determined automatically.', 'shipments', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_gzd_shipments_default_shipping_provider',
+ 'default' => '',
+ 'type' => 'select',
+ 'options' => wc_gzd_get_shipping_provider_select(),
+ 'class' => 'wc-enhanced-select',
+ ),
+
+ array( 'type' => 'sectionend', 'id' => 'shipments_options' ),
+
+ array( 'title' => _x( 'Automation', 'shipments', 'woocommerce-germanized' ), 'type' => 'title', 'id' => 'shipments_auto_options' ),
+
+ array(
+ 'title' => _x( 'Enable', 'shipments', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Automatically create shipments for orders.', 'shipments', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_gzd_shipments_auto_enable',
+ 'default' => 'yes',
+ 'type' => 'gzd_toggle',
+ ),
+
+ array(
+ 'title' => _x( 'Order statuses', 'shipments', 'woocommerce-germanized' ),
+ 'desc_tip' => _x( 'Create shipments as soon as the order reaches one of the following status(es).', 'shipments', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_gzd_shipments_auto_statuses',
+ 'default' => array( 'wc-processing', 'wc-on-hold' ),
+ 'class' => 'wc-enhanced-select-nostd',
+ 'options' => wc_get_order_statuses(),
+ 'type' => 'multiselect',
+ 'custom_attributes' => array(
+ 'data-show_if_woocommerce_gzd_shipments_auto_enable' => '',
+ 'data-placeholder' => _x( 'On new order creation', 'shipments', 'woocommerce-germanized' )
+ ),
+ ),
+
+ array(
+ 'title' => _x( 'Default status', 'shipments', 'woocommerce-germanized' ),
+ 'desc_tip' => _x( 'Choose a default status for the automatically created shipment.', 'shipments', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_gzd_shipments_auto_default_status',
+ 'default' => 'gzd-processing',
+ 'class' => 'wc-enhanced-select',
+ 'options' => $statuses,
+ 'type' => 'select',
+ 'custom_attributes' => array(
+ 'data-show_if_woocommerce_gzd_shipments_auto_enable' => '',
+ ),
+ ),
+
+ array(
+ 'title' => _x( 'Update status', 'shipments', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Mark order as completed after order is fully shipped.', 'shipments', 'woocommerce-germanized' ) . '' . _x( 'This option will automatically update the order status to completed as soon as all required shipments have been marked as shipped.', 'shipments', 'woocommerce-germanized' ) . '
',
+ 'id' => 'woocommerce_gzd_shipments_auto_order_shipped_completed_enable',
+ 'default' => 'yes',
+ 'type' => 'gzd_toggle',
+ ),
+
+ array(
+ 'title' => _x( 'Mark as shipped', 'shipments', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Mark shipments as shipped after order completion.', 'shipments', 'woocommerce-germanized' ) . '' . _x( 'This option will automatically update contained shipments to shipped (if possible, e.g. not yet delivered) as soon as the order was marked as completed.', 'shipments', 'woocommerce-germanized' ) . '
',
+ 'id' => 'woocommerce_gzd_shipments_auto_order_completed_shipped_enable',
+ 'default' => 'no',
+ 'type' => 'gzd_toggle',
+ ),
+
+ array( 'type' => 'sectionend', 'id' => 'shipments_auto_options' ),
+
+ array( 'title' => _x( 'Returns', 'shipments', 'woocommerce-germanized' ), 'type' => 'title', 'id' => 'shipments_return_options', 'desc' => sprintf( _x( 'Returns can be added manually by the shop manager or by the customer. Decide what suits you best by turning customer-added returns on or off in your %s.', 'shipments', 'woocommerce-germanized' ), '' . _x( 'shipping provider settings', 'shipments', 'woocommerce-germanized' ) . '' ) ),
+
+ array(
+ 'type' => 'shipment_return_reasons',
+ ),
+
+ array(
+ 'title' => _x( 'Days to return', 'shipments', 'woocommerce-germanized' ),
+ 'desc' => '' . sprintf( _x( 'In case one of your %s supports returns added by customers you might want to limit the number of days a customer is allowed to add returns to an order. The days are counted starting with the date the order was shipped, completed or created (by checking for existance in this order).', 'shipments', 'woocommerce-germanized' ), '' . _x( 'shipping providers', 'shipments', 'woocommerce-germanized' ) . '' ) . '
',
+ 'css' => 'max-width: 60px;',
+ 'type' => 'number',
+ 'id' => 'woocommerce_gzd_shipments_customer_return_open_days',
+ 'default' => '14',
+ ),
+
+ array( 'type' => 'sectionend', 'id' => 'shipments_return_options' ),
+
+ array( 'title' => _x( 'Customer Account', 'shipments', 'woocommerce-germanized' ), 'type' => 'title', 'id' => 'shipments_customer_options' ),
+
+ array(
+ 'title' => _x( 'List', 'shipments', 'woocommerce-germanized' ),
+ 'desc' => _x( 'List shipments on customer account order screen.', 'shipments', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_gzd_shipments_customer_account_enable',
+ 'default' => 'yes',
+ 'type' => 'gzd_toggle',
+ ),
+
+ array( 'type' => 'sectionend', 'id' => 'shipments_customer_options' ),
+ );
+
+ return $settings;
+ }
+
+ protected static function get_address_settings() {
+ $settings = array(
+ array( 'title' => _x( 'Shipper Address', 'shipments', 'woocommerce-germanized' ), 'type' => 'title', 'id' => 'shipments_shipper_address' ),
+
+ array(
+ 'title' => _x( 'First Name', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'id' => 'woocommerce_gzd_shipments_shipper_address_first_name',
+ 'default' => '',
+ ),
+
+ array(
+ 'title' => _x( 'Last Name', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'id' => 'woocommerce_gzd_shipments_shipper_address_last_name',
+ 'default' => '',
+ ),
+
+ array(
+ 'title' => _x( 'Company', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'id' => 'woocommerce_gzd_shipments_shipper_address_company',
+ 'default' => get_bloginfo( 'name' ),
+ ),
+
+ array(
+ 'title' => _x( 'Address 1', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'id' => 'woocommerce_gzd_shipments_shipper_address_address_1',
+ 'default' => get_option( 'woocommerce_store_address' ),
+ ),
+
+ array(
+ 'title' => _x( 'Address 2', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'id' => 'woocommerce_gzd_shipments_shipper_address_address_2',
+ 'default' => get_option( 'woocommerce_store_address_2' ),
+ ),
+
+ array(
+ 'title' => _x( 'City', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'id' => 'woocommerce_gzd_shipments_shipper_address_city',
+ 'default' => get_option( 'woocommerce_store_city' ),
+ ),
+
+ array(
+ 'title' => _x( 'Country / State', 'shipments', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_gzd_shipments_shipper_address_country',
+ 'default' => get_option( 'woocommerce_default_country' ),
+ 'type' => 'single_select_country',
+ 'desc_tip' => true,
+ ),
+
+ array(
+ 'title' => _x( 'Postcode', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'id' => 'woocommerce_gzd_shipments_shipper_address_postcode',
+ 'default' => get_option( 'woocommerce_store_postcode' ),
+ ),
+
+ array(
+ 'title' => _x( 'Phone', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'id' => 'woocommerce_gzd_shipments_shipper_address_phone',
+ 'default' => '',
+ ),
+
+ array(
+ 'title' => _x( 'Email', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'id' => 'woocommerce_gzd_shipments_shipper_address_email',
+ 'default' => get_option( 'woocommerce_email_from_address' ),
+ ),
+
+ array( 'type' => 'sectionend', 'id' => 'shipments_shipper_address' ),
+
+ array( 'title' => _x( 'Return Address', 'shipments', 'woocommerce-germanized' ), 'type' => 'title', 'id' => 'shipments_return_address' ),
+
+ array(
+ 'title' => _x( 'First Name', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'id' => 'woocommerce_gzd_shipments_return_address_first_name',
+ 'default' => '',
+ 'placeholder' => get_option( 'woocommerce_gzd_shipments_shipper_address_first_name' )
+ ),
+
+ array(
+ 'title' => _x( 'Last Name', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'id' => 'woocommerce_gzd_shipments_return_address_last_name',
+ 'default' => '',
+ 'placeholder' => get_option( 'woocommerce_gzd_shipments_shipper_address_last_name' )
+ ),
+
+ array(
+ 'title' => _x( 'Company', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'id' => 'woocommerce_gzd_shipments_return_address_company',
+ 'default' => '',
+ 'placeholder' => get_option( 'woocommerce_gzd_shipments_shipper_address_company' )
+ ),
+
+ array(
+ 'title' => _x( 'Address 1', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'id' => 'woocommerce_gzd_shipments_return_address_address_1',
+ 'default' => '',
+ 'placeholder' => get_option( 'woocommerce_gzd_shipments_shipper_address_address_1' )
+ ),
+
+ array(
+ 'title' => _x( 'Address 2', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'id' => 'woocommerce_gzd_shipments_return_address_address_2',
+ 'default' => '',
+ 'placeholder' => get_option( 'woocommerce_gzd_shipments_shipper_address_address_2' )
+ ),
+
+ array(
+ 'title' => _x( 'City', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'id' => 'woocommerce_gzd_shipments_return_address_city',
+ 'default' => '',
+ 'placeholder' => get_option( 'woocommerce_gzd_shipments_shipper_address_city' )
+ ),
+
+ array(
+ 'title' => _x( 'Country / State', 'shipments', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_gzd_shipments_return_address_country',
+ 'default' => '',
+ 'type' => 'single_select_country',
+ 'placeholder' => get_option( 'woocommerce_gzd_shipments_shipper_address_country' ),
+ 'desc_tip' => true,
+ ),
+
+ array(
+ 'title' => _x( 'Postcode', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'id' => 'woocommerce_gzd_shipments_return_address_postcode',
+ 'default' => '',
+ 'placeholder' => get_option( 'woocommerce_gzd_shipments_shipper_address_postcode' )
+ ),
+
+ array(
+ 'title' => _x( 'Phone', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'id' => 'woocommerce_gzd_shipments_shipper_address_phone',
+ 'default' => '',
+ 'placeholder' => get_option( 'woocommerce_gzd_shipments_shipper_address_phone' )
+ ),
+
+ array(
+ 'title' => _x( 'Email', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'id' => 'woocommerce_gzd_shipments_return_address_email',
+ 'default' => '',
+ 'placeholder' => get_option( 'woocommerce_gzd_shipments_shipper_address_email' )
+ ),
+
+ array( 'type' => 'sectionend', 'id' => 'shipments_return_address' ),
+ );
+
+ return $settings;
+ }
+
+ protected static function get_packaging_settings() {
+ $settings = array(
+ array( 'title' => '', 'type' => 'title', 'id' => 'packaging_options' ),
+
+ array(
+ 'type' => 'packaging_list',
+ ),
+
+ array(
+ 'title' => _x( 'Default packaging', 'shipments', 'woocommerce-germanized' ),
+ 'desc_tip' => _x( 'Choose a packaging which serves as fallback or default in case no suitable packaging could be matched for a certain shipment.', 'shipments', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_gzd_shipments_default_packaging',
+ 'default' => '',
+ 'type' => 'select',
+ 'options' => wc_gzd_get_packaging_select(),
+ 'class' => 'wc-enhanced-select',
+ ),
+
+ array( 'type' => 'sectionend', 'id' => 'packaging_options' ),
+ );
+
+ return $settings;
+ }
+
+ public static function get_settings( $current_section = '' ) {
+ $settings = array();
+
+ if ( '' === $current_section ) {
+ $settings = self::get_general_settings();
+ } elseif ( 'packaging' === $current_section ) {
+ $settings = self::get_packaging_settings();
+ } elseif ( 'address' === $current_section ) {
+ $settings = self::get_address_settings();
+ }
+
+ return $settings;
+ }
+
+ public static function get_additional_breadcrumb_items( $breadcrumb ) {
+ return $breadcrumb;
+ }
+
+ public static function get_sections() {
+ return array(
+ '' => _x( 'General', 'shipments', 'woocommerce-germanized' ),
+ 'packaging' => _x( 'Packaging', 'shipments', 'woocommerce-germanized' ),
+ 'address' => _x( 'Addresses', 'shipments', 'woocommerce-germanized' ),
+ );
+ }
+
+ public static function get_sanitized_settings( $settings, $data = null ) {
+ if ( is_null( $data ) ) {
+ $data = $_POST; // WPCS: input var okay, CSRF ok.
+ }
+
+ if ( empty( $data ) ) {
+ return false;
+ }
+
+ $settings_to_save = array();
+
+ // Loop options and get values to save.
+ foreach ( $settings as $option ) {
+
+ if ( ! isset( $option['id'] ) || empty( $option['id'] ) || ! isset( $option['type'] ) || in_array( $option['type'], array( 'title', 'sectionend' ) ) || ( isset( $option['is_option'] ) && false === $option['is_option'] ) ) {
+ continue;
+ }
+
+ $option_key = $option['id'];
+ $raw_value = isset( $data[ $option_key ] ) ? wp_unslash( $data[ $option_key ] ) : null;
+
+ // Format the value based on option type.
+ switch ( $option['type'] ) {
+ case 'checkbox':
+ $value = '1' === $raw_value || 'yes' === $raw_value ? 'yes' : 'no';
+ break;
+ case 'textarea':
+ $value = wp_kses_post( trim( $raw_value ) );
+ break;
+ case 'password':
+ $value = is_null( $raw_value ) ? '' : addslashes( $raw_value );
+ $value = trim( $value );
+
+ if ( class_exists( 'WC_GZD_Secret_Box_Helper' ) ) {
+ $encrypted = \WC_GZD_Secret_Box_Helper::encrypt( $value );
+
+ if ( ! is_wp_error( $encrypted ) ) {
+ $value = $encrypted;
+ }
+ }
+ break;
+ case 'multiselect':
+ case 'multi_select_countries':
+ $value = array_filter( array_map( 'wc_clean', (array) $raw_value ) );
+ break;
+ case 'image_width':
+ $value = array();
+ if ( isset( $raw_value['width'] ) ) {
+ $value['width'] = wc_clean( $raw_value['width'] );
+ $value['height'] = wc_clean( $raw_value['height'] );
+ $value['crop'] = isset( $raw_value['crop'] ) ? 1 : 0;
+ } else {
+ $value['width'] = $option['default']['width'];
+ $value['height'] = $option['default']['height'];
+ $value['crop'] = $option['default']['crop'];
+ }
+ break;
+ case 'select':
+ $allowed_values = empty( $option['options'] ) ? array() : array_map( 'strval', array_keys( $option['options'] ) );
+ if ( empty( $option['default'] ) && empty( $allowed_values ) ) {
+ $value = null;
+ break;
+ }
+ $default = ( empty( $option['default'] ) ? $allowed_values[0] : $option['default'] );
+ $value = in_array( $raw_value, $allowed_values, true ) ? $raw_value : $default;
+ break;
+ case 'relative_date_selector':
+ $value = wc_parse_relative_date_option( $raw_value );
+ break;
+ default:
+ $value = wc_clean( $raw_value );
+ break;
+ }
+
+ /**
+ * Sanitize the value of an option.
+ *
+ * @since 2.4.0
+ */
+ $value = apply_filters( 'woocommerce_admin_settings_sanitize_option', $value, $option, $raw_value );
+
+ $settings_to_save[ $option_key ] = $value;
+ }
+
+ return $settings_to_save;
+ }
+
+ public static function render_label_fields( $settings, $shipment, $echo = false ) {
+ ob_start();
+ foreach( $settings as $setting ) {
+ $setting = wp_parse_args( $setting, array( 'id' => '', 'type' => 'text' ) );
+
+ if ( has_action( "woocommerce_gzd_shipment_label_admin_field_{$setting['id']}" ) ) {
+ do_action( "woocommerce_gzd_shipment_label_admin_field_{$setting['id']}", $setting, $shipment );
+ } elseif ( 'select' === $setting['type'] ) {
+ woocommerce_wp_select( $setting );
+ } elseif( 'checkbox' === $setting['type'] ) {
+ woocommerce_wp_checkbox( $setting );
+ } elseif( 'textarea' === $setting['type'] ) {
+ woocommerce_wp_textarea_input( $setting );
+ } elseif( 'text' === $setting['type'] ) {
+ woocommerce_wp_text_input( $setting );
+ } elseif( 'services_start' === $setting['type'] ) {
+ $hide_default = isset( $setting['hide_default'] ) ? wc_string_to_bool( $setting['hide_default'] ) : false;
+ $missing_div_closes++;
+ ?>
+
+
+ 0 ) {
+ echo '
';
+ $missing_div_closes--;
+ }
+
+ $missing_div_closes++;
+ ?>
+
+ 0 ) {
+ echo '
';
+ $missing_div_closes--;
+ }
+
+ $missing_div_closes++;
+ ?>
+
+
+
+ 0 ) {
+ while( $missing_div_closes > 0 ) {
+ $missing_div_closes--;
+ echo '';
+ }
+ }
+
+ $html = ob_get_clean();
+
+ if ( ! $echo ) {
+ return $html;
+ } else {
+ echo $html;
+ }
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Admin/Table.php b/packages/woocommerce-germanized-shipments/src/Admin/Table.php
new file mode 100644
index 000000000..8db059761
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Admin/Table.php
@@ -0,0 +1,1161 @@
+ 'simple',
+ ) );
+
+ $this->shipment_type = $args['type'];
+
+ parent::__construct(
+ array(
+ 'plural' => 'shipments',
+ 'screen' => isset( $args['screen'] ) ? $args['screen'] : null,
+ )
+ );
+ }
+
+ public function set_default_hidden_columns( $columns, $screen ) {
+ if ( $this->screen->id === $screen->id ) {
+ $columns = array_merge( $columns, $this->get_default_hidden_columns() );
+ }
+
+ return $columns;
+ }
+
+ protected function get_default_hidden_columns() {
+ return array(
+ 'weight',
+ 'dimensions',
+ 'packaging'
+ );
+ }
+
+ public function enable_query_removing( $args ) {
+ $args = array_merge( $args, array(
+ 'changed',
+ 'bulk_action'
+ ) );
+
+ return $args;
+ }
+
+ /**
+ * Handle bulk actions.
+ *
+ * @param string $redirect_to URL to redirect to.
+ * @param string $action Action name.
+ * @param array $ids List of ids.
+ * @return string
+ */
+ public function handle_bulk_actions( $action, $ids, $redirect_to ) {
+ $ids = array_reverse( array_map( 'absint', $ids ) );
+ $changed = 0;
+
+ if ( false !== strpos( $action, 'mark_' ) ) {
+
+ $shipment_statuses = wc_gzd_get_shipment_statuses();
+ $new_status = substr( $action, 5 ); // Get the status name from action.
+
+ // Sanity check: bail out if this is actually not a status, or is not a registered status.
+ if ( isset( $shipment_statuses[ 'gzd-' . $new_status ] ) ) {
+
+ foreach ( $ids as $id ) {
+
+ if ( $shipment = wc_gzd_get_shipment( $id ) ) {
+ $shipment->update_status( $new_status, true );
+
+ /**
+ * Action that fires after a shipment bulk status update has been processed.
+ *
+ * @param integer $shipment_id The shipment id.
+ * @param string $new_status The new shipment status.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( 'woocommerce_gzd_shipment_edit_status', $id, $new_status );
+ $changed++;
+ }
+ }
+ }
+ } elseif( 'delete' === $action ) {
+ foreach ( $ids as $id ) {
+ if ( $shipment = wc_gzd_get_shipment( $id ) ) {
+ $shipment->delete( true );
+ $changed++;
+ }
+ }
+ } elseif( 'confirm_requests' === $action ) {
+ foreach ( $ids as $id ) {
+ if ( $shipment = wc_gzd_get_shipment( $id ) ) {
+ if ( 'return' === $shipment->get_type() ) {
+ if ( $shipment->is_customer_requested() && $shipment->has_status( 'requested' ) ) {
+ if ( $shipment->confirm_customer_request() ) {
+ $changed++;
+ }
+ }
+ }
+ }
+ }
+ }
+
+ /**
+ * Filter to decide whether a Shipment has changed during bulk action or not.
+ *
+ * @param boolean $changed Whether the Shipment has changed or not.
+ * @param string $action The bulk action
+ * @param string $redirect_to The redirect URL.
+ * @param Table $table The table instance.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ $changed = apply_filters( 'woocommerce_gzd_shipments_bulk_action', $changed, $action, $ids, $redirect_to, $this );
+
+ if ( $changed ) {
+ $redirect_to = add_query_arg(
+ array(
+ 'changed' => $changed,
+ 'ids' => join( ',', $ids ),
+ 'bulk_action' => $action
+ ),
+ $redirect_to
+ );
+ }
+
+ return esc_url_raw( $redirect_to );
+ }
+
+ public function output_notice() {
+
+ if ( ! empty( $this->notice ) ) {
+ $type = isset( $this->notice['type'] ) ? $this->notice['type'] : 'success';
+
+ echo '' . wpautop( $this->notice['message'] ) . '
';
+ }
+
+ $this->notice = array();
+ }
+
+ /**
+ * Show confirmation message that order status changed for number of orders.
+ */
+ public function set_bulk_notice() {
+
+ $number = isset( $_REQUEST['changed'] ) ? absint( $_REQUEST['changed'] ) : 0; // WPCS: input var ok, CSRF ok.
+ $bulk_action = isset( $_REQUEST['bulk_action'] ) ? wc_clean( wp_unslash( $_REQUEST['bulk_action'] ) ) : ''; // WPCS: input var ok, CSRF ok.
+
+ if ( 'delete' === $bulk_action ) {
+
+ $this->set_notice( sprintf( _nx( '%d shipment deleted.', '%d shipments deleted.', $number, 'shipments', 'woocommerce-germanized' ), number_format_i18n( $number ) ) );
+
+ } elseif( strpos( $bulk_action, 'mark_' ) !== false ) {
+
+ $shipment_statuses = wc_gzd_get_shipment_statuses();
+
+ // Check if any status changes happened.
+ foreach ( $shipment_statuses as $slug => $name ) {
+
+ if ( 'mark_' . str_replace( 'gzd-', '', $slug ) === $bulk_action ) { // WPCS: input var ok, CSRF ok.
+ $this->set_notice( sprintf( _nx( '%d shipment status changed.', '%d shipment statuses changed.', $number, 'shipments', 'woocommerce-germanized' ), number_format_i18n( $number ) ) );
+ break;
+ }
+ }
+ }
+
+ /**
+ * Action that fires after bulk updating shipments. Action might be usefull to add
+ * custom notices after custom bulk actions have been applied.
+ *
+ * The dynamic portion of this hook, `$this->get_hook_prefix()` is used to construct a
+ * unique hook for a shipment type e.g. return. In case of simple shipments the type is omitted.
+ *
+ * Example hook name: woocommerce_gzd_return_shipments_table_bulk_notice
+ *
+ * @param string $bulk_action The bulk action.
+ * @param Table $shipment_table The table object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( "{$this->get_hook_prefix()}bulk_notice", $bulk_action, $this );
+ }
+
+ public function set_notice( $message, $type = 'success' ) {
+ $this->notice = array(
+ 'message' => $message,
+ 'type' => $type,
+ );
+ }
+
+ protected function get_stati() {
+ return $this->stati;
+ }
+
+ /**
+ * @return bool
+ */
+ public function ajax_user_can() {
+ return current_user_can( 'edit_shop_orders' );
+ }
+
+ public function get_page_option() {
+ return 'woocommerce_page_wc_gzd_shipments_per_page';
+ }
+
+ /**
+ * @global array $avail_post_stati
+ * @global WP_Query $wp_query
+ * @global int $per_page
+ * @global string $mode
+ */
+ public function prepare_items() {
+ global $per_page;
+
+ $per_page = $this->get_items_per_page( $this->get_page_option(), 10 );
+
+ /**
+ * Filter to adjust Shipment's table items per page.
+ *
+ * The dynamic portion of this hook, `$this->get_hook_prefix()` is used to construct a
+ * unique hook for a shipment type e.g. return. In case of simple shipments the type is omitted.
+ *
+ * Example hook name: woocommerce_gzd_return_shipments_table_edit_per_page
+ *
+ * @param integer $per_page Number of Shipments per page.
+ * @param string $type The type in this case shipment.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ $per_page = apply_filters( "{$this->get_hook_prefix()}edit_per_page", $per_page, 'shipment' );
+ $this->stati = wc_gzd_get_shipment_statuses();
+ $this->counts = wc_gzd_get_shipment_counts( $this->shipment_type );
+ $paged = $this->get_pagenum();
+
+ $args = array(
+ 'limit' => $per_page,
+ 'paginate' => true,
+ 'offset' => ( $paged - 1 ) * $per_page,
+ 'count_total' => true,
+ 'type' => $this->shipment_type,
+ );
+
+ if ( isset( $_REQUEST['shipment_status'] ) && in_array( $_REQUEST['shipment_status'], array_keys( $this->stati ) ) ) {
+ $args['status'] = wc_clean( wp_unslash( $_REQUEST['shipment_status'] ) );
+ }
+
+ if ( isset( $_REQUEST['orderby'] ) ) {
+ if ( 'weight' === $_REQUEST['orderby'] ) {
+ $args['orderby'] = 'weight';
+ } else {
+ $args['orderby'] = wc_clean( wp_unslash( $_REQUEST['orderby'] ) );
+ }
+ }
+
+ if ( isset( $_REQUEST['order'] ) ) {
+ $args['order'] = 'asc' === $_REQUEST['order'] ? 'ASC' : 'DESC';
+ }
+
+ if ( isset( $_REQUEST['parent_id'] ) && ! empty( $_REQUEST['parent_id'] ) ) {
+ $args['parent_id'] = absint( $_REQUEST['parent_id'] );
+ }
+
+ if ( isset( $_REQUEST['order_id'] ) && ! empty( $_REQUEST['order_id'] ) ) {
+ $args['order_id'] = absint( $_REQUEST['order_id'] );
+ }
+
+ if ( isset( $_REQUEST['m'] ) ) {
+ $m = wc_clean( wp_unslash( $_REQUEST['m'] ) );
+ $year = substr( $m, 0, 4 );
+
+ if ( ! empty( $year ) ) {
+ $month = '';
+ $day = '';
+
+ if ( strlen( $m ) > 5 ) {
+ $month = substr( $m, 4, 2 );
+ }
+
+ if ( strlen( $m ) > 7 ) {
+ $day = substr( $m, 6, 2 );
+ }
+
+ $datetime = new WC_DateTime();
+ $datetime->setDate( $year, 1, 1 );
+
+ if ( ! empty( $month ) ) {
+ $datetime->setDate( $year, $month, 1 );
+ }
+
+ if ( ! empty( $day ) ) {
+ $datetime->setDate( $year, $month, $day );
+ }
+
+ $next_month = clone $datetime;
+ $next_month->modify( '+ 1 month' );
+ // Make sure to not include next month first day
+ $next_month->modify( '-1 day' );
+
+ $args['date_created'] = $datetime->format( 'Y-m-d' ) . '...' . $next_month->format( 'Y-m-d' );
+ }
+ }
+
+ if ( isset( $_REQUEST['s'] ) ) {
+ $search = wc_clean( wp_unslash( $_REQUEST['s'] ) );
+
+ if ( ! is_numeric( $search ) ) {
+ $search = '*' . $search . '*';
+ }
+
+ $args['search'] = $search;
+ }
+
+ // Query the user IDs for this page
+ $this->query = new ShipmentQuery( $args );
+ $this->items = $this->query->get_shipments();
+
+ $this->set_pagination_args(
+ array(
+ 'total_items' => $this->query->get_total(),
+ 'per_page' => $per_page,
+ )
+ );
+ }
+
+ /**
+ */
+ public function no_items() {
+ echo _x( 'No shipments found', 'shipments', 'woocommerce-germanized' );
+ }
+
+ /**
+ * Determine if the current view is the "All" view.
+ *
+ * @since 4.2.0
+ *
+ * @return bool Whether the current view is the "All" view.
+ */
+ protected function is_base_request() {
+ $vars = $_GET;
+ unset( $vars['paged'] );
+
+ if ( empty( $vars ) ) {
+ return true;
+ }
+
+ return 1 === count( $vars );
+ }
+
+ /**
+ * @global array $locked_post_status This seems to be deprecated.
+ * @global array $avail_post_stati
+ * @return array
+ */
+ protected function get_views() {
+
+ $status_links = array();
+ $num_shipments = $this->counts;
+ $total_shipments = array_sum( (array) $num_shipments );
+ $class = '';
+ $all_args = array();
+
+ if ( empty( $class ) && ( $this->is_base_request() || isset( $_REQUEST['all_shipments'] ) ) ) {
+ $class = 'current';
+ }
+
+ $all_inner_html = sprintf(
+ _nx(
+ 'All (%s)',
+ 'All (%s)',
+ $total_shipments, 'shipments', 'woocommerce-germanized'
+ ),
+ number_format_i18n( $total_shipments )
+ );
+
+ $status_links['all'] = $this->get_edit_link( $all_args, $all_inner_html, $class );
+
+ foreach ( wc_gzd_get_shipment_statuses() as $status => $title ) {
+ $class = '';
+
+ if ( ! in_array( $status, array_keys( $this->stati ) ) || empty( $num_shipments[ $status ] ) ) {
+ continue;
+ }
+
+ if ( isset( $_REQUEST['shipment_status'] ) && $status === $_REQUEST['shipment_status'] ) {
+ $class = 'current';
+ }
+
+ $status_args = array(
+ 'shipment_status' => $status,
+ );
+
+ $status_label = sprintf(
+ translate_nooped_plural( _nx_noop( $title . ' (%s)', $title . ' (%s)', 'shipments', 'woocommerce-germanized' ), $num_shipments[ $status ] ),
+ number_format_i18n( $num_shipments[ $status ] )
+ );
+
+ $status_links[ $status ] = $this->get_edit_link( $status_args, $status_label, $class );
+ }
+
+ return $status_links;
+ }
+
+ /**
+ * Helper to create links to edit.php with params.
+ *
+ * @since 4.4.0
+ *
+ * @param string[] $args Associative array of URL parameters for the link.
+ * @param string $label Link text.
+ * @param string $class Optional. Class attribute. Default empty string.
+ * @return string The formatted link string.
+ */
+ protected function get_edit_link( $args, $label, $class = '' ) {
+ $url = add_query_arg( $args, $this->get_main_page() );
+
+ $class_html = $aria_current = '';
+ if ( ! empty( $class ) ) {
+ $class_html = sprintf(
+ ' class="%s"',
+ esc_attr( $class )
+ );
+
+ if ( 'current' === $class ) {
+ $aria_current = ' aria-current="page"';
+ }
+ }
+
+ return sprintf(
+ '%s',
+ esc_url( $url ),
+ $class_html,
+ $aria_current,
+ $label
+ );
+ }
+
+ /**
+ * @return string
+ */
+ public function current_action() {
+ if ( isset( $_REQUEST['delete_all'] ) || isset( $_REQUEST['delete_all2'] ) ) {
+ return 'delete_all';
+ }
+
+ return parent::current_action();
+ }
+
+ /**
+ * Display a monthly dropdown for filtering items
+ *
+ * @since 3.0.6
+ *
+ * @global wpdb $wpdb
+ * @global WP_Locale $wp_locale
+ *
+ * @param string $post_type
+ */
+ protected function months_dropdown( $type ) {
+ global $wpdb, $wp_locale;
+
+ $extra_checks = "AND shipment_status != 'auto-draft'";
+
+ if ( isset( $_GET['shipment_status'] ) && 'all' !== $_GET['shipment_status'] ) {
+ $extra_checks = $wpdb->prepare( ' AND shipment_status = %s', wc_clean( wp_unslash( $_GET['shipment_status'] ) ) );
+ }
+
+ $months = $wpdb->get_results("
+ SELECT DISTINCT YEAR( shipment_date_created ) AS year, MONTH( shipment_date_created ) AS month
+ FROM $wpdb->gzd_shipments
+ WHERE 1=1
+ $extra_checks
+ ORDER BY shipment_date_created DESC
+ " );
+
+ $month_count = count( $months );
+
+ if ( ! $month_count || ( 1 == $month_count && 0 == $months[0]->month ) ) {
+ return;
+ }
+
+ $m = isset( $_GET['m'] ) ? (int) $_GET['m'] : 0;
+ ?>
+
+
+
+
+
+
+
+
+ get_notices( 'error' );
+ $success = $handler->get_notices( 'success' );
+ ?>
+
+
+
+
+
+
+
+ admin_after_error(); ?>
+
+
+
+
+
+ admin_handled();
+ /**
+ * Action that fires after a certain bulk action result has been rendered.
+ *
+ * The dynamic portion of this hook, `$this->get_hook_prefix()` is used to construct a
+ * unique hook for a shipment type e.g. return. In case of simple shipments the type is omitted.
+ * `$bulk_action` refers to the bulk action handled.
+ *
+ * Example hook name: woocommerce_gzd_return_shipments_table_mark_processing_handled
+ *
+ * @param BulkActionHandler $bulk_action_handler The bulk action handler.
+ * @param string $bulk_action The bulk action.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( "{$this->get_hook_prefix()}bulk_action_{$bulk_action}_handled", $handler, $bulk_action );
+ ?>
+
+ reset(); ?>
+
+
+ get_success_message(); ?>
+
+ months_dropdown( 'shipment' );
+ $this->order_filter();
+
+ /**
+ * Action that fires after outputting Shipments table view filters.
+ * Might be used to add custom filters to the Shipments table view.
+ *
+ * The dynamic portion of this hook, `$this->get_hook_prefix()` is used to construct a
+ * unique hook for a shipment type e.g. return. In case of simple shipments the type is omitted.
+ *
+ * Example hook name: woocommerce_gzd_return_shipments_table_filters
+ *
+ * @param string $which top or bottom.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( "{$this->get_hook_prefix()}filters", $which );
+
+ $output = ob_get_clean();
+
+ if ( ! empty( $output ) ) {
+ echo $output;
+
+ submit_button( _x( 'Filter', 'shipments', 'woocommerce-germanized' ), '', 'filter_action', false, array( 'id' => 'shipment-query-submit' ) );
+ }
+ }
+ ?>
+
+
+
+ ';
+ $columns['title'] = _x( 'Title', 'shipments', 'woocommerce-germanized' );
+ $columns['date'] = _x( 'Date', 'shipments', 'woocommerce-germanized' );
+ $columns['status'] = _x( 'Status', 'shipments', 'woocommerce-germanized' );
+ $columns['items'] = _x( 'Items', 'shipments', 'woocommerce-germanized' );
+ $columns['address'] = _x( 'Address', 'shipments', 'woocommerce-germanized' );
+ $columns['packaging'] = _x( 'Packaging', 'shipments', 'woocommerce-germanized' );
+ $columns['weight'] = _x( 'Weight', 'shipments', 'woocommerce-germanized' );
+ $columns['dimensions'] = _x( 'Dimensions', 'shipments', 'woocommerce-germanized' );
+ $columns['order'] = _x( 'Order', 'shipments', 'woocommerce-germanized' );
+ $columns['actions'] = _x( 'Actions', 'shipments', 'woocommerce-germanized' );
+
+ return $columns;
+ }
+
+ /**
+ * @return array
+ */
+ public function get_columns() {
+ $columns = $this->get_custom_columns();
+
+ /**
+ * Filters the columns displayed in the Shipments list table.
+ *
+ * The dynamic portion of this hook, `$this->get_hook_prefix()` is used to construct a
+ * unique hook for a shipment type e.g. return. In case of simple shipments the type is omitted.
+ *
+ * Example hook name: woocommerce_gzd_return_shipments_table_edit_per_page
+ *
+ * @param string[] $columns An associative array of column headings.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ $columns = apply_filters( "{$this->get_hook_prefix()}columns", $columns );
+
+ return $columns;
+ }
+
+ /**
+ * @return array
+ */
+ protected function get_sortable_columns() {
+ return array(
+ 'date' => array( 'date_created', false ),
+ 'weight' => 'weight',
+ 'order' => 'order_id'
+ );
+ }
+
+ /**
+ * Gets the name of the default primary column.
+ *
+ * @since 4.3.0
+ *
+ * @return string Name of the default primary column, in this case, 'title'.
+ */
+ protected function get_default_primary_column_name() {
+ return 'title';
+ }
+
+ /**
+ * Handles the default column output.
+ *
+ * @since 4.3.0
+ *
+ * @param Shipment $shipment The current shipment object.
+ * @param string $column_name The current column name.
+ */
+ public function column_default( $shipment, $column_name ) {
+
+ /**
+ * Fires in each custom column in the Shipments list table.
+ *
+ * The dynamic portion of this hook, `$this->get_hook_prefix()` is used to construct a
+ * unique hook for a shipment type e.g. return. In case of simple shipments the type is omitted.
+ *
+ * Example hook name: woocommerce_gzd_return_shipments_table_filters
+ *
+ * @param string $column_name The name of the column to display.
+ * @param integer $shipment_id The current shipment id.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( "{$this->get_hook_prefix()}custom_column", $column_name, $shipment->get_id() );
+ }
+
+ public function get_main_page() {
+ return 'admin.php?page=wc-gzd-shipments';
+ }
+
+ /**
+ * Handles the post author column output.
+ *
+ * @since 4.3.0
+ *
+ * @param Shipment $shipment The current shipment object.
+ */
+ public function column_title( $shipment ) {
+
+ $title = sprintf( _x( '%s #%s', 'shipment title', 'woocommerce-germanized' ), wc_gzd_get_shipment_label_title( $shipment->get_type() ), $shipment->get_id() );
+
+ if ( $order = $shipment->get_order() ) {
+ echo '' . $title . ' ';
+ } else {
+ echo $title . ' ';
+ }
+
+ echo '';
+ }
+
+ protected function get_custom_actions( $shipment, $actions ) {
+ return $actions;
+ }
+
+ /**
+ * Handles shipment actions.
+ *
+ * @since 0.0.1
+ *
+ * @param Shipment $shipment The current shipment object.
+ */
+ protected function column_actions( $shipment ) {
+ echo ''; + + /** + * Action that fires before table actions are outputted for a Shipment. + * + * The dynamic portion of this hook, `$this->get_hook_prefix()` is used to construct a + * unique hook for a shipment type e.g. return. In case of simple shipments the type is omitted. + * + * Example hook name: woocommerce_gzd_return_shipments_table_actions_start + * + * @param Shipment $shipment The shipment object. + * + * @since 3.0.0 + * @package Vendidero/Germanized/Shipments + */ + do_action( "{$this->get_hook_prefix()}actions_start", $shipment ); + + $actions = array(); + + if ( $shipment->has_status( array( 'draft' ) ) ) { + $actions['processing'] = array( + 'url' => wp_nonce_url( admin_url( 'admin-ajax.php?action=woocommerce_gzd_update_shipment_status&status=processing&shipment_id=' . $shipment->get_id() ), 'update-shipment-status' ), + 'name' => _x( 'Processing', 'shipments', 'woocommerce-germanized' ), + 'action' => 'processing', + ); + } + + if ( $shipment->has_status( array( 'draft', 'processing' ) ) ) { + $actions['shipped'] = array( + 'url' => wp_nonce_url( admin_url( 'admin-ajax.php?action=woocommerce_gzd_update_shipment_status&status=shipped&shipment_id=' . $shipment->get_id() ), 'update-shipment-status' ), + 'name' => _x( 'Shipped', 'shipments', 'woocommerce-germanized' ), + 'action' => 'shipped', + ); + } + + if ( $shipment->supports_label() ) { + + if ( $label = $shipment->get_label() ) { + + $actions['download_label'] = array( + 'url' => $label->get_download_url(), + 'name' => _x( 'Download label', 'shipments', 'woocommerce-germanized' ), + 'action' => 'download-label download', + 'target' => '_blank' + ); + + } elseif( $shipment->needs_label() ) { + + $actions['generate_label'] = array( + 'url' => '#', + 'name' => _x( 'Generate label', 'shipments', 'woocommerce-germanized' ), + 'action' => 'generate-label generate', + ); + + include Package::get_path() . '/includes/admin/views/label/html-shipment-label-backbone.php'; + } + } + + $actions = $this->get_custom_actions( $shipment, $actions ); + + /** + * Filters the actions available for Shipments table list column. + * + * The dynamic portion of this hook, `$this->get_hook_prefix()` is used to construct a + * unique hook for a shipment type e.g. return. In case of simple shipments the type is omitted. + * + * Example hook name: woocommerce_gzd_return_shipments_table_actions + * + * @param array $actions The registered Shipment actions. + * @param Shipment $shipment The shipment object. + * + * @since 3.0.0 + * @package Vendidero/Germanized/Shipments + */ + $actions = apply_filters( "{$this->get_hook_prefix()}actions", $actions, $shipment ); + + echo wc_gzd_render_shipment_action_buttons( $actions ); // WPCS: XSS ok. + + /** + * Action that fires after table actions are outputted for a Shipment. + * + * The dynamic portion of this hook, `$this->get_hook_prefix()` is used to construct a + * unique hook for a shipment type e.g. return. In case of simple shipments the type is omitted. + * + * Example hook name: woocommerce_gzd_return_shipments_table_actions_end + * + * @param Shipment $shipment The shipment object. + * + * @since 3.0.0 + * @package Vendidero/Germanized/Shipments + */ + do_action( "{$this->get_hook_prefix()}actions_end", $shipment ); + + echo '
'; + } + + public function column_cb( $shipment ) { + if ( current_user_can( 'edit_shop_orders' ) ) : + ?> + + + +|
+ get_product() ) : ?>
+ get_name() ); ?>
+
+ get_name() ); ?>
+
+
+ get_sku() ? ' ' . esc_html_x( 'SKU:', 'shipments', 'woocommerce-germanized' ) . ' ' . esc_html( $item->get_sku() ) . '' : '' ); ?> + + get_hook_prefix()}item_after_name", $item->get_id(), $item, $shipment ); ?> + |
+ + get_quantity(); ?>x + | +
' . $html . '
',
+ ),
+ 'shipment_id' => $shipment_id,
+ 'success' => true,
+ );
+
+ wp_send_json( $response );
+ }
+
+ public static function remove_shipment_label() {
+ check_ajax_referer( 'remove-shipment-label', 'security' );
+
+ if ( ! current_user_can( 'edit_shop_orders' ) || ! isset( $_POST['shipment_id'] ) ) {
+ wp_die( -1 );
+ }
+
+ $response = array();
+ $response_error = array(
+ 'success' => false,
+ 'messages' => array(
+ _x( 'There was an error deleting the label.', 'shipments', 'woocommerce-germanized' )
+ ),
+ );
+
+ $shipment_id = absint( $_POST['shipment_id'] );
+
+ if ( ! $shipment = wc_gzd_get_shipment( $shipment_id ) ) {
+ wp_send_json( $response_error );
+ }
+
+ if ( ! $label = $shipment->get_label() ) {
+ wp_send_json( $response_error );
+ }
+
+ if ( $shipment->delete_label( true ) ) {
+ $response = array(
+ 'success' => true,
+ 'shipment_id' => $shipment->get_id(),
+ 'needs_refresh' => true,
+ 'fragments' => array(
+ 'div#shipment-' . $shipment_id => self::get_shipment_html( $shipment ),
+ ),
+ );
+ } else {
+ wp_send_json( $response_error );
+ }
+
+ wp_send_json( $response );
+ }
+
+ public static function create_shipment_label() {
+ check_ajax_referer( 'create-shipment-label', 'security' );
+
+ if ( ! current_user_can( 'edit_shop_orders' ) || ! isset( $_POST['shipment_id'] ) ) {
+ wp_die( -1 );
+ }
+
+ $response = array();
+ $response_error = array(
+ 'success' => false,
+ 'messages' => array(
+ _x( 'There was an error processing the label.', 'shipments', 'woocommerce-germanized' )
+ ),
+ );
+
+ $shipment_id = absint( $_POST['shipment_id'] );
+ $result = false;
+
+ if ( ! $shipment = wc_gzd_get_shipment( $shipment_id ) ) {
+ wp_send_json( $response_error );
+ }
+
+ if ( $shipment->supports_label() && $shipment->needs_label() ) {
+ $data = array();
+
+ foreach( $_POST as $key => $value ) {
+ if ( in_array( $key, array( 'action', 'security' ) ) ) {
+ continue;
+ }
+
+ $data[ $key ] = wc_clean( wp_unslash( $value ) );
+ }
+
+ $result = $shipment->create_label( $data );
+ }
+
+ if ( is_wp_error( $result ) ) {
+ $response = array(
+ 'success' => false,
+ 'messages' => $result->get_error_messages(),
+ );
+ } elseif ( $label = $shipment->get_label() ) {
+
+ $order_shipment = wc_gzd_get_shipment_order( $shipment->get_order() );
+
+ $response = array(
+ 'success' => true,
+ 'label_id' => $label->get_id(),
+ 'shipment_id' => $shipment_id,
+ 'needs_refresh' => true,
+ 'fragments' => array(
+ 'div#shipment-' . $shipment_id => self::get_shipment_html( $shipment ),
+ '.order-shipping-status' => $order_shipment ? self::get_order_status_html( $order_shipment ) : '',
+ '.order-return-status' => $order_shipment ? self::get_order_return_status_html( $order_shipment ) : '',
+ 'tr#shipment-' . $shipment_id . ' td.actions .wc-gzd-shipment-action-button-generate-label' => self::label_download_button_html( $label ),
+ ),
+ );
+ } else {
+ $response = $response_error;
+ }
+
+ wp_send_json( $response );
+ }
+
+ protected static function get_shipment_html( $p_shipment, $p_is_active = true ) {
+ $is_active = $p_is_active;
+ $shipment = $p_shipment;
+
+ ob_start();
+ include( Package::get_path() . '/includes/admin/views/html-order-shipment.php' );
+ $html = ob_get_clean();
+
+ return $html;
+ }
+
+ protected static function get_label_html( $p_shipment, $p_label = false ) {
+ $shipment = $p_shipment;
+
+ if ( $p_label ) {
+ $label = $p_label;
+ }
+
+ ob_start();
+ include( Package::get_path() . '/includes/admin/views/label/html-shipment-label.php' );
+ $html = ob_get_clean();
+
+ return $html;
+ }
+
+ /**
+ * @param ShipmentLabel $label
+ *
+ * @return string
+ */
+ protected static function label_download_button_html( $label ) {
+ return '' . _x( 'Download label', 'shipments', 'woocommerce-germanized' ) . '';
+ }
+
+ public static function edit_shipping_provider_status() {
+ check_ajax_referer( 'edit-shipping-providers', 'security' );
+
+ if ( ! current_user_can( 'edit_shop_orders' ) || ! isset( $_POST['provider'] ) || ! isset( $_POST['enable'] ) ) {
+ wp_die( -1 );
+ }
+
+ $response_error = array(
+ 'success' => false,
+ 'message' => _x( 'There was an error while trying to save the shipping provider status.', 'shipments', 'woocommerce-germanized' ),
+ );
+
+ $provider = sanitize_key( wc_clean( $_POST['provider'] ) );
+ $enable = wc_clean( $_POST['enable'] );
+ $helper = Helper::instance();
+ $response = array(
+ 'success' => true,
+ 'provider' => $provider,
+ 'message' => '',
+ );
+
+ $helper->load_shipping_providers();
+
+ if ( $shipping_provider = $helper->get_shipping_provider( $provider ) ) {
+ if ( 'yes' === $enable ) {
+ $response['activated'] = 'yes';
+ $shipping_provider->activate();
+ } else {
+ $response['activated'] = 'no';
+ $shipping_provider->deactivate();
+ }
+
+ wp_send_json( $response );
+ } else {
+ wp_send_json( $response_error );
+ }
+ }
+
+ public static function remove_shipping_provider() {
+ check_ajax_referer( 'remove-shipping-provider', 'security' );
+
+ if ( ! current_user_can( 'edit_shop_orders' ) || ! isset( $_POST['provider'] ) ) {
+ wp_die( -1 );
+ }
+
+ $response_error = array(
+ 'success' => false,
+ 'message' => _x( 'There was an error while trying to delete the shipping provider.', 'shipments', 'woocommerce-germanized' ),
+ );
+
+ $provider = sanitize_key( wc_clean( $_POST['provider'] ) );
+ $helper = Helper::instance();
+ $response = array(
+ 'success' => true,
+ 'provider' => $provider,
+ 'message' => '',
+ );
+
+ $helper->load_shipping_providers();
+
+ if ( $shipping_provider = $helper->get_shipping_provider( $provider ) ) {
+ $shipping_provider->delete();
+ wp_send_json( $response );
+ } else {
+ wp_send_json( $response_error );
+ }
+ }
+
+ public static function shipments_bulk_action_handle() {
+ $action = isset( $_POST['bulk_action'] ) ? wc_clean( $_POST['bulk_action'] ) : '';
+ $type = isset( $_POST['type'] ) ? wc_clean( $_POST['type'] ) : 'simple';
+
+ check_ajax_referer( "woocommerce_gzd_shipments_{$action}", 'security' );
+
+ if ( ! current_user_can( 'edit_shop_orders' ) || ! isset( $_POST['step'] ) || ! isset( $_POST['ids'] ) ) {
+ wp_die( -1 );
+ }
+
+ $response_error = array(
+ 'success' => false,
+ 'message' => _x( 'There was an error while bulk processing shipments.', 'shipments', 'woocommerce-germanized' ),
+ );
+
+ $response = array(
+ 'success' => true,
+ 'message' => '',
+ );
+
+ $handlers = Admin::get_bulk_action_handlers();
+
+ if ( ! array_key_exists( $action, $handlers ) ) {
+ wp_send_json( $response_error );
+ }
+
+ $ids = isset( $_POST['ids'] ) ? array_map( 'absint', $_POST['ids'] ) : array();
+ $step = isset( $_POST['step'] ) ? absint( $_POST['step'] ) : 1;
+
+ $handler = $handlers[ $action ];
+
+ if ( 1 === $step ) {
+ $handler->reset( true );
+ }
+
+ $handler->set_step( $step );
+ $handler->set_ids( $ids );
+ $handler->set_shipment_type( $type );
+
+ $handler->handle();
+
+ if ( $handler->get_percent_complete() >= 100 ) {
+ $errors = $handler->get_notices( 'error' );
+
+ if ( empty( $errors ) ) {
+ $handler->add_notice( $handler->get_success_message(), 'success' );
+ $handler->update_notices();
+ }
+
+ wp_send_json_success(
+ array(
+ 'step' => 'done',
+ 'percentage' => 100,
+ 'url' => $handler->get_success_redirect_url(),
+ 'type' => $handler->get_shipment_type(),
+ )
+ );
+ } else {
+ wp_send_json_success(
+ array(
+ 'step' => ++$step,
+ 'percentage' => $handler->get_percent_complete(),
+ 'ids' => $handler->get_ids(),
+ 'type' => $handler->get_shipment_type(),
+ )
+ );
+ }
+ }
+
+ /**
+ * @param Order $order
+ */
+ private static function refresh_shipments( &$order ) {
+ MetaBox::refresh_shipments( $order );
+ }
+
+ /**
+ * @param Order $order
+ * @param bool $shipment
+ */
+ private static function refresh_shipment_items( &$order, &$shipment = false ) {
+ MetaBox::refresh_shipment_items( $order, $shipment );
+ }
+
+ /**
+ * @param Order $order
+ */
+ private static function refresh_status( &$order ) {
+ MetaBox::refresh_status( $order );
+ }
+
+ public static function update_shipment_status() {
+ if ( current_user_can( 'edit_shop_orders' ) && check_admin_referer( 'update-shipment-status' ) && isset( $_GET['status'], $_GET['shipment_id'] ) ) {
+ $status = sanitize_text_field( wp_unslash( $_GET['status'] ) );
+ $shipment = wc_gzd_get_shipment( absint( wp_unslash( $_GET['shipment_id'] ) ) );
+
+ if ( wc_gzd_is_shipment_status( 'gzd-' . $status ) && $shipment ) {
+ $shipment->update_status( $status, true );
+ /**
+ * Action to indicate Shipment status change via WP Admin.
+ *
+ * @param integer $shipment_id The shipment id.
+ * @param string $status The status to be switched to.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( 'woocommerce_gzd_updated_shipment_status', $shipment->get_id(), $status );
+ }
+ }
+
+ wp_safe_redirect( wp_get_referer() ? wp_get_referer() : admin_url( 'admin.php?page=wc-gzd-shipments' ) );
+ exit;
+ }
+
+ public static function remove_shipment() {
+ check_ajax_referer( 'edit-shipments', 'security' );
+
+ if ( ! current_user_can( 'edit_shop_orders' ) || ! isset( $_POST['shipment_id'] ) ) {
+ wp_die( -1 );
+ }
+
+ $response_error = array(
+ 'success' => false,
+ 'message' => _x( 'There was an error processing the shipment', 'shipments', 'woocommerce-germanized' ),
+ );
+
+ $response = array(
+ 'success' => true,
+ 'message' => '',
+ );
+
+ $shipment_id = absint( $_POST['shipment_id'] );
+
+ if ( ! $shipment = wc_gzd_get_shipment( $shipment_id ) ) {
+ wp_send_json( $response_error );
+ }
+
+ if ( ! $order_shipment = wc_gzd_get_shipment_order( $shipment->get_order() ) ) {
+ wp_send_json( $response_error );
+ }
+
+ if ( $shipment->delete( true ) ) {
+ $order_shipment->remove_shipment( $shipment_id );
+
+ $response['shipment_id'] = $shipment_id;
+ $response['fragments'] = array(
+ '.order-shipping-status' => self::get_order_status_html( $order_shipment ),
+ '.order-return-status' => self::get_order_return_status_html( $order_shipment ),
+ );
+
+ self::send_json_success( $response, $order_shipment );
+ } else {
+ wp_send_json( $response_error );
+ }
+ }
+
+ public static function add_shipment() {
+ check_ajax_referer( 'edit-shipments', 'security' );
+
+ if ( ! current_user_can( 'edit_shop_orders' ) || ! isset( $_POST['order_id'] ) ) {
+ wp_die( -1 );
+ }
+
+ $response_error = array(
+ 'success' => false,
+ 'message' => _x( 'There was an error while adding the shipment', 'shipments', 'woocommerce-germanized' ),
+ );
+
+ $response = array(
+ 'success' => true,
+ 'message' => '',
+ );
+
+ $order_id = absint( $_POST['order_id'] );
+
+ if ( ! $order = wc_get_order( $order_id ) ) {
+ wp_send_json( $response_error );
+ }
+
+ if ( ! $order_shipment = wc_gzd_get_shipment_order( $order ) ) {
+ wp_send_json( $response_error );
+ }
+
+ self::refresh_shipment_items( $order_shipment );
+
+ if ( ! $order_shipment->needs_shipping() ) {
+ $response_error['message'] = _x( 'This order contains enough shipments already.', 'shipments', 'woocommerce-germanized' );
+ wp_send_json( $response_error );
+ }
+
+ $shipment = wc_gzd_create_shipment( $order_shipment );
+
+ if ( is_wp_error( $shipment ) ) {
+ wp_send_json( $response_error );
+ }
+
+ $order_shipment->add_shipment( $shipment );
+
+ // Mark as active
+ $is_active = true;
+
+ ob_start();
+ include( Package::get_path() . '/includes/admin/views/html-order-shipment.php' );
+ $html = ob_get_clean();
+
+ $response['new_shipment'] = $html;
+ $response['new_shipment_type'] = $shipment->get_type();
+ $response['fragments'] = array(
+ '.order-shipping-status' => self::get_order_status_html( $order_shipment ),
+ '.order-return-status' => self::get_order_return_status_html( $order_shipment ),
+ );
+
+ self::send_json_success( $response, $order_shipment );
+ }
+
+ public static function add_return_shipment() {
+ check_ajax_referer( 'edit-shipments', 'security' );
+
+ if ( ! current_user_can( 'edit_shop_orders' ) || ! isset( $_POST['order_id'] ) ) {
+ wp_die( -1 );
+ }
+
+ $response_error = array(
+ 'success' => false,
+ 'message' => _x( 'There was an error processing the shipment', 'shipments', 'woocommerce-germanized' ),
+ );
+
+ $response = array(
+ 'success' => true,
+ 'message' => '',
+ 'new_shipment' => '',
+ );
+
+ $order_id = absint( $_POST['order_id'] );
+ $items = isset( $_POST['return_item'] ) ? (array) $_POST['return_item'] : array();
+
+ if ( ! $order_shipment = wc_gzd_get_shipment_order( $order_id ) ) {
+ wp_send_json( $response_error );
+ }
+
+ self::refresh_shipment_items( $order_shipment );
+
+ if ( ! $order_shipment->needs_return() ) {
+ $response_error['message'] = _x( 'This order contains enough returns already.', 'shipments', 'woocommerce-germanized' );
+ wp_send_json( $response_error );
+ }
+
+ $shipment = wc_gzd_create_return_shipment( $order_shipment, array( 'items' => $items ) );
+
+ if ( is_wp_error( $shipment ) ) {
+ wp_send_json( $response_error );
+ }
+
+ $order_shipment->add_shipment( $shipment );
+
+ // Mark as active
+ $is_active = true;
+
+ ob_start();
+ include( Package::get_path() . '/includes/admin/views/html-order-shipment.php' );
+ $html = ob_get_clean();
+
+ $response['new_shipment'] = $html;
+ $response['new_shipment_type'] = $shipment->get_type();
+ $response['fragments'] = array(
+ '.order-shipping-status' => self::get_order_status_html( $order_shipment ),
+ '.order-return-status' => self::get_order_return_status_html( $order_shipment ),
+ );
+
+ self::send_json_success( $response, $order_shipment );
+ }
+
+ public static function validate_shipment_item_quantities() {
+ check_ajax_referer( 'edit-shipments', 'security' );
+
+ if ( ! current_user_can( 'edit_shop_orders' ) || ! isset( $_POST['order_id'] ) ) {
+ wp_die( -1 );
+ }
+
+ $response_error = array(
+ 'success' => false,
+ 'message' => _x( 'There was an error processing the shipment', 'shipments', 'woocommerce-germanized' ),
+ );
+
+ $response = array(
+ 'success' => true,
+ 'message' => '',
+ );
+
+ $order_id = absint( $_POST['order_id'] );
+ $active = isset( $_POST['active'] ) ? absint( $_POST['active'] ) : 0;
+
+ if ( ! $order = wc_get_order( $order_id ) ) {
+ wp_send_json( $response_error );
+ }
+
+ if ( ! $order_shipment = wc_gzd_get_shipment_order( $order ) ) {
+ wp_send_json( $response_error );
+ }
+
+ static::refresh_shipments( $order_shipment );
+
+ $order_shipment->validate_shipments();
+
+ $response['fragments'] = self::get_shipments_html( $order_shipment, $active );
+
+ self::send_json_success( $response, $order_shipment );
+ }
+
+ public static function sync_shipment_items() {
+ check_ajax_referer( 'edit-shipments', 'security' );
+
+ if ( ! current_user_can( 'edit_shop_orders' ) || ! isset( $_POST['shipment_id'] ) ) {
+ wp_die( -1 );
+ }
+
+ $response_error = array(
+ 'success' => false,
+ 'message' => _x( 'There was an error processing the shipment', 'shipments', 'woocommerce-germanized' ),
+ );
+
+ $response = array(
+ 'success' => true,
+ 'message' => '',
+ );
+
+ $shipment_id = absint( $_POST['shipment_id'] );
+
+ if ( ! $shipment = wc_gzd_get_shipment( $shipment_id ) ) {
+ wp_send_json( $response_error );
+ }
+
+ if ( ! $order = $shipment->get_order() ) {
+ wp_send_json( $response_error );
+ }
+
+ if ( ! $order_shipment = wc_gzd_get_shipment_order( $order ) ) {
+ wp_send_json( $response_error );
+ }
+
+ $shipment = $order_shipment->get_shipment( $shipment_id );
+
+ static::refresh_shipment_items( $order_shipment );
+
+ if ( $shipment->is_editable() ) {
+ $shipment = $order_shipment->get_shipment( $shipment_id );
+
+ // Make sure we are working based on the current instance.
+ $shipment->set_order_shipment( $order_shipment );
+ $shipment->sync_items();
+ $shipment->save();
+ }
+
+ ob_start();
+ foreach( $shipment->get_items() as $item ) {
+ include( Package::get_path() . '/includes/admin/views/html-order-shipment-item.php' );
+ }
+ $html = ob_get_clean();
+
+ $response['fragments'] = array(
+ '#shipment-' . $shipment->get_id() . ' .shipment-item-list:first' => '' . $html . '
',
+ '#shipment-' . $shipment->get_id() . ' .item-count:first' => self::get_item_count_html( $shipment, $order_shipment ),
+ );
+
+ self::send_json_success( $response, $order_shipment, $shipment );
+ }
+
+ public static function json_search_orders() {
+ ob_start();
+
+ check_ajax_referer( 'search-orders', 'security' );
+
+ if ( ! current_user_can( 'edit_shop_orders' ) ) {
+ wp_die( -1 );
+ }
+
+ $term = isset( $_GET['term'] ) ? (string) wc_clean( wp_unslash( $_GET['term'] ) ) : '';
+ $limit = 0;
+
+ if ( empty( $term ) ) {
+ wp_die();
+ }
+
+ if ( ! is_numeric( $term ) ) {
+ $ids = wc_order_search( $term );
+ } else {
+ global $wpdb;
+
+ $ids = $wpdb->get_col(
+ $wpdb->prepare(
+ "SELECT DISTINCT p1.ID FROM {$wpdb->posts} p1 WHERE p1.ID LIKE %s AND post_type = 'shop_order'", // @codingStandardsIgnoreLine
+ $wpdb->esc_like( wc_clean( $term ) ) . '%'
+ )
+ );
+ }
+
+ $found_orders = array();
+
+ if ( ! empty( $_GET['exclude'] ) ) {
+ $ids = array_diff( $ids, array_map( 'absint', (array) wp_unslash( $_GET['exclude'] ) ) );
+ }
+
+ foreach ( $ids as $id ) {
+ if ( $order = wc_get_order( $id ) ) {
+ $found_orders[ $id ] = sprintf(
+ esc_html_x( 'Order #%s', 'shipments', 'woocommerce-germanized' ),
+ $order->get_order_number()
+ );
+ }
+ }
+
+ /**
+ * Filter to adjust found orders to filter Shipments.
+ *
+ * @param array $result The order search result.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ wp_send_json( apply_filters( 'woocommerce_gzd_json_search_found_shipment_orders', $found_orders ) );
+ }
+
+ private static function get_order_status_html( $order_shipment ) {
+ $status_html = '' . wc_gzd_get_shipment_order_shipping_status_name( $order_shipment->get_shipping_status() ) . '';
+
+ return $status_html;
+ }
+
+ private static function get_order_return_status_html( $order_shipment ) {
+ $status_html = '' . wc_gzd_get_shipment_order_return_status_name( $order_shipment->get_return_status() ) . '';
+
+ return $status_html;
+ }
+
+ public static function refresh_shipment_packaging() {
+ check_ajax_referer( 'refresh-shipment-packaging', 'security' );
+
+ if ( ! current_user_can( 'edit_shop_orders' ) || ! isset( $_POST['shipment_id'] ) ) {
+ wp_die( -1 );
+ }
+
+ $response_error = array(
+ 'success' => false,
+ 'message' => _x( 'There was an error processing the shipment', 'shipments', 'woocommerce-germanized' ),
+ );
+
+ $shipment_id = absint( $_POST['shipment_id'] );
+
+ if ( ! $shipment = wc_gzd_get_shipment( $shipment_id ) ) {
+ wp_send_json( $response_error );
+ }
+
+ $response = array(
+ 'success' => true,
+ 'message' => '',
+ 'shipment_id' => $shipment_id,
+ 'needs_packaging_refresh' => true,
+ );
+
+ $data = array(
+ 'packaging_id' => isset( $_POST['shipment_packaging_id'][ $shipment_id ] ) ? absint( wc_clean( $_POST['shipment_packaging_id'][ $shipment_id ] ) ) : '',
+ );
+
+ $shipment->set_props( $data );
+
+ $response['fragments'] = array(
+ '#shipment-' . $shipment->get_id() . ' .shipment-packaging-select' => self::get_packaging_select_html( $shipment ),
+ );
+
+ wp_send_json( $response );
+ }
+
+ protected static function get_packaging_select_html( $shipment ) {
+ ob_start();
+ include( Package::get_path() . '/includes/admin/views/html-order-shipment-packaging-select.php' );
+ $html = ob_get_clean();
+
+ return $html;
+ }
+
+ public static function save_shipments() {
+ check_ajax_referer( 'edit-shipments', 'security' );
+
+ if ( ! current_user_can( 'edit_shop_orders' ) || ! isset( $_POST['order_id'] ) ) {
+ wp_die( -1 );
+ }
+
+ $response_error = array(
+ 'success' => false,
+ 'message' => _x( 'There was an error processing the shipment', 'shipments', 'woocommerce-germanized' ),
+ );
+
+ $response = array(
+ 'success' => true,
+ 'message' => '',
+ );
+
+ $order_id = absint( $_POST['order_id'] );
+ $active = isset( $_POST['active'] ) ? absint( $_POST['active'] ) : 0;
+
+ if ( ! $order = wc_get_order( $order_id ) ) {
+ wp_send_json( $response_error );
+ }
+
+ if ( ! $order_shipment = wc_gzd_get_shipment_order( $order ) ) {
+ wp_send_json( $response_error );
+ }
+
+ // Refresh data
+ self::refresh_shipments( $order_shipment );
+
+ // Make sure that we are not applying more
+ $order_shipment->validate_shipment_item_quantities();
+
+ // Refresh statuses after adjusting quantities
+ self::refresh_status( $order_shipment );
+
+ $order_shipment->save();
+
+ $response['fragments'] = self::get_shipments_html( $order_shipment, $active );
+
+ self::send_json_success( $response, $order_shipment );
+ }
+
+ /**
+ * @param Order $order_shipment
+ * @param int $active
+ *
+ * @return array
+ */
+ private static function get_shipments_html( $p_order_shipment, $p_active = 0 ) {
+ $order_shipment = $p_order_shipment;
+ $active_shipment = $p_active;
+
+ ob_start();
+ include( Package::get_path() . '/includes/admin/views/html-order-shipment-list.php' );
+ $html = ob_get_clean();
+
+ $fragments = array(
+ '#order-shipments-list' => $html,
+ '.order-shipping-status' => self::get_order_status_html( $order_shipment ),
+ '.order-return-status' => self::get_order_return_status_html( $order_shipment ),
+ );
+
+ return $fragments;
+ }
+
+ public static function get_available_return_shipment_items() {
+ check_ajax_referer( 'edit-shipments', 'security' );
+
+ if ( ! current_user_can( 'edit_shop_orders' ) || ! isset( $_POST['order_id'] ) ) {
+ wp_die( -1 );
+ }
+
+ $response_error = array(
+ 'success' => false,
+ 'message' => _x( 'There was an error processing the shipment', 'shipments', 'woocommerce-germanized' ),
+ );
+
+ $response = array(
+ 'success' => true,
+ 'message' => '',
+ 'html' => '',
+ );
+
+ $order_id = absint( $_POST['order_id'] );
+
+ if ( ! $order_shipment = wc_gzd_get_shipment_order( $order_id ) ) {
+ wp_send_json( $response_error );
+ }
+
+ static::refresh_shipments( $order_shipment );
+
+ ob_start();
+ include( Package::get_path() . '/includes/admin/views/html-order-add-return-shipment-items.php' );
+ $response['html'] = ob_get_clean();
+
+ self::send_json_success( $response, $order_shipment );
+ }
+
+ public static function get_available_shipment_items() {
+ check_ajax_referer( 'edit-shipments', 'security' );
+
+ if ( ! current_user_can( 'edit_shop_orders' ) || ! isset( $_POST['shipment_id'] ) ) {
+ wp_die( -1 );
+ }
+
+ $response_error = array(
+ 'success' => false,
+ 'message' => _x( 'There was an error processing the shipment', 'shipments', 'woocommerce-germanized' ),
+ );
+
+ $response = array(
+ 'success' => true,
+ 'message' => '',
+ 'items' => array(),
+ );
+
+ $shipment_id = absint( $_POST['shipment_id'] );
+
+ if ( ! $shipment = wc_gzd_get_shipment( $shipment_id ) ) {
+ wp_send_json( $response_error );
+ }
+
+ if ( ! $order = $shipment->get_order() ) {
+ wp_send_json( $response_error );
+ }
+
+ if ( ! $order_shipment = wc_gzd_get_shipment_order( $order ) ) {
+ wp_send_json( $response_error );
+ }
+
+ static::refresh_shipments( $order_shipment );
+
+ if ( 'return' === $shipment->get_type() ) {
+ $response['items'] = $order_shipment->get_available_items_for_return( array(
+ 'shipment_id' => $shipment->get_id(),
+ 'disable_duplicates' => true,
+ ) );
+ } else {
+ $response['items'] = $order_shipment->get_available_items_for_shipment( array(
+ 'shipment_id' => $shipment_id,
+ 'disable_duplicates' => true,
+ ) );
+ }
+
+ self::send_json_success( $response, $order_shipment );
+ }
+
+ public static function add_shipment_item() {
+ check_ajax_referer( 'edit-shipments', 'security' );
+
+ if ( ! current_user_can( 'edit_shop_orders' ) || ! isset( $_POST['shipment_id'] ) ) {
+ wp_die( -1 );
+ }
+
+ $response_error = array(
+ 'success' => false,
+ 'message' => _x( 'There was an error processing the shipment', 'shipments', 'woocommerce-germanized' ),
+ );
+
+ $response = array(
+ 'success' => true,
+ 'message' => '',
+ 'new_item' => '',
+ );
+
+ $shipment_id = absint( $_POST['shipment_id'] );
+ $original_item_id = isset( $_POST['original_item_id'] ) ? absint( $_POST['original_item_id'] ) : 0;
+ $item_quantity = isset( $_POST['quantity'] ) ? absint( $_POST['quantity'] ) : false;
+
+ if ( false !== $item_quantity && $item_quantity === 0 ) {
+ $item_quantity = 1;
+ }
+
+ if ( empty( $original_item_id ) ) {
+ wp_send_json( $response_error );
+ }
+
+ if ( ! $shipment = wc_gzd_get_shipment( $shipment_id ) ) {
+ wp_send_json( $response_error );
+ }
+
+ if ( ! $order = $shipment->get_order() ) {
+ wp_send_json( $response_error );
+ }
+
+ if ( ! $order_shipment = wc_gzd_get_shipment_order( $order ) ) {
+ wp_send_json( $response_error );
+ }
+
+ static::refresh_shipments( $order_shipment );
+
+ // Make sure we are working with the shipment from the order
+ $shipment = $order_shipment->get_shipment( $shipment_id );
+
+ if ( 'return' === $shipment->get_type() ) {
+ $item = self::add_shipment_return_item( $order_shipment, $shipment, $original_item_id, $item_quantity );
+ } else {
+ $item = self::add_shipment_order_item( $order_shipment, $shipment, $original_item_id, $item_quantity );
+ }
+
+ if ( ! $item ) {
+ wp_send_json( $response_error );
+ }
+
+ ob_start();
+ include( Package::get_path() . '/includes/admin/views/html-order-shipment-item.php' );
+ $response['new_item'] = ob_get_clean();
+
+ $response['fragments'] = array(
+ '#shipment-' . $shipment->get_id() . ' .item-count:first' => self::get_item_count_html( $shipment, $order_shipment ),
+ );
+
+ self::send_json_success( $response, $order_shipment, $shipment );
+ }
+
+ /**
+ * @param Order $order_shipment
+ * @param ReturnShipment $shipment
+ * @param integer $parent_item_id
+ * @param integer $quantity
+ */
+ private static function add_shipment_return_item( $order_shipment, $shipment, $order_item_id, $quantity ) {
+ $response_error = array(
+ 'success' => false,
+ 'message' => _x( 'There was an error processing the shipment', 'shipments', 'woocommerce-germanized' ),
+ );
+
+ if ( ! $shipment_item = $order_shipment->get_simple_shipment_item( $order_item_id ) ) {
+ wp_send_json( $response_error );
+ }
+
+ // No duplicates allowed
+ if ( $shipment->get_item_by_order_item_id( $order_item_id ) ) {
+ wp_send_json( $response_error );
+ }
+
+ // Check max quantity
+ $quantity_left = $order_shipment->get_item_quantity_left_for_returning( $shipment_item->get_order_item_id() );
+
+ if ( $quantity ) {
+ if ( $quantity > $quantity_left ) {
+ $quantity = $quantity_left;
+ }
+ } else {
+ $quantity = $quantity_left;
+ }
+
+ if ( $item = wc_gzd_create_return_shipment_item( $shipment, $shipment_item, array( 'quantity' => $quantity ) ) ) {
+ $shipment->add_item( $item );
+ $shipment->save();
+ }
+
+ return $item;
+ }
+
+ /**
+ * @param Order $order_shipment
+ * @param SimpleShipment $shipment
+ * @param integer $order_item_id
+ * @param integer $quantity
+ */
+ private static function add_shipment_order_item( $order_shipment, $shipment, $order_item_id, $quantity ) {
+
+ $response_error = array(
+ 'success' => false,
+ 'message' => _x( 'There was an error processing the shipment', 'shipments', 'woocommerce-germanized' ),
+ );
+
+ $order = $order_shipment->get_order();
+
+ if ( ! $order_item = $order->get_item( $order_item_id ) ) {
+ wp_send_json( $response_error );
+ }
+
+ // No duplicates allowed
+ if ( $shipment->get_item_by_order_item_id( $order_item_id ) ) {
+ wp_send_json( $response_error );
+ }
+
+ // Check max quantity
+ $quantity_left = $order_shipment->get_item_quantity_left_for_shipping( $order_item );
+
+ if ( $quantity ) {
+ if ( $quantity > $quantity_left ) {
+ $quantity = $quantity_left;
+ }
+ } else {
+ $quantity = $quantity_left;
+ }
+
+ if ( $item = wc_gzd_create_shipment_item( $shipment, $order_item, array( 'quantity' => $quantity ) ) ) {
+ $shipment->add_item( $item );
+ $shipment->save();
+ }
+
+ return $item;
+ }
+
+ private static function get_item_count_html( $p_shipment, $p_order_shipment ) {
+ $shipment = $p_shipment;
+
+ // Refresh the instance to make sure we are working with the same object
+ $shipment->set_order_shipment( $p_order_shipment );
+
+ ob_start();
+ include( Package::get_path() . '/includes/admin/views/html-order-shipment-item-count.php' );
+ $html = ob_get_clean();
+
+ return $html;
+ }
+
+ public static function remove_shipment_item() {
+ check_ajax_referer( 'edit-shipments', 'security' );
+
+ if ( ! current_user_can( 'edit_shop_orders' ) || ! isset( $_POST['shipment_id'] ) || ! isset( $_POST['item_id'] ) ) {
+ wp_die( -1 );
+ }
+
+ $response_error = array(
+ 'success' => false,
+ 'message' => _x( 'There was an error processing the shipment', 'shipments', 'woocommerce-germanized' ),
+ );
+
+ $response = array(
+ 'success' => true,
+ 'message' => '',
+ 'item_id' => '',
+ );
+
+ $shipment_id = absint( $_POST['shipment_id'] );
+ $item_id = absint( $_POST['item_id'] );
+
+ if ( ! $shipment = wc_gzd_get_shipment( $shipment_id ) ) {
+ wp_send_json( $response_error );
+ }
+
+ if ( ! $item = $shipment->get_item( $item_id ) ) {
+ wp_send_json( $response_error );
+ }
+
+ if ( ! $order_shipment = wc_gzd_get_shipment_order( $shipment->get_order_id() ) ) {
+ wp_send_json( $response_error );
+ }
+
+ $shipment->remove_item( $item_id );
+ $shipment->save();
+
+ $response['item_id'] = $item_id;
+ $response['fragments'] = array(
+ '#shipment-' . $shipment->get_id() . ' .item-count:first' => self::get_item_count_html( $shipment, $order_shipment ),
+ );
+
+ self::send_json_success( $response, $order_shipment, $shipment );
+ }
+
+ public static function limit_shipment_item_quantity() {
+ check_ajax_referer( 'edit-shipments', 'security' );
+
+ if ( ! current_user_can( 'edit_shop_orders' ) || ! isset( $_POST['shipment_id'] ) || ! isset( $_POST['item_id'] ) ) {
+ wp_die( -1 );
+ }
+
+ $response_error = array(
+ 'success' => false,
+ 'message' => _x( 'There was an error processing the shipment', 'shipments', 'woocommerce-germanized' ),
+ );
+
+ $response = array(
+ 'success' => true,
+ 'message' => '',
+ 'max_quantity' => '',
+ 'item_id' => '',
+ );
+
+ $shipment_id = absint( $_POST['shipment_id'] );
+ $item_id = absint( $_POST['item_id'] );
+ $quantity = isset( $_POST['quantity'] ) ? (int) $_POST['quantity'] : 1;
+ $quantity = $quantity <= 0 ? 1 : $quantity;
+
+ if ( ! $shipment = wc_gzd_get_shipment( $shipment_id ) ) {
+ wp_send_json( $response_error );
+ }
+
+ if ( ! $order = $shipment->get_order() ) {
+ wp_send_json( $response_error );
+ }
+
+ if ( ! $order_shipment = wc_gzd_get_shipment_order( $order ) ) {
+ wp_send_json( $response_error );
+ }
+
+ // Make sure the shipment order gets notified about changes
+ if ( ! $shipment = $order_shipment->get_shipment( $shipment_id ) ) {
+ wp_send_json( $response_error );
+ }
+
+ if ( ! $item = $shipment->get_item( $item_id ) ) {
+ wp_send_json( $response_error );
+ }
+
+ if ( ! $order_item = $order->get_item( $item->get_order_item_id() ) ) {
+ wp_send_json( $response_error );
+ }
+
+ static::refresh_shipments( $order_shipment );
+
+ $quantity_max = 0;
+
+ if ( 'return' === $shipment->get_type() ) {
+ $quantity_max = $order_shipment->get_item_quantity_left_for_returning( $item->get_order_item_id(), array(
+ 'exclude_current_shipment' => true,
+ 'shipment_id' => $shipment->get_id(),
+ ) );
+ } else {
+ $quantity_max = $order_shipment->get_item_quantity_left_for_shipping( $order_item, array(
+ 'exclude_current_shipment' => true,
+ 'shipment_id' => $shipment->get_id(),
+ ) );
+ }
+
+ $response['item_id'] = $item_id;
+ $response['max_quantity'] = $quantity_max;
+
+ if ( $quantity > $quantity_max ) {
+ $quantity = $quantity_max;
+ }
+
+ $shipment->update_item_quantity( $item_id, $quantity );
+
+ $response['fragments'] = array(
+ '#shipment-' . $shipment->get_id() . ' .item-count:first' => self::get_item_count_html( $shipment, $order_shipment ),
+ );
+
+ self::send_json_success( $response, $order_shipment, $shipment );
+ }
+
+ /**
+ * @param $response
+ * @param Order $order_shipment
+ * @param Shipment|bool $shipment
+ */
+ private static function send_json_success( $response, $order_shipment, $current_shipment = false ) {
+
+ $available_items = $order_shipment->get_available_items_for_shipment();
+ $response['shipments'] = array();
+
+ foreach( $order_shipment->get_shipments() as $shipment ) {
+ $shipment->set_order_shipment( $order_shipment );
+
+ $response['shipments'][ $shipment->get_id() ] = array(
+ 'is_editable' => $shipment->is_editable(),
+ 'needs_items' => $shipment->needs_items( array_keys( $available_items ) ),
+ 'weight' => wc_format_localized_decimal( $shipment->get_content_weight() ),
+ 'length' => wc_format_localized_decimal( $shipment->get_content_length() ),
+ 'width' => wc_format_localized_decimal( $shipment->get_content_width() ),
+ 'height' => wc_format_localized_decimal( $shipment->get_content_height() ),
+ 'total_weight' => wc_format_localized_decimal( $shipment->get_total_weight() ),
+ );
+ }
+
+ $response['order_needs_new_shipments'] = $order_shipment->needs_shipping();
+ $response['order_needs_new_returns'] = $order_shipment->needs_return();
+
+ if ( $current_shipment ) {
+ if ( ! isset( $response['fragments'] ) ) {
+ $response['fragments'] = array();
+ }
+
+ $response['needs_packaging_refresh'] = true;
+ $response['shipment_id'] = $current_shipment->get_id();
+ $response['fragments']['#shipment-' . $current_shipment->get_id() . ' .shipment-packaging-select'] = self::get_packaging_select_html( $current_shipment );
+ }
+
+ wp_send_json( $response );
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Api.php b/packages/woocommerce-germanized-shipments/src/Api.php
new file mode 100644
index 000000000..a9ada6cbd
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Api.php
@@ -0,0 +1,329 @@
+get_data();
+ $response_order_data['shipments'] = array();
+ $context = 'view';
+
+ if ( $order ) {
+ $order_shipment = wc_gzd_get_shipment_order( $order );
+ $shipments = $order_shipment->get_shipments();
+
+ if ( ! empty( $shipments ) ) {
+
+ foreach( $shipments as $shipment ) {
+
+ $item_data = array();
+
+ foreach( $shipment->get_items() as $item ) {
+ $item_data[] = array(
+ 'id' => $item->get_id(),
+ 'name' => $item->get_name( $context ),
+ 'order_item_id' => $item->get_order_item_id( $context ),
+ 'product_id' => $item->get_product_id( $context ),
+ 'quantity' => $item->get_quantity( $context ),
+ );
+ }
+
+ $shipment_data = array(
+ 'id' => $shipment->get_id(),
+ 'date_created' => wc_rest_prepare_date_response( $shipment->get_date_created( $context ), false ),
+ 'date_created_gmt' => wc_rest_prepare_date_response( $shipment->get_date_created( $context ) ),
+ 'date_sent' => wc_rest_prepare_date_response( $shipment->get_date_sent( $context ), false ),
+ 'date_sent_gmt' => wc_rest_prepare_date_response( $shipment->get_date_sent( $context ) ),
+ 'est_delivery_date' => wc_rest_prepare_date_response( $shipment->get_est_delivery_date( $context ), false ),
+ 'est_delivery_date_gmt' => wc_rest_prepare_date_response( $shipment->get_est_delivery_date( $context ) ),
+ 'total' => wc_format_decimal( $shipment->get_total(), $request['dp'] ),
+ 'weight' => $shipment->get_weight( $context ),
+ 'status' => $shipment->get_status(),
+ 'tracking_id' => $shipment->get_tracking_id(),
+ 'tracking_url' => $shipment->get_tracking_url(),
+ 'shipping_provider' => $shipment->get_shipping_provider(),
+ 'dimensions' => array(
+ 'length' => $shipment->get_length( $context ),
+ 'width' => $shipment->get_width( $context ),
+ 'height' => $shipment->get_height( $context ),
+ ),
+ 'address' => $shipment->get_address( $context ),
+ 'items' => $item_data,
+ );
+
+ $response_order_data['shipments'][] = $shipment_data;
+ }
+ }
+ }
+
+ $response->set_data( $response_order_data );
+
+ return $response;
+ }
+
+ public static function order_shipments_schema( $schema ) {
+ $weight_unit = get_option( 'woocommerce_weight_unit' );
+ $dimension_unit = get_option( 'woocommerce_dimension_unit' );
+
+ $schema['shipments'] = array(
+ 'description' => _x( 'List of shipments.', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'array',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ 'items' => array(
+ 'type' => 'object',
+ 'properties' => array(
+ 'id' => array(
+ 'description' => _x( 'Shipment ID.', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'integer',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ 'status' => array(
+ 'description' => _x( 'Shipment status.', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit' ),
+ 'enum' => self::get_shipment_statuses(),
+ 'readonly' => true,
+ ),
+ 'tracking_id' => array(
+ 'description' => _x( 'Shipment tracking id.', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ 'tracking_url' => array(
+ 'description' => _x( 'Shipment tracking url.', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ 'shipping_provider' => array(
+ 'description' => _x( 'Shipment shipping provider.', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ 'date_created' => array(
+ 'description' => _x( "The date the shipment was created, in the site's timezone.", 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'date-time',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ 'date_created_gmt' => array(
+ 'description' => _x( 'The date the shipment was created, as GMT.', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'date-time',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ 'date_sent' => array(
+ 'description' => _x( "The date the shipment was sent, in the site's timezone.", 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'date-time',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ 'date_sent_gmt' => array(
+ 'description' => _x( 'The date the shipment was sent, as GMT.', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'date-time',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ 'est_delivery_date' => array(
+ 'description' => _x( "The estimated delivery date of the shipment, in the site's timezone.", 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'date-time',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ 'est_delivery_date_gmt' => array(
+ 'description' => _x( 'The estimated delivery date of the shipment, as GMT.', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'date-time',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ 'weight' => array(
+ /* translators: %s: weight unit */
+ 'description' => sprintf( _x( 'Shipment weight (%s).', 'shipments', 'woocommerce-germanized' ), $weight_unit ),
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ 'dimensions' => array(
+ 'description' => _x( 'Shipment dimensions.', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'object',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ 'properties' => array(
+ 'length' => array(
+ /* translators: %s: dimension unit */
+ 'description' => sprintf( _x( 'Shipment length (%s).', 'shipments', 'woocommerce-germanized' ), $dimension_unit ),
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ 'width' => array(
+ /* translators: %s: dimension unit */
+ 'description' => sprintf( _x( 'Shipment width (%s).', 'shipments', 'woocommerce-germanized' ), $dimension_unit ),
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ 'height' => array(
+ /* translators: %s: dimension unit */
+ 'description' => sprintf( _x( 'Shipment height (%s).', 'shipments', 'woocommerce-germanized' ), $dimension_unit ),
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ ),
+ ),
+ 'address' => array(
+ 'description' => _x( 'Shipping address.', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'object',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ 'properties' => array(
+ 'first_name' => array(
+ 'description' => _x( 'First name.', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ 'last_name' => array(
+ 'description' => _x( 'Last name.', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ 'company' => array(
+ 'description' => _x( 'Company name.', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ 'address_1' => array(
+ 'description' => _x( 'Address line 1', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ 'address_2' => array(
+ 'description' => _x( 'Address line 2', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ 'city' => array(
+ 'description' => _x( 'City name.', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ 'state' => array(
+ 'description' => _x( 'ISO code or name of the state, province or district.', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ 'postcode' => array(
+ 'description' => _x( 'Postal code.', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ 'country' => array(
+ 'description' => _x( 'Country code in ISO 3166-1 alpha-2 format.', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ ),
+ ),
+ 'items' => array(
+ 'description' => _x( 'Shipment items.', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'array',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ 'items' => array(
+ 'type' => 'object',
+ 'properties' => array(
+ 'id' => array(
+ 'description' => _x( 'Item ID.', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'integer',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ 'name' => array(
+ 'description' => _x( 'Item name.', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'mixed',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ 'order_item_id' => array(
+ 'description' => _x( 'Order Item ID.', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'integer',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ 'product_id' => array(
+ 'description' => _x( 'Product ID.', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'mixed',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ 'quantity' => array(
+ 'description' => _x( 'Quantity.', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'integer',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ ),
+ ),
+ ),
+ ),
+ ),
+ );
+
+ return $schema;
+ }
+
+ public static function register_controllers( $controller ) {
+ $controller['wc/v3']['shipments'] = 'Vendidero\Germanized\Shipments\Rest\Shipments.php';
+
+ return $controller;
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Automation.php b/packages/woocommerce-germanized-shipments/src/Automation.php
new file mode 100644
index 000000000..37d556412
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Automation.php
@@ -0,0 +1,185 @@
+get_simple_shipments() as $shipment ) {
+
+ if ( ! $shipment->has_status( array( 'shipped', 'delivered' ) ) ) {
+ $shipment->update_status( 'shipped' );
+ }
+ }
+ }
+ }
+ }
+
+ /**
+ * Mark the order as completed if the order is fully shipped.
+ *
+ * @param $order_id
+ */
+ public static function mark_order_completed( $order_id ) {
+ if ( $order = wc_get_order( $order_id ) ) {
+
+ /**
+ * By default do not mark orders (via invoice) as completed after shipped as
+ * the order will be shipped before the invoice was paid.
+ */
+ $mark_as_completed = ! in_array( $order->get_payment_method(), array( 'invoice' ) ) ? true : false;
+
+ /**
+ * Filter that allows to conditionally disable automatic
+ * order completion after the shipments are marked as shipped.
+ *
+ * @param boolean $mark_as_completed Whether to mark the order as completed or not.
+ * @param integer $order_id The order id.
+ *
+ * @since 3.2.3
+ * @package Vendidero/Germanized/Shipments
+ */
+ if ( ! apply_filters( 'woocommerce_gzd_shipment_order_mark_as_completed', $mark_as_completed, $order_id ) ) {
+ return;
+ }
+
+ /**
+ * Filter to adjust the new status of an order after all it's required
+ * shipments have been marked as shipped. Does only take effect if the automation option has been set
+ * within the shipment settings.
+ *
+ * @param string $status The order status to be used.
+ * @param integer $order_id The order id.
+ *
+ * @since 3.0.5
+ * @package Vendidero/Germanized/Shipments
+ */
+ $order->update_status( apply_filters( 'woocommerce_gzd_shipment_order_completed_status', 'completed', $order_id ) , _x( 'Order is fully shipped.', 'shipments', 'woocommerce-germanized' ) );
+ }
+ }
+
+ public static function create_shipments( $order_id, $enable_auto_filter = true ) {
+ $shipment_status = Package::get_setting( 'auto_default_status' );
+
+ if ( empty( $shipment_status ) ) {
+ $shipment_status = 'processing';
+ }
+
+ /**
+ * Filter to disable automatically creating shipments for a specific order.
+ *
+ * @param string $enable Whether to create or not create shipments.
+ * @param integer $order_id The order id.
+ *
+ * @since 3.1.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ if ( $enable_auto_filter && ! apply_filters( 'woocommerce_gzd_auto_create_shipments_for_order', true, $order_id ) ) {
+ return;
+ }
+
+ if ( $order_shipment = wc_gzd_get_shipment_order( $order_id ) ) {
+ if ( ! apply_filters( 'woocommerce_gzd_auto_create_custom_shipments_for_order', false, $order_id ) ) {
+ $shipments = $order_shipment->get_simple_shipments();
+
+ foreach ( $shipments as $shipment ) {
+ if ( $shipment->is_editable() ) {
+ $shipment->sync();
+ $shipment->sync_items();
+ $shipment->save();
+ }
+ }
+
+ if ( $order_shipment->needs_shipping() ) {
+ $shipment = wc_gzd_create_shipment( $order_shipment, array( 'props' => array( 'status' => $shipment_status ) ) );
+
+ if ( ! is_wp_error( $shipment ) ) {
+ $order_shipment->add_shipment( $shipment );
+ }
+ }
+ }
+
+ do_action( 'woocommerce_gzd_after_auto_create_shipments_for_order', $order_id, $shipment_status );
+ }
+ }
+
+ public static function maybe_create_shipments( $order_id ) {
+
+ // Make sure that MetaBox is saved before we process automation
+ if ( self::is_admin_edit_order_request() ) {
+ add_action( 'woocommerce_process_shop_order_meta', array( __CLASS__, 'create_shipments' ), 70 );
+ } else {
+ self::create_shipments( $order_id );
+ }
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/DataStores/Label.php b/packages/woocommerce-germanized-shipments/src/DataStores/Label.php
new file mode 100644
index 000000000..6f014f162
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/DataStores/Label.php
@@ -0,0 +1,556 @@
+set_date_created( current_time( 'timestamp', true ) );
+
+ $data = array(
+ 'label_number' => $label->get_number(),
+ 'label_shipment_id' => $label->get_shipment_id(),
+ 'label_path' => $label->get_path(),
+ 'label_product_id' => $label->get_product_id(),
+ 'label_type' => $label->get_type(),
+ 'label_shipping_provider' => $label->get_shipping_provider(),
+ 'label_parent_id' => $label->get_parent_id(),
+ 'label_date_created' => gmdate( 'Y-m-d H:i:s', $label->get_date_created( 'edit' )->getOffsetTimestamp() ),
+ 'label_date_created_gmt' => gmdate( 'Y-m-d H:i:s', $label->get_date_created( 'edit' )->getTimestamp() ),
+ );
+
+ $wpdb->insert(
+ $wpdb->gzd_shipment_labels,
+ $data
+ );
+
+ $label_id = $wpdb->insert_id;
+
+ if ( $label_id ) {
+ $label->set_id( $label_id );
+
+ $this->save_label_data( $label );
+
+ $label->save_meta_data();
+ $label->apply_changes();
+
+ $this->clear_caches( $label );
+
+ $hook_postfix = $this->get_hook_postfix( $label );
+
+ /**
+ * Action fires when a new DHL label has been created.
+ *
+ * The dynamic portion of this hook, `$hook_postfix` refers to the
+ * label type e.g. return in case it is not a simple label.
+ *
+ * @param integer $label_id The label id.
+ * @param Label $label The label instance.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/DHL
+ */
+ do_action( "woocommerce_gzd_shipment_{$hook_postfix}label_created", $label_id, $label );
+ }
+ }
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Labels\Label $label
+ *
+ * @return string
+ */
+ protected function get_hook_postfix( $label ) {
+ $prefix = $label->get_shipping_provider() . '_';
+
+ if ( 'simple' !== $label->get_type() ) {
+ $prefix = $prefix . $label->get_type() . '_';
+ }
+
+ return $prefix;
+ }
+
+ /**
+ * Method to update a label in the database.
+ *
+ * @param \Vendidero\Germanized\Shipments\Labels\Label $label Label object.
+ */
+ public function update( &$label ) {
+ global $wpdb;
+
+ $updated_props = array();
+ $core_props = $this->core_props;
+ $changed_props = array_keys( $label->get_changes() );
+ $label_data = array();
+
+ foreach ( $changed_props as $prop ) {
+
+ if ( ! in_array( $prop, $core_props, true ) ) {
+ continue;
+ }
+
+ switch( $prop ) {
+ case "date_created":
+ $label_data[ 'label' . $prop ] = gmdate( 'Y-m-d H:i:s', $label->{'get_' . $prop}( 'edit' )->getOffsetTimestamp() );
+ $label_data[ 'label_' . $prop . '_gmt' ] = gmdate( 'Y-m-d H:i:s', $label->{'get_' . $prop}( 'edit' )->getTimestamp() );
+ break;
+ default:
+ if ( is_callable( array( $label, 'get_' . $prop ) ) ) {
+ $label_data[ 'label_' . $prop ] = $label->{'get_' . $prop}( 'edit' );
+ }
+ break;
+ }
+ }
+
+ if ( ! empty( $label_data ) ) {
+ $wpdb->update(
+ $wpdb->gzd_shipment_labels,
+ $label_data,
+ array( 'label_id' => $label->get_id() )
+ );
+ }
+
+ $this->save_label_data( $label );
+ $label->save_meta_data();
+
+ $label->apply_changes();
+ $this->clear_caches( $label );
+
+ $hook_postfix = $this->get_hook_postfix( $label );
+
+ /**
+ * Action fires after a DHL label has been updated in the DB.
+ *
+ * The dynamic portion of this hook, `$hook_postfix` refers to the
+ * label type e.g. return in case it is not a simple label.
+ *
+ * @param integer $label_id The label id.
+ * @param Label $label The label instance.
+ * @param array $changed_props Properties that have been changed.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/DHL
+ */
+ do_action( "woocommerce_gzd_shipment_{$hook_postfix}label_updated", $label->get_id(), $label, $changed_props );
+ }
+
+ /**
+ * Remove a shipment from the database.
+ *
+ * @since 3.0.0
+ * @param \Vendidero\Germanized\Shipments\Labels\Label $label Label object.
+ * @param bool $force_delete Unused param.
+ */
+ public function delete( &$label, $force_delete = false ) {
+ global $wpdb;
+
+ if ( $file = $label->get_file() ) {
+ wp_delete_file( $file );
+ }
+
+ /*
+ * Delete additional files e.g. export documents
+ */
+ foreach( $label->get_additional_file_types() as $file_type ) {
+ if ( $file = $label->get_file( $file_type ) ) {
+ wp_delete_file( $file );
+ }
+ }
+
+ $wpdb->delete( $wpdb->gzd_shipment_labels, array( 'label_id' => $label->get_id() ), array( '%d' ) );
+ $wpdb->delete( $wpdb->gzd_shipment_labelmeta, array( 'gzd_shipment_label_id' => $label->get_id() ), array( '%d' ) );
+
+ $this->clear_caches( $label );
+
+ $children = $label->get_children();
+
+ foreach( $children as $child ) {
+ $child->delete( $force_delete );
+ }
+
+ $hook_postfix = $this->get_hook_postfix( $label );
+
+ /**
+ * Action fires after a DHL label has been deleted from DB.
+ *
+ * The dynamic portion of this hook, `$hook_postfix` refers to the
+ * label type e.g. return in case it is not a simple label.
+ *
+ * @param integer $label_id The label id.
+ * @param \Vendidero\Germanized\DHL\Label $label The label object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/DHL
+ */
+ do_action( "woocommerce_gzd_shipment_{$hook_postfix}label_deleted", $label->get_id(), $label );
+ }
+
+ /**
+ * Read a shipment from the database.
+ *
+ * @since 3.0.0
+ *
+ * @param \Vendidero\Germanized\Shipments\Labels\Label $label Label object.
+ *
+ * @throws Exception Throw exception if invalid shipment.
+ */
+ public function read( &$label ) {
+ global $wpdb;
+
+ $data = $wpdb->get_row(
+ $wpdb->prepare(
+ "SELECT * FROM {$wpdb->gzd_shipment_labels} WHERE label_id = %d LIMIT 1",
+ $label->get_id()
+ )
+ );
+
+ if ( $data ) {
+ $label->set_props(
+ array(
+ 'shipment_id' => $data->label_shipment_id,
+ 'number' => $data->label_number,
+ 'path' => $data->label_path,
+ 'parent_id' => $data->label_parent_id,
+ 'shipping_provider' => $data->label_shipping_provider,
+ 'product_id' => $data->label_product_id,
+ 'date_created' => 0 < $data->label_date_created_gmt ? wc_string_to_timestamp( $data->label_date_created_gmt ) : null,
+ )
+ );
+
+ $this->read_label_data( $label );
+ $label->read_meta_data();
+ $label->set_object_read( true );
+
+ $hook_postfix = $this->get_hook_postfix( $label );
+
+ /**
+ * Action fires after reading a DHL label from DB.
+ *
+ * The dynamic portion of this hook, `$hook_postfix` refers to the
+ * label type e.g. return in case it is not a simple label.
+ *
+ * @param \Vendidero\Germanized\DHL\Label $label The label object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/DHL
+ */
+ do_action( "woocommerce_gzd_shipment_{$hook_postfix}label_loaded", $label );
+ } else {
+ throw new Exception( _x( 'Invalid label.', 'shipments', 'woocommerce-germanized' ) );
+ }
+ }
+
+ /**
+ * Clear any caches.
+ *
+ * @param \Vendidero\Germanized\Shipments\Labels\Label $label Label object.
+ * @since 3.0.0
+ */
+ protected function clear_caches( &$label ) {
+ wp_cache_delete( $label->get_id(), $this->meta_type . '_meta' );
+ }
+
+ /*
+ |--------------------------------------------------------------------------
+ | Additional Methods
+ |--------------------------------------------------------------------------
+ */
+
+ /**
+ * Get the label type based on label ID.
+ *
+ * @param int $label_id Label id.
+ * @return bool|mixed
+ */
+ public function get_label_data( $label_id ) {
+ global $wpdb;
+
+ $data = $wpdb->get_row(
+ $wpdb->prepare(
+ "SELECT label_type, label_shipping_provider FROM {$wpdb->gzd_shipment_labels} WHERE label_id = %d LIMIT 1",
+ $label_id
+ )
+ );
+
+ if ( ! empty( $data ) ) {
+ return (object) array(
+ 'shipping_provider' => $data->label_shipping_provider,
+ 'type' => $data->label_type
+ );
+ }
+
+ return false;
+ }
+
+ /**
+ * Read extra data associated with the shipment.
+ *
+ * @param \Vendidero\Germanized\Shipments\Labels\Label $label Label object.
+ * @since 3.0.0
+ */
+ protected function read_label_data( &$label ) {
+ $props = array();
+ $meta_keys = $this->internal_meta_keys;
+
+ foreach ( $label->get_extra_data_keys() as $key ) {
+ $meta_keys[] = '_' . $key;
+ }
+
+ foreach( $meta_keys as $meta_key ) {
+ $props[ substr( $meta_key, 1 ) ] = get_metadata( $this->meta_type, $label->get_id(), $meta_key, true );
+ }
+
+ $label->set_props( $props );
+ }
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Labels\Label $label
+ */
+ protected function save_label_data( &$label ) {
+ $updated_props = array();
+ $meta_key_to_props = array();
+
+ foreach( $this->internal_meta_keys as $meta_key ) {
+ $prop_name = substr( $meta_key, 1 );
+
+ if ( in_array( $prop_name, $this->core_props ) ) {
+ continue;
+ }
+
+ $meta_key_to_props[ $meta_key ] = $prop_name;
+ }
+
+ // Make sure to take extra data (like product url or text for external products) into account.
+ $extra_data_keys = $label->get_extra_data_keys();
+
+ foreach ( $extra_data_keys as $key ) {
+ $meta_key_to_props[ '_' . $key ] = $key;
+ }
+
+ $props_to_update = $this->get_props_to_update( $label, $meta_key_to_props, $this->meta_type );
+
+ foreach ( $props_to_update as $meta_key => $prop ) {
+
+ if ( ! is_callable( array( $label, "get_$prop" ) ) ) {
+ continue;
+ }
+
+ $value = $label->{"get_$prop"}( 'edit' );
+ $value = is_string( $value ) ? wp_slash( $value ) : $value;
+
+ if ( is_bool( $value ) ) {
+ $value = wc_bool_to_string( $value );
+ }
+
+ $updated = $this->update_or_delete_meta( $label, $meta_key, $value );
+
+ if ( $updated ) {
+ $updated_props[] = $prop;
+ }
+ }
+
+ /**
+ * Action fires after DHL label meta properties have been updated.
+ *
+ * @param \Vendidero\Germanized\Shipments\Labels\Label $label The label object.
+ * @param array $updated_props The updated properties.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/DHL
+ */
+ do_action( 'woocommerce_gzd_shipment_label_object_updated_props', $label, $updated_props );
+ }
+
+ /**
+ * Update meta data in, or delete it from, the database.
+ *
+ * Avoids storing meta when it's either an empty string or empty array.
+ * Other empty values such as numeric 0 and null should still be stored.
+ * Data-stores can force meta to exist using `must_exist_meta_keys`.
+ *
+ * Note: WordPress `get_metadata` function returns an empty string when meta data does not exist.
+ *
+ * @param WC_Data $object The WP_Data object (WC_Coupon for coupons, etc).
+ * @param string $meta_key Meta key to update.
+ * @param mixed $meta_value Value to save.
+ *
+ * @since 3.6.0 Added to prevent empty meta being stored unless required.
+ *
+ * @return bool True if updated/deleted.
+ */
+ protected function update_or_delete_meta( $object, $meta_key, $meta_value ) {
+ if ( in_array( $meta_value, array( array(), '' ), true ) && ! in_array( $meta_key, $this->must_exist_meta_keys, true ) ) {
+ $updated = delete_metadata( $this->meta_type, $object->get_id(), $meta_key );
+ } else {
+ $updated = update_metadata( $this->meta_type, $object->get_id(), $meta_key, $meta_value );
+ }
+
+ return (bool) $updated;
+ }
+
+ /**
+ * Get valid WP_Query args from a WC_Order_Query's query variables.
+ *
+ * @since 3.0.6
+ * @param array $query_vars query vars from a WC_Order_Query.
+ * @return array
+ */
+ protected function get_wp_query_args( $query_vars ) {
+ global $wpdb;
+
+ $wp_query_args = parent::get_wp_query_args( $query_vars );
+
+ // Force type to be existent
+ if ( isset( $query_vars['type'] ) ) {
+ $wp_query_args['type'] = $query_vars['type'];
+ }
+
+ if ( ! isset( $wp_query_args['date_query'] ) ) {
+ $wp_query_args['date_query'] = array();
+ }
+
+ if ( ! isset( $wp_query_args['meta_query'] ) ) {
+ $wp_query_args['meta_query'] = array();
+ }
+
+ // Allow Woo to treat these props as date query compatible
+ $date_queries = array(
+ 'date_created' => 'post_date',
+ );
+
+ foreach ( $date_queries as $query_var_key => $db_key ) {
+ if ( isset( $query_vars[ $query_var_key ] ) && '' !== $query_vars[ $query_var_key ] ) {
+
+ // Remove any existing meta queries for the same keys to prevent conflicts.
+ $existing_queries = wp_list_pluck( $wp_query_args['meta_query'], 'key', true );
+ $meta_query_index = array_search( $db_key, $existing_queries, true );
+
+ if ( false !== $meta_query_index ) {
+ unset( $wp_query_args['meta_query'][ $meta_query_index ] );
+ }
+
+ $wp_query_args = $this->parse_date_for_wp_query( $query_vars[ $query_var_key ], $db_key, $wp_query_args );
+ }
+ }
+
+ /**
+ * Replace date query columns after Woo parsed dates.
+ * Include table name because otherwise WP_Date_Query won't accept our custom column.
+ */
+ if ( isset( $wp_query_args['date_query'] ) ) {
+ foreach( $wp_query_args['date_query'] as $key => $date_query ) {
+ if ( isset( $date_query['column'] ) && in_array( $date_query['column'], $date_queries, true ) ) {
+ $wp_query_args['date_query'][ $key ]['column'] = $wpdb->gzd_shipment_labels . '.label_' . array_search( $date_query['column'], $date_queries, true );
+ }
+ }
+ }
+
+ if ( ! isset( $query_vars['paginate'] ) || ! $query_vars['paginate'] ) {
+ $wp_query_args['no_found_rows'] = true;
+ }
+
+ /**
+ * Filter to adjust the DHL label query args after parsing them.
+ *
+ * @param array $wp_query_args Parsed query arguments.
+ * @param array $query_vars Original query arguments.
+ * @param Label $data_store The label data store.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/DHL
+ */
+ return apply_filters( 'woocommerce_gzd_shipment_label_data_store_get_labels_query', $wp_query_args, $query_vars, $this );
+ }
+
+ public function get_query_args( $query_vars ) {
+ return $this->get_wp_query_args( $query_vars );
+ }
+
+ /**
+ * Table structure is slightly different between meta types, this function will return what we need to know.
+ *
+ * @since 3.0.0
+ * @return array Array elements: table, object_id_field, meta_id_field
+ */
+ protected function get_db_info() {
+ global $wpdb;
+
+ $meta_id_field = 'meta_id'; // for some reason users calls this umeta_id so we need to track this as well.
+ $table = $wpdb->gzd_shipment_labelmeta;
+ $object_id_field = $this->meta_type . '_id';
+
+ if ( ! empty( $this->object_id_field_for_meta ) ) {
+ $object_id_field = $this->object_id_field_for_meta;
+ }
+
+ return array(
+ 'table' => $table,
+ 'object_id_field' => $object_id_field,
+ 'meta_id_field' => $meta_id_field,
+ );
+ }
+
+ public function get_label_count() {
+ global $wpdb;
+
+ return absint( $wpdb->get_var( "SELECT COUNT( * ) FROM {$wpdb->gzd_shipment_labels}" ) );
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/DataStores/Packaging.php b/packages/woocommerce-germanized-shipments/src/DataStores/Packaging.php
new file mode 100644
index 000000000..e618cdefc
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/DataStores/Packaging.php
@@ -0,0 +1,628 @@
+set_date_created( current_time( 'timestamp', true ) );
+
+ $data = array(
+ 'packaging_type' => $packaging->get_type(),
+ 'packaging_description' => $packaging->get_description(),
+ 'packaging_weight' => $packaging->get_weight(),
+ 'packaging_max_content_weight' => $packaging->get_max_content_weight(),
+ 'packaging_length' => $packaging->get_length(),
+ 'packaging_width' => $packaging->get_width(),
+ 'packaging_height' => $packaging->get_height(),
+ 'packaging_order' => $packaging->get_order(),
+ 'packaging_date_created' => gmdate( 'Y-m-d H:i:s', $packaging->get_date_created( 'edit' )->getOffsetTimestamp() ),
+ 'packaging_date_created_gmt' => gmdate( 'Y-m-d H:i:s', $packaging->get_date_created( 'edit' )->getTimestamp() ),
+ );
+
+ $wpdb->insert(
+ $wpdb->gzd_packaging,
+ $data
+ );
+
+ $packaging_id = $wpdb->insert_id;
+
+ if ( $packaging_id ) {
+ $packaging->set_id( $packaging_id );
+
+ $this->save_packaging_data( $packaging );
+
+ $packaging->save_meta_data();
+ $packaging->apply_changes();
+
+ $this->clear_caches( $packaging );
+
+ /**
+ * Action that indicates that a new Packaging has been created in the DB.
+ *
+ * @param integer $packaging_id The packaging id.
+ * @param \Vendidero\Germanized\Shipments\Packaging $packaging The packaging instance.
+ *
+ * @since 3.3.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( "woocommerce_gzd_new_packaging", $packaging_id, $packaging );
+ }
+ }
+
+ /**
+ * Method to update a packaging in the database.
+ *
+ * @param \Vendidero\Germanized\Shipments\Packaging $packaging Packaging object.
+ */
+ public function update( &$packaging ) {
+ global $wpdb;
+
+ $updated_props = array();
+ $core_props = $this->core_props;
+ $changed_props = array_keys( $packaging->get_changes() );
+ $packaging_data = array();
+
+ foreach ( $changed_props as $prop ) {
+
+ if ( ! in_array( $prop, $core_props, true ) ) {
+ continue;
+ }
+
+ switch( $prop ) {
+ case "date_created":
+ if ( is_callable( array( $packaging, 'get_' . $prop ) ) ) {
+ $packaging_data[ 'packaging_' . $prop ] = gmdate( 'Y-m-d H:i:s', $packaging->{'get_' . $prop}( 'edit' )->getOffsetTimestamp() );
+ $packaging_data[ 'packaging_' . $prop . '_gmt' ] = gmdate( 'Y-m-d H:i:s', $packaging->{'get_' . $prop}( 'edit' )->getTimestamp() );
+ }
+ break;
+ default:
+ if ( is_callable( array( $packaging, 'get_' . $prop ) ) ) {
+ $packaging_data[ 'packaging_' . $prop ] = $packaging->{'get_' . $prop}( 'edit' );
+ }
+ break;
+ }
+ }
+
+ if ( ! empty( $packaging_data ) ) {
+ $wpdb->update(
+ $wpdb->gzd_packaging,
+ $packaging_data,
+ array( 'packaging_id' => $packaging->get_id() )
+ );
+ }
+
+ $this->save_packaging_data( $packaging );
+
+ $packaging->save_meta_data();
+ $packaging->apply_changes();
+
+ $this->clear_caches( $packaging );
+
+ /**
+ * Action that indicates that a Packaging has been updated in the DB.
+ *
+ * @param integer $packaging_id The packaging id.
+ * @param \Vendidero\Germanized\Shipments\Packaging $packaging The packaging instance.
+ *
+ * @since 3.3.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( "woocommerce_gzd_packaging_updated", $packaging->get_id(), $packaging );
+ }
+
+ /**
+ * Remove a Packaging from the database.
+ *
+ * @since 3.0.0
+ * @param \Vendidero\Germanized\Shipments\Packaging $packaging Packaging object.
+ * @param bool $force_delete Unused param.
+ */
+ public function delete( &$packaging, $force_delete = false ) {
+ global $wpdb;
+
+ $wpdb->delete( $wpdb->gzd_packaging, array( 'packaging_id' => $packaging->get_id() ), array( '%d' ) );
+ $wpdb->delete( $wpdb->gzd_packagingmeta, array( 'gzd_packaging_id' => $packaging->get_id() ), array( '%d' ) );
+
+ $this->clear_caches( $packaging );
+
+ /**
+ * Action that indicates that a Packaging has been deleted from the DB.
+ *
+ * @param integer $packaging_id The packaging id.
+ * @param \Vendidero\Germanized\Shipments\Packaging $packaging The packaging instance.
+ *
+ * @since 3.3.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( "woocommerce_gzd_packaging_deleted", $packaging->get_id(), $packaging );
+ }
+
+ /**
+ * Read a Packaging from the database.
+ *
+ * @since 3.3.0
+ *
+ * @param \Vendidero\Germanized\Shipments\Packaging $packaging Packaging object.
+ *
+ * @throws Exception Throw exception if invalid packaging.
+ */
+ public function read( &$packaging ) {
+ global $wpdb;
+
+ $data = $wpdb->get_row(
+ $wpdb->prepare(
+ "SELECT * FROM {$wpdb->gzd_packaging} WHERE packaging_id = %d LIMIT 1",
+ $packaging->get_id()
+ )
+ );
+
+ if ( $data ) {
+ $packaging->set_props(
+ array(
+ 'type' => $data->packaging_type,
+ 'description' => $data->packaging_description,
+ 'weight' => $data->packaging_weight,
+ 'max_content_weight' => $data->packaging_max_content_weight,
+ 'length' => $data->packaging_length,
+ 'width' => $data->packaging_width,
+ 'height' => $data->packaging_height,
+ 'order' => $data->packaging_order,
+ 'date_created' => 0 < $data->packaging_date_created_gmt ? wc_string_to_timestamp( $data->packaging_date_created_gmt ) : null,
+ )
+ );
+
+ $this->read_packaging_data( $packaging );
+
+ $packaging->read_meta_data();
+ $packaging->set_object_read( true );
+
+ /**
+ * Action that indicates that a Packaging has been loaded from DB.
+ *
+ * @param \Vendidero\Germanized\Shipments\Packaging $packaging The Packaging object.
+ *
+ * @since 3.3.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( "woocommerce_gzd_packaging_loaded", $packaging );
+ } else {
+ throw new Exception( _x( 'Invalid packaging.', 'shipments', 'woocommerce-germanized' ) );
+ }
+ }
+
+ /**
+ * Clear any caches.
+ *
+ * @param \Vendidero\Germanized\Shipments\Packaging $packaging Packaging object.
+ * @since 3.0.0
+ */
+ protected function clear_caches( &$packaging ) {
+ wp_cache_delete( $packaging->get_id(), $this->meta_type . '_meta' );
+ wp_cache_delete( 'packaging-list', 'packaging' );
+ }
+
+ /*
+ |--------------------------------------------------------------------------
+ | Additional Methods
+ |--------------------------------------------------------------------------
+ */
+
+ /**
+ * Get the packaging type based on ID.
+ *
+ * @param int $packaging_id Packaging id.
+ * @return string
+ */
+ public function get_packaging_type( $packing_id ) {
+ global $wpdb;
+
+ $type = $wpdb->get_col(
+ $wpdb->prepare(
+ "SELECT packaging_type FROM {$wpdb->gzd_packaging} WHERE packaging_id = %d LIMIT 1",
+ $packing_id
+ )
+ );
+
+ return ! empty( $type ) ? $type[0] : false;
+ }
+
+ /**
+ * Read extra data associated with the Packaging.
+ *
+ * @param \Vendidero\Germanized\Shipments\Packaging $packaging Packaging object.
+ * @since 3.0.0
+ */
+ protected function read_packaging_data( &$packaging ) {
+ $props = array();
+
+ foreach( $this->internal_meta_keys as $meta_key ) {
+ $props[ substr( $meta_key, 1 ) ] = get_metadata( 'gzd_packaging', $packaging->get_id(), $meta_key, true );
+ }
+
+ $packaging->set_props( $props );
+ }
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Packaging $packaging
+ */
+ protected function save_packaging_data( &$packaging ) {
+ $updated_props = array();
+ $meta_key_to_props = array();
+
+ foreach( $this->internal_meta_keys as $meta_key ) {
+ $prop_name = substr( $meta_key, 1 );
+
+ if ( in_array( $prop_name, $this->core_props ) ) {
+ continue;
+ }
+
+ $meta_key_to_props[ $meta_key ] = $prop_name;
+ }
+
+ $props_to_update = $this->get_props_to_update( $packaging, $meta_key_to_props, $this->meta_type );
+
+ foreach ( $props_to_update as $meta_key => $prop ) {
+
+ if ( ! is_callable( array( $packaging, "get_$prop" ) ) ) {
+ continue;
+ }
+
+ $value = $packaging->{"get_$prop"}( 'edit' );
+ $value = is_string( $value ) ? wp_slash( $value ) : $value;
+
+ $updated = $this->update_or_delete_meta( $packaging, $meta_key, $value );
+
+ if ( $updated ) {
+ $updated_props[] = $prop;
+ }
+ }
+
+ /**
+ * Action that fires after updating a Packaging's properties.
+ *
+ * @param \Vendidero\Germanized\Shipments\Packaging $packaging The Packaging object.
+ * @param array $changed_props The updated properties.
+ *
+ * @since 3.3.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( 'woocommerce_gzd_packaging_object_updated_props', $packaging, $updated_props );
+ }
+
+ /**
+ * Update meta data in, or delete it from, the database.
+ *
+ * Avoids storing meta when it's either an empty string or empty array.
+ * Other empty values such as numeric 0 and null should still be stored.
+ * Data-stores can force meta to exist using `must_exist_meta_keys`.
+ *
+ * Note: WordPress `get_metadata` function returns an empty string when meta data does not exist.
+ *
+ * @param WC_Data $object The WP_Data object (WC_Coupon for coupons, etc).
+ * @param string $meta_key Meta key to update.
+ * @param mixed $meta_value Value to save.
+ *
+ * @since 3.6.0 Added to prevent empty meta being stored unless required.
+ *
+ * @return bool True if updated/deleted.
+ */
+ protected function update_or_delete_meta( $object, $meta_key, $meta_value ) {
+ if ( in_array( $meta_value, array( array(), '' ), true ) && ! in_array( $meta_key, $this->must_exist_meta_keys, true ) ) {
+ $updated = delete_metadata( $this->meta_type, $object->get_id(), $meta_key );
+ } else {
+ $updated = update_metadata( $this->meta_type, $object->get_id(), $meta_key, $meta_value );
+ }
+
+ return (bool) $updated;
+ }
+
+ /**
+ * Get valid WP_Query args from a WC_Order_Query's query variables.
+ *
+ * @since 3.0.6
+ * @param array $query_vars query vars from a WC_Order_Query.
+ * @return array
+ */
+ protected function get_wp_query_args( $query_vars ) {
+ global $wpdb;
+
+ $wp_query_args = parent::get_wp_query_args( $query_vars );
+
+ // Force type to be existent
+ if ( isset( $query_vars['type'] ) ) {
+ $wp_query_args['type'] = $query_vars['type'];
+ }
+
+ if ( ! isset( $wp_query_args['date_query'] ) ) {
+ $wp_query_args['date_query'] = array();
+ }
+
+ if ( ! isset( $wp_query_args['meta_query'] ) ) {
+ $wp_query_args['meta_query'] = array();
+ }
+
+ // Allow Woo to treat these props as date query compatible
+ $date_queries = array(
+ 'date_created',
+ );
+
+ foreach ( $date_queries as $db_key ) {
+ if ( isset( $query_vars[ $db_key ] ) && '' !== $query_vars[ $db_key ] ) {
+
+ // Remove any existing meta queries for the same keys to prevent conflicts.
+ $existing_queries = wp_list_pluck( $wp_query_args['meta_query'], 'key', true );
+ $meta_query_index = array_search( $db_key, $existing_queries, true );
+
+ if ( false !== $meta_query_index ) {
+ unset( $wp_query_args['meta_query'][ $meta_query_index ] );
+ }
+
+ $date_query_args = $this->parse_date_for_wp_query( $query_vars[ $db_key ], 'post_date', array() );
+
+ /**
+ * Replace date query columns after Woo parsed dates.
+ * Include table name because otherwise WP_Date_Query won't accept our custom column.
+ */
+ if ( isset( $date_query_args['date_query'] ) && ! empty( $date_query_args['date_query'] ) ) {
+ $date_query = $date_query_args['date_query'][0];
+
+ if ( 'post_date' === $date_query['column'] ) {
+ $date_query['column'] = $wpdb->gzd_shipments . '.shipment_' . $db_key;
+ }
+
+ $wp_query_args['date_query'][] = $date_query;
+ }
+ }
+ }
+
+ if ( ! isset( $query_vars['paginate'] ) || ! $query_vars['paginate'] ) {
+ $wp_query_args['no_found_rows'] = true;
+ }
+
+ /**
+ * Filter to adjust Packaging query arguments after parsing.
+ *
+ * @param array $wp_query_args Array containing parsed query arguments.
+ * @param array $query_vars The original query arguments.
+ * @param Packaging $data_store The packaging data store object.
+ *
+ * @since 3.3.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_packaging_data_store_get_shipments_query', $wp_query_args, $query_vars, $this );
+ }
+
+ public function get_packaging_list( $args = array() ) {
+ global $wpdb;
+
+ $all_types = array_keys( wc_gzd_get_packaging_types() );
+
+ $args = wp_parse_args( $args, array(
+ 'type' => $all_types
+ ) );
+
+ if ( ! is_array( $args['type'] ) ) {
+ $args['type'] = array( $args['type'] );
+ }
+
+ $types = array_filter( wc_clean( $args['type'] ) );
+ $types = empty( $types ) ? $all_types : $types;
+
+ $query = "
+ SELECT packaging_id FROM {$wpdb->gzd_packaging}
+ WHERE packaging_type IN ( '" . implode( "','", $types ) . "' )
+ ORDER BY packaging_order ASC
+ ";
+
+ if ( $all_types === $types ) {
+ // Get from cache if available.
+ $results = wp_cache_get( 'packaging-list', 'packaging' );
+
+ if ( false === $results ) {
+ $results = $wpdb->get_results( $query );
+
+ wp_cache_set( 'packaging-list', $results, 'packaging' );
+ }
+ } else {
+ $results = $wpdb->get_results( $query );
+ }
+
+ foreach ( $results as $key => $packaging ) {
+ $results[ $key ] = wc_gzd_get_packaging( $packaging );
+ }
+
+ return $results;
+ }
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment
+ *
+ * @return \Vendidero\Germanized\Shipments\Packaging[]
+ */
+ public function find_available_packaging_for_shipment( $shipment ) {
+ $packaging_available = array();
+ $items_to_pack = $shipment->get_items_to_pack();
+
+ // Get from cache if available.
+ $results = wp_cache_get( 'available-packaging-' . $shipment->get_id(), 'shipments' );
+
+ if ( false === $results && sizeof( $items_to_pack ) > 0 ) {
+ $available_packaging_ids = array();
+
+ if ( Package::is_packing_supported() ) {
+ $packaging_list = wc_gzd_get_packaging_list();
+ $items = \DVDoug\BoxPacker\ItemList::fromArray( $items_to_pack );
+
+ foreach( $packaging_list as $packaging ) {
+ $box = new PackagingBox( $packaging );
+ $org_size = sizeof( $items_to_pack );
+
+ $packer = new VolumePacker( $box, $items );
+ $packed = $packer->pack();
+
+ if ( sizeof( $packed->getItems() ) === $org_size ) {
+ $packaging_available[] = $packaging;
+ $available_packaging_ids[] = $packaging->get_id();
+ }
+ }
+ } else {
+ global $wpdb;
+
+ $weight = wc_format_decimal( empty( $shipment->get_weight() ) ? 0 : wc_get_weight( $shipment->get_weight(), wc_gzd_get_packaging_weight_unit(), $shipment->get_weight_unit() ), 1 );
+ $length = wc_format_decimal( empty( $shipment->get_length() ) ? 0 : wc_get_dimension( $shipment->get_length(), wc_gzd_get_packaging_dimension_unit(), $shipment->get_dimension_unit() ), 1 );
+ $width = wc_format_decimal( empty( $shipment->get_width() ) ? 0 : wc_get_dimension( $shipment->get_width(), wc_gzd_get_packaging_dimension_unit(), $shipment->get_dimension_unit() ), 1 );
+ $height = wc_format_decimal( empty( $shipment->get_height() ) ? 0 : wc_get_dimension( $shipment->get_height(), wc_gzd_get_packaging_dimension_unit(), $shipment->get_dimension_unit() ), 1 );
+
+ $types = array_keys( wc_gzd_get_packaging_types() );
+ $threshold = apply_filters( 'woocommerce_gzd_shipment_packaging_match_threshold', 0, $shipment );
+
+ $query_sql = "SELECT
+ packaging_id,
+ (packaging_length - %f) AS length_diff,
+ (packaging_width - %f) AS width_diff,
+ (packaging_height - %f) AS height_diff,
+ ((packaging_length - %f) + (packaging_width - %f) + (packaging_height - %f)) AS total_diff
+ FROM {$wpdb->gzd_packaging}
+ WHERE ( packaging_max_content_weight = 0 OR packaging_max_content_weight >= %f ) AND packaging_type IN ( '" . implode( "','", $types ) . "' )
+ HAVING length_diff >= %f AND width_diff >= %f AND height_diff >= %f
+ ORDER BY total_diff ASC, packaging_weight ASC, packaging_order ASC
+ ";
+
+ $query = $wpdb->prepare( $query_sql, $length, $width, $height, $length, $width, $height, $weight, $threshold, $threshold, $threshold );
+ $results = $wpdb->get_results( $query );
+
+ if ( $results ) {
+ foreach( $results as $result ) {
+ $available_packaging_ids[] = $result->packaging_id;
+ $packaging_available[] = wc_gzd_get_packaging( $result->packaging_id );
+ }
+ }
+ }
+
+ wp_cache_set( 'available-packaging-' . $shipment->get_id(), $available_packaging_ids, 'shipments' );
+ } elseif ( sizeof( $items_to_pack ) <= 0 ) {
+ $packaging_available = wc_gzd_get_packaging_list();
+ } else {
+ foreach( (array) $results as $packaging_id ) {
+ $packaging_available[] = wc_gzd_get_packaging( $packaging_id );
+ }
+ }
+
+ return apply_filters( 'woocommerce_gzd_find_available_packaging_for_shipment', $this->sort_packaging_list( $packaging_available ), $shipment );
+ }
+
+ protected function sort_packaging_list( $packaging ) {
+ usort($packaging, array( $this, '_sort_packaging_list_callback' ) );
+
+ return $packaging;
+ }
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Packaging $packaging_a
+ * @param \Vendidero\Germanized\Shipments\Packaging $packaging_b
+ *
+ * @return int
+ */
+ protected function _sort_packaging_list_callback( $packaging_a, $packaging_b ) {
+ if ( $packaging_a->get_volume() === $packaging_b->get_volume() ) {
+ return 0;
+ }
+
+ return ( $packaging_a->get_volume() > $packaging_b->get_volume() ) ? 1 : -1;
+ }
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment
+ * @param string|array $types
+ *
+ * @return \Vendidero\Germanized\Shipments\Packaging|false
+ */
+ public function find_best_match_for_shipment( $shipment ) {
+ $results = $this->find_available_packaging_for_shipment( $shipment );
+ $packaging = false;
+
+ if ( ! empty( $results ) ) {
+ $packaging = $results[0];
+ }
+
+ return apply_filters( 'woocommerce_gzd_find_best_matching_packaging_for_shipment', $packaging, $shipment );
+ }
+
+ /**
+ * Table structure is slightly different between meta types, this function will return what we need to know.
+ *
+ * @since 3.0.0
+ * @return array Array elements: table, object_id_field, meta_id_field
+ */
+ protected function get_db_info() {
+ global $wpdb;
+
+ $meta_id_field = 'meta_id'; // for some reason users calls this umeta_id so we need to track this as well.
+ $table = $wpdb->gzd_packagingmeta;
+ $object_id_field = $this->meta_type . '_id';
+
+ if ( ! empty( $this->object_id_field_for_meta ) ) {
+ $object_id_field = $this->object_id_field_for_meta;
+ }
+
+ return array(
+ 'table' => $table,
+ 'object_id_field' => $object_id_field,
+ 'meta_id_field' => $meta_id_field,
+ );
+ }
+
+ public function get_query_args( $query_vars ) {
+ return $this->get_wp_query_args( $query_vars );
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/DataStores/Shipment.php b/packages/woocommerce-germanized-shipments/src/DataStores/Shipment.php
new file mode 100644
index 000000000..11735ffbc
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/DataStores/Shipment.php
@@ -0,0 +1,712 @@
+set_date_created( current_time( 'timestamp', true ) );
+ $shipment->set_weight_unit( get_option( 'woocommerce_weight_unit', 'kg' ) );
+ $shipment->set_dimension_unit( get_option( 'woocommerce_dimension_unit', 'cm' ) );
+
+ $data = array(
+ 'shipment_country' => $shipment->get_country(),
+ 'shipment_order_id' => is_callable( array( $shipment, 'get_order_id' ) ) ? $shipment->get_order_id() : 0,
+ 'shipment_parent_id' => is_callable( array( $shipment, 'get_parent_id' ) ) ? $shipment->get_parent_id() : 0,
+ 'shipment_tracking_id' => $shipment->get_tracking_id(),
+ 'shipment_status' => $this->get_status( $shipment ),
+ 'shipment_search_index' => $this->get_search_index( $shipment ),
+ 'shipment_packaging_id' => $shipment->get_packaging_id(),
+ 'shipment_type' => $shipment->get_type(),
+ 'shipment_shipping_provider' => $shipment->get_shipping_provider(),
+ 'shipment_shipping_method' => $shipment->get_shipping_method(),
+ 'shipment_date_created' => gmdate( 'Y-m-d H:i:s', $shipment->get_date_created( 'edit' )->getOffsetTimestamp() ),
+ 'shipment_date_created_gmt' => gmdate( 'Y-m-d H:i:s', $shipment->get_date_created( 'edit' )->getTimestamp() ),
+ 'shipment_version' => Package::get_version()
+ );
+
+ if ( $shipment->get_date_sent() ) {
+ $data['shipment_date_sent'] = gmdate( 'Y-m-d H:i:s', $shipment->get_date_sent( 'edit' )->getOffsetTimestamp() );
+ $data['shipment_date_sent_gmt'] = gmdate( 'Y-m-d H:i:s', $shipment->get_date_sent( 'edit' )->getTimestamp() );
+ }
+
+ if ( is_callable( array( $shipment, 'get_est_delivery_date' ) ) && $shipment->get_est_delivery_date() ) {
+ $data['shipment_est_delivery_date'] = gmdate( 'Y-m-d H:i:s', $shipment->get_est_delivery_date( 'edit' )->getOffsetTimestamp() );
+ $data['shipment_est_delivery_date_gmt'] = gmdate( 'Y-m-d H:i:s', $shipment->get_est_delivery_date( 'edit' )->getTimestamp() );
+ }
+
+ $wpdb->insert(
+ $wpdb->gzd_shipments,
+ $data
+ );
+
+ $shipment_id = $wpdb->insert_id;
+
+ if ( $shipment_id ) {
+ $shipment->set_id( $shipment_id );
+
+ $this->save_shipment_data( $shipment );
+
+ $shipment->save_meta_data();
+ $shipment->apply_changes();
+
+ $this->clear_caches( $shipment );
+
+ $hook_postfix = $this->get_hook_postfix( $shipment );
+
+ /**
+ * Action that indicates that a new Shipment has been created in the DB.
+ *
+ * The dynamic portion of this hook, `$hook_postfix` refers to the
+ * shipment type in case it is not a simple shipment.
+ *
+ * @param integer $shipment_id The shipment id.
+ * @param Shipment $shipment The shipment instance.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( "woocommerce_gzd_new_{$hook_postfix}shipment", $shipment_id, $shipment );
+ }
+ }
+
+ /**
+ * Get the status to save to the object.
+ *
+ * @since 3.6.0
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment Shipment object.
+ * @return string
+ */
+ protected function get_status( $shipment ) {
+ $shipment_status = $shipment->get_status( 'edit' );
+
+ if ( ! $shipment_status ) {
+ /** This filter is documented in src/Shipment.php */
+ $shipment_status = apply_filters( 'woocommerce_gzd_get_shipment_default_status', 'gzd-draft' );
+ }
+
+ $valid_statuses = array_keys( wc_gzd_get_shipment_statuses() );
+
+ // Add a gzd- prefix to the status.
+ if ( in_array( 'gzd-' . $shipment_status, $valid_statuses, true ) ) {
+ $shipment_status = 'gzd-' . $shipment_status;
+ }
+
+ return $shipment_status;
+ }
+
+ /**
+ * Method to update a shipment in the database.
+ *
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment Shipment object.
+ */
+ public function update( &$shipment ) {
+ global $wpdb;
+
+ $updated_props = array();
+ $core_props = $this->core_props;
+ $changed_props = array_keys( $shipment->get_changes() );
+ $shipment_data = array();
+
+ if ( '' === $shipment->get_weight_unit( 'edit' ) ) {
+ $shipment->set_weight_unit( get_option( 'woocommerce_weight_unit', 'kg' ) );
+ }
+
+ if ( '' === $shipment->get_dimension_unit( 'edit' ) ) {
+ $shipment->set_dimension_unit( get_option( 'woocommerce_dimension_unit', 'cm' ) );
+ }
+
+ // Make sure country in core props is updated as soon as the address changes
+ if ( in_array( 'address', $changed_props ) ) {
+ $changed_props[] = 'country';
+
+ // Update search index
+ $shipment_data['shipment_search_index'] = $this->get_search_index( $shipment );
+ }
+
+ // Shipping provider has changed - lets remove existing label
+ if ( in_array( 'shipping_provider', $changed_props ) ) {
+
+ if ( $shipment->supports_label() && $shipment->has_label() ) {
+ $shipment->get_label()->delete();
+ }
+ }
+
+ foreach ( $changed_props as $prop ) {
+
+ if ( ! in_array( $prop, $core_props, true ) ) {
+ continue;
+ }
+
+ switch( $prop ) {
+ case "status":
+ $shipment_data[ 'shipment_' . $prop ] = $this->get_status( $shipment);
+ break;
+ case "date_created":
+ case "date_sent":
+ case "est_delivery_date":
+ if ( is_callable( array( $shipment, 'get_' . $prop ) ) ) {
+ $shipment_data[ 'shipment_' . $prop ] = gmdate( 'Y-m-d H:i:s', $shipment->{'get_' . $prop}( 'edit' )->getOffsetTimestamp() );
+ $shipment_data[ 'shipment_' . $prop . '_gmt' ] = gmdate( 'Y-m-d H:i:s', $shipment->{'get_' . $prop}( 'edit' )->getTimestamp() );
+ }
+ break;
+ default:
+ if ( is_callable( array( $shipment, 'get_' . $prop ) ) ) {
+ $shipment_data[ 'shipment_' . $prop ] = $shipment->{'get_' . $prop}( 'edit' );
+ }
+ break;
+ }
+ }
+
+ if ( ! empty( $shipment_data ) ) {
+ $shipment_data['shipment_search_index'] = $this->get_search_index( $shipment );
+
+ $wpdb->update(
+ $wpdb->gzd_shipments,
+ $shipment_data,
+ array( 'shipment_id' => $shipment->get_id() )
+ );
+ }
+
+ $this->save_shipment_data( $shipment );
+
+ $shipment->save_meta_data();
+ $shipment->apply_changes();
+
+ $this->clear_caches( $shipment );
+
+ $hook_postfix = $this->get_hook_postfix( $shipment );
+
+ /**
+ * Action that indicates that a Shipment has been updated in the DB.
+ *
+ * The dynamic portion of this hook, `$hook_postfix` refers to the
+ * shipment type in case it is not a simple shipment.
+ *
+ * @param integer $shipment_id The shipment id.
+ * @param Shipment $shipment The shipment instance.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( "woocommerce_gzd_{$hook_postfix}shipment_updated", $shipment->get_id(), $shipment );
+ }
+
+ /**
+ * Remove a shipment from the database.
+ *
+ * @since 3.0.0
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment Shipment object.
+ * @param bool $force_delete Unused param.
+ */
+ public function delete( &$shipment, $force_delete = false ) {
+ global $wpdb;
+
+ $wpdb->delete( $wpdb->gzd_shipments, array( 'shipment_id' => $shipment->get_id() ), array( '%d' ) );
+ $wpdb->delete( $wpdb->gzd_shipmentmeta, array( 'gzd_shipment_id' => $shipment->get_id() ), array( '%d' ) );
+
+ $this->delete_items( $shipment );
+ $this->clear_caches( $shipment );
+
+ $hook_postfix = $this->get_hook_postfix( $shipment );
+
+ /**
+ * Action that indicates that a Shipment has been deleted from the DB.
+ *
+ * The dynamic portion of this hook, `$hook_postfix` refers to the
+ * shipment type in case it is not a simple shipment.
+ *
+ * @param integer $shipment_id The shipment id.
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment The shipment object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( "woocommerce_gzd_{$hook_postfix}shipment_deleted", $shipment->get_id(), $shipment );
+ }
+
+ /**
+ * Read a shipment from the database.
+ *
+ * @since 3.0.0
+ *
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment Shipment object.
+ *
+ * @throws Exception Throw exception if invalid shipment.
+ */
+ public function read( &$shipment ) {
+ global $wpdb;
+
+ $data = $wpdb->get_row(
+ $wpdb->prepare(
+ "SELECT * FROM {$wpdb->gzd_shipments} WHERE shipment_id = %d LIMIT 1",
+ $shipment->get_id()
+ )
+ );
+
+ if ( $data ) {
+ $shipment->set_props(
+ array(
+ 'order_id' => $data->shipment_order_id,
+ 'parent_id' => $data->shipment_parent_id,
+ 'country' => $data->shipment_country,
+ 'tracking_id' => $data->shipment_tracking_id,
+ 'shipping_provider' => $data->shipment_shipping_provider,
+ 'shipping_method' => $data->shipment_shipping_method,
+ 'packaging_id' => $data->shipment_packaging_id,
+ 'date_created' => 0 < $data->shipment_date_created_gmt ? wc_string_to_timestamp( $data->shipment_date_created_gmt ) : null,
+ 'date_sent' => 0 < $data->shipment_date_sent_gmt ? wc_string_to_timestamp( $data->shipment_date_sent_gmt ) : null,
+ 'est_delivery_date' => 0 < $data->shipment_est_delivery_date_gmt ? wc_string_to_timestamp( $data->shipment_est_delivery_date_gmt ) : null,
+ 'status' => $data->shipment_status,
+ 'version' => $data->shipment_version,
+ )
+ );
+
+ $this->read_shipment_data( $shipment );
+
+ $shipment->read_meta_data();
+ $shipment->set_object_read( true );
+
+ $hook_postfix = $this->get_hook_postfix( $shipment );
+
+ /**
+ * Action that indicates that a Shipment has been loaded from DB.
+ *
+ * The dynamic portion of this hook, `$hook_postfix` refers to the
+ * shipment type in case it is not a simple shipment.
+ *
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment The shipment object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( "woocommerce_gzd_{$hook_postfix}shipment_loaded", $shipment );
+ } else {
+ throw new Exception( _x( 'Invalid shipment.', 'shipments', 'woocommerce-germanized' ) );
+ }
+ }
+
+ /**
+ * Clear any caches.
+ *
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment Shipment object.
+ * @since 3.0.0
+ */
+ protected function clear_caches( &$shipment ) {
+ wp_cache_delete( 'shipment-items-' . $shipment->get_id(), 'shipments' );
+ wp_cache_delete( $shipment->get_id(), $this->meta_type . '_meta' );
+ wp_cache_delete( 'available-packaging-' . $shipment->get_id(), 'shipments' );
+ }
+
+ /*
+ |--------------------------------------------------------------------------
+ | Additional Methods
+ |--------------------------------------------------------------------------
+ */
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment
+ */
+ protected function get_search_index( $shipment ) {
+ $index = array();
+
+ if ( is_a( $shipment, '\Vendidero\Germanized\Shipments\ReturnShipment' ) ) {
+ $index = array_merge( $index, $shipment->get_sender_address() );
+ } else {
+ $index = array_merge( $index, $shipment->get_address() );
+ }
+
+ return implode( ' ', $index );
+ }
+
+ protected function get_hook_postfix( $shipment ) {
+ if ( 'simple' !== $shipment->get_type() ) {
+ return $shipment->get_type() . '_';
+ }
+
+ return '';
+ }
+
+ /**
+ * Get the label type based on label ID.
+ *
+ * @param int $shipment_id Shipment id.
+ * @return string
+ */
+ public function get_shipment_type( $shipment_id ) {
+ global $wpdb;
+
+ $type = $wpdb->get_col(
+ $wpdb->prepare(
+ "SELECT shipment_type FROM {$wpdb->gzd_shipments} WHERE shipment_id = %d LIMIT 1",
+ $shipment_id
+ )
+ );
+
+ return ! empty( $type ) ? $type[0] : false;
+ }
+
+ /**
+ * Read extra data associated with the shipment.
+ *
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment Shipment object.
+ * @since 3.0.0
+ */
+ protected function read_shipment_data( &$shipment ) {
+ $props = array();
+
+ foreach( $this->internal_meta_keys as $meta_key ) {
+ $props[ substr( $meta_key, 1 ) ] = get_metadata( 'gzd_shipment', $shipment->get_id(), $meta_key, true );
+ }
+
+ $shipment->set_props( $props );
+ }
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment
+ */
+ protected function save_shipment_data( &$shipment ) {
+ $updated_props = array();
+ $meta_key_to_props = array();
+
+ foreach( $this->internal_meta_keys as $meta_key ) {
+ $prop_name = substr( $meta_key, 1 );
+
+ if ( in_array( $prop_name, $this->core_props ) ) {
+ continue;
+ }
+
+ $meta_key_to_props[ $meta_key ] = $prop_name;
+ }
+
+ $props_to_update = $this->get_props_to_update( $shipment, $meta_key_to_props, 'gzd_shipment' );
+
+ foreach ( $props_to_update as $meta_key => $prop ) {
+
+ if ( ! is_callable( array( $shipment, "get_$prop" ) ) ) {
+ continue;
+ }
+
+ $value = $shipment->{"get_$prop"}( 'edit' );
+ $value = is_string( $value ) ? wp_slash( $value ) : $value;
+
+ switch ( $prop ) {
+ case "is_customer_requested":
+ $value = wc_bool_to_string( $value );
+ break;
+ }
+
+ // Force updating props that are dependent on inner content data (weight, dimensions)
+ if ( in_array( $prop, array( 'weight', 'width', 'length', 'height' ) ) && ! $shipment->is_editable() ) {
+
+ // Get weight in view context to maybe allow calculating inner content props.
+ $value = $shipment->{"get_$prop"}( 'view' );
+ $updated = update_metadata( 'gzd_shipment', $shipment->get_id(), $meta_key, $value );
+ } else {
+ $updated = $this->update_or_delete_meta( $shipment, $meta_key, $value );
+ }
+
+ if ( $updated ) {
+ $updated_props[] = $prop;
+ }
+ }
+
+ /**
+ * Action that fires after updating a Shipment's properties.
+ *
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment The shipment object.
+ * @param array $changed_props The updated properties.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( 'woocommerce_gzd_shipment_object_updated_props', $shipment, $updated_props );
+ }
+
+ /**
+ * Update meta data in, or delete it from, the database.
+ *
+ * Avoids storing meta when it's either an empty string or empty array.
+ * Other empty values such as numeric 0 and null should still be stored.
+ * Data-stores can force meta to exist using `must_exist_meta_keys`.
+ *
+ * Note: WordPress `get_metadata` function returns an empty string when meta data does not exist.
+ *
+ * @param WC_Data $object The WP_Data object (WC_Coupon for coupons, etc).
+ * @param string $meta_key Meta key to update.
+ * @param mixed $meta_value Value to save.
+ *
+ * @since 3.6.0 Added to prevent empty meta being stored unless required.
+ *
+ * @return bool True if updated/deleted.
+ */
+ protected function update_or_delete_meta( $object, $meta_key, $meta_value ) {
+ if ( in_array( $meta_value, array( array(), '' ), true ) && ! in_array( $meta_key, $this->must_exist_meta_keys, true ) ) {
+ $updated = delete_metadata( 'gzd_shipment', $object->get_id(), $meta_key );
+ } else {
+ $updated = update_metadata( 'gzd_shipment', $object->get_id(), $meta_key, $meta_value );
+ }
+
+ return (bool) $updated;
+ }
+
+ /**
+ * Read items from the database for this shipment.
+ *
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment Shipment object.
+ *
+ * @return array
+ */
+ public function read_items( $shipment ) {
+ global $wpdb;
+
+ // Get from cache if available.
+ $items = 0 < $shipment->get_id() ? wp_cache_get( 'shipment-items-' . $shipment->get_id(), 'shipments' ) : false;
+
+ if ( false === $items ) {
+
+ $items = $wpdb->get_results(
+ $wpdb->prepare( "SELECT * FROM {$wpdb->gzd_shipment_items} WHERE shipment_id = %d ORDER BY shipment_item_id;", $shipment->get_id() )
+ );
+
+ foreach ( $items as $item ) {
+ wp_cache_set( 'item-' . $item->shipment_item_id, $item, 'shipment-items' );
+ }
+
+ if ( 0 < $shipment->get_id() ) {
+ wp_cache_set( 'shipment-items-' . $shipment->get_id(), $items, 'shipments' );
+ }
+ }
+
+ if ( ! empty( $items ) ) {
+
+ $shipment_type = $shipment->get_type();
+
+ $items = array_map( function( $item_id ) use ( $shipment_type ) {
+ return wc_gzd_get_shipment_item( $item_id, $shipment_type );
+ }, array_combine( wp_list_pluck( $items, 'shipment_item_id' ), $items ) );
+ } else {
+ $items = array();
+ }
+
+ return $items;
+ }
+
+ /**
+ * Remove all items from the shipment.
+ *
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment Shipment object.
+ */
+ public function delete_items( $shipment ) {
+ global $wpdb;
+
+ $wpdb->query( $wpdb->prepare( "DELETE FROM itemmeta USING {$wpdb->gzd_shipment_itemmeta} itemmeta INNER JOIN {$wpdb->gzd_shipment_items} items WHERE itemmeta.gzd_shipment_item_id = items.shipment_item_id and items.shipment_id = %d", $shipment->get_id() ) );
+ $wpdb->query( $wpdb->prepare( "DELETE FROM {$wpdb->gzd_shipment_items} WHERE shipment_id = %d", $shipment->get_id() ) );
+
+ $this->clear_caches( $shipment );
+ }
+
+ /**
+ * Get valid WP_Query args from a WC_Order_Query's query variables.
+ *
+ * @since 3.0.6
+ * @param array $query_vars query vars from a WC_Order_Query.
+ * @return array
+ */
+ protected function get_wp_query_args( $query_vars ) {
+ global $wpdb;
+
+ // Add the 'wc-' prefix to status if needed.
+ if ( ! empty( $query_vars['status'] ) ) {
+ if ( is_array( $query_vars['status'] ) ) {
+ foreach ( $query_vars['status'] as &$status ) {
+ $status = wc_gzd_is_shipment_status( 'gzd-' . $status ) ? 'gzd-' . $status : $status;
+ }
+ } else {
+ $query_vars['status'] = wc_gzd_is_shipment_status( 'gzd-' . $query_vars['status'] ) ? 'gzd-' . $query_vars['status'] : $query_vars['status'];
+ }
+ }
+
+ $wp_query_args = parent::get_wp_query_args( $query_vars );
+
+ // Force type to be existent
+ if ( isset( $query_vars['type'] ) ) {
+ $wp_query_args['type'] = $query_vars['type'];
+ }
+
+ if ( ! isset( $wp_query_args['date_query'] ) ) {
+ $wp_query_args['date_query'] = array();
+ }
+
+ if ( ! isset( $wp_query_args['meta_query'] ) ) {
+ $wp_query_args['meta_query'] = array();
+ }
+
+ // Allow Woo to treat these props as date query compatible
+ $date_queries = array(
+ 'date_created',
+ 'date_sent',
+ 'est_delivery_date'
+ );
+
+ foreach ( $date_queries as $db_key ) {
+ if ( isset( $query_vars[ $db_key ] ) && '' !== $query_vars[ $db_key ] ) {
+
+ // Remove any existing meta queries for the same keys to prevent conflicts.
+ $existing_queries = wp_list_pluck( $wp_query_args['meta_query'], 'key', true );
+ $meta_query_index = array_search( $db_key, $existing_queries, true );
+
+ if ( false !== $meta_query_index ) {
+ unset( $wp_query_args['meta_query'][ $meta_query_index ] );
+ }
+
+ $date_query_args = $this->parse_date_for_wp_query( $query_vars[ $db_key ], 'post_date', array() );
+
+ /**
+ * Replace date query columns after Woo parsed dates.
+ * Include table name because otherwise WP_Date_Query won't accept our custom column.
+ */
+ if ( isset( $date_query_args['date_query'] ) && ! empty( $date_query_args['date_query'] ) ) {
+ $date_query = $date_query_args['date_query'][0];
+
+ if ( 'post_date' === $date_query['column'] ) {
+ $date_query['column'] = $wpdb->gzd_shipments . '.shipment_' . $db_key;
+ }
+
+ $wp_query_args['date_query'][] = $date_query;
+ }
+ }
+ }
+
+ if ( ! isset( $query_vars['paginate'] ) || ! $query_vars['paginate'] ) {
+ $wp_query_args['no_found_rows'] = true;
+ }
+
+ /**
+ * Filter to adjust Shipments query arguments after parsing.
+ *
+ * @param array $wp_query_args Array containing parsed query arguments.
+ * @param array $query_vars The original query arguments.
+ * @param Shipment $data_store The shipment data store object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipping_data_store_get_shipments_query', $wp_query_args, $query_vars, $this );
+ }
+
+ /**
+ * Table structure is slightly different between meta types, this function will return what we need to know.
+ *
+ * @since 3.0.0
+ * @return array Array elements: table, object_id_field, meta_id_field
+ */
+ protected function get_db_info() {
+ global $wpdb;
+
+ $meta_id_field = 'meta_id'; // for some reason users calls this umeta_id so we need to track this as well.
+ $table = $wpdb->gzd_shipmentmeta;
+ $object_id_field = $this->meta_type . '_id';
+
+ if ( ! empty( $this->object_id_field_for_meta ) ) {
+ $object_id_field = $this->object_id_field_for_meta;
+ }
+
+ return array(
+ 'table' => $table,
+ 'object_id_field' => $object_id_field,
+ 'meta_id_field' => $meta_id_field,
+ );
+ }
+
+ public function get_query_args( $query_vars ) {
+ return $this->get_wp_query_args( $query_vars );
+ }
+
+ public function get_shipment_count( $status, $type = '' ) {
+ global $wpdb;
+
+ if ( empty( $type ) ) {
+ $query = $wpdb->prepare( "SELECT COUNT( * ) FROM {$wpdb->gzd_shipments} WHERE shipment_status = %s", $status );
+ } else {
+ $query = $wpdb->prepare( "SELECT COUNT( * ) FROM {$wpdb->gzd_shipments} WHERE shipment_status = %s and shipment_type = %s", $status, $type );
+ }
+
+ return absint( $wpdb->get_var( $query ) );
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/DataStores/ShipmentItem.php b/packages/woocommerce-germanized-shipments/src/DataStores/ShipmentItem.php
new file mode 100644
index 000000000..249af817e
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/DataStores/ShipmentItem.php
@@ -0,0 +1,350 @@
+insert(
+ $wpdb->gzd_shipment_items, array(
+ 'shipment_id' => $item->get_shipment_id(),
+ 'shipment_item_quantity' => $item->get_quantity(),
+ 'shipment_item_order_item_id' => $item->get_order_item_id(),
+ 'shipment_item_product_id' => $item->get_product_id(),
+ 'shipment_item_parent_id' => $item->get_parent_id(),
+ 'shipment_item_name' => $item->get_name(),
+ )
+ );
+
+ $item->set_id( $wpdb->insert_id );
+ $this->save_item_data( $item );
+ $item->save_meta_data();
+ $item->apply_changes();
+ $this->clear_cache( $item );
+
+ /**
+ * Action that indicates that a new ShipmentItem has been created in the DB.
+ *
+ * @param integer $shipment_item_id The shipment item id.
+ * @param \Vendidero\Germanized\Shipments\ShipmentItem $item The shipment item object.
+ * @param integer $shipment_id The shipment id.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( 'woocommerce_gzd_new_shipment_item', $item->get_id(), $item, $item->get_shipment_id() );
+ }
+
+ /**
+ * Update a shipment item in the database.
+ *
+ * @since 3.0.0
+ * @param \Vendidero\Germanized\Shipments\ShipmentItem $item Shipment item object.
+ */
+ public function update( &$item ) {
+ global $wpdb;
+
+ $changes = $item->get_changes();
+
+ if ( array_intersect( $this->core_props, array_keys( $changes ) ) ) {
+ $wpdb->update(
+ $wpdb->gzd_shipment_items, array(
+ 'shipment_id' => $item->get_shipment_id(),
+ 'shipment_item_order_item_id' => $item->get_order_item_id(),
+ 'shipment_item_quantity' => $item->get_quantity(),
+ 'shipment_item_product_id' => $item->get_product_id(),
+ 'shipment_item_parent_id' => $item->get_parent_id(),
+ 'shipment_item_name' => $item->get_name(),
+ ), array( 'shipment_item_id' => $item->get_id() )
+ );
+ }
+
+ $this->save_item_data( $item );
+ $item->save_meta_data();
+ $item->apply_changes();
+ $this->clear_cache( $item );
+
+ /**
+ * Action that indicates that a ShipmentItem has been updated in the DB.
+ *
+ * @param integer $shipment_item_id The shipment item id.
+ * @param \Vendidero\Germanized\Shipments\ShipmentItem $item The shipment item object.
+ * @param integer $shipment_id The shipment id.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( 'woocommerce_gzd_shipment_item_updated', $item->get_id(), $item, $item->get_shipment_id() );
+ }
+
+ /**
+ * Remove a shipment item from the database.
+ *
+ * @since 3.0.0
+ * @param \Vendidero\Germanized\Shipments\ShipmentItem $item Shipment item object.
+ * @param array $args Array of args to pass to the delete method.
+ */
+ public function delete( &$item, $args = array() ) {
+ if ( $item->get_id() ) {
+ global $wpdb;
+
+ /**
+ * Action that fires before deleting a ShipmentItem from the DB.
+ *
+ * @param integer $shipment_item_id The shipment item id.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( 'woocommerce_gzd_before_delete_shipment_item', $item->get_id() );
+
+ $wpdb->delete( $wpdb->gzd_shipment_items, array( 'shipment_item_id' => $item->get_id() ) );
+ $wpdb->delete( $wpdb->gzd_shipment_itemmeta, array( 'gzd_shipment_item_id' => $item->get_id() ) );
+
+ /**
+ * Action that indicates that a ShipmentItem has been deleted from the DB.
+ *
+ * @param integer $shipment_item_id The shipment item id.
+ * @param \Vendidero\Germanized\Shipments\ShipmentItem $item The shipment item object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( 'woocommerce_gzd_delete_shipment_item', $item->get_id(), $item );
+ $this->clear_cache( $item );
+ }
+ }
+
+ /**
+ * Read a shipment item from the database.
+ *
+ * @since 3.0.0
+ *
+ * @param \Vendidero\Germanized\Shipments\ShipmentItem $item Shipment item object.
+ *
+ * @throws Exception If invalid shipment item.
+ */
+ public function read( &$item ) {
+ global $wpdb;
+
+ $item->set_defaults();
+
+ // Get from cache if available.
+ $data = wp_cache_get( 'item-' . $item->get_id(), 'shipment-items' );
+
+ if ( false === $data ) {
+ $data = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$wpdb->gzd_shipment_items} WHERE shipment_item_id = %d LIMIT 1;", $item->get_id() ) );
+ wp_cache_set( 'item-' . $item->get_id(), $data, 'shipment-items' );
+ }
+
+ if ( ! $data ) {
+ throw new Exception( _x( 'Invalid shipment item.', 'shipments', 'woocommerce-germanized' ) );
+ }
+
+ $item->set_props(
+ array(
+ 'shipment_id' => $data->shipment_id,
+ 'order_item_id' => $data->shipment_item_order_item_id,
+ 'quantity' => $data->shipment_item_quantity,
+ 'product_id' => $data->shipment_item_product_id,
+ 'parent_id' => $data->shipment_item_parent_id,
+ 'name' => $data->shipment_item_name
+ )
+ );
+
+ $this->read_item_data( $item );
+ $item->read_meta_data();
+ $item->set_object_read( true );
+ }
+
+ /**
+ * Read extra data associated with the shipment item.
+ *
+ * @param \Vendidero\Germanized\Shipments\ShipmentItem $item Shipment item object.
+ * @since 3.0.0
+ */
+ protected function read_item_data( &$item ) {
+ $props = array();
+
+ foreach( $this->internal_meta_keys as $meta_key ) {
+ $props[ substr( $meta_key, 1 ) ] = get_metadata( $this->meta_type, $item->get_id(), $meta_key, true );
+ }
+
+ $item->set_props( $props );
+ }
+
+ /**
+ * Update meta data in, or delete it from, the database.
+ *
+ * Avoids storing meta when it's either an empty string or empty array.
+ * Other empty values such as numeric 0 and null should still be stored.
+ * Data-stores can force meta to exist using `must_exist_meta_keys`.
+ *
+ * Note: WordPress `get_metadata` function returns an empty string when meta data does not exist.
+ *
+ * @param WC_Data $object The WP_Data object (WC_Coupon for coupons, etc).
+ * @param string $meta_key Meta key to update.
+ * @param mixed $meta_value Value to save.
+ *
+ * @since 3.6.0 Added to prevent empty meta being stored unless required.
+ *
+ * @return bool True if updated/deleted.
+ */
+ protected function update_or_delete_meta( $object, $meta_key, $meta_value ) {
+ if ( in_array( $meta_value, array( array(), '' ), true ) && ! in_array( $meta_key, $this->must_exist_meta_keys, true ) ) {
+ $updated = delete_metadata( $this->meta_type, $object->get_id(), $meta_key );
+ } else {
+ $updated = update_metadata( $this->meta_type, $object->get_id(), $meta_key, $meta_value );
+ }
+
+ return (bool) $updated;
+ }
+
+ /**
+ * Saves an item's data to the database / item meta.
+ * Ran after both create and update, so $item->get_id() will be set.
+ *
+ * @since 3.0.0
+ * @param \Vendidero\Germanized\Shipments\ShipmentItem $item Shipment item object.
+ */
+ public function save_item_data( &$item ) {
+ $updated_props = array();
+ $meta_key_to_props = array();
+
+ foreach( $this->internal_meta_keys as $meta_key ) {
+
+ $prop_name = substr( $meta_key, 1 );
+
+ if ( in_array( $prop_name, $this->core_props ) ) {
+ continue;
+ }
+
+ $meta_key_to_props[ $meta_key ] = $prop_name;
+ }
+
+ $props_to_update = $this->get_props_to_update( $item, $meta_key_to_props, $this->meta_type );
+
+ foreach ( $props_to_update as $meta_key => $prop ) {
+
+ $getter = "get_$prop";
+
+ if ( ! is_callable( array( $item, $getter ) ) ) {
+ continue;
+ }
+
+ $value = $item->{"get_$prop"}( 'edit' );
+ $value = is_string( $value ) ? wp_slash( $value ) : $value;
+
+ switch ( $prop ) {}
+
+ $updated = $this->update_or_delete_meta( $item, $meta_key, $value );
+
+ if ( $updated ) {
+ $updated_props[] = $prop;
+ }
+ }
+
+ /**
+ * Action that fires after updating a ShipmentItem's properties.
+ *
+ * @param \Vendidero\Germanized\Shipments\ShipmentItem $item The shipment item object.
+ * @param array $changed_props The updated properties.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( 'woocommerce_gzd_shipment_item_object_updated_props', $item, $updated_props );
+ }
+
+ /**
+ * Clear meta cache.
+ *
+ * @param \Vendidero\Germanized\Shipments\ShipmentItem $item Shipment item object.
+ */
+ public function clear_cache( &$item ) {
+ wp_cache_delete( 'item-' . $item->get_id(), 'shipment-items' );
+ wp_cache_delete( 'shipment-items-' . $item->get_shipment_id(), 'shipments' );
+ wp_cache_delete( $item->get_id(), $this->meta_type . '_meta' );
+ }
+
+ /**
+ * Table structure is slightly different between meta types, this function will return what we need to know.
+ *
+ * @since 3.0.0
+ * @return array Array elements: table, object_id_field, meta_id_field
+ */
+ protected function get_db_info() {
+ global $wpdb;
+
+ $meta_id_field = 'meta_id'; // for some reason users calls this umeta_id so we need to track this as well.
+ $table = $wpdb->gzd_shipment_itemmeta;
+ $object_id_field = $this->meta_type . '_id';
+
+ if ( ! empty( $this->object_id_field_for_meta ) ) {
+ $object_id_field = $this->object_id_field_for_meta;
+ }
+
+ return array(
+ 'table' => $table,
+ 'object_id_field' => $object_id_field,
+ 'meta_id_field' => $meta_id_field,
+ );
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/DataStores/ShippingProvider.php b/packages/woocommerce-germanized-shipments/src/DataStores/ShippingProvider.php
new file mode 100644
index 000000000..081b54228
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/DataStores/ShippingProvider.php
@@ -0,0 +1,443 @@
+set_name( $this->get_unqiue_name( $provider ) );
+
+ $data = array(
+ 'shipping_provider_activated' => $provider->is_activated() ? 1 : 0,
+ 'shipping_provider_name' => $provider->get_name( 'edit' ),
+ 'shipping_provider_title' => $provider->get_title( 'edit' ),
+ );
+
+ $wpdb->insert(
+ $wpdb->gzd_shipping_provider,
+ $data
+ );
+
+ $provider_id = $wpdb->insert_id;
+
+ if ( $provider_id ) {
+ $provider->set_id( $provider_id );
+
+ $this->save_provider_data( $provider );
+
+ $provider->update_settings_with_defaults();
+ $provider->save_meta_data();
+ $provider->apply_changes();
+
+ $this->clear_caches( $provider );
+
+ /**
+ * Action that indicates that a new Shipping Provider has been created in the DB.
+ *
+ * @param integer $provider_id The provider id.
+ * @param \Vendidero\Germanized\Shipments\ShippingProvider\Simple $shipping_provider The shipping provider instance.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( "woocommerce_gzd_new_shipping_provider", $provider_id, $provider );
+ }
+ }
+
+ /**
+ * Generate a unique name to save to the object.
+ *
+ * @since 3.6.0
+ * @param \Vendidero\Germanized\Shipments\ShippingProvider\Simple $provider Shipping provider object.
+ * @return string
+ */
+ protected function get_unqiue_name( $provider ) {
+ global $wpdb;
+
+ $slug = sanitize_key( $provider->get_title() );
+
+ // Post slugs must be unique across all posts.
+ $check_sql = "SELECT shipping_provider_name FROM $wpdb->gzd_shipping_provider WHERE shipping_provider_name = %s AND shipping_provider_id != %d LIMIT 1";
+ $provider_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $slug, $provider->get_id() ) );
+
+ if ( $provider_name_check ) {
+ $suffix = 2;
+ do {
+ $alt_provider_name = _truncate_post_slug( $slug, 200 - ( strlen( $suffix ) + 1 ) ) . "-$suffix";
+ $provider_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $alt_provider_name, $provider->get_id() ) );
+ $suffix++;
+ } while ( $provider_name_check );
+ $slug = $alt_provider_name;
+ }
+
+ return $slug;
+ }
+
+ /**
+ * Method to update a shipping provider in the database.
+ *
+ * @param \Vendidero\Germanized\Shipments\ShippingProvider\Simple $provider Shipping provider object.
+ */
+ public function update( &$provider ) {
+ global $wpdb;
+
+ $updated_props = array();
+ $core_props = $this->core_props;
+ $changed_props = array_keys( $provider->get_changes() );
+ $provider_data = array();
+
+ foreach ( $changed_props as $prop ) {
+
+ if ( ! in_array( $prop, $core_props, true ) ) {
+ continue;
+ }
+
+ switch( $prop ) {
+ case "activated":
+ $provider_data[ 'shipping_provider_' . $prop ] = $provider->is_activated() ? 1 : 0;
+ break;
+ default:
+ if ( is_callable( array( $provider, 'get_' . $prop ) ) ) {
+ $provider_data[ 'shipping_provider_' . $prop ] = $provider->{'get_' . $prop}( 'edit' );
+ }
+ break;
+ }
+ }
+
+ if ( ! empty( $provider_data ) ) {
+ $wpdb->update(
+ $wpdb->gzd_shipping_provider,
+ $provider_data,
+ array( 'shipping_provider_id' => $provider->get_id() )
+ );
+ }
+
+ $this->save_provider_data( $provider );
+
+ $provider->save_meta_data();
+ $provider->apply_changes();
+
+ $this->clear_caches( $provider );
+
+ /**
+ * Action that indicates that a shipping provider has been updated in the DB.
+ *
+ * @param integer $shipping_provider_id The shipping provider id.
+ * @param \Vendidero\Germanized\Shipments\ShippingProvider\Simple $shipping_provider The shipping provider instance.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( "woocommerce_gzd_shipping_provider_updated", $provider->get_id(), $provider );
+ }
+
+ /**
+ * Remove a shipping provider from the database.
+ *
+ * @since 3.0.0
+ * @param \Vendidero\Germanized\Shipments\ShippingProvider\Simple $provider Shipping provider object.
+ * @param bool $force_delete Unused param.
+ */
+ public function delete( &$provider, $force_delete = false ) {
+ global $wpdb;
+
+ $wpdb->delete( $wpdb->gzd_shipping_provider, array( 'shipping_provider_id' => $provider->get_id() ), array( '%d' ) );
+ $wpdb->delete( $wpdb->gzd_shipping_providermeta, array( 'gzd_shipping_provider_id' => $provider->get_id() ), array( '%d' ) );
+
+ $this->clear_caches( $provider );
+
+ /**
+ * Action that indicates that a shipping provider has been deleted from the DB.
+ *
+ * @param integer $shipping_provider_id The shipping provider id.
+ * @param \Vendidero\Germanized\Shipments\ShippingProvider\Simple $provider The shipping provider object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( "woocommerce_gzd_shipping_provider_deleted", $provider->get_id(), $provider );
+ }
+
+ /**
+ * Read a shipping provider from the database.
+ *
+ * @since 3.0.0
+ *
+ * @param \Vendidero\Germanized\Shipments\ShippingProvider\Simple $provider Shipping provider object.
+ *
+ * @throws Exception Throw exception if invalid shipping provider.
+ */
+ public function read( &$provider ) {
+ global $wpdb;
+
+ $data = $wpdb->get_row(
+ $wpdb->prepare(
+ "SELECT * FROM {$wpdb->gzd_shipping_provider} WHERE shipping_provider_id = %d LIMIT 1",
+ $provider->get_id()
+ )
+ );
+
+ if ( $data ) {
+ $provider->set_props(
+ array(
+ 'name' => $data->shipping_provider_name,
+ 'title' => $data->shipping_provider_title,
+ 'activated' => $data->shipping_provider_activated,
+ )
+ );
+
+ $this->read_provider_data( $provider );
+
+ $provider->read_meta_data();
+ $provider->set_object_read( true );
+
+ /**
+ * Action that indicates that a shipping provider has been loaded from DB.
+ *
+ * @param \Vendidero\Germanized\Shipments\ShippingProvider\Simple $provider The shipping provider object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( "woocommerce_gzd_shipping_provider_loaded", $provider );
+ } else {
+ throw new Exception( _x( 'Invalid shipping provider.', 'shipments', 'woocommerce-germanized' ) );
+ }
+ }
+
+ /**
+ * Clear any caches.
+ *
+ * @param \Vendidero\Germanized\Shipments\ShippingProvider\Simple $provider Shipping provider object.
+ * @since 3.0.0
+ */
+ protected function clear_caches( &$provider ) {
+ wp_cache_delete( $provider->get_id(), $this->meta_type . '_meta' );
+ }
+
+ /*
+ |--------------------------------------------------------------------------
+ | Additional Methods
+ |--------------------------------------------------------------------------
+ */
+
+ /**
+ * Read extra data associated with the shipping provider.
+ *
+ * @param \Vendidero\Germanized\Shipments\ShippingProvider\Simple $provider Shipping provider object.
+ * @since 3.0.0
+ */
+ protected function read_provider_data( &$provider ) {
+ $props = array();
+ $meta_keys = $this->internal_meta_keys;
+
+ foreach ( $provider->get_extra_data_keys() as $key ) {
+ $meta_keys[] = '_' . $key;
+ }
+
+ foreach( $meta_keys as $meta_key ) {
+ $props[ substr( $meta_key, 1 ) ] = get_metadata( 'gzd_shipping_provider', $provider->get_id(), $meta_key, true );
+ }
+
+ $provider->set_props( $props );
+ }
+
+ /**
+ * Save shipping provider data.
+ *
+ * @param \Vendidero\Germanized\Shipments\ShippingProvider\Simple $provider Shipping provider object.
+ */
+ protected function save_provider_data( &$provider ) {
+ $updated_props = array();
+ $meta_key_to_props = array();
+
+ foreach( $this->internal_meta_keys as $meta_key ) {
+ $prop_name = substr( $meta_key, 1 );
+
+ if ( in_array( $prop_name, $this->core_props ) ) {
+ continue;
+ }
+
+ $meta_key_to_props[ $meta_key ] = $prop_name;
+ }
+
+ // Make sure to take extra data (like product url or text for external products) into account.
+ $extra_data_keys = $provider->get_extra_data_keys();
+
+ foreach ( $extra_data_keys as $key ) {
+ $meta_key_to_props[ '_' . $key ] = $key;
+ }
+
+ $props_to_update = $this->get_props_to_update( $provider, $meta_key_to_props, 'gzd_shipping_provider' );
+
+ foreach ( $props_to_update as $meta_key => $prop ) {
+
+ if ( ! is_callable( array( $provider, "get_$prop" ) ) ) {
+ continue;
+ }
+
+ $value = $provider->{"get_$prop"}( 'edit' );
+ $value = is_string( $value ) ? wp_slash( $value ) : $value;
+
+ if ( is_bool( $value ) ) {
+ $value = wc_bool_to_string( $value );
+ }
+
+ $updated = $this->update_or_delete_meta( $provider, $meta_key, $value );
+
+ if ( $updated ) {
+ $updated_props[] = $prop;
+ }
+ }
+
+ /**
+ * Action that fires after updating a shipping providers' properties.
+ *
+ * @param \Vendidero\Germanized\Shipments\ShippingProvider\Simple $provider The shipping provider object.
+ * @param array $changed_props The updated properties.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( 'woocommerce_gzd_shipping_provider_object_updated_props', $provider, $updated_props );
+ }
+
+ /**
+ * Update meta data in, or delete it from, the database.
+ *
+ * Avoids storing meta when it's either an empty string or empty array.
+ * Other empty values such as numeric 0 and null should still be stored.
+ * Data-stores can force meta to exist using `must_exist_meta_keys`.
+ *
+ * Note: WordPress `get_metadata` function returns an empty string when meta data does not exist.
+ *
+ * @param WC_Data $object The WP_Data object (WC_Coupon for coupons, etc).
+ * @param string $meta_key Meta key to update.
+ * @param mixed $meta_value Value to save.
+ *
+ * @since 3.6.0 Added to prevent empty meta being stored unless required.
+ *
+ * @return bool True if updated/deleted.
+ */
+ protected function update_or_delete_meta( $object, $meta_key, $meta_value ) {
+ if ( in_array( $meta_value, array( array(), '' ), true ) && ! in_array( $meta_key, $this->must_exist_meta_keys, true ) ) {
+ $updated = delete_metadata( 'gzd_shipping_provider', $object->get_id(), $meta_key );
+ } else {
+ $updated = update_metadata( 'gzd_shipping_provider', $object->get_id(), $meta_key, $meta_value );
+ }
+
+ return (bool) $updated;
+ }
+
+ /**
+ * Table structure is slightly different between meta types, this function will return what we need to know.
+ *
+ * @since 3.0.0
+ * @return array Array elements: table, object_id_field, meta_id_field
+ */
+ protected function get_db_info() {
+ global $wpdb;
+
+ $meta_id_field = 'meta_id'; // for some reason users calls this umeta_id so we need to track this as well.
+ $table = $wpdb->gzd_shipping_providermeta;
+ $object_id_field = $this->meta_type . '_id';
+
+ if ( ! empty( $this->object_id_field_for_meta ) ) {
+ $object_id_field = $this->object_id_field_for_meta;
+ }
+
+ return array(
+ 'table' => $table,
+ 'object_id_field' => $object_id_field,
+ 'meta_id_field' => $meta_id_field,
+ );
+ }
+
+ public function get_shipping_provider_count() {
+ global $wpdb;
+
+ return absint( $wpdb->get_var( "SELECT COUNT( * ) FROM {$wpdb->gzd_shipping_provider}" ) );
+ }
+
+ public function get_shipping_provider_name( $provider_id ) {
+ global $wpdb;
+
+ $provider_name_check = $wpdb->get_row( $wpdb->prepare( "SELECT shipping_provider_name FROM $wpdb->gzd_shipping_provider WHERE shipping_provider_id = %d LIMIT 1", $provider_id ) );
+
+ if ( ! empty( $provider_name_check ) ) {
+ return $provider_name_check->shipping_provider_name;
+ }
+
+ return false;
+ }
+
+ public function get_shipping_providers() {
+ global $wpdb;
+
+ $providers = $wpdb->get_results( "SELECT * FROM $wpdb->gzd_shipping_provider" );
+ $shipping_providers = array();
+
+ foreach( $providers as $provider ) {
+ try {
+ $shipping_providers[ $provider->shipping_provider_name ] = $provider;
+ } catch( Exception $e ) {
+ continue;
+ }
+ }
+
+ return $shipping_providers;
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Emails.php b/packages/woocommerce-germanized-shipments/src/Emails.php
new file mode 100644
index 000000000..ea38422e2
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Emails.php
@@ -0,0 +1,201 @@
+get_type() || $shipment->has_status( 'delivered' ) ) {
+ return;
+ }
+
+ if ( $plain_text ) {
+ wc_get_template(
+ 'emails/plain/email-return-shipment-instructions.php', array(
+ 'shipment' => $shipment,
+ 'sent_to_admin' => $sent_to_admin,
+ 'plain_text' => $plain_text,
+ 'email' => $email,
+ )
+ );
+ } else {
+ wc_get_template(
+ 'emails/email-return-shipment-instructions.php', array(
+ 'shipment' => $shipment,
+ 'sent_to_admin' => $sent_to_admin,
+ 'plain_text' => $plain_text,
+ 'email' => $email,
+ )
+ );
+ }
+ }
+
+ /**
+ * @param Shipment $shipment
+ * @param bool $sent_to_admin
+ * @param bool $plain_text
+ * @param string $email
+ */
+ public static function email_tracking( $shipment, $sent_to_admin = false, $plain_text = false, $email = '' ) {
+
+ // Do only include shipment tracking if estimated delivery date or tracking instruction or tracking url exists
+ // Do not show tracking for returns
+ if ( ! $shipment->has_tracking() || $shipment->has_status( 'delivered' ) || 'return' === $shipment->get_type() ) {
+ return;
+ }
+
+ if ( $plain_text ) {
+ wc_get_template(
+ 'emails/plain/email-shipment-tracking.php', array(
+ 'shipment' => $shipment,
+ 'sent_to_admin' => $sent_to_admin,
+ 'plain_text' => $plain_text,
+ 'email' => $email,
+ )
+ );
+ } else {
+ wc_get_template(
+ 'emails/email-shipment-tracking.php', array(
+ 'shipment' => $shipment,
+ 'sent_to_admin' => $sent_to_admin,
+ 'plain_text' => $plain_text,
+ 'email' => $email,
+ )
+ );
+ }
+ }
+
+ /**
+ * @param Shipment $shipment
+ * @param bool $sent_to_admin
+ * @param bool $plain_text
+ * @param string $email
+ */
+ public static function email_address( $shipment, $sent_to_admin = false, $plain_text = false, $email = '' ) {
+
+ if ( 'return' === $shipment->get_type() || in_array( $email, array( 'customer_return_shipment_delivered' ) ) ) {
+ if ( $provider = $shipment->get_shipping_provider_instance() ) {
+ if ( $provider->hide_return_address() ) {
+ return;
+ }
+ }
+ }
+
+ if ( $plain_text ) {
+ wc_get_template(
+ 'emails/plain/email-shipment-address.php', array(
+ 'shipment' => $shipment,
+ 'sent_to_admin' => $sent_to_admin,
+ 'plain_text' => $plain_text,
+ 'email' => $email,
+ )
+ );
+ } else {
+ wc_get_template(
+ 'emails/email-shipment-address.php', array(
+ 'shipment' => $shipment,
+ 'sent_to_admin' => $sent_to_admin,
+ 'plain_text' => $plain_text,
+ 'email' => $email,
+ )
+ );
+ }
+ }
+
+ /**
+ * Show the order details table
+ *
+ * @param WC_Order $order Order instance.
+ * @param bool $sent_to_admin If should sent to admin.
+ * @param bool $plain_text If is plain text email.
+ * @param string $email Email address.
+ */
+ public static function email_details( $shipment, $sent_to_admin = false, $plain_text = false, $email = '' ) {
+ if ( $plain_text ) {
+ wc_get_template(
+ 'emails/plain/email-shipment-details.php', array(
+ 'shipment' => $shipment,
+ 'sent_to_admin' => $sent_to_admin,
+ 'plain_text' => $plain_text,
+ 'email' => $email,
+ )
+ );
+ } else {
+ wc_get_template(
+ 'emails/email-shipment-details.php', array(
+ 'shipment' => $shipment,
+ 'sent_to_admin' => $sent_to_admin,
+ 'plain_text' => $plain_text,
+ 'email' => $email,
+ )
+ );
+ }
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/FormHandler.php b/packages/woocommerce-germanized-shipments/src/FormHandler.php
new file mode 100644
index 000000000..04adf6a99
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/FormHandler.php
@@ -0,0 +1,280 @@
+ $email,
+ 'post__in' => array( $order_id ),
+ 'limit' => 1,
+ 'return' => 'ids'
+ ) ) );
+
+ // Now lets try to find the order by a custom order number
+ if ( empty( $orders ) ) {
+
+ $orders = new WP_Query( apply_filters( 'woocommerce_gzd_return_request_order_query_args', array(
+ 'post_type' => 'shop_order',
+ 'post_status' => 'any',
+ 'limit' => 1,
+ 'fields' => 'ids',
+ 'meta_query' => array(
+ 'relation' => 'AND',
+ array(
+ 'key' => '_billing_email',
+ 'value' => $email,
+ 'compare' => '=',
+ ),
+ array(
+ 'key' => apply_filters( 'woocommerce_gzd_return_request_customer_order_number_meta_key', '_order_number' ),
+ 'value' => $order_id,
+ 'compare' => '='
+ ),
+ ),
+ ) ) );
+
+ if ( ! empty( $orders->posts ) ) {
+ $db_order_id = $orders->posts[0];
+ }
+ } else {
+ $db_order_id = $orders[0];
+ }
+
+ if ( ! $db_order_id || ( ! $order = wc_get_order( $db_order_id ) ) ) {
+ throw new Exception( '' . _x( 'Error:', 'shipments', 'woocommerce-germanized' ) . ' ' . _x( 'We were not able to find a matching order.', 'shipments', 'woocommerce-germanized' ) );
+ }
+
+ if ( ! wc_gzd_order_is_customer_returnable( $order ) ) {
+ throw new Exception( '' . _x( 'Error:', 'shipments', 'woocommerce-germanized' ) . ' ' . _x( 'This order is currently not eligible for returns. Please contact us for further details.', 'shipments', 'woocommerce-germanized' ) );
+ }
+
+ $key = 'wc_gzd_order_return_request_' . wp_generate_password( 13, false );
+
+ $order->update_meta_data( '_return_request_key', $key );
+ $order->save();
+
+ // Send email to customer
+ wc_add_notice( _x( 'Thank you. You\'ll receive an email containing a link to create a new return to your order.', 'shipments', 'woocommerce-germanized' ), 'success' );
+
+ WC()->mailer()->emails['WC_GZD_Email_Customer_Guest_Return_Shipment_Request']->trigger( $order );
+
+ do_action( 'woocommerce_gzd_return_request_successfull', $order );
+
+ } catch( Exception $e ) {
+ wc_add_notice( $e->getMessage(), 'error' );
+ do_action( 'woocommerce_gzd_return_request_failed' );
+ }
+ }
+ }
+
+ /**
+ * Save the password/account details and redirect back to the my account page.
+ */
+ public static function add_return_shipment() {
+ $nonce_value = isset( $_REQUEST['add-return-shipment-nonce'] ) ? $_REQUEST['add-return-shipment-nonce'] : '';
+
+ if ( ! wp_verify_nonce( $nonce_value, 'add_return_shipment' ) ) {
+ return;
+ }
+
+ if ( empty( $_POST['action'] ) || 'gzd_add_return_shipment' !== $_POST['action'] ) {
+ return;
+ }
+
+ wc_nocache_headers();
+
+ $order_id = ! empty( $_POST['order_id'] ) ? absint( wp_unslash( $_POST['order_id'] ) ) : false;
+ $items = ! empty( $_POST['items'] ) ? wc_clean( wp_unslash( $_POST['items'] ) ) : array();
+ $item_data = ! empty( $_POST['item'] ) ? wc_clean( wp_unslash( $_POST['item'] ) ) : array();
+
+ if ( ! ( $order = wc_get_order( $order_id ) ) || ( ! wc_gzd_customer_can_add_return_shipment( $order_id ) ) ) {
+ wc_add_notice( _x( 'You are not allowed to add returns to that order.', 'shipments', 'woocommerce-germanized' ), 'error' );
+ return;
+ }
+
+ if ( ! wc_gzd_order_is_customer_returnable( $order ) ) {
+ wc_add_notice( _x( 'Sorry, but this order does not support returns any longer.', 'shipments', 'woocommerce-germanized' ), 'error' );
+ return;
+ }
+
+ if ( empty( $items ) ) {
+ wc_add_notice( _x( 'Please choose one or more items from the list.', 'shipments', 'woocommerce-germanized' ), 'error' );
+ return;
+ }
+
+ $return_items = array();
+ $shipment_order = wc_gzd_get_shipment_order( $order );
+
+ foreach( $items as $order_item_id ) {
+
+ if ( $item = $shipment_order->get_simple_shipment_item( $order_item_id ) ) {
+
+ $quantity = isset( $item_data[ $order_item_id ]['quantity'] ) ? absint( $item_data[ $order_item_id ]['quantity'] ) : 0;
+ $quantity_returnable = $shipment_order->get_item_quantity_left_for_returning( $order_item_id );
+ $reason = isset( $item_data[ $order_item_id ]['reason'] ) ? wc_clean( $item_data[ $order_item_id ]['reason'] ) : '';
+
+ if ( ! empty( $reason ) && ! wc_gzd_return_shipment_reason_exists( $reason ) ) {
+ wc_add_notice( _x( 'The return reason you have chosen does not exist.', 'shipments', 'woocommerce-germanized' ), 'error' );
+ return;
+ } elseif( empty( $reason ) && ! wc_gzd_allow_customer_return_empty_return_reason( $order ) ) {
+ wc_add_notice( _x( 'Please choose a return reason from the list.', 'shipments', 'woocommerce-germanized' ), 'error' );
+ return;
+ }
+
+ if ( $quantity > $quantity_returnable ) {
+ wc_add_notice( _x( 'Please check your item quantities. Quantities must not exceed maximum quantities.', 'shipments', 'woocommerce-germanized' ), 'error' );
+ return;
+ } else {
+ $return_items[ $order_item_id ] = array(
+ 'quantity' => $quantity,
+ 'return_reason_code' => $reason,
+ );
+ }
+ }
+ }
+
+ if ( empty( $return_items ) ) {
+ wc_add_notice( _x( 'Please choose one or more items from the list.', 'shipments', 'woocommerce-germanized' ), 'error' );
+ }
+
+ if ( wc_notice_count( 'error' ) > 0 ) {
+ return;
+ }
+
+ $needs_manual_confirmation = wc_gzd_customer_return_needs_manual_confirmation( $order );
+
+ if ( $needs_manual_confirmation ) {
+ $default_status = 'requested';
+ } else {
+ $default_status = 'processing';
+ }
+
+ // Add return shipment
+ $return_shipment = wc_gzd_create_return_shipment( $shipment_order, array(
+ 'items' => $return_items,
+ 'props' => array(
+ /**
+ * This filter may be used to adjust the default status of a return shipment
+ * added by a customer.
+ *
+ * @param string $status The default status.
+ * @param WC_Order $order The order object.
+ *
+ * @since 3.1.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ 'status' => apply_filters( 'woocommerce_gzd_customer_new_return_shipment_request_status', $default_status, $order ),
+ 'is_customer_requested' => true,
+ ),
+ ) );
+
+ if ( is_wp_error( $return_shipment ) ) {
+ wc_add_notice( _x( 'There was an error while creating the return. Please contact us for further information.', 'shipments', 'woocommerce-germanized' ), 'error' );
+ return;
+ } else {
+ // Delete return request key if available
+ $shipment_order->delete_order_return_request_key();
+
+ $success_message = self::get_return_request_success_message( $needs_manual_confirmation );
+
+ // Do not add success message for guest returns
+ if ( $order->get_customer_id() > 0 ) {
+ wc_add_notice( $success_message );
+ }
+
+ /**
+ * This hook is fired after a customer has added a new return request
+ * for a specific shipment. The return shipment object has been added successfully.
+ *
+ * @param ReturnShipment $shipment The return shipment object.
+ * @param WC_Order $order The order object.
+ *
+ * @since 3.1.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( 'woocommerce_gzd_new_customer_return_shipment_request', $return_shipment, $order );
+
+ if ( $needs_manual_confirmation ) {
+ $return_url = $order->get_view_order_url();
+ } else {
+ $return_url = $return_shipment->get_view_shipment_url();
+ }
+
+ if ( $order->get_customer_id() <= 0 ) {
+ $return_url = add_query_arg( array( 'return-request-success' => 'yes', 'needs-confirmation' => wc_bool_to_string( $needs_manual_confirmation ) ), wc_get_page_permalink( 'myaccount' ) );
+ }
+
+ /**
+ * This filter may be used to adjust the redirect of a customer
+ * after adding a new return shipment. In case the return request needs manual confirmation
+ * the customer will be redirected to the parent shipment.
+ *
+ * @param string $url The redirect URL.
+ * @param ReturnShipment $shipment The return shipment object.
+ * @param boolean $needs_manual_confirmation Whether the request needs manual confirmation or not.
+ *
+ * @since 3.1.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ $redirect = apply_filters( 'woocommerce_gzd_customer_new_return_shipment_request_redirect', $return_url, $return_shipment, $needs_manual_confirmation );
+
+ wp_safe_redirect( $redirect );
+ exit;
+ }
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Install.php b/packages/woocommerce-germanized-shipments/src/Install.php
new file mode 100644
index 000000000..a99640941
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Install.php
@@ -0,0 +1,291 @@
+get_shipping_providers();
+
+ foreach( $providers as $provider ) {
+ if ( ! $provider->is_activated() ) {
+ continue;
+ }
+
+ $provider->update_settings_with_defaults();
+ $provider->save();
+ }
+ }
+
+ private static function maybe_create_return_reasons() {
+ $reasons = get_option( 'woocommerce_gzd_shipments_return_reasons', null );
+
+ if ( is_null( $reasons ) ) {
+ $default_reasons = array(
+ array(
+ 'order' => 1,
+ 'code' => 'wrong-product',
+ 'reason' => _x( 'Wrong product or size ordered', 'shipments', 'woocommerce-germanized' ),
+ ),
+ array(
+ 'order' => 2,
+ 'code' => 'not-needed',
+ 'reason' => _x( 'Product no longer needed', 'shipments', 'woocommerce-germanized' ),
+ ),
+ array(
+ 'order' => 3,
+ 'code' => 'look',
+ 'reason' => _x( 'Don\'t like the look', 'shipments', 'woocommerce-germanized' ),
+ )
+ );
+
+ update_option( 'woocommerce_gzd_shipments_return_reasons', $default_reasons );
+ }
+ }
+
+ private static function get_db_version() {
+ return get_option( 'woocommerce_gzd_shipments_db_version', null );
+ }
+
+ private static function maybe_create_packaging() {
+ $packaging = wc_gzd_get_packaging_list();
+ $db_version = self::get_db_version();
+
+ if ( empty( $packaging ) && is_null( $db_version ) ) {
+ $defaults = array(
+ array(
+ 'description' => _x( 'Cardboard S', 'shipments', 'woocommerce-germanized' ),
+ 'length' => 25,
+ 'width' => 17.5,
+ 'height' => 10,
+ 'weight' => 0.14,
+ 'max_content_weight' => 30,
+ 'type' => 'cardboard'
+ ),
+ array(
+ 'description' => _x( 'Cardboard M', 'shipments', 'woocommerce-germanized' ),
+ 'length' => 37.5,
+ 'width' => 30,
+ 'height' => 13.5,
+ 'weight' => 0.23,
+ 'max_content_weight' => 30,
+ 'type' => 'cardboard'
+ ),
+ array(
+ 'description' => _x( 'Cardboard L', 'shipments', 'woocommerce-germanized' ),
+ 'length' => 45,
+ 'width' => 35,
+ 'height' => 20,
+ 'weight' => 0.3,
+ 'max_content_weight' => 30,
+ 'type' => 'cardboard'
+ ),
+ array(
+ 'description' => _x( 'Letter C5/6', 'shipments', 'woocommerce-germanized' ),
+ 'length' => 22,
+ 'width' => 11,
+ 'height' => 1,
+ 'weight' => 0,
+ 'max_content_weight' => 0.05,
+ 'type' => 'letter'
+ ),
+ array(
+ 'description' => _x( 'Letter C4', 'shipments', 'woocommerce-germanized' ),
+ 'length' => 22.9,
+ 'width' => 32.4,
+ 'height' => 2,
+ 'weight' => 0.01,
+ 'max_content_weight' => 1,
+ 'type' => 'letter'
+ ),
+ );
+
+ foreach( $defaults as $default ) {
+ $packaging = new Packaging();
+ $packaging->set_props( $default );
+ $packaging->save();
+ }
+ }
+ }
+
+ private static function create_tables() {
+ global $wpdb;
+
+ $wpdb->hide_errors();
+ require_once ABSPATH . 'wp-admin/includes/upgrade.php';
+ dbDelta( self::get_schema() );
+ }
+
+ private static function create_upload_dir() {
+ Package::maybe_set_upload_dir();
+
+ $dir = Package::get_upload_dir();
+
+ if ( ! @is_dir( $dir['basedir'] ) ) {
+ @mkdir( $dir['basedir'] );
+ }
+
+ if ( ! file_exists( trailingslashit( $dir['basedir'] ) . '.htaccess' ) ) {
+ @file_put_contents( trailingslashit( $dir['basedir'] ) . '.htaccess', 'deny from all' );
+ }
+
+ if ( ! file_exists( trailingslashit( $dir['basedir'] ) . 'index.php' ) ) {
+ @touch( trailingslashit( $dir['basedir'] ) . 'index.php' );
+ }
+ }
+
+ private static function get_schema() {
+ global $wpdb;
+
+ $collate = '';
+
+ if ( $wpdb->has_cap( 'collation' ) ) {
+ $collate = $wpdb->get_charset_collate();
+ }
+
+ $tables = "
+CREATE TABLE {$wpdb->prefix}woocommerce_gzd_shipment_items (
+ shipment_item_id BIGINT UNSIGNED NOT NULL auto_increment,
+ shipment_id BIGINT UNSIGNED NOT NULL,
+ shipment_item_name TEXT NOT NULL,
+ shipment_item_order_item_id BIGINT UNSIGNED NOT NULL,
+ shipment_item_product_id BIGINT UNSIGNED NOT NULL,
+ shipment_item_parent_id BIGINT UNSIGNED NOT NULL,
+ shipment_item_quantity SMALLINT UNSIGNED NOT NULL DEFAULT '1',
+ PRIMARY KEY (shipment_item_id),
+ KEY shipment_id (shipment_id),
+ KEY shipment_item_order_item_id (shipment_item_order_item_id),
+ KEY shipment_item_product_id (shipment_item_product_id),
+ KEY shipment_item_parent_id (shipment_item_parent_id)
+) $collate;
+CREATE TABLE {$wpdb->prefix}woocommerce_gzd_shipment_itemmeta (
+ meta_id BIGINT UNSIGNED NOT NULL auto_increment,
+ gzd_shipment_item_id BIGINT UNSIGNED NOT NULL,
+ meta_key varchar(255) default NULL,
+ meta_value longtext NULL,
+ PRIMARY KEY (meta_id),
+ KEY gzd_shipment_item_id (gzd_shipment_item_id),
+ KEY meta_key (meta_key(32))
+) $collate;
+CREATE TABLE {$wpdb->prefix}woocommerce_gzd_shipments (
+ shipment_id BIGINT UNSIGNED NOT NULL auto_increment,
+ shipment_date_created datetime NOT NULL default '0000-00-00 00:00:00',
+ shipment_date_created_gmt datetime NOT NULL default '0000-00-00 00:00:00',
+ shipment_date_sent datetime default NULL,
+ shipment_date_sent_gmt datetime default NULL,
+ shipment_est_delivery_date datetime default NULL,
+ shipment_est_delivery_date_gmt datetime default NULL,
+ shipment_status varchar(20) NOT NULL default 'gzd-draft',
+ shipment_order_id BIGINT UNSIGNED NOT NULL DEFAULT 0,
+ shipment_packaging_id BIGINT UNSIGNED NOT NULL DEFAULT 0,
+ shipment_parent_id BIGINT UNSIGNED NOT NULL DEFAULT 0,
+ shipment_country varchar(2) NOT NULL DEFAULT '',
+ shipment_tracking_id varchar(200) NOT NULL DEFAULT '',
+ shipment_type varchar(200) NOT NULL DEFAULT '',
+ shipment_version varchar(200) NOT NULL DEFAULT '',
+ shipment_search_index longtext NOT NULL DEFAULT '',
+ shipment_shipping_provider varchar(200) NOT NULL DEFAULT '',
+ shipment_shipping_method varchar(200) NOT NULL DEFAULT '',
+ PRIMARY KEY (shipment_id),
+ KEY shipment_order_id (shipment_order_id),
+ KEY shipment_packaging_id (shipment_packaging_id),
+ KEY shipment_parent_id (shipment_parent_id)
+) $collate;
+CREATE TABLE {$wpdb->prefix}woocommerce_gzd_shipment_labels (
+ label_id BIGINT UNSIGNED NOT NULL auto_increment,
+ label_date_created datetime NOT NULL default '0000-00-00 00:00:00',
+ label_date_created_gmt datetime NOT NULL default '0000-00-00 00:00:00',
+ label_shipment_id BIGINT UNSIGNED NOT NULL,
+ label_parent_id BIGINT UNSIGNED NOT NULL DEFAULT 0,
+ label_number varchar(200) NOT NULL DEFAULT '',
+ label_product_id varchar(200) NOT NULL DEFAULT '',
+ label_shipping_provider varchar(200) NOT NULL DEFAULT '',
+ label_path varchar(200) NOT NULL DEFAULT '',
+ label_type varchar(200) NOT NULL DEFAULT '',
+ PRIMARY KEY (label_id),
+ KEY label_shipment_id (label_shipment_id),
+ KEY label_parent_id (label_parent_id)
+) $collate;
+CREATE TABLE {$wpdb->prefix}woocommerce_gzd_shipment_labelmeta (
+ meta_id BIGINT UNSIGNED NOT NULL auto_increment,
+ gzd_shipment_label_id BIGINT UNSIGNED NOT NULL,
+ meta_key varchar(255) default NULL,
+ meta_value longtext NULL,
+ PRIMARY KEY (meta_id),
+ KEY gzd_shipment_label_id (gzd_shipment_label_id),
+ KEY meta_key (meta_key(32))
+) $collate;
+CREATE TABLE {$wpdb->prefix}woocommerce_gzd_shipmentmeta (
+ meta_id BIGINT UNSIGNED NOT NULL auto_increment,
+ gzd_shipment_id BIGINT UNSIGNED NOT NULL,
+ meta_key varchar(255) default NULL,
+ meta_value longtext NULL,
+ PRIMARY KEY (meta_id),
+ KEY gzd_shipment_id (gzd_shipment_id),
+ KEY meta_key (meta_key(32))
+) $collate;
+CREATE TABLE {$wpdb->prefix}woocommerce_gzd_packaging (
+ packaging_id BIGINT UNSIGNED NOT NULL auto_increment,
+ packaging_date_created datetime NOT NULL default '0000-00-00 00:00:00',
+ packaging_date_created_gmt datetime NOT NULL default '0000-00-00 00:00:00',
+ packaging_type varchar(200) NOT NULL DEFAULT '',
+ packaging_description TINYTEXT NOT NULL DEFAULT '',
+ packaging_weight DECIMAL(6,2) UNSIGNED NOT NULL DEFAULT 0,
+ packaging_order BIGINT UNSIGNED NOT NULL DEFAULT 0,
+ packaging_max_content_weight DECIMAL(6,2) UNSIGNED NOT NULL DEFAULT 0,
+ packaging_length DECIMAL(6,2) UNSIGNED NOT NULL DEFAULT 0,
+ packaging_width DECIMAL(6,2) UNSIGNED NOT NULL DEFAULT 0,
+ packaging_height DECIMAL(6,2) UNSIGNED NOT NULL DEFAULT 0,
+ PRIMARY KEY (packaging_id)
+) $collate;
+CREATE TABLE {$wpdb->prefix}woocommerce_gzd_packagingmeta (
+ meta_id BIGINT UNSIGNED NOT NULL auto_increment,
+ gzd_packaging_id BIGINT UNSIGNED NOT NULL,
+ meta_key varchar(255) default NULL,
+ meta_value longtext NULL,
+ PRIMARY KEY (meta_id),
+ KEY gzd_packaging_id (gzd_packaging_id),
+ KEY meta_key (meta_key(32))
+) $collate;
+CREATE TABLE {$wpdb->prefix}woocommerce_gzd_shipping_provider (
+ shipping_provider_id BIGINT UNSIGNED NOT NULL auto_increment,
+ shipping_provider_activated TINYINT(1) NOT NULL default 1,
+ shipping_provider_title varchar(200) NOT NULL DEFAULT '',
+ shipping_provider_name varchar(200) NOT NULL DEFAULT '',
+ PRIMARY KEY (shipping_provider_id)
+) $collate;
+CREATE TABLE {$wpdb->prefix}woocommerce_gzd_shipping_providermeta (
+ meta_id BIGINT UNSIGNED NOT NULL auto_increment,
+ gzd_shipping_provider_id BIGINT UNSIGNED NOT NULL,
+ meta_key varchar(255) default NULL,
+ meta_value longtext NULL,
+ PRIMARY KEY (meta_id),
+ KEY gzd_shipping_provider_id (gzd_shipping_provider_id),
+ KEY meta_key (meta_key(32))
+) $collate;";
+
+ return $tables;
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Interfaces/ShipmentLabel.php b/packages/woocommerce-germanized-shipments/src/Interfaces/ShipmentLabel.php
new file mode 100644
index 000000000..adc982953
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Interfaces/ShipmentLabel.php
@@ -0,0 +1,95 @@
+get_shipping_provider_instance() ) {
+ if ( $provider->automatically_set_shipment_status_shipped( $shipment ) ) {
+ $shipment->set_status( 'shipped' );
+ }
+ }
+ }
+
+ public static function set_after_create_automation( $shipment_id, $shipment ) {
+ self::do_automation( $shipment, false );
+ }
+
+ /**
+ * @param Shipment $shipment
+ * @param boolean $is_hook
+ */
+ protected static function do_automation( $shipment, $is_hook = true ) {
+ $disable = false;
+
+ if ( ! $shipment->needs_label( false ) ) {
+ $disable = true;
+ }
+
+ /**
+ * Filter that allows to disable automatically creating DHL labels for a certain shipment.
+ *
+ * @param boolean $disable True if you want to disable automation.
+ * @param Shipment $shipment The shipment object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/DHL
+ */
+ $disable = apply_filters( 'woocommerce_gzd_shipments_disable_label_auto_generate', $disable, $shipment );
+
+ if ( $disable ) {
+ return;
+ }
+
+ if ( $provider = $shipment->get_shipping_provider_instance() ) {
+ $hook_prefix = 'woocommerce_gzd_' . ( 'return' === $shipment->get_type() ? 'return_' : '' ) . 'shipment_status_';
+ $auto_status = $provider->get_label_automation_shipment_status( $shipment );
+
+ if ( $provider->automatically_generate_label( $shipment ) && ! empty( $auto_status ) ) {
+ $status = str_replace( 'gzd-', '', $auto_status );
+
+ if ( $is_hook ) {
+ add_action( $hook_prefix . $status, array( __CLASS__, 'maybe_create_label' ), 5, 2 );
+ } elseif( $shipment->has_status( $status ) ) {
+ self::maybe_create_label( $shipment->get_id(), $shipment );
+ }
+ }
+ }
+ }
+
+ /**
+ * @param $shipment_id
+ * @param Shipment $shipment
+ */
+ public static function set_automation( $shipment_id, $shipment ) {
+ self::do_automation( $shipment, true );
+ }
+
+ public static function create_label( $shipment_id, $shipment = false ) {
+ if ( ! $shipment ) {
+ $shipment = wc_gzd_get_shipment( $shipment_id );
+
+ if ( ! $shipment ) {
+ return;
+ }
+ }
+
+ if ( ! $shipment->has_label() ) {
+ $result = $shipment->create_label();
+
+ if ( is_wp_error( $result ) ) {
+ Package::log( sprintf( 'Error while automatically creating label for %1$s: %2$s', $shipment->get_shipment_number(), wc_print_r( $result->get_error_messages(), true ) ) );
+ }
+ }
+ }
+
+ private static function is_admin_edit_order_request() {
+ return ( isset( $_POST['action'] ) && 'editpost' === $_POST['action'] && isset( $_POST['post_type'] ) && 'shop_order' === $_POST['post_type'] );
+ }
+
+ public static function maybe_create_label( $shipment_id, $shipment = false ) {
+ // Make sure that MetaBox is saved before we process automation
+ if ( self::is_admin_edit_order_request() ) {
+ add_action( 'woocommerce_process_shop_order_meta', array( __CLASS__, 'create_label' ), 70 );
+ } else {
+ self::create_label( $shipment_id, $shipment );
+ }
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Labels/DownloadHandler.php b/packages/woocommerce-germanized-shipments/src/Labels/DownloadHandler.php
new file mode 100644
index 000000000..d2fff1c8c
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Labels/DownloadHandler.php
@@ -0,0 +1,127 @@
+ 'no',
+ 'print' => 'no',
+ ) );
+
+ $args = self::parse_args( $args );
+
+ if ( current_user_can( 'edit_shop_orders' ) ) {
+ $handler = new BulkLabel();
+
+ if ( $path = $handler->get_file() ) {
+ $filename = $handler->get_filename();
+
+ self::download( $path, $filename, $args['force'] );
+ }
+ }
+ }
+ }
+ }
+
+ public static function download_label() {
+ if ( 'wc-gzd-download-shipment-label' === $_GET['action'] && wp_verify_nonce( $_REQUEST['_wpnonce'], 'download-shipment-label' ) ) {
+ $shipment_id = absint( $_GET['shipment_id'] );
+ $has_permission = current_user_can( 'edit_shop_orders' );
+
+ $args = self::parse_args( array(
+ 'force' => wc_string_to_bool( isset( $_GET['force'] ) ? wc_clean( $_GET['force'] ) : false )
+ ) );
+
+ if ( $shipment = wc_gzd_get_shipment( $shipment_id ) ) {
+ if ( 'return' === $shipment->get_type() && current_user_can( 'view_order', $shipment->get_order_id() ) && $shipment->has_label() ) {
+ $has_permission = true;
+ }
+
+ if ( $has_permission ) {
+ if ( $label = $shipment->get_label() ) {
+ $file = $label->get_file( $args['path'] );
+ $filename = $label->get_filename( $args['path'] );
+
+ if ( file_exists( $file ) ) {
+ self::download( $file, $filename, $args['force'] );
+ }
+ }
+ }
+ }
+ }
+ }
+
+ public static function parse_args( $args = array() ) {
+ $args = wp_parse_args( $args, array(
+ 'force' => false,
+ 'path' => '',
+ ) );
+
+ $args['force'] = wc_string_to_bool( $args['force'] );
+
+ return $args;
+ }
+
+ public static function download( $path, $filename, $force = false ) {
+ if ( $force ) {
+ self::force( $path, $filename );
+ } else {
+ self::embed( $path, $filename );
+ }
+ }
+
+ private static function force( $path, $filename ) {
+ WC_Download_Handler::download_file_force( $path, $filename );
+ }
+
+ private static function embed( $file_path, $filename ) {
+ if ( ob_get_level() ) {
+ $levels = ob_get_level();
+ for ( $i = 0; $i < $levels; $i++ ) {
+ @ob_end_clean(); // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
+ }
+ } else {
+ @ob_end_clean(); // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
+ }
+
+ wc_nocache_headers();
+
+ header( 'X-Robots-Tag: noindex, nofollow', true );
+ header( 'Content-type: application/pdf' );
+ header( 'Content-Description: File Transfer' );
+ header( 'Content-Disposition: inline; filename="' . $filename . '";' );
+ header( 'Content-Transfer-Encoding: binary' );
+
+ $file_size = @filesize( $file_path ); // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
+
+ if ( ! $file_size ) {
+ return;
+ }
+
+ header( 'Content-Length: ' . $file_size );
+
+ @readfile( $file_path );
+ exit();
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Labels/Factory.php b/packages/woocommerce-germanized-shipments/src/Labels/Factory.php
new file mode 100644
index 000000000..eb61fe214
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Labels/Factory.php
@@ -0,0 +1,84 @@
+get_label_data( $label_id );
+
+ if ( $label_data ) {
+ $label_type = $label_data->type;
+ $shipping_provider_name = $label_data->shipping_provider;
+ }
+ }
+
+ $shipping_provider_name = apply_filters( 'woocommerce_gzd_shipment_label_shipping_provider_name', $shipping_provider_name, $label_id, $label_type );
+
+ if ( ! $shipping_provider = wc_gzd_get_shipping_provider( $shipping_provider_name ) ) {
+ return false;
+ }
+
+ $classname = $shipping_provider->get_label_classname( $label_type );
+
+ /**
+ * Filter that allows adjusting the default DHL label classname.
+ *
+ * @param string $classname The classname to be used.
+ * @param integer $label_id The label id.
+ * @param string $label_type The label type.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/DHL
+ */
+ $classname = apply_filters( 'woocommerce_gzd_shipment_label_class', $classname, $label_id, $label_type, $shipping_provider );
+
+ if ( ! class_exists( $classname ) ) {
+ return false;
+ }
+
+ try {
+ return new $classname( $label_id );
+ } catch ( Exception $e ) {
+ wc_caught_exception( $e, __FUNCTION__, func_get_args() );
+ return false;
+ }
+ }
+
+ public static function get_label_id( $label ) {
+ if ( is_numeric( $label ) ) {
+ return $label;
+ } elseif ( $label instanceof Label ) {
+ return $label->get_id();
+ } elseif ( ! empty( $label->label_id ) ) {
+ return $label->label_id;
+ } else {
+ return false;
+ }
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Labels/Label.php b/packages/woocommerce-germanized-shipments/src/Labels/Label.php
new file mode 100644
index 000000000..d51a0fcde
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Labels/Label.php
@@ -0,0 +1,604 @@
+ null,
+ 'shipment_id' => 0,
+ 'product_id' => '',
+ 'parent_id' => 0,
+ 'number' => '',
+ 'shipping_provider' => '',
+ 'weight' => '',
+ 'net_weight' => '',
+ 'length' => '',
+ 'width' => '',
+ 'height' => '',
+ 'path' => '',
+ 'created_via' => '',
+ 'services' => array(),
+ );
+
+ public function __construct( $data = 0 ) {
+ parent::__construct( $data );
+
+ if ( $data instanceof ShipmentLabel ) {
+ $this->set_id( absint( $data->get_id() ) );
+ } elseif ( is_numeric( $data ) ) {
+ $this->set_id( $data );
+ }
+
+ $this->data_store = WC_Data_Store::load( $this->data_store_name );
+
+ // If we have an ID, load the user from the DB.
+ if ( $this->get_id() ) {
+ try {
+ $this->data_store->read( $this );
+ } catch ( Exception $e ) {
+ $this->set_id( 0 );
+ $this->set_object_read( true );
+ }
+ } else {
+ $this->set_object_read( true );
+ }
+ }
+
+ public function get_type() {
+ return 'simple';
+ }
+
+ /**
+ * Merge changes with data and clear.
+ * Overrides WC_Data::apply_changes.
+ * array_replace_recursive does not work well for license because it merges domains registered instead
+ * of replacing them.
+ *
+ * @since 3.2.0
+ */
+ public function apply_changes() {
+ if ( function_exists( 'array_replace' ) ) {
+ $this->data = array_replace( $this->data, $this->changes ); // phpcs:ignore PHPCompatibility.FunctionUse.NewFunctions.array_replaceFound
+ } else { // PHP 5.2 compatibility.
+ foreach ( $this->changes as $key => $change ) {
+ $this->data[ $key ] = $change;
+ }
+ }
+ $this->changes = array();
+ }
+
+ /**
+ * Prefix for action and filter hooks on data.
+ *
+ * @since 3.0.0
+ * @return string
+ */
+ protected function get_general_hook_prefix() {
+ $prefix = 'simple' === $this->get_type() ? '' : $this->get_type() . '_';
+
+ return "woocommerce_gzd_shipment_{$this->get_shipping_provider()}_{$prefix}label_";
+ }
+
+ /**
+ * Prefix for action and filter hooks on data.
+ *
+ * @since 3.0.0
+ * @return string
+ */
+ protected function get_hook_prefix() {
+ return $this->get_general_hook_prefix() . 'get_';
+ }
+
+ /**
+ * Return the date this license was created.
+ *
+ * @since 3.0.0
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return WC_DateTime|null object if the date is set or null if there is no date.
+ */
+ public function get_date_created( $context = 'view' ) {
+ return $this->get_prop( 'date_created', $context );
+ }
+
+ public function get_shipment_id( $context = 'view' ) {
+ return $this->get_prop( 'shipment_id', $context );
+ }
+
+ public function get_shipping_provider( $context = 'view' ) {
+ return $this->get_prop( 'shipping_provider', $context );
+ }
+
+ public function get_shipping_provider_instance() {
+ $provider = $this->get_shipping_provider();
+
+ if ( ! empty( $provider ) ) {
+ return wc_gzd_get_shipping_provider( $provider );
+ }
+
+ return false;
+ }
+
+ public function get_parent_id( $context = 'view' ) {
+ return $this->get_prop( 'parent_id', $context );
+ }
+
+ public function get_created_via( $context = 'view' ) {
+ return $this->get_prop( 'created_via', $context );
+ }
+
+ public function get_product_id( $context = 'view' ) {
+ return $this->get_prop( 'product_id', $context );
+ }
+
+ public function get_number( $context = 'view' ) {
+ return $this->get_prop( 'number', $context );
+ }
+
+ public function has_number() {
+ $number = $this->get_number();
+
+ return empty( $number ) ? false : true;
+ }
+
+ public function get_weight( $context = 'view' ) {
+ return $this->get_prop( 'weight', $context );
+ }
+
+ public function get_net_weight( $context = 'view' ) {
+ $weight = $this->get_prop( 'net_weight', $context );
+
+ if ( 'view' === $context && '' === $weight ) {
+ $weight = $this->get_weight( $context );
+ }
+
+ return $weight;
+ }
+
+ public function get_length( $context = 'view' ) {
+ return $this->get_prop( 'length', $context );
+ }
+
+ public function get_width( $context = 'view' ) {
+ return $this->get_prop( 'width', $context );
+ }
+
+ public function get_height( $context = 'view' ) {
+ return $this->get_prop( 'height', $context );
+ }
+
+ public function has_dimensions() {
+ $width = $this->get_width();
+ $length = $this->get_length();
+ $height = $this->get_height();
+
+ return ( ! empty( $width ) && ! empty( $length ) && ! empty( $height ) );
+ }
+
+ public function get_path( $context = 'view', $file_path = '' ) {
+ return $this->get_prop( 'path', $context );
+ }
+
+ public function get_services( $context = 'view' ) {
+ return $this->get_prop( 'services', $context );
+ }
+
+ public function has_service( $service ) {
+ return ( in_array( $service, $this->get_services() ) );
+ }
+
+ public function get_shipment() {
+ if ( is_null( $this->shipment ) ) {
+ $this->shipment = ( $this->get_shipment_id() > 0 ? wc_gzd_get_shipment( $this->get_shipment_id() ) : false );
+ }
+
+ return $this->shipment;
+ }
+
+ /*
+ |--------------------------------------------------------------------------
+ | Setters
+ |--------------------------------------------------------------------------
+ */
+
+ /**
+ * Set the date this license was last updated.
+ *
+ * @since 1.0.0
+ * @param string|integer|null $date UTC timestamp, or ISO 8601 DateTime. If the DateTime string has no timezone or offset, WordPress site timezone will be assumed. Null if their is no date.
+ */
+ public function set_date_created( $date = null ) {
+ $this->set_date_prop( 'date_created', $date );
+ }
+
+ public function set_number( $number ) {
+ $this->set_prop( 'number', $number );
+ }
+
+ public function set_product_id( $number ) {
+ $this->set_prop( 'product_id', $number );
+ }
+
+ public function set_shipping_provider( $slug ) {
+ $this->set_prop( 'shipping_provider', $slug );
+ }
+
+ public function set_parent_id( $id ) {
+ $this->set_prop( 'parent_id', absint( $id ) );
+ }
+
+ public function set_created_via( $created_via ) {
+ $this->set_prop( 'created_via', $created_via );
+ }
+
+ public function set_weight( $weight ) {
+ $this->set_prop( 'weight','' !== $weight ? wc_format_decimal( $weight ) : '' );
+ }
+
+ public function set_net_weight( $weight ) {
+ $this->set_prop( 'net_weight','' !== $weight ? wc_format_decimal( $weight ) : '' );
+ }
+
+ public function set_width( $width ) {
+ $this->set_prop( 'width','' !== $width ? wc_format_decimal( $width ) : '' );
+ }
+
+ public function set_length( $length ) {
+ $this->set_prop( 'length','' !== $length ? wc_format_decimal( $length ) : '' );
+ }
+
+ public function set_height( $height ) {
+ $this->set_prop( 'height','' !== $height ? wc_format_decimal( $height ) : '' );
+ }
+
+ public function set_path( $path, $file_type = '' ) {
+ $this->set_prop( 'path', $path );
+ }
+
+ public function set_services( $services ) {
+ $this->set_prop( 'services', empty( $services ) ? array() : (array) $services );
+ }
+
+ /**
+ * Returns linked children labels.
+ *
+ * @return ShipmentLabel[]
+ */
+ public function get_children() {
+ return wc_gzd_get_shipment_labels( array( 'parent_id' => $this->get_id() ) );
+ }
+
+ public function has_children() {
+ $children = $this->get_children();
+
+ return sizeof( $children ) > 0 ? true : false;
+ }
+
+ public function add_service( $service ) {
+ $services = (array) $this->get_services();
+ $available_services = array();
+
+ if ( $provider = $this->get_shipping_provider_instance() ) {
+ if ( $shipment = $this->get_shipment() ) {
+ $available_services = $provider->get_available_label_services( $shipment );
+ }
+ }
+
+ if ( ! in_array( $service, $services ) && in_array( $service, $available_services ) ) {
+ $services[] = $service;
+ $this->set_services( $services );
+
+ return true;
+ }
+
+ return false;
+ }
+
+ public function remove_service( $service ) {
+ $services = (array) $this->get_services();
+
+ if ( in_array( $service, $services ) ) {
+ $services = array_diff( $services, array( $service ) );
+
+ $this->set_services( $services );
+ return true;
+ }
+
+ return false;
+ }
+
+ public function supports_additional_file_type( $file_type ) {
+ return in_array( $file_type, $this->get_additional_file_types() );
+ }
+
+ public function get_additional_file_types() {
+ return array();
+ }
+
+ public function get_file( $file_type = '' ) {
+ if ( ! $path = $this->get_path( 'view', $file_type ) ) {
+ return false;
+ }
+
+ return $this->get_file_by_path( $path );
+ }
+
+ protected function get_new_filename( $file_type = '' ) {
+ $file_parts = array(
+ $this->get_shipping_provider()
+ );
+
+ if ( ! empty( $file_type ) ) {
+ $file_parts[] = $file_type;
+ }
+
+ if ( 'simple' !== $this->get_type() ) {
+ $file_parts[] = $this->get_type();
+ }
+
+ $file_parts[] = $this->get_shipment_id();
+
+ $filename_default = implode( '-', $file_parts );
+ $filename_default = $filename_default . '.pdf';
+ $filename = apply_filters( "{$this->get_hook_prefix()}filename", $filename_default, $this, $file_type );
+
+ return sanitize_file_name( $filename );
+ }
+
+ public function get_filename( $file_type = '' ) {
+ if ( ! $path = $this->get_path( 'view', $file_type ) ) {
+ return $this->get_new_filename( $file_type );
+ }
+
+ return basename( $path );
+ }
+
+ protected function get_file_by_path( $file ) {
+ // If the file is relative, prepend upload dir.
+ if ( $file && 0 !== strpos( $file, '/' ) && ( ( $uploads = Package::get_upload_dir() ) && false === $uploads['error'] ) ) {
+ $file = $uploads['basedir'] . "/$file";
+
+ return $file;
+ } else {
+ return false;
+ }
+ }
+
+ public function set_shipment_id( $shipment_id ) {
+ // Reset order object
+ $this->shipment = null;
+
+ $this->set_prop( 'shipment_id', absint( $shipment_id ) );
+ }
+
+ /**
+ * @param Shipment $shipment
+ */
+ public function set_shipment( &$shipment ) {
+ $this->shipment = $shipment;
+
+ $this->set_prop( 'shipment_id', absint( $shipment->get_id() ) );
+ }
+
+ public function get_download_url( $args = array() ) {
+ $base_url = is_admin() ? admin_url() : trailingslashit( home_url() );
+ $download_url = add_query_arg( array( 'action' => 'wc-gzd-download-shipment-label', 'shipment_id' => $this->get_shipment_id() ), wp_nonce_url( $base_url, 'download-shipment-label' ) );
+
+ foreach( $args as $arg => $val ) {
+ if ( is_bool( $val ) ) {
+ $args[ $arg ] = wc_bool_to_string( $val );
+ }
+ }
+
+ $download_url = add_query_arg( $args, $download_url );
+
+ /**
+ * Filter for shipping providers to adjust the label download URL.
+ *
+ * The dynamic portion of this hook, `$this->get_hook_prefix()` is used to construct a
+ * unique hook for a shipment type. `$provider` is related to the current shipping provider
+ * for the shipment (slug).
+ *
+ * Example hook name: `woocommerce_gzd_return_shipment_get_dhl_label_download_url`
+ *
+ * @param string $url The download URL.
+ * @param Label $label The current shipment instance.
+ *
+ * @since 3.0.6
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( "{$this->get_hook_prefix()}download_url", $download_url, $this );
+ }
+
+ /**
+ * @return \WP_Error|true
+ */
+ public function fetch() {
+ $result = new \WP_Error( 'label-fetch-error', _x( 'This label misses the API implementation', 'shipments', 'woocommerce-germanized' ) );
+
+ return $result;
+ }
+
+ /**
+ * @param $stream
+ * @param string $file_type
+ *
+ * @return false|string
+ */
+ public function upload_label_file( $stream, $file_type = '' ) {
+ try {
+ Package::set_upload_dir_filter();
+ $filename = $this->get_filename( $file_type );
+
+ add_filter( 'wp_unique_filename', function( $new_filename ) use ( $filename ) {
+ return $filename;
+ }, 99 );
+
+ $tmp = wp_upload_bits( $this->get_filename( $file_type ),null, $stream );
+
+ remove_filter( 'wp_unique_filename', function(){}, 99 );
+ Package::unset_upload_dir_filter();
+
+ if ( isset( $tmp['file'] ) ) {
+ $path = $tmp['file'];
+ $path = Package::get_relative_upload_dir( $path );
+
+ $this->set_path( $path, $file_type );
+
+ return $path;
+ } else {
+ throw new Exception( _x( 'Error while uploading label.', 'shipments', 'woocommerce-germanized' ) );
+ }
+ } catch ( Exception $e ) {
+ return false;
+ }
+ }
+
+ /**
+ * @param $url
+ * @param string $file_type
+ *
+ * @return false|string
+ */
+ public function download_label_file( $url, $file_type = '' ) {
+ $timeout_seconds = 5;
+
+ try {
+ if ( ! function_exists( 'download_url' ) ) {
+ include_once( ABSPATH . 'wp-admin/includes/file.php' );
+ }
+
+ if ( ! function_exists( 'download_url' ) ) {
+ throw new \Exception( _x( 'Error while downloading the PDF file.', 'shipments', 'woocommerce-germanized' ) );
+ }
+
+ // Download file to temp dir.
+ $temp_file = download_url( $url, $timeout_seconds );
+
+ if ( is_wp_error( $temp_file ) ) {
+ throw new \Exception( _x( 'Error while downloading the PDF file.', 'shipments', 'woocommerce-germanized' ) );
+ }
+
+ $file = [
+ 'name' => $this->get_filename( $file_type ),
+ 'type' => 'application/pdf',
+ 'tmp_name' => $temp_file,
+ 'error' => 0,
+ 'size' => filesize( $temp_file ),
+ ];
+
+ $overrides = [
+ 'test_type' => false,
+ 'test_form' => false,
+ 'test_size' => true,
+ ];
+
+ // Move the temporary file into the uploads directory.
+ Package::set_upload_dir_filter();
+ $results = wp_handle_sideload( $file, $overrides );
+ Package::unset_upload_dir_filter();
+
+ if ( empty( $results['error'] ) ) {
+ $path = Package::get_relative_upload_dir( $results['file'] );
+
+ $this->set_path( $path, $file_type );
+
+ return $path;
+ } else {
+ throw new \Exception( _x( 'Error while downloading the PDF file.', 'shipments', 'woocommerce-germanized' ) );
+ }
+ } catch( \Exception $e ) {
+ return false;
+ }
+ }
+
+ public function is_trackable() {
+ return true;
+ }
+
+ /**
+ * Gets a prop for a getter method.
+ *
+ * @since 3.0.0
+ * @param string $prop Name of prop to get.
+ * @param string $address billing or shipping.
+ * @param string $context What the value is for. Valid values are view and edit.
+ * @return mixed
+ */
+ protected function get_address_prop( $prop, $address = 'sender_address', $context = 'view' ) {
+ $value = null;
+
+ if ( isset( $this->changes[ $address ][ $prop ] ) || isset( $this->data[ $address ][ $prop ] ) ) {
+ $value = isset( $this->changes[ $address ][ $prop ] ) ? $this->changes[ $address ][ $prop ] : $this->data[ $address ][ $prop ];
+
+ if ( 'view' === $context ) {
+ /**
+ * Filter to adjust a specific address property for a DHL label.
+ *
+ * The dynamic portion of the hook name, `$this->get_hook_prefix()` constructs an individual
+ * hook name which uses `woocommerce_gzd_dhl_label_get_` as a prefix. Additionally
+ * `$address` contains the current address type e.g. sender_address and `$prop` contains the actual
+ * property e.g. street.
+ *
+ * Example hook name: `woocommerce_gzd_dhl_return_label_get_sender_address_street`
+ *
+ * @param string $value The address property value.
+ * @param \Vendidero\Germanized\DHL\Label\Label $label The label object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/DHL
+ */
+ $value = apply_filters( "{$this->get_hook_prefix()}{$address}_{$prop}", $value, $this );
+ }
+ }
+
+ return $value;
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Labels/Query.php b/packages/woocommerce-germanized-shipments/src/Labels/Query.php
new file mode 100644
index 000000000..46a815c44
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Labels/Query.php
@@ -0,0 +1,489 @@
+ 10,
+ 'shipment_id' => '',
+ 'product_id' => '',
+ 'shipping_provider' => '',
+ 'parent_id' => '',
+ 'type' => wc_gzd_get_shipment_label_types(),
+ 'number' => '',
+ 'order' => 'DESC',
+ 'orderby' => 'date_created',
+ 'return' => 'objects',
+ 'page' => 1,
+ 'offset' => '',
+ 'paginate' => false,
+ 'search' => '',
+ 'search_columns' => array(),
+ );
+ }
+
+ /**
+ * Get labels matching the current query vars.
+ *
+ * @return Label[] objects
+ *
+ * @throws \Exception When WC_Data_Store validation fails.
+ */
+ public function get_labels() {
+ /**
+ * Filter to adjust query paramaters for a DHL label query.
+ *
+ * @param array $query_vars The query arguments.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/DHL
+ */
+ $args = apply_filters( 'woocommerce_gzd_shipment_label_query_args', $this->get_query_vars() );
+ $args = WC_Data_Store::load( 'shipment-label' )->get_query_args( $args );
+
+ $this->query( $args );
+
+ /**
+ * Filter to adjust query result data for a DHL label query.
+ *
+ * @param Label[] $results The results.
+ * @param array $args The query arguments.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/DHL
+ */
+ return apply_filters( 'woocommerce_gzd_shipment_label_query', $this->results, $args );
+ }
+
+ public function get_total() {
+ return $this->total_labels;
+ }
+
+ /**
+ * Query shipments.
+ *
+ * @param array $query_args
+ */
+ protected function query( $query_args ) {
+ global $wpdb;
+
+ $this->args = $query_args;
+ $this->parse_query();
+ $this->prepare_query();
+
+ $qv =& $this->args;
+
+ $this->results = null;
+
+ if ( null === $this->results ) {
+ $this->request = "SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit";
+
+ if ( is_array( $qv['fields'] ) || 'objects' == $qv['fields'] ) {
+ $this->results = $wpdb->get_results( $this->request );
+ } else {
+ $this->results = $wpdb->get_col( $this->request );
+ }
+
+ if ( isset( $qv['count_total'] ) && $qv['count_total'] ) {
+ $found_labels_query = 'SELECT FOUND_ROWS()';
+ $this->total_labels = (int) $wpdb->get_var( $found_labels_query );
+ }
+ }
+
+ if ( ! $this->results ) {
+ return;
+ }
+
+ if ( 'objects' == $qv['fields'] ) {
+ foreach ( $this->results as $key => $label ) {
+ $this->results[ $key ] = wc_gzd_get_shipment_label( $label );
+ }
+ }
+ }
+
+ /**
+ * Parse the query before preparing it.
+ */
+ protected function parse_query() {
+
+ if ( isset( $this->args['shipment_id'] ) ) {
+ $this->args['shipment_id'] = absint( $this->args['shipment_id'] );
+ }
+
+ if ( isset( $this->args['shipping_provider'] ) ) {
+ $this->args['shipping_provider'] = sanitize_key( $this->args['shipping_provider'] );
+ }
+
+ if ( isset( $this->args['product_id'] ) ) {
+ $this->args['product_id'] = wc_clean( $this->args['product_id'] );
+ }
+
+ if ( isset( $this->args['parent_id'] ) && ! empty( $this->args['parent_id'] ) ) {
+ $this->args['parent_id'] = absint( $this->args['parent_id'] );
+ }
+
+ if ( isset( $this->args['number'] ) ) {
+ $this->args['number'] = sanitize_key( $this->args['number'] );
+ }
+
+ if ( isset( $this->args['type'] ) ) {
+ $this->args['type'] = (array) $this->args['type'];
+ $this->args['type'] = array_map( 'wc_clean', $this->args['type'] );
+ }
+
+ if ( isset( $this->args['search'] ) ) {
+ $this->args['search'] = wc_clean( $this->args['search'] );
+
+ if ( ! isset( $this->args['search_columns'] ) ) {
+ $this->args['search_columns'] = array();
+ }
+ }
+ }
+
+ /**
+ * Prepare the query for DB usage.
+ */
+ protected function prepare_query() {
+ global $wpdb;
+
+ if ( is_array( $this->args['fields'] ) ) {
+ $this->args['fields'] = array_unique( $this->args['fields'] );
+
+ $this->query_fields = array();
+
+ foreach ( $this->args['fields'] as $field ) {
+ $field = 'ID' === $field ? 'label_id' : sanitize_key( $field );
+ $this->query_fields[] = "$wpdb->gzd_shipment_labels.$field";
+ }
+
+ $this->query_fields = implode( ',', $this->query_fields );
+
+ } elseif ( 'objects' == $this->args['fields'] ) {
+ $this->query_fields = "$wpdb->gzd_shipment_labels.*";
+ } else {
+ $this->query_fields = "$wpdb->gzd_shipment_labels.label_id";
+ }
+
+ if ( isset( $this->args['count_total'] ) && $this->args['count_total'] ) {
+ $this->query_fields = 'SQL_CALC_FOUND_ROWS ' . $this->query_fields;
+ }
+
+ $this->query_from = "FROM $wpdb->gzd_shipment_labels";
+ $this->query_where = 'WHERE 1=1';
+
+ // order id
+ if ( isset( $this->args['shipment_id'] ) ) {
+ $this->query_where .= $wpdb->prepare( ' AND label_shipment_id = %d', $this->args['shipment_id'] );
+ }
+
+ // parent id
+ if ( isset( $this->args['parent_id'] ) ) {
+ $this->query_where .= $wpdb->prepare( ' AND label_parent_id = %d', $this->args['parent_id'] );
+ }
+
+ // Number
+ if ( isset( $this->args['number'] ) ) {
+ $this->query_where .= $wpdb->prepare( " AND label_number IN ('%s')", $this->args['number'] );
+ }
+
+ // Shipping provider
+ if ( isset( $this->args['shipping_provider'] ) ) {
+ $this->query_where .= $wpdb->prepare( " AND label_shipping_provider IN ('%s')", $this->args['shipping_provider'] );
+ }
+
+ // Shipping provider
+ if ( isset( $this->args['product_id'] ) ) {
+ $this->query_where .= $wpdb->prepare( " AND label_product_id IN ('%s')", $this->args['product_id'] );
+ }
+
+ // type
+ if ( isset( $this->args['type'] ) ) {
+ $types = $this->args['type'];
+ $p_types = array();
+
+ foreach( $types as $type ) {
+ $p_types[] = $wpdb->prepare( "label_type = '%s'", $type );
+ }
+
+ $where_type = implode( ' OR ', $p_types );
+
+ if ( ! empty( $where_type ) ) {
+ $this->query_where .= " AND ($where_type)";
+ }
+ }
+
+ // Search
+ $search = '';
+
+ if ( isset( $this->args['search'] ) ) {
+ $search = trim( $this->args['search'] );
+ }
+
+ if ( $search ) {
+
+ $leading_wild = ( ltrim( $search, '*' ) != $search );
+ $trailing_wild = ( rtrim( $search, '*' ) != $search );
+
+ if ( $leading_wild && $trailing_wild ) {
+ $wild = 'both';
+ } elseif ( $leading_wild ) {
+ $wild = 'leading';
+ } elseif ( $trailing_wild ) {
+ $wild = 'trailing';
+ } else {
+ $wild = false;
+ }
+ if ( $wild ) {
+ $search = trim( $search, '*' );
+ }
+
+ $search_columns = array();
+
+ if ( $this->args['search_columns'] ) {
+ $search_columns = array_intersect( $this->args['search_columns'], array( 'label_id', 'label_path', 'label_number', 'label_shipment_id', 'label_product_id' ) );
+ }
+
+ if ( ! $search_columns ) {
+ if ( is_numeric( $search ) ) {
+ $search_columns = array( 'label_id', 'label_shipment_id' );
+ } else {
+ $search_columns = array( 'label_id', 'label_path', 'label_number', 'label_shipment_id', 'label_product_id' );
+ }
+ }
+
+ /**
+ * Filters the columns to search in a DHL LabelQuery search.
+ *
+ * The default columns depend on the search term, and include 'label_id',
+ * 'label_shipment_id', 'label_path' and 'label_number'.
+ *
+ * @since 3.0.0
+ *
+ * @param string[] $search_columns Array of column names to be searched.
+ * @param string $search Text being searched.
+ * @param LabelQuery $this The current LabelQuery instance.
+ *
+ * @package Vendidero/Germanized/DHL
+ */
+ $search_columns = apply_filters( 'woocommerce_gzd_shipment_label_search_columns', $search_columns, $search, $this );
+
+ $this->query_where .= $this->get_search_sql( $search, $search_columns, $wild );
+ }
+
+ // Parse and sanitize 'include', for use by 'orderby' as well as 'include' below.
+ if ( ! empty( $this->args['include'] ) ) {
+ $include = wp_parse_id_list( $this->args['include'] );
+ } else {
+ $include = false;
+ }
+
+ // Meta query.
+ $this->meta_query = new WP_Meta_Query();
+ $this->meta_query->parse_query_vars( $this->args );
+
+ if ( ! empty( $this->meta_query->queries ) ) {
+ $clauses = $this->meta_query->get_sql( 'gzd_shipment_label', $wpdb->gzd_shipment_labels, 'label_id', $this );
+ $this->query_from .= $clauses['join'];
+ $this->query_where .= $clauses['where'];
+
+ if ( $this->meta_query->has_or_relation() ) {
+ $this->query_fields = 'DISTINCT ' . $this->query_fields;
+ }
+ }
+
+ // sorting
+ $this->args['order'] = isset( $this->args['order'] ) ? strtoupper( $this->args['order'] ) : '';
+ $order = $this->parse_order( $this->args['order'] );
+
+ if ( empty( $this->args['orderby'] ) ) {
+ // Default order is by 'user_login'.
+ $ordersby = array( 'date_created' => $order );
+ } elseif ( is_array( $this->args['orderby'] ) ) {
+ $ordersby = $this->args['orderby'];
+ } else {
+ // 'orderby' values may be a comma- or space-separated list.
+ $ordersby = preg_split( '/[,\s]+/', $this->args['orderby'] );
+ }
+
+ $orderby_array = array();
+
+ foreach ( $ordersby as $_key => $_value ) {
+ if ( ! $_value ) {
+ continue;
+ }
+
+ if ( is_int( $_key ) ) {
+ // Integer key means this is a flat array of 'orderby' fields.
+ $_orderby = $_value;
+ $_order = $order;
+ } else {
+ // Non-integer key means this the key is the field and the value is ASC/DESC.
+ $_orderby = $_key;
+ $_order = $_value;
+ }
+
+ $parsed = $this->parse_orderby( $_orderby );
+
+ if ( ! $parsed ) {
+ continue;
+ }
+
+ $orderby_array[] = $parsed . ' ' . $this->parse_order( $_order );
+ }
+
+ // If no valid clauses were found, order by user_login.
+ if ( empty( $orderby_array ) ) {
+ $orderby_array[] = "label_id $order";
+ }
+
+ $this->query_orderby = 'ORDER BY ' . implode( ', ', $orderby_array );
+
+ // limit
+ if ( isset( $this->args['posts_per_page'] ) && $this->args['posts_per_page'] > 0 ) {
+ if ( isset( $this->args['offset'] ) ) {
+ $this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $this->args['offset'], $this->args['posts_per_page'] );
+ } else {
+ $this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $this->args['posts_per_page'] * ( $this->args['page'] - 1 ), $this->args['posts_per_page'] );
+ }
+ }
+
+ if ( ! empty( $include ) ) {
+ // Sanitized earlier.
+ $ids = implode( ',', $include );
+ $this->query_where .= " AND $wpdb->gzd_shipment_labels.label_id IN ($ids)";
+ } elseif ( ! empty( $this->args['exclude'] ) ) {
+ $ids = implode( ',', wp_parse_id_list( $this->args['exclude'] ) );
+ $this->query_where .= " AND $wpdb->gzd_shipment_labels.label_id NOT IN ($ids)";
+ }
+
+ // Date queries are allowed for the user_registered field.
+ if ( ! empty( $this->args['date_query'] ) && is_array( $this->args['date_query'] ) ) {
+ $date_query = new WP_Date_Query( $this->args['date_query'], 'label_date_created' );
+ $this->query_where .= $date_query->get_sql();
+ }
+ }
+
+ /**
+ * Used internally to generate an SQL string for searching across multiple columns
+ *
+ * @since 3.0.6
+ *
+ * @global \wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param string $string
+ * @param array $cols
+ * @param bool $wild Whether to allow wildcard searches. Default is false for Network Admin, true for single site.
+ * Single site allows leading and trailing wildcards, Network Admin only trailing.
+ * @return string
+ */
+ protected function get_search_sql( $string, $cols, $wild = false ) {
+ global $wpdb;
+
+ $searches = array();
+ $leading_wild = ( 'leading' == $wild || 'both' == $wild ) ? '%' : '';
+ $trailing_wild = ( 'trailing' == $wild || 'both' == $wild ) ? '%' : '';
+ $like = $leading_wild . $wpdb->esc_like( $string ) . $trailing_wild;
+
+ foreach ( $cols as $col ) {
+ if ( 'ID' == $col ) {
+ $searches[] = $wpdb->prepare( "$col = %s", $string );
+ } else {
+ $searches[] = $wpdb->prepare( "$col LIKE %s", $like );
+ }
+ }
+
+ return ' AND (' . implode( ' OR ', $searches ) . ')';
+ }
+
+ /**
+ * Parse orderby statement.
+ *
+ * @param string $orderby
+ * @return string
+ */
+ protected function parse_orderby( $orderby ) {
+ global $wpdb;
+
+ $meta_query_clauses = $this->meta_query->get_clauses();
+
+ $_orderby = '';
+
+ if ( in_array( $orderby, array( 'number', 'shipment_id', 'date_created' ) ) ) {
+ $_orderby = 'label_' . $orderby;
+ } elseif ( 'ID' == $orderby || 'id' == $orderby ) {
+ $_orderby = 'label_id';
+ } elseif ( 'meta_value' == $orderby || $this->get( 'meta_key' ) == $orderby ) {
+ $_orderby = "$wpdb->gzd_shipment_labelmeta.meta_value";
+ } elseif ( 'meta_value_num' == $orderby ) {
+ $_orderby = "$wpdb->gzd_shipment_labelmeta.meta_value+0";
+ } elseif ( 'include' === $orderby && ! empty( $this->args['include'] ) ) {
+ $include = wp_parse_id_list( $this->args['include'] );
+ $include_sql = implode( ',', $include );
+ $_orderby = "FIELD( $wpdb->gzd_shipment_labels.label_id, $include_sql )";
+ } elseif ( isset( $meta_query_clauses[ $orderby ] ) ) {
+ $meta_clause = $meta_query_clauses[ $orderby ];
+ $_orderby = sprintf( 'CAST(%s.meta_value AS %s)', esc_sql( $meta_clause['alias'] ), esc_sql( $meta_clause['cast'] ) );
+ }
+
+ return $_orderby;
+ }
+
+ /**
+ * Parse order statement.
+ *
+ * @param string $order
+ * @return string
+ */
+ protected function parse_order( $order ) {
+ if ( ! is_string( $order ) || empty( $order ) ) {
+ return 'DESC';
+ }
+
+ if ( 'ASC' === strtoupper( $order ) ) {
+ return 'ASC';
+ } else {
+ return 'DESC';
+ }
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Labels/ReturnLabel.php b/packages/woocommerce-germanized-shipments/src/Labels/ReturnLabel.php
new file mode 100644
index 000000000..40ae4315f
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Labels/ReturnLabel.php
@@ -0,0 +1,119 @@
+ array(),
+ );
+
+ public function get_type() {
+ return 'return';
+ }
+
+ public function get_sender_address( $context = 'view' ) {
+ return $this->get_prop( 'sender_address', $context );
+ }
+
+ /**
+ * Gets a prop for a getter method.
+ *
+ * @since 3.0.0
+ * @param string $prop Name of prop to get.
+ * @param string $address billing or shipping.
+ * @param string $context What the value is for. Valid values are view and edit.
+ * @return mixed
+ */
+ protected function get_sender_address_prop( $prop, $context = 'view' ) {
+ $value = $this->get_address_prop( $prop, 'sender_address', $context );
+
+ return $value;
+ }
+
+ public function get_sender_address_2( $context = 'view' ) {
+ return $this->get_sender_address_prop( 'address_2', $context );
+ }
+
+ public function get_sender_address_addition() {
+ $addition = $this->get_sender_address_2();
+ $street_addition = $this->get_sender_street_addition();
+
+ if ( ! empty( $street_addition ) ) {
+ $addition = $street_addition . ( ! empty( $addition ) ? ' ' . $addition : '' );
+ }
+
+ return trim( $addition );
+ }
+
+ public function get_sender_street( $context = 'view' ) {
+ return $this->get_sender_address_prop( 'street', $context );
+ }
+
+ public function get_sender_street_number( $context = 'view' ) {
+ return $this->get_sender_address_prop( 'street_number', $context );
+ }
+
+ public function get_sender_street_addition( $context = 'view' ) {
+ return $this->get_sender_address_prop( 'street_addition', $context );
+ }
+
+ public function get_sender_company( $context = 'view' ) {
+ return $this->get_sender_address_prop( 'company', $context );
+ }
+
+ public function get_sender_name( $context = 'view' ) {
+ return $this->get_sender_address_prop( 'name', $context );
+ }
+
+ public function get_sender_formatted_full_name() {
+ return sprintf( _x( '%1$s', 'shipments full name', 'woocommerce-germanized' ), $this->get_sender_name() );
+ }
+
+ public function get_sender_postcode( $context = 'view' ) {
+ return $this->get_sender_address_prop( 'postcode', $context );
+ }
+
+ public function get_sender_city( $context = 'view' ) {
+ return $this->get_sender_address_prop( 'city', $context );
+ }
+
+ public function get_sender_state( $context = 'view' ) {
+ return $this->get_sender_address_prop( 'state', $context );
+ }
+
+ public function get_sender_country( $context = 'view' ) {
+ return $this->get_sender_address_prop( 'country', $context );
+ }
+
+ public function get_sender_phone( $context = 'view' ) {
+ return $this->get_sender_address_prop( 'phone', $context );
+ }
+
+ public function get_sender_email( $context = 'view' ) {
+ return $this->get_sender_address_prop( 'email', $context );
+ }
+
+ public function set_sender_address( $value ) {
+ $this->set_prop( 'sender_address', empty( $value ) ? array() : (array) $value );
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Order.php b/packages/woocommerce-germanized-shipments/src/Order.php
new file mode 100644
index 000000000..b5d58a2b1
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Order.php
@@ -0,0 +1,910 @@
+order = $order;
+ }
+
+ /**
+ * Returns the Woo WC_Order original object
+ *
+ * @return object|WC_Order
+ */
+ public function get_order() {
+ return $this->order;
+ }
+
+ /**
+ * @return WC_DateTime|null
+ */
+ public function get_date_shipped() {
+ $date_shipped = $this->get_order()->get_meta( '_date_shipped', true );
+
+ if ( $date_shipped ) {
+ try {
+ $date_shipped = new WC_DateTime( "@{$date_shipped}" );
+
+ // Set local timezone or offset.
+ if ( get_option( 'timezone_string' ) ) {
+ $date_shipped->setTimezone( new DateTimeZone( wc_timezone_string() ) );
+ } else {
+ $date_shipped->set_utc_offset( wc_timezone_offset() );
+ }
+ } catch( Exception $e ) {
+ $date_shipped = null;
+ }
+ } else {
+ $date_shipped = null;
+ }
+
+ return $date_shipped;
+ }
+
+ public function get_shipping_status() {
+ $status = 'not-shipped';
+ $shipments = $this->get_simple_shipments();
+
+ if ( ! empty( $shipments ) ) {
+ foreach( $shipments as $shipment ) {
+
+ if ( $shipment->has_status( wc_gzd_get_shipment_sent_statuses() ) ) {
+ $status = 'partially-shipped';
+ break;
+ }
+ }
+ }
+
+ if ( ! $this->needs_shipping( array( 'sent_only' => true ) ) ) {
+ $status = 'shipped';
+ }
+
+ return $status;
+ }
+
+ public function has_shipped_shipments() {
+ $shipments = $this->get_simple_shipments();
+
+ foreach( $shipments as $shipment ) {
+
+ if ( $shipment->has_status( wc_gzd_get_shipment_sent_statuses() ) ) {
+ return true;
+ }
+ }
+
+ return false;
+ }
+
+ public function get_return_status() {
+ $status = 'open';
+ $shipments = $this->get_return_shipments();
+
+ if ( ! empty( $shipments ) ) {
+ foreach( $shipments as $shipment ) {
+
+ if ( $shipment->has_status( 'delivered' ) ) {
+ $status = 'partially-returned';
+ break;
+ }
+ }
+ }
+
+ if ( ! $this->needs_return( array( 'delivered_only' => true ) ) && $this->has_shipped_shipments() ) {
+ $status = 'returned';
+ }
+
+ return $status;
+ }
+
+ public function get_default_return_shipping_provider() {
+ $default_provider_instance = wc_gzd_get_order_shipping_provider( $this->get_order() );
+ $default_provider = $default_provider_instance ? $default_provider_instance->get_name() : '';
+ $shipments = $this->get_simple_shipments();
+
+ foreach( $shipments as $shipment ) {
+ if ( $shipment->has_status( wc_gzd_get_shipment_sent_statuses() ) ) {
+ $default_provider = $shipment->get_shipping_provider();
+ }
+ }
+
+ return apply_filters( 'woocommerce_gzd_shipment_order_return_default_shipping_provider', $default_provider, $this );
+ }
+
+ public function validate_shipments( $args = array() ) {
+ $args = wp_parse_args( $args, array(
+ 'save' => true,
+ ) );
+
+ foreach( $this->get_simple_shipments() as $shipment ) {
+
+ if ( $shipment->is_editable() ) {
+
+ // Make sure we are working based on the current instance.
+ $shipment->set_order_shipment( $this );
+ $shipment->sync();
+
+ $this->validate_shipment_item_quantities( $shipment->get_id() );
+ }
+ }
+
+ if ( $args['save'] ) {
+ $this->save();
+ }
+ }
+
+ public function validate_shipment_item_quantities( $shipment_id = false ) {
+ $shipment = $shipment_id ? $this->get_shipment( $shipment_id ) : false;
+ $shipments = ( $shipment_id && $shipment ) ? array( $shipment ) : $this->get_simple_shipments();
+ $order_items = $this->get_shippable_items();
+
+ foreach( $shipments as $shipment ) {
+
+ if ( ! is_a( $shipment, 'Vendidero\Germanized\Shipments\Shipment' ) ) {
+ continue;
+ }
+
+ // Do only check draft shipments
+ if ( $shipment->is_editable() ) {
+ foreach( $shipment->get_items() as $item ) {
+
+ // Order item does not exist
+ if ( ! isset( $order_items[ $item->get_order_item_id() ] ) ) {
+
+ /**
+ * Filter to decide whether to keep non-existing OrderItems within
+ * the Shipment while validating or not.
+ *
+ * @param boolean $keep Whether to keep non-existing OrderItems or not.
+ * @param ShipmentItem $item The shipment item object.
+ * @param Shipment $shipment The shipment object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ if ( ! apply_filters( 'woocommerce_gzd_shipment_order_keep_non_order_item', false, $item, $shipment ) ) {
+ $shipment->remove_item( $item->get_id() );
+ }
+
+ continue;
+ }
+
+ $order_item = $order_items[ $item->get_order_item_id() ];
+ $quantity = $this->get_item_quantity_left_for_shipping( $order_item, array(
+ 'shipment_id' => $shipment->get_id(),
+ 'exclude_current_shipment' => true,
+ ) );
+
+ if ( $quantity <= 0 ) {
+ $shipment->remove_item( $item->get_id() );
+ } else {
+ $new_quantity = $item->get_quantity();
+
+ if ( $item->get_quantity() > $quantity ) {
+ $new_quantity = $quantity;
+ }
+
+ $item->sync( array( 'quantity' => $new_quantity ) );
+ }
+ }
+
+ if ( empty( $shipment->get_items() ) ) {
+ $this->remove_shipment( $shipment->get_id() );
+ }
+ }
+ }
+ }
+
+ /**
+ * @return Shipment[] Shipments
+ */
+ public function get_shipments() {
+
+ if ( is_null( $this->shipments ) ) {
+
+ $this->shipments = wc_gzd_get_shipments( array(
+ 'order_id' => $this->get_order()->get_id(),
+ 'limit' => -1,
+ 'orderby' => 'date_created',
+ 'type' => array( 'simple', 'return' ),
+ 'order' => 'ASC'
+ ) );
+ }
+
+ $shipments = (array) $this->shipments;
+
+ return $shipments;
+ }
+
+ /**
+ * @return SimpleShipment[]
+ */
+ public function get_simple_shipments() {
+ $simple = array();
+
+ foreach( $this->get_shipments() as $shipment ) {
+ if ( 'simple' === $shipment->get_type() ) {
+ $simple[] = $shipment;
+ }
+ }
+
+ return $simple;
+ }
+
+ /**
+ * @return ReturnShipment[]
+ */
+ public function get_return_shipments() {
+ $returns = array();
+
+ foreach( $this->get_shipments() as $shipment ) {
+ if ( 'return' === $shipment->get_type() ) {
+ $returns[] = $shipment;
+ }
+ }
+
+ return $returns;
+ }
+
+ public function add_shipment( &$shipment ) {
+ $shipments = $this->get_shipments();
+
+ $this->shipments[] = $shipment;
+ }
+
+ public function remove_shipment( $shipment_id ) {
+ $shipments = $this->get_shipments();
+
+ foreach( $this->shipments as $key => $shipment ) {
+
+ if ( $shipment->get_id() === (int) $shipment_id ) {
+ $this->shipments_to_delete[] = $shipment;
+
+ unset( $this->shipments[ $key ] );
+ break;
+ }
+ }
+ }
+
+ /**
+ * @param $shipment_id
+ *
+ * @return bool|SimpleShipment|ReturnShipment
+ */
+ public function get_shipment( $shipment_id ) {
+ $shipments = $this->get_shipments();
+
+ foreach( $shipments as $shipment ) {
+
+ if ( $shipment->get_id() === (int) $shipment_id ) {
+ return $shipment;
+ }
+ }
+
+ return false;
+ }
+
+ /**
+ * @param WC_Order_Item $order_item
+ */
+ public function get_item_quantity_left_for_shipping( $order_item, $args = array() ) {
+ $quantity_left = 0;
+ $args = wp_parse_args( $args, array(
+ 'sent_only' => false,
+ 'shipment_id' => 0,
+ 'exclude_current_shipment' => false,
+ ) );
+
+ if ( is_numeric( $order_item ) ) {
+ $order_item = $this->get_order()->get_item( $order_item );
+ }
+
+ if ( $order_item ) {
+ $quantity_left = $this->get_shippable_item_quantity( $order_item );
+
+ foreach( $this->get_simple_shipments() as $shipment ) {
+
+ if ( $args['sent_only'] && ! $shipment->has_status( wc_gzd_get_shipment_sent_statuses() ) ) {
+ continue;
+ }
+
+ if ( $args['exclude_current_shipment'] && $args['shipment_id'] > 0 && ( $shipment->get_id() === $args['shipment_id'] ) ) {
+ continue;
+ }
+
+ if ( $item = $shipment->get_item_by_order_item_id( $order_item->get_id() ) ) {
+ $quantity_left -= $item->get_quantity();
+ }
+ }
+ }
+
+ if ( $quantity_left < 0 ) {
+ $quantity_left = 0;
+ }
+
+ /**
+ * Filter to adjust the quantity left for shipment of a specific order item.
+ *
+ * @param integer $quantity_left The quantity left for shipment.
+ * @param WC_Order_Item $order_item The order item object.
+ * @param Order $this The shipment order object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipment_order_item_quantity_left_for_shipping', $quantity_left, $order_item, $this );
+ }
+
+ public function get_item_quantity_sent_by_order_item_id( $order_item_id ) {
+ $shipments = $this->get_simple_shipments();
+ $quantity = 0;
+
+ foreach( $shipments as $shipment ) {
+
+ if ( ! $shipment->has_status( wc_gzd_get_shipment_sent_statuses() ) ) {
+ continue;
+ }
+
+ if ( $item = $shipment->get_item_by_order_item_id( $order_item_id ) ) {
+ $quantity += $item->get_quantity();
+ }
+ }
+
+ return $quantity;
+ }
+
+ /**
+ * @param ShipmentItem $item
+ */
+ public function get_item_quantity_left_for_returning( $order_item_id, $args = array() ) {
+ $quantity_left = 0;
+ $args = wp_parse_args( $args, array(
+ 'delivered_only' => false,
+ 'shipment_id' => 0,
+ 'exclude_current_shipment' => false,
+ ) );
+
+ $quantity_left = $this->get_item_quantity_sent_by_order_item_id( $order_item_id );
+
+ foreach( $this->get_return_shipments() as $shipment ) {
+
+ if ( $args['delivered_only'] && ! $shipment->has_status( 'delivered' ) ) {
+ continue;
+ }
+
+ if ( $args['exclude_current_shipment'] && $args['shipment_id'] > 0 && ( $shipment->get_id() === $args['shipment_id'] ) ) {
+ continue;
+ }
+
+ if ( $shipment_item = $shipment->get_item_by_order_item_id( $order_item_id ) ) {
+ $quantity_left -= $shipment_item->get_quantity();
+ }
+ }
+
+ if ( $quantity_left < 0 ) {
+ $quantity_left = 0;
+ }
+
+ /**
+ * Filter to adjust the quantity left for returning of a specific order item.
+ *
+ * @param integer $quantity_left The quantity left for shipment.
+ * @param integer $order_item_id The order item id.
+ * @param Order $this The shipment order object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipment_order_item_quantity_left_for_returning', $quantity_left, $order_item_id, $this );
+ }
+
+ public function get_items_to_pack_left_for_shipping( $group_by_shipping_class = false ) {
+ $items = $this->get_available_items_for_shipment();
+ $items_to_be_packed = array();
+
+ foreach( $items as $order_item_id => $item ) {
+
+ if ( ! $order_item = $this->get_order()->get_item( $order_item_id ) ) {
+ continue;
+ }
+
+ $shipping_class = '';
+
+ if ( $group_by_shipping_class ) {
+ if ( $product = $order_item->get_product() ) {
+ $shipping_class = $product->get_shipping_class();
+ }
+ }
+
+ for ( $i = 0; $i < $item['max_quantity']; $i++ ) {
+ try {
+ $box_item = new Packing\OrderItem( $order_item );
+
+ if ( ! isset( $items_to_be_packed[ $shipping_class ] ) ) {
+ $items_to_be_packed[ $shipping_class ] = array();
+ }
+
+ $items_to_be_packed[ $shipping_class ][] = $box_item;
+ } catch( \Exception $e ) {}
+ }
+ }
+
+ return apply_filters( 'woocommerce_gzd_shipment_order_items_to_pack_left_for_shipping', $items_to_be_packed, $group_by_shipping_class );
+ }
+
+ /**
+ * @param bool|Shipment $shipment
+ * @return array
+ */
+ public function get_available_items_for_shipment( $args = array() ) {
+ $args = wp_parse_args( $args, array(
+ 'disable_duplicates' => false,
+ 'shipment_id' => 0,
+ 'sent_only' => false,
+ 'exclude_current_shipment' => false,
+ ) );
+
+ $items = array();
+ $shipment = $args['shipment_id'] ? $this->get_shipment( $args['shipment_id'] ) : false;
+
+ foreach( $this->get_shippable_items() as $item ) {
+ $quantity_left = $this->get_item_quantity_left_for_shipping( $item, $args );
+
+ if ( $shipment ) {
+ if ( $args['disable_duplicates'] && $shipment->get_item_by_order_item_id( $item->get_id() ) ) {
+ continue;
+ }
+ }
+
+ if ( $quantity_left > 0 ) {
+ $sku = '';
+
+ if ( is_callable( array( $item, 'get_product' ) ) ) {
+ if ( $product = $item->get_product() ) {
+ $sku = $product->get_sku();
+ }
+ }
+
+ $items[ $item->get_id() ] = array(
+ 'name' => $item->get_name() . ( ! empty( $sku ) ? ' (' . esc_html( $sku ) . ')' : '' ),
+ 'max_quantity' => $quantity_left,
+ );
+ }
+ }
+
+ return $items;
+ }
+
+ /**
+ * Returns the first found matching shipment item for a certain order item id.
+ *
+ * @param $order_item_id
+ *
+ * @return bool|ShipmentItem
+ */
+ public function get_simple_shipment_item( $order_item_id ) {
+ foreach( $this->get_simple_shipments() as $shipment ) {
+
+ if ( $item = $shipment->get_item_by_order_item_id( $order_item_id ) ) {
+ return $item;
+ }
+ }
+
+ return false;
+ }
+
+ /**
+ * @return array
+ */
+ public function get_available_items_for_return( $args = array() ) {
+ $args = wp_parse_args( $args, array(
+ 'disable_duplicates' => false,
+ 'shipment_id' => 0,
+ 'delivered_only' => false,
+ 'exclude_current_shipment' => false,
+ ) );
+
+ $items = array();
+ $shipment = $args['shipment_id'] ? $this->get_shipment( $args['shipment_id'] ) : false;
+
+ foreach( $this->get_returnable_items() as $item ) {
+ $quantity_left = $this->get_item_quantity_left_for_returning( $item->get_order_item_id(), $args );
+
+ if ( $shipment ) {
+ if ( $args['disable_duplicates'] && $shipment->get_item_by_order_item_id( $item->get_order_item_id() ) ) {
+ continue;
+ }
+ }
+
+ if ( $quantity_left > 0 ) {
+ $sku = $item->get_sku();
+
+ $items[ $item->get_order_item_id() ] = array(
+ 'name' => $item->get_name() . ( ! empty( $sku ) ? ' (' . esc_html( $sku ) . ')' : '' ),
+ 'max_quantity' => $quantity_left,
+ );
+ }
+ }
+
+ return $items;
+ }
+
+ public function item_needs_shipping( $order_item, $args = array() ) {
+ $args = wp_parse_args( $args, array(
+ 'sent_only' => false,
+ ) );
+
+ $needs_shipping = false;
+
+ if ( $this->get_item_quantity_left_for_shipping( $order_item, $args ) > 0 ) {
+ $needs_shipping = true;
+ }
+
+ /**
+ * Filter to decide whether an order item needs shipping or not.
+ *
+ * @param boolean $needs_shipping Whether the item needs shipping or not.
+ * @param WC_Order_Item $item The order item object.
+ * @param array $args Additional arguments to be considered.
+ * @param Order $order The shipment order object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipment_order_item_needs_shipping', $needs_shipping, $order_item, $args, $this );
+ }
+
+ /**
+ * Checks whether an item needs return or not by checking the quantity left for return.
+ *
+ * @param ShipmentItem $item
+ * @param array $args
+ *
+ * @return mixed|void
+ */
+ public function item_needs_return( $item, $args = array() ) {
+ $args = wp_parse_args( $args, array(
+ 'delivered_only' => false,
+ ) );
+
+ $needs_return = false;
+
+ if ( $this->get_item_quantity_left_for_returning( $item->get_order_item_id(), $args ) > 0 ) {
+ $needs_return = true;
+ }
+
+ /**
+ * Filter to decide whether a shipment item needs return or not.
+ *
+ * @param boolean $needs_return Whether the item needs return or not.
+ * @param ShipmentItem $item The order item object.
+ * @param array $args Additional arguments to be considered.
+ * @param Order $order The shipment order object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipment_item_needs_return', $needs_return, $item, $args, $this );
+ }
+
+ /**
+ * Returns the return request key added to allow a guest customer to add
+ * a new return request to a certain order.
+ *
+ * @return mixed
+ */
+ public function get_order_return_request_key() {
+ return $this->get_order()->get_meta( '_return_request_key' );
+ }
+
+ /**
+ * Removes the return request key from the order. Saves the order.
+ */
+ public function delete_order_return_request_key() {
+ $this->get_order()->delete_meta_data( '_return_request_key' );
+ $this->get_order()->save();
+ }
+
+ /**
+ * Returns items that are ready for shipping (defaults to non-virtual line items).
+ *
+ * @return WC_Order_Item[] Shippable items.
+ */
+ public function get_shippable_items() {
+ $items = $this->get_order()->get_items( 'line_item' );
+
+ foreach( $items as $key => $item ) {
+ $product = is_callable( array( $item, 'get_product' ) ) ? $item->get_product() : false;
+
+ if ( $product ) {
+ if ( $product->is_virtual() || $this->get_shippable_item_quantity( $item ) <= 0 ) {
+ unset( $items[ $key ] );
+ }
+ }
+ }
+
+ $items = array_filter( $items );
+
+ /**
+ * Filter to adjust shippable order items for a specific order.
+ * By default excludes virtual items.
+ *
+ * @param WC_Order_Item[] $items Array containing shippable order items.
+ * @param WC_Order $order The order object.
+ * @param Order $order The shipment order object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipment_order_shippable_items', $items, $this->get_order(), $this );
+ }
+
+ /**
+ * Returns items that are ready for return. By default only shipped (or delivered) items are returnable.
+ *
+ * @return ShipmentItem[] Shippable items.
+ */
+ public function get_returnable_items() {
+ $items = array();
+
+ foreach( $this->get_simple_shipments() as $shipment ) {
+
+ if ( ! $shipment->has_status( wc_gzd_get_shipment_sent_statuses() ) ) {
+ continue;
+ }
+
+ foreach( $shipment->get_items() as $item ) {
+
+ if ( ! isset( $items[ $item->get_order_item_id() ] ) ) {
+ $new_item = clone $item;
+ $items[ $item->get_order_item_id() ] = $new_item;
+ } else {
+ $new_quantity = $items[ $item->get_order_item_id() ]->get_quantity() + $item->get_quantity();
+ $items[ $item->get_order_item_id() ]->set_quantity( $new_quantity );
+ }
+ }
+ }
+
+ /**
+ * Filter to adjust returnable items for a specific order.
+ *
+ * @param ShipmentItem[] $items Array containing shippable order items.
+ * @param WC_Order $order The order object.
+ * @param Order $order The shipment order object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipment_order_returnable_items', $items, $this->get_order(), $this );
+ }
+
+ public function get_shippable_item_quantity( $order_item ) {
+ $refunded_qty = $this->get_order()->get_qty_refunded_for_item( $order_item->get_id() );
+
+ // Make sure we are safe to substract quantity for logical purposes
+ if ( $refunded_qty < 0 ) {
+ $refunded_qty *= -1;
+ }
+
+ $quantity_left = $order_item->get_quantity() - $refunded_qty;
+
+ /**
+ * Filter that allows adjusting the quantity left for shipping or a specific order item.
+ *
+ * @param integer $quantity_left The quantity left for shipping.
+ * @param WC_Order_Item $item The order item object.
+ * @param Order $order The shipment order object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipment_order_item_shippable_quantity', $quantity_left, $order_item, $this );
+ }
+
+ /**
+ * Returns the total number of shippable items.
+ *
+ * @return mixed|void
+ */
+ public function get_shippable_item_count() {
+ $count = 0;
+
+ foreach( $this->get_shippable_items() as $item ) {
+ $count += $this->get_shippable_item_quantity( $item );
+ }
+
+ /**
+ * Filters the total number of shippable items available in an order.
+ *
+ * @param integer $count The total number of items.
+ * @param Order $order The shipment order object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipment_order_shippable_item_count', $count, $this );
+ }
+
+ /**
+ * Returns the number of total returnable items.
+ *
+ * @return mixed|void
+ */
+ public function get_returnable_item_count() {
+ $count = 0;
+
+ foreach( $this->get_returnable_items() as $item ) {
+ $count += $item->get_quantity();
+ }
+
+ /**
+ * Filters the total number of returnable items available in an order.
+ *
+ * @param integer $count The total number of items.
+ * @param Order $order The shipment order object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipment_order_returnable_item_count', $count, $this );
+ }
+
+ protected function has_local_pickup() {
+ $shipping_methods = $this->get_order()->get_shipping_methods();
+ $has_pickup = false;
+
+ /**
+ * Filters which shipping methods are considered local pickup method
+ * which by default do not require shipment.
+ *
+ * @param string[] $pickup_methods Array of local pickup shipping method ids.
+ *
+ * @since 3.1.6
+ * @package Vendidero/Germanized/Shipments
+ */
+ $pickup_methods = apply_filters( 'woocommerce_gzd_shipment_local_pickup_shipping_methods', array( 'local_pickup' ) );
+
+ foreach( $shipping_methods as $shipping_method ) {
+ if ( in_array( $shipping_method->get_method_id(), $pickup_methods ) ) {
+ $has_pickup = true;
+ break;
+ }
+ }
+
+ return $has_pickup;
+ }
+
+ /**
+ * Checks whether the order needs shipping or not by checking quantity
+ * for every line item.
+ *
+ * @param bool $sent_only Whether to only include shipments treated as sent or not.
+ *
+ * @return bool Whether the order needs shipping or not.
+ */
+ public function needs_shipping( $args = array() ) {
+ $args = wp_parse_args( $args, array(
+ 'sent_only' => false
+ ) );
+
+ $order_items = $this->get_shippable_items();
+ $needs_shipping = false;
+ $has_pickup = $this->has_local_pickup();
+
+ if ( ! $has_pickup ) {
+ foreach( $order_items as $order_item ) {
+ if ( $this->item_needs_shipping( $order_item, $args ) ) {
+ $needs_shipping = true;
+ break;
+ }
+ }
+ }
+
+ /**
+ * Filter to decide whether an order needs shipping or not.
+ *
+ * @param boolean $needs_shipping Whether the order needs shipping or not.
+ * @param WC_Order $order The order object.
+ * @param Order $order The shipment order object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipment_order_needs_shipping', $needs_shipping, $this->get_order(), $this );
+ }
+
+ /**
+ * Checks whether the order needs return or not by checking quantity
+ * for every line item.
+ *
+ * @return bool Whether the order needs shipping or not.
+ */
+ public function needs_return( $args = array() ) {
+ $args = wp_parse_args( $args, array(
+ 'delivered_only' => false
+ ) );
+
+ $items = $this->get_returnable_items();
+ $needs_return = false;
+
+ foreach( $items as $item ) {
+
+ if ( $this->item_needs_return( $item, $args ) ) {
+ $needs_return = true;
+ break;
+ }
+ }
+
+ /**
+ * Filter to decide whether an order needs return or not.
+ *
+ * @param boolean $needs_return Whether the order needs return or not.
+ * @param WC_Order $order The order object.
+ * @param Order $order The shipment order object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipment_order_needs_return', $needs_return, $this->get_order(), $this );
+ }
+
+ public function save() {
+ if ( ! empty( $this->shipments_to_delete ) ) {
+
+ foreach( $this->shipments_to_delete as $shipment ) {
+ $shipment->delete( true );
+ }
+ }
+
+ foreach( $this->shipments as $shipment ) {
+ $shipment->save();
+ }
+ }
+
+ /**
+ * Call child methods if the method does not exist.
+ *
+ * @param $method
+ * @param $args
+ *
+ * @return bool|mixed
+ */
+ public function __call( $method, $args ) {
+
+ if ( method_exists( $this->order, $method ) ) {
+ return call_user_func_array( array( $this->order, $method ), $args );
+ }
+
+ return false;
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/PDFMerger.php b/packages/woocommerce-germanized-shipments/src/PDFMerger.php
new file mode 100644
index 000000000..92bfdefea
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/PDFMerger.php
@@ -0,0 +1,143 @@
+_pdf = new Fpdi();
+ }
+
+ /**
+ * Add file to this pdf
+ *
+ * @param string $filename Filename of the source file
+ * @param mixed $pages Range of files (if not set, all pages where imported)
+ */
+ public function add( $filename, $pages = [], $width = 210 ) {
+ if ( file_exists( $filename ) ) {
+ $pageCount = $this->_pdf->setSourceFile( $filename );
+
+ for ( $i = 1; $i <= $pageCount; $i ++ ) {
+ if ( $this->_isPageInRange( $i, $pages ) ) {
+ $this->_addPage( $i, $width );
+ }
+ }
+ }
+
+ return $this;
+ }
+
+ /**
+ * Output merged pdf
+ *
+ * @param string $type
+ */
+ public function output( $filename, $type = 'I' ) {
+ return $this->_pdf->Output( $type, $filename );
+ }
+
+ /**
+ * Force download merged pdf as file
+ *
+ * @param $filename
+ *
+ * @return string
+ */
+ public function download( $filename ) {
+ return $this->output( $filename, 'D' );
+ }
+
+ /**
+ * Save merged pdf
+ *
+ * @param $filename
+ *
+ * @return string
+ */
+ public function save( $filename ) {
+ return $this->output( $filename, 'F' );
+ }
+
+ /**
+ * Add single page
+ *
+ * @param $pageNumber
+ *
+ * @throws PdfReaderException
+ */
+ private function _addPage( $pageNumber, $width = 210 ) {
+ $pageId = $this->_pdf->importPage( $pageNumber );
+ $size = $this->_pdf->getTemplateSize( $pageId );
+
+ $orientation = isset( $size['orientation'] ) ? $size['orientation'] : '';
+
+ $this->_pdf->addPage( $orientation, $size );
+
+ if ( ! isset( $size['width'] ) || empty( $size['width'] ) ) {
+ $this->_pdf->useImportedPage( $pageId, 0, 0, $width, null, true );
+ } else {
+ $this->_pdf->useImportedPage( $pageId );
+ }
+ }
+
+
+ /**
+ * Check if a specific page should be merged.
+ * If pages are empty, all pages will be merged
+ *
+ * @return bool
+ */
+ private function _isPageInRange( $pageNumber, $pages = [] ) {
+ if ( empty( $pages ) ) {
+ return true;
+ }
+
+ foreach ( $pages as $range ) {
+ if ( in_array( $pageNumber, $this->_getRange( $range ) ) ) {
+ return true;
+ }
+ }
+
+ return false;
+ }
+
+
+ /**
+ * Get range by given value
+ *
+ * @param mixed $value
+ *
+ * @return array
+ */
+ private function _getRange( $value = null ) {
+ $value = preg_replace( '/[^0-9\-.]/is', '', $value );
+
+ if ( $value == '' ) {
+ return false;
+ }
+
+ $value = explode( '-', $value );
+ if ( count( $value ) == 1 ) {
+ return $value;
+ }
+
+ return range( $value[0] > $value[1] ? $value[1] : $value[0], $value[0] > $value[1] ? $value[0] : $value[1] );
+
+ }
+
+}
diff --git a/packages/woocommerce-germanized-shipments/src/PDFSplitter.php b/packages/woocommerce-germanized-shipments/src/PDFSplitter.php
new file mode 100644
index 000000000..bd9723932
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/PDFSplitter.php
@@ -0,0 +1,185 @@
+_pdf = new Fpdi();
+
+ try {
+
+ if ( $stream ) {
+ $file = StreamReader::createByString( $file );
+ $this->filename = $filename;
+ } else {
+ $this->filename = basename( $this->file );
+ }
+
+ $this->file = $file;
+ $this->pagecount = $this->_pdf->setSourceFile( $file ); // How many pages?
+
+ } catch( PdfParserException $e ) {
+
+ } catch( Exception $e ) {}
+ }
+
+ public function get_page_count() {
+ return $this->pagecount;
+ }
+
+ public function split() {
+ $new_files = array();
+
+ try {
+ // Split each page into a new PDF
+ for ( $i = 1; $i <= $this->pagecount; $i++ ) {
+
+ $new_pdf = new Fpdi();
+ $new_pdf->AddPage();
+ $new_pdf->setSourceFile( $this->file );
+ $new_pdf->useTemplate( $new_pdf->importPage( $i ), 0, 0, 210, null, true );
+
+ $new_files[] = $new_pdf->Output( 'S', $this->filename );
+ }
+
+ } catch( PdfParserException $e ) {
+ return false;
+ }
+
+ return $new_files;
+ }
+
+ /**
+ * Add file to this pdf
+ *
+ * @param string $filename Filename of the source file
+ * @param mixed $pages Range of files (if not set, all pages where imported)
+ */
+ public function add( $filename, $pages = [] ) {
+ if (file_exists($filename))
+ {
+ $pageCount = $this->_pdf->setSourceFile($filename);
+ for ($i = 1; $i <= $pageCount; $i++) {
+ if ($this->_isPageInRange($i, $pages)) {
+ $this->_addPage($i);
+ }
+ }
+ }
+ return $this;
+ }
+
+ /**
+ * Output merged pdf
+ *
+ * @param string $type
+ */
+ public function output($filename, $type = 'I')
+ {
+ return $this->_pdf->Output($type, $filename);
+ }
+
+ /**
+ * Force download merged pdf as file
+ *
+ * @param $filename
+ * @return string
+ */
+ public function download($filename)
+ {
+ return $this->output($filename, 'D');
+ }
+
+ /**
+ * Save merged pdf
+ *
+ * @param $filename
+ * @return string
+ */
+ public function save($filename)
+ {
+ return $this->output($filename, 'F');
+ }
+
+ /**
+ * Add single page
+ *
+ * @param $pageNumber
+ * @throws PdfReaderException
+ */
+ private function _addPage($pageNumber)
+ {
+ $pageId = $this->_pdf->importPage($pageNumber);
+ $this->_pdf->addPage();
+ $this->_pdf->useImportedPage($pageId);
+ }
+
+
+ /**
+ * Check if a specific page should be merged.
+ * If pages are empty, all pages will be merged
+ *
+ * @return bool
+ */
+ private function _isPageInRange($pageNumber, $pages = [])
+ {
+ if (empty($pages)) {
+ return true;
+ }
+
+ foreach ($pages as $range) {
+ if (in_array($pageNumber, $this->_getRange($range))) {
+ return true;
+ }
+ }
+
+ return false;
+ }
+
+
+ /**
+ * Get range by given value
+ *
+ * @param mixed $value
+ * @return array
+ */
+ private function _getRange($value = null)
+ {
+ $value = preg_replace('/[^0-9\-.]/is', '', $value);
+
+ if ($value == '') {
+ return false;
+ }
+
+ $value = explode('-', $value);
+ if (count($value) == 1) {
+ return $value;
+ }
+
+ return range($value[0] > $value[1] ? $value[1] : $value[0], $value[0] > $value[1] ? $value[0] : $value[1]);
+
+ }
+
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Package.php b/packages/woocommerce-germanized-shipments/src/Package.php
new file mode 100644
index 000000000..c3122f31b
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Package.php
@@ -0,0 +1,548 @@
+query_vars['add-return-shipment'] ) ) {
+ $callback = 'woocommerce_gzd_shipments_template_add_return_shipment';
+ $order_id = absint( $wp->query_vars['add-return-shipment'] );
+ }
+
+ if ( $callback && $order_id && ( $order_shipment = wc_gzd_get_shipment_order( $order_id ) ) && ! empty( $key ) ) {
+
+ // Order return key is invalid.
+ if ( ! wc_gzd_customer_can_add_return_shipment( $order_id ) ) {
+ throw new Exception( _x( 'Sorry, this order is invalid and cannot be returned.', 'shipments', 'woocommerce-germanized' ) );
+ } else {
+ call_user_func_array( $callback, array( 'order_id' => $order_id ) );
+ $template = self::get_path() . '/templates/global/empty.php';
+ }
+ }
+ } catch ( Exception $e ) {
+ wc_add_notice( $e->getMessage(), 'error' );
+ }
+ }
+
+ return $template;
+ }
+
+ public static function register_shortcodes() {
+ add_shortcode( 'gzd_return_request_form', array( __CLASS__, 'return_request_form' ) );
+ }
+
+ public static function return_request_form( $args = array() ) {
+
+ $defaults = array(
+ 'message' => '',
+ 'hidden' => false,
+ );
+
+ $args = wp_parse_args( $args, $defaults );
+ $notices = function_exists( 'wc_print_notices' ) ? wc_print_notices( true ) : '';
+ $html = '';
+
+ // Output notices in case notices have not been outputted yet.
+ if ( ! empty( $notices ) ) {
+ $html .= '' . $notices . '
';
+ }
+
+ $html .= wc_get_template_html( 'global/form-return-request.php', $args );
+
+ return $html;
+ }
+
+ public static function load_wpml_compatibility( $compatibility ) {
+ WPMLHelper::init( $compatibility );
+ }
+
+ public static function set_method_filters( $methods ) {
+
+ foreach ( $methods as $method => $class ) {
+ add_filter( 'woocommerce_shipping_instance_form_fields_' . $method, array( __CLASS__, 'add_method_settings' ), 10, 1 );
+ /**
+ * Use this filter as a backup to support plugins like Flexible Shipping which may override methods
+ */
+ add_filter( 'woocommerce_settings_api_form_fields_' . $method, array( __CLASS__, 'add_method_settings' ), 10, 1 );
+ add_filter( 'woocommerce_shipping_' . $method . '_instance_settings_values', array( __CLASS__, 'filter_method_settings' ), 10, 2 );
+ }
+
+ return $methods;
+ }
+
+ /**
+ * Indicates whether the BoxPack library for improved packing calculation is supported
+ *
+ * @return bool
+ */
+ public static function is_packing_supported() {
+ return version_compare( phpversion(), '7.1', '>=' );
+ }
+
+ public static function get_method_settings() {
+ if ( is_null( self::$method_settings ) ) {
+ self::$method_settings = Method::get_admin_settings();
+ }
+
+ return self::$method_settings;
+ }
+
+ public static function filter_method_settings( $p_settings, $method ) {
+ $shipping_provider_settings = self::get_method_settings();
+ $shipping_provider = isset( $p_settings['shipping_provider'] ) ? $p_settings['shipping_provider'] : '';
+ $shipping_method = wc_gzd_get_shipping_provider_method( $method );
+
+ /**
+ * Make sure the (maybe) new selected provider is used on updating the settings.
+ */
+ $shipping_method->set_provider( $shipping_provider );
+
+ foreach( $p_settings as $setting => $value ) {
+ if ( array_key_exists( $setting, $shipping_provider_settings ) ) {
+ // Check if setting does neither belong to global setting nor shipping provider prefix
+ if ( 'shipping_provider' !== $setting && ! $shipping_method->setting_belongs_to_provider( $setting ) ) {
+ unset( $p_settings[ $setting ] );
+ } elseif ( $shipping_method->get_fallback_setting_value( $setting ) === $value ) {
+ unset( $p_settings[ $setting ] );
+ } elseif( '' === $value ) {
+ unset( $p_settings[ $setting ] );
+ }
+ }
+ }
+
+ /**
+ * Filter that returns shipping method settings cleaned from global shipping provider method settings.
+ * This filter might be useful to remove some default setting values from
+ * shipping provider method settings e.g. DHL settings.
+ *
+ * @param array $p_settings The settings
+ * @param WC_Shipping_Method $method The shipping method instance
+ *
+ * @since 3.0.6
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipping_provider_method_clean_settings', $p_settings, $method );
+ }
+
+ public static function add_method_settings( $p_settings ) {
+ $wc = WC();
+
+ /**
+ * Prevent undefined index notices during REST API calls.
+ *
+ * @see WC_REST_Shipping_Zone_Methods_V2_Controller::get_settings()
+ */
+ if ( is_callable( array( $wc, 'is_rest_api_request' ) ) && $wc->is_rest_api_request() ) {
+ return $p_settings;
+ }
+
+ $shipping_provider_settings = self::get_method_settings();
+
+ return array_merge( $p_settings, $shipping_provider_settings );
+ }
+
+ public static function load_shipping_methods( $package ) {
+ $shipping = WC_Shipping::instance();
+
+ foreach( $shipping->shipping_methods as $key => $method ) {
+ $shipping_provider_method = new Method( $method );
+ }
+ }
+
+ public static function inject_endpoints() {
+ if ( function_exists( 'WC' ) && WC()->query ) {
+ foreach( self::get_endpoints() as $endpoint ) {
+ if ( ! array_key_exists( $endpoint, WC()->query->query_vars ) ) {
+ $option_name = str_replace( '-', '_', $endpoint );
+ WC()->query->query_vars[ $endpoint ] = get_option( "woocommerce_gzd_shipments_{$option_name}_endpoint", $endpoint );
+ }
+ }
+ }
+ }
+
+ public static function get_endpoints() {
+ return array(
+ 'view-shipment',
+ 'add-return-shipment',
+ 'view-shipments'
+ );
+ }
+
+ public static function register_endpoints( $query_vars ) {
+ foreach( self::get_endpoints() as $endpoint ) {
+ if ( ! array_key_exists( $endpoint, $query_vars ) ) {
+ $option_name = str_replace( '-', '_', $endpoint );
+ $query_vars[ $endpoint ] = get_option( "woocommerce_gzd_shipments_{$option_name}_endpoint", $endpoint );
+ }
+ }
+
+ return $query_vars;
+ }
+
+ public static function install() {
+ self::init();
+ Install::install();
+ }
+
+ public static function install_integration() {
+ self::init();
+ self::install();
+ }
+
+ public static function maybe_set_upload_dir() {
+ // Create a dir suffix
+ if ( ! get_option( 'woocommerce_gzd_shipments_upload_dir_suffix', false ) ) {
+ self::$upload_dir_suffix = substr( self::generate_key(), 0, 10 );
+ update_option( 'woocommerce_gzd_shipments_upload_dir_suffix', self::$upload_dir_suffix );
+ } else {
+ self::$upload_dir_suffix = get_option( 'woocommerce_gzd_shipments_upload_dir_suffix' );
+ }
+ }
+
+ /**
+ * Generate a unique key.
+ *
+ * @return string
+ */
+ protected static function generate_key() {
+ $key = array( ABSPATH, time() );
+ $constants = array( 'AUTH_KEY', 'SECURE_AUTH_KEY', 'LOGGED_IN_KEY', 'NONCE_KEY', 'AUTH_SALT', 'SECURE_AUTH_SALT', 'LOGGED_IN_SALT', 'NONCE_SALT', 'SECRET_KEY' );
+
+ foreach ( $constants as $constant ) {
+ if ( defined( $constant ) ) {
+ $key[] = constant( $constant );
+ }
+ }
+
+ shuffle( $key );
+
+ return md5( serialize( $key ) );
+ }
+
+ public static function log( $message, $type = 'info' ) {
+ $enable_logging = defined( 'WP_DEBUG' ) && WP_DEBUG ? true : false;
+
+ /**
+ * Filter that allows adjusting whether to enable or disable
+ * logging for the shipments package
+ *
+ * @param boolean $enable_logging True if logging should be enabled. False otherwise.
+ *
+ * @package Vendidero/Germanized/Shipments
+ */
+ if ( ! apply_filters( 'woocommerce_gzd_shipments_enable_logging', $enable_logging ) ) {
+ return false;
+ }
+
+ $logger = wc_get_logger();
+
+ if ( ! $logger ) {
+ return false;
+ }
+
+ if ( ! is_callable( array( $logger, $type ) ) ) {
+ $type = 'info';
+ }
+
+ $logger->{$type}( $message, array( 'source' => 'wc-gzd-shipments' ) );
+ }
+
+ public static function get_upload_dir_suffix() {
+ return self::$upload_dir_suffix;
+ }
+
+ public static function get_upload_dir() {
+
+ self::set_upload_dir_filter();
+ $upload_dir = wp_upload_dir();
+ self::unset_upload_dir_filter();
+
+ /**
+ * Filter to adjust the upload directory used to store shipment related files. By default
+ * files are stored in a custom directory under wp-content/uploads.
+ *
+ * @param array $upload_dir Array containing `wp_upload_dir` data.
+ *
+ * @since 3.0.1
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipments_upload_dir', $upload_dir );
+ }
+
+ public static function get_relative_upload_dir( $path ) {
+
+ self::set_upload_dir_filter();
+ $path = _wp_relative_upload_path( $path );
+ self::unset_upload_dir_filter();
+
+ /**
+ * Filter to retrieve the relative upload path used for storing shipment related files.
+ *
+ * @param array $path Relative path.
+ *
+ * @since 3.0.1
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipments_relative_upload_dir', $path );
+ }
+
+ public static function set_upload_dir_filter() {
+ add_filter( 'upload_dir', array( __CLASS__, "filter_upload_dir" ), 150, 1 );
+ }
+
+ public static function unset_upload_dir_filter() {
+ remove_filter( 'upload_dir', array( __CLASS__, "filter_upload_dir" ), 150 );
+ }
+
+ public static function get_file_by_path( $file ) {
+ // If the file is relative, prepend upload dir.
+ if ( $file && 0 !== strpos( $file, '/' ) && ( ( $uploads = self::get_upload_dir() ) && false === $uploads['error'] ) ) {
+ $file = $uploads['basedir'] . "/$file";
+
+ return $file;
+ } else {
+ return $file;
+ }
+ }
+
+ public static function filter_upload_dir( $args ) {
+ $upload_base = trailingslashit( $args['basedir'] );
+ $upload_url = trailingslashit( $args['baseurl'] );
+
+ /**
+ * Filter to adjust the upload path used to store shipment related files. By default
+ * files are stored in a custom directory under wp-content/uploads.
+ *
+ * @param string $path Path to the upload directory.
+ *
+ * @since 3.0.6
+ * @package Vendidero/Germanized/Shipments
+ */
+ $args['basedir'] = apply_filters( 'woocommerce_gzd_shipments_upload_path', $upload_base . 'wc-gzd-shipments-' . self::get_upload_dir_suffix() );
+ /**
+ * Filter to adjust the upload URL used to retrieve shipment related files. By default
+ * files are stored in a custom directory under wp-content/uploads.
+ *
+ * @param string $url URL to the upload directory.
+ *
+ * @since 3.0.6
+ * @package Vendidero/Germanized/Shipments
+ */
+ $args['baseurl'] = apply_filters( 'woocommerce_gzd_shipments_upload_url', $upload_url . 'wc-gzd-shipments-' . self::get_upload_dir_suffix() );
+
+ $args['path'] = $args['basedir'] . $args['subdir'];
+ $args['url'] = $args['baseurl'] . $args['subdir'];
+
+ return $args;
+ }
+
+ public static function has_dependencies() {
+ return class_exists( 'WooCommerce' ) && apply_filters( 'woocommerce_gzd_shipments_enabled', true );
+ }
+
+ private static function includes() {
+
+ if ( is_admin() ) {
+ Admin\Admin::init();
+ }
+
+ Ajax::init();
+ Automation::init();
+ Labels\Automation::init();
+ Labels\DownloadHandler::init();
+ Emails::init();
+ Validation::init();
+ Api::init();
+ FormHandler::init();
+
+ if ( self::is_frontend_request() ) {
+ include_once self::get_path() . '/includes/wc-gzd-shipment-template-hooks.php';
+ }
+
+ include_once self::get_path() . '/includes/wc-gzd-shipment-functions.php';
+ include_once self::get_path() . '/includes/wc-gzd-label-functions.php';
+ include_once self::get_path() . '/includes/wc-gzd-packaging-functions.php';
+ }
+
+ private static function is_frontend_request() {
+ return ( ! is_admin() || defined( 'DOING_AJAX' ) ) && ! defined( 'DOING_CRON' );
+ }
+
+ /**
+ * Function used to Init WooCommerce Template Functions - This makes them pluggable by plugins and themes.
+ */
+ public static function include_template_functions() {
+ include_once self::get_path() . '/includes/wc-gzd-shipments-template-functions.php';
+ }
+
+ public static function filter_templates( $path, $template_name ) {
+
+ if ( file_exists( self::get_path() . '/templates/' . $template_name ) ) {
+ $path = self::get_path() . '/templates/' . $template_name;
+ }
+
+ return $path;
+ }
+
+ /**
+ * Register custom tables within $wpdb object.
+ */
+ private static function define_tables() {
+ global $wpdb;
+
+ // List of tables without prefixes.
+ $tables = array(
+ 'gzd_shipment_itemmeta' => 'woocommerce_gzd_shipment_itemmeta',
+ 'gzd_shipmentmeta' => 'woocommerce_gzd_shipmentmeta',
+ 'gzd_shipments' => 'woocommerce_gzd_shipments',
+ 'gzd_shipment_labelmeta' => 'woocommerce_gzd_shipment_labelmeta',
+ 'gzd_shipment_labels' => 'woocommerce_gzd_shipment_labels',
+ 'gzd_shipment_items' => 'woocommerce_gzd_shipment_items',
+ 'gzd_shipping_provider' => 'woocommerce_gzd_shipping_provider',
+ 'gzd_shipping_providermeta' => 'woocommerce_gzd_shipping_providermeta',
+ 'gzd_packaging' => 'woocommerce_gzd_packaging',
+ 'gzd_packagingmeta' => 'woocommerce_gzd_packagingmeta',
+ );
+
+ foreach ( $tables as $name => $table ) {
+ $wpdb->$name = $wpdb->prefix . $table;
+ $wpdb->tables[] = $table;
+ }
+ }
+
+ public static function register_data_stores( $stores ) {
+ $stores['shipment'] = 'Vendidero\Germanized\Shipments\DataStores\Shipment';
+ $stores['shipment-label'] = 'Vendidero\Germanized\Shipments\DataStores\Label';
+ $stores['packaging'] = 'Vendidero\Germanized\Shipments\DataStores\Packaging';
+ $stores['shipment-item'] = 'Vendidero\Germanized\Shipments\DataStores\ShipmentItem';
+ $stores['shipping-provider'] = 'Vendidero\Germanized\Shipments\DataStores\ShippingProvider';
+
+ return $stores;
+ }
+
+ /**
+ * Return the version of the package.
+ *
+ * @return string
+ */
+ public static function get_version() {
+ return self::VERSION;
+ }
+
+ /**
+ * Return the path to the package.
+ *
+ * @return string
+ */
+ public static function get_path() {
+ return dirname( __DIR__ );
+ }
+
+ /**
+ * Return the path to the package.
+ *
+ * @return string
+ */
+ public static function get_url() {
+ return plugins_url( '', __DIR__ );
+ }
+
+ public static function get_assets_url() {
+ return self::get_url() . '/assets';
+ }
+
+ public static function get_setting( $name, $default = false ) {
+ $option_name = "woocommerce_gzd_shipments_{$name}";
+
+ return get_option( $option_name, $default );
+ }
+
+ public static function get_store_address_country() {
+ $default = get_option( 'woocommerce_store_country' );
+
+ return $default;
+ }
+
+ public static function get_store_address_street() {
+ $store_address = wc_gzd_split_shipment_street( get_option( 'woocommerce_store_address' ) );
+
+ return $store_address['street'];
+ }
+
+ public static function get_store_address_street_number() {
+ $store_address = wc_gzd_split_shipment_street( get_option( 'woocommerce_store_address' ) );
+
+ return $store_address['number'];
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Packaging.php b/packages/woocommerce-germanized-shipments/src/Packaging.php
new file mode 100644
index 000000000..ce8235f89
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Packaging.php
@@ -0,0 +1,339 @@
+ null,
+ 'weight' => 0,
+ 'max_content_weight' => 0,
+ 'width' => 0,
+ 'height' => 0,
+ 'length' => 0,
+ 'order' => 0,
+ 'type' => '',
+ 'description' => '',
+ );
+
+ /**
+ * Get the packaging if ID is passed, otherwise the packaging is new and empty.
+ * This class should NOT be instantiated, but the `wc_gzd_get_packaging` function should be used.
+ *
+ * @param int|object|Packaging $packaging packaging to read.
+ */
+ public function __construct( $data = 0 ) {
+ parent::__construct( $data );
+
+ if ( $data instanceof Packaging ) {
+ $this->set_id( absint( $data->get_id() ) );
+ } elseif ( is_numeric( $data ) ) {
+ $this->set_id( $data );
+ }
+
+ $this->data_store = WC_Data_Store::load( $this->data_store_name );
+
+ // If we have an ID, load the user from the DB.
+ if ( $this->get_id() ) {
+ try {
+ $this->data_store->read( $this );
+ } catch ( Exception $e ) {
+ $this->set_id( 0 );
+ $this->set_object_read( true );
+ }
+ } else {
+ $this->set_object_read( true );
+ }
+ }
+
+ /**
+ * Merge changes with data and clear.
+ * Overrides WC_Data::apply_changes.
+ *
+ * @since 3.2.0
+ */
+ public function apply_changes() {
+ if ( function_exists( 'array_replace' ) ) {
+ $this->data = array_replace( $this->data, $this->changes ); // phpcs:ignore PHPCompatibility.FunctionUse.NewFunctions.array_replaceFound
+ } else { // PHP 5.2 compatibility.
+ foreach ( $this->changes as $key => $change ) {
+ $this->data[ $key ] = $change;
+ }
+ }
+ $this->changes = array();
+ }
+
+ /**
+ * Prefix for action and filter hooks on data.
+ *
+ * @return string
+ */
+ protected function get_hook_prefix() {
+ return $this->get_general_hook_prefix() . 'get_';
+ }
+
+ /**
+ * Prefix for action and filter hooks on data.
+ *
+ * @return string
+ */
+ protected function get_general_hook_prefix() {
+ return "woocommerce_gzd_packaging_";
+ }
+
+ /**
+ * Return the date this packaging was created.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return WC_DateTime|null object if the date is set or null if there is no date.
+ */
+ public function get_date_created( $context = 'view' ) {
+ return $this->get_prop( 'date_created', $context );
+ }
+
+ /**
+ * Returns the packaging weight in kg.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_weight( $context = 'view' ) {
+ return $this->get_prop( 'weight', $context );
+ }
+
+ /**
+ * Returns the packaging max content weight in kg.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_max_content_weight( $context = 'view' ) {
+ return $this->get_prop( 'max_content_weight', $context );
+ }
+
+ /**
+ * Returns the packaging order within its list.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_order( $context = 'view' ) {
+ return $this->get_prop( 'order', $context );
+ }
+
+ /**
+ * Returns the packaging type e.g. box or letter.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_type( $context = 'view' ) {
+ return $this->get_prop( 'type', $context );
+ }
+
+ /**
+ * Returns the packaging description.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_description( $context = 'view' ) {
+ return $this->get_prop( 'description', $context );
+ }
+
+ /**
+ * Returns the packaging length in cm.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_length( $context = 'view' ) {
+ return $this->get_prop( 'length', $context );
+ }
+
+ /**
+ * Returns the packaging width in cm.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_width( $context = 'view' ) {
+ return $this->get_prop( 'width', $context );
+ }
+
+ /**
+ * Returns the packaging height in cm.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_height( $context = 'view' ) {
+ return $this->get_prop( 'height', $context );
+ }
+
+ public function has_dimensions() {
+ $width = $this->get_width();
+ $length = $this->get_length();
+ $height = $this->get_height();
+
+ return ( ! empty( $width ) && ! empty( $length ) && ! empty( $height ) );
+ }
+
+ /**
+ * Returns dimensions.
+ *
+ * @return string|array
+ */
+ public function get_dimensions() {
+ return array(
+ 'length' => wc_format_decimal( $this->get_length(), false, true ),
+ 'width' => wc_format_decimal( $this->get_width(), false, true ),
+ 'height' => wc_format_decimal( $this->get_height(), false, true ),
+ );
+ }
+
+ public function get_formatted_dimensions() {
+ return wc_gzd_format_shipment_dimensions( $this->get_dimensions(), wc_gzd_get_packaging_dimension_unit() );
+ }
+
+ public function get_volume() {
+ return (float) $this->get_length() * (float) $this->get_width() * (float) $this->get_height();
+ }
+
+ /**
+ * Set the date this packaging was created.
+ *
+ * @param string|integer|null $date UTC timestamp, or ISO 8601 DateTime. If the DateTime string has no timezone or offset, WordPress site timezone will be assumed. Null if their is no date.
+ */
+ public function set_date_created( $date = null ) {
+ $this->set_date_prop( 'date_created', $date );
+ }
+
+ /**
+ * Set packaging weight in kg.
+ *
+ * @param string $weight The weight.
+ */
+ public function set_weight( $weight ) {
+ $this->set_prop( 'weight', empty( $weight ) ? 0 : wc_format_decimal( $weight, 2, true ) );
+ }
+
+ public function get_title() {
+ $description = $this->get_description();
+
+ return sprintf(
+ _x( '%1$s (%2$s, %3$s)', 'shipments-packaging-title', 'woocommerce-germanized' ),
+ $description,
+ $this->get_formatted_dimensions(),
+ wc_gzd_format_shipment_weight( wc_format_decimal( $this->get_weight(), false, true ), wc_gzd_get_packaging_weight_unit() )
+ );
+ }
+
+ /**
+ * Set packaging order.
+ *
+ * @param integer $order The order.
+ */
+ public function set_order( $order ) {
+ $this->set_prop( 'order', absint( $order ) );
+ }
+
+ /**
+ * Set packaging max content weight in kg.
+ *
+ * @param string $weight The weight.
+ */
+ public function set_max_content_weight( $weight ) {
+ $this->set_prop( 'max_content_weight', empty( $weight ) ? 0 : wc_format_decimal( $weight, 2, true ) );
+ }
+
+ /**
+ * Set packaging type
+ *
+ * @param string $type The type.
+ */
+ public function set_type( $type ) {
+ $this->set_prop( 'type', $type );
+ }
+
+ /**
+ * Set packaging description
+ *
+ * @param string $description The description.
+ */
+ public function set_description( $description ) {
+ $this->set_prop( 'description', $description );
+ }
+
+ /**
+ * Set packaging width in cm.
+ *
+ * @param string $width The width.
+ */
+ public function set_width( $width ) {
+ $this->set_prop( 'width', empty( $width ) ? 0 : wc_format_decimal( $width, 1, true ) );
+ }
+
+ /**
+ * Set packaging length in cm.
+ *
+ * @param string $length The length.
+ */
+ public function set_length( $length ) {
+ $this->set_prop( 'length', empty( $length ) ? 0 : wc_format_decimal( $length, 1, true ) );
+ }
+
+ /**
+ * Set packaging height in cm.
+ *
+ * @param string $height The height.
+ */
+ public function set_height( $height ) {
+ $this->set_prop( 'height', empty( $height ) ? 0 : wc_format_decimal( $height, 1, true ) );
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/PackagingFactory.php b/packages/woocommerce-germanized-shipments/src/PackagingFactory.php
new file mode 100644
index 000000000..b6f0ccaa2
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/PackagingFactory.php
@@ -0,0 +1,65 @@
+get_id();
+ } elseif ( ! empty( $packaging->packaging_id ) ) {
+ return $packaging->packaging_id;
+ } else {
+ return false;
+ }
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Packing/Helper.php b/packages/woocommerce-germanized-shipments/src/Packing/Helper.php
new file mode 100644
index 000000000..f87652519
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Packing/Helper.php
@@ -0,0 +1,26 @@
+get_id() ] = new PackagingBox( $packaging );
+ }
+ }
+
+ if ( $id ) {
+ return array_key_exists( $id, self::$packaging ) ? self::$packaging[ $id ] : false;
+ }
+
+ return self::$packaging;
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Packing/OrderItem.php b/packages/woocommerce-germanized-shipments/src/Packing/OrderItem.php
new file mode 100644
index 000000000..530453ac5
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Packing/OrderItem.php
@@ -0,0 +1,116 @@
+item = $item;
+
+ if ( ! is_callable( array( $item, 'get_product' ) ) ) {
+ throw new \Exception( 'Invalid item' );
+ }
+
+ if ( $product = $this->item->get_product() ) {
+ $this->product = $product;
+
+ $width = empty( $this->product->get_width() ) ? 0 : wc_format_decimal( $this->product->get_width() );
+ $length = empty( $this->product->get_length() ) ? 0 : wc_format_decimal( $this->product->get_length() );
+ $depth = empty( $this->product->get_height() ) ? 0 : wc_format_decimal( $this->product->get_height() );
+
+ $this->dimensions = array(
+ 'width' => (int) wc_get_dimension( $width, 'mm' ),
+ 'length' => (int) wc_get_dimension( $length, 'mm' ),
+ 'depth' => (int) wc_get_dimension( $depth, 'mm' )
+ );
+
+ $weight = empty( $this->product->get_weight() ) ? 0 : wc_format_decimal( $this->product->get_weight() );
+ $this->weight = (int) wc_get_weight( $weight, 'g' );
+ }
+
+ if ( ! $product ) {
+ throw new \Exception( 'Missing product' );
+ }
+ }
+
+ public function get_id() {
+ return $this->item->get_id();
+ }
+
+ /**
+ * @return \WC_Order_Item_Product
+ */
+ public function get_order_item() {
+ return $this->item;
+ }
+
+ /**
+ * Item SKU etc.
+ */
+ public function getDescription(): string {
+ if ( $this->product->get_sku() ) {
+ return $this->product->get_sku();
+ }
+
+ return $this->item->get_id();
+ }
+
+ /**
+ * Item width in mm.
+ */
+ public function getWidth(): int {
+ return $this->dimensions['width'];
+ }
+
+ /**
+ * Item length in mm.
+ */
+ public function getLength(): int {
+ return $this->dimensions['length'];
+ }
+
+ /**
+ * Item depth in mm.
+ */
+ public function getDepth(): int {
+ return $this->dimensions['depth'];
+ }
+
+ /**
+ * Item weight in g.
+ */
+ public function getWeight(): int {
+ return $this->weight;
+ }
+
+ /**
+ * Does this item need to be kept flat / packed "this way up"?
+ */
+ public function getKeepFlat(): bool {
+ return false;
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Packing/PackagingBox.php b/packages/woocommerce-germanized-shipments/src/Packing/PackagingBox.php
new file mode 100644
index 000000000..4ed184a7a
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Packing/PackagingBox.php
@@ -0,0 +1,147 @@
+packaging = $packaging;
+
+ $width = empty( $this->packaging->get_width() ) ? 0 : wc_format_decimal( $this->packaging->get_width() );
+ $length = empty( $this->packaging->get_length() ) ? 0 : wc_format_decimal( $this->packaging->get_length() );
+ $depth = empty( $this->packaging->get_height() ) ? 0 : wc_format_decimal( $this->packaging->get_height() );
+
+ $this->dimensions = array(
+ 'width' => (int) wc_get_dimension( $width, 'mm', wc_gzd_get_packaging_dimension_unit() ),
+ 'length' => (int) wc_get_dimension( $length, 'mm', wc_gzd_get_packaging_dimension_unit() ),
+ 'depth' => (int) wc_get_dimension( $depth, 'mm', wc_gzd_get_packaging_dimension_unit() )
+ );
+
+ $weight = empty( $this->packaging->get_weight() ) ? 0 : wc_format_decimal( $this->packaging->get_weight() );
+ $this->weight = (int) wc_get_weight( $weight, 'g', wc_gzd_get_packaging_weight_unit() );
+
+ $max_content_weight = empty( $this->packaging->get_max_content_weight() ) ? 0 : wc_format_decimal( $this->packaging->get_max_content_weight() );
+ $this->max_weight = (int) wc_get_weight( $max_content_weight, 'g', wc_gzd_get_packaging_weight_unit() );
+
+ /**
+ * If no max weight was chosen - use 50kg as fallback
+ */
+ if ( empty( $this->max_weight ) ) {
+ $this->max_weight = 50000;
+ }
+ }
+
+ public function get_id() {
+ return $this->packaging->get_id();
+ }
+
+ /**
+ * Reference for box type (e.g. SKU or description).
+ */
+ public function getReference(): string {
+ return (string) $this->packaging->get_title();
+ }
+
+ /**
+ * Outer width in mm.
+ */
+ public function getOuterWidth(): int {
+ return $this->dimensions['width'];
+ }
+
+ /**
+ * Outer length in mm.
+ */
+ public function getOuterLength(): int {
+ return $this->dimensions['length'];
+ }
+
+ /**
+ * Outer depth in mm.
+ */
+ public function getOuterDepth(): int {
+ return $this->dimensions['depth'];
+ }
+
+ /**
+ * Empty weight in g.
+ */
+ public function getEmptyWeight(): int {
+ return $this->weight;
+ }
+
+ /**
+ * Returns the threshold by which the inner dimension gets reduced
+ * in comparison to the outer dimension.
+ *
+ * @param string $type
+ *
+ * @return float
+ */
+ public function get_inner_dimension_buffer( $value, $type = 'width' ) {
+ if ( apply_filters( 'woocommerce_gzd_packaging_inner_dimension_use_percentage_buffer', false, $type, $this ) ) {
+ $percentage_buffer = apply_filters( 'woocommerce_gzd_packaging_inner_dimension_percentage_buffer,', 0.5, $type, $this ) / 100;
+ $value = $value - ( $value * $percentage_buffer );
+ } else {
+ $fixed_buffer = apply_filters( 'woocommerce_gzd_packaging_inner_dimension_fixed_buffer_mm', 5, $type, $this );
+ $value = $value - $fixed_buffer;
+ }
+
+ return max( $value, 0 );
+ }
+
+ /**
+ * Inner width in mm.
+ */
+ public function getInnerWidth(): int {
+ $width = $this->get_inner_dimension_buffer( $this->dimensions['width'], 'width' );
+
+ return $width;
+ }
+
+ /**
+ * Inner length in mm.
+ */
+ public function getInnerLength(): int {
+ $length = $this->get_inner_dimension_buffer( $this->dimensions['length'], 'length' );
+
+ return $length;
+ }
+
+ /**
+ * Inner depth in mm.
+ */
+ public function getInnerDepth(): int {
+ $depth = $this->get_inner_dimension_buffer( $this->dimensions['depth'], 'depth' );
+
+ return $depth;
+ }
+
+ /**
+ * Max weight the packaging can hold in g.
+ */
+ public function getMaxWeight(): int {
+ return $this->max_weight;
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Packing/ShipmentItem.php b/packages/woocommerce-germanized-shipments/src/Packing/ShipmentItem.php
new file mode 100644
index 000000000..2a7856f44
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Packing/ShipmentItem.php
@@ -0,0 +1,110 @@
+item = $item;
+
+ if ( $shipment = $item->get_shipment() ) {
+ $dimension_unit = $shipment->get_dimension_unit();
+ $weight_unit = $shipment->get_weight_unit();
+ } else {
+ $dimension_unit = get_option( 'woocommerce_dimension_unit', 'cm' );
+ $weight_unit = get_option( 'woocommerce_weight_unit', 'kg' );
+ }
+
+ $width = empty( $this->item->get_width() ) ? 0 : wc_format_decimal( $this->item->get_width() );
+ $length = empty( $this->item->get_length() ) ? 0 : wc_format_decimal( $this->item->get_length() );
+ $depth = empty( $this->item->get_height() ) ? 0 : wc_format_decimal( $this->item->get_height() );
+
+ $this->dimensions = array(
+ 'width' => (int) wc_get_dimension( $width, 'mm', $dimension_unit ),
+ 'length' => (int) wc_get_dimension( $length, 'mm', $dimension_unit ),
+ 'depth' => (int) wc_get_dimension( $depth, 'mm', $dimension_unit )
+ );
+
+ $weight = empty( $this->item->get_weight() ) ? 0 : wc_format_decimal( $this->item->get_weight() );
+ $this->weight = (int) wc_get_weight( $weight, 'g', $weight_unit );
+ }
+
+ /**
+ * @return \Vendidero\Germanized\Shipments\ShipmentItem
+ */
+ public function get_shipment_item() {
+ return $this->item;
+ }
+
+ public function get_id() {
+ return $this->item->get_id();
+ }
+
+ /**
+ * Item SKU etc.
+ */
+ public function getDescription(): string {
+ if ( $this->item->get_sku() ) {
+ return $this->item->get_sku();
+ }
+
+ return $this->item->get_id();
+ }
+
+ /**
+ * Item width in mm.
+ */
+ public function getWidth(): int {
+ return $this->dimensions['width'];
+ }
+
+ /**
+ * Item length in mm.
+ */
+ public function getLength(): int {
+ return $this->dimensions['length'];
+ }
+
+ /**
+ * Item depth in mm.
+ */
+ public function getDepth(): int {
+ return $this->dimensions['depth'];
+ }
+
+ /**
+ * Item weight in g.
+ */
+ public function getWeight(): int {
+ return $this->weight;
+ }
+
+ /**
+ * Does this item need to be kept flat / packed "this way up"?
+ */
+ public function getKeepFlat(): bool {
+ return false;
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/ReturnReason.php b/packages/woocommerce-germanized-shipments/src/ReturnReason.php
new file mode 100644
index 000000000..aa42e19c2
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/ReturnReason.php
@@ -0,0 +1,43 @@
+ '',
+ 'reason' => '',
+ 'order' => 0,
+ ) );
+
+ $this->args = $args;
+ }
+
+ public function get_reason() {
+ return $this->args['reason'];
+ }
+
+ public function get_code() {
+ return $this->args['code'];
+ }
+
+ public function get_name() {
+ return $this->get_code();
+ }
+
+ public function get_order() {
+ return absint( $this->args['order'] );
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/ReturnShipment.php b/packages/woocommerce-germanized-shipments/src/ReturnShipment.php
new file mode 100644
index 000000000..b117d45e8
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/ReturnShipment.php
@@ -0,0 +1,631 @@
+ 0,
+ 'is_customer_requested' => false,
+ 'sender_address' => array(),
+ );
+
+ /**
+ * Returns the shipment type.
+ *
+ * @return string
+ */
+ public function get_type() {
+ return 'return';
+ }
+
+ /**
+ * Returns the order id belonging to the shipment.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return integer
+ */
+ public function get_order_id( $context = 'view' ) {
+ return $this->get_prop( 'order_id', $context );
+ }
+
+ /**
+ * Returns whether the current return was requested by a customer or not.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return boolean
+ */
+ public function get_is_customer_requested( $context = 'view' ) {
+ return $this->get_prop( 'is_customer_requested', $context );
+ }
+
+ public function is_customer_requested() {
+ return $this->get_is_customer_requested();
+ }
+
+ public function confirm_customer_request() {
+ if ( $this->is_customer_requested() && $this->has_status( 'requested' ) ) {
+
+ $this->set_status( 'processing' );
+
+ if ( $this->save() ) {
+ /**
+ * Action that fires after a return request has been confirmed to the customer.
+ *
+ * @param integer $shipment_id The return shipment id.
+ * @param ReturnShipment $shipment The return shipment object.
+ *
+ * @since 3.1.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( 'woocommerce_gzd_return_shipment_customer_confirmed', $this->get_id(), $this );
+
+ return true;
+ } else {
+ return false;
+ }
+ }
+
+ return false;
+ }
+
+ /**
+ * Returns the address of the sender e.g. customer.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string[]
+ */
+ public function get_sender_address( $context = 'view' ) {
+ return $this->get_prop( 'sender_address', $context );
+ }
+
+ /**
+ * Set shipment order id.
+ *
+ * @param string $order_id The order id.
+ */
+ public function set_order_id( $order_id ) {
+ // Reset order object
+ $this->order = null;
+
+ $this->set_prop( 'order_id', absint( $order_id ) );
+ }
+
+ /**
+ * Set if the current return was requested by the customer or not.
+ *
+ * @param string $is_requested Whether or not it is requested by the customer.
+ */
+ public function set_is_customer_requested( $is_requested ) {
+ $this->set_prop( 'is_customer_requested', wc_string_to_bool( $is_requested ) );
+ }
+
+ /**
+ * Set shipment order.
+ *
+ * @param Order $order_shipment The order shipment.
+ */
+ public function set_order_shipment( &$order_shipment ) {
+ $this->order_shipment = $order_shipment;
+ }
+
+ /**
+ * Returns shipment order.
+ *
+ * @return Order|null The order shipment.
+ */
+ public function get_order_shipment() {
+ if ( is_null( $this->order_shipment ) ) {
+ $order = $this->get_order();
+ $this->order_shipment = ( $order ? wc_gzd_get_shipment_order( $order ) : false );
+ }
+
+ return $this->order_shipment;
+ }
+
+ /**
+ * Returns the shippable item count.
+ *
+ * @return int
+ */
+ public function get_shippable_item_count() {
+
+ if ( $order_shipment = $this->get_order_shipment() ) {
+ return $order_shipment->get_returnable_item_count();
+ }
+
+ return 0;
+ }
+
+ /**
+ * Tries to fetch the order for the current shipment.
+ *
+ * @return bool|WC_Order|null
+ */
+ public function get_order() {
+ if ( is_null( $this->order ) ) {
+ $this->order = ( $this->get_order_id() > 0 ? wc_get_order( $this->get_order_id() ) : false );
+ }
+
+ return $this->order;
+ }
+
+ /**
+ * Returns available shipment methods by checking the corresponding order.
+ *
+ * @return string[]
+ */
+ public function get_available_shipping_methods() {
+ $methods = array();
+ $methods[ $this->get_shipping_method() ] = '';
+
+ return $methods;
+ }
+
+ /**
+ * Returns a sender address prop.
+ *
+ * @param string $prop
+ * @param string $context
+ *
+ * @return null|string
+ */
+ protected function get_sender_address_prop( $prop, $context = 'view' ) {
+ $value = null;
+
+ if ( isset( $this->changes['sender_address'][ $prop ] ) || isset( $this->data['sender_address'][ $prop ] ) ) {
+ $value = isset( $this->changes['sender_address'][ $prop ] ) ? $this->changes['sender_address'][ $prop ] : $this->data['sender_address'][ $prop ];
+
+ if ( 'view' === $context ) {
+ /**
+ * Filter to adjust a Shipment's return sender address property e.g. first_name.
+ *
+ * The dynamic portion of this hook, `$this->get_hook_prefix()` is used to construct a
+ * unique hook for a shipment type. `$prop` refers to the actual address property e.g. first_name.
+ *
+ * Example hook name: woocommerce_gzd_return_shipment_get_sender_address_first_name
+ *
+ * @param string $value The address property value.
+ * @param Shipment $this The shipment object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ $value = apply_filters( "{$this->get_hook_prefix()}sender_address_{$prop}", $value, $this );
+ }
+ }
+
+ return $value;
+ }
+
+ /**
+ * Returns the formatted sender address.
+ *
+ * @param string $empty_content Content to show if no address is present.
+ * @return string
+ */
+ public function get_formatted_sender_address( $empty_content = '' ) {
+ $address = WC()->countries->get_formatted_address( $this->get_sender_address() );
+
+ return $address ? $address : $empty_content;
+ }
+
+ /**
+ * Returns the sender address phone number.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_sender_phone( $context = 'view' ) {
+ return $this->get_sender_address_prop( 'phone', $context );
+ }
+
+ /**
+ * Returns the sender address email.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_sender_email( $context = 'view' ) {
+ return $this->get_sender_address_prop( 'email', $context );
+ }
+
+ /**
+ * Returns the sender address first line.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_sender_address_1( $context = 'view' ) {
+ return $this->get_sender_address_prop( 'address_1', $context );
+ }
+
+ /**
+ * Returns the sender address second line.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_sender_address_2( $context = 'view' ) {
+ return $this->get_sender_address_prop( 'address_2', $context );
+ }
+
+ /**
+ * Returns the sender address street number by splitting the address.
+ *
+ * @param string $type The address type e.g. address_1 or address_2.
+ *
+ * @return string
+ */
+ public function get_sender_address_street_number( $type = 'address_1' ) {
+ $split = wc_gzd_split_shipment_street( $this->{"get_sender_$type"}() );
+
+ return $split['number'];
+ }
+
+ /**
+ * Returns the sender address street without number by splitting the address.
+ *
+ * @param string $type The address type e.g. address_1 or address_2.
+ *
+ * @return string
+ */
+ public function get_sender_address_street( $type = 'address_1' ) {
+ $split = wc_gzd_split_shipment_street( $this->{"get_sender_$type"}() );
+
+ return $split['street'];
+ }
+
+ /**
+ * Returns the sender address street addition by splitting the address.
+ *
+ * @param string $type The address type e.g. address_1 or address_2.
+ *
+ * @return string
+ */
+ public function get_sender_address_street_addition( $type = 'address_1' ) {
+ $split = wc_gzd_split_shipment_street( $this->{"get_sender_$type"}() );
+
+ return $split['addition'];
+ }
+
+ /**
+ * Returns the sender address company.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_sender_company( $context = 'view' ) {
+ return $this->get_sender_address_prop( 'company', $context );
+ }
+
+ /**
+ * Returns the sender address first name.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_sender_first_name( $context = 'view' ) {
+ return $this->get_sender_address_prop( 'first_name', $context );
+ }
+
+ /**
+ * Returns the shipment address last name.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_sender_last_name( $context = 'view' ) {
+ return $this->get_sender_address_prop( 'last_name', $context );
+ }
+
+ /**
+ * Returns the sender address formatted full name.
+ *
+ * @return string
+ */
+ public function get_formatted_sender_full_name() {
+ return sprintf( _x( '%1$s %2$s', 'full name', 'woocommerce-germanized' ), $this->get_sender_first_name(), $this->get_sender_last_name() );
+ }
+
+ /**
+ * Returns the sender address postcode.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_sender_postcode( $context = 'view' ) {
+ return $this->get_sender_address_prop( 'postcode', $context );
+ }
+
+ /**
+ * Returns the sender address city.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_sender_city( $context = 'view' ) {
+ return $this->get_sender_address_prop( 'city', $context );
+ }
+
+ /**
+ * Returns the sender address state.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_sender_state( $context = 'view' ) {
+ return $this->get_sender_address_prop( 'state', $context );
+ }
+
+ public function get_formatted_sender_state() {
+ if ( '' === $this->get_sender_state() || '' === $this->get_sender_country() ) {
+ return '';
+ }
+
+ return wc_gzd_get_formatted_state( $this->get_sender_state(), $this->get_sender_country() );
+ }
+
+ /**
+ * Returns the sender address country.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_sender_country( $context = 'view' ) {
+ return $this->get_sender_address_prop( 'country', $context ) ? $this->get_sender_address_prop( 'country', $context ) : '';
+ }
+
+ /**
+ * Set sender address.
+ *
+ * @param string[] $address The address props.
+ */
+ public function set_sender_address( $address ) {
+ $this->set_prop( 'sender_address', empty( $address ) ? array() : (array) $address );
+ }
+
+ /**
+ * Syncs the return shipment with the corresponding parent shipment.
+ *
+ * @param array $args
+ *
+ * @return bool
+ */
+ public function sync( $args = array() ) {
+
+ try {
+
+ if ( ! $order_shipment = $this->get_order_shipment() ) {
+ throw new Exception( _x( 'Invalid shipment order', 'shipments', 'woocommerce-germanized' ) );
+ }
+
+ $return_address = wc_gzd_get_shipment_return_address( $order_shipment );
+ $order = $order_shipment->get_order();
+
+ /**
+ * Make sure that manually adjusted providers are not overridden by syncing.
+ */
+ $default_provider = $order_shipment->get_default_return_shipping_provider();
+ $provider = $this->get_shipping_provider( 'edit' );
+
+ $args = wp_parse_args( $args, array(
+ 'order_id' => $order->get_id(),
+ 'country' => $return_address['country'],
+ 'shipping_method' => wc_gzd_get_shipment_order_shipping_method_id( $order ),
+ 'shipping_provider' => ( ! empty( $provider ) ) ? $provider : $default_provider,
+ 'address' => $return_address,
+ 'sender_address' => array_merge( $order->get_address( 'shipping' ), array( 'email' => $order->get_billing_email(), 'phone' => $order->get_billing_phone() ) ),
+ 'weight' => $this->get_weight( 'edit' ),
+ 'length' => $this->get_length( 'edit' ),
+ 'width' => $this->get_width( 'edit' ),
+ 'height' => $this->get_height( 'edit' ),
+ ) );
+
+ /**
+ * Filter to allow adjusting the return shipment props synced from the corresponding order.
+ *
+ * @param mixed $args The properties in key => value pairs.
+ * @param ReturnShipment $shipment The shipment object.
+ * @param Order $order_shipment The shipment order object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ $args = apply_filters( 'woocommerce_gzd_return_shipment_sync_props', $args, $this, $order_shipment );
+
+ $this->set_props( $args );
+
+ /**
+ * Action that fires after a return shipment has been synced. Syncing is used to
+ * keep the shipment in sync with the corresponding parent shipment.
+ *
+ * @param ReturnShipment $shipment The return shipment object.
+ * @param Order $order_shipment The shipment order object.
+ * @param array $args Array containing properties in key => value pairs to be updated.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( 'woocommerce_gzd_return_shipment_synced', $this, $order_shipment, $args );
+
+ } catch ( Exception $e ) {
+ return false;
+ }
+
+ return true;
+ }
+
+ /**
+ * Keeps items in sync with the parent shipment items.
+ * Limits quantities and removes non-existent items.
+ *
+ * @param array $args
+ *
+ * @return bool
+ */
+ public function sync_items( $args = array() ) {
+ try {
+
+ if ( ! $order_shipment = $this->get_order_shipment() ) {
+ throw new Exception( _x( 'Invalid shipment order', 'shipments', 'woocommerce-germanized' ) );
+ }
+
+ $order = $order_shipment->get_order();
+
+ $args = wp_parse_args( $args, array(
+ 'items' => array(),
+ ) );
+
+ $available_items = $order_shipment->get_available_items_for_return( array(
+ 'shipment_id' => $this->get_id(),
+ 'exclude_current_shipment' => true,
+ ) );
+
+ foreach( $available_items as $order_item_id => $item_data ) {
+
+ if ( $item = $order_shipment->get_simple_shipment_item( $order_item_id ) ) {
+ $quantity = $item_data['max_quantity'];
+ $return_reason_code = '';
+
+ if ( ! empty( $args['items'] ) ) {
+ if ( isset( $args['items'][ $order_item_id ] ) ) {
+
+ if ( is_array( $args['items'][ $order_item_id ] ) ) {
+ $default_item_data = wp_parse_args( $args['items'][ $order_item_id ], array(
+ 'quantity' => 1,
+ 'return_reason_code' => '',
+ ) );
+ } else {
+ $default_item_data = array(
+ 'quantity' => absint( $args['items'][ $order_item_id ] ),
+ 'return_reason_code' => '',
+ );
+ }
+
+ $new_quantity = $default_item_data['quantity'];
+ $return_reason_code = $default_item_data['return_reason_code'];
+
+ if ( $new_quantity < $quantity ) {
+ $quantity = $new_quantity;
+ }
+ } else {
+ continue;
+ }
+ }
+
+ $sync_data = array(
+ 'quantity' => $quantity,
+ );
+
+ if ( ! empty( $return_reason_code ) ) {
+ $sync_data['return_reason_code'] = $return_reason_code;
+ }
+
+ if ( ! $shipment_item = $this->get_item_by_order_item_id( $order_item_id ) ) {
+ $shipment_item = wc_gzd_create_return_shipment_item( $this, $item, $sync_data );
+
+ $this->add_item( $shipment_item );
+ } else {
+ $shipment_item->sync( $sync_data );
+ }
+ }
+ }
+
+ foreach( $this->get_items() as $item ) {
+
+ // Remove non-existent items
+ if ( ! $shipment_item = $order_shipment->get_simple_shipment_item( $item->get_order_item_id() ) ) {
+ $this->remove_item( $item->get_id() );
+ }
+ }
+
+ // Sync packaging
+ $this->sync_packaging();
+
+ /**
+ * Action that fires after items of a shipment have been synced.
+ *
+ * @param SimpleShipment $shipment The shipment object.
+ * @param Order $order_shipment The shipment order object.
+ * @param array $args Array containing additional data e.g. items.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( 'woocommerce_gzd_return_shipment_items_synced', $this, $order_shipment, $args );
+
+ } catch ( Exception $e ) {
+ return false;
+ }
+
+ return true;
+ }
+
+ /**
+ * Returns whether the Shipment needs additional items or not.
+ *
+ * @param bool|integer[] $available_items
+ *
+ * @return bool
+ */
+ public function needs_items( $available_items = false ) {
+
+ if ( ! $available_items && ( $order_shipment = $this->get_order_shipment() ) ) {
+ $available_items = array_keys( $order_shipment->get_available_items_for_return() );
+ }
+
+ return ( $this->is_editable() && ! $this->contains_order_item( $available_items ) );
+ }
+
+ /**
+ * Returns the edit shipment URL.
+ *
+ * @return mixed|string|void
+ */
+ public function get_edit_shipment_url() {
+ /**
+ * Filter to adjust the edit Shipment admin URL.
+ *
+ * The dynamic portion of this hook, `$this->get_hook_prefix()` is used to construct a
+ * unique hook for a shipment type.
+ *
+ * Example hook name: woocommerce_gzd_shipment_get_edit_url
+ *
+ * @param string $url The URL.
+ * @param Shipment $this The shipment object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( "{$this->get_hook_prefix()}edit_url", get_admin_url( null, 'post.php?post=' . $this->get_order_id() . '&action=edit&shipment_id=' . $this->get_id() ), $this );
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Shipment.php b/packages/woocommerce-germanized-shipments/src/Shipment.php
new file mode 100644
index 000000000..5d4483bad
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Shipment.php
@@ -0,0 +1,2371 @@
+ null,
+ 'date_sent' => null,
+ 'status' => '',
+ 'weight' => '',
+ 'width' => '',
+ 'height' => '',
+ 'length' => '',
+ 'packaging_weight' => '',
+ 'weight_unit' => '',
+ 'dimension_unit' => '',
+ 'country' => '',
+ 'address' => array(),
+ 'tracking_id' => '',
+ 'shipping_provider' => '',
+ 'shipping_method' => '',
+ 'total' => 0,
+ 'subtotal' => 0,
+ 'additional_total' => 0,
+ 'est_delivery_date' => null,
+ 'packaging_id' => 0,
+ 'version' => ''
+ );
+
+ /**
+ * Get the shipment if ID is passed, otherwise the shipment is new and empty.
+ * This class should NOT be instantiated, but the `wc_gzd_get_shipment` function should be used.
+ *
+ * @param int|object|Shipment $shipment Shipment to read.
+ */
+ public function __construct( $data = 0 ) {
+ parent::__construct( $data );
+
+ if ( $data instanceof Shipment ) {
+ $this->set_id( absint( $data->get_id() ) );
+ } elseif ( is_numeric( $data ) ) {
+ $this->set_id( $data );
+ }
+
+ $this->data_store = WC_Data_Store::load( $this->data_store_name );
+
+ // If we have an ID, load the user from the DB.
+ if ( $this->get_id() ) {
+ try {
+ $this->data_store->read( $this );
+ } catch ( Exception $e ) {
+ $this->set_id( 0 );
+ $this->set_object_read( true );
+ }
+ } else {
+ $this->set_object_read( true );
+ }
+ }
+
+ public function get_type() {
+ return '';
+ }
+
+ /**
+ * Merge changes with data and clear.
+ * Overrides WC_Data::apply_changes.
+ *
+ * @since 3.2.0
+ */
+ public function apply_changes() {
+ if ( function_exists( 'array_replace' ) ) {
+ $this->data = array_replace( $this->data, $this->changes ); // phpcs:ignore PHPCompatibility.FunctionUse.NewFunctions.array_replaceFound
+ } else { // PHP 5.2 compatibility.
+ foreach ( $this->changes as $key => $change ) {
+ $this->data[ $key ] = $change;
+ }
+ }
+ $this->changes = array();
+ }
+
+ /**
+ * @return bool|Order
+ */
+ public function get_order_shipment() {
+ return false;
+ }
+
+ public function set_order_shipment( &$order_shipment ) {}
+
+ /**
+ * Return item count (quantities summed up).
+ *
+ * @return int
+ */
+ public function get_item_count() {
+ $items = $this->get_items();
+ $quantity = 0;
+
+ foreach( $items as $item ) {
+ $quantity += $item->get_quantity();
+ }
+
+ return $quantity;
+ }
+
+ /**
+ * Prefix for action and filter hooks on data.
+ *
+ * @return string
+ */
+ protected function get_hook_prefix() {
+ return $this->get_general_hook_prefix() . 'get_';
+ }
+
+ /**
+ * Prefix for action and filter hooks on data.
+ *
+ * @return string
+ */
+ protected function get_general_hook_prefix() {
+ $shipment_prefix = 'simple' === $this->get_type() ? '' : $this->get_type() . '_';
+
+ return "woocommerce_gzd_{$shipment_prefix}shipment_";
+ }
+
+ /**
+ * Return the shipment statuses without gzd- internal prefix.
+ *
+ * @param string $context View or edit context.
+ * @return string
+ */
+ public function get_status( $context = 'view' ) {
+ $status = $this->get_prop( 'status', $context );
+
+ if ( empty( $status ) && 'view' === $context ) {
+
+ /**
+ * Filters the default Shipment status used as fallback.
+ *
+ * The dynamic portion of this hook, `$this->get_hook_prefix()` is used to construct a
+ * unique hook for a shipment type.
+ *
+ * Example hook name: woocommerce_gzd_shipment_get_default_shipment_status
+ *
+ * @param string $status Default fallback status.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ $status = apply_filters( "{$this->get_hook_prefix()}}default_shipment_status", 'draft' );
+ }
+
+ return $status;
+ }
+
+ /**
+ * Checks whether the shipment has a specific status or not.
+ *
+ * @param string|string[] $status The status to be checked against.
+ * @return boolean
+ */
+ public function has_status( $status ) {
+ /**
+ * Filter to decide whether a Shipment has a certain status or not.
+ *
+ * @param boolean $has_status Whether the Shipment has a status or not.
+ * @param Shipment $this The shipment object.
+ * @param string $status The status to be checked against.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipment_has_status', ( is_array( $status ) && in_array( $this->get_status(), $status, true ) ) || $this->get_status() === $status, $this, $status );
+ }
+
+ /**
+ * Return the date this shipment was created.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return WC_DateTime|null object if the date is set or null if there is no date.
+ */
+ public function get_date_created( $context = 'view' ) {
+ return $this->get_prop( 'date_created', $context );
+ }
+
+ /**
+ * Return the date this shipment was sent.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return WC_DateTime|null object if the date is set or null if there is no date.
+ */
+ public function get_date_sent( $context = 'view' ) {
+ return $this->get_prop( 'date_sent', $context );
+ }
+
+ /**
+ * Returns the shipment method.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_shipping_method( $context = 'view' ) {
+ return $this->get_prop( 'shipping_method', $context );
+ }
+
+ public function get_shipping_method_instance() {
+ $method_id = $this->get_shipping_method();
+
+ if ( is_null( $this->shipping_method_instance ) && ! empty( $method_id ) ) {
+ $this->shipping_method_instance = wc_gzd_get_shipping_provider_method( $this->get_shipping_method() );
+ }
+
+ return is_null( $this->shipping_method_instance ) ? false : $this->shipping_method_instance;
+ }
+
+ /**
+ * Returns the shipment weight. In case view context was chosen and weight is not yet set, returns the content weight.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_weight( $context = 'view' ) {
+ $weight = $this->get_prop( 'weight', $context );
+
+ if ( 'view' === $context && '' === $weight ) {
+ return $this->get_content_weight();
+ }
+
+ return $weight;
+ }
+
+ public function get_total_weight() {
+ $weight = $this->get_weight() + $this->get_packaging_weight();
+
+ return $weight;
+ }
+
+ public function get_packaging_weight( $context = 'view' ) {
+ $weight = $this->get_prop( 'packaging_weight', $context );
+
+ if ( 'view' === $context && '' === $weight ) {
+ if ( $packaging = $this->get_packaging() ) {
+ if ( ! empty( $packaging->get_weight() ) ) {
+ $weight = wc_get_weight( $packaging->get_weight(), $this->get_weight_unit(), wc_gzd_get_packaging_weight_unit() );
+ }
+ }
+ }
+
+ return $weight;
+ }
+
+ public function get_items_to_pack() {
+ if ( is_null( $this->items_to_pack ) ) {
+ $this->items_to_pack = array();
+
+ foreach( $this->get_items() as $item ) {
+ for ( $i = 0; $i < $item->get_quantity(); $i++ ) {
+ $box_item = new Packing\ShipmentItem( $item );
+ $this->items_to_pack[] = $box_item;
+ }
+ }
+ }
+
+ return apply_filters( "{$this->get_hook_prefix()}items_to_pack", $this->items_to_pack, $this );
+ }
+
+ /**
+ * Returns the shipment weight unit.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_weight_unit( $context = 'view' ) {
+ $unit = $this->get_prop( 'weight_unit', $context );
+
+ if ( 'view' === $context && '' === $unit ) {
+ return get_option( 'woocommerce_weight_unit' );
+ }
+
+ return $unit;
+ }
+
+ /**
+ * Returns the shipment dimension unit.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_dimension_unit( $context = 'view' ) {
+ $unit = $this->get_prop( 'dimension_unit', $context );
+
+ if ( 'view' === $context && '' === $unit ) {
+ return get_option( 'woocommerce_dimension_unit' );
+ }
+
+ return $unit;
+ }
+
+ /**
+ * Returns the shipment length. In case view context was chosen and length is not yet set, returns the content length.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_length( $context = 'view' ) {
+ $length = $this->get_prop( 'length', $context );
+
+ if ( 'view' === $context && '' === $length ) {
+ return $this->get_content_length();
+ }
+
+ return $length;
+ }
+
+ public function get_package_length() {
+ $length = $this->get_length();
+
+ // Older versions did not sync dimensions with packaging dimensions
+ if ( '' === $this->get_version() ) {
+ if ( $packaging = $this->get_packaging() ) {
+ $length = wc_get_dimension( $packaging->get_length(), $this->get_dimension_unit(), wc_gzd_get_packaging_dimension_unit() );
+ }
+ }
+
+ return $length;
+ }
+
+ public function has_packaging() {
+ return ( $this->get_packaging_id() > 0 && $this->get_packaging() ) ? true : false;
+ }
+
+ /**
+ * Returns the shipment width. In case view context was chosen and width is not yet set, returns the content width.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_width( $context = 'view' ) {
+ $width = $this->get_prop( 'width', $context );
+
+ if ( 'view' === $context && '' === $width ) {
+ return $this->get_content_width();
+ }
+
+ return $width;
+ }
+
+ public function get_package_width() {
+ $width = $this->get_width();
+
+ if ( '' === $this->get_version() ) {
+ if ( $packaging = $this->get_packaging() ) {
+ $width = wc_get_dimension( $packaging->get_width(), $this->get_dimension_unit(), wc_gzd_get_packaging_dimension_unit() );
+ }
+ }
+
+ return $width;
+ }
+
+ /**
+ * Returns the shipment height. In case view context was chosen and height is not yet set, returns the content height.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_height( $context = 'view' ) {
+ $height = $this->get_prop( 'height', $context );
+
+ if ( 'view' === $context && '' === $height ) {
+ return $this->get_content_height();
+ }
+
+ return $height;
+ }
+
+ public function get_package_height() {
+ $height = $this->get_height();
+
+ if ( '' === $this->get_version() ) {
+ if ( $packaging = $this->get_packaging() ) {
+ $height = wc_get_dimension( $packaging->get_height(), $this->get_dimension_unit(), wc_gzd_get_packaging_dimension_unit() );
+ }
+ }
+
+ return $height;
+ }
+
+ public function has_dimensions() {
+ $width = $this->get_width();
+ $length = $this->get_length();
+ $height = $this->get_height();
+
+ return ( ! empty( $width ) && ! empty( $length ) && ! empty( $height ) );
+ }
+
+ /**
+ * Returns the calculated weights for included items.
+ *
+ * @return float[]
+ */
+ public function get_item_weights() {
+ if ( is_null( $this->weights ) ) {
+ $this->weights = array();
+
+ foreach( $this->get_items() as $item ) {
+ $this->weights[ $item->get_id() ] = ( ( $item->get_weight() === '' ? 0 : $item->get_weight() ) * $item->get_quantity() );
+ }
+
+ if ( empty( $this->weights ) ) {
+ $this->weights = array( 0 );
+ }
+ }
+
+ return $this->weights;
+ }
+
+ /**
+ * Returns the calculated lengths for included items.
+ *
+ * @return float[]
+ */
+ public function get_item_lengths() {
+ if ( is_null( $this->lengths ) ) {
+ $this->lengths = array();
+
+ foreach( $this->get_items() as $item ) {
+ $this->lengths[ $item->get_id() ] = $item->get_length() === '' ? 0 : $item->get_length();
+ }
+
+ if ( empty( $this->lengths ) ) {
+ $this->lengths = array( 0 );
+ }
+ }
+
+ return $this->lengths;
+ }
+
+ /**
+ * Returns the calculated widths for included items.
+ *
+ * @return float[]
+ */
+ public function get_item_widths() {
+ if ( is_null( $this->widths ) ) {
+ $this->widths = array();
+
+ foreach( $this->get_items() as $item ) {
+ $this->widths[ $item->get_id() ] = $item->get_width() === '' ? 0 : $item->get_width();
+ }
+
+ if ( empty( $this->widths ) ) {
+ $this->widths = array( 0 );
+ }
+ }
+
+ return $this->widths;
+ }
+
+ /**
+ * Returns the calculated heights for included items.
+ *
+ * @return float[]
+ */
+ public function get_item_heights() {
+ if ( is_null( $this->heights ) ) {
+ $this->heights = array();
+
+ foreach( $this->get_items() as $item ) {
+ $this->heights[ $item->get_id() ] = ( $item->get_height() === '' ? 0 : $item->get_height() ) * $item->get_quantity();
+ }
+
+ if ( empty( $this->heights ) ) {
+ $this->heights = array( 0 );
+ }
+ }
+
+ return $this->heights;
+ }
+
+ /**
+ * Returns the calculated weight for included items.
+ *
+ * @return float
+ */
+ public function get_content_weight() {
+ return wc_format_decimal( array_sum( $this->get_item_weights() ) );
+ }
+
+ /**
+ * Returns the calculated length for included items.
+ *
+ * @return float
+ */
+ public function get_content_length() {
+ $default = max( $this->get_item_lengths() );
+
+ return wc_format_decimal( $default, false, true );
+ }
+
+ /**
+ * Returns the calculated width for included items.
+ *
+ * @return float
+ */
+ public function get_content_width() {
+ $default = max( $this->get_item_widths() );
+
+ return wc_format_decimal( $default, false, true );
+ }
+
+ /**
+ * Returns the calculated height for included items.
+ *
+ * @return float
+ */
+ public function get_content_height() {
+ $default_height = array_sum( $this->get_item_heights() );
+
+ return wc_format_decimal( $default_height, false, true );
+ }
+
+ /**
+ * Returns the shipping address properties.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string[]
+ */
+ public function get_address( $context = 'view' ) {
+ return $this->get_prop( 'address', $context );
+ }
+
+ /**
+ * Returns the shipment total.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return float
+ */
+ public function get_total( $context = 'view' ) {
+ return $this->get_prop( 'total', $context );
+ }
+
+ /**
+ * Returns the shipment total.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return float
+ */
+ public function get_subtotal( $context = 'view' ) {
+ $subtotal = $this->get_prop( 'subtotal', $context );
+
+ if ( 'view' === $context && empty( $subtotal ) ) {
+ $subtotal = $this->get_total();
+ }
+
+ return $subtotal;
+ }
+
+ /**
+ * Returns the additional total amount containing shipping and fee costs.
+ * Only one of the shipments related to an order should include additional total.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return float
+ */
+ public function get_additional_total( $context = 'view' ) {
+ return $this->get_prop( 'additional_total', $context );
+ }
+
+ public function has_tracking() {
+ $has_tracking = true;
+
+ if ( ! $this->has_tracking_instruction() && ! $this->get_tracking_url() ) {
+ $has_tracking = false;
+ }
+
+ /**
+ * Check whether the label supports tracking or not
+ */
+ if ( $this->has_label() && ( $label = $this->get_label() ) ) {
+ if ( ! $label->is_trackable() ) {
+ $has_tracking = false;
+ }
+ }
+
+ return apply_filters( "{$this->get_general_hook_prefix()}has_tracking", $has_tracking, $this );
+ }
+
+ /**
+ * Returns the shipment tracking id.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_tracking_id( $context = 'view' ) {
+ return $this->get_prop( 'tracking_id', $context );
+ }
+
+ /**
+ * Returns the shipment tracking URL.
+ *
+ * @return string
+ */
+ public function get_tracking_url() {
+ $tracking_url = '';
+
+ if ( $provider = $this->get_shipping_provider_instance() ) {
+ $tracking_url = $provider->get_tracking_url( $this );
+ }
+
+ /**
+ * Filter to adjust a Shipment's tracking URL.
+ *
+ * The dynamic portion of this hook, `$this->get_hook_prefix()` is used to construct a
+ * unique hook for a shipment type.
+ *
+ * Example hook name: woocommerce_gzd_shipment_get_tracking_url
+ *
+ * @param string $tracking_url The tracking URL.
+ * @param Shipment $shipment The shipment object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( "{$this->get_hook_prefix()}tracking_url", $tracking_url, $this );
+ }
+
+ /**
+ * Returns the shipment tracking instruction.
+ *
+ * @return string
+ */
+ public function get_tracking_instruction() {
+ $instruction = '';
+
+ if ( $provider = $this->get_shipping_provider_instance() ) {
+ // $instruction = sprintf( _x( 'Your shipment is being processed by %s. If you want to track the shipment, please use the following tracking number: %s. Depending on the chosen shipping method it is possible that the tracking data does not reflect the current status when receiving this email.', 'shipments', 'woocommerce-germanized' ), wc_gzd_get_shipping_provider_title( $this->get_shipping_provider() ), $this->get_tracking_id() );
+ $instruction = $provider->get_tracking_desc( $this );
+ }
+
+ /**
+ * Filter to adjust a Shipment's tracking instruction.
+ *
+ * The dynamic portion of this hook, `$this->get_hook_prefix()` is used to construct a
+ * unique hook for a shipment type.
+ *
+ * Example hook name: woocommerce_gzd_shipment_get_tracking_instruction
+ *
+ * @param string $instruction The tracking instruction.
+ * @param Shipment $this The shipment object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( "{$this->get_hook_prefix()}tracking_instruction", $instruction, $this );
+ }
+
+ /**
+ * Returns whether the current shipment has tracking instructions available or not.
+ *
+ * @return boolean
+ */
+ public function has_tracking_instruction() {
+ $instruction = $this->get_tracking_instruction();
+
+ return ( ! empty( $instruction ) ) ? true : false;
+ }
+
+ /**
+ * Returns the shipment shipping provider.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_shipping_provider( $context = 'view' ) {
+ return $this->get_prop( 'shipping_provider', $context );
+ }
+
+ public function get_shipping_provider_title() {
+ if ( $provider = $this->get_shipping_provider_instance() ) {
+ return $provider->get_title();
+ }
+
+ return '';
+ }
+
+ public function get_shipping_provider_instance() {
+ $provider = $this->get_shipping_provider();
+
+ if ( ! empty( $provider ) ) {
+ return wc_gzd_get_shipping_provider( $provider );
+ }
+
+ return false;
+ }
+
+ /**
+ * Returns the formatted shipping address.
+ *
+ * @param string $empty_content Content to show if no address is present.
+ * @return string
+ */
+ public function get_formatted_address( $empty_content = '' ) {
+ $address = WC()->countries->get_formatted_address( $this->get_address() );
+
+ return $address ? $address : $empty_content;
+ }
+
+ /**
+ * Get a formatted shipping address for the order.
+ *
+ * @return string
+ */
+ public function get_address_map_url( $address ) {
+ // Remove name and company before generate the Google Maps URL.
+ unset( $address['first_name'], $address['last_name'], $address['company'], $address['email'], $address['phone'], $address['title'] );
+
+ /**
+ * Filter to adjust a Shipment's address parts used for constructing the Google maps URL.
+ *
+ * The dynamic portion of this hook, `$this->get_hook_prefix()` is used to construct a
+ * unique hook for a shipment type.
+ *
+ * Example hook name: woocommerce_gzd_shipment_get_address_map_url_parts
+ *
+ * @param string[] $address The address parts used.
+ * @param Shipment $this The shipment object.
+ *
+ * @since 3.0.6
+ * @package Vendidero/Germanized/Shipments
+ */
+ $address = apply_filters( "{$this->get_hook_prefix()}address_map_url_parts", $address, $this );
+ $address = array_filter( $address );
+
+ /**
+ * Filter to adjust a Shipment's address Google maps URL.
+ *
+ * The dynamic portion of this hook, `$this->get_hook_prefix()` is used to construct a
+ * unique hook for a shipment type.
+ *
+ * Example hook name: woocommerce_gzd_shipment_get_address_map_url
+ *
+ * @param string $url The address url.
+ * @param Shipment $this The shipment object.
+ *
+ * @since 3.0.6
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( "{$this->get_hook_prefix()}address_map_url", 'https://maps.google.com/maps?&q=' . rawurlencode( implode( ', ', $address ) ) . '&z=16', $this );
+ }
+
+ /**
+ * Returns the shipment address phone number.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_phone( $context = 'view' ) {
+ return $this->get_address_prop( 'phone', $context );
+ }
+
+ /**
+ * Returns the shipment address email.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_email( $context = 'view' ) {
+ return $this->get_address_prop( 'email', $context );
+ }
+
+ /**
+ * Returns the shipment address first line.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_address_1( $context = 'view' ) {
+ return $this->get_address_prop( 'address_1', $context );
+ }
+
+ /**
+ * Returns the shipment address second line.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_address_2( $context = 'view' ) {
+ return $this->get_address_prop( 'address_2', $context );
+ }
+
+ /**
+ * Returns the shipment address street number by splitting the address.
+ *
+ * @param string $type The address type e.g. address_1 or address_2.
+ *
+ * @return string
+ */
+ public function get_address_street_number( $type = 'address_1' ) {
+ $split = wc_gzd_split_shipment_street( $this->{"get_$type"}() );
+
+ /**
+ * Filter to adjust the shipment address street number.
+ *
+ * @param string $number The shipment address street number.
+ * @param Shipment $shipment The shipment object.
+ *
+ * @since 3.0.6
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_get_shipment_address_street_number', $split['number'], $this );
+ }
+
+ /**
+ * Returns the shipment address street without number by splitting the address.
+ *
+ * @param string $type The address type e.g. address_1 or address_2.
+ *
+ * @return string
+ */
+ public function get_address_street( $type = 'address_1' ) {
+ $split = wc_gzd_split_shipment_street( $this->{"get_$type"}() );
+
+ /**
+ * Filter to adjust the shipment address street.
+ *
+ * @param string $street The shipment address street without street number.
+ * @param Shipment $shipment The shipment object.
+ *
+ * @since 3.0.6
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_get_shipment_address_street', $split['street'], $this );
+ }
+
+ public function get_address_street_addition( $type = 'address_1' ) {
+ $split = wc_gzd_split_shipment_street( $this->{"get_$type"}() );
+
+ /**
+ * Filter to adjust the shipment address street addition.
+ *
+ * @param string $addition The shipment address street addition e.g. EG14.
+ * @param Shipment $shipment The shipment object.
+ *
+ * @since 3.0.6
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_get_shipment_address_street_addition', $split['addition'], $this );
+ }
+
+ /**
+ * Returns the shipment address company.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_company( $context = 'view' ) {
+ return $this->get_address_prop( 'company', $context );
+ }
+
+ /**
+ * Returns the shipment address first name.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_first_name( $context = 'view' ) {
+ return $this->get_address_prop( 'first_name', $context );
+ }
+
+ /**
+ * Returns the shipment address last name.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_last_name( $context = 'view' ) {
+ return $this->get_address_prop( 'last_name', $context );
+ }
+
+ /**
+ * Returns the shipment address formatted full name.
+ *
+ * @return string
+ */
+ public function get_formatted_full_name() {
+ return sprintf( _x( '%1$s %2$s', 'full name', 'woocommerce-germanized' ), $this->get_first_name(), $this->get_last_name() );
+ }
+
+ /**
+ * Returns the shipment address postcode.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_postcode( $context = 'view' ) {
+ return $this->get_address_prop( 'postcode', $context );
+ }
+
+ /**
+ * Returns the shipment address city.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_city( $context = 'view' ) {
+ return $this->get_address_prop( 'city', $context );
+ }
+
+ /**
+ * Returns the shipment address state.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_state( $context = 'view' ) {
+ return $this->get_address_prop( 'state', $context );
+ }
+
+ public function get_formatted_state() {
+ if ( '' === $this->get_state() || '' === $this->get_country() ) {
+ return '';
+ }
+
+ return wc_gzd_get_formatted_state( $this->get_state(), $this->get_country() );
+ }
+
+ /**
+ * Returns the shipment address country.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_country( $context = 'view' ) {
+ return $this->get_address_prop( 'country', $context ) ? $this->get_address_prop( 'country', $context ) : '';
+ }
+
+ /**
+ * Return the date this shipment is estimated to be delivered.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return WC_DateTime|null object if the date is set or null if there is no date.
+ */
+ public function get_est_delivery_date( $context = 'view' ) {
+ return $this->get_prop( 'est_delivery_date', $context );
+ }
+
+ /**
+ * Decides whether the shipment is sent to an external pickup or not.
+ *
+ * @param string[]|string $types
+ *
+ * @return boolean
+ */
+ public function send_to_external_pickup( $types ) {
+ $types = is_array( $types ) ? $types : array( $types );
+
+ /**
+ * Filter to decide whether a Shipment is to be sent to a external pickup location
+ * e.g. packstation.
+ *
+ * @param boolean $external True if the Shipment goes to a pickup location.
+ * @param array $types Array containing the types to be checked agains.
+ * @param Shipment $this The shipment object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipment_send_to_external_pickup', false, $types, $this );
+ }
+
+ /**
+ * Returns an address prop.
+ *
+ * @param string $prop
+ * @param string $context
+ *
+ * @return null|string
+ */
+ protected function get_address_prop( $prop, $context = 'view' ) {
+ $value = null;
+
+ if ( isset( $this->changes['address'][ $prop ] ) || isset( $this->data['address'][ $prop ] ) ) {
+ $value = isset( $this->changes['address'][ $prop ] ) ? $this->changes['address'][ $prop ] : $this->data['address'][ $prop ];
+
+ if ( 'view' === $context ) {
+ /**
+ * Filter to adjust a Shipment's shipping address property e.g. first_name.
+ *
+ * The dynamic portion of this hook, `$this->get_hook_prefix()` is used to construct a
+ * unique hook for a shipment type. `$prop` refers to the actual address property e.g. first_name.
+ *
+ * Example hook name: woocommerce_gzd_shipment_get_address_first_name
+ *
+ * @param string $value The address property value.
+ * @param Shipment $this The shipment object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ $value = apply_filters( "{$this->get_hook_prefix()}address_{$prop}", $value, $this );
+ }
+ }
+
+ return $value;
+ }
+
+ /**
+ * Returns dimensions.
+ *
+ * @return string|array
+ */
+ public function get_dimensions() {
+ return array(
+ 'length' => $this->get_length(),
+ 'width' => $this->get_width(),
+ 'height' => $this->get_height(),
+ );
+ }
+
+ /**
+ * Returns dimensions.
+ *
+ * @return string|array
+ */
+ public function get_package_dimensions() {
+ return array(
+ 'length' => $this->get_package_length(),
+ 'width' => $this->get_package_width(),
+ 'height' => $this->get_package_height(),
+ );
+ }
+
+ public function get_formatted_dimensions() {
+ return wc_gzd_format_shipment_dimensions( $this->get_dimensions(), $this->get_dimension_unit() );
+ }
+
+ /**
+ * Returns whether the shipment is editable or not.
+ *
+ * @return boolean
+ */
+ public function is_editable() {
+ /**
+ * Filter to dedice whether the current Shipment is still editable or not.
+ *
+ * @param boolean $is_editable Whether the Shipment is editable or not.
+ * @param Shipment $this The shipment object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipment_is_editable', $this->has_status( wc_gzd_get_shipment_editable_statuses() ), $this );
+ }
+
+ /**
+ * Returns the shipment number.
+ *
+ * @return string
+ */
+ public function get_shipment_number() {
+ /**
+ * Filter to adjust a Shipment's number.
+ *
+ * The dynamic portion of this hook, `$this->get_hook_prefix()` is used to construct a
+ * unique hook for a shipment type.
+ *
+ * Example hook name: woocommerce_gzd_shipment_get_shipment_number
+ *
+ * @param string $number The shipment number.
+ * @param Shipment $this The shipment object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return (string) apply_filters( "{$this->get_hook_prefix()}shipment_number", $this->get_id(), $this );
+ }
+
+ /*
+ |--------------------------------------------------------------------------
+ | Setters
+ |--------------------------------------------------------------------------
+ */
+
+ /**
+ * Set shipment status.
+ *
+ * @param string $new_status Status to change the shipment to. No internal gzd- prefix is required.
+ * @param boolean $manual_update Whether it is a manual status update or not.
+ * @return array details of change
+ */
+ public function set_status( $new_status, $manual_update = false ) {
+ $old_status = $this->get_status();
+ $new_status = 'gzd-' === substr( $new_status, 0, 4 ) ? substr( $new_status, 4 ) : $new_status;
+
+ $this->set_prop( 'status', $new_status );
+
+ $result = array(
+ 'from' => $old_status,
+ 'to' => $new_status,
+ );
+
+ if ( true === $this->object_read && ! empty( $result['from'] ) && $result['from'] !== $result['to'] ) {
+ $this->status_transition = array(
+ 'from' => ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $result['from'],
+ 'to' => $result['to'],
+ 'manual' => (bool) $manual_update,
+ );
+
+ if ( $manual_update ) {
+ /**
+ * Action that fires after a shipment status has been updated manually.
+ *
+ * @param integer $shipment_id The shipment id.
+ * @param string $status The new shipment status.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( 'woocommerce_gzd_shipment_edit_status', $this->get_id(), $result['to'] );
+ }
+
+ $this->maybe_set_date_sent();
+ }
+
+ return $result;
+ }
+
+ /**
+ * Maybe set date sent.
+ *
+ * Sets the date sent variable when transitioning to the shipped shipment status.
+ * Date sent is set once in this manner - only when it is not already set.
+ */
+ public function maybe_set_date_sent() {
+ // This logic only runs if the date_sent prop has not been set yet.
+ if ( ! $this->get_date_sent( 'edit' ) ) {
+ $sent_stati = wc_gzd_get_shipment_sent_statuses();
+
+ if ( $this->has_status( $sent_stati ) ) {
+
+ // If payment complete status is reached, set paid now.
+ $this->set_date_sent( current_time( 'timestamp', true ) );
+ }
+ }
+ }
+
+ /**
+ * Updates status of shipment immediately.
+ *
+ * @uses Shipment::set_status()
+ *
+ * @param string $new_status Status to change the shipment to. No internal gzd- prefix is required.
+ * @param bool $manual Is this a manual order status change?
+ * @return bool
+ */
+ public function update_status( $new_status, $manual = false ) {
+ if ( ! $this->get_id() ) {
+ return false;
+ }
+
+ try {
+ $this->set_status( $new_status, $manual );
+ $this->save();
+ } catch ( Exception $e ) {
+ $logger = wc_get_logger();
+ $logger->error(
+ sprintf( 'Error updating status for shipment #%d', $this->get_id() ), array(
+ 'shipment' => $this,
+ 'error' => $e,
+ )
+ );
+ return false;
+ }
+ return true;
+ }
+
+ /**
+ * Set the date this shipment was created.
+ *
+ * @param string|integer|null $date UTC timestamp, or ISO 8601 DateTime. If the DateTime string has no timezone or offset, WordPress site timezone will be assumed. Null if their is no date.
+ */
+ public function set_date_created( $date = null ) {
+ $this->set_date_prop( 'date_created', $date );
+ }
+
+ /**
+ * Set the date this shipment was sent.
+ *
+ * @param string|integer|null $date UTC timestamp, or ISO 8601 DateTime. If the DateTime string has no timezone or offset, WordPress site timezone will be assumed. Null if their is no date.
+ */
+ public function set_date_sent( $date = null ) {
+ $this->set_date_prop( 'date_sent', $date );
+ }
+
+ /**
+ * Set shipment weight in kg.
+ *
+ * @param string $weight The weight.
+ */
+ public function set_weight( $weight ) {
+ $this->set_prop( 'weight', '' === $weight ? '' : wc_format_decimal( $weight ) );
+ }
+
+ public function set_packaging_weight( $weight ) {
+ $this->set_prop( 'packaging_weight', '' === $weight ? '' : wc_format_decimal( $weight ) );
+ }
+
+ /**
+ * Set shipment total weight.
+ *
+ * @param string $weight The weight.
+ */
+ public function set_total_weight( $weight ) {
+ $this->set_prop( 'total_weight', '' === $weight ? '' : wc_format_decimal( $weight ) );
+ }
+
+ /**
+ * Set shipment width.
+ *
+ * @param string $width The width.
+ */
+ public function set_width( $width ) {
+ $this->set_prop( 'width', '' === $width ? '' : wc_format_decimal( $width ) );
+ }
+
+ public function set_weight_unit( $unit ) {
+ $this->set_prop( 'weight_unit', $unit );
+ }
+
+ public function set_dimension_unit( $unit ) {
+ $this->set_prop( 'dimension_unit', $unit );
+ }
+
+ /**
+ * Set shipment length.
+ *
+ * @param string $length The length.
+ */
+ public function set_length( $length ) {
+ $this->set_prop( 'length', '' === $length ? '' : wc_format_decimal( $length ) );
+ }
+
+ /**
+ * Set shipment height.
+ *
+ * @param string $height The height.
+ */
+ public function set_height( $height ) {
+ $this->set_prop( 'height', '' === $height ? '' : wc_format_decimal( $height ) );
+ }
+
+ /**
+ * Set shipment address.
+ *
+ * @param string[] $address The address props.
+ */
+ public function set_address( $address ) {
+ $this->set_prop( 'address', empty( $address ) ? array() : (array) $address );
+ }
+
+ /**
+ * Set shipment shipping method.
+ *
+ * @param string $method The shipping method.
+ */
+ public function set_shipping_method( $method ) {
+ $this->shipping_method_instance = null;
+
+ $this->set_prop( 'shipping_method', $method );
+ }
+
+ /**
+ * Set shipment version.
+ *
+ * @param string $version The version.
+ */
+ public function set_version( $version ) {
+ $this->set_prop( 'version', $version );
+ }
+
+ /**
+ * Set the date this shipment will be delivered.
+ *
+ * @param string|integer|null $date UTC timestamp, or ISO 8601 DateTime. If the DateTime string has no timezone or offset, WordPress site timezone will be assumed. Null if their is no date.
+ */
+ public function set_est_delivery_date( $date = null ) {
+ $this->set_date_prop( 'est_delivery_date', $date );
+ }
+
+ /**
+ * Set shipment total.
+ *
+ * @param float|string $value The shipment total.
+ */
+ public function set_total( $value ) {
+ $value = wc_format_decimal( $value );
+
+ if ( ! is_numeric( $value ) ) {
+ $value = 0;
+ }
+
+ $this->set_prop( 'total', $value );
+ }
+
+ /**
+ * Set shipment total.
+ *
+ * @param float|string $value The shipment total.
+ */
+ public function set_subtotal( $value ) {
+ $value = wc_format_decimal( $value );
+
+ if ( ! is_numeric( $value ) ) {
+ $value = 0;
+ }
+
+ $this->set_prop( 'subtotal', $value );
+ }
+
+ /**
+ * Set shipment additional total.
+ *
+ * @param float|string $value The shipment total.
+ */
+ public function set_additional_total( $value ) {
+ $value = wc_format_decimal( $value );
+
+ if ( ! is_numeric( $value ) ) {
+ $value = 0;
+ }
+
+ $this->set_prop( 'additional_total', $value );
+ }
+
+ /**
+ * Set shipment shipping country.
+ *
+ * @param string $country The country in ISO format.
+ */
+ public function set_country( $country ) {
+ $this->set_address_prop( 'country', $country );
+ }
+
+ /**
+ * Update a specific address prop.
+ *
+ * @param $prop
+ * @param $value
+ */
+ protected function set_address_prop( $prop, $value ) {
+ $address = $this->get_address();
+ $address[ $prop ] = $value;
+
+ $this->set_address( $address );
+ }
+
+ /**
+ * Set shipment tracking id.
+ *
+ * @param string $tracking_id The trakcing id.
+ */
+ public function set_tracking_id( $tracking_id ) {
+ $this->set_prop( 'tracking_id', $tracking_id );
+ }
+
+ /**
+ * Set shipment shipping provider.
+ *
+ * @param string $provider The shipping provider.
+ */
+ public function set_shipping_provider( $provider ) {
+ $this->set_prop( 'shipping_provider', wc_gzd_get_shipping_provider_slug( $provider ) );
+ }
+
+ /**
+ * Set packaging id.
+ *
+ * @param integer $packaging_id The packaging id.
+ */
+ public function set_packaging_id( $packaging_id ) {
+ $this->set_prop( 'packaging_id', absint( $packaging_id ) );
+
+ $this->packaging = null;
+ }
+
+ public function sync_packaging() {
+ $available_packaging = $this->get_available_packaging();
+ $default_packaging = $this->get_default_packaging();
+ $packaging_id = $this->get_packaging_id( 'edit' );
+
+ if ( ! empty( $packaging_id ) ) {
+ $exists = false;
+
+ foreach( $available_packaging as $packaging ) {
+ if ( $packaging_id == $packaging->get_id() ) {
+ $exists = true;
+ break;
+ }
+ }
+
+ if ( ! $exists ) {
+ $this->set_packaging_id( $default_packaging->get_id() );
+ }
+ } elseif ( empty( $packaging_id ) && $default_packaging ) {
+ $this->set_packaging_id( $default_packaging->get_id() );
+ }
+ }
+
+ public function update_packaging() {
+ if ( $packaging = $this->get_packaging() ) {
+ $packaging_dimension = wc_gzd_get_packaging_dimension_unit();
+
+ $props = array(
+ 'width' => wc_get_dimension( $packaging->get_width( 'edit' ), $this->get_dimension_unit(), $packaging_dimension ),
+ 'length' => wc_get_dimension( $packaging->get_length( 'edit' ), $this->get_dimension_unit(), $packaging_dimension ),
+ 'height' => wc_get_dimension( $packaging->get_height( 'edit' ), $this->get_dimension_unit(), $packaging_dimension ),
+ 'packaging_weight' => wc_get_weight( $packaging->get_weight( 'edit' ), $this->get_weight_unit(), wc_gzd_get_packaging_weight_unit() )
+ );
+
+ $this->set_props( $props );
+ } else {
+ // Reset
+ $this->set_props( array(
+ 'width' => '',
+ 'length' => '',
+ 'height' => '',
+ 'packaging_weight' => ''
+ ) );
+ }
+
+ return true;
+ }
+
+ /**
+ * Return an array of items within this shipment.
+ *
+ * @return ShipmentItem[]
+ */
+ public function get_items() {
+ $items = array();
+
+ if ( is_null( $this->items ) ) {
+ $this->items = array_filter( $this->data_store->read_items( $this ) );
+
+ $items = (array) $this->items;
+ } else {
+ $items = (array) $this->items;
+ }
+
+ /**
+ * Filter to adjust items belonging to a Shipment.
+ *
+ * The dynamic portion of this hook, `$this->get_hook_prefix()` is used to construct a
+ * unique hook for a shipment type.
+ *
+ * Example hook name: woocommerce_gzd_shipment_get_items
+ *
+ * @param string $number The shipment number.
+ * @param Shipment $this The shipment object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( "{$this->get_hook_prefix()}items", $items, $this );
+ }
+
+ /**
+ * Get's the URL to edit the shipment in the backend.
+ *
+ * @return string
+ */
+ abstract public function get_edit_shipment_url();
+
+ public function get_view_shipment_url() {
+ /**
+ * Filter to adjust the URL being used to access the view shipment page on the customer account page.
+ *
+ * The dynamic portion of this hook, `$this->get_hook_prefix()` is used to construct a
+ * unique hook for a shipment type.
+ *
+ * Example hook name: woocommerce_gzd_shipment_view_shipment_url
+ *
+ * @param string $url The URL pointing to the view page.
+ * @param Shipment $this The shipment object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( "{$this->get_hook_prefix()}_view_shipment_url", wc_get_endpoint_url( 'view-shipment', $this->get_id(), wc_get_page_permalink( 'myaccount' ) ), $this );
+ }
+
+ /**
+ * Get an item object.
+ *
+ * @param int $item_id ID of item to get.
+ *
+ * @return ShipmentItem|false
+ */
+ public function get_item( $item_id ) {
+ $items = $this->get_items();
+
+ if ( isset( $items[ $item_id ] ) ) {
+ return $items[ $item_id ];
+ }
+
+ return false;
+ }
+
+ /**
+ * Remove item from the shipment.
+ *
+ * @param int $item_id Item ID to delete.
+ *
+ * @return false|void
+ */
+ public function remove_item( $item_id ) {
+ $item = $this->get_item( $item_id );
+
+ // Unset and remove later.
+ $this->items_to_delete[] = $item;
+
+ unset( $this->items[ $item->get_id() ] );
+
+ $this->reset_content_data();
+ $this->calculate_totals();
+ $this->sync_packaging();
+ }
+
+ public function update_item_quantity( $item_id, $quantity = 1 ) {
+ if ( $item = $this->get_item( $item_id ) ) {
+ $item->set_quantity( $quantity );
+
+ if ( array_key_exists( 'quantity', $item->get_changes() ) ) {
+ $this->sync_packaging();
+ }
+
+ return true;
+ }
+
+ return false;
+ }
+
+ /**
+ * Adds a shipment item to this shipment. The shipment item will not persist until save.
+ *
+ * @since 3.0.0
+ * @param ShipmentItem $item Shipment item object.
+ *
+ * @return false|void
+ */
+ public function add_item( $item ) {
+ // Make sure that items are loaded
+ $items = $this->get_items();
+
+ // Set parent.
+ $item->set_shipment_id( $this->get_id() );
+
+ // Append new row with generated temporary ID.
+ $item_id = $item->get_id();
+
+ if ( $item_id ) {
+ $this->items[ $item_id ] = $item;
+ } else {
+ $this->items[ 'new:' . count( $this->items ) ] = $item;
+ }
+
+ $this->items_to_pack = null;
+
+ $this->reset_content_data();
+ $this->calculate_totals();
+ $this->sync_packaging();
+ }
+
+ /**
+ * Reset item content data.
+ */
+ protected function reset_content_data() {
+ $this->weights = null;
+ $this->lengths = null;
+ $this->widths = null;
+ $this->heights = null;
+ }
+
+ /**
+ * Handle the status transition.
+ */
+ protected function status_transition() {
+ $status_transition = $this->status_transition;
+
+ // Reset status transition variable.
+ $this->status_transition = false;
+
+ if ( $status_transition ) {
+ try {
+ /**
+ * Action that fires before a shipment status transition happens.
+ *
+ * @param integer $shipment_id The shipment id.
+ * @param Shipment $shipment The shipment object.
+ * @param array $status_transition The status transition data.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( 'woocommerce_gzd_shipment_before_status_change', $this->get_id(), $this, $this->status_transition );
+
+ $status_to = $status_transition['to'];
+ $status_hook_prefix = 'woocommerce_gzd_' . ( 'simple' === $this->get_type() ? '' : $this->get_type() . '_' ) . 'shipment_status';
+
+ /**
+ * Action that indicates shipment status change to a specific status.
+ *
+ * The dynamic portion of the hook name, `$status_hook_prefix` constructs a unique prefix
+ * based on the shipment type. `$status_to` refers to the new shipment status.
+ *
+ * Example hook name: `woocommerce_gzd_return_shipment_status_processing`
+ *
+ * @param integer $shipment_id The shipment id.
+ * @param Shipment $shipment The shipment object.
+ *
+ * @see wc_gzd_get_shipment_statuses()
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( "{$status_hook_prefix}_$status_to", $this->get_id(), $this );
+
+ if ( ! empty( $status_transition['from'] ) ) {
+ $status_from = $status_transition['from'];
+
+ /**
+ * Action that indicates shipment status change from a specific status to a specific status.
+ *
+ * The dynamic portion of the hook name, `$status_hook_prefix` constructs a unique prefix
+ * based on the shipment type. `$status_from` refers to the old shipment status.
+ * `$status_to` refers to the new status.
+ *
+ * Example hook name: `woocommerce_gzd_return_shipment_status_processing_to_shipped`
+ *
+ * @param integer $shipment_id The shipment id.
+ * @param Shipment $shipment The shipment object.
+ *
+ * @see wc_gzd_get_shipment_statuses()
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( "{$status_hook_prefix}_{$status_from}_to_{$status_to}", $this->get_id(), $this );
+
+ /**
+ * Action that indicates shipment status change.
+ *
+ * @param integer $shipment_id The shipment id.
+ * @param string $status_from The old shipment status.
+ * @param string $status_to The new shipment status.
+ * @param Shipment $shipment The shipment object.
+ *
+ * @see wc_gzd_get_shipment_statuses()
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( 'woocommerce_gzd_shipment_status_changed', $this->get_id(), $status_from, $status_to, $this );
+ }
+ } catch ( Exception $e ) {
+ $logger = wc_get_logger();
+ $logger->error(
+ sprintf( 'Status transition of shipment #%d errored!', $this->get_id() ), array(
+ 'shipment' => $this,
+ 'error' => $e,
+ )
+ );
+ }
+ }
+ }
+
+ /**
+ * Remove all items from the shipment.
+ */
+ public function remove_items() {
+ $this->data_store->delete_items( $this );
+ $this->items = array();
+
+ $this->items_to_pack = null;
+
+ $this->reset_content_data();
+ $this->calculate_totals();
+ $this->sync_packaging();
+ }
+
+ /**
+ * Save all items which are part of this shipment.
+ */
+ protected function save_items() {
+ $items_changed = false;
+
+ foreach ( $this->items_to_delete as $item ) {
+ $item->delete();
+ $items_changed = true;
+ }
+
+ $this->items_to_delete = array();
+
+ foreach ( $this->get_items() as $item_key => $item ) {
+ $item->set_shipment_id( $this->get_id() );
+
+ $item_id = $item->save();
+
+ // If ID changed (new item saved to DB)...
+ if ( $item_id !== $item_key ) {
+ $this->items[ $item_id ] = $item;
+
+ unset( $this->items[ $item_key ] );
+
+ $items_changed = true;
+ }
+ }
+ }
+
+ /**
+ * Finds an ShipmentItem based on an order item id.
+ *
+ * @param integer $order_item_id
+ *
+ * @return bool|ShipmentItem
+ */
+ public function get_item_by_order_item_id( $order_item_id ) {
+ $items = $this->get_items();
+
+ foreach( $items as $item ) {
+ if ( $item->get_order_item_id() === (int) $order_item_id ) {
+ return $item;
+ }
+ }
+
+ return false;
+ }
+
+ /**
+ * Returns version.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return integer
+ */
+ public function get_version( $context = 'view' ) {
+ return $this->get_prop( 'version', $context );
+ }
+
+ /**
+ * Returns the packaging id belonging to the shipment.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return integer
+ */
+ public function get_packaging_id( $context = 'view' ) {
+ return $this->get_prop( 'packaging_id', $context );
+ }
+
+ public function get_packaging() {
+ if ( is_null( $this->packaging ) && $this->get_packaging_id() > 0 ) {
+ $this->packaging = wc_gzd_get_packaging( $this->get_packaging_id() );
+ }
+
+ return $this->packaging;
+ }
+
+ public function get_available_packaging() {
+ $packaging_store = \WC_Data_Store::load( 'packaging' );
+
+ return apply_filters( "{$this->get_hook_prefix()}available_packaging", $packaging_store->find_available_packaging_for_shipment( $this ), $this );
+ }
+
+ public function get_default_packaging() {
+ $packaging_store = \WC_Data_Store::load( 'packaging' );
+ $default_packaging = $packaging_store->find_best_match_for_shipment( $this );
+
+ if ( ! $default_packaging ) {
+ $setting = Package::get_setting( 'default_packaging' );
+
+ if ( ! empty( $setting ) && wc_gzd_get_packaging( $setting ) ) {
+ $default_packaging = wc_gzd_get_packaging( $setting );
+ }
+ }
+
+ return apply_filters( "{$this->get_hook_prefix()}default_packaging_id", $default_packaging, $this );
+ }
+
+ /**
+ * Tries to fetch the order for the current shipment.
+ *
+ * @return bool|WC_Order|null
+ */
+ abstract public function get_order();
+
+ abstract public function get_order_id();
+
+ /**
+ * Returns the formatted order number.
+ *
+ * @return string
+ */
+ public function get_order_number() {
+ if ( $order = $this->get_order() ) {
+ return $order->get_order_number();
+ }
+
+ return $this->get_order_id();
+ }
+
+ /**
+ * Returns whether the Shipment contains an order item or not.
+ *
+ * @param integer|integer[] $item_id
+ *
+ * @return boolean
+ */
+ public function contains_order_item( $item_id ) {
+
+ if ( ! is_array( $item_id ) ) {
+ $item_id = array( $item_id );
+ }
+
+ $new_items = $item_id;
+
+ foreach( $item_id as $key => $order_item_id ) {
+
+ if ( is_a( $order_item_id, 'WC_Order_Item' ) ) {
+ $order_item_id = $order_item_id->get_id();
+ $item_id[ $key ] = $order_item_id;
+ }
+
+ if ( $this->get_item_by_order_item_id( $order_item_id ) ) {
+ unset( $new_items[ $key ] );
+ }
+ }
+
+ $contains = empty( $new_items ) ? true : false;
+
+ /**
+ * Filter to adjust whether a Shipment contains a specific order item or not.
+ *
+ * @param boolean $contains Whether the Shipment contains the order item or not.
+ * @param integer[] $order_item_id The order item id(s).
+ * @param Shipment $this The shipment object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipment_contains_order_item', $contains, $item_id, $this );
+ }
+
+ public function get_shippable_item_count() {
+ return 0;
+ }
+
+ /**
+ * Finds an ShipmentItem based on an item parent id.
+ *
+ * @param integer $item_parent_id
+ *
+ * @return bool|ShipmentItem
+ */
+ public function get_item_by_item_parent_id( $item_parent_id ) {
+ $items = $this->get_items();
+
+ foreach( $items as $item ) {
+ if ( $item->get_parent_id() === $item_parent_id ) {
+ return $item;
+ }
+ }
+
+ return false;
+ }
+
+ public function needs_items( $available_items = false ) {
+ return false;
+ }
+
+ public function sync( $args = array() ) {
+ return false;
+ }
+
+ public function sync_items( $args = array() ) {
+ return false;
+ }
+
+ /**
+ * Returns a label
+ *
+ * @return boolean|ShipmentLabel|ShipmentReturnLabel
+ */
+ public function get_label() {
+ $label = false;
+ $prefix = '';
+
+ if ( $provider = $this->get_shipping_provider_instance() ) {
+ $prefix = $provider->get_name() . '_';
+ $label = $provider->get_label( $this );
+ }
+
+ /**
+ * Filter for shipping providers to retrieve the `ShipmentLabel` corresponding to a certain shipment.
+ *
+ * The dynamic portion of this hook, `$this->get_hook_prefix()` is used to construct a
+ * unique hook for a shipment type. `$provider` is related to the current shipping provider
+ * for the shipment (slug).
+ *
+ * Example hook name: `woocommerce_gzd_return_shipment_get_dhl_label`
+ *
+ * @param boolean|ShipmentLabel $label The label instance.
+ * @param Shipment $shipment The current shipment instance.
+ *
+ * @since 3.0.6
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( "{$this->get_hook_prefix()}{$prefix}label", $label, $this );
+ }
+
+ /**
+ * Output label admin fields.
+ */
+ public function get_label_settings_html() {
+ $hook_prefix = $this->get_general_hook_prefix();
+ $html = '';
+
+ if ( $provider = $this->get_shipping_provider_instance() ) {
+ $hook_prefix = $hook_prefix . '_' . $provider->get_name();
+ $html = $provider->get_label_fields_html( $this );
+ }
+
+ /**
+ * Action for shipping providers to output available admin settings while creating a label.
+ *
+ * The dynamic portion of this hook, `$hook_prefix` is used to construct a
+ * unique hook for a shipment type. `$provider` is related to the current shipping provider
+ * for the shipment (slug).
+ *
+ * Example hook name: `woocommerce_gzd_return_shipment_print_dhl_label_admin_fields`
+ *
+ * @param Shipment $shipment The current shipment instance.
+ *
+ * @since 3.0.6
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( "{$hook_prefix}label_settings_html", $html, $this );
+ }
+
+ public function create_label( $props = false ) {
+ $hook_prefix = $this->get_general_hook_prefix();
+ $provider_name = '';
+ $error = new WP_Error();
+
+ /**
+ * Sanitize props
+ */
+ if ( is_array( $props ) ) {
+ foreach( $props as $key => $value ) {
+ $props[ $key ] = wc_clean( wp_unslash( $value ) );
+ }
+ }
+
+ if ( $provider = $this->get_shipping_provider_instance() ) {
+ $provider_name = $provider->get_name();
+ $result = $provider->create_label( $this, $props );
+
+ if ( is_wp_error( $result ) ) {
+ return $result;
+ }
+ } else {
+ /**
+ * Action for shipping providers to create the `ShipmentLabel` corresponding to a certain shipment.
+ *
+ * The dynamic portion of this hook, `$hook_prefix` is used to construct a
+ * unique hook for a shipment type. `$provider` is related to the current shipping provider
+ * for the shipment (slug).
+ *
+ * Example hook name: `woocommerce_gzd_return_shipment_create_dhl_label`
+ *
+ * @param array|false $props Array containing props extracted from post data (if created manually).
+ * @param WP_Error $error An WP_Error instance useful for returning errors while creating the label.
+ * @param Shipment $shipment The current shipment instance.
+ *
+ * @since 3.0.6
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( "{$hook_prefix}create_{$provider_name}label", $props, $error, $this );
+
+ if ( wc_gzd_shipment_wp_error_has_errors( $error ) ) {
+ return $error;
+ }
+ }
+
+ if ( $label = $this->get_label() ) {
+ $this->set_tracking_id( $label->get_number() );
+
+ /**
+ * Action for shipping providers to adjust the shipment before updating it after a label has
+ * been successfully generated.
+ *
+ * The dynamic portion of this hook, `$hook_prefix` is used to construct a
+ * unique hook for a shipment type. `$provider` is related to the current shipping provider
+ * for the shipment (slug).
+ *
+ * Example hook name: `woocommerce_gzd_return_shipment_created_dhl_label`
+ *
+ * @param Shipment $shipment The current shipment instance.
+ * @param array $props Array containing props extracted from post data (if created manually) and sanitized via `wc_clean`.
+ * @param array $raw_data Raw post data unsanitized.
+ *
+ * @since 3.1.2
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( "{$hook_prefix}created_{$provider_name}label", $this, $props );
+
+ do_action( "{$hook_prefix}created_label", $this, $props );
+
+ $this->save();
+ }
+
+ return true;
+ }
+
+ public function delete_label( $force = false ) {
+ if ( $this->supports_label() && ( $label = $this->get_label() ) ) {
+ $label->delete( $force );
+ $this->set_tracking_id( '' );
+ $this->save();
+
+ return true;
+ }
+
+ return false;
+ }
+
+ /**
+ * Whether or not the current shipments supports labels or not.
+ *
+ * @return bool
+ */
+ public function supports_label() {
+ if ( $provider = $this->get_shipping_provider_instance() ) {
+ if ( $provider->supports_labels( $this->get_type(), $this ) ) {
+ return true;
+ }
+ }
+
+ return false;
+ }
+
+ /**
+ * Whether or not the current shipments needs a label or not.
+ *
+ * @return bool
+ */
+ public function needs_label( $check_status = true ) {
+ $needs_label = true;
+ $provider = $this->get_shipping_provider();
+ $hook_prefix = $this->get_general_hook_prefix();
+
+ if ( ! empty( $provider ) ) {
+ $provider = $provider . '_';
+ }
+
+ if ( $this->has_label() ) {
+ $needs_label = false;
+ }
+
+ if ( ! $this->supports_label() ) {
+ $needs_label = false;
+ }
+
+ if ( $shipping_provider = $this->get_shipping_provider_instance() ) {
+ if ( ! $shipping_provider->is_activated() ) {
+ $needs_label = false;
+ }
+ }
+
+ // If shipment is already delivered
+ if ( $check_status && $this->has_status( array( 'delivered', 'shipped' ) ) ) {
+ $needs_label = false;
+ }
+
+ /**
+ * Filter for shipping providers to decide whether the shipment needs a label or not.
+ *
+ * The dynamic portion of this hook, `$hook_prefix` is used to construct a
+ * unique hook for a shipment type. `$provider` is related to the current shipping provider
+ * for the shipment (slug).
+ *
+ * Example hook name: `woocommerce_gzd_return_shipment_needs_dhl_label`
+ *
+ * @param boolean $needs_label Whether or not the shipment needs a label.
+ * @param boolean $check_status Whether or not checking the shipment status is needed.
+ * @param Shipment $shipment The current shipment instance.
+ *
+ * @since 3.0.6
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( "{$hook_prefix}needs_{$provider}label", $needs_label, $check_status, $this );
+ }
+
+ /**
+ * Whether or not the current shipment has a valid label or not.
+ *
+ * @return bool
+ */
+ public function has_label() {
+ $label = $this->get_label();
+
+ if ( $label && is_a( $label, '\Vendidero\Germanized\Shipments\Interfaces\ShipmentLabel' ) ) {
+ if ( 'return' === $label->get_type() ) {
+ if ( ! is_a( $label, '\Vendidero\Germanized\Shipments\Interfaces\ShipmentReturnLabel' ) ) {
+ return false;
+ }
+ }
+
+ return true;
+ } else {
+ return false;
+ }
+ }
+
+ public function get_label_download_url( $args = array() ) {
+ $download_url = '';
+ $provider = $this->get_shipping_provider();
+
+ if ( $label = $this->get_label() ) {
+ $download_url = $label->get_download_url( $args );
+ }
+
+ /**
+ * Filter for shipping providers to adjust the label download URL.
+ *
+ * The dynamic portion of this hook, `$this->get_hook_prefix()` is used to construct a
+ * unique hook for a shipment type. `$provider` is related to the current shipping provider
+ * for the shipment (slug).
+ *
+ * Example hook name: `woocommerce_gzd_return_shipment_get_dhl_label_download_url`
+ *
+ * @param string $url The download URL.
+ * @param Shipment $shipment The current shipment instance.
+ *
+ * @since 3.0.6
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( "{$this->get_hook_prefix()}{$provider}label_download_url", $download_url, $this );
+ }
+
+ public function add_note( $note, $added_by_user = false ) {
+ if ( $order = $this->get_order() ) {
+ if ( is_callable( array( $order, 'add_order_note' ) ) ) {
+ $order->add_order_note( $note, 0, $added_by_user );
+ }
+ }
+ }
+
+ /**
+ * Calculate totals based on contained items.
+ */
+ protected function calculate_totals() {
+ $total = 0;
+ $subtotal = 0;
+
+ foreach( $this->get_items() as $item ) {
+ $total += round( $item->get_total(), wc_get_price_decimals() );
+ $subtotal += round( $item->get_subtotal(), wc_get_price_decimals() );
+ }
+
+ $this->set_total( $total );
+
+ if ( empty( $subtotal ) ) {
+ $subtotal = $total;
+ }
+
+ $this->set_subtotal( $subtotal );
+ }
+
+ public function delete( $force_delete = false ) {
+ $this->delete_label( $force_delete );
+
+ return parent::delete( $force_delete );
+ }
+
+ /**
+ * Save data to the database.
+ *
+ * @return integer shipment id
+ */
+ public function save() {
+ try {
+ $this->calculate_totals();
+ $is_new = false;
+
+ if ( array_key_exists( 'packaging_id', $this->get_changes() ) || $this->is_editable() ) {
+ $this->update_packaging();
+ }
+
+ if ( $this->data_store ) {
+ // Trigger action before saving to the DB. Allows you to adjust object props before save.
+ do_action( 'woocommerce_before_' . $this->object_type . '_object_save', $this, $this->data_store );
+
+ if ( $this->get_id() ) {
+ $this->data_store->update( $this );
+ } else {
+ $this->data_store->create( $this );
+ $is_new = true;
+ }
+ }
+
+ $this->save_items();
+
+ /**
+ * Trigger action after saving shipment to the DB.
+ *
+ * @param Shipment $shipment The shipment object being saved.
+ * @param WC_Data_Store_WP $data_store THe data store persisting the data.
+ */
+ do_action( 'woocommerce_after_' . $this->object_type . '_object_save', $this, $this->data_store );
+
+ $hook_postfix = '';
+
+ if ( 'simple' !== $this->get_type() ) {
+ $hook_postfix = $this->get_type() . '_';
+ }
+
+ /**
+ * Trigger action after saving shipment to the DB.
+ *
+ * The dynamic portion of this hook, `$hook_postfix` is used to construct a
+ * unique hook for a shipment type.
+ *
+ * Example hook name: woocommerce_gzd_shipment_after_save
+ *
+ * @param Shipment $shipment The shipment object being saved.
+ * @param boolean $is_new Indicator to determine whether this is a new shipment or not.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( "woocommerce_gzd_{$hook_postfix}shipment_after_save", $this, $is_new );
+
+ $this->status_transition();
+ $this->reset_content_data();
+
+ } catch ( Exception $e ) {
+ $logger = wc_get_logger();
+ $logger->error(
+ sprintf( 'Error saving shipment #%d', $this->get_id() ), array(
+ 'shipment' => $this,
+ 'error' => $e,
+ )
+ );
+ }
+
+ return $this->get_id();
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/ShipmentFactory.php b/packages/woocommerce-germanized-shipments/src/ShipmentFactory.php
new file mode 100644
index 000000000..5c89d8a76
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/ShipmentFactory.php
@@ -0,0 +1,88 @@
+get_shipment_type( $shipment_id );
+
+ /**
+ * Shipment type cannot be found, seems to not exist.
+ */
+ if ( empty( $shipment_type ) ) {
+ return false;
+ }
+
+ $shipment_type_data = wc_gzd_get_shipment_type_data( $shipment_type );
+ } else {
+ $shipment_type_data = wc_gzd_get_shipment_type_data( $shipment_type );
+ }
+
+ if ( $shipment_type_data ) {
+ $classname = $shipment_type_data['class_name'];
+ } else {
+ $classname = false;
+ }
+
+ /**
+ * Filter to adjust the classname used to construct a Shipment.
+ *
+ * @param string $clasname The classname to be used.
+ * @param integer $shipment_id The shipment id.
+ * @param string $shipment_type The shipment type.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ $classname = apply_filters( 'woocommerce_gzd_shipment_class', $classname, $shipment_id, $shipment_type );
+
+ if ( ! class_exists( $classname ) ) {
+ return false;
+ }
+
+ try {
+ return new $classname( $shipment_id );
+ } catch ( Exception $e ) {
+ wc_caught_exception( $e, __FUNCTION__, func_get_args() );
+ return false;
+ }
+ }
+
+ public static function get_shipment_id( $shipment ) {
+ if ( is_numeric( $shipment ) ) {
+ return $shipment;
+ } elseif ( $shipment instanceof Shipment ) {
+ return $shipment->get_id();
+ } elseif ( ! empty( $shipment->shipment_id ) ) {
+ return $shipment->shipment_id;
+ } else {
+ return false;
+ }
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/ShipmentItem.php b/packages/woocommerce-germanized-shipments/src/ShipmentItem.php
new file mode 100644
index 000000000..b402ca9a6
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/ShipmentItem.php
@@ -0,0 +1,516 @@
+ 0,
+ 'order_item_id' => 0,
+ 'parent_id' => 0,
+ 'quantity' => 1,
+ 'product_id' => 0,
+ 'weight' => '',
+ 'width' => '',
+ 'length' => '',
+ 'height' => '',
+ 'sku' => '',
+ 'name' => '',
+ 'total' => 0,
+ 'subtotal' => 0,
+ );
+
+ /**
+ * Stores meta in cache for future reads.
+ * A group must be set to to enable caching.
+ *
+ * @var string
+ */
+ protected $cache_group = 'shipment-items';
+
+ /**
+ * Meta type. This should match up with
+ * the types available at https://developer.wordpress.org/reference/functions/add_metadata/.
+ * WP defines 'post', 'user', 'comment', and 'term'.
+ *
+ * @var string
+ */
+ protected $meta_type = 'shipment_item';
+
+ /**
+ * This is the name of this object type.
+ *
+ * @var string
+ */
+ protected $object_type = 'shipment_item';
+
+ /**
+ * Constructor.
+ *
+ * @param int|object|array $item ID to load from the DB, or WC_Order_Item object.
+ */
+ public function __construct( $item = 0 ) {
+ parent::__construct( $item );
+
+ if ( $item instanceof ShipmentItem ) {
+ $this->set_id( $item->get_id() );
+ } elseif ( is_numeric( $item ) && $item > 0 ) {
+ $this->set_id( $item );
+ } else {
+ $this->set_object_read( true );
+ }
+
+ $this->data_store = WC_Data_Store::load( 'shipment-item' );
+
+ // If we have an ID, load the user from the DB.
+ if ( $this->get_id() ) {
+ try {
+ $this->data_store->read( $this );
+ } catch ( Exception $e ) {
+ $this->set_id( 0 );
+ $this->set_object_read( true );
+ }
+ } else {
+ $this->set_object_read( true );
+ }
+ }
+
+ /**
+ * Merge changes with data and clear.
+ * Overrides WC_Data::apply_changes.
+ * array_replace_recursive does not work well for order items because it merges taxes instead
+ * of replacing them.
+ *
+ * @since 3.2.0
+ */
+ public function apply_changes() {
+ if ( function_exists( 'array_replace' ) ) {
+ $this->data = array_replace( $this->data, $this->changes ); // phpcs:ignore PHPCompatibility.FunctionUse.NewFunctions.array_replaceFound
+ } else { // PHP 5.2 compatibility.
+ foreach ( $this->changes as $key => $change ) {
+ $this->data[ $key ] = $change;
+ }
+ }
+ $this->changes = array();
+ }
+
+ /*
+ |--------------------------------------------------------------------------
+ | Getters
+ |--------------------------------------------------------------------------
+ */
+
+ public function get_type() {
+ return 'simple';
+ }
+
+ /**
+ * Get order ID this meta belongs to.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return int
+ */
+ public function get_shipment_id( $context = 'view' ) {
+ return $this->get_prop( 'shipment_id', $context );
+ }
+
+ /**
+ * Get order ID this meta belongs to.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return int
+ */
+ public function get_order_item_id( $context = 'view' ) {
+ return $this->get_prop( 'order_item_id', $context );
+ }
+
+ /**
+ * Get order ID this meta belongs to.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return int
+ */
+ public function get_product_id( $context = 'view' ) {
+ return $this->get_prop( 'product_id', $context );
+ }
+
+ /**
+ * Get item parent id.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return int
+ */
+ public function get_parent_id( $context = 'view' ) {
+ return $this->get_prop( 'parent_id', $context );
+ }
+
+ /**
+ * Get order ID this meta belongs to.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return int
+ */
+ public function get_total( $context = 'view' ) {
+ return $this->get_prop( 'total', $context );
+ }
+
+ /**
+ * Get order ID this meta belongs to.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return int
+ */
+ public function get_subtotal( $context = 'view' ) {
+ $subtotal = $this->get_prop( 'subtotal', $context );
+
+ if ( 'view' === $context && empty( $subtotal ) ) {
+ $subtotal = $this->get_total();
+ }
+
+ return $subtotal;
+ }
+
+ /**
+ * Get quantity.
+ *
+ * @return int
+ */
+ public function get_sku( $context = 'view' ) {
+ return $this->get_prop( 'sku', $context );
+ }
+
+ /**
+ * Get quantity.
+ *
+ * @return int
+ */
+ public function get_quantity( $context = 'view' ) {
+ return $this->get_prop( 'quantity', $context );
+ }
+
+ /**
+ * Get weight.
+ *
+ * @return string
+ */
+ public function get_weight( $context = 'view' ) {
+ return $this->get_prop( 'weight', $context );
+ }
+
+ /**
+ * Get width.
+ *
+ * @return string
+ */
+ public function get_width( $context = 'view' ) {
+ return $this->get_prop( 'width', $context );
+ }
+
+ /**
+ * Get length.
+ *
+ * @return string
+ */
+ public function get_length( $context = 'view' ) {
+ return $this->get_prop( 'length', $context );
+ }
+
+ /**
+ * Get height.
+ *
+ * @return string
+ */
+ public function get_height( $context = 'view' ) {
+ return $this->get_prop( 'height', $context );
+ }
+
+ public function get_name( $context = 'view' ) {
+
+ if ( 'view' === $context && ( $item = $this->get_order_item() ) ) {
+ return $item->get_name();
+ }
+
+ return $this->get_prop( 'name', $context );
+ }
+
+ /**
+ * Get parent order object.
+ *
+ * @return SimpleShipment|ReturnShipment|Shipment
+ */
+ public function get_shipment() {
+ if ( is_null( $this->shipment ) && 0 < $this->get_shipment_id() ) {
+ $this->shipment = wc_gzd_get_shipment( $this->get_shipment_id() );
+ }
+
+ $shipment = ( $this->shipment ) ? $this->shipment : false;
+
+ return $shipment;
+ }
+
+ /**
+ * Sets the linked shipment instance.
+ *
+ * @param Shipment $shipment
+ */
+ public function set_shipment( &$shipment ) {
+ $this->shipment = $shipment;
+ }
+
+ /**
+ * Syncs an item with either it's parent item or the corresponding order item.
+ *
+ * @param array $args
+ */
+ public function sync( $args = array() ) {
+ $item = false;
+
+ if ( $shipment = $this->get_shipment() ) {
+ if ( 'return' === $shipment->get_type() ) {
+ if ( $shipment = $this->get_shipment() ) {
+ if ( $order_shipment = $shipment->get_order_shipment() ) {
+ $item = $order_shipment->get_simple_shipment_item( $this->get_order_item_id() );
+ }
+ }
+ } else {
+ $item = $this->get_order_item();
+ }
+ }
+
+ if ( is_a( $item, '\Vendidero\Germanized\Shipments\ShipmentItem' ) ) {
+
+ $default_data = $item->get_data();
+
+ unset( $default_data['id'] );
+ unset( $default_data['shipment_id'] );
+
+ $default_data['parent_id'] = $item->get_id();
+ $args = wp_parse_args( $args, $default_data );
+
+ } elseif( is_a( $item, 'WC_Order_Item' ) ) {
+
+ if ( is_callable( array( $item, 'get_variation_id' ) ) && is_callable( array( $item, 'get_product_id' ) ) ) {
+ $this->set_product_id( $item->get_variation_id() ? $item->get_variation_id() : $item->get_product_id() );
+ } elseif( is_callable( array( $item, 'get_product_id' ) ) ) {
+ $this->set_product_id( $item->get_product_id() );
+ }
+
+ $product = $this->get_product();
+ $tax_total = is_callable( array( $item, 'get_total_tax' ) ) ? $item->get_total_tax() : 0;;
+ $total = is_callable( array( $item, 'get_total' ) ) ? $item->get_total() : 0;
+ $subtotal = is_callable( array( $item, 'get_subtotal' ) ) ? $item->get_subtotal() : 0;
+ $tax_subtotal = is_callable( array( $item, 'get_subtotal_tax' ) ) ? $item->get_subtotal_tax() : 0;
+
+ $args = wp_parse_args( $args, array(
+ 'order_item_id' => $item->get_id(),
+ 'quantity' => 1,
+ 'name' => $item->get_name(),
+ 'sku' => $product ? $product->get_sku() : '',
+ 'total' => $total + $tax_total,
+ 'subtotal' => $subtotal + $tax_subtotal,
+ 'weight' => $product ? wc_get_weight( $product->get_weight(), $shipment->get_weight_unit() ) : '',
+ 'length' => $product ? wc_get_dimension( $product->get_length(), $shipment->get_dimension_unit() ) : '',
+ 'width' => $product ? wc_get_dimension( $product->get_width(), $shipment->get_dimension_unit() ) : '',
+ 'height' => $product ? wc_get_dimension( $product->get_height(), $shipment->get_dimension_unit() ) : '',
+ ) );
+ }
+
+ $this->set_props( $args );
+
+ /**
+ * Action that fires after a shipment item has been synced. Syncing is used to
+ * keep the shipment item in sync with the corresponding order item or parent shipment item.
+ *
+ * @param WC_Order_Item|ShipmentItem $item The order item object or parent shipment item.
+ * @param array $args Array containing props in key => value pairs which have been updated.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( 'woocommerce_gzd_shipment_item_synced', $this, $item, $args );
+ }
+
+ public function get_order_item() {
+ if ( is_null( $this->order_item ) && 0 < $this->get_order_item_id() ) {
+ if ( $shipment = $this->get_shipment() ) {
+
+ if ( $order = $shipment->get_order() ) {
+ $this->order_item = $order->get_item( $this->get_order_item_id() );
+ }
+ }
+ }
+
+ $item = ( $this->order_item ) ? $this->order_item : false;
+
+ return $item;
+ }
+
+ public function get_product() {
+ if ( is_null( $this->product ) && 0 < $this->get_product_id() ) {
+ $this->product = wc_get_product( $this->get_product_id() );
+ }
+
+ $product = ( $this->product ) ? $this->product : false;
+
+ return $product;
+ }
+
+ /*
+ |--------------------------------------------------------------------------
+ | Setters
+ |--------------------------------------------------------------------------
+ */
+
+ /**
+ * Set order ID.
+ *
+ * @param int $value Order ID.
+ */
+ public function set_shipment_id( $value ) {
+ $this->order_item = null;
+ $this->shipment = null;
+
+ $this->set_prop( 'shipment_id', absint( $value ) );
+ }
+
+ /**
+ * Set order ID.
+ *
+ * @param int $value Order ID.
+ */
+ public function set_order_item_id( $value ) {
+ $this->set_prop( 'order_item_id', absint( $value ) );
+ }
+
+ /**
+ * Set order ID.
+ *
+ * @param int $value Order ID.
+ */
+ public function set_total( $value ) {
+ $value = wc_format_decimal( $value );
+
+ if ( ! is_numeric( $value ) ) {
+ $value = 0;
+ }
+
+ $this->set_prop( 'total', $value );
+ }
+
+ /**
+ * Set order ID.
+ *
+ * @param int $value Order ID.
+ */
+ public function set_subtotal( $value ) {
+ $value = wc_format_decimal( $value );
+
+ if ( ! is_numeric( $value ) ) {
+ $value = 0;
+ }
+
+ $this->set_prop( 'subtotal', $value );
+ }
+
+ /**
+ * Set order ID.
+ *
+ * @param int $value Order ID.
+ */
+ public function set_product_id( $value ) {
+ $this->product = null;
+ $this->set_prop( 'product_id', absint( $value ) );
+ }
+
+ /**
+ * Set parent id.
+ *
+ * @param int $value parent id.
+ */
+ public function set_parent_id( $value ) {
+ $this->set_prop( 'parent_id', absint( $value ) );
+ }
+
+ public function set_sku( $sku ) {
+ $this->set_prop( 'sku', $sku );
+ }
+
+ /**
+ * Set weight in kg
+ *
+ * @param $weight
+ */
+ public function set_weight( $weight ) {
+ $this->set_prop( 'weight', '' === $weight ? '' : wc_format_decimal( $weight ) );
+ }
+
+ /**
+ * Set width in cm
+ *
+ * @param $weight
+ */
+ public function set_width( $width ) {
+ $this->set_prop( 'width', '' === $width ? '' : wc_format_decimal( $width ) );
+ }
+
+ /**
+ * Set length in cm
+ *
+ * @param $weight
+ */
+ public function set_length( $length ) {
+ $this->set_prop( 'length', '' === $length ? '' : wc_format_decimal( $length ) );
+ }
+
+ /**
+ * Set height in cm
+ *
+ * @param $weight
+ */
+ public function set_height( $height ) {
+ $this->set_prop( 'height', '' === $height ? '' : wc_format_decimal( $height ) );
+ }
+
+ public function get_dimensions() {
+ return array(
+ 'length' => $this->get_length(),
+ 'width' => $this->get_width(),
+ 'height' => $this->get_height(),
+ );
+ }
+
+ public function set_quantity( $quantity ) {
+ $this->set_prop( 'quantity', absint( $quantity ) );
+ }
+
+ public function set_name( $name ) {
+ $this->set_prop( 'name', $name );
+ }
+
+ /*
+ |--------------------------------------------------------------------------
+ | Other Methods
+ |--------------------------------------------------------------------------
+ */
+}
diff --git a/packages/woocommerce-germanized-shipments/src/ShipmentQuery.php b/packages/woocommerce-germanized-shipments/src/ShipmentQuery.php
new file mode 100644
index 000000000..107de9f95
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/ShipmentQuery.php
@@ -0,0 +1,532 @@
+ array_keys( wc_gzd_get_shipment_statuses() ),
+ 'limit' => 10,
+ 'order_id' => '',
+ 'parent_id' => '',
+ 'type' => 'simple',
+ 'country' => '',
+ 'tracking_id' => '',
+ 'order' => 'DESC',
+ 'orderby' => 'date_created',
+ 'return' => 'objects',
+ 'page' => 1,
+ 'offset' => '',
+ 'paginate' => false,
+ 'search' => '',
+ 'search_columns' => array(),
+ );
+ }
+
+ /**
+ * Get shipments matching the current query vars.
+ *
+ * @return Shipment[] Array containing Shipments.
+ */
+ public function get_shipments() {
+ /**
+ * Filter to adjust query arguments passed to a Shipment query.
+ *
+ * @param array $args The arguments passed.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ $args = apply_filters( 'woocommerce_gzd_shipment_query_args', $this->get_query_vars() );
+ $args = WC_Data_Store::load( 'shipment' )->get_query_args( $args );
+
+ $this->query( $args );
+
+ /**
+ * Filter to adjust the Shipment query result.
+ *
+ * @param Shipment[] $results Shipment results.
+ * @param array $args The arguments passed.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipment_query', $this->results, $args );
+ }
+
+ public function get_total() {
+ return $this->total_shipments;
+ }
+
+ /**
+ * Query shipments.
+ *
+ * @param array $query_args
+ */
+ protected function query( $query_args ) {
+ global $wpdb;
+
+ $this->args = $query_args;
+ $this->parse_query();
+ $this->prepare_query();
+
+ $qv =& $this->args;
+
+ $this->results = null;
+
+ if ( null === $this->results ) {
+ $this->request = "SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit";
+
+ if ( is_array( $qv['fields'] ) || 'objects' == $qv['fields'] ) {
+ $this->results = $wpdb->get_results( $this->request );
+ } else {
+ $this->results = $wpdb->get_col( $this->request );
+ }
+
+ if ( isset( $qv['count_total'] ) && $qv['count_total'] ) {
+ $found_shipments_query = 'SELECT FOUND_ROWS()';
+ $this->total_shipments = (int) $wpdb->get_var( $found_shipments_query );
+ }
+ }
+
+ if ( ! $this->results ) {
+ return;
+ }
+
+ if ( 'objects' == $qv['fields'] ) {
+ foreach ( $this->results as $key => $shipment ) {
+ $this->results[ $key ] = wc_gzd_get_shipment( $shipment );
+ }
+ }
+ }
+
+ /**
+ * Parse the query before preparing it.
+ */
+ protected function parse_query() {
+
+ if ( isset( $this->args['order_id'] ) ) {
+ $this->args['order_id'] = absint( $this->args['order_id'] );
+ }
+
+ if ( isset( $this->args['parent_id'] ) ) {
+ $this->args['parent_id'] = absint( $this->args['parent_id'] );
+ }
+
+ if ( isset( $this->args['tracking_id'] ) ) {
+ $this->args['tracking_id'] = sanitize_key( $this->args['tracking_id'] );
+ }
+
+ if ( isset( $this->args['status'] ) ) {
+ $this->args['status'] = (array) $this->args['status'];
+ $this->args['status'] = array_map( 'sanitize_key', $this->args['status'] );
+ }
+
+ if ( isset( $this->args['type'] ) ) {
+ $this->args['type'] = (array) $this->args['type'];
+ $this->args['type'] = array_map( 'wc_clean', $this->args['type'] );
+ }
+
+ if ( isset( $this->args['country'] ) ) {
+ $countries = isset( WC()->countries ) ? WC()->countries : false;
+
+ if ( $countries && is_a( $countries, 'WC_Countries' ) ) {
+
+ // Reverse search by country name
+ if ( $key = array_search( $this->args['country'], $countries->get_countries() ) ) {
+ $this->args['country'] = $key;
+ }
+ }
+
+ // Country Code ISO
+ $this->args['country'] = strtoupper( substr( $this->args['country'], 0, 2 ) );
+ }
+
+ if ( isset( $this->args['search'] ) ) {
+ $this->args['search'] = wc_clean( $this->args['search'] );
+
+ if ( ! isset( $this->args['search_columns'] ) ) {
+ $this->args['search_columns'] = array();
+ }
+ }
+
+ if ( isset( $this->args['orderby'] ) ) {
+ if ( 'weight' === $this->args['orderby'] ) {
+ $this->args['meta_query'][] = array(
+ 'relation' => 'OR',
+ array(
+ 'key' => '_weight',
+ 'compare' => 'NOT EXISTS',
+ ),
+ array(
+ 'key' => '_weight',
+ 'compare' => '>=',
+ 'value' => 0,
+ ),
+ );
+
+ $this->args['orderby'] = 'meta_value_num';
+ }
+ }
+ }
+
+ /**
+ * Prepare the query for DB usage.
+ */
+ protected function prepare_query() {
+ global $wpdb;
+
+ if ( is_array( $this->args['fields'] ) ) {
+ $this->args['fields'] = array_unique( $this->args['fields'] );
+
+ $this->query_fields = array();
+
+ foreach ( $this->args['fields'] as $field ) {
+ $field = 'ID' === $field ? 'shipment_id' : sanitize_key( $field );
+ $this->query_fields[] = "$wpdb->gzd_shipments.$field";
+ }
+
+ $this->query_fields = implode( ',', $this->query_fields );
+
+ } elseif ( 'objects' == $this->args['fields'] ) {
+ $this->query_fields = "$wpdb->gzd_shipments.*";
+ } else {
+ $this->query_fields = "$wpdb->gzd_shipments.shipment_id";
+ }
+
+ if ( isset( $this->args['count_total'] ) && $this->args['count_total'] ) {
+ $this->query_fields = 'SQL_CALC_FOUND_ROWS ' . $this->query_fields;
+ }
+
+ $this->query_from = "FROM $wpdb->gzd_shipments";
+ $this->query_where = 'WHERE 1=1';
+
+ // order id
+ if ( isset( $this->args['order_id'] ) ) {
+ $this->query_where .= $wpdb->prepare( ' AND shipment_order_id = %d', $this->args['order_id'] );
+ }
+
+ // tracking id
+ if ( isset( $this->args['tracking_id'] ) ) {
+ $this->query_where .= $wpdb->prepare( " AND shipment_tracking_id IN ('%s')", $this->args['tracking_id'] );
+ }
+
+ // parent id
+ if ( isset( $this->args['parent_id'] ) ) {
+ $this->query_where .= $wpdb->prepare( " AND shipment_parent_id = %d", $this->args['parent_id'] );
+ }
+
+ // country
+ if ( isset( $this->args['country'] ) ) {
+ $this->query_where .= $wpdb->prepare( " AND shipment_country IN ('%s')", $this->args['country'] );
+ }
+
+ // type
+ if ( isset( $this->args['type'] ) ) {
+ $types = $this->args['type'];
+ $p_types = array();
+
+ foreach( $types as $type ) {
+ $p_types[] = $wpdb->prepare( "shipment_type = '%s'", $type );
+ }
+
+ $where_type = implode( ' OR ', $p_types );
+
+ if ( ! empty( $where_type ) ) {
+ $this->query_where .= " AND ($where_type)";
+ }
+ }
+
+ // status
+ if ( isset( $this->args['status'] ) ) {
+ $stati = $this->args['status'];
+ $p_status = array();
+
+ foreach( $stati as $status ) {
+ $p_status[] = $wpdb->prepare( "shipment_status = '%s'", $status );
+ }
+
+ $where_status = implode( ' OR ', $p_status );
+
+ if ( ! empty( $where_status ) ) {
+ $this->query_where .= " AND ($where_status)";
+ }
+ }
+
+ // Search
+ $search = '';
+
+ if ( isset( $this->args['search'] ) ) {
+ $search = trim( $this->args['search'] );
+ }
+
+ if ( $search ) {
+
+ $leading_wild = ( ltrim( $search, '*' ) != $search );
+ $trailing_wild = ( rtrim( $search, '*' ) != $search );
+
+ if ( $leading_wild && $trailing_wild ) {
+ $wild = 'both';
+ } elseif ( $leading_wild ) {
+ $wild = 'leading';
+ } elseif ( $trailing_wild ) {
+ $wild = 'trailing';
+ } else {
+ $wild = false;
+ }
+ if ( $wild ) {
+ $search = trim( $search, '*' );
+ }
+
+ $search_columns = array();
+
+ if ( $this->args['search_columns'] ) {
+ $search_columns = array_intersect( $this->args['search_columns'], array( 'shipment_id', 'shipment_country', 'shipment_tracking_id', 'shipment_order_id', 'shipment_shipping_provider', 'shipment_shipping_method', 'shipment_search_index' ) );
+ }
+
+ if ( ! $search_columns ) {
+ if ( is_numeric( $search ) ) {
+ $search_columns = array( 'shipment_id', 'shipment_order_id' );
+ } elseif ( strlen( $search ) === 2 ) {
+ $search_columns = array( 'shipment_country' );
+ } else {
+ $search_columns = array( 'shipment_id', 'shipment_country', 'shipment_tracking_id', 'shipment_order_id', 'shipment_search_index' );
+ }
+ }
+
+ /**
+ * Filters the columns to search in a ShipmentQuery search.
+ *
+ * The default columns depend on the search term, and include 'shipment_id', 'shipment_country',
+ * 'shipment_tracking_id', 'shipment_order_id', 'shipment_shipping_provider' and 'shipment_shipping_method'.
+ *
+ * @since 3.0.0
+ *
+ * @param string[] $search_columns Array of column names to be searched.
+ * @param string $search Text being searched.
+ * @param ShipmentQuery $this The current ShipmentQuery instance.
+ *
+ * @package Vendidero/Germanized/Shipments
+ */
+ $search_columns = apply_filters( 'woocommerce_gzd_shipment_search_columns', $search_columns, $search, $this );
+
+ $this->query_where .= $this->get_search_sql( $search, $search_columns, $wild );
+ }
+
+ // Parse and sanitize 'include', for use by 'orderby' as well as 'include' below.
+ if ( ! empty( $this->args['include'] ) ) {
+ $include = wp_parse_id_list( $this->args['include'] );
+ } else {
+ $include = false;
+ }
+
+ // Meta query.
+ $this->meta_query = new WP_Meta_Query();
+ $this->meta_query->parse_query_vars( $this->args );
+
+ if ( ! empty( $this->meta_query->queries ) ) {
+ $clauses = $this->meta_query->get_sql( 'gzd_shipment', $wpdb->gzd_shipments, 'shipment_id', $this );
+ $this->query_from .= $clauses['join'];
+ $this->query_where .= $clauses['where'];
+
+ if ( $this->meta_query->has_or_relation() ) {
+ $this->query_fields = 'DISTINCT ' . $this->query_fields;
+ }
+ }
+
+ // sorting
+ $this->args['order'] = isset( $this->args['order'] ) ? strtoupper( $this->args['order'] ) : '';
+ $order = $this->parse_order( $this->args['order'] );
+
+ if ( empty( $this->args['orderby'] ) ) {
+ // Default order is by 'user_login'.
+ $ordersby = array( 'date_created' => $order );
+ } elseif ( is_array( $this->args['orderby'] ) ) {
+ $ordersby = $this->args['orderby'];
+ } else {
+ // 'orderby' values may be a comma- or space-separated list.
+ $ordersby = preg_split( '/[,\s]+/', $this->args['orderby'] );
+ }
+
+ $orderby_array = array();
+
+ foreach ( $ordersby as $_key => $_value ) {
+ if ( ! $_value ) {
+ continue;
+ }
+
+ if ( is_int( $_key ) ) {
+ // Integer key means this is a flat array of 'orderby' fields.
+ $_orderby = $_value;
+ $_order = $order;
+ } else {
+ // Non-integer key means this the key is the field and the value is ASC/DESC.
+ $_orderby = $_key;
+ $_order = $_value;
+ }
+
+ $parsed = $this->parse_orderby( $_orderby );
+
+ if ( ! $parsed ) {
+ continue;
+ }
+
+ $orderby_array[] = $parsed . ' ' . $this->parse_order( $_order );
+ }
+
+ // If no valid clauses were found, order by user_login.
+ if ( empty( $orderby_array ) ) {
+ $orderby_array[] = "shipment_id $order";
+ }
+
+ $this->query_orderby = 'ORDER BY ' . implode( ', ', $orderby_array );
+
+ // limit
+ if ( isset( $this->args['posts_per_page'] ) && $this->args['posts_per_page'] > 0 ) {
+ if ( isset( $this->args['offset'] ) ) {
+ $this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $this->args['offset'], $this->args['posts_per_page'] );
+ } else {
+ $this->query_limit = $wpdb->prepare( 'LIMIT %d, %d', $this->args['posts_per_page'] * ( $this->args['page'] - 1 ), $this->args['posts_per_page'] );
+ }
+ }
+
+ if ( ! empty( $include ) ) {
+ // Sanitized earlier.
+ $ids = implode( ',', $include );
+ $this->query_where .= " AND $wpdb->gzd_shipments.shipment_id IN ($ids)";
+ } elseif ( ! empty( $this->args['exclude'] ) ) {
+ $ids = implode( ',', wp_parse_id_list( $this->args['exclude'] ) );
+ $this->query_where .= " AND $wpdb->gzd_shipments.shipment_id NOT IN ($ids)";
+ }
+
+ // Date queries are allowed for the user_registered field.
+ if ( ! empty( $this->args['date_query'] ) && is_array( $this->args['date_query'] ) ) {
+ $date_query = new WP_Date_Query( $this->args['date_query'], 'shipment_date_created' );
+ $this->query_where .= $date_query->get_sql();
+ }
+ }
+
+ /**
+ * Used internally to generate an SQL string for searching across multiple columns
+ *
+ * @since 3.0.6
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param string $string
+ * @param array $cols
+ * @param bool $wild Whether to allow wildcard searches. Default is false for Network Admin, true for single site.
+ * Single site allows leading and trailing wildcards, Network Admin only trailing.
+ * @return string
+ */
+ protected function get_search_sql( $string, $cols, $wild = false ) {
+ global $wpdb;
+
+ $searches = array();
+ $leading_wild = ( 'leading' == $wild || 'both' == $wild ) ? '%' : '';
+ $trailing_wild = ( 'trailing' == $wild || 'both' == $wild ) ? '%' : '';
+ $like = $leading_wild . $wpdb->esc_like( $string ) . $trailing_wild;
+
+ foreach ( $cols as $col ) {
+ if ( 'ID' == $col ) {
+ $searches[] = $wpdb->prepare( "$col = %s", $string );
+ } else {
+ $searches[] = $wpdb->prepare( "$col LIKE %s", $like );
+ }
+ }
+
+ return ' AND (' . implode( ' OR ', $searches ) . ')';
+ }
+
+ /**
+ * Parse orderby statement.
+ *
+ * @param string $orderby
+ * @return string
+ */
+ protected function parse_orderby( $orderby ) {
+ global $wpdb;
+
+ $meta_query_clauses = $this->meta_query->get_clauses();
+ $_orderby = '';
+
+ if ( in_array( $orderby, array( 'country', 'status', 'tracking_id', 'date_created', 'order_id' ) ) ) {
+ $_orderby = 'shipment_' . $orderby;
+ } elseif( 'date' == $orderby ) {
+ $_orderby = 'shipment_date_created';
+ } elseif ( 'ID' == $orderby || 'id' == $orderby ) {
+ $_orderby = 'shipment_id';
+ } elseif ( 'meta_value' == $orderby || $this->get( 'meta_key' ) == $orderby ) {
+ $_orderby = "$wpdb->gzd_shipmentmeta.meta_value";
+ } elseif ( 'meta_value_num' == $orderby ) {
+ $_orderby = "$wpdb->gzd_shipmentmeta.meta_value+0";
+ } elseif ( 'include' === $orderby && ! empty( $this->args['include'] ) ) {
+ $include = wp_parse_id_list( $this->args['include'] );
+ $include_sql = implode( ',', $include );
+ $_orderby = "FIELD( $wpdb->gzd_shipments.shipment_id, $include_sql )";
+ } elseif ( isset( $meta_query_clauses[ $orderby ] ) ) {
+ $meta_clause = $meta_query_clauses[ $orderby ];
+ $_orderby = sprintf( 'CAST(%s.meta_value AS %s)', esc_sql( $meta_clause['alias'] ), esc_sql( $meta_clause['cast'] ) );
+ }
+
+ return $_orderby;
+ }
+
+ /**
+ * Parse order statement.
+ *
+ * @param string $order
+ * @return string
+ */
+ protected function parse_order( $order ) {
+ if ( ! is_string( $order ) || empty( $order ) ) {
+ return 'DESC';
+ }
+
+ if ( 'ASC' === strtoupper( $order ) ) {
+ return 'ASC';
+ } else {
+ return 'DESC';
+ }
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/ShipmentReturnItem.php b/packages/woocommerce-germanized-shipments/src/ShipmentReturnItem.php
new file mode 100644
index 000000000..be8184518
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/ShipmentReturnItem.php
@@ -0,0 +1,31 @@
+ '',
+ );
+
+ public function get_type() {
+ return 'return';
+ }
+
+ public function get_return_reason_code( $context = 'view' ) {
+ return $this->get_prop( 'return_reason_code', $context );
+ }
+
+ public function set_return_reason_code( $code ) {
+ $this->set_prop( 'return_reason_code', $code );
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/ShippingProvider/Auto.php b/packages/woocommerce-germanized-shipments/src/ShippingProvider/Auto.php
new file mode 100644
index 000000000..dfd69b951
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/ShippingProvider/Auto.php
@@ -0,0 +1,508 @@
+ 2,
+ 'label_minimum_shipment_weight' => 0.5,
+ 'label_auto_enable' => false,
+ 'label_auto_shipment_status' => 'gzd-processing',
+ 'label_return_auto_enable' => false,
+ 'label_return_auto_shipment_status' => 'gzd-processing',
+ 'label_auto_shipment_status_shipped' => false,
+ );
+
+ public function get_label_default_shipment_weight( $context = 'view' ) {
+ return $this->get_prop( 'label_default_shipment_weight', $context );
+ }
+
+ public function get_label_minimum_shipment_weight( $context = 'view' ) {
+ return $this->get_prop( 'label_minimum_shipment_weight', $context );
+ }
+
+ /**
+ * @param false|Shipment $shipment
+ *
+ * @return boolean
+ */
+ public function automatically_generate_label( $shipment = false ) {
+ $setting_key = 'label_auto_enable';
+
+ if ( $shipment ) {
+ if ( 'return' === $shipment->get_type() ) {
+ $setting_key = 'label_return_auto_enable';
+ }
+
+ return wc_string_to_bool( $this->get_shipment_setting( $shipment, $setting_key, false ) );
+ } else {
+ return wc_string_to_bool( $this->get_setting( $setting_key, false ) );
+ }
+ }
+
+ /**
+ * @param false|Shipment $shipment
+ *
+ * @return string
+ */
+ public function get_label_automation_shipment_status( $shipment = false ) {
+ $setting_key = 'label_auto_shipment_status';
+
+ if ( $shipment ) {
+ if ( 'return' === $shipment->get_type() ) {
+ $setting_key = 'label_return_auto_shipment_status';
+ }
+
+ return $this->get_shipment_setting( $shipment, $setting_key, 'gzd-processing' );
+ } else {
+ return $this->get_setting( $setting_key, 'gzd-processing' );
+ }
+ }
+
+ public function automatically_set_shipment_status_shipped( $shipment = false ) {
+ $setting_key = 'label_auto_shipment_status_shipped';
+
+ if ( $shipment ) {
+ return wc_string_to_bool( $this->get_shipment_setting( $shipment, $setting_key, false ) );
+ } else {
+ return wc_string_to_bool( $this->get_setting( $setting_key, false ) );
+ }
+ }
+
+ public function get_label_auto_enable( $context = 'view' ) {
+ return $this->get_prop( 'label_auto_enable', $context );
+ }
+
+ public function get_label_auto_shipment_status_shipped( $context = 'view' ) {
+ return $this->get_prop( 'label_auto_shipment_status_shipped', $context );
+ }
+
+ public function get_label_auto_shipment_status( $context = 'view' ) {
+ return $this->get_prop( 'label_auto_shipment_status', $context );
+ }
+
+ public function automatically_generate_return_label() {
+ return $this->get_label_return_auto_enable();
+ }
+
+ public function get_label_return_auto_enable( $context = 'view' ) {
+ return $this->get_prop( 'label_return_auto_enable', $context );
+ }
+
+ public function get_label_return_auto_shipment_status( $context = 'view' ) {
+ return $this->get_prop( 'label_return_auto_shipment_status', $context );
+ }
+
+ public function is_sandbox() {
+ return false;
+ }
+
+ public function set_label_default_shipment_weight( $weight ) {
+ $this->set_prop( 'label_default_shipment_weight', ( '' === $weight ? 0 : wc_format_decimal( $weight ) ) );
+ }
+
+ public function set_label_minimum_shipment_weight( $weight ) {
+ $this->set_prop( 'label_minimum_shipment_weight', ( '' === $weight ? 0 : wc_format_decimal( $weight ) ) );
+ }
+
+ public function set_label_auto_enable( $enable ) {
+ $this->set_prop( 'label_auto_enable', wc_string_to_bool( $enable ) );
+ }
+
+ public function set_label_auto_shipment_status_shipped( $enable ) {
+ $this->set_prop( 'label_auto_shipment_status_shipped', wc_string_to_bool( $enable ) );
+ }
+
+ public function set_label_auto_shipment_status( $status ) {
+ $this->set_prop( 'label_auto_shipment_status',$status );
+ }
+
+ public function set_label_return_auto_enable( $enable ) {
+ $this->set_prop( 'label_return_auto_enable', wc_string_to_bool( $enable ) );
+ }
+
+ public function set_label_return_auto_shipment_status( $status ) {
+ $this->set_prop( 'label_return_auto_shipment_status',$status );
+ }
+
+ public function get_label_classname( $type ) {
+ return '\Vendidero\Germanized\Shipments\Labels\Simple';
+ }
+
+ /**
+ * Whether or not this instance is a manual integration.
+ * Manual integrations are constructed dynamically from DB and do not support
+ * automatic shipment handling, e.g. label creation.
+ *
+ * @return bool
+ */
+ public function is_manual_integration() {
+ return false;
+ }
+
+ /**
+ * Whether or not this instance supports a certain label type.
+ *
+ * @param string $label_type The label type e.g. simple or return.
+ *
+ * @return bool
+ */
+ public function supports_labels( $label_type, $shipment = false ) {
+ return true;
+ }
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment
+ *
+ * @return mixed|void
+ */
+ public function get_label( $shipment ) {
+ $type = wc_gzd_get_label_type_by_shipment( $shipment );
+ $label = wc_gzd_get_label_by_shipment( $shipment, $type );
+
+ return apply_filters( "{$this->get_hook_prefix()}label", $label, $shipment, $this );
+ }
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment
+ */
+ public function get_label_fields_html( $shipment ) {
+ /**
+ * Setup local variables
+ */
+ $settings = $this->get_label_fields( $shipment );
+ $provider = $this;
+
+ if ( is_wp_error( $settings ) ) {
+ $error = $settings;
+
+ ob_start();
+ include( Package::get_path() . '/includes/admin/views/label/html-shipment-label-backbone-error.php' );
+ $html = ob_get_clean();
+ } else {
+ ob_start();
+ include( Package::get_path() . '/includes/admin/views/label/html-shipment-label-backbone-form.php' );
+ $html = ob_get_clean();
+ }
+
+ return apply_filters( "{$this->get_hook_prefix()}label_fields_html", $html, $shipment, $this );
+ }
+
+ protected function get_automation_settings() {
+ $settings = array(
+ array( 'title' => _x( 'Automation', 'shipments', 'woocommerce-germanized' ), 'allow_override' => true, 'type' => 'title', 'id' => 'shipping_provider_label_auto_options' ),
+ );
+
+ $shipment_statuses = array_diff_key( wc_gzd_get_shipment_statuses(), array_fill_keys( array( 'gzd-draft', 'gzd-delivered', 'gzd-returned', 'gzd-requested' ), '' ) );
+
+ $settings = array_merge( $settings, array(
+ array(
+ 'title' => _x( 'Labels', 'shipments', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Automatically create labels for shipments.', 'shipments', 'woocommerce-germanized' ),
+ 'id' => 'label_auto_enable',
+ 'type' => 'gzd_toggle',
+ 'value' => wc_bool_to_string( $this->get_setting( 'label_auto_enable' ) )
+ ),
+
+ array(
+ 'title' => _x( 'Status', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'select',
+ 'id' => 'label_auto_shipment_status',
+ 'desc' => '' . _x( 'Choose a shipment status which should trigger generation of a label.', 'shipments', 'woocommerce-germanized' ) . ' ' . ( 'yes' === Package::get_setting( 'auto_enable' ) ? sprintf( _x( 'Your current default shipment status is: %s.', 'shipments', 'woocommerce-germanized' ), wc_gzd_get_shipment_status_name( Package::get_setting( 'auto_default_status' ) ) ) : '' ) . '
',
+ 'options' => $shipment_statuses,
+ 'class' => 'wc-enhanced-select',
+ 'custom_attributes' => array( 'data-show_if_label_auto_enable' => '' ),
+ 'value' => $this->get_setting( 'label_auto_shipment_status' ),
+ ),
+
+ array(
+ 'title' => _x( 'Shipment Status', 'shipments', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Mark shipment as shipped after label has been created successfully.', 'shipments', 'woocommerce-germanized' ),
+ 'id' => 'label_auto_shipment_status_shipped',
+ 'type' => 'gzd_toggle',
+ 'custom_attributes' => array( 'data-show_if_label_auto_enable' => '' ),
+ 'value' => wc_bool_to_string( $this->get_setting( 'label_auto_shipment_status_shipped' ) ),
+ ),
+ ) );
+
+ if ( $this->supports_labels( 'return' ) ) {
+ $settings = array_merge( $settings, array(
+ array(
+ 'title' => _x( 'Returns', 'shipments', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Automatically create labels for returns.', 'shipments', 'woocommerce-germanized' ),
+ 'id' => 'label_return_auto_enable',
+ 'type' => 'gzd_toggle',
+ 'value' => wc_bool_to_string( $this->get_setting( 'label_return_auto_enable' ) ),
+ ),
+
+ array(
+ 'title' => _x( 'Status', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'select',
+ 'id' => 'label_return_auto_shipment_status',
+ 'desc' => '' . _x( 'Choose a shipment status which should trigger generation of a return label.', 'shipments', 'woocommerce-germanized' ) . '
',
+ 'options' => $shipment_statuses,
+ 'class' => 'wc-enhanced-select',
+ 'custom_attributes' => array( 'data-show_if_label_return_auto_enable' => '' ),
+ 'value' => $this->get_setting( 'label_return_auto_shipment_status' ),
+ )
+ ) );
+ }
+
+ $settings = array_merge( $settings, array(
+ array( 'type' => 'sectionend', 'id' => 'shipping_provider_label_auto_options' ),
+ ) );
+
+ return $settings;
+ }
+
+ public function get_settings_help_pointers( $section = '' ) {
+ return array();
+ }
+
+ protected function get_label_settings() {
+ $settings = array(
+ array( 'title' => '', 'type' => 'title', 'id' => 'shipping_provider_label_options' ),
+
+ array(
+ 'title' => _x( 'Default content weight (kg)', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'desc' => _x( 'Choose a default shipment content weight to be used for labels if no weight has been applied to the shipment.', 'shipments', 'woocommerce-germanized' ),
+ 'desc_tip' => true,
+ 'id' => 'label_default_shipment_weight',
+ 'css' => 'max-width: 60px;',
+ 'class' => 'wc_input_decimal',
+ 'value' => $this->get_setting( 'label_default_shipment_weight' )
+ ),
+
+ array(
+ 'title' => _x( 'Minimum weight (kg)', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'desc' => _x( 'Choose a minimum weight to be used for labels e.g. to prevent low shipment weight errors.', 'shipments', 'woocommerce-germanized' ),
+ 'desc_tip' => true,
+ 'id' => 'label_minimum_shipment_weight',
+ 'css' => 'max-width: 60px;',
+ 'class' => 'wc_input_decimal',
+ 'value' => $this->get_setting( 'label_minimum_shipment_weight' )
+ ),
+
+ array( 'type' => 'sectionend', 'id' => 'shipping_provider_label_options' ),
+ );
+
+ return $settings;
+ }
+
+ protected function get_available_base_countries() {
+ $countries = array();
+
+ if ( function_exists( 'WC' ) && WC()->countries ) {
+ $countries = WC()->countries->get_countries();
+ }
+
+ return $countries;
+ }
+
+ public function get_setting_sections() {
+ $sections = array(
+ '' => _x( 'General', 'shipments', 'woocommerce-germanized' ),
+ 'label' => _x( 'Labels', 'shipments', 'woocommerce-germanized' ),
+ 'automation' => _x( 'Automation', 'shipments', 'woocommerce-germanized' ),
+ );
+
+ $sections = array_replace_recursive( $sections, parent::get_setting_sections() );
+
+ return $sections;
+ }
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment
+ */
+ public function get_label_fields( $shipment ) {
+ if ( 'return' === $shipment->get_type() ) {
+ return $this->get_return_label_fields( $shipment );
+ } else {
+ return $this->get_simple_label_fields( $shipment );
+ }
+ }
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment
+ */
+ protected function get_simple_label_fields( $shipment ) {
+ $default = $this->get_default_label_product( $shipment );
+ $available = $this->get_available_label_products( $shipment );
+
+ $settings = array(
+ array(
+ 'id' => 'product_id',
+ 'label' => sprintf( _x( '%s Product', 'shipments', 'woocommerce-germanized' ), $this->get_title() ),
+ 'description' => '',
+ 'options' => $this->get_available_label_products( $shipment ),
+ 'value' => $default && array_key_exists( $default, $available ) ? $default : '',
+ 'type' => 'select'
+ )
+ );
+
+ return $settings;
+ }
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment
+ */
+ protected function get_return_label_fields( $shipment ) {
+ return $this->get_simple_label_fields( $shipment );
+ }
+
+ /**
+ * @param Shipment $shipment
+ * @param $props
+ *
+ * @return \WP_Error|mixed
+ */
+ protected function validate_label_request( $shipment, $props ) {
+ return $props;
+ }
+
+ /**
+ * @param Shipment $shipment
+ *
+ * @return array
+ */
+ protected function get_default_label_props( $shipment ) {
+ $default = array(
+ 'shipping_provider' => $this->get_name(),
+ 'weight' => wc_gzd_get_shipment_label_weight( $shipment ),
+ 'net_weight' => wc_gzd_get_shipment_label_weight( $shipment, true ),
+ 'shipment_id' => $shipment->get_id(),
+ 'services' => array(),
+ 'product_id' => $this->get_default_label_product( $shipment )
+ );
+
+ $dimensions = wc_gzd_get_shipment_label_dimensions( $shipment );
+ $default = array_merge( $default, $dimensions );
+
+ return $default;
+ }
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment
+ * @param mixed $props
+ */
+ public function create_label( $shipment, $props = false ) {
+ /**
+ * In case props is false this indicates an automatic (non-manual) request.
+ */
+ if ( false === $props ) {
+ $props = $this->get_default_label_props( $shipment );
+ } elseif ( is_array( $props ) ) {
+ $fields = $this->get_label_fields( $shipment );
+
+ /**
+ * By default checkbox fields won't be transmitted via POST data.
+ * In case the values does not exist within props, assume not checked.
+ */
+ foreach( $fields as $field ) {
+ if ( ! isset( $field['value'] ) ) {
+ continue;
+ }
+
+ if ( 'checkbox' === $field['type'] && ! isset( $props[ $field['id'] ] ) ) {
+ $props[ $field['id'] ] = 'no';
+ }
+ }
+
+ /**
+ * Merge with default data. That needs to be done after manually
+ * parsing checkboxes as missing data would be overridden with defaults.
+ */
+ $props = wp_parse_args( $props, $this->get_default_label_props( $shipment ) );
+
+ foreach( $props as $key => $value ) {
+ if ( substr( $key, 0, strlen( 'service_' ) ) === 'service_' ) {
+ $new_key = substr( $key, ( strlen( 'service_' ) ) );
+
+ if ( wc_string_to_bool( $value ) && in_array( $new_key, $this->get_available_label_services( $shipment ) ) ) {
+ if ( ! in_array( $new_key, $props['services'] ) ) {
+ $props['services'][] = $new_key;
+ }
+ unset( $props[ $key ] );
+ } else {
+ if ( ( $service_key = array_search( $new_key, $props['services'] ) ) !== false ) {
+ unset( $props['services'][ $service_key ] );
+ }
+ unset( $props[ $key ] );
+ }
+ }
+ }
+ }
+
+ $props = $this->validate_label_request( $shipment, $props );
+
+ if ( is_wp_error( $props ) ) {
+ return $props;
+ }
+
+ if ( isset( $props['services'] ) ) {
+ $props['services'] = array_unique( $props['services'] );
+ }
+
+ $label = Factory::get_label( 0, $this->get_name(), $shipment->get_type() );
+
+ if ( $label ) {
+ foreach( $props as $key => $value ) {
+ $setter = "set_{$key}";
+
+ if ( is_callable( array( $label, $setter ) ) ) {
+ $label->{$setter}( $value );
+ } else {
+ $label->update_meta_data( $key, $value );
+ }
+ }
+
+ $label->set_shipment( $shipment );
+
+ /**
+ * Fetch the label via API and store as file
+ */
+ $result = $label->fetch();
+
+ if ( is_wp_error( $result ) ) {
+ return $result;
+ } else {
+ do_action( "{$this->get_general_hook_prefix()}created_label", $label, $this );
+
+ return $label->save();
+ }
+ }
+
+ return new \WP_Error( 'label-error', _x( 'Error while creating the label.', 'shipments', 'woocommerce-germanized' ) );
+ }
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment
+ */
+ public function get_available_label_services( $shipment ) {
+ return array();
+ }
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment
+ */
+ abstract public function get_available_label_products( $shipment );
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment
+ */
+ abstract public function get_default_label_product( $shipment );
+}
diff --git a/packages/woocommerce-germanized-shipments/src/ShippingProvider/Helper.php b/packages/woocommerce-germanized-shipments/src/ShippingProvider/Helper.php
new file mode 100644
index 000000000..5a7065dd1
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/ShippingProvider/Helper.php
@@ -0,0 +1,190 @@
+get_shipping_provider_class_names();
+
+ if ( ! is_object( $provider ) ) {
+ if ( ! class_exists( $provider ) ) {
+ return false;
+ }
+
+ $provider = new $provider();
+ } else {
+ $classname = '\Vendidero\Germanized\Shipments\ShippingProvider\Simple';
+
+ if ( array_key_exists( $provider->shipping_provider_name, $classes ) ) {
+ $classname = $classes[ $provider->shipping_provider_name ];
+ }
+
+ $classname = apply_filters( 'woocommerce_gzd_shipping_provider_class_name', $classname, $provider->shipping_provider_name, $provider );
+
+ if ( ! class_exists( $classname ) ) {
+ $classname = '\Vendidero\Germanized\Shipments\ShippingProvider\Simple';
+ }
+
+ $provider = new $classname( $provider );
+ }
+
+ if ( ! $provider || ! is_a( $provider, '\Vendidero\Germanized\Shipments\Interfaces\ShippingProvider' ) ) {
+ return false;
+ }
+
+ if ( is_null( $this->shipping_providers ) ) {
+ $this->shipping_providers = array();
+ }
+
+ $this->shipping_providers[ $provider->get_name() ] = $provider;
+ }
+
+ /**
+ * Shipping providers register themselves by returning their main class name through the woocommerce_gzd_shipping_provider_integrations filter.
+ *
+ * @return array
+ */
+ public function get_shipping_provider_class_names() {
+ $class_names = array();
+
+ /**
+ * This filter may be used to register additional shipping providers
+ * by adding a unique name as key and the classname to be loaded as value of the array.
+ *
+ * @param array $shipping_providers The shipping provider array
+ *
+ * @since 1.0.5
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipping_provider_class_names', $class_names );
+ }
+
+ /**
+ * Loads all shipping providers which are hooked in.
+ *
+ * @return ShippingProvider[]
+ */
+ public function load_shipping_providers() {
+ $this->shipping_providers = array();
+
+ // Unique provider name => provider class name.
+ $shipping_providers = array_merge( $this->get_shipping_provider_class_names(), WC_Data_Store::load( 'shipping-provider' )->get_shipping_providers() );
+
+ // For the settings in the backend, and for non-shipping zone methods, we still need to load any registered classes here.
+ foreach ( $shipping_providers as $provider_name => $provider_class ) {
+ $this->register_shipping_provider( $provider_class );
+ }
+
+ /**
+ * This hook fires as soon as shipping providers are loaded.
+ * Additional shipping provider may be registered manually afterwards.
+ *
+ * @param Helper $providers The shipping providers instance
+ *
+ * @since 3.0.6
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( 'woocommerce_gzd_load_shipping_providers', $this );
+
+ // Return loaded methods.
+ return $this->get_shipping_providers();
+ }
+
+ /**
+ * Returns all registered shipping providers for usage.
+ *
+ * @return Simple|Auto|ShippingProvider[]
+ */
+ public function get_shipping_providers() {
+ if ( is_null( $this->shipping_providers ) ) {
+ $this->load_shipping_providers();
+ }
+
+ return $this->shipping_providers;
+ }
+
+ /**
+ * @param $name
+ *
+ * @return false|Simple|Auto|ShippingProvider
+ */
+ public function get_shipping_provider( $name ) {
+ $providers = $this->get_shipping_providers();
+
+ return ( array_key_exists( $name, $providers ) ? $providers[ $name ] : false );
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/ShippingProvider/Method.php b/packages/woocommerce-germanized-shipments/src/ShippingProvider/Method.php
new file mode 100644
index 000000000..69f5bec0d
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/ShippingProvider/Method.php
@@ -0,0 +1,397 @@
+method = $method;
+ $this->init();
+ } else {
+ $this->is_placeholder = true;
+ $this->init_placeholder( $method );
+ }
+ }
+
+ protected function init_placeholder( $id ) {
+ if ( is_a( $id, 'WC_Shipping_Rate' ) ) {
+ $instance_id = $id->get_instance_id();
+ $id = $id->get_id();
+
+ if ( strpos( $id, ':' ) === false ) {
+ $id = $id . ':' . $instance_id;
+ }
+ }
+
+ if ( ! is_numeric( $id ) ) {
+ $expl = explode( ':', $id );
+ $instance_id = ( ( ! empty( $expl ) && sizeof( $expl ) > 1 ) ? $expl[1] : 0 );
+ $id = ( ( ! empty( $expl ) && sizeof( $expl ) > 1 ) ? $expl[0] : $id );
+ } else {
+ $instance_id = $id;
+ }
+
+ $this->placeholder_id = $id;
+ $this->placeholder_instance_id = $instance_id;
+
+ $this->instance_form_fields = Package::get_method_settings();
+ }
+
+ public function get_fallback_setting_value( $setting_key ) {
+ $setting_key = $this->maybe_prefix_key( $setting_key );
+ $setting_value = '';
+
+ /**
+ * In case the setting belongs to the current shipping provider
+ * lets allow overriding the fallback setting with data from the provider.
+ */
+ if ( ( $provider = $this->get_provider_instance() ) && $this->setting_belongs_to_provider( $setting_key ) ) {
+ $setting_value = $provider->get_setting( $setting_key );
+ }
+
+ if ( is_null( $setting_value ) ) {
+ $setting_value = Package::get_setting( $setting_key, null );
+ }
+
+ /**
+ * Convert booleans to string options
+ */
+ if ( is_bool( $setting_value ) ) {
+ $setting_value = wc_bool_to_string( $setting_value );
+ }
+
+ return apply_filters( "{$this->get_hook_prefix()}setting_fallback_value", $setting_value, $setting_key, $this );
+ }
+
+ protected function supports_instance_settings() {
+ if ( $this->is_placeholder() ) {
+ return false;
+ } else {
+ $supports_settings = ( $this->method->supports( 'instance-settings' ) && $this->method->supports( 'instance-settings-modal' ) ) ? true : false;
+
+ return apply_filters( 'woocommerce_gzd_shipping_provider_method_supports_instance_settings', $supports_settings, $this );
+ }
+ }
+
+ public function is_placeholder() {
+ return $this->is_placeholder === true;
+ }
+
+ /**
+ * Get all available shipping method settings. This method (re-) loads all
+ * the settings available across every registered shipping provider.
+ * Call the cached version instead for performance improvements.
+ *
+ * @see Package::get_method_settings()
+ *
+ * @return mixed|void
+ */
+ public static function get_admin_settings() {
+ /**
+ * Filter to adjust admin settings added to the shipment method instance specifically for shipping providers.
+ *
+ * @param array $settings Admin setting fields.
+ *
+ * @since 3.0.6
+ * @package Vendidero/Germanized/Shipments
+ */
+ $settings = apply_filters( 'woocommerce_gzd_shipping_provider_method_admin_settings', array(
+ 'shipping_provider_title' => array(
+ 'title' => _x( 'Shipping Provider Settings', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'title',
+ 'default' => '',
+ 'description' => _x( 'Adjust shipping provider settings used for managing shipments.', 'shipments', 'woocommerce-germanized' ),
+ ),
+ 'shipping_provider' => array(
+ 'title' => _x( 'Shipping Provider', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'select',
+ /**
+ * Filter to adjust default shipping provider pre-selected within shipping provider method settings.
+ *
+ * @param string $provider_name The shipping provider name e.g. dhl.
+ *
+ * @since 3.0.6
+ * @package Vendidero/Germanized/Shipments
+ */
+ 'default' => apply_filters( 'woocommerce_gzd_shipping_provider_method_default_provider', '' ),
+ 'options' => wc_gzd_get_shipping_provider_select(),
+ 'description' => _x( 'Choose a shipping provider which will be selected by default for an eligible shipment.', 'shipments', 'woocommerce-germanized' ),
+ ),
+ ) );
+
+ foreach( wc_gzd_get_shipping_providers() as $provider ) {
+ if ( ! $provider->is_activated() ) {
+ continue;
+ }
+
+ $additional_settings = $provider->get_shipping_method_settings();
+ $settings = array_merge( $settings, $additional_settings );
+ }
+
+ /**
+ * Append a stop title to make sure the table is closed within settings.
+ */
+ $settings = array_merge( $settings, array(
+ 'shipping_provider_stop_title' => array(
+ 'title' => '',
+ 'type' => 'title',
+ 'default' => '',
+ ),
+ ) );
+
+ return apply_filters( "woocommerce_gzd_shipping_provider_method_admin_settings_wrapped", $settings );
+ }
+
+ protected function init() {
+ $this->instance_form_fields = Package::get_method_settings();
+ $this->get_method()->instance_form_fields = array_merge( $this->get_method()->instance_form_fields, $this->instance_form_fields );
+
+ // Refresh instance settings in case they were already loaded
+ if ( ! empty( $this->get_method()->instance_settings ) ) {
+ $this->get_method()->init_instance_settings();
+ }
+ }
+
+ protected function get_hook_prefix() {
+ $prefix = "woocommerce_gzd_shipping_provider_method_";
+
+ return $prefix;
+ }
+
+ /**
+ * Returns the Woo WC_Shipping_Method original object
+ *
+ * @return object|WC_Shipping_Method
+ */
+ public function get_method() {
+ return $this->method;
+ }
+
+ public function get_id() {
+ if ( ! $this->is_placeholder() ) {
+ return $this->method->id;
+ } else {
+ return $this->placeholder_id;
+ }
+ }
+
+ public function get_instance_id() {
+ if ( ! $this->is_placeholder() ) {
+ return $this->method->get_instance_id();
+ } else {
+ return $this->placeholder_instance_id;
+ }
+ }
+
+ public function has_option( $key ) {
+ $fields = $this->instance_form_fields;
+ $key = $this->maybe_prefix_key( $key );
+ $has_option = ( array_key_exists( $key, $fields ) && $this->setting_belongs_to_provider( $key ) ) ? true : false;
+
+ /**
+ * Filter that allows checking whether a shipping provider method has a specific option or not.
+ *
+ * @param boolean $has_option Whether or not the option exists.
+ * @param string $key The setting key.
+ * @param Method $method The method instance.
+ *
+ * @since 3.0.6
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( "{$this->get_hook_prefix()}setting_prefix", $has_option, $key, $this );
+ }
+
+ public function setting_belongs_to_provider( $setting_key, $provider = '' ) {
+ $prefix = $this->get_custom_setting_prefix_key();
+
+ if ( ! empty( $provider ) ) {
+ $prefix = $provider . '_';
+ }
+
+ $belongs_to_provider = false;
+
+ if ( ! empty( $prefix ) && substr( $setting_key, 0, strlen( $prefix ) ) === $prefix ) {
+ $belongs_to_provider = true;
+ }
+
+ return $belongs_to_provider;
+ }
+
+ public function is_provider_enabled( $provider ) {
+ return ( $this->get_provider() === $provider ) ? true : false;
+ }
+
+ public function set_provider( $provider_name ) {
+ $this->provider_slug = $provider_name;
+ }
+
+ public function get_provider() {
+ $id = sanitize_key( $this->get_id() );
+
+ if ( is_null( $this->provider_slug ) ) {
+ $provider_slug = $this->method ? $this->method->get_option( 'shipping_provider' ) : '';
+
+ if ( ! empty( $provider_slug ) ) {
+ if ( $provider = wc_gzd_get_shipping_provider( $provider_slug ) ) {
+
+ if ( ! $provider->is_activated() ) {
+ $provider_slug = '';
+ }
+ }
+ }
+
+ if ( empty( $provider_slug ) ) {
+ $provider_slug = wc_gzd_get_default_shipping_provider();
+ }
+
+ /**
+ * Filter that allows adjusting the shipping provider chosen for a specific shipping method.
+ *
+ * @param string $provider_slug The shipping provider.
+ * @param string $method_id The shipping method id.
+ * @param Method $method The method instance.
+ *
+ * @since 3.0.6
+ * @package Vendidero/Germanized/Shipments
+ */
+ $this->provider_slug = apply_filters( "woocommerce_gzd_shipping_provider_method_provider", $provider_slug, $this->get_id(), $this );
+ }
+
+ /**
+ * Filter that allows choosing a shipping provider for a specific shipping method.
+ *
+ * The dynamic portion of this hook, `$id` refers to the shipping method id.
+ *
+ * Example hook name: `woocommerce_gzd_shipping_provider_method_flat_rate_provider`
+ *
+ * @param string $provider_slug The shipping provider name to be used.
+ * @param Method $method The method instance.
+ *
+ * @since 3.0.6
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( "{$this->get_hook_prefix()}{$id}_provider", $this->provider_slug, $this );
+ }
+
+ public function get_provider_instance() {
+ $provider_slug = $this->get_provider();
+
+ if ( ! empty( $provider_slug ) ) {
+ return wc_gzd_get_shipping_provider( $provider_slug );
+ }
+
+ return false;
+ }
+
+ protected function get_custom_setting_prefix_key() {
+ $prefix = '';
+
+ if ( $provider = $this->get_provider_instance() ) {
+ $prefix = $provider->get_name() . '_';
+ }
+
+ return apply_filters( "{$this->get_hook_prefix()}custom_setting_prefix", $prefix, $this );
+ }
+
+ protected function maybe_prefix_key( $key ) {
+ $fields = $this->instance_form_fields;
+ $prefix = $this->get_custom_setting_prefix_key();
+ $new_key = $key;
+
+ // Do only prefix if the prefix does not yet exist.
+ if ( ! array_key_exists( $new_key, $fields ) ) {
+ if ( substr( $key, 0, strlen( $prefix ) ) !== $prefix ) {
+ $new_key = $prefix . $key;
+ }
+ }
+
+ /**
+ * Filter that allows prefixing the setting key used for a shipping provider method.
+ *
+ * @param string $new_key The prefixed setting key.
+ * @param string $key The original setting key.
+ * @param Method $method The method instance.
+ *
+ * @since 3.0.6
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( "{$this->get_hook_prefix()}setting_key_prefixed", $new_key, $key, $this );
+ }
+
+ public function get_option( $key ) {
+ $key = $this->maybe_prefix_key( $key );
+ $option_value = $this->get_fallback_setting_value( $key );
+
+ if ( ! $this->is_placeholder() ) {
+ if ( $this->has_option( $key ) && $this->supports_instance_settings() ) {
+ $option_type = isset( $this->instance_form_fields[ $key ]['type'] ) ? $this->instance_form_fields[ $key ]['type'] : 'text';
+
+ // Do only use method settings if the method is not a placeholder and method supports settings
+ $option_value = $this->method->get_option( $key, $option_value );
+
+ if ( in_array( $option_type, array( 'checkbox', 'radio' ) ) ) {
+ $option_value = wc_string_to_bool( $option_value );
+
+ if ( $option_value ) {
+ $option_value = 'yes';
+ } else {
+ $option_value = 'no';
+ }
+ }
+ }
+ }
+
+ return apply_filters( "{$this->get_hook_prefix()}setting_value", $option_value, $key, $this );
+ }
+
+ /**
+ * Call child methods if the method does not exist.
+ *
+ * @param $method
+ * @param $args
+ *
+ * @return bool|mixed
+ */
+ public function __call( $method, $args ) {
+
+ if ( method_exists( $this->method, $method ) ) {
+ return call_user_func_array( array( $this->method, $method ), $args );
+ }
+
+ return false;
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/ShippingProvider/MethodPlaceholder.php b/packages/woocommerce-germanized-shipments/src/ShippingProvider/MethodPlaceholder.php
new file mode 100644
index 000000000..22ce09f12
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/ShippingProvider/MethodPlaceholder.php
@@ -0,0 +1,24 @@
+ true,
+ 'title' => '',
+ 'name' => '',
+ 'description' => '',
+ 'supports_customer_returns' => false,
+ 'supports_guest_returns' => false,
+ 'return_manual_confirmation' => true,
+ 'return_instructions' => '',
+ 'tracking_url_placeholder' => '',
+ 'tracking_desc_placeholder' => '',
+ );
+
+ /**
+ * Get the provider if ID is passed. In case it is an integration, data will be provided through the impl.
+ * This class should NOT be instantiated, but the `wc_gzd_get_shipping_provider` function should be used.
+ *
+ * @param int|object|ShippingProvider $provider Provider to read.
+ */
+ public function __construct( $data = 0 ) {
+ parent::__construct( $data );
+
+ if ( $data instanceof ShippingProvider ) {
+ $this->set_id( absint( $data->get_id() ) );
+ } elseif ( is_numeric( $data ) ) {
+ $this->set_id( $data );
+ } elseif( is_object( $data ) && isset( $data->shipping_provider_id ) ) {
+ $this->set_id( $data->shipping_provider_id );
+ }
+
+ $this->data_store = WC_Data_Store::load( $this->data_store_name );
+
+ // If we have an ID, load the user from the DB.
+ if ( $this->get_id() ) {
+ try {
+ $this->data_store->read( $this );
+ } catch ( Exception $e ) {
+ $this->set_id( 0 );
+ $this->set_object_read( true );
+ }
+ } else {
+ $this->set_object_read( true );
+ }
+ }
+
+ public function get_help_link() {
+ return '';
+ }
+
+ public function get_signup_link() {
+ return '';
+ }
+
+ /**
+ * Whether or not this instance is a manual integration.
+ * Manual integrations are constructed dynamically from DB and do not support
+ * automatic shipment handling, e.g. label creation.
+ *
+ * @return bool
+ */
+ public function is_manual_integration() {
+ return true;
+ }
+
+ /**
+ * Whether or not this instance supports a certain label type.
+ *
+ * @param string $label_type The label type e.g. simple or return.
+ * @param false|Shipment Shipment instance
+ *
+ * @return bool
+ */
+ public function supports_labels( $label_type, $shipment = false ) {
+ return false;
+ }
+
+ public function supports_customer_return_requests() {
+ if ( $this->is_manual_integration() ) {
+ return true;
+ }
+
+ return false;
+ }
+
+ /**
+ * Some providers (e.g. DHL) create return labels automatically and the return
+ * address is chosen dynamically depending on the country. For that reason the return address
+ * might not show up within emails or in customer panel.
+ *
+ * @return bool
+ */
+ public function hide_return_address() {
+ return false;
+ }
+
+ public function get_edit_link( $section = '' ) {
+ $url = admin_url( 'admin.php?page=wc-settings&tab=germanized-shipping_provider&provider=' . esc_attr( $this->get_name() ) );
+ $url = add_query_arg( array( 'section' => $section ), $url );
+
+ return $url;
+ }
+
+ /**
+ * Returns whether the shipping provider is active for usage or not.
+ *
+ * @return bool
+ */
+ public function is_activated() {
+ return $this->get_activated() === true;
+ }
+
+ public function needs_manual_confirmation_for_returns() {
+ return $this->get_return_manual_confirmation() === true;
+ }
+
+ /**
+ * @param false|\WC_Order $order
+ *
+ * @return bool
+ */
+ public function supports_customer_returns( $order = false ) {
+ return $this->get_supports_customer_returns() === true;
+ }
+
+ public function supports_guest_returns() {
+ return $this->get_supports_customer_returns() === true && $this->get_supports_guest_returns() === true;
+ }
+
+ /**
+ * Returns a title for the shipping provider.
+ *
+ * @param string $context
+ *
+ * @return string
+ */
+ public function get_title( $context = 'view' ) {
+ return $this->get_prop( 'title', $context );
+ }
+
+ /**
+ * Returns a unique slug/name for the shipping provider.
+ *
+ * @param string $context
+ *
+ * @return string
+ */
+ public function get_name( $context = 'view' ) {
+ return $this->get_prop( 'name', $context );
+ }
+
+ /**
+ * Returns a description for the provider.
+ *
+ * @param string $context
+ *
+ * @return string
+ */
+ public function get_description( $context = 'view' ) {
+ $desc = $this->get_prop( 'description', $context );
+
+ if ( 'view' === $context && empty( $desc ) ) {
+ return '-';
+ }
+
+ return $desc;
+ }
+
+ /**
+ * Returns whether the shipping provider is activated or not.
+ *
+ * @param string $context
+ *
+ * @return string
+ */
+ public function get_activated( $context = 'view' ) {
+ return $this->get_prop( 'activated', $context );
+ }
+
+ /**
+ * Returns whether the shipping provider needs manual confirmation for a return.
+ *
+ * @param string $context
+ *
+ * @return string
+ */
+ public function get_return_manual_confirmation( $context = 'view' ) {
+ return $this->get_prop( 'return_manual_confirmation', $context );
+ }
+
+ /**
+ * Returns whether the shipping provider supports returns added by customers or not.
+ *
+ * @param string $context
+ *
+ * @return string
+ */
+ public function get_supports_customer_returns( $context = 'view' ) {
+ return $this->get_prop( 'supports_customer_returns', $context );
+ }
+
+ /**
+ * Returns whether the shipping provider supports returns added by guests or not.
+ *
+ * @param string $context
+ *
+ * @return string
+ */
+ public function get_supports_guest_returns( $context = 'view' ) {
+ return $this->get_prop( 'supports_guest_returns', $context );
+ }
+
+ /**
+ * Returns the tracking url placeholder which is being used to
+ * construct a tracking url.
+ *
+ * @param string $context
+ *
+ * @return mixed
+ */
+ public function get_tracking_url_placeholder( $context = 'view' ) {
+ $data = $this->get_prop( 'tracking_url_placeholder', $context );
+
+ // In case the option value is not stored in DB yet
+ if ( 'view' === $context && empty( $data ) ) {
+ $data = $this->get_default_tracking_url_placeholder();
+ }
+
+ return $data;
+ }
+
+ public function get_default_tracking_url_placeholder() {
+ return '';
+ }
+
+ /**
+ * Returns the tracking description placeholder which is being used to
+ * construct a tracking description.
+ *
+ * @param string $context
+ *
+ * @return mixed
+ */
+ public function get_tracking_desc_placeholder( $context = 'view' ) {
+ $data = $this->get_prop( 'tracking_desc_placeholder', $context );
+
+ // In case the option value is not stored in DB yet
+ if ( 'view' === $context && empty( $data ) ) {
+ $data = $this->get_default_tracking_desc_placeholder();
+ }
+
+ return $data;
+ }
+
+ public function get_default_tracking_desc_placeholder() {
+ return _x( 'Your shipment is being processed by {shipping_provider}. If you want to track the shipment, please use the following tracking number: {tracking_id}. Depending on the chosen shipping method it is possible that the tracking data does not reflect the current status when receiving this email.', 'shipments', 'woocommerce-germanized' );
+ }
+
+ /**
+ * Returns the return instructions.
+ *
+ * @param string $context
+ *
+ * @return mixed
+ */
+ public function get_return_instructions( $context = 'view' ) {
+ return $this->get_prop( 'return_instructions', $context );
+ }
+
+ public function has_return_instructions() {
+ $instructions = $this->get_return_instructions();
+
+ return empty( $instructions ) ? false : true;
+ }
+
+ public function get_address_prop( $prop, $type = 'shipper' ) {
+ $key = "woocommerce_gzd_shipments_{$type}_address_{$prop}";
+ $value = get_option( $key, '' );
+
+ if ( 'return' === $type && '' === $value ) {
+ $value = get_option( "woocommerce_gzd_shipments_shipper_address_{$prop}" );
+ }
+
+ return $value;
+ }
+
+ public function get_shipper_email() {
+ return $this->get_address_prop( 'email' );
+ }
+
+ public function get_shipper_phone() {
+ return $this->get_address_prop( 'phone' );
+ }
+
+ public function get_contact_phone() {
+ return get_option( 'woocommerce_gzd_shipments_contact_phone' );
+ }
+
+ public function get_shipper_first_name() {
+ return $this->get_address_prop( 'first_name' );
+ }
+
+ public function get_shipper_last_name() {
+ return $this->get_address_prop( 'last_name' );
+ }
+
+ public function get_shipper_name() {
+ return $this->get_shipper_first_name() . ' ' . $this->get_shipper_last_name();
+ }
+
+ public function get_shipper_company() {
+ return $this->get_address_prop( 'company' );
+ }
+
+ public function get_shipper_address() {
+ return $this->get_address_prop( 'address_1' );
+ }
+
+ public function get_shipper_address_2() {
+ return $this->get_address_prop( 'address_2' );
+ }
+
+ public function get_shipper_street() {
+ $split = wc_gzd_split_shipment_street( $this->get_shipper_address() );
+
+ return $split['street'];
+ }
+
+ public function get_shipper_street_number() {
+ $split = wc_gzd_split_shipment_street( $this->get_shipper_address() );
+
+ return $split['number'];
+ }
+
+ public function get_shipper_postcode() {
+ return $this->get_address_prop( 'postcode' );
+ }
+
+ public function get_shipper_city() {
+ return $this->get_address_prop( 'city' );
+ }
+
+ public function get_shipper_country() {
+ return $this->get_address_prop( 'country' );
+ }
+
+ public function get_return_first_name() {
+ return $this->get_address_prop( 'first_name', 'return' );
+ }
+
+ public function get_return_last_name() {
+ return $this->get_address_prop( 'last_name', 'return' );
+ }
+
+ public function get_return_company() {
+ return $this->get_address_prop( 'company', 'return' );
+ }
+
+ public function get_return_name() {
+ return $this->get_return_first_name() . ' ' . $this->get_return_last_name();
+ }
+
+ public function get_return_address() {
+ return $this->get_address_prop( 'address_1', 'return' );
+ }
+
+ public function get_return_address_2() {
+ return $this->get_address_prop( 'address_2', 'return' );
+ }
+
+ public function get_return_street() {
+ $split = wc_gzd_split_shipment_street( $this->get_return_address() );
+
+ return $split['street'];
+ }
+
+ public function get_return_street_number() {
+ $split = wc_gzd_split_shipment_street( $this->get_return_address() );
+
+ return $split['number'];
+ }
+
+ public function get_return_postcode() {
+ return $this->get_address_prop( 'postcode', 'return' );
+ }
+
+ public function get_return_city() {
+ return $this->get_address_prop( 'city', 'return' );
+ }
+
+ public function get_return_country() {
+ return $this->get_address_prop( 'country', 'return' );
+ }
+
+ public function get_return_email() {
+ return $this->get_address_prop( 'email', 'return' );
+ }
+
+ public function get_return_phone() {
+ return $this->get_address_prop( 'phone', 'return' );
+ }
+
+ /**
+ * Set the current shipping provider to active or inactive.
+ *
+ * @param bool $is_activated
+ */
+ public function set_activated( $is_activated ) {
+ $this->set_prop( 'activated', wc_string_to_bool( $is_activated ) );
+ }
+
+ /**
+ * Mark the current shipping provider as manual needed confirmation for returns.
+ *
+ * @param bool $needs_confirmation
+ */
+ public function set_return_manual_confirmation( $needs_confirmation ) {
+ $this->set_prop( 'return_manual_confirmation', wc_string_to_bool( $needs_confirmation ) );
+ }
+
+ /**
+ * Set whether or not the current shipping provider supports customer returns
+ *
+ * @param bool $supports
+ */
+ public function set_supports_customer_returns( $supports ) {
+ $this->set_prop( 'supports_customer_returns', wc_string_to_bool( $supports ) );
+ }
+
+ /**
+ * Set whether or not the current shipping provider supports guest returns
+ *
+ * @param bool $supports
+ */
+ public function set_supports_guest_returns( $supports ) {
+ $this->set_prop( 'supports_guest_returns', wc_string_to_bool( $supports ) );
+ }
+
+ public function update_settings_with_defaults() {
+ foreach( $this->get_all_settings() as $section => $settings ) {
+ foreach( $settings as $setting ) {
+ $type = isset( $setting['type'] ) ? $setting['type'] : 'title';
+ $default = isset( $setting['default'] ) ? $setting['default'] : null;
+
+ if ( in_array( $type, array( 'title', 'sectionend', 'html' ) ) || ! isset( $setting['id'] ) || empty( $setting['id'] ) ) {
+ continue;
+ }
+
+ $current_value = $this->get_setting( $setting['id'], null, 'edit' );
+
+ /**
+ * Update meta data with default value in case it does not yet exist.
+ */
+ if ( is_null( $current_value ) && ! is_null( $default ) ) {
+ $this->update_setting( $setting['id'], $default );
+ }
+ }
+ }
+ }
+
+ /**
+ * Activate current ShippingProvider instance.
+ */
+ public function activate() {
+ $this->set_activated( true );
+ $this->update_settings_with_defaults();
+ $this->save();
+
+ /**
+ * This action fires as soon as a certain shipping provider gets activated.
+ *
+ * @param ShippingProvider $shipping_provider The shipping provider instance.
+ */
+ do_action( 'woocommerce_gzd_shipping_provider_activated', $this );
+ }
+
+ /**
+ * Deactivate current ShippingProvider instance.
+ */
+ public function deactivate() {
+ $this->set_activated( false );
+ $this->save();
+
+ /**
+ * This action fires as soon as a certain shipping provider gets deactivated.
+ *
+ * @param ShippingProvider $shipping_provider The shipping provider instance.
+ */
+ do_action( 'woocommerce_gzd_shipping_provider_deactivated', $this );
+ }
+
+ /**
+ * Set the name of the current shipping provider.
+ *
+ * @param string $name
+ */
+ public function set_name( $name ) {
+ $this->set_prop( 'name', $name );
+ }
+
+ /**
+ * Set the title of the current shipping provider.
+ *
+ * @param string $title
+ */
+ public function set_title( $title ) {
+ $this->set_prop( 'title', $title );
+ }
+
+ /**
+ * Set the description of the current shipping provider.
+ *
+ * @param string $description
+ */
+ public function set_description( $description ) {
+ $this->set_prop( 'description', $description );
+ }
+
+ /**
+ * Set the return instructions of the current shipping provider.
+ *
+ * @param string $instructions
+ */
+ public function set_return_instructions( $instructions ) {
+ $this->set_prop( 'return_instructions', $instructions );
+ }
+
+ /**
+ * Set the tracking url placeholder of the current shipping provider.
+ *
+ * @param string $placeholder
+ */
+ public function set_tracking_url_placeholder( $placeholder ) {
+ $this->set_prop( 'tracking_url_placeholder', $placeholder );
+ }
+
+ /**
+ * Set the tracking description placeholder of the current shipping provider.
+ *
+ * @param string $placeholder
+ */
+ public function set_tracking_desc_placeholder( $placeholder ) {
+ $this->set_prop( 'tracking_desc_placeholder', $placeholder );
+ }
+
+ /**
+ * Returns the tracking url for a specific shipment.
+ *
+ * @param Shipment $shipment
+ *
+ * @return string
+ */
+ public function get_tracking_url( $shipment ) {
+
+ $tracking_url = '';
+ $tracking_id = $shipment->get_tracking_id();
+
+ if ( '' !== $this->get_tracking_url_placeholder() && ! empty( $tracking_id ) ) {
+ $placeholders = $this->get_tracking_placeholders( $shipment );
+ $tracking_url = str_replace( array_keys( $placeholders ), array_values( $placeholders ), $this->get_tracking_url_placeholder() );
+ }
+
+ /**
+ * This filter returns the tracking url provided by the shipping provider for a certain shipment.
+ *
+ * The dynamic portion of the hook `$this->get_hook_prefix()` refers to the
+ * current provider name.
+ *
+ * Example hook name: woocommerce_gzd_shipping_provider_dhl_get_tracking_url
+ *
+ * @param string $tracking_url The tracking url.
+ * @param Shipment $shipment The shipment used to build the url.
+ * @param ShippingProvider $provider The shipping provider.
+ *
+ * @since 3.0.6
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( $this->get_hook_prefix() . 'tracking_url', $tracking_url, $shipment, $this );
+ }
+
+ /**
+ * Returns the tracking description for a certain shipment.
+ *
+ * @param Shipment $shipment
+ *
+ * @return string
+ */
+ public function get_tracking_desc( $shipment ) {
+
+ $tracking_desc = '';
+ $tracking_id = $shipment->get_tracking_id();
+
+ if ( '' !== $this->get_tracking_desc_placeholder() && ! empty( $tracking_id ) ) {
+ $placeholders = $this->get_tracking_placeholders( $shipment );
+ $tracking_desc = str_replace( array_keys( $placeholders ), array_values( $placeholders ), $this->get_tracking_desc_placeholder() );
+ }
+
+ /**
+ * This filter returns the tracking description provided by the shipping provider for a certain shipment.
+ *
+ * The dynamic portion of the hook `$this->get_hook_prefix()` refers to the
+ * current provider name.
+ *
+ * Example hook name: woocommerce_gzd_shipping_provider_dhl_get_tracking_description
+ *
+ * @param string $tracking_url The tracking description.
+ * @param Shipment $shipment The shipment used to build the url.
+ * @param ShippingProvider $provider The shipping provider.
+ *
+ * @since 3.0.6
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( $this->get_hook_prefix() . 'tracking_desc', $tracking_desc, $shipment, $this );
+ }
+
+ protected function set_prop( $prop, $value ) {
+ parent::set_prop( $prop, $value );
+ }
+
+ /**
+ * @param bool|Shipment $shipment
+ *
+ * @return array
+ */
+ public function get_tracking_placeholders( $shipment = false ) {
+ $label = false;
+
+ if ( $shipment ) {
+ $label = $shipment->get_label();
+ }
+
+ /**
+ * This filter may be used to add or manipulate tracking placeholder data
+ * for a certain shipping provider.
+ *
+ * The dynamic portion of the hook `$this->get_hook_prefix()` refers to the
+ * current provider name.
+ *
+ * Example hook name: woocommerce_gzd_shipping_provider_dhl_get_tracking_placeholders
+ *
+ * @param array $placeholders Placeholders in key => value pairs.
+ * @param ShippingProvider $provider The shipping provider.
+ * @param Shipment|bool $shipment The shipment instance if available.
+ *
+ * @since 3.0.6
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( "{$this->get_hook_prefix()}tracking_placeholders", array(
+ '{shipment_number}' => $shipment ? $shipment->get_shipment_number() : '',
+ '{order_number}' => $shipment ? $shipment->get_order_number() : '',
+ '{tracking_id}' => $shipment ? $shipment->get_tracking_id() : '',
+ '{postcode}' => $shipment ? $shipment->get_postcode() : '',
+ '{date_sent_day}' => $shipment && $shipment->get_date_sent() ? $shipment->get_date_sent()->format( 'd' ) : '',
+ '{date_sent_month}' => $shipment && $shipment->get_date_sent() ? $shipment->get_date_sent()->format( 'm' ) : '',
+ '{date_sent_year}' => $shipment && $shipment->get_date_sent() ? $shipment->get_date_sent()->format( 'Y' ) : '',
+ '{date_day}' => $shipment && $shipment->get_date_created() ? $shipment->get_date_created()->format( 'd' ) : '',
+ '{date_month}' => $shipment && $shipment->get_date_created() ? $shipment->get_date_created()->format( 'm' ) : '',
+ '{date_year}' => $shipment && $shipment->get_date_created() ? $shipment->get_date_created()->format( 'Y' ) : '',
+ '{label_date_day}' => $label ? $label->get_date_created()->format( 'd' ) : '',
+ '{label_date_month}' => $label ? $label->get_date_created()->format( 'm' ) : '',
+ '{label_date_year}' => $label ? $label->get_date_created()->format( 'Y' ) : '',
+ '{shipping_provider}' => $this->get_title()
+ ), $this, $shipment );
+ }
+
+ /**
+ * Prefix for action and filter hooks on data.
+ *
+ * @since 3.0.0
+ * @return string
+ */
+ protected function get_hook_prefix() {
+ return $this->get_general_hook_prefix() . 'get_';
+ }
+
+ /**
+ * Prefix for action and filter hooks on data.
+ *
+ * @since 3.0.0
+ * @return string
+ */
+ protected function get_general_hook_prefix() {
+ $name = sanitize_key( $this->get_name( 'edit' ) );
+
+ if ( empty( $name ) ) {
+ return "woocommerce_gzd_shipping_provider_";
+ } else {
+ return "woocommerce_gzd_shipping_provider_{$name}_";
+ }
+ }
+
+ protected function get_general_settings() {
+ $settings = array(
+ array( 'title' => '', 'type' => 'title', 'id' => 'shipping_provider_options' ),
+ );
+
+ if ( $this->is_manual_integration() ) {
+ $settings = array_merge( $settings, array(
+ array(
+ 'title' => _x( 'Title', 'shipments', 'woocommerce-germanized' ),
+ 'desc_tip' => _x( 'Choose a title for the shipping provider.', 'shipments', 'woocommerce-germanized' ),
+ 'id' => 'shipping_provider_title',
+ 'value' => $this->get_title( 'edit' ),
+ 'default' => '',
+ 'type' => 'text',
+ ),
+
+ array(
+ 'title' => _x( 'Description', 'shipments', 'woocommerce-germanized' ),
+ 'desc_tip' => _x( 'Choose a description for the shipping provider.', 'shipments', 'woocommerce-germanized' ),
+ 'id' => 'shipping_provider_description',
+ 'value' => $this->get_description( 'edit' ),
+ 'default' => '',
+ 'type' => 'textarea',
+ 'css' => 'width: 100%;',
+ ),
+ ) );
+ }
+
+ $settings = array_merge( $settings, array(
+ array(
+ 'title' => _x( 'Tracking URL', 'shipments', 'woocommerce-germanized' ),
+ 'desc' => '' . sprintf( _x( 'Adjust the placeholder used to construct the tracking URL for this shipping provider. You may use on of the following placeholders to insert the tracking id or other dynamic data: %s', 'shipments', 'woocommerce-germanized' ), '
',
+ 'id' => 'shipping_provider_tracking_url_placeholder',
+ 'placeholder' => $this->get_default_tracking_url_placeholder(),
+ 'value' => $this->get_tracking_url_placeholder( 'edit' ),
+ 'default' => $this->get_default_tracking_url_placeholder(),
+ 'type' => 'text',
+ 'css' => 'width: 100%;',
+ ),
+
+ array(
+ 'title' => _x( 'Tracking description', 'shipments', 'woocommerce-germanized' ),
+ 'desc' => '' . implode( ', ', array_keys( $this->get_tracking_placeholders() ) ) . '' ) . '' . sprintf( _x( 'Adjust the placeholder used to construct the tracking description for this shipping provider (e.g. used within notification emails). You may use on of the following placeholders to insert the tracking id or other dynamic data: %s', 'shipments', 'woocommerce-germanized' ), '
',
+ 'id' => 'shipping_provider_tracking_desc_placeholder',
+ 'placeholder' => '',
+ 'value' => $this->get_tracking_desc_placeholder( 'edit' ),
+ 'default' => $this->get_default_tracking_desc_placeholder(),
+ 'type' => 'textarea',
+ 'css' => 'width: 100%; min-height: 60px; margin-top: 1em;',
+ )
+ ) );
+
+ $settings = array_merge( $settings, array(
+ array( 'type' => 'sectionend', 'id' => 'shipping_provider_options' ),
+ ) );
+
+ return $settings;
+ }
+
+ /**
+ * @param Shipment $shipment
+ * @param $key
+ */
+ public function get_shipment_setting( $shipment, $key, $default = null ) {
+ $value = $this->get_setting( $key, $default );
+
+ if ( $method = $shipment->get_shipping_method_instance() ) {
+ $prefixed_key = $this->get_name() . '_' . $key;
+
+ if ( $method->has_option( $prefixed_key ) ) {
+ $method_value = $method->get_option( $prefixed_key );
+
+ if ( ! is_null( $method_value ) && $value !== $method_value ) {
+ $value = $method_value;
+ }
+ }
+ }
+
+ return $value;
+ }
+
+ public function get_setting( $key, $default = null, $context = 'view' ) {
+ $clean_key = $this->unprefix_setting_key( $key );
+ $getter = "get_{$clean_key}";
+ $value = $default;
+
+ if ( is_callable( array( $this, $getter ) ) ) {
+ $value = $this->$getter( $context );
+ } elseif ( $this->meta_exists( $clean_key ) ) {
+ $value = $this->get_meta( $clean_key, true, $context );
+ }
+
+ if ( strstr( $key, 'password' ) ) {
+ if ( class_exists( 'WC_GZD_Secret_Box_Helper' ) ) {
+ $result = \WC_GZD_Secret_Box_Helper::decrypt( $value );
+
+ if ( ! is_wp_error( $result ) ) {
+ $value = $result;
+ }
+ }
+
+ $value = $this->retrieve_password( $value );
+ }
+
+ return $value;
+ }
+
+ protected function retrieve_password( $value ) {
+ return stripslashes( $value );
+ }
+
+ protected function unprefix_setting_key( $key ) {
+ $prefixes = array(
+ 'shipping_provider_',
+ $this->get_name() . '_',
+ );
+
+ foreach( $prefixes as $prefix ) {
+ if ( substr( $key, 0, strlen( $prefix ) ) === $prefix ) {
+ $key = substr( $key, strlen( $prefix ) );
+ }
+ }
+
+ return $key;
+ }
+
+ public function update_settings( $section = '', $data = null, $save = true ) {
+ $settings_to_save = Settings::get_sanitized_settings( $this->get_settings( $section ), $data );
+
+ foreach( $settings_to_save as $option_name => $value ) {
+ $this->update_setting( $option_name, $value );
+ }
+
+ if ( $save ) {
+ $this->save();
+ }
+ }
+
+ public function update_setting( $setting, $value ) {
+ $setting_name_clean = $this->unprefix_setting_key( $setting );
+ $setter = 'set_' . $setting_name_clean;
+
+ try {
+ if ( is_callable( array( $this, $setter ) ) ) {
+ $this->{$setter}( $value );
+ } else {
+ $this->update_meta_data( $setting_name_clean, $value );
+ }
+ } catch( Exception $e ) {}
+ }
+
+ public function get_settings( $section = '' ) {
+ $settings = array();
+
+ if ( '' === $section || 'general' === $section ) {
+ $settings = $this->get_general_settings();
+ } elseif( 'returns' === $section ) {
+ $settings = $this->get_return_settings();
+ } elseif( is_callable( array( $this, "get_{$section}_settings" ) ) ) {
+ $settings = $this->{"get_{$section}_settings"}();
+ }
+
+ /**
+ * This filter returns the admin settings available for a certain shipping provider.
+ *
+ * The dynamic portion of the hook `$this->get_hook_prefix()` refers to the
+ * current provider name.
+ *
+ * Example hook name: woocommerce_gzd_shipping_provider_dhl_get_settings
+ *
+ * @param array $settings Available settings.
+ * @param ShippingProvider $provider The shipping provider.
+ *
+ * @since 3.0.6
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( $this->get_hook_prefix() . 'settings', $settings, $section, $this );
+ }
+
+ protected function get_return_settings() {
+ $settings = array(
+ array( 'title' => '', 'type' => 'title', 'id' => 'shipping_provider_return_options' ),
+ );
+
+ $settings = array_merge( $settings, array(
+ array(
+ 'title' => _x( 'Customer returns', 'shipments', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Allow customers to submit return requests to shipments.', 'shipments', 'woocommerce-germanized' ) . '' . implode( ', ', array_keys( $this->get_tracking_placeholders() ) ) . '' ) . '' . sprintf( _x( 'This option will allow your customers to submit return requests to orders. Return requests will be visible within your %s. To learn more about return requests by customers and/or guests, please check the %s.', 'shipments', 'woocommerce-germanized' ), '' . _x( 'Return Dashboard', 'shipments', 'woocommerce-germanized' ) . '', '' . _x( 'docs', 'shipments', 'woocommerce-germanized' ) . '' ) . '
',
+ 'id' => 'supports_customer_returns',
+ 'placeholder' => '',
+ 'value' => wc_bool_to_string( $this->get_supports_customer_returns( 'edit' ) ),
+ 'default' => 'no',
+ 'type' => 'gzd_toggle',
+ ),
+
+ array(
+ 'title' => _x( 'Guest returns', 'shipments', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Allow guests to submit return requests to shipments.', 'shipments', 'woocommerce-germanized' ) . '' . sprintf( _x( 'Guests will need to provide their email address and the order id to receive a one-time link to submit a return request. The placeholder %s might be used to place the request form on your site.', 'shipments', 'woocommerce-germanized' ), '
',
+ 'id' => 'supports_guest_returns',
+ 'default' => 'no',
+ 'value' => wc_bool_to_string( $this->get_supports_guest_returns( 'edit' ) ),
+ 'type' => 'gzd_toggle',
+ 'custom_attributes' => array(
+ 'data-show_if_shipping_provider_supports_customer_returns' => '',
+ ),
+ ),
+
+ array(
+ 'title' => _x( 'Manual confirmation', 'shipments', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Return requests need manual confirmation.', 'shipments', 'woocommerce-germanized' ) . '[gzd_return_request_form]' ) . '' . _x( 'By default return request need manual confirmation e.g. a shop manager needs to review return requests which by default are added with the status "requested" after a customer submitted a return request. If you choose to disable this option, customer return requests will be added as "processing" and an email confirmation including instructions will be sent immediately to the customer.', 'shipments', 'woocommerce-germanized' ) . '
',
+ 'id' => 'return_manual_confirmation',
+ 'placeholder' => '',
+ 'value' => wc_bool_to_string( $this->get_return_manual_confirmation( 'edit' ) ),
+ 'default' => 'yes',
+ 'type' => 'gzd_toggle',
+ 'custom_attributes' => array(
+ 'data-show_if_shipping_provider_supports_customer_returns' => '',
+ ),
+ ),
+
+ array(
+ 'title' => _x( 'Return instructions', 'shipments', 'woocommerce-germanized' ),
+ 'desc' => '' . _x( 'Provide your customer with instructions on how to return the shipment after a return request has been confirmed e.g. explain how to prepare the return for shipment. In case a label cannot be generated automatically, make sure to provide your customer with information on how to obain a return label.', 'shipments', 'woocommerce-germanized' ) . '
',
+ 'id' => 'return_instructions',
+ 'placeholder' => '',
+ 'value' => $this->get_return_instructions( 'edit' ),
+ 'default' => '',
+ 'type' => 'textarea',
+ 'css' => 'width: 100%; min-height: 60px; margin-top: 1em;',
+ 'custom_attributes' => array(
+ 'data-show_if_shipping_provider_supports_customer_returns' => '',
+ ),
+ ),
+ ) );
+
+ $settings = array_merge( $settings, array(
+ array( 'type' => 'sectionend', 'id' => 'shipping_provider_return_options' ),
+ ) );
+
+ return $settings;
+ }
+
+ protected function get_all_settings() {
+ $settings = array();
+
+ foreach( array_keys( $this->get_setting_sections() ) as $section ) {
+ $settings[ $section ] = $this->get_settings( $section );
+ }
+
+ return $settings;
+ }
+
+ public function get_shipping_method_settings() {
+ $settings = $this->get_all_settings();
+ $sections = $this->get_setting_sections();
+
+ $method_settings = array();
+ $include_current_section = false;
+
+ foreach( $settings as $section => $section_settings ) {
+ $global_settings_url = $this->get_edit_link( $section );
+ $default_title = $sections[ $section ];
+
+ foreach( $section_settings as $setting ) {
+ $include = false;
+ $setting = wp_parse_args( $setting, array(
+ 'allow_override' => ( $include_current_section && ! in_array( $setting['type'], array( 'title', 'sectionend' ) ) ) ? true : false,
+ 'type' => '',
+ 'id' => '',
+ 'value' => '',
+ 'title_method' => '',
+ 'title' => ''
+ ) );
+
+ if ( true === $setting['allow_override'] ) {
+ $include = true;
+
+ if ( 'title' === $setting['type'] ) {
+ $include_current_section = true;
+ }
+ } elseif ( $include_current_section && ! in_array( $setting['type'], array( 'title', 'sectionend' ) ) && false !== $setting['allow_override'] ) {
+ $include = true;
+ } elseif( in_array( $setting['type'], array( 'title', 'sectionend' ) ) ) {
+ $include_current_section = false;
+ }
+
+ if ( $include ) {
+ $new_setting = array();
+ $new_setting['id'] = $this->get_name() . '_' . $setting['id'];
+ $new_setting['type'] = str_replace( 'gzd_toggle', 'checkbox', $setting['type'] );
+ $new_setting['default'] = $setting['value'];
+
+ if ( 'checkbox' === $new_setting['type'] ) {
+ $new_setting['label'] = $setting['desc'];
+ } elseif ( isset( $setting['desc'] ) ) {
+ $new_setting['description'] = $setting['desc'];
+ }
+
+ $copy = array( 'options', 'title', 'desc_tip' );
+
+ foreach ( $copy as $cp ) {
+ if ( isset( $setting[ $cp ] ) ) {
+ $new_setting[ $cp ] = $setting[ $cp ];
+ }
+ }
+
+ if( 'title' === $new_setting['type'] ) {
+ $new_setting['description'] = sprintf( _x( 'These settings override your global %2$s options. Do only adjust these settings in case you would like to specifically adjust them for this specific shipping method.', 'shipments', 'woocommerce-germanized' ), $global_settings_url, $this->get_title() );
+
+ if ( empty( $setting['title'] ) ) {
+ $new_setting['title'] = $default_title;
+ }
+
+ if ( ! empty( $setting['title_method'] ) ) {
+ $new_setting['title'] = $setting['title_method'];
+ }
+ }
+
+ $method_settings[ $new_setting['id'] ] = $new_setting;
+ }
+ }
+ }
+
+ return $method_settings;
+ }
+
+ public function get_setting_sections() {
+ $sections = array(
+ '' => _x( 'General', 'shipments', 'woocommerce-germanized' ),
+ );
+
+ if ( $this->supports_customer_return_requests() ) {
+ $sections['returns'] = _x( 'Return Requests', 'shipments', 'woocommerce-germanized' );
+ }
+
+ return $sections;
+ }
+
+ public function save() {
+ return parent::save();
+ }
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment
+ *
+ * @return ShipmentLabel|false
+ */
+ public function get_label( $shipment ) {
+ return apply_filters( "{$this->get_hook_prefix()}label", false, $shipment, $this );
+ }
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment
+ */
+ public function get_label_fields_html( $shipment ) {
+ return apply_filters( "{$this->get_hook_prefix()}label_fields_html", '', $shipment, $this );
+ }
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment
+ * @param mixed $props
+ */
+ public function create_label( $shipment, $props = false ) {
+ $result = new \WP_Error( 'shipping-provider', _x( 'This shipping provider does not support creating labels.', 'shipments', 'woocommerce-germanized' ) );
+
+ return $result;
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/SimpleShipment.php b/packages/woocommerce-germanized-shipments/src/SimpleShipment.php
new file mode 100644
index 000000000..6fd7ffca4
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/SimpleShipment.php
@@ -0,0 +1,382 @@
+ 0,
+ );
+
+ /**
+ * Returns the shipment type.
+ *
+ * @return string
+ */
+ public function get_type() {
+ return 'simple';
+ }
+
+ /**
+ * Returns the order id belonging to the shipment.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return integer
+ */
+ public function get_order_id( $context = 'view' ) {
+ return $this->get_prop( 'order_id', $context );
+ }
+
+ /**
+ * Set shipment order id.
+ *
+ * @param string $order_id The order id.
+ */
+ public function set_order_id( $order_id ) {
+ // Reset order object
+ $this->order = null;
+
+ $this->set_prop( 'order_id', absint( $order_id ) );
+ }
+
+ /**
+ * Set shipment order.
+ *
+ * @param Order $order_shipment The order shipment.
+ */
+ public function set_order_shipment( &$order_shipment ) {
+ $this->order_shipment = $order_shipment;
+ }
+
+ /**
+ * Tries to fetch the order for the current shipment.
+ *
+ * @return bool|WC_Order|null
+ */
+ public function get_order() {
+ if ( is_null( $this->order ) ) {
+ $this->order = ( $this->get_order_id() > 0 ? wc_get_order( $this->get_order_id() ) : false );
+ }
+
+ return $this->order;
+ }
+
+ /**
+ * Returns the order shipment instance. Loads from DB if not yet exists.
+ *
+ * @return bool|Order
+ */
+ public function get_order_shipment() {
+ if ( is_null( $this->order_shipment ) ) {
+ $order = $this->get_order();
+ $this->order_shipment = ( $order ? wc_gzd_get_shipment_order( $order ) : false );
+ }
+
+ return $this->order_shipment;
+ }
+
+ /**
+ * Sync the shipment with it's corresponding order.
+ *
+ * @param array $args
+ *
+ * @return bool
+ */
+ public function sync( $args = array() ) {
+ try {
+
+ if ( ! $order_shipment = $this->get_order_shipment() ) {
+ throw new Exception( _x( 'Invalid shipment order', 'shipments', 'woocommerce-germanized' ) );
+ }
+
+ /**
+ * Hotfix WCML infinite loop
+ *
+ */
+ if ( function_exists( 'wc_gzd_remove_class_filter' ) ) {
+ wc_gzd_remove_class_filter( 'woocommerce_order_get_items', 'WCML_Orders', 'woocommerce_order_get_items', 10 );
+ }
+
+ $order = $order_shipment->get_order();
+
+ /**
+ * Make sure that manually adjusted providers are not overridden by syncing.
+ */
+ $default_provider_instance = wc_gzd_get_order_shipping_provider( $order );
+ $default_provider = $default_provider_instance ? $default_provider_instance->get_name() : '';
+ $provider = $this->get_shipping_provider( 'edit' );
+ $address_data = array_merge( $order->get_address( 'shipping' ), array( 'email' => $order->get_billing_email(), 'phone' => $order->get_billing_phone() ) );
+
+ /**
+ * Fix to make sure that we are not syncing formatted customer titles (e.g. Herr)
+ * which prevents shipment addresses from being translated.
+ */
+ if ( isset( $address_data['title'] ) && ! empty( $address_data['title'] ) ) {
+ if ( $title = $order->get_meta( "_shipping_title", true ) ) {
+ $address_data['title'] = $title;
+ }
+ }
+
+ /**
+ * Force the country to have a max length of 2.
+ * https://github.com/woocommerce/woocommerce/issues/27521
+ */
+ $country = substr( strtoupper( $order->get_shipping_country() ), 0, 2 );
+
+ $packaging_id = $this->get_packaging_id( 'edit' );
+
+ $dimensions = array(
+ 'width' => $this->get_width( 'edit' ),
+ 'length' => $this->get_length( 'edit' ),
+ 'height' => $this->get_height( 'edit' )
+ );
+
+ $args = wp_parse_args( $args, array(
+ 'order_id' => $order->get_id(),
+ 'shipping_method' => wc_gzd_get_shipment_order_shipping_method_id( $order ),
+ 'shipping_provider' => ( ! empty( $provider ) ) ? $provider : $default_provider,
+ 'packaging_id' => $this->get_packaging_id( 'edit' ),
+ 'address' => $address_data,
+ 'country' => $country,
+ 'weight' => $this->get_weight( 'edit' ),
+ 'packaging_weight' => $this->get_packaging_weight( 'edit' ),
+ 'length' => $dimensions['length'],
+ 'width' => $dimensions['width'],
+ 'height' => $dimensions['height'],
+ 'additional_total' => $this->calculate_additional_total( $order ),
+ ) );
+
+ /**
+ * Filter to allow adjusting the shipment props synced from the corresponding order.
+ *
+ * @param mixed $args The properties in key => value pairs.
+ * @param SimpleShipment $shipment The shipment object.
+ * @param Order $order_shipment The shipment order object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ $args = apply_filters( 'woocommerce_gzd_shipment_sync_props', $args, $this, $order_shipment );
+
+ $this->set_props( $args );
+
+ /**
+ * Action that fires after a shipment has been synced. Syncing is used to
+ * keep the shipment in sync with the corresponding order.
+ *
+ * @param SimpleShipment $shipment The shipment object.
+ * @param Order $order_shipment The shipment order object.
+ * @param array $args Array containing properties in key => value pairs to be updated.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( 'woocommerce_gzd_shipment_synced', $this, $order_shipment, $args );
+
+ } catch ( Exception $e ) {
+ return false;
+ }
+
+ return true;
+ }
+
+ /**
+ * @param WC_Order $order
+ */
+ protected function calculate_additional_total( $order ) {
+ $fees_total = 0;
+ $additional_total = 0;
+
+ // Sum fee costs.
+ foreach ( $order->get_fees() as $item ) {
+ $fees_total += ( $item->get_total() + $item->get_total_tax() );
+ }
+
+ $additional_total = $fees_total + $order->get_shipping_total() + $order->get_shipping_tax();
+
+ return $additional_total;
+ }
+
+ /**
+ * Sync items with the corresponding order items.
+ * Limits quantities and removes non-existing items.
+ *
+ * @param array $args
+ *
+ * @return bool
+ */
+ public function sync_items( $args = array() ) {
+ try {
+
+ if ( ! $order_shipment = $this->get_order_shipment() ) {
+ throw new Exception( _x( 'Invalid shipment order', 'shipments', 'woocommerce-germanized' ) );
+ }
+
+ $order = $order_shipment->get_order();
+
+ $args = wp_parse_args( $args, array(
+ 'items' => array(),
+ ) );
+
+ $available_items = $order_shipment->get_available_items_for_shipment( array(
+ 'shipment_id' => $this->get_id(),
+ 'exclude_current_shipment' => true,
+ ) );
+
+ foreach( $available_items as $item_id => $item_data ) {
+
+ if ( $order_item = $order->get_item( $item_id ) ) {
+ $quantity = $item_data['max_quantity'];
+
+ if ( ! empty( $args['items'] ) ) {
+ if ( isset( $args['items'][ $item_id ] ) ) {
+ $new_quantity = absint( $args['items'][ $item_id ] );
+
+ if ( $new_quantity < $quantity ) {
+ $quantity = $new_quantity;
+ }
+ } else {
+ continue;
+ }
+ }
+
+ if ( ! $shipment_item = $this->get_item_by_order_item_id( $item_id ) ) {
+ $shipment_item = wc_gzd_create_shipment_item( $this, $order_item, array( 'quantity' => $quantity ) );
+
+ $this->add_item( $shipment_item );
+ } else {
+ $shipment_item->sync( array( 'quantity' => $quantity ) );
+ }
+ }
+ }
+
+ foreach( $this->get_items() as $item ) {
+
+ // Remove non-existent items
+ if( ! $order_item = $order->get_item( $item->get_order_item_id() ) ) {
+ $this->remove_item( $item->get_id() );
+ }
+ }
+
+ // Sync packaging
+ $this->sync_packaging();
+
+ /**
+ * Action that fires after items of a shipment have been synced.
+ *
+ * @param SimpleShipment $shipment The shipment object.
+ * @param Order $order_shipment The shipment order object.
+ * @param array $args Array containing additional data e.g. items.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( 'woocommerce_gzd_shipment_items_synced', $this, $order_shipment, $args );
+
+ } catch ( Exception $e ) {
+ return false;
+ }
+
+ return true;
+ }
+
+ /**
+ * Returns available shipment methods by checking the corresponding order.
+ *
+ * @return string[]
+ */
+ public function get_available_shipping_methods() {
+ $methods = array();
+
+ if ( $order = $this->get_order() ) {
+ $items = $order->get_shipping_methods();
+
+ foreach( $items as $item ) {
+ $methods[ $item->get_method_id() . ':' . $item->get_instance_id() ] = $item->get_name();
+ }
+ }
+
+ return $methods;
+ }
+
+ /**
+ * Returns the number of items available for shipment.
+ *
+ * @return int|mixed|void
+ */
+ public function get_shippable_item_count() {
+ if ( $order_shipment = $this->get_order_shipment() ) {
+ return $order_shipment->get_shippable_item_count();
+ }
+
+ return 0;
+ }
+
+ /**
+ * Returns whether the Shipment needs additional items or not.
+ *
+ * @param bool|integer[] $available_items
+ *
+ * @return bool
+ */
+ public function needs_items( $available_items = false ) {
+
+ if ( ! $available_items && ( $order = wc_gzd_get_shipment_order( $this->get_order() ) ) ) {
+ $available_items = array_keys( $order->get_available_items_for_shipment() );
+ }
+
+ return ( $this->is_editable() && ! $this->contains_order_item( $available_items ) );
+ }
+
+ /**
+ * Returns the edit shipment URL.
+ *
+ * @return mixed|string|void
+ */
+ public function get_edit_shipment_url() {
+ /**
+ * Filter to adjust the edit Shipment admin URL.
+ *
+ * The dynamic portion of this hook, `$this->get_hook_prefix()` is used to construct a
+ * unique hook for a shipment type.
+ *
+ * Example hook name: woocommerce_gzd_shipment_get_edit_url
+ *
+ * @param string $url The URL.
+ * @param Shipment $this The shipment object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( "{$this->get_hook_prefix()}edit_url", get_admin_url( null, 'post.php?post=' . $this->get_order_id() . '&action=edit&shipment_id=' . $this->get_id() ), $this );
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Validation.php b/packages/woocommerce-germanized-shipments/src/Validation.php
new file mode 100644
index 000000000..3e84d0cfd
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Validation.php
@@ -0,0 +1,215 @@
+get_name() ) {
+ update_option( 'woocommerce_gzd_shipments_default_shipping_provider', '' );
+ }
+ }
+
+ /**
+ * @param $shipment_id
+ * @param $status_from
+ * @param $status_to
+ * @param Shipment $shipment
+ */
+ public static function maybe_update_order_date_shipped( $shipment_id, $status_from, $status_to, $shipment ) {
+ if ( 'simple' === $shipment->get_type() && ( $order = $shipment->get_order() ) ) {
+ self::check_order_shipped( $order );
+ }
+ }
+
+ public static function check_order_shipped( $order ) {
+ if ( $shipment_order = wc_gzd_get_shipment_order( $order ) ) {
+
+ if ( 'shipped' === $shipment_order->get_shipping_status() ) {
+
+ /**
+ * Action that fires as soon as an order has been shipped completely.
+ * That is the case when the order contains all relevant shipments and all the shipments are marked as shipped.
+ *
+ * @param string $order_id The order id.
+ *
+ * @since 3.1.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( 'woocommerce_gzd_shipments_order_shipped', $shipment_order->get_order()->get_id() );
+
+ $shipment_order->get_order()->update_meta_data( '_date_shipped', current_time( 'timestamp', true ) );
+ $shipment_order->get_order()->save();
+ } else {
+ $shipment_order->get_order()->delete_meta_data( '_date_shipped' );
+ $shipment_order->get_order()->save();
+ }
+ }
+ }
+
+ /**
+ * Delete editable shipments if an order is cancelled.
+ *
+ * @param $order_id
+ * @param WC_Order $order
+ */
+ public static function maybe_cancel_shipments( $order_id, $order ) {
+ $shipments = wc_gzd_get_shipments_by_order( $order );
+
+ foreach( $shipments as $shipment ) {
+ if ( $shipment->is_editable() ) {
+ $shipment->delete();
+ }
+ }
+ }
+
+ public static function before_delete_refund( $refund_id ) {
+ if ( $refund = wc_get_order( $refund_id ) ) {
+
+ if ( is_a( $refund, 'WC_Order_Refund' ) ) {
+ self::$current_refund_parent_order = $refund->get_parent_id();
+ }
+ }
+ }
+
+ public static function delete_refund_order( $refund_id ) {
+ if ( self::$current_refund_parent_order !== false ) {
+
+ if ( $order_shipment = wc_gzd_get_shipment_order( self::$current_refund_parent_order ) ) {
+ $order_shipment->validate_shipments();
+ }
+
+ self::$current_refund_parent_order = false;
+ }
+ }
+
+ public static function refresh_refund_order( $refund ) {
+ if ( $refund->get_parent_id() <= 0 ) {
+ return;
+ }
+
+ if ( $order_shipment = wc_gzd_get_shipment_order( $refund->get_parent_id() ) ) {
+ $order_shipment->validate_shipments();
+ }
+ }
+
+ public static function delete_order( $order_id ) {
+ if ( $order_shipment = wc_gzd_get_shipment_order( $order_id ) ) {
+
+ foreach( $order_shipment->get_shipments() as $shipment ) {
+
+ if ( $shipment->is_editable() ) {
+ $order_shipment->remove_shipment( $shipment->get_id() );
+ }
+ }
+
+ $order_shipment->save();
+ }
+ }
+
+ public static function new_order( $order_id ) {
+ if ( $order_shipment = wc_gzd_get_shipment_order( $order_id ) ) {
+ $order_shipment->validate_shipments();
+ }
+ }
+
+ public static function update_order( $order_id ) {
+ if ( $order_shipment = wc_gzd_get_shipment_order( $order_id ) ) {
+ $order_shipment->validate_shipments();
+ }
+ }
+
+ public static function delete_order_item( $order_item_id ) {
+ try {
+ if ( $order_id = wc_get_order_id_by_order_item_id( $order_item_id ) ) {
+
+ if ( $order_shipment = wc_gzd_get_shipment_order( $order_id ) ) {
+ foreach( $order_shipment->get_shipments() as $shipment ) {
+
+ if ( $shipment->is_editable() ) {
+ if ( $item = $shipment->get_item_by_order_item_id( $order_item_id ) ) {
+ $shipment->remove_item( $item->get_id() );
+ }
+ }
+ }
+
+ $order_shipment->save();
+ }
+ }
+ } catch( Exception $e ) {}
+ }
+
+ public static function create_order_item( $order_item_id, $order_item, $order_id ) {
+ if ( $order_shipment = wc_gzd_get_shipment_order( $order_id ) ) {
+ $order_shipment->validate_shipments();
+ }
+ }
+
+ protected static function is_admin_save_order_request() {
+ $is_admin_order_save_request = doing_action( 'save_post' );
+
+ /**
+ * Detect admin order adjustments e.g. add item, remove item, save post etc. and
+ * prevent singular order item hooks from executing to prevent multiple shipment validation requests
+ * which will execute on order save hook as well.
+ */
+ if ( ! $is_admin_order_save_request && is_ajax() && isset( $_REQUEST['action'] ) && isset( $_REQUEST['order_id'] ) && strpos( $_REQUEST['action'], 'woocommerce_' ) !== false ) {
+ $is_admin_order_save_request = true;
+ }
+
+ return $is_admin_order_save_request;
+ }
+
+ /**
+ * @param $order_item_id
+ * @param WC_Order_Item $order_item
+ */
+ public static function update_order_item( $order_item_id, $order_item ) {
+ if ( ! self::is_admin_save_order_request() ) {
+ if ( is_callable( array( $order_item, 'get_order_id' ) ) ) {
+
+ if ( $order_shipment = wc_gzd_get_shipment_order( $order_item->get_order_id() ) ) {
+ $order_shipment->validate_shipments();
+ }
+ }
+ }
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/WPMLHelper.php b/packages/woocommerce-germanized-shipments/src/WPMLHelper.php
new file mode 100644
index 000000000..87d044101
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/WPMLHelper.php
@@ -0,0 +1,122 @@
+ $title ) {
+ $title = sprintf( $title, $provider->get_title() );
+ $getter = "get_{$string_name}";
+
+ if ( is_callable( array( $provider, $getter ) ) ) {
+ $value = $provider->{$getter}();
+
+ do_action( 'wpml_register_string', $value, self::get_shipping_provider_string_id( $string_name, $provider ), self::get_shipping_provider_string_package( $string_name, $provider ), $title, 'AREA' );
+ }
+ }
+ }
+
+ protected static function get_shipping_provider_strings() {
+ $strings = array(
+ 'tracking_desc_placeholder' => _x( '%s tracking description', 'shipments', 'woocommerce-germanized' ),
+ 'tracking_url_placeholder' => _x( '%s tracking URL', 'shipments', 'woocommerce-germanized' ),
+ 'return_instructions' => _x( '%s return instructions', 'shipments', 'woocommerce-germanized' ),
+ );
+
+ return $strings;
+ }
+
+ /**
+ * @param $string_name
+ * @param ShippingProvider $provider
+ */
+ protected static function get_shipping_provider_string_id( $string_name, $provider ) {
+ return "woocommerce_gzd_shipping_provider_{$provider->get_name()}_{$string_name}";
+ }
+
+ /**
+ * @param $string_name
+ * @param ShippingProvider $provider
+ */
+ protected static function get_shipping_provider_string_package( $string_name, $provider ) {
+ $strings = self::get_shipping_provider_strings();
+ $package = array();
+
+ if ( array_key_exists( $string_name, $strings ) ) {
+ $title = sprintf( $strings[ $string_name ], $provider->get_title() );
+
+ $package = array(
+ 'kind' => 'Shipping Provider',
+ 'name' => "{$provider->get_name()}_{$string_name}",
+ 'edit_link' => $provider->get_edit_link(),
+ 'title' => $title,
+ );
+ }
+
+ return $package;
+ }
+
+ /**
+ * @param $emails
+ */
+ public static function register_emails( $emails ) {
+ $emails['WC_GZD_Email_Customer_Shipment'] = 'customer_shipment';
+ $emails['WC_GZD_Email_Customer_Return_Shipment'] = 'customer_return_shipment';
+ $emails['WC_GZD_Email_Customer_Return_Shipment_Delivered'] = 'customer_return_shipment_delivered';
+ $emails['WC_GZD_Email_Customer_Guest_Return_Shipment_Request'] = 'customer_guest_return_shipment_request';
+
+ return $emails;
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/templates/emails/admin-new-return-shipment-request.php b/packages/woocommerce-germanized-shipments/templates/emails/admin-new-return-shipment-request.php
new file mode 100644
index 000000000..5dcd06ebe
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/templates/emails/admin-new-return-shipment-request.php
@@ -0,0 +1,60 @@
+
+
+
+ get_formatted_sender_full_name() ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>
+ + + +get_billing_first_name() ); ?>
+ ++ get_order_number() ); ?> +
+ + + + + + + +get_billing_first_name() ); ?>
+ ++ +
+ + + +get_billing_first_name() ); ?>
+ ++ +
+ + + +get_billing_first_name() ); ?>
+ ++ +
+get_shipping_provider_instance(); +?> + +has_return_instructions() ) : ?> +get_return_instructions() ) ) . PHP_EOL ); ?>
+ diff --git a/packages/woocommerce-germanized-shipments/templates/emails/email-shipment-address.php b/packages/woocommerce-germanized-shipments/templates/emails/email-shipment-address.php new file mode 100644 index 000000000..753efff2d --- /dev/null +++ b/packages/woocommerce-germanized-shipments/templates/emails/email-shipment-address.php @@ -0,0 +1,34 @@ + + +| + + + + get_formatted_address(); ?> + + | +
+ get_edit_shipment_url() ) . '">'; + $after = ''; + } else { + $before = ''; + $after = ''; + } + /* translators: %s: Order ID. */ + echo wp_kses_post( $before . ( ! $sent_to_admin ? sprintf( _x( 'Details to your %s', 'shipments', 'woocommerce-germanized' ), wc_gzd_get_shipment_label_title( $shipment->get_type() ) ) : sprintf( _x( '[%s #%s]', 'shipments', 'woocommerce-germanized' ), wc_gzd_get_shipment_label_title( $shipment->get_type() ), $shipment->get_shipment_number() ) ) . $after ); + ?> +
+ +
+
+
+
+
+
+
diff --git a/packages/woocommerce-germanized-shipments/templates/emails/email-shipment-items.php b/packages/woocommerce-germanized-shipments/templates/emails/email-shipment-items.php
new file mode 100644
index 000000000..7cf680f65
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/templates/emails/email-shipment-items.php
@@ -0,0 +1,113 @@
+ $item ) :
+ $product = $item->get_product();
+ $sku = $item->get_sku();
+ $purchase_note = '';
+ $image = '';
+
+ /**
+ * Filter to decide whether a specific ShipmentItem is visible within email table or not.
+ *
+ * @param boolean $is_visible Whether the ShipmentItem is visible or not.
+ * @param ShipmentItem $item The ShipmentItem object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ if ( ! apply_filters( 'woocommerce_gzd_shipment_item_visible', true, $item ) ) {
+ continue;
+ }
+
+ if ( is_object( $product ) ) {
+ $image = $product->get_image( $image_size );
+ }
+
+ ?>
+ | + | + |
|---|
|
+
+
+ get_est_delivery_date() ) : ?>
+ get_est_delivery_date(), wc_date_format() ); ?> + + + get_tracking_url() ) : ?> + + + + has_tracking_instruction() ) : ?> +get_tracking_instruction(); ?> + + |
+
| + + |
|---|
| + + + + + + get_type() ), $shipment->get_shipment_number() ) ); ?> + + + + + + + get_status() ) ); ?> + + get_tracking_url() && ! $shipment->has_status( 'delivered' ) ) : ?> + + + + + + $action ) { // phpcs:ignore WordPress.WP.GlobalVariablesOverride.OverrideProhibited + echo '' . esc_html( $action['name'] ) . ''; + } + } + ?> + + | + +
+ ' . $shipment->get_shipment_number() . '', // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped + '' . wc_format_datetime( $shipment->get_date_created() ) . '', // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped + '' . wc_gzd_get_shipment_status_name( $shipment->get_status() ) . '' // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped + ); + ?> +
+ + diff --git a/packages/woocommerce-germanized-shipments/templates/shipment/add-return-shipment-item.php b/packages/woocommerce-germanized-shipments/templates/shipment/add-return-shipment-item.php new file mode 100644 index 000000000..b10ce3268 --- /dev/null +++ b/packages/woocommerce-germanized-shipments/templates/shipment/add-return-shipment-item.php @@ -0,0 +1,81 @@ + +get_phone() ); ?>
+ + + get_email() ) : ?> +get_email() ); ?>
+ + + +get_tracking_instruction(); ?>
+ + +| + | + |
|---|
get_return_instructions() ) ) ) ); ?>
+
+
+has_status( 'delivered' ) && ( $label = $shipment->get_label() ) ) : ?>
+
+
+
+
diff --git a/packages/woocommerce-germanized-shipments/woocommerce-germanized-shipments.php b/packages/woocommerce-germanized-shipments/woocommerce-germanized-shipments.php
new file mode 100644
index 000000000..638fb71b0
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/woocommerce-germanized-shipments.php
@@ -0,0 +1,72 @@
+
+
+
+ 0 ) {
+ if ( $.inArray( elementId, exclude_hide_experts ) == -1 ) {
+ showElement = false;
+ }
+ }
+ }
+
+ if ( showElement ) {
+ $( this ).parents( 'tr' ).show();
+ } else {
+ $( this ).parents( 'tr' ).hide();
+ }
+ });
+ },
+
+ onSidebarTitelChange: function() {
+ var $next = $( this ).nextAll( 'table.form-table:first' );
+ $next.find( 'tr:first' ).trigger( 'click' );
+ },
+
+ onSidebarChange: function() {
+ var $sidebar_elem = $( this ).find( '[data-sidebar]' ),
+ $table = $( this ).parents( '.form-table' ),
+ $current_sidebar = $( '.wc-ts-sidebar-active' ),
+ $sidebar = $current_sidebar;
+
+ if ( $sidebar_elem.length <= 0 ) {
+ if ( $table.find( '[data-sidebar]' ).length > 0 ) {
+ $sidebar_elem = $table.find( '[data-sidebar]:first' );
+ }
+ }
+
+ if ( $sidebar_elem.length <= 0 ) {
+ $sidebar = $( '#wc-ts-sidebar-default' );
+ } else {
+ $sidebar = $( '#' + $sidebar_elem.data( 'sidebar' ) );
+ }
+
+ $current_sidebar.removeClass( 'wc-ts-sidebar-active' );
+ $sidebar.addClass( 'wc-ts-sidebar-active' );
+ },
+
+ getSettingsWrapper: function() {
+ var self = trusted_shops.admin;
+ var prefix = self.optionPrefix.replace( '_', '-' );
+
+ return $( '.wc-' + prefix + 'admin-settings' );
+ },
+
+ addNotice: function( type, texts ) {
+ var self = trusted_shops.admin;
+
+ self.getSettingsWrapper().find( '#message' ).remove();
+ self.getSettingsWrapper().prepend( '
+ composer install',
+ '' . esc_html( str_replace( ABSPATH, '', __DIR__ ) ) . ''
+ );
+ ?>
+
' + texts.join( '
' ) + '
'+t.join("
")+"
+
+
diff --git a/packages/woocommerce-trusted-shops/includes/class-wc-trusted-shops-admin.php b/packages/woocommerce-trusted-shops/includes/class-wc-trusted-shops-admin.php
new file mode 100644
index 000000000..27d68d0d1
--- /dev/null
+++ b/packages/woocommerce-trusted-shops/includes/class-wc-trusted-shops-admin.php
@@ -0,0 +1,954 @@
+base = $base;
+
+ add_action( 'woocommerce_ts_before_save', array( $this, 'before_save' ), 0, 1 );
+ add_action( 'woocommerce_ts_after_save', array( $this, 'after_save' ), 0, 1 );
+
+ add_action( 'woocommerce_ts_admin_settings_before', array( $this, 'wpml_notice' ) );
+
+ // Default settings
+ add_filter( 'woocommerce_gzd_installation_default_settings', array( $this, 'set_installation_settings' ), 10, 1 );
+
+ // After Install
+ add_action( 'woocommerce_trusted_shops_installed', array( $this, 'create_attribute' ) );
+
+ // Review Collector
+ add_action( 'admin_init', array( $this, 'review_collector_export_csv' ) );
+ add_action( 'woocommerce_trusted_shops_load_admin_scripts', array( $this, 'load_scripts' ) );
+
+ add_action( 'woocommerce_product_options_general_product_data', array( $this, 'output_fields' ) );
+ add_action( 'woocommerce_product_after_variable_attributes', array( $this, 'output_variation_fields' ), 20, 3 );
+ add_action( 'woocommerce_save_product_variation', array( $this, 'save_variation_fields' ) , 0, 2 );
+
+ if ( ! wc_ts_woocommerce_supports_crud() ) {
+ add_action( 'woocommerce_process_product_meta', array( $this, 'save_fields' ), 20, 2 );
+ } else {
+ add_action( 'woocommerce_admin_process_product_object', array( $this, 'save_fields' ), 10, 1 );
+ }
+ }
+
+ public function set_installation_settings( $settings ) {
+ return array_merge( $settings, $this->get_settings() );
+ }
+
+ public function wpml_notice() {
+ if ( $this->base->is_multi_language_setup() ) {
+ $is_default_language = false;
+ $compatibility = $this->base->get_multi_language_compatibility();
+ $default_language = strtoupper( $compatibility->get_default_language() );
+ $current_language = strtoupper( $compatibility->get_current_language() );
+
+ if ( $current_language == $default_language ) {
+ $is_default_language = true;
+ }
+
+ include_once( 'admin/views/html-wpml-notice.php' );
+ }
+ }
+
+ public function output_variation_fields( $loop, $variation_data, $variation ) {
+ $_product = wc_get_product( $variation );
+ $_parent = wc_get_product( wc_ts_get_crud_data( $_product, 'parent' ) );
+ $variation_id = wc_ts_get_crud_data( $_product, 'id' );
+ $variation_meta = get_post_meta( $variation_id );
+ $variation_data = array();
+
+ $variation_fields = array(
+ '_ts_gtin' => '',
+ '_ts_mpn' => '',
+ );
+
+ foreach ( $variation_fields as $field => $value ) {
+ $variation_data[ $field ] = isset( $variation_meta[ $field ][0] ) ? maybe_unserialize( $variation_meta[ $field ][0] ) : $value;
+ }
+
+ ?>
+
+ + + + + ' . $current_language . '' ); ?> + +
+
+
+
+ '',
+ '_ts_mpn' => '',
+ );
+
+ foreach ( $data as $k => $v ) {
+ $data_k = 'variable' . ( substr( $k, 0, 1) === '_' ? '' : '_' ) . $k;
+ $data[ $k ] = ( isset( $_POST[ $data_k ][$i] ) ? $_POST[ $data_k ][$i] : null );
+ }
+
+ if ( $product = wc_get_product( $variation_id ) ) {
+ foreach( $data as $key => $value ) {
+ $product = wc_ts_set_crud_data( $product, $key, $value );
+ }
+
+ if ( wc_ts_woocommerce_supports_crud() ) {
+ $product->save();
+ }
+ }
+ }
+
+ public function output_fields() {
+ echo '';
+ }
+
+ public function save_fields( $product ) {
+ if ( is_numeric( $product ) )
+ $product = wc_get_product( $product );
+
+ if ( isset( $_POST['_ts_gtin'] ) ) {
+ $product = wc_ts_set_crud_data( $product, '_ts_gtin', wc_clean( $_POST['_ts_gtin'] ) );
+ }
+
+ if ( isset( $_POST['_ts_mpn'] ) ) {
+ $product = wc_ts_set_crud_data( $product, '_ts_mpn', wc_clean( $_POST['_ts_mpn'] ) );
+ }
+ }
+
+ public function create_attribute() {
+ $attributes = array(
+ 'brand' => _x( 'Brand', 'trusted-shops', 'woocommerce-germanized' ),
+ );
+
+ // Create the taxonomy
+ global $wpdb;
+ delete_transient( 'wc_attribute_taxonomies' );
+
+ foreach ( $attributes as $attribute_name => $title ) {
+ if ( ! in_array( 'pa_' . $attribute_name, wc_get_attribute_taxonomy_names() ) ) {
+ $attribute = array(
+ 'attribute_label' => $title,
+ 'attribute_name' => $attribute_name,
+ 'attribute_type' => 'text',
+ 'attribute_orderby' => 'menu_order',
+ 'attribute_public' => 0
+ );
+
+ $wpdb->insert( $wpdb->prefix . 'woocommerce_attribute_taxonomies', $attribute );
+ delete_transient( 'wc_attribute_taxonomies' );
+ }
+ }
+ }
+
+ public function load_scripts() {
+ $screen = get_current_screen();
+ $suffix = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min';
+ $assets_path = $this->base->plugin->plugin_url() . '/assets/';
+
+ wp_register_style( 'woocommerce-trusted-shops-admin', $assets_path . 'css/admin' . $suffix . '.css', false, $this->base->plugin->version );
+ wp_enqueue_style( 'woocommerce-trusted-shops-admin' );
+
+ wp_register_script( 'wc-admin-trusted-shops', $assets_path . 'js/admin' . $suffix . '.js', array( 'jquery', 'woocommerce_settings' ), $this->base->plugin->version, true );
+ wp_localize_script( 'wc-admin-trusted-shops', 'trusted_shops_params', array(
+ 'option_prefix' => $this->base->option_prefix,
+ 'i18n_error_mandatory' => _x( 'This field is mandatory', 'trusted-shops', 'woocommerce-germanized' ),
+ ) );
+
+ wp_enqueue_script( 'wc-admin-trusted-shops' );
+ }
+
+ public function register_section( $sections ) {
+ $sections['trusted_shops'] = _x( 'Trusted Shops Options', 'trusted-shops', 'woocommerce-germanized' );
+
+ return $sections;
+ }
+
+ public function get_font_families() {
+ return array(
+ 'Arial' => _x( 'Arial', 'trusted-shops', 'woocommerce-germanized' ),
+ 'Geneva' => _x( 'Geneva', 'trusted-shops', 'woocommerce-germanized' ),
+ 'Georgia' => _x( 'Georgia', 'trusted-shops', 'woocommerce-germanized' ),
+ 'Helvetica' => _x( 'Helvetica', 'trusted-shops', 'woocommerce-germanized' ),
+ 'Sans-serif' => _x( 'Sans-serif', 'trusted-shops', 'woocommerce-germanized' ),
+ 'Serif' => _x( 'Serif', 'trusted-shops', 'woocommerce-germanized' ),
+ 'Trebuchet MS' => _x( 'Trebuchet MS', 'trusted-shops', 'woocommerce-germanized' ),
+ 'Verdana' => _x( 'Verdana', 'trusted-shops', 'woocommerce-germanized' ),
+ );
+ }
+
+ public function get_order_statuses() {
+ return wc_get_order_statuses();
+ }
+
+ public function get_translatable_settings() {
+ $translatable = array();
+
+ foreach( $this->get_settings_array() as $setting ) {
+ if ( isset( $setting['id'] ) && ! in_array( $setting['type'], array( 'title', 'sectionend' ) ) ) {
+ $translatable[ $setting['id'] ] = '';
+ }
+ }
+
+ return $translatable;
+ }
+
+ protected function get_settings_array( $defaults = array() ) {
+ $settings = array(
+ array(
+ 'title' => _x( 'Trusted Shops Integration', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc' => sprintf( _x( 'Do you need help with integrating your Trustbadge? %s', 'trusted-shops', 'woocommerce-germanized' ), '' . _x( 'To the step-by-step instructions', 'trusted-shops', 'woocommerce-germanized' ) .'' ),
+ 'type' => 'title',
+ 'id' => 'trusted_shops_options'
+ ),
+
+ array(
+ 'title' => _x( 'Trusted Shops ID', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc' => _x( 'The Trusted Shops ID is a unique identifier for your shop. You can find your Trusted Shops ID in your My Trusted Shops account.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc_tip' => true,
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_id',
+ 'type' => 'text',
+ 'custom_attributes' => array( 'data-sidebar' => 'wc-ts-sidebar-default' ),
+ 'css' => 'min-width:300px;',
+ ),
+
+ array(
+ 'title' => _x( 'Edit Mode', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_integration_mode',
+ 'desc_tip' => _x( 'The advanced configuration is for users with programming skills. Here you can create even more individual settings.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'type' => 'select',
+ 'class' => 'chosen_select',
+ 'options' => array(
+ 'standard' => _x( 'Standard configuration', 'trusted-shops', 'woocommerce-germanized' ),
+ 'expert' => _x( 'Advanced configuration', 'trusted-shops', 'woocommerce-germanized' ),
+ ),
+ 'default' => 'standard',
+ ),
+
+ array( 'type' => 'sectionend', 'id' => 'trusted_shops_options' ),
+
+ array(
+ 'title' => _x( 'Configure your Trustbadge', 'trusted-shops', 'woocommerce-germanized' ),
+ 'type' => 'title',
+ 'id' => 'trusted_shops_badge_options',
+ ),
+
+ array(
+ 'title' => _x( 'Display Trustbadge', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_trustbadge_enable',
+ 'desc_tip' => _x( 'Display the Trustbadge on all the pages of your shop.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'type' => 'ts_toggle',
+ 'custom_attributes' => array( 'data-sidebar' => 'wc-ts-sidebar-trustbadge' ),
+ 'default' => 'no'
+ ),
+
+ array(
+ 'title' => _x( 'Variant', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_trustbadge_variant',
+ 'desc_tip' => _x( 'You can display your Trustbadge with or without Review Stars.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'type' => 'select',
+ 'class' => 'chosen_select',
+ 'options' => array(
+ 'standard' => _x( 'Display Trustbadge with review stars', 'trusted-shops', 'woocommerce-germanized' ),
+ 'hide_reviews' => _x( 'Display Trustbadge without review stars', 'trusted-shops', 'woocommerce-germanized' ),
+ ),
+ 'default' => 'standard'
+ ),
+
+ array(
+ 'title' => _x( 'Vertical Offset', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc_tip' => _x( 'Choose the distance that the Trustbadge will appear from the bottom-right corner of the screen.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_trustbadge_y',
+ 'type' => 'number',
+ 'desc' => _x( 'px', 'trusted-shops', 'woocommerce-germanized' ),
+ 'default' => '0',
+ 'custom_attributes' => array(
+ 'step' => '1',
+ 'min' => 0,
+ 'data-validate' => 'integer',
+ 'data-validate-msg' => sprintf( _x( 'Please choose a non-negative number (at least %d)', 'trusted-shops', 'woocommerce-germanized' ), 0 ),
+ ),
+ 'css' => 'max-width:60px;',
+ ),
+
+ array(
+ 'title' => _x( 'Trustbadge code', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_trustbadge_code',
+ 'type' => 'textarea',
+ 'desc_tip' => true,
+ 'desc' => _x( 'The advanced configuration is for users with programming skills. Here you can create even more individual settings.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'css' => 'width: 100%; min-height: 150px',
+ 'default' => '',
+ ),
+
+ array( 'type' => 'sectionend', 'id' => 'trusted_shops_badge_options' ),
+
+ array(
+ 'title' => _x( 'Configure your Shop Reviews', 'trusted-shops', 'woocommerce-germanized' ),
+ 'type' => 'title',
+ 'id' => 'trusted_shops_review_sticker_options'
+ ),
+
+ array(
+ 'title' => _x( 'Display Shop Review Sticker', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc_tip' => _x( 'To display the Shop Review Sticker, you have to assign the widget "Trusted Shops Review Sticker".', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc' => sprintf( _x( 'Assign widget %s', 'trusted-shops', 'woocommerce-germanized' ), '' . _x( 'here', 'trusted-shops', 'woocommerce-germanized' ) . '' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_review_sticker_enable',
+ 'type' => 'ts_toggle',
+ 'custom_attributes' => array( 'data-sidebar' => 'wc-ts-sidebar-shop-reviews' ),
+ 'default' => 'no'
+ ),
+
+ array(
+ 'title' => _x( 'Background color', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc_tip' => _x( 'Choose the background color for your Review Sticker.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_review_sticker_bg_color',
+ 'type' => 'color',
+ 'default' => '#FFDC0F',
+ ),
+
+ array(
+ 'title' => _x( 'Font', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_review_sticker_font',
+ 'desc_tip' => _x( 'Choose the font for your Review Sticker.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'type' => 'select',
+ 'class' => 'chosen_select',
+ 'default' => 'arial'
+ ),
+
+ array(
+ 'title' => _x( 'Number of reviews displayed', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc_tip' => _x( 'Display x alternating Shop Reviews in your Shop Review Sticker. You can display between 1 and 5 alternating Shop Reviews.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_review_sticker_number',
+ 'type' => 'number',
+ 'desc' => _x( 'Show x alternating reviews', 'trusted-shops', 'woocommerce-germanized' ),
+ 'default' => '5',
+ 'custom_attributes' => array(
+ 'step' => '1',
+ 'min' => 1,
+ 'max' => 5,
+ 'data-validate' => 'integer',
+ 'data-validate-msg' => sprintf( _x( 'Please choose a non-negative number between %d and %d', 'trusted-shops', 'woocommerce-germanized' ),1, 5 ),
+ ),
+ 'css' => 'max-width:60px;',
+ ),
+
+ array(
+ 'title' => _x( 'Minimum rating displayed', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc_tip' => _x( 'Only show Shop Reviews with a minimum rating of x stars. ', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_review_sticker_better_than',
+ 'type' => 'number',
+ 'desc' => _x( 'Star(s)', 'trusted-shops', 'woocommerce-germanized' ),
+ 'default' => '3',
+ 'custom_attributes' => array(
+ 'step' => '1',
+ 'min' => 1,
+ 'max' => 5,
+ 'data-validate' => 'integer',
+ 'data-validate-msg' => sprintf( _x( 'Please choose a non-negative number between %d and %d', 'trusted-shops', 'woocommerce-germanized' ), 1, 5 ),
+ ),
+ 'css' => 'max-width:60px;',
+ ),
+
+ array(
+ 'title' => _x( 'Sticker code', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_review_sticker_code',
+ 'type' => 'textarea',
+ 'desc_tip' => true,
+ 'desc' => _x( 'The advanced configuration is for users with programming skills. Here you can perform even more individual settings.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'css' => 'width: 100%; min-height: 150px',
+ 'default' => '',
+ ),
+
+ array(
+ 'title' => _x( 'Google Organic Search', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc_tip' => _x( 'Activate this option to give Google the opportunity to show your Shop Reviews in Google organic search results.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc' => _x( 'By activating this option, rich snippets will be integrated in the selected pages so your shop review stars may be displayed in Google organic search results. If you use Product Reviews and already activated rich snippets in expert mode, we recommend integrating rich snippets for Shop Reviews on category pages only.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_rich_snippets_enable',
+ 'type' => 'ts_toggle',
+ 'default' => 'no'
+ ),
+
+ array(
+ 'title' => _x( 'Activate rich snippets on', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc' => _x( 'category pages', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_rich_snippets_category',
+ 'type' => 'checkbox',
+ 'default' => 'no',
+ 'checkboxgroup' => 'start',
+ ),
+
+ array(
+ 'desc' => _x( 'product pages', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_rich_snippets_product',
+ 'type' => 'checkbox',
+ 'default' => 'no',
+ 'checkboxgroup' => '',
+ ),
+
+ array(
+ 'desc' => _x( 'homepage (not recommended)', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_rich_snippets_home',
+ 'type' => 'checkbox',
+ 'default' => 'no',
+ 'checkboxgroup' => 'end',
+ ),
+
+ array(
+ 'title' => _x( 'Rich snippets code', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_rich_snippets_code',
+ 'type' => 'textarea',
+ 'desc_tip' => true,
+ 'desc' => _x( 'The advanced configuration is for users with programming skills. Here you can create even more individual settings.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'css' => 'width: 100%; min-height: 150px',
+ 'default' => '',
+ ),
+
+ array( 'type' => 'sectionend', 'id' => 'trusted_shops_review_sticker_options' ),
+
+ array(
+ 'title' => _x( 'Configure your Product Reviews ', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc' => sprintf( _x( 'To use Product Reviews, activate them in your %s first.', 'trusted-shops', 'woocommerce-germanized' ), '' . _x( 'Trusted Shops package', 'trusted-shops', 'woocommerce-germanized' ) .'' ),
+ 'type' => 'title',
+ 'id' => 'trusted_shops_reviews_options'
+ ),
+
+ array(
+ 'title' => _x( 'Collect Product Reviews', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Show Product Reviews on the product page in a separate tab, just as shown on the picture on the right.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_reviews_enable',
+ 'type' => 'ts_toggle',
+ 'custom_attributes' => array( 'data-sidebar' => 'wc-ts-sidebar-product-reviews' ),
+ 'default' => 'no'
+ ),
+
+ array(
+ 'title' => _x( 'Reviews', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc_tip' => _x( 'You can choose a name for the tab with your Product Reviews.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Show Product Reviews on the product detail page in an additional tab.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_product_sticker_enable',
+ 'type' => 'ts_toggle',
+ 'default' => 'no'
+ ),
+
+ array(
+ 'title' => _x( 'Name of Product Reviews tab', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc_tip' => _x( 'You can choose a name for the tab with your Product Reviews.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_product_sticker_tab_text',
+ 'type' => 'text',
+ 'default' => _x( 'Product reviews', 'trusted-shops', 'woocommerce-germanized' ),
+ ),
+
+ array(
+ 'title' => _x( 'Border color', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc_tip' => _x( 'Set the color for the frame around your Product Reviews.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_product_sticker_border_color',
+ 'type' => 'color',
+ 'default' => '#FFDC0F',
+ ),
+
+ array(
+ 'title' => _x( 'Background color', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc_tip' => _x( 'Set the background color for your Product Reviews.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_product_sticker_bg_color',
+ 'type' => 'color',
+ 'default' => '#FFFFFF',
+ ),
+
+ array(
+ 'title' => _x( 'Star color', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc_tip' => _x( 'Set the color for the Product Review stars in your Product Reviews tab.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_product_sticker_star_color',
+ 'type' => 'color',
+ 'default' => '#C0C0C0',
+ ),
+
+ array(
+ 'title' => _x( 'Star size', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_product_sticker_star_size',
+ 'type' => 'number',
+ 'default' => '15',
+ 'desc' => _x( 'px', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc_tip' => _x( 'Set the size for the Product Review stars in your Product Reviews tab.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'css' => 'max-width:60px;',
+ 'custom_attributes' => array(
+ 'step' => '1',
+ 'min' => 0,
+ 'data-validate' => 'integer',
+ 'data-validate-msg' => sprintf( _x( 'Please choose a non-negative number (at least %d)', 'trusted-shops', 'woocommerce-germanized' ), 0 ),
+ ),
+ ),
+
+ array(
+ 'title' => _x( 'Product Sticker Code', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_product_sticker_code',
+ 'desc_tip' => _x( 'The advanced configuration is for users with programming skills. Here you can perform even more individual settings.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'type' => 'textarea',
+ 'css' => 'width: 100%; min-height: 150px',
+ 'default' => '',
+ ),
+
+ array(
+ 'title' => _x( 'jQuerySelector', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc_tip' => _x( 'Please choose where your Product Reviews shall be displayed on the Product detail page.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_product_sticker_selector',
+ 'type' => 'text',
+ 'default' => '#ts_product_sticker',
+ ),
+
+ array(
+ 'title' => _x( 'Rating stars', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Show star ratings on the product detail page below your product name.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc_tip' => _x( 'Display Product Review stars on product pages below the product name, just as shown in the picture on the right.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_product_widget_enable',
+ 'type' => 'ts_toggle',
+ 'default' => 'no'
+ ),
+
+ array(
+ 'title' => _x( 'Star color', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_product_widget_star_color',
+ 'desc_tip' => _x( 'Set the color for the review stars, that are displayed on the product page, below your product name.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'type' => 'color',
+ 'default' => '#FFDC0F',
+ ),
+
+ array(
+ 'title' => _x( 'Star size', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_product_widget_star_size',
+ 'desc_tip' => _x( 'Set the size for the review stars that are displayed on the product page, below your product name.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'type' => 'number',
+ 'default' => '14',
+ 'desc' => _x( 'px', 'trusted-shops', 'woocommerce-germanized' ),
+ 'css' => 'max-width:60px;',
+ 'custom_attributes' => array(
+ 'step' => '1',
+ 'min' => 0,
+ 'data-validate' => 'integer',
+ 'data-validate-msg' => sprintf( _x( 'Please choose a non-negative number (at least %d)', 'trusted-shops', 'woocommerce-germanized' ), 0 ),
+ ),
+ ),
+
+ array(
+ 'title' => _x( 'Font size', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_product_widget_font_size',
+ 'desc_tip' => _x( 'Set the font size for the text that goes with your review stars.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'type' => 'number',
+ 'desc' => _x( 'px', 'trusted-shops', 'woocommerce-germanized' ),
+ 'default' => '12',
+ 'css' => 'max-width:60px;',
+ 'custom_attributes' => array(
+ 'step' => '1',
+ 'min' => 0,
+ 'data-validate' => 'integer',
+ 'data-validate-msg' => sprintf( _x( 'Please choose a non-negative number (at least %d)', 'trusted-shops', 'woocommerce-germanized' ), 0 ),
+ ),
+ ),
+
+ array(
+ 'title' => _x( 'Product Review Code', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc_tip' => _x( 'The advanced configuration is for users with programming skills. Here you can perform even more individual settings.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_product_widget_code',
+ 'type' => 'textarea',
+ 'css' => 'width: 100%; min-height: 150px',
+ 'default' => '',
+ ),
+
+ array(
+ 'title' => _x( 'jQuerySelector', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc_tip' => _x( 'Please choose where your Product Review Stars shall be displayed on the Product Detail page.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_product_widget_selector',
+ 'type' => 'text',
+ 'default' => '#ts_product_widget',
+ ),
+
+ array(
+ 'title' => _x( 'Brand attribute', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc' => sprintf( _x( 'Create brand attribute %s', 'trusted-shops', 'woocommerce-germanized' ), '' . _x( 'here', 'trusted-shops', 'woocommerce-germanized' ) . '' ),
+ 'desc_tip' => _x( 'Brand name of the product. By passing this information on to Google, you improve your chances of having Google identify your products. Assign your brand attribute. If your products don\'t have a GTIN, you can pass on the brand name and the MPN to use Google Integration.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_brand_attribute',
+ 'css' => 'min-width:250px;',
+ 'default' => 'brand',
+ 'type' => 'select',
+ 'class' => 'chosen_select_nostd',
+ 'custom_attributes' => array( 'data-placeholder' => _x( 'None', 'trusted-shops', 'woocommerce-germanized' ) ),
+ ),
+
+ array( 'type' => 'sectionend', 'id' => 'trusted_shops_reviews_options' ),
+ );
+
+ if ( $this->base->supports( 'reminder' ) ) {
+
+ $settings = array_merge( $settings, array(
+
+ array(
+ 'title' => _x( 'Configure your Review Requests', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc' => _x( '7 days after an order has been placed, Trusted Shops automatically sends an invite to your customers. If you want to set a different time for sending automatic Review Requests, please activate the option below. If you want to send review requests with legal certainty, you need your customers\' consent to receive Review Requests. You also have to include an option to unsubscribe.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'type' => 'title',
+ 'id' => 'trusted_shops_review_reminder_options',
+ ),
+
+ array(
+ 'title' => _x( 'Enable Review Requests', 'trusted-shops', 'woocommerce-germanized' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_review_reminder_enable',
+ 'type' => 'ts_toggle',
+ 'default' => 'no',
+ 'custom_attributes' => array( 'data-sidebar' => 'wc-ts-sidebar-review-reminder' ),
+ 'autoload' => false
+ ),
+
+ array(
+ 'title' => _x( 'WooCommerce status', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc_tip' => _x( 'We recommend choosing the order status that you set when your products have been shipped.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'default' => array( 'wc-completed' ),
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_review_reminder_status',
+ 'type' => 'multiselect',
+ 'class' => 'chosen_select',
+ ),
+
+ array(
+ 'title' => _x( 'Days until Review Request', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc_tip' => _x( 'Set the number of days to wait after an order has reached the order status you selected above before having a review request sent to your customers.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'default' => 7,
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_review_reminder_days',
+ 'type' => 'number',
+ 'custom_attributes' => array(
+ 'step' => '1',
+ 'min' => 0,
+ 'data-validate' => 'integer',
+ ),
+ ),
+
+ array(
+ 'title' => _x( 'Permission via checkbox', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc_tip' => _x( 'If the checkbox is activated, only customers who gave their consent will receive Review Requests.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'default' => '',
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_review_reminder_checkbox',
+ 'type' => 'html',
+ 'html' => '' . _x( 'Edit checkbox', 'trusted-shops', 'woocommerce-germanized' ) . '',
+ ),
+
+ array(
+ 'title' => _x( 'Unsubscribe via link', 'trusted-shops', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Allows the customer to unsubscribe from Review Requests.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'default' => 'yes',
+ 'id' => 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_review_reminder_opt_out',
+ 'type' => 'ts_toggle',
+ ),
+
+ array( 'type' => 'sectionend', 'id' => 'trusted_shops_review_reminder_options' ),
+
+ ) );
+ }
+
+ if ( ! empty( $defaults ) ) {
+ foreach( $settings as $key => $setting ) {
+ if ( isset( $setting['id'] ) ) {
+ foreach( $defaults as $setting_id => $default ) {
+ if ( $setting_id === $setting['id'] ) {
+ $settings[ $key ] = array_replace_recursive( $setting, $default );
+ }
+ }
+ }
+ }
+ }
+
+ return $settings;
+ }
+
+ /**
+ * Get Trusted Shops related Settings for Admin Interface
+ *
+ * @return array
+ */
+ public function get_settings() {
+
+ $attributes = wc_get_attribute_taxonomies();
+ $linked_attributes = array();
+
+ // Set attributes
+ foreach ( $attributes as $attribute ) {
+ $linked_attributes[ $attribute->attribute_name ] = $attribute->attribute_label;
+ }
+
+ // Add empty option placeholder to allow clearing
+ $linked_attributes = array_merge( array( '' => '' ), $linked_attributes );
+
+ $update_settings = array(
+ 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_trustbadge_code' => array(
+ 'default' => $this->base->get_trustbadge_code( false ),
+ ),
+ 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_review_sticker_font' => array(
+ 'options' => $this->get_font_families(),
+ ),
+ 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_review_sticker_code' => array(
+ 'default' => $this->base->get_review_sticker_code( false ),
+ ),
+ 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_rich_snippets_code' => array(
+ 'default' => $this->base->get_rich_snippets_code( false ),
+ ),
+ 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_product_sticker_code' => array(
+ 'default' => $this->base->get_product_sticker_code( false ),
+ ),
+ 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_product_widget_code' => array(
+ 'default' => $this->base->get_product_widget_code( false ),
+ ),
+ 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_brand_attribute' => array(
+ 'options' => $linked_attributes,
+ ),
+ );
+
+ if ( $this->base->supports( 'reminder' ) ) {
+ $update_settings['woocommerce_' . $this->base->option_prefix . 'trusted_shops_review_reminder_status'] = array(
+ 'options' => $this->get_order_statuses(),
+ );
+ }
+
+ $settings = $this->get_settings_array( $update_settings );
+
+ return $settings;
+ }
+
+ public function get_image( $img ) {
+ $language = $this->base->get_language();
+ $endings = array( '.jpg', '.png' );
+ $last = substr( $img, -4 );
+ $ending = '';
+
+ if ( in_array( $last, $endings ) ) {
+ $ending = $last;
+ $img = substr( $img, 0, -4 );
+ }
+
+ $new_img = $img . '_' . $language . $ending;
+
+ return $this->base->plugin->plugin_url() . '/assets/images/ts/' . $new_img;
+ }
+
+ public function get_sidebar() {
+ ob_start();
+ ?>
+
+ base->option_prefix . 'trusted_shops_id'] ) && $_POST['woocommerce_' . $this->base->option_prefix . 'trusted_shops_id'] != $this->base->id ) {
+ update_option( '_woocommerce_' . $this->base->option_prefix . 'trusted_shops_update_reviews', 1 );
+ }
+ }
+
+ public function after_save( $settings ) {
+ $this->base->refresh();
+
+ if ( get_option( 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_integration_mode' ) === 'standard' ) {
+
+ // Delete code snippets
+ delete_option( 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_trustbadge_code' );
+ delete_option( 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_product_sticker_code' );
+ delete_option( 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_product_widget_code' );
+ delete_option( 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_rich_snippets_code' );
+ delete_option( 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_review_sticker_code' );
+ }
+
+ // Disable Reviews if Trusted Shops review collection has been enabled
+ if ( get_option( 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_reviews_enable' ) === 'yes' ) {
+ update_option( 'woocommerce_enable_review_rating', 'no' );
+ }
+
+ if ( get_option( '_woocommerce_' . $this->base->option_prefix . 'trusted_shops_update_reviews' ) ) {
+ $this->base->get_dependency( 'schedule' )->update_reviews();
+ }
+
+ delete_option( '_woocommerce_' . $this->base->option_prefix . 'trusted_shops_update_reviews' );
+ }
+
+ public function review_collector_export_csv() {
+ if ( ! current_user_can( 'manage_woocommerce' ) )
+ return;
+
+ if ( ! isset( $_GET['action'] ) || $_GET['action'] != 'wc_' . $this->base->option_prefix . 'trusted-shops-export' || ( isset( $_GET['action'] ) && $_GET['action'] == 'wc_' . $this->base->option_prefix . 'trusted-shops-export' && ! wp_verify_nonce( $_REQUEST['_wpnonce'], 'wc_' . $this->base->option_prefix . 'trusted-shops-export' ) ) )
+ return;
+
+ $interval_d = ( ( isset( $_GET['interval'] ) && ! empty( $_GET['interval'] ) ) ? absint( $_GET['interval'] ) : 30 );
+ $days_to_send = ( ( isset( $_GET['days'] ) && ! empty( $_GET['days'] ) ) ? absint( $_GET['days'] ) : 5 );
+ $status = ( ( isset( $_GET['status'] ) && ! empty( $_GET['status'] ) ) ? wc_clean( $_GET['status'] ) : '' );
+
+ update_option( 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_review_collector_days_to_send', $days_to_send );
+ update_option( 'woocommerce_' . $this->base->option_prefix . 'trusted_shops_review_collector', $interval_d );
+
+ if ( wc_ts_woocommerce_supports_crud() ) {
+ include_once( 'class-wc-trusted-shops-review-exporter.php' );
+
+ $exporter = new WC_Trusted_Shops_Review_Exporter();
+ $exporter->set_days_until_send( $days_to_send );
+ $exporter->set_interval_days( $interval_d );
+
+ if ( ! empty( $status ) ) {
+ $exporter->set_statuses( array( $status ) );
+ }
+
+ if ( isset( $_GET['lang'] ) && ! empty( $_GET['lang'] ) ) {
+ $exporter->set_lang( wc_clean( $_GET['lang'] ) );
+ }
+
+ $exporter->export();
+ }
+ }
+
+ public function review_collector_export() {
+
+ $href_org = admin_url();
+ $href_org = add_query_arg( array(
+ 'action' => 'wc_' . $this->base->option_prefix . 'trusted-shops-export',
+ '_wpnonce' => wp_create_nonce( 'wc_' . $this->base->option_prefix . 'trusted-shops-export' ),
+ 'lang' => $this->base->is_multi_language_setup() ? $this->base->get_multi_language_compatibility()->get_current_language() : '',
+ ), $href_org );
+
+ if ( ! wc_ts_woocommerce_supports_crud() )
+ return;
+
+ $days_interval = get_option( 'woocommerce_gzd_trusted_shops_review_collector', 30 );
+ $days_to_send = get_option( 'woocommerce_gzd_trusted_shops_review_collector_days_to_send', 5 );
+ ?>
+
+ + + +
++ + +
+; ?>)
; ?>)
+
+ ; ?>)
+
+ ; ?>)
+ ; ?>)
+
+
+ ; ?>)
+
+
+
+ get_trusted_url( 'https://www.trustedshops.com/tsb2b/sa/ratings/reviewCollector/reviewCollector.seam' ) . '" target="_blank">' . _x( 'My Trusted Shops account', 'trusted-shops', 'woocommerce-germanized' ) . '' ); ?>
+| + + | +
+
+ get_trusted_url( 'https://www.trustedshops.com/tsb2b/sa/ratings/reviewCollector/reviewCollector.seam' ) . '" target="_blank">' . _x( 'here', 'trusted-shops', 'woocommerce-germanized' ) . '' ); ?>
+
+
+
+
+
+
+
+ |
+
|---|
' . $html . '
' : '';
+ }
+
+ /**
+ * Returns Trusted Shops Badge html
+ *
+ * @param array $atts
+ * @return string
+ */
+ public function trusted_shops_badge( $atts ) {
+ extract( shortcode_atts( array('width' => ''), $atts ) );
+
+ return $this->base->is_enabled() ? '' : '';
+ }
+
+}
diff --git a/packages/woocommerce-trusted-shops/includes/class-wc-trusted-shops-template-hooks.php b/packages/woocommerce-trusted-shops/includes/class-wc-trusted-shops-template-hooks.php
new file mode 100644
index 000000000..6752bec00
--- /dev/null
+++ b/packages/woocommerce-trusted-shops/includes/class-wc-trusted-shops-template-hooks.php
@@ -0,0 +1,251 @@
+base = $base;
+
+ // Load hooks on init so that language-specific settings are loaded
+ add_action( 'init', array( $this, 'init' ), 10 );
+
+ // Always register checkbox to avoid language problems
+ add_action( 'woocommerce_gzd_register_legal_core_checkboxes', array( $this, 'review_reminder_checkbox' ), 30 );
+ }
+
+ public function init() {
+ if ( $this->base->is_enabled() ) {
+ add_action( 'woocommerce_thankyou', array( $this, 'template_thankyou' ), 10, 1 );
+ add_action( 'wp_footer', array( $this, 'template_trustbadge' ), 250 );
+ }
+
+ if ( $this->base->product_reviews_visible() ) {
+ add_filter( 'woocommerce_product_tabs', array( $this, 'remove_review_tab' ), 40, 1 );
+ }
+
+ if ( $this->base->is_product_sticker_enabled() ) {
+ add_filter( 'woocommerce_product_tabs', array( $this, 'review_tab' ), 50, 1 );
+ }
+
+ if ( $this->base->is_product_widget_enabled() ) {
+ add_filter( 'woocommerce_trusted_shops_template_name', array( $this, 'set_product_widget_template' ), 50, 1 );
+ }
+
+ if ( $this->base->is_rich_snippets_enabled() ) {
+ add_action( 'wp_footer', array( $this, 'insert_rich_snippets' ), 20 );
+ }
+
+ // Save Fields on order
+ if ( $this->base->is_review_reminder_enabled() ) {
+ add_action( 'woocommerce_checkout_update_order_meta', array( $this, 'update_order_meta' ) );
+
+ if ( 'yes' === $this->base->review_reminder_opt_out ) {
+ // Email notices right beneath order table
+ add_action( 'woocommerce_email_after_order_table', array( $this, 'email_cancel_review_reminder' ), 8, 3 );
+ add_filter( 'woocommerce_email_styles', array( $this, 'email_styles' ) );
+
+ // Check for customer activation
+ add_action( 'template_redirect', array( $this, 'cancel_review_reminder_check' ) );
+ }
+ }
+ }
+
+ public function insert_rich_snippets() {
+ $insert = false;
+
+ if ( in_array( 'category', $this->base->get_rich_snippets_locations() ) ) {
+ if ( is_product_category() ) {
+ $insert = true;
+ }
+ }
+
+ if ( in_array( 'home', $this->base->get_rich_snippets_locations() ) ) {
+ if ( function_exists( 'is_shop' ) && is_shop() ) {
+ $insert = true;
+ }
+ }
+
+ if ( in_array( 'product', $this->base->get_rich_snippets_locations() ) ) {
+ if ( is_product() ) {
+ $insert = true;
+ }
+ }
+
+ if ( $insert ) {
+ echo do_shortcode( '[trusted_shops_rich_snippets]' );
+ }
+ }
+
+ public function cancel_review_reminder_check() {
+ if ( isset( $_GET['disable-review-reminder'] ) && isset( $_GET['order-id'] ) ) {
+
+ $order_id = absint( $_GET['order-id'] );
+ $code = wc_clean( $_GET['disable-review-reminder'] );
+
+ if ( ! empty( $code ) && ! empty( $order_id ) ) {
+
+ $order_query = new WP_Query( array(
+ 'post_type' => 'shop_order',
+ 'p' => $order_id,
+ 'post_status' => array_keys( wc_get_order_statuses() ),
+ 'posts_per_page' => 1,
+ 'meta_query' => array(
+ 'code' => array(
+ 'key' => '_ts_cancel_review_reminder_code',
+ 'compare' => '=',
+ 'value' => $code,
+ ),
+ ),
+ ) );
+
+ while ( $order_query->have_posts() ) {
+ $order_query->next_post();
+ $order = wc_get_order( $order_query->post->ID );
+
+ if ( $order ) {
+ $order_id = wc_ts_get_crud_data( $order, 'id' );
+
+ delete_post_meta( $order_id, '_ts_cancel_review_reminder_code' );
+ delete_post_meta( $order_id, '_ts_review_reminder_opted_in' );
+
+ wp_die( sprintf( _x( 'Your review reminder e-mail has been cancelled successfully. Return to %s.', 'trusted-shops', 'woocommerce-germanized' ), '' . _x( 'Home', 'trusted-shops', 'woocommerce-germanized' ) . '' ) );
+ }
+ }
+ }
+ }
+ }
+
+ public function email_styles( $css ) {
+ $css .= '
+ .wc-ts-cancel-review-reminder {
+ margin-top: 16px;
+ }
+ ';
+
+ return $css;
+ }
+
+ public function get_cancel_review_reminder_link( $order ) {
+ $code = wc_ts_get_crud_data( $order, 'ts_cancel_review_reminder_code' );
+
+ if ( ! $code || empty( $code ) ) {
+ global $wp_hasher;
+
+ if ( empty( $wp_hasher ) ) {
+ require_once ABSPATH . WPINC . '/class-phpass.php';
+ $wp_hasher = new PasswordHash( 8, true );
+ }
+
+ $code = $wp_hasher->HashPassword( wp_generate_password( 20 ) );
+
+ update_post_meta( wc_ts_get_crud_data( $order, 'id' ), '_ts_cancel_review_reminder_code', $code );
+ }
+
+ $order_id = wc_ts_get_crud_data( $order, 'id' );
+ $link = add_query_arg( array( 'disable-review-reminder' => $code, 'order-id' => $order_id ), get_site_url() );
+
+ if ( $lang = wc_ts_get_order_language( $order ) ) {
+ $link = add_query_arg( array( 'lang' => $lang ), $link );
+ }
+
+ return apply_filters( 'woocommerce_trusted_shops_cancel_review_reminder_link', $link, $code, $order );
+ }
+
+ public function email_cancel_review_reminder( $order, $sent_to_admin, $plain_text ) {
+ $type = WC_germanized()->emails->get_current_email_object();
+
+ // Try to flush the cache before continuing
+ WC_GZD_Cache_Helper::maybe_flush_cache( 'db', array( 'cache_type' => 'meta', 'meta_type' => 'post', 'meta_key' => 'ts_review_reminder_opted_in' ) );
+ $opted_in = wc_ts_get_crud_data( $order, 'ts_review_reminder_opted_in' );
+
+ if ( $type && 'yes' === $opted_in && 'customer_processing_order' === $type->id ) {
+ wc_get_template( 'emails/cancel-review-reminder.php', array( 'link' => $this->get_cancel_review_reminder_link( $order ) ) );
+ }
+ }
+
+ public function update_order_meta( $order_id ) {
+ $checkbox = wc_gzd_get_legal_checkbox( 'review_reminder' );
+
+ if ( isset( $_POST['review_reminder'] ) || ! $checkbox || ( $checkbox && ! $checkbox->is_enabled() ) ) {
+ update_post_meta( $order_id, '_ts_review_reminder_opted_in', 'yes' );
+ }
+ }
+
+ public function review_reminder_checkbox() {
+ if ( ! function_exists( 'wc_gzd_register_legal_checkbox' ) ) {
+ return;
+ }
+
+ wc_gzd_register_legal_checkbox( 'review_reminder', array(
+ 'html_id' => 'review-reminder',
+ 'html_name' => 'review_reminder',
+ 'html_wrapper_classes' => array( 'legal' ),
+ 'label' => _x( 'Yes, I would like to be reminded via e-mail after {days} day(s) to review my order. I am able to cancel the reminder at any time by clicking on the "cancel review reminder" link within the order confirmation.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'label_args' => array( '{days}' => $this->base->review_reminder_days ),
+ 'hide_input' => false,
+ 'is_enabled' => false,
+ 'is_mandatory' => false,
+ 'error_message' => _x( 'Please allow us to send a review reminder by e-mail.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'priority' => 6,
+ 'is_core' => true,
+ 'admin_name' => _x( 'Review reminder', 'trusted-shops', 'woocommerce-germanized' ),
+ 'admin_desc' => _x( 'Asks the customer to receive a Trusted Shops review reminder.', 'trusted-shops', 'woocommerce-germanized' ),
+ 'locations' => array( 'checkout' ),
+ ) );
+ }
+
+ public function set_product_widget_template( $template ) {
+
+ if ( in_array( $template, array( 'single-product/rating.php' ) ) ) {
+ $template = 'trusted-shops/product-widget.php';
+ }
+
+ return $template;
+ }
+
+ public function remove_review_tab( $tabs ) {
+ if ( isset( $tabs['reviews'] ) )
+ unset( $tabs['reviews'] );
+
+ return $tabs;
+ }
+
+ public function review_tab( $tabs ) {
+ $tabs['trusted_shops_reviews'] = array(
+ 'title' => $this->base->product_sticker_tab_text,
+ 'priority' => 30,
+ 'callback' => array( $this, 'template_product_sticker' ),
+ );
+ return $tabs;
+ }
+
+ public function template_review_sticker( $template ) {
+ wc_get_template( 'trusted-shops/review-sticker.php', array( 'plugin' => $this->base, 'element' => '#ts_review_sticker' ) );
+ }
+
+ public function template_product_sticker( $template ) {
+ wc_get_template( 'trusted-shops/product-sticker.php', array( 'plugin' => $this->base ) );
+ }
+
+ public function template_trustbadge() {
+ wc_get_template( 'trusted-shops/trustbadge.php', array( 'plugin' => $this->base ) );
+ }
+
+ public function template_thankyou( $order_id ) {
+ wc_get_template( 'trusted-shops/thankyou.php', array(
+ 'order_id' => $order_id,
+ 'plugin' => $this->base,
+ ) );
+ }
+
+}
diff --git a/packages/woocommerce-trusted-shops/includes/class-wc-trusted-shops-widgets.php b/packages/woocommerce-trusted-shops/includes/class-wc-trusted-shops-widgets.php
new file mode 100644
index 000000000..e17bf409d
--- /dev/null
+++ b/packages/woocommerce-trusted-shops/includes/class-wc-trusted-shops-widgets.php
@@ -0,0 +1,33 @@
+base = $base;
+
+ add_action( 'widgets_init', array( $this, 'include_widgets' ), 25 );
+ }
+
+ public function include_widgets() {
+ if ( $this->base->is_review_sticker_enabled() ) {
+ $this->register_widget( 'review_sticker' );
+ }
+ }
+
+ private function register_widget( $name ) {
+ $classname = $this->base->get_dependency_name( 'widget_' . $name );
+ include_once( 'widgets/class-' . strtolower( str_replace( '_', '-', $classname ) ) . '.php' );
+ register_widget( $classname );
+ }
+
+}
diff --git a/packages/woocommerce-trusted-shops/includes/class-wc-trusted-shops.php b/packages/woocommerce-trusted-shops/includes/class-wc-trusted-shops.php
new file mode 100644
index 000000000..fc8dd10ea
--- /dev/null
+++ b/packages/woocommerce-trusted-shops/includes/class-wc-trusted-shops.php
@@ -0,0 +1,659 @@
+plugin = $plugin;
+
+ $args = wp_parse_args( $params, array(
+ 'et_params' => array(),
+ 'signup_params' => array(),
+ 'prefix' => '',
+ 'signup_url' => '',
+ 'supports' => array( 'reminder' ),
+ 'path' => dirname( __FILE__ ) . '/'
+ ) );
+
+ foreach ( $args as $arg => $val ) {
+ $this->$arg = $val;
+ }
+
+ $this->option_prefix = strtolower( $this->prefix );
+ $this->load();
+ }
+
+ public function load() {
+
+ // Refresh TS ID + API URL
+ $this->refresh();
+ $this->includes();
+
+ add_action( 'init', array( $this, 'refresh' ), 50 );
+
+ if ( is_admin() ) {
+ $this->get_dependency( 'admin' );
+ }
+
+ $this->get_dependency( 'schedule' );
+ $this->get_dependency( 'shortcodes' );
+ $this->get_dependency( 'widgets' );
+ $this->get_dependency( 'template_hooks' );
+
+ if ( $this->is_enabled() ) {
+ add_action( 'wp_enqueue_scripts', array( $this, 'load_frontend_assets' ), 50 );
+
+ if ( is_admin() ) {
+ add_filter( 'woocommerce_gzd_wpml_translatable_options', array( $this, 'register_wpml_options' ), 20, 1 );
+ add_filter( 'woocommerce_gzd_wpml_remove_translation_empty_equal', array( $this, 'stop_wpml_options_string_deletions' ), 20, 4 );
+ }
+ }
+ }
+
+ public function register_wpml_options( $settings ) {
+ $admin = $this->get_dependency( 'admin' );
+
+ return array_merge( $settings, $admin->get_translatable_settings() );
+ }
+
+ /**
+ * Make sure that other languages are not synced with main language e.g. option does not default to main language
+ *
+ * @param $allow
+ * @param $option
+ * @param $new_value
+ * @param $old_value
+ * @return bool
+ */
+ public function stop_wpml_options_string_deletions( $allow, $option, $new_value, $old_value ) {
+ $admin = $this->get_dependency( 'admin' );
+
+ if ( array_key_exists( $option, $admin->get_translatable_settings() ) ) {
+ $allow = false;
+ }
+
+ return $allow;
+ }
+
+ public function includes() {
+ include_once( $this->path . 'wc-ts-core-functions.php' );
+ }
+
+ public function load_frontend_assets() {
+ $suffix = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min';
+ $assets_path = $this->plugin->plugin_url() . '/assets/css';
+
+ wp_register_style( 'woocommerce-trusted-shops', $assets_path . '/layout' . $suffix . '.css', false, $this->plugin->version );
+ wp_enqueue_style( 'woocommerce-trusted-shops' );
+ }
+
+ public function get_dependency_name( $name ) {
+ $classname = 'WC_Trusted_Shops_' . ucwords( str_replace( '-', '_', strtolower( $name ) ) );
+ return $classname;
+ }
+
+ public function get_dependency( $name ) {
+ $classname = $this->get_dependency_name( $name );
+
+ return call_user_func_array( array( $classname, 'instance' ), array( $this ) );
+ }
+
+ public function refresh() {
+ $this->id = $this->__get( 'id' );
+ $this->api_url = 'http://api.trustedshops.com/rest/public/v2/shops/'. $this->id .'/quality.json';
+ }
+
+ public function get_multi_language_compatibility() {
+ return apply_filters( 'woocommerce_trusted_shops_multi_language_compatibility', $this->plugin->get_compatibility( 'wpml-string-translation' ) );
+ }
+
+ public function is_multi_language_setup() {
+ $compatibility = $this->get_multi_language_compatibility();
+
+ return $compatibility->is_activated() ? true : false;
+ }
+
+ /**
+ * Get Trusted Shops Options
+ *
+ * @param string $key
+ * @return mixed
+ */
+ public function __get( $key ) {
+ $option_name = 'woocommerce_' . $this->option_prefix . 'trusted_shops_' . $key;
+ $value = get_option( $option_name );
+
+ /**
+ * By default WPML does not allow empty strings to override default translations.
+ * This snippet manually checks for translations and allows to override default WPML translations.
+ */
+ if ( ! is_admin() && $this->is_multi_language_setup() ) {
+
+ $compatibility = $this->get_multi_language_compatibility();
+
+ $default_language = $compatibility->get_default_language();
+ $current_language = $compatibility->get_current_language();
+
+ if ( $current_language !== $default_language ) {
+ if ( isset( $this->options[ $current_language ][ $key ] ) ) {
+ return $this->options[ $current_language ][ $key ];
+ } else {
+ if ( $string_id = $compatibility->get_string_id( $option_name ) ) {
+ $translation = $compatibility->get_string_translation( $string_id, $current_language );
+
+ if ( false !== $translation ) {
+ $this->options[ $current_language ][ $key ] = $translation;
+ $value = $translation;
+ }
+ }
+ }
+ }
+ }
+
+ return $value;
+ }
+
+ /**
+ * Checks whether a certain Trusted Shops Option isset
+ *
+ * @param string $key
+ * @return boolean
+ */
+ public function __isset( $key ) {
+ return ( ! get_option( 'woocommerce_' . $this->option_prefix . 'trusted_shops_' . $key ) ) ? false : true;
+ }
+
+ /**
+ * Checks whether Trusted Shops is enabled
+ *
+ * @return boolean
+ */
+ public function is_enabled() {
+ return ( $this->id ) ? true : false;
+ }
+
+ public function get_rich_snippets_locations() {
+ $locations = array();
+
+ if ( $this->rich_snippets_category === 'yes' ) {
+ $locations[] = 'category';
+ }
+
+ if ( $this->rich_snippets_product === 'yes' ) {
+ $locations[] = 'product';
+ }
+
+ if ( $this->rich_snippets_home === 'yes' ) {
+ $locations[] = 'home';
+ }
+
+ return $locations;
+ }
+
+ public function is_trustbadge_enabled() {
+ return ( $this->trustbadge_enable === 'yes' && $this->id !== '' ? true : false );
+ }
+
+ /**
+ * Checks whether Trusted Shops Rich Snippets are enabled
+ *
+ * @return boolean
+ */
+ public function is_rich_snippets_enabled() {
+ return ( $this->rich_snippets_enable === 'yes' && $this->is_enabled() ? true : false );
+ }
+
+ /**
+ * Checks whether review widget is enabled
+ *
+ * @return boolean
+ */
+ public function is_review_widget_enabled() {
+ return ( $this->review_widget_enable === 'yes' && $this->is_enabled() ? true : false );
+ }
+
+ public function is_review_reminder_enabled() {
+ return ( $this->review_reminder_enable === 'yes' && $this->supports( 'reminder' ) && $this->is_enabled() ? true : false );
+ }
+
+ public function is_review_reminder_checkbox_enabled() {
+ return ( $this->review_reminder_checkbox === 'yes' && $this->is_review_reminder_enabled() ? true : false );
+ }
+
+ public function product_reviews_visible() {
+ return ( $this->is_enabled() && $this->is_product_sticker_enabled() ? true : false );
+ }
+
+ public function is_product_reviews_enabled() {
+ return ( $this->reviews_enable === 'yes' && $this->is_enabled() ? true : false );
+ }
+
+ public function is_product_sticker_enabled() {
+ return ( $this->is_product_reviews_enabled() && $this->product_sticker_enable === 'yes' ? true : false );
+ }
+
+ public function is_review_sticker_enabled() {
+ return $this->review_sticker_enable === 'yes' ? true : false;
+ }
+
+ public function is_product_widget_enabled() {
+ return ( $this->is_product_reviews_enabled() && $this->product_widget_enable === 'yes' ? true : false );
+ }
+
+ public function supports( $type ) {
+ return ( in_array( $type, $this->supports ) ? true : false );
+ }
+
+ /**
+ * Gets Trusted Shops payment gateway by woocommerce payment id
+ *
+ * @param integer $payment_method_id
+ * @return string
+ */
+ public function get_payment_gateway( $payment_method_id ) {
+ $gateways = WC()->payment_gateways()->payment_gateways();
+
+ if ( array_key_exists( $payment_method_id, $gateways ) ) {
+ return $gateways[ $payment_method_id ]->get_method_title();
+ } else {
+ return 'wcOther';
+ }
+ }
+
+ /**
+ * Returns the average rating by grabbing the rating from the current languages' cache.
+ *
+ * @return array
+ */
+ public function get_average_rating() {
+ $reviews = ( $this->reviews_cache ? $this->reviews_cache : array() );
+
+ if ( $this->is_multi_language_setup() ) {
+ $default_language = $this->get_multi_language_compatibility()->get_default_language();
+ $current_language = $this->get_multi_language_compatibility()->get_current_language();
+
+ if ( $current_language != $default_language ) {
+ $reviews = ( $this->{"reviews_cache_{$current_language}"} ? $this->{"reviews_cache_{$current_language}"} : array() );
+ }
+ }
+
+ return $reviews;
+ }
+
+ /**
+ * Returns the certificate link
+ *
+ * @return string
+ */
+ public function get_certificate_link() {
+ return 'https://www.trustedshops.com/shop/certificate.php?shop_id=' . $this->id;
+ }
+
+ /**
+ * Returns add new rating link
+ *
+ * @return string
+ */
+ public function get_new_review_link( $email, $order_id ) {
+ return 'https://www.trustedshops.de/bewertung/bewerten_' . $this->id . '.html&buyerEmail=' . urlencode( base64_encode( $email ) ) . '&shopOrderID=' . urlencode( base64_encode( $order_id ) );
+ }
+
+ /**
+ * Returns the rating link
+ *
+ * @return string
+ */
+ public function get_rating_link() {
+ return 'https://www.trustedshops.de/bewertung/info_' . $this->id . '.html';
+ }
+
+ /**
+ * Gets the attachment id of review widget graphic
+ *
+ * @return mixed
+ */
+ public function get_review_widget_attachment() {
+ return ( ! $this->review_widget_attachment ? false : $this->review_widget_attachment );
+ }
+
+ protected function get_product_shopping_data( $id, $attribute ) {
+ $product = is_numeric( $id ) ? wc_get_product( $id ) : $id;
+
+ if ( ! $product ) {
+ return false;
+ }
+
+ $data = wc_ts_get_crud_data( $product, $attribute );
+
+ if ( 'variation' === $product->get_type() ) {
+ if ( empty( $data ) ) {
+ $parent = wc_get_product( wc_ts_get_crud_data( $product, 'parent' ) );
+ $data = wc_ts_get_crud_data( $parent, $attribute );
+ }
+ }
+
+ return $data;
+ }
+
+ public function get_product_image( $id ) {
+ $product = is_numeric( $id ) ? wc_get_product( $id ) : $id;
+
+ if ( ! $product ) {
+ return false;
+ }
+
+ $image = '';
+
+ if ( is_callable( array( $product, 'get_image_id' ) ) ) {
+ $image_id = $product->get_image_id();
+ $images = wp_get_attachment_image_src( $image_id, 'shop_single' );
+
+ if ( ! empty( $images ) ) {
+ $image = $images[0];
+ }
+ } else {
+ if ( has_post_thumbnail( wc_ts_get_crud_data( $product, 'id' ) ) ) {
+ $images = wp_get_attachment_image_src( get_post_thumbnail_id( wc_ts_get_crud_data( $product, 'id' ) ), 'shop_single' );
+
+ if ( ! empty( $images ) ) {
+ $image = $images[0];
+ }
+ }
+ }
+
+ return $image;
+ }
+
+ public function get_product_brand( $id ) {
+ $product = is_numeric( $id ) ? wc_get_product( $id ) : $id;
+
+ if ( ! $product ) {
+ return false;
+ }
+
+ return $product->get_attribute( $this->brand_attribute );
+ }
+
+ public function get_product_mpn( $id ) {
+ return $this->get_product_shopping_data( $id, '_ts_mpn' );
+ }
+
+ public function get_product_gtin( $id ) {
+ return $this->get_product_shopping_data( $id, '_ts_gtin' );
+ }
+
+ public function get_product_skus( $id ) {
+ $product = is_numeric( $id ) ? wc_get_product( $id ) : $id;
+ $skus = array();
+ $skus[] = ( $product->get_sku() ) ? $product->get_sku() : wc_ts_get_crud_data( $product, 'id' );
+
+ if ( 'grouped' === $product->get_type() ) {
+ foreach( $product->get_children() as $child ) {
+ if ( $child_product = wc_get_product( $child ) ) {
+ $skus[] = ( $child_product->get_sku() ) ? $child_product->get_sku() : wc_ts_get_crud_data( $child_product, 'id' );
+ }
+ }
+ }
+
+ return $skus;
+ }
+
+ public function get_template( $name ) {
+ $html = "";
+
+ ob_start();
+ wc_get_template( 'trusted-shops/' . str_replace( '_', '-', $name ) . '-tpl.php', array( 'plugin' => $this ) );
+ $html = ob_get_clean();
+
+ return preg_replace('/^\h*\v+/m', '', strip_tags( $html ) );
+ }
+
+ public function get_script( $name, $replace = true, $args = array() ) {
+ $script = $this->get_template( $name );
+
+ if ( $this->integration_mode === 'expert' ) {
+ $option_script = $this->{$name . "_code"};
+
+ if ( $option_script ) {
+ $script = $option_script;
+ }
+ }
+
+ if ( $replace ) {
+ $args = wp_parse_args( $args, array(
+ 'id' => $this->id,
+ 'locale' => $this->get_locale(),
+ ) );
+
+ foreach ( $args as $key => $arg ) {
+ $search = '{' . $key . '}';
+ $replace = $arg;
+
+ if ( is_array( $arg ) ) {
+ $search = "'{" . $key . "}'";
+
+ foreach( $arg as $k => $v ) {
+ $arg[$k] = "'$v'";
+ }
+
+ $replace = implode( ',', $arg );
+ }
+
+ $script = str_replace( $search, $replace, $script );
+ }
+ }
+
+ return $script;
+ }
+
+ public function get_selector_attribute( $type, $selector = '' ) {
+ $element = $this->get_selector_raw( $type, $selector );
+
+ if ( substr( $element, 0, 1 ) === '.' ) {
+ $element = substr( $element, 1 );
+ } elseif( substr( $element, 0, 1 ) === '#' ) {
+ $element = substr( $element, 1 );
+ }
+
+ return $element;
+ }
+
+ public function get_selector_raw( $type, $selector = '' ) {
+ $element = $this->{$type . "_selector"};
+
+ if ( empty( $element ) ) {
+ $element = "#ts_{$type}";
+ }
+
+ if ( ! empty( $selector ) ) {
+ $element = $selector;
+ }
+
+ return $element;
+ }
+
+ public function get_selector( $type, $selector = '' ) {
+ $element = $this->get_selector_raw( $type, $selector );
+ $attribute = $this->get_selector_attribute( $type, $selector );
+ $is_class = false;
+
+ if ( substr( $element, 0, 1 ) === '.' ) {
+ $is_class = true;
+ }
+
+ return $is_class ? 'class="' . esc_attr( $attribute ) . '"' : 'id="' . esc_attr( $attribute ) . '"';
+ }
+
+ public function get_product_sticker_code( $replace = true, $args = array() ) {
+ if ( $replace ) {
+ $args = wp_parse_args( $args, array(
+ 'element' => $this->product_sticker_selector,
+ 'border_color' => $this->product_sticker_border_color,
+ 'star_color' => $this->product_sticker_star_color,
+ 'star_size' => $this->product_sticker_star_size,
+ ) );
+ }
+
+ return $this->get_script( 'product_sticker', $replace, $args );
+ }
+
+ public function get_review_sticker_code( $replace = true, $args = array() ) {
+ if ( $replace ) {
+ $args = wp_parse_args( $args, array(
+ 'element' => '#ts_review_sticker',
+ 'bg_color' => $this->review_sticker_bg_color,
+ 'font' => $this->review_sticker_font,
+ 'number' => $this->review_sticker_number,
+ 'better_than' => $this->review_sticker_better_than
+ ) );
+ }
+
+ return $this->get_script( 'review_sticker', $replace, $args );
+ }
+
+ public function get_product_widget_code( $replace = true, $args = array() ) {
+ if ( $replace ) {
+
+ $args = wp_parse_args( $args, array(
+ 'element' => $this->product_widget_selector,
+ 'star_color' => $this->product_widget_star_color,
+ 'star_size' => $this->product_widget_star_size,
+ 'font_size' => $this->product_widget_font_size,
+ ) );
+
+ }
+
+ return $this->get_script( 'product_widget', $replace, $args );
+ }
+
+ public function get_trustbadge_code( $replace = true, $args = array() ) {
+ if ( $replace ) {
+ $args = wp_parse_args( $args, array(
+ 'offset' => $this->trustbadge_y,
+ 'variant' => $this->trustbadge_variant === 'standard' ? 'reviews' : 'default',
+ 'disable' => $this->is_trustbadge_enabled() ? 'false' : 'true',
+ ) );
+ }
+
+ return $this->get_script( 'trustbadge', $replace, $args );
+ }
+
+ public function get_rich_snippets_code( $replace = true, $args = array() ) {
+ if ( $replace ) {
+ $rating = $this->get_average_rating();
+
+ $args = apply_filters( 'woocommerce_trusted_shops_rich_snippets_args', wp_parse_args( $args, array(
+ 'average' => $rating['avg'],
+ 'count' => $rating['count'],
+ 'maximum' => $rating['max'],
+ 'rating' => $rating,
+ 'name' => get_bloginfo( 'name' ),
+ ) ), $this );
+ }
+
+ return $this->get_script( 'rich_snippets', $replace, $args );
+ }
+
+ public function get_supported_languages() {
+ return array_keys( $this->get_locale_mapping() );
+ }
+
+ protected function get_locale_mapping() {
+ $supported = array(
+ 'de' => 'de_DE',
+ 'en' => 'en_GB',
+ 'fr' => 'fr_FR',
+ );
+
+ return $supported;
+ }
+
+ public function get_language() {
+ $locale = $this->get_locale();
+
+ return substr( $locale, 0, 2 );
+ }
+
+ public function get_locale() {
+ $supported = $this->get_locale_mapping();
+
+ $locale = 'en_GB';
+ $base = substr( function_exists( 'get_user_locale' ) ? get_user_locale() : get_locale(), 0, 2 );
+
+ if ( isset( $supported[ $base ] ) )
+ $locale = $supported[ $base ];
+
+ return $locale;
+ }
+}
+
+?>
diff --git a/packages/woocommerce-trusted-shops/includes/class-wc-ts-dependencies.php b/packages/woocommerce-trusted-shops/includes/class-wc-ts-dependencies.php
new file mode 100644
index 000000000..4d49092b9
--- /dev/null
+++ b/packages/woocommerce-trusted-shops/includes/class-wc-ts-dependencies.php
@@ -0,0 +1,139 @@
+ array( 'version' => '2.4', 'version_prefix' => 'woocommerce', 'name' => 'WooCommerce' ),
+ );
+
+ public static function instance() {
+ if ( is_null( self::$_instance ) ) {
+ self::$_instance = new self();
+ }
+ return self::$_instance;
+ }
+
+ /**
+ * Cloning is forbidden.
+ *
+ * @since 1.0
+ */
+ public function __clone() {
+ _doing_it_wrong( __FUNCTION__, _x( 'Cheatin’ huh?', 'trusted-shops', 'woocommerce-germanized' ), '1.0' );
+ }
+
+ /**
+ * Unserializing instances of this class is forbidden.
+ *
+ * @since 1.0
+ */
+ public function __wakeup() {
+ _doing_it_wrong( __FUNCTION__, _x( 'Cheatin’ huh?', 'trusted-shops', 'woocommerce-germanized' ), '1.0' );
+ }
+
+ public function __construct() {
+
+ $this->plugins = (array) get_option( 'active_plugins', array() );
+
+ if ( is_multisite() ) {
+ $this->plugins = array_merge( $this->plugins, get_site_option( 'active_sitewide_plugins', array() ) );
+ }
+
+ foreach ( $this->plugins_required as $plugin => $data ) {
+
+ if ( ! $this->is_plugin_activated( $plugin ) || $this->is_plugin_outdated( $plugin ) ) {
+ add_action( 'admin_notices', array( $this, 'dependencies_notice' ) );
+ $this->loadable = false;
+ }
+ }
+ }
+
+ public function get_plugin_version( $plugin_slug ) {
+ return get_option( $plugin_slug . '_version' );
+ }
+
+ public function is_plugin_outdated( $plugin ) {
+ $required = ( isset( $this->plugins_required[ $plugin ] ) ? $this->plugins_required[ $plugin ] : false );
+
+ if ( ! $required ) {
+ return false;
+ }
+
+ if ( version_compare( $this->get_plugin_version( $required[ 'version_prefix' ] ), $required[ 'version' ], "<" ) ) {
+ return true;
+ }
+
+ return false;
+ }
+
+ public function is_plugin_activated( $plugin ) {
+
+ if ( strpos( $plugin, '.php' ) === false ) {
+ $plugin = trailingslashit( $plugin ) . $plugin . '.php';
+ }
+
+ return in_array( $plugin, $this->plugins ) || array_key_exists( $plugin, $this->plugins );
+ }
+
+ /**
+ * This method removes accuration from $ver2 if this version is more accurate than $main_ver
+ */
+ public function compare_versions( $main_ver, $ver2, $operator ) {
+
+ $expl_main_ver = explode( '.', $main_ver );
+ $expl_ver2 = explode( '.', $ver2 );
+
+ // Check if ver2 string is more accurate than main_ver
+ if ( sizeof( $expl_main_ver ) == 2 && sizeof( $expl_ver2 ) > 2 ) {
+ $new_ver_2 = array_slice( $expl_ver2, 0, 2 );
+ $ver2 = implode( '.', $new_ver_2 );
+ }
+
+ return version_compare( $main_ver, $ver2, $operator );
+ }
+
+ /**
+ * Checks if WooCommerce is activated
+ *
+ * @return boolean true if WooCommerce is activated
+ */
+ public function is_woocommerce_activated() {
+ return $this->is_plugin_activated( 'woocommerce/woocommerce.php' );
+ }
+
+ public function is_wpml_activated() {
+ return ( $this->is_plugin_activated( 'sitepress-multilingual-cms/sitepress.php' ) && $this->is_plugin_activated( 'woocommerce-multilingual/wpml-woocommerce.php' ) );
+ }
+
+ public function woocommerce_version_supports_crud() {
+ return ( $this->compare_versions( $this->get_plugin_version( 'woocommerce' ), '2.7', '>=' ) );
+ }
+
+ public function is_loadable() {
+ return $this->loadable;
+ }
+
+ public function dependencies_notice() {
+ global $dependencies;
+ $dependencies = $this;
+
+ include_once( 'admin/views/html-notice-dependencies.php' );
+ }
+
+}
+
+WC_TS_Dependencies::instance();
diff --git a/packages/woocommerce-trusted-shops/includes/class-wc-ts-install.php b/packages/woocommerce-trusted-shops/includes/class-wc-ts-install.php
new file mode 100644
index 000000000..2e87b1c48
--- /dev/null
+++ b/packages/woocommerce-trusted-shops/includes/class-wc-ts-install.php
@@ -0,0 +1,168 @@
+ 'updates/woocommerce-ts-update-3.0.0.php',
+ '4.0.6' => 'updates/woocommerce-ts-update-4.0.6.php'
+ );
+
+ /**
+ * Hook in tabs.
+ */
+ public function __construct() {
+ if ( ! Package::is_integration() ) {
+ add_action( 'admin_init', array( __CLASS__, 'check_version' ), 10 );
+ }
+
+ add_action( 'admin_init', array( __CLASS__, 'install_actions' ), 5 );
+ }
+
+ /**
+ * Install actions such as installing pages when a button is clicked.
+ */
+ public static function install_actions() {
+ if ( ! empty( $_GET['do_update_woocommerce_ts'] ) ) {
+ self::update();
+
+ // Update complete
+ delete_option( '_wc_ts_needs_update' );
+ }
+ }
+
+ /**
+ * check_version function.
+ *
+ * @access public
+ * @return void
+ */
+ public static function check_version() {
+ if ( ! defined( 'IFRAME_REQUEST' ) && ( get_option( 'woocommerce_trusted_shops_version' ) != WC_trusted_shops()->version || get_option( 'woocommerce_trusted_shops_db_version' ) != WC_trusted_shops()->version ) ) {
+ self::install();
+ do_action( 'woocommerce_trusted_shops_updated' );
+ }
+ }
+
+ public static function install_integration() {
+ self::create_cron_jobs();
+ self::update_versions();
+ }
+
+ protected static function update_versions() {
+ // Queue upgrades
+ $current_version = get_option( 'woocommerce_trusted_shops_version', null );
+ $current_db_version = get_option( 'woocommerce_trusted_shops_db_version', null );
+
+ if ( ! is_null( $current_db_version ) && version_compare( $current_db_version, max( array_keys( self::$db_updates ) ), '<' ) ) {
+ // Update
+ update_option( '_wc_ts_needs_update', 1 );
+ } else {
+ self::update_db_version();
+ }
+
+ self::update_ts_version();
+
+ do_action( 'woocommerce_trusted_shops_installed' );
+ }
+
+ /**
+ * Install TS
+ */
+ public static function install() {
+ // Load Translation for default options
+ $locale = apply_filters( 'plugin_locale', get_locale(), 'woocommerce-germanized' );
+ $mofile = WC_trusted_shops()->plugin_path() . '/i18n/languages/woocommerce-trusted-shops.mo';
+
+ if ( file_exists( WC_trusted_shops()->plugin_path() . '/i18n/languages/woocommerce-trusted-shops-' . $locale . '.mo' ) ) {
+ $mofile = WC_trusted_shops()->plugin_path() . '/i18n/languages/woocommerce-trusted-shops-' . $locale . '.mo';
+ }
+
+ load_textdomain( 'woocommerce-trusted-shops', $mofile );
+
+ self::create_options();
+ self::create_cron_jobs();
+ self::update_versions();
+
+ // Flush rules after install
+ flush_rewrite_rules();
+ }
+
+ /**
+ * Update WC version to current
+ */
+ private static function update_ts_version() {
+ delete_option( 'woocommerce_trusted_shops_version' );
+ add_option( 'woocommerce_trusted_shops_version', WC_trusted_shops()->version );
+ }
+
+ /**
+ * Update DB version to current
+ */
+ private static function update_db_version( $version = null ) {
+ delete_option( 'woocommerce_trusted_shops_db_version' );
+ add_option( 'woocommerce_trusted_shops_db_version', is_null( $version ) ? WC_trusted_shops()->version : $version );
+ }
+
+ /**
+ * Handle updates
+ */
+ public static function update() {
+ $current_db_version = get_option( 'woocommerce_trusted_shops_db_version' );
+
+ foreach ( self::$db_updates as $version => $updater ) {
+ if ( version_compare( $current_db_version, $version, '<' ) ) {
+ include( $updater );
+ self::update_db_version( $version );
+ }
+ }
+
+ self::update_db_version();
+ }
+
+ /**
+ * Create cron jobs (clear them first)
+ */
+ private static function create_cron_jobs() {
+ // Cron jobs
+ wp_clear_scheduled_hook( 'woocommerce_gzd_trusted_shops_reviews' );
+ wp_schedule_event( time(), 'twicedaily', 'woocommerce_gzd_trusted_shops_reviews' );
+ }
+
+ /**
+ * Default options
+ *
+ * Sets up the default options used on the settings page
+ *
+ * @access public
+ */
+ private static function create_options() {
+ // Include settings so that we can run through defaults
+ $options = apply_filters( 'woocommerce_gzd_installation_default_settings', array() );
+
+ foreach ( $options as $value ) {
+
+ if ( isset( $value['default'] ) && isset( $value['id'] ) ) {
+ $autoload = isset( $value['autoload'] ) ? (bool) $value['autoload'] : true;
+ add_option( $value['id'], $value['default'], '', ( $autoload ? 'yes' : 'no' ) );
+ }
+ }
+ }
+}
+
+endif;
+
+return new WC_TS_Install();
diff --git a/packages/woocommerce-trusted-shops/includes/class-wc-ts-settings-handler.php b/packages/woocommerce-trusted-shops/includes/class-wc-ts-settings-handler.php
new file mode 100644
index 000000000..712feadae
--- /dev/null
+++ b/packages/woocommerce-trusted-shops/includes/class-wc-ts-settings-handler.php
@@ -0,0 +1,70 @@
+id = 'trusted-shops';
+ $this->label = _x( 'Trusted Shops', 'trusted-shops', 'woocommerce-germanized' );
+
+ parent::__construct();
+ }
+
+ /**
+ * Get settings array
+ *
+ * @return array
+ */
+ public function get_settings() {
+ $admin = WC_trusted_shops()->trusted_shops->get_dependency( 'admin' );
+ $settings = $admin->get_settings();
+
+ return $settings;
+ }
+
+ public function output() {
+ global $current_section;
+
+ $settings = $this->get_settings();
+ $sidebar = $this->get_sidebar();
+
+ include_once( WC_trusted_shops()->plugin_path() . '/includes/admin/views/html-settings-section.php' );
+ }
+
+ public function get_sidebar() {
+ $admin = WC_trusted_shops()->trusted_shops->get_dependency( 'admin' );
+ $sidebar = $admin->get_sidebar();
+
+ return $sidebar;
+ }
+
+ /**
+ * Save settings
+ */
+ public function save() {
+ $settings = $this->get_settings();
+
+ do_action( 'woocommerce_ts_before_save', $settings );
+ WC_Admin_Settings::save_fields( $settings );
+ do_action( 'woocommerce_ts_after_save', $settings );
+ }
+}
+
+endif;
+
+?>
diff --git a/packages/woocommerce-trusted-shops/includes/compatibility/class-wc-ts-compatibility-wpml-string-translation.php b/packages/woocommerce-trusted-shops/includes/compatibility/class-wc-ts-compatibility-wpml-string-translation.php
new file mode 100644
index 000000000..8e6afae03
--- /dev/null
+++ b/packages/woocommerce-trusted-shops/includes/compatibility/class-wc-ts-compatibility-wpml-string-translation.php
@@ -0,0 +1,343 @@
+ defined( 'WPML_ST_VERSION' ) ? WPML_ST_VERSION : '1.0',
+ )
+ );
+ }
+
+ public function is_activated() {
+ global $sitepress;
+
+ return defined( 'WPML_ST_VERSION' ) && isset( $sitepress) ? true : false;
+ }
+
+ public function load() {
+ if ( is_admin() ) {
+ $this->admin_translate_options();
+ }
+ }
+
+ public function get_languages() {
+ global $sitepress;
+ $codes = array();
+
+ if ( isset( $sitepress ) && is_callable( array( $sitepress, 'get_ls_languages' ) ) ) {
+ $languages = $sitepress->get_ls_languages();
+
+ if ( ! empty( $languages ) ) {
+ $codes = array_keys( $languages );
+ }
+ }
+
+ return $codes;
+ }
+
+ public function get_language_name( $language = '' ) {
+ global $sitepress;
+
+ if ( empty( $language ) ) {
+ $language = $this->get_current_language();
+ }
+
+ return $sitepress->get_display_language_name( $language );
+ }
+
+ public function get_current_language() {
+ global $sitepress;
+
+ return $sitepress->get_current_language();
+ }
+
+ public function get_default_language() {
+ global $sitepress;
+ $default = '';
+
+ if ( isset( $sitepress ) && is_callable( array( $sitepress, 'get_default_language' ) ) ) {
+ $default = $sitepress->get_default_language();
+ }
+
+ return $default;
+ }
+
+ /**
+ * Register strings that are translatable within the settings panel. Strings will be loaded in the admin user's language
+ * within the settings screen only.
+ *
+ * @return array
+ */
+ public function get_translatable_options() {
+ return apply_filters( 'woocommerce_gzd_wpml_translatable_options', array() );
+ }
+
+ /**
+ * By default WPML allow only certain strings to be translated within the administration area (e.g. blog title).
+ * If you want some translatable strings to be loaded globally within the admin panel use the filter accordingly.
+ *
+ * @return array
+ */
+ public function get_translatable_admin_options() {
+ return apply_filters( 'woocommerce_gzd_wpml_translatable_admin_options', array() );
+ }
+
+ public function admin_translate_options() {
+ $this->set_filters();
+ }
+
+ public function set_filters() {
+ $admin_strings = $this->get_translatable_admin_options();
+
+ if ( $this->enable_option_filters() ) {
+
+ foreach( $this->get_translatable_options() as $option => $args ) {
+ add_filter( 'option_' . $option, array( $this, 'translate_option_filter' ), 10, 2 );
+ add_filter( 'pre_update_option_' . $option, array( $this, 'pre_update_translation_filter' ), 10, 3 );
+
+ wc_ts_remove_class_filter( 'option_' . $option, 'WPML_Admin_Texts', 'icl_st_translate_admin_string', 10 );
+ }
+
+ } elseif( ! empty( $admin_strings ) ) {
+
+ foreach( $admin_strings as $option => $args ) {
+ add_filter( 'option_' . $option, array( $this, 'translate_option_filter' ), 10, 2 );
+ wc_ts_remove_class_filter( 'option_' . $option, 'WPML_Admin_Texts', 'icl_st_translate_admin_string', 10 );
+ }
+ }
+ }
+
+ protected function enable_option_filters() {
+ $enable = false;
+
+ if ( isset( $_GET['tab'] ) && ( 'trusted-shops' === $_GET['tab'] ) ) {
+ $enable = true;
+ }
+
+ return apply_filters( 'woocommerce_gzd_enable_wpml_string_translation_settings_filters', $enable );
+ }
+
+ public function get_string_language( $string_id, $option = '' ) {
+ if ( $string = $this->get_string_by_id( $string_id ) ) {
+ return $string->language;
+ }
+
+ global $WPML_String_Translation;
+
+ return $WPML_String_Translation->get_current_string_language( $option );
+ }
+
+ public function get_string_by_id( $string_id ) {
+ global $wpdb;
+
+ $string = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM {$wpdb->prefix}icl_strings WHERE id=%d LIMIT 1", $string_id ) );
+
+ if ( $string ) {
+ return $string[0];
+ }
+
+ return false;
+ }
+
+ public function get_string_id( $option, $context = '' ) {
+ $context = empty( $context ) ? 'admin_texts_' . $option : $context;
+
+ return icl_st_is_registered_string( $context, $option );
+ }
+
+ public function get_string_value( $string_id ) {
+ if ( $string = $this->get_string_by_id( $string_id ) ) {
+ return $string->value;
+ }
+
+ return false;
+ }
+
+ public function update_string_value( $string_id, $value ) {
+ global $wpdb;
+
+ $value = maybe_serialize( $value );
+
+ $wpdb->update( "{$wpdb->prefix}icl_strings", array( 'value' => $value ), array( 'id' => $string_id ) );
+ }
+
+ public function delete_string_translation( $string_id, $language ) {
+ global $wpdb;
+
+ $wpdb->query( $wpdb->prepare("DELETE FROM {$wpdb->prefix}icl_string_translations WHERE string_id=%d AND language=%s", $string_id, $language ) );
+ }
+
+ public function update_string_translation( $option, $language, $value, $status = '' ) {
+ if ( empty( $status ) ) {
+ $status = ICL_TM_COMPLETE;
+ }
+
+ if ( $string_id = $this->get_string_id( $option ) ) {
+ icl_add_string_translation( $string_id, $language, $value, $status );
+ }
+
+ icl_update_string_translation( $option, $language, $value, $status );
+
+ // Make sure that the string is stored within the WPML translatable option names
+ $option_names = get_option( '_icl_admin_option_names', array() );
+ $option_names[ $option ] = 1;
+
+ update_option( '_icl_admin_option_names', $option_names );
+ }
+
+ public function get_string_translation( $string_id, $language, $status = '' ) {
+ $translations = icl_get_string_translations_by_id( $string_id );
+ $status = empty( $status ) ? ICL_TM_COMPLETE : $status;
+
+ if ( isset( $translations[ $language ] ) && $translations[ $language ]['status'] == $status ) {
+ return $translations[ $language ]['value'];
+ }
+
+ return false;
+ }
+
+ public function get_translated_string( $option, $language, $context = '' ) {
+ $value = null;
+
+ if ( $string_id = $this->get_string_id( $option, $context ) ) {
+ $value = $this->get_string_translation( $string_id, $language );
+ }
+
+ return $value;
+ }
+
+ public function register_string( $option, $value, $context = '' ) {
+ $context = empty( $context ) ? 'admin_texts_' . $option : $context;
+
+ return icl_register_string( $context, $option, $value );
+ }
+
+ public function pre_update_translation_filter( $new_value, $old_value, $option ) {
+ $string_options = $this->get_translatable_options();
+
+ if ( is_array( $new_value ) || is_array( $string_options[ $option ] ) ) {
+
+ if ( ! is_array( $new_value ) ) {
+ $new_value = array();
+ }
+
+ $args = $string_options[ $option ];
+
+ foreach( $new_value as $id => $options ) {
+ foreach( $options as $key => $value ) {
+ if ( in_array( $key, $args ) ) {
+ $old_value_internal = isset( $old_value[ $id ][ $key ] ) ? $old_value[ $id ][ $key ] : '';
+ $new_value[ $id ][ $key ] = $this->pre_update_translation( $value, $old_value_internal, "[{$option}][{$id}]{$key}", "admin_texts_{$option}" );
+ }
+ }
+ }
+
+ return $new_value;
+ } else {
+ return $this->pre_update_translation( $new_value, $old_value, $option );
+ }
+ }
+
+ protected function pre_update_translation( $new_value, $old_value, $option, $context = '' ) {
+ $org_string_id = $this->get_string_id( $option, $context );
+ $strings_language = $this->get_string_language( $org_string_id, $option );
+ $return_value = $old_value;
+
+ if ( $strings_language === $this->get_current_language() || 'all' === $this->get_current_language() ) {
+
+ $current_string_value = $this->get_string_value( $org_string_id );
+
+ // Update original string value
+ if ( $org_string_id && ( $new_value !== $old_value || $current_string_value !== $new_value ) ) {
+ $this->update_string_value( $org_string_id, $new_value );
+ }
+
+ $return_value = $new_value;
+
+ } else {
+ $update_translation = true;
+
+ if ( $org_string_id ) {
+ $org_string = $this->get_string_value( $org_string_id );
+
+ /**
+ * Remove translation if it equals original string
+ * Use woocommerce_gzd_wpml_remove_translation_empty_equal filter to disallow string deletion which results in "real" option translations
+ */
+ if ( ( $org_string === $new_value || empty( $new_value ) ) && apply_filters( 'woocommerce_gzd_wpml_remove_translation_empty_equal', true, $option, $new_value, $old_value ) ) {
+ $this->delete_string_translation( $org_string_id, $this->get_current_language() );
+
+ $return_value = $old_value;
+ $update_translation = false;
+ }
+ }
+
+ if ( $update_translation ) {
+ $this->update_string_translation( $option, $this->get_current_language(), $new_value );
+ }
+ }
+
+ // Allow WPML to delete the cache
+ do_action( "update_option_{$option}", $old_value, $return_value, $option );
+
+ return $return_value;
+ }
+
+ public function translate_option_filter( $org_value, $option ) {
+ $string_options = $this->get_translatable_options();
+
+ if ( is_array( $org_value ) || is_array( $string_options[ $option ] ) ) {
+
+ if ( ! is_array( $org_value ) ) {
+ $org_value = array();
+ }
+
+ $args = $string_options[ $option ];
+
+ foreach( $org_value as $id => $options ) {
+ foreach( $options as $key => $value ) {
+ if ( in_array( $key, $args ) ) {
+ $org_value[ $id ][ $key ] = $this->translate_option( $value, "[{$option}][{$id}]{$key}", "admin_texts_{$option}" );
+ }
+ }
+ }
+
+ return $org_value;
+ } else {
+ return $this->translate_option( $org_value, $option );
+ }
+ }
+
+ protected function translate_option( $org_value, $option, $context = '' ) {
+ $string_id = $this->get_string_id( $option, $context );
+ $language = $this->get_current_language();
+
+ if ( ! $string_id ) {
+ $string_id = $this->register_string( $option, $org_value, $context );
+ }
+
+ $translation = $this->get_string_translation( $string_id, $language );
+
+ if ( false !== $translation ) {
+ $org_value = $translation;
+ }
+
+ return $org_value;
+ }
+
+ public function pre_update_translate_checkboxes( $new_value, $old_value, $option ) {
+ return $new_value;
+ }
+}
diff --git a/packages/woocommerce-trusted-shops/includes/emails/class-wc-ts-email-customer-trusted-shops.php b/packages/woocommerce-trusted-shops/includes/emails/class-wc-ts-email-customer-trusted-shops.php
new file mode 100644
index 000000000..61c18977b
--- /dev/null
+++ b/packages/woocommerce-trusted-shops/includes/emails/class-wc-ts-email-customer-trusted-shops.php
@@ -0,0 +1,159 @@
+id = 'customer_trusted_shops';
+ $this->title = _x( 'Trusted Shops Review Reminder', 'trusted-shops', 'woocommerce-germanized' );
+ $this->description = _x( 'This E-Mail is being sent to a customer to remind him about the possibility to leave a review at Trusted Shops.', 'trusted-shops', 'woocommerce-germanized' );
+
+ $this->template_html = 'emails/customer-trusted-shops.php';
+ $this->template_plain = 'emails/plain/customer-trusted-shops.php';
+ $this->helper = function_exists( 'wc_gzd_get_email_helper' ) ? wc_gzd_get_email_helper( $this ) : false;
+
+ // Triggers for this email
+ add_action( 'woocommerce_germanized_trusted_shops_review_notification', array( $this, 'trigger' ) );
+
+ $this->placeholders = array(
+ '{site_title}' => $this->get_blogname(),
+ '{order_number}' => '',
+ '{order_date}' => '',
+ );
+
+ // Call parent constuctor
+ parent::__construct();
+
+ $this->customer_email = true;
+ }
+
+ /**
+ * Get email subject.
+ *
+ * @since 3.1.0
+ * @return string
+ */
+ public function get_default_subject() {
+ return _x( 'Please rate your {site_title} order from {order_date}', 'trusted-shops', 'woocommerce-germanized' );
+ }
+
+ /**
+ * Get email heading.
+ *
+ * @since 3.1.0
+ * @return string
+ */
+ public function get_default_heading() {
+ return _x( 'Please rate your Order', 'trusted-shops', 'woocommerce-germanized' );
+ }
+
+ /**
+ * trigger function.
+ *
+ * @access public
+ * @return void
+ */
+ public function trigger( $order_id ) {
+ if ( $this->helper ) {
+ $this->helper->setup_locale();
+ } else {
+ $this->setup_locale();
+ }
+
+ if ( $order_id ) {
+ $this->object = wc_get_order( $order_id );
+ $this->recipient = wc_ts_get_crud_data( $this->object, 'billing_email' );
+
+ $this->placeholders['{order_date}'] = wc_gzd_get_order_date( $this->object, wc_date_format() );
+ $this->placeholders['{order_number}'] = $this->object->get_order_number();
+ }
+
+ if ( $this->helper ) {
+ $this->helper->setup_email_locale();
+ }
+
+ if ( $this->is_enabled() && $this->get_recipient() ) {
+ $this->send( $this->get_recipient(), $this->get_subject(), $this->get_content(), $this->get_headers(), $this->get_attachments() );
+ }
+
+ if ( $this->helper ) {
+ $this->helper->restore_email_locale();
+ $this->helper->restore_locale();
+ } else {
+ $this->restore_locale();
+ }
+ }
+
+ /**
+ * Return content from the additional_content field.
+ *
+ * Displayed above the footer.
+ *
+ * @since 2.0.4
+ * @return string
+ */
+ public function get_additional_content() {
+ if ( is_callable( 'parent::get_additional_content' ) ) {
+ return parent::get_additional_content();
+ }
+
+ return '';
+ }
+
+ /**
+ * get_content_html function.
+ *
+ * @access public
+ * @return string
+ */
+ public function get_content_html() {
+ return wc_get_template_html( $this->template_html, array(
+ 'order' => $this->object,
+ 'email_heading' => $this->get_heading(),
+ 'additional_content' => $this->get_additional_content(),
+ 'sent_to_admin' => false,
+ 'plain_text' => false,
+ 'email' => $this
+ ) );
+ }
+
+ /**
+ * Get content plain.
+ *
+ * @return string
+ */
+ public function get_content_plain() {
+ return wc_get_template_html(
+ $this->template_plain, array(
+ 'order' => $this->object,
+ 'email_heading' => $this->get_heading(),
+ 'additional_content' => $this->get_additional_content(),
+ 'sent_to_admin' => false,
+ 'plain_text' => false,
+ 'email' => $this
+ )
+ );
+ }
+}
+
+endif;
+
+return new WC_TS_Email_Customer_Trusted_Shops();
diff --git a/packages/woocommerce-trusted-shops/includes/updates/woocommerce-ts-update-3.0.0.php b/packages/woocommerce-trusted-shops/includes/updates/woocommerce-ts-update-3.0.0.php
new file mode 100644
index 000000000..b8fc50196
--- /dev/null
+++ b/packages/woocommerce-trusted-shops/includes/updates/woocommerce-ts-update-3.0.0.php
@@ -0,0 +1,23 @@
+
diff --git a/packages/woocommerce-trusted-shops/includes/updates/woocommerce-ts-update-4.0.6.php b/packages/woocommerce-trusted-shops/includes/updates/woocommerce-ts-update-4.0.6.php
new file mode 100644
index 000000000..c4c3c4406
--- /dev/null
+++ b/packages/woocommerce-trusted-shops/includes/updates/woocommerce-ts-update-4.0.6.php
@@ -0,0 +1,14 @@
+
diff --git a/packages/woocommerce-trusted-shops/includes/wc-ts-core-functions.php b/packages/woocommerce-trusted-shops/includes/wc-ts-core-functions.php
new file mode 100644
index 000000000..c097b5d64
--- /dev/null
+++ b/packages/woocommerce-trusted-shops/includes/wc-ts-core-functions.php
@@ -0,0 +1,319 @@
+get_wc_product();
+ }
+
+ $value = null;
+
+ $getter = substr( $key, 0, 3 ) === "get" ? $key : "get_$key";
+ $key = substr( $key, 0, 3 ) === "get" ? substr( $key, 3 ) : $key;
+
+ if ( 'id' === $key && is_callable( array( $object, 'is_type' ) ) && $object->is_type( 'variation' ) && ! wc_ts_woocommerce_supports_crud() ) {
+ $key = 'variation_id';
+ } elseif ( 'parent' === $key && is_callable( array( $object, 'is_type' ) ) && $object->is_type( 'variation' ) && ! wc_ts_woocommerce_supports_crud() ) {
+ // Set getter to parent so that it is not being used for pre 2.7
+ $key = 'id';
+ $getter = 'parent';
+ }
+
+ $getter_mapping = array(
+ 'parent' => 'get_parent_id',
+ 'completed_date' => 'get_date_completed',
+ 'order_date' => 'get_date_created',
+ 'product_type' => 'get_type',
+ 'order_type' => 'get_type',
+ );
+
+ if ( array_key_exists( $key, $getter_mapping ) ) {
+ $getter = $getter_mapping[ $key ];
+ }
+
+ if ( is_callable( array( $object, $getter ) ) ) {
+ $reflection = new ReflectionMethod( $object, $getter );
+ if ( $reflection->isPublic() ) {
+ $value = $object->{$getter}();
+ }
+ } elseif ( wc_ts_woocommerce_supports_crud() ) {
+ // Prefix meta if suppress_suffix is not set
+ if ( substr( $key, 0, 1 ) !== '_' && ! $suppress_suffix )
+ $key = '_' . $key;
+
+ $value = $object->get_meta( $key );
+ } else {
+ $key = substr( $key, 0, 1 ) === "_" ? substr( $key, 1 ) : $key;
+ $value = $object->{$key};
+ }
+
+ return $value;
+ }
+}
+
+if ( ! function_exists( 'wc_ts_woocommerce_supports_crud' ) ) {
+
+ function wc_ts_woocommerce_supports_crud() {
+ return WC_TS_Dependencies::instance()->woocommerce_version_supports_crud();
+ }
+}
+
+if ( ! function_exists( 'wc_ts_help_tip' ) ) {
+
+ function wc_ts_help_tip( $tip, $allow_html = false ) {
+ if ( function_exists( 'wc_help_tip' ) )
+ return wc_help_tip( $tip, $allow_html );
+
+ return '[?]';
+ }
+}
+
+if ( ! function_exists( 'wc_ts_set_crud_data' ) ) {
+
+ function wc_ts_set_crud_data( $object, $key, $value ) {
+ if ( wc_ts_woocommerce_supports_crud() ) {
+
+ $key_unprefixed = substr( $key, 0, 1 ) === '_' ? substr( $key, 1 ) : $key;
+ $setter = substr( $key_unprefixed, 0, 3 ) === "set" ? $key : "set_{$key_unprefixed}";
+
+ if ( is_callable( array( $object, $setter ) ) ) {
+ $reflection = new ReflectionMethod( $object, $setter );
+ if ( $reflection->isPublic() ) {
+ $object->{$setter}( $value );
+ }
+ } else {
+ $object = wc_ts_set_crud_meta_data( $object, $key, $value );
+ }
+ } else {
+ $object = wc_ts_set_crud_meta_data( $object, $key, $value );
+ }
+ return $object;
+ }
+}
+
+if ( ! function_exists( 'wc_ts_set_crud_meta_data' ) ) {
+ function wc_ts_set_crud_meta_data( $object, $key, $value ) {
+
+ if ( wc_ts_woocommerce_supports_crud() ) {
+ $object->update_meta_data( $key, $value );
+ } else {
+ update_post_meta( wc_ts_get_crud_data( $object, 'id' ), $key, $value );
+ }
+ return $object;
+ }
+}
+
+if ( ! function_exists( 'wc_ts_get_order_date' ) ) {
+
+ function wc_ts_get_order_date( $order, $format = '' ) {
+ $date_formatted = '';
+
+ if ( function_exists( 'wc_format_datetime' ) ) {
+ return wc_format_datetime( $order->get_date_created(), $format );
+ } else {
+ $date = $order->order_date;
+ }
+
+ if ( empty( $format ) ) {
+ $format = get_option( 'date_format' );
+ }
+
+ if ( ! empty( $date ) ) {
+ $date_formatted = date_i18n( $format, strtotime( $date ) );
+ }
+
+ return $date_formatted;
+ }
+}
+
+if ( ! function_exists( 'wc_ts_get_order_currency' ) ) {
+
+ function wc_ts_get_order_currency( $order ) {
+ if ( wc_ts_woocommerce_supports_crud() ) {
+ return $order->get_currency();
+ }
+
+ return $order->get_order_currency();
+ }
+}
+
+if ( ! function_exists( 'wc_ts_get_order_language' ) ) {
+
+ function wc_ts_get_order_language( $order ) {
+ $order_id = is_numeric( $order ) ? $order : wc_ts_get_crud_data( $order, 'id' );
+
+ return get_post_meta( $order_id, 'wpml_language', true );
+ }
+}
+
+if ( ! function_exists( 'wc_ts_switch_language' ) ) {
+
+ function wc_ts_switch_language( $lang, $set_default = false ) {
+ global $sitepress;
+ global $wc_ts_original_lang;
+
+ if ( $set_default ) {
+ $wc_ts_original_lang = $lang;
+ }
+
+ if ( isset( $sitepress ) && is_callable( array( $sitepress, 'get_current_language' ) ) && is_callable( array( $sitepress, 'switch_lang' ) ) ) {
+ if ( $sitepress->get_current_language() != $lang ) {
+
+ $sitepress->switch_lang( $lang, true );
+
+ // Somehow WPML doesn't automatically change the locale
+ if ( is_callable( array( $sitepress, 'reset_locale_utils_cache' ) ) ) {
+ $sitepress->reset_locale_utils_cache();
+ }
+
+ if ( function_exists( 'switch_to_locale' ) ) {
+ switch_to_locale( get_locale() );
+
+ // Filter on plugin_locale so load_plugin_textdomain loads the correct locale.
+ add_filter( 'plugin_locale', 'get_locale' );
+
+ // Init WC locale.
+ WC()->load_plugin_textdomain();
+ WC_trusted_shops()->load_plugin_textdomain();
+ WC_trusted_shops()->trusted_shops->refresh();
+ }
+
+ do_action( 'woocommerce_gzd_trusted_shops_switched_language', $lang, $wc_ts_original_lang );
+ }
+ }
+
+ do_action( 'woocommerce_gzd_trusted_shops_switch_language', $lang, $wc_ts_original_lang );
+ }
+}
+
+if ( ! function_exists( 'wc_ts_restore_language' ) ) {
+
+ function wc_ts_restore_language() {
+ global $wc_ts_original_lang;
+
+ if ( isset( $wc_ts_original_lang ) && ! empty( $wc_ts_original_lang ) ) {
+ wc_ts_switch_language( $wc_ts_original_lang );
+ }
+ }
+}
+
+if ( ! function_exists( 'wc_ts_remove_class_filter' ) ) {
+ /**
+ * Remove Class Filter Without Access to Class Object
+ *
+ * In order to use the core WordPress remove_filter() on a filter added with the callback
+ * to a class, you either have to have access to that class object, or it has to be a call
+ * to a static method. This method allows you to remove filters with a callback to a class
+ * you don't have access to.
+ *
+ * Works with WordPress 1.2+ (4.7+ support added 9-19-2016)
+ * Updated 2-27-2017 to use internal WordPress removal for 4.7+ (to prevent PHP warnings output)
+ *
+ * @param string $tag Filter to remove
+ * @param string $class_name Class name for the filter's callback
+ * @param string $method_name Method name for the filter's callback
+ * @param int $priority Priority of the filter (default 10)
+ *
+ * @return bool Whether the function is removed.
+ */
+ function wc_ts_remove_class_filter( $tag, $class_name = '', $method_name = '', $priority = 10 ) {
+ global $wp_filter;
+
+ // Check that filter actually exists first
+ if ( ! isset( $wp_filter[ $tag ] ) ) return FALSE;
+
+ /**
+ * If filter config is an object, means we're using WordPress 4.7+ and the config is no longer
+ * a simple array, rather it is an object that implements the ArrayAccess interface.
+ *
+ * To be backwards compatible, we set $callbacks equal to the correct array as a reference (so $wp_filter is updated)
+ *
+ * @see https://make.wordpress.org/core/2016/09/08/wp_hook-next-generation-actions-and-filters/
+ */
+ if ( is_object( $wp_filter[ $tag ] ) && isset( $wp_filter[ $tag ]->callbacks ) ) {
+ // Create $fob object from filter tag, to use below
+ $fob = $wp_filter[ $tag ];
+ $callbacks = &$wp_filter[ $tag ]->callbacks;
+ } else {
+ $callbacks = &$wp_filter[ $tag ];
+ }
+
+ // Exit if there aren't any callbacks for specified priority
+ if ( ! isset( $callbacks[ $priority ] ) || empty( $callbacks[ $priority ] ) ) return FALSE;
+
+ // Loop through each filter for the specified priority, looking for our class & method
+ foreach( (array) $callbacks[ $priority ] as $filter_id => $filter ) {
+
+ // Filter should always be an array - array( $this, 'method' ), if not goto next
+ if ( ! isset( $filter[ 'function' ] ) || ! is_array( $filter[ 'function' ] ) ) continue;
+
+ // If first value in array is not an object, it can't be a class
+ if ( ! is_object( $filter[ 'function' ][ 0 ] ) ) continue;
+
+ // Method doesn't match the one we're looking for, goto next
+ if ( $filter[ 'function' ][ 1 ] !== $method_name ) continue;
+
+ // Method matched, now let's check the Class
+ if ( get_class( $filter[ 'function' ][ 0 ] ) === $class_name ) {
+
+ // WordPress 4.7+ use core remove_filter() since we found the class object
+ if( isset( $fob ) ){
+ // Handles removing filter, reseting callback priority keys mid-iteration, etc.
+ $fob->remove_filter( $tag, $filter['function'], $priority );
+
+ } else {
+ // Use legacy removal process (pre 4.7)
+ unset( $callbacks[ $priority ][ $filter_id ] );
+ // and if it was the only filter in that priority, unset that priority
+ if ( empty( $callbacks[ $priority ] ) ) {
+ unset( $callbacks[ $priority ] );
+ }
+ // and if the only filter for that tag, set the tag to an empty array
+ if ( empty( $callbacks ) ) {
+ $callbacks = array();
+ }
+ // Remove this filter from merged_filters, which specifies if filters have been sorted
+ unset( $GLOBALS['merged_filters'][ $tag ] );
+ }
+
+ return TRUE;
+ }
+ }
+
+ return FALSE;
+ }
+}
+
+if ( ! function_exists( 'wc_ts_remove_class_action' ) ) {
+ /**
+ * Remove Class Action Without Access to Class Object
+ *
+ * In order to use the core WordPress remove_action() on an action added with the callback
+ * to a class, you either have to have access to that class object, or it has to be a call
+ * to a static method. This method allows you to remove actions with a callback to a class
+ * you don't have access to.
+ *
+ * Works with WordPress 1.2+ (4.7+ support added 9-19-2016)
+ *
+ * @param string $tag Action to remove
+ * @param string $class_name Class name for the action's callback
+ * @param string $method_name Method name for the action's callback
+ * @param int $priority Priority of the action (default 10)
+ *
+ * @return bool Whether the function is removed.
+ */
+ function wc_ts_remove_class_action( $tag, $class_name = '', $method_name = '', $priority = 10 ) {
+ wc_ts_remove_class_filter( $tag, $class_name, $method_name, $priority );
+ }
+}
diff --git a/packages/woocommerce-trusted-shops/includes/widgets/class-wc-trusted-shops-widget-review-sticker.php b/packages/woocommerce-trusted-shops/includes/widgets/class-wc-trusted-shops-widget-review-sticker.php
new file mode 100644
index 000000000..7b20bb3b6
--- /dev/null
+++ b/packages/woocommerce-trusted-shops/includes/widgets/class-wc-trusted-shops-widget-review-sticker.php
@@ -0,0 +1,63 @@
+widget_cssclass = 'woocommerce woocommerce_gzd widget_trusted_shops_review_sticker';
+ $this->widget_description = _x( "Show your TS shop review sticker.", 'trusted-shops', 'woocommerce-germanized' );
+ $this->widget_id = 'woocommerce_gzd_widget_trusted_shops_shop_review_sticker';
+ $this->widget_name = _x( 'Trusted Shops Shop Review Sticker', 'trusted-shops', 'woocommerce-germanized' );
+ $this->settings = array(
+ 'title' => array(
+ 'type' => 'text',
+ 'std' => _x( 'Trusted Shops Reviews', 'trusted-shops', 'woocommerce-germanized' ),
+ 'label' => _x( 'Title', 'trusted-shops', 'woocommerce-germanized' ),
+ ),
+ );
+ parent::__construct();
+ }
+
+ /**
+ * widget function.
+ *
+ * @see WP_Widget
+ * @access public
+ * @param array $args
+ * @param array $instance
+ * @return void
+ */
+ public function widget( $args, $instance ) {
+ extract( $args );
+
+ $element = "#ts_review_sticker_{$this->number}";
+
+ $title = apply_filters('widget_title', empty( $instance['title'] ) ? _x( 'Trusted Shops Reviews', 'trusted-shops', 'woocommerce-germanized' ) : $instance['title'], $instance, $this->id_base );
+
+ echo $before_widget;
+
+ if ( $title )
+ echo $before_title . $title . $after_title;
+
+ echo '';
+
+ echo $after_widget;
+ }
+}
+
+?>
diff --git a/packages/woocommerce-trusted-shops/license.txt b/packages/woocommerce-trusted-shops/license.txt
new file mode 100644
index 000000000..e4e3f0c5f
--- /dev/null
+++ b/packages/woocommerce-trusted-shops/license.txt
@@ -0,0 +1,699 @@
+WooCommerce Trusted Shops
+
+Copyright 2011 by the contributors
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
+This program incorporates work covered by the following copyright and
+permission notices:
+
+ WooCommerce
+
+=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright © 2007 Free Software Foundation, Inc.
+
+
+ version, '3.1', '>=' ) ? true : false;
+ }
+
+ public static function is_integration() {
+ return class_exists( 'WooCommerce_Germanized' ) ? true : false;
+ }
+
+ private static function includes() {
+ include_once self::get_path() . '/includes/class-wc-trusted-shops-core.php';
+ }
+
+ public static function init_hooks() {}
+
+ /**
+ * Return the version of the package.
+ *
+ * @return string
+ */
+ public static function get_version() {
+ return self::VERSION;
+ }
+
+ /**
+ * Return the path to the package.
+ *
+ * @return string
+ */
+ public static function get_path() {
+ return dirname( __DIR__ );
+ }
+
+ /**
+ * Return the path to the package.
+ *
+ * @return string
+ */
+ public static function get_url() {
+ return plugins_url( '', __DIR__ );
+ }
+
+ public static function get_assets_url() {
+ return self::get_url() . '/assets';
+ }
+
+ private static function define_constant( $name, $value ) {
+ if ( ! defined( $name ) ) {
+ define( $name, $value );
+ }
+ }
+}
diff --git a/packages/woocommerce-trusted-shops/templates/emails/cancel-review-reminder.php b/packages/woocommerce-trusted-shops/templates/emails/cancel-review-reminder.php
new file mode 100644
index 000000000..8b0c2ad6d
--- /dev/null
+++ b/packages/woocommerce-trusted-shops/templates/emails/cancel-review-reminder.php
@@ -0,0 +1,14 @@
+
+
+
+
diff --git a/packages/woocommerce-trusted-shops/templates/emails/customer-trusted-shops.php b/packages/woocommerce-trusted-shops/templates/emails/customer-trusted-shops.php
new file mode 100644
index 000000000..5c948fa35
--- /dev/null
+++ b/packages/woocommerce-trusted-shops/templates/emails/customer-trusted-shops.php
@@ -0,0 +1,35 @@
+
+
+
+
+
+
+
+' . _x( 'cancel review reminder', 'trusted-shops', 'woocommerce-germanized' ) . '' ); ?>
+| + |
get_selector( 'product_sticker' ); ?>>
+
+
diff --git a/packages/woocommerce-trusted-shops/templates/trusted-shops/product-widget-tpl.php b/packages/woocommerce-trusted-shops/templates/trusted-shops/product-widget-tpl.php
new file mode 100644
index 000000000..08d41768a
--- /dev/null
+++ b/packages/woocommerce-trusted-shops/templates/trusted-shops/product-widget-tpl.php
@@ -0,0 +1,22 @@
+
+
diff --git a/packages/woocommerce-trusted-shops/templates/trusted-shops/product-widget.php b/packages/woocommerce-trusted-shops/templates/trusted-shops/product-widget.php
new file mode 100644
index 000000000..1dd2927d2
--- /dev/null
+++ b/packages/woocommerce-trusted-shops/templates/trusted-shops/product-widget.php
@@ -0,0 +1,23 @@
+ID );
+$plugin = isset( $plugin ) ? $plugin : WC_trusted_shops()->trusted_shops;
+$skus = $plugin->get_product_skus( $post->ID );
+?>
+
+get_selector( 'product_widget' ); ?>>
+
+
+
+
diff --git a/packages/woocommerce-trusted-shops/templates/trusted-shops/review-sticker-tpl.php b/packages/woocommerce-trusted-shops/templates/trusted-shops/review-sticker-tpl.php
new file mode 100644
index 000000000..2f9890663
--- /dev/null
+++ b/packages/woocommerce-trusted-shops/templates/trusted-shops/review-sticker-tpl.php
@@ -0,0 +1,33 @@
+
+
+
diff --git a/packages/woocommerce-trusted-shops/templates/trusted-shops/review-sticker.php b/packages/woocommerce-trusted-shops/templates/trusted-shops/review-sticker.php
new file mode 100644
index 000000000..dc0f2896e
--- /dev/null
+++ b/packages/woocommerce-trusted-shops/templates/trusted-shops/review-sticker.php
@@ -0,0 +1,17 @@
+
+
+get_selector( 'review_sticker', $element ); ?>>
+
+
diff --git a/packages/woocommerce-trusted-shops/templates/trusted-shops/rich-snippets-tpl.php b/packages/woocommerce-trusted-shops/templates/trusted-shops/rich-snippets-tpl.php
new file mode 100644
index 000000000..0f9afef14
--- /dev/null
+++ b/packages/woocommerce-trusted-shops/templates/trusted-shops/rich-snippets-tpl.php
@@ -0,0 +1,22 @@
+
+
diff --git a/packages/woocommerce-trusted-shops/templates/trusted-shops/rich-snippets.php b/packages/woocommerce-trusted-shops/templates/trusted-shops/rich-snippets.php
new file mode 100644
index 000000000..a92ee4755
--- /dev/null
+++ b/packages/woocommerce-trusted-shops/templates/trusted-shops/rich-snippets.php
@@ -0,0 +1,16 @@
+
+
+
diff --git a/packages/woocommerce-trusted-shops/templates/trusted-shops/thankyou.php b/packages/woocommerce-trusted-shops/templates/trusted-shops/thankyou.php
new file mode 100644
index 000000000..a2f229bcb
--- /dev/null
+++ b/packages/woocommerce-trusted-shops/templates/trusted-shops/thankyou.php
@@ -0,0 +1,49 @@
+
+
+
diff --git a/packages/woocommerce-trusted-shops/templates/trusted-shops/trustbadge-tpl.php b/packages/woocommerce-trusted-shops/templates/trusted-shops/trustbadge-tpl.php
new file mode 100644
index 000000000..71ed15bd1
--- /dev/null
+++ b/packages/woocommerce-trusted-shops/templates/trusted-shops/trustbadge-tpl.php
@@ -0,0 +1,29 @@
+
+
+
diff --git a/packages/woocommerce-trusted-shops/templates/trusted-shops/trustbadge.php b/packages/woocommerce-trusted-shops/templates/trusted-shops/trustbadge.php
new file mode 100644
index 000000000..b6da7d249
--- /dev/null
+++ b/packages/woocommerce-trusted-shops/templates/trusted-shops/trustbadge.php
@@ -0,0 +1,15 @@
+
+
+
diff --git a/packages/woocommerce-trusted-shops/woocommerce-trusted-shops.php b/packages/woocommerce-trusted-shops/woocommerce-trusted-shops.php
new file mode 100644
index 000000000..55cdf898f
--- /dev/null
+++ b/packages/woocommerce-trusted-shops/woocommerce-trusted-shops.php
@@ -0,0 +1,73 @@
+
+
+
+
+ composer install',
+ '' . esc_html( str_replace( ABSPATH, '', __DIR__ ) ) . ''
+ );
+ ?>
+