+ { children }
+
+ );
+};
+
+export default Noninteractive;
diff --git a/packages/woocommerce-germanized-dhl/assets/js/base/components/radio-control-accordion/index.js b/packages/woocommerce-germanized-dhl/assets/js/base/components/radio-control-accordion/index.js
new file mode 100644
index 000000000..b6987e899
--- /dev/null
+++ b/packages/woocommerce-germanized-dhl/assets/js/base/components/radio-control-accordion/index.js
@@ -0,0 +1,73 @@
+/**
+ * External dependencies
+ */
+import classnames from 'classnames';
+import { withInstanceId } from '@wordpress/compose';
+
+/**
+ * Internal dependencies
+ */
+import RadioControlOption from '../radio-control/option';
+
+const RadioControlAccordion = ( {
+ className,
+ instanceId,
+ id,
+ selected,
+ onChange,
+ options,
+} ) => {
+ const radioControlId = id || instanceId;
+
+ if ( ! options.length ) {
+ return null;
+ }
+ return (
+
+ { options.map( ( option ) => {
+ const hasOptionContent =
+ typeof option === 'object' && 'content' in option;
+ const checked = option.value === selected;
+ return (
+
+ );
+};
+
+export default withInstanceId( RadioControlAccordion );
+export { RadioControlAccordion };
diff --git a/packages/woocommerce-germanized-dhl/assets/js/base/components/radio-control/index.js b/packages/woocommerce-germanized-dhl/assets/js/base/components/radio-control/index.js
new file mode 100644
index 000000000..419731150
--- /dev/null
+++ b/packages/woocommerce-germanized-dhl/assets/js/base/components/radio-control/index.js
@@ -0,0 +1,55 @@
+/**
+ * External dependencies
+ */
+import classnames from 'classnames';
+import { useInstanceId } from '@wordpress/compose';
+/**
+ * Internal dependencies
+ */
+import RadioControlOption from './option';
+import './style.scss';
+
+const RadioControl = ( {
+ className,
+ id,
+ selected,
+ onChange,
+ options,
+ disabled,
+} ) => {
+ const instanceId = useInstanceId( RadioControl );
+ const radioControlId = id || instanceId;
+
+ if ( ! options.length ) {
+ return null;
+ }
+
+ return (
+
+ {
+ onChange( value );
+ if ( typeof option.onChange === 'function' ) {
+ option.onChange( value );
+ }
+ } }
+ />
+ { hasOptionContent && checked && (
+
+ );
+ } ) }
+
+ { option.content }
+
+ ) }
+
+ { options.map( ( option ) => (
+ {
+ onChange( value );
+ if ( typeof option.onChange === 'function' ) {
+ option.onChange( value );
+ }
+ } }
+ disabled={ disabled }
+ />
+ ) ) }
+
+ );
+};
+
+export default RadioControl;
+export { default as RadioControlOption } from './option';
+export { default as RadioControlOptionLayout } from './option-layout';
diff --git a/packages/woocommerce-germanized-dhl/assets/js/base/components/radio-control/option-layout.js b/packages/woocommerce-germanized-dhl/assets/js/base/components/radio-control/option-layout.js
new file mode 100644
index 000000000..a9a96d8c0
--- /dev/null
+++ b/packages/woocommerce-germanized-dhl/assets/js/base/components/radio-control/option-layout.js
@@ -0,0 +1,52 @@
+const OptionLayout = ( {
+ label,
+ secondaryLabel,
+ description,
+ secondaryDescription,
+ id,
+} ) => {
+ return (
+
+
+ );
+};
+
+export default OptionLayout;
diff --git a/packages/woocommerce-germanized-dhl/assets/js/base/components/radio-control/option.js b/packages/woocommerce-germanized-dhl/assets/js/base/components/radio-control/option.js
new file mode 100644
index 000000000..0871ba2be
--- /dev/null
+++ b/packages/woocommerce-germanized-dhl/assets/js/base/components/radio-control/option.js
@@ -0,0 +1,61 @@
+/**
+ * External dependencies
+ */
+import classnames from 'classnames';
+
+/**
+ * Internal dependencies
+ */
+import OptionLayout from './option-layout';
+
+const Option = ( {
+ checked,
+ name,
+ onChange,
+ option,
+ disabled,
+} ) => {
+ const { value, label, description, secondaryLabel, secondaryDescription } =
+ option;
+ const onChangeValue = ( event ) => onChange( event.target.value );
+
+ return (
+
+ );
+};
+
+export default Option;
diff --git a/packages/woocommerce-germanized-dhl/assets/js/base/components/radio-control/style.scss b/packages/woocommerce-germanized-dhl/assets/js/base/components/radio-control/style.scss
new file mode 100644
index 000000000..e69de29bb
diff --git a/packages/woocommerce-germanized-dhl/assets/js/base/utils/debounce.js b/packages/woocommerce-germanized-dhl/assets/js/base/utils/debounce.js
new file mode 100644
index 000000000..008707ee1
--- /dev/null
+++ b/packages/woocommerce-germanized-dhl/assets/js/base/utils/debounce.js
@@ -0,0 +1,28 @@
+export const debounce = (
+ func,
+ wait,
+ immediate
+) => {
+ let timeout;
+ let latestArgs;
+
+ const debounced = ( ( ...args ) => {
+ latestArgs = args;
+ if ( timeout ) clearTimeout( timeout );
+ timeout = setTimeout( () => {
+ timeout = null;
+ if ( ! immediate && latestArgs ) func( ...latestArgs );
+ }, wait );
+ if ( immediate && ! timeout ) func( ...args );
+ } );
+
+ debounced.flush = () => {
+ if ( timeout && latestArgs ) {
+ func( ...latestArgs );
+ clearTimeout( timeout );
+ timeout = null;
+ }
+ };
+
+ return debounced;
+};
diff --git a/packages/woocommerce-germanized-dhl/assets/js/base/utils/index.js b/packages/woocommerce-germanized-dhl/assets/js/base/utils/index.js
new file mode 100644
index 000000000..679ebef40
--- /dev/null
+++ b/packages/woocommerce-germanized-dhl/assets/js/base/utils/index.js
@@ -0,0 +1 @@
+export * from './debounce';
\ No newline at end of file
diff --git a/packages/woocommerce-germanized-dhl/assets/js/blocks/checkout/index.js b/packages/woocommerce-germanized-dhl/assets/js/blocks/checkout/index.js
new file mode 100644
index 000000000..59bb39b0d
--- /dev/null
+++ b/packages/woocommerce-germanized-dhl/assets/js/blocks/checkout/index.js
@@ -0,0 +1,2 @@
+import './slotfills/dom-watcher';
+import './slotfills/preferred-services';
\ No newline at end of file
diff --git a/packages/woocommerce-germanized-dhl/assets/js/blocks/checkout/slotfills/dom-watcher.js b/packages/woocommerce-germanized-dhl/assets/js/blocks/checkout/slotfills/dom-watcher.js
new file mode 100644
index 000000000..2ce02ebb8
--- /dev/null
+++ b/packages/woocommerce-germanized-dhl/assets/js/blocks/checkout/slotfills/dom-watcher.js
@@ -0,0 +1,39 @@
+import { ExperimentalOrderMeta } from '@woocommerce/blocks-checkout';
+import { registerPlugin } from '@wordpress/plugins';
+import { useEffect } from "@wordpress/element";
+import { dispatch, select } from '@wordpress/data';
+import { CHECKOUT_STORE_KEY } from '@woocommerce/block-data';
+
+const DomWatcher = ({
+ extensions,
+ cart
+}) => {
+ /**
+ * Use this little helper which sets the default checkout data in case it
+ * does not exist, e.g. the checkboxes block is missing to prevent extension errors.
+ *
+ * @see https://github.com/woocommerce/woocommerce-blocks/issues/11446
+ */
+ useEffect(() => {
+ const extensionsData = select( CHECKOUT_STORE_KEY ).getExtensionData();
+
+ if ( ! extensionsData.hasOwnProperty( 'woocommerce-gzd-dhl' ) ) {
+ dispatch( CHECKOUT_STORE_KEY ).__internalSetExtensionData( 'woocommerce-gzd-dhl', {} );
+ }
+ }, [] );
+
+ return null;
+};
+
+const render = () => {
+ return (
+
+ { label && (
+
+ { label }
+
+ ) }
+ { secondaryLabel && (
+
+ { secondaryLabel }
+
+ ) }
+
+ { ( description || secondaryDescription ) && (
+
+ { description && (
+
+ { description }
+
+ ) }
+ { secondaryDescription && (
+
+ { secondaryDescription }
+
+ ) }
+
+ ) }
+
+
+ );
+};
+
+const DhlPreferredLocation = ( props ) => {
+ const {
+ setPreferredOption,
+ preferredOptions,
+ } = props;
+
+ const location = preferredOptions.hasOwnProperty( 'preferred_location' ) ? preferredOptions['preferred_location'] : '';
+
+ return (
+ <>
+ { _x( 'Choose a weather-protected and non-visible place on your property, where we can deposit the parcel in your absence.', 'dhl', 'woocommerce-germanized' ) }
+
+
+ { _x( 'Choose a delivery day', 'dhl', 'woocommerce-germanized' ) }
+
+ { costValue > 0 &&
+ (+
+ { preferredDays.map( ( preferred ) => {
+ const checked = preferredDay === preferred.date;
+
+ return (
+ {
+ setPreferredOption( 'preferred_day', preferred.date );
+ } }
+ checked={ checked }
+ className={ classnames(
+ `wc-gzd-dhl-preferred-day`,
+ {
+ active: checked
+ }
+ ) }
+ >
+
+
+ { preferred.day }
+
+
+ { preferred.week_day }
+
+
+
+ );
+ } ) }
+
+
+ {
+ setPreferredOption( 'preferred_location_type', value );
+ } }
+ options={ options }
+ />
+
+ );
+};
+
+const DhlCdpOptions = (
+ props
+) => {
+ const { preferredOptions, setPreferredOption, homeDeliveryCost, currency } = props;
+ const preferredDeliveryType = preferredOptions.hasOwnProperty( 'preferred_delivery_type' ) ? preferredOptions['preferred_delivery_type'] : '';
+ const costValue = parseInt( homeDeliveryCost, 10 );
+
+ const options = [
+ {
+ value: 'cdp',
+ label: _x( 'Shop', 'dhl', 'woocommerce-germanized' ),
+ content: (
+ _x( 'Delivery to nearby parcel store/locker or to the front door.', 'dhl', 'woocommerce-germanized' )
+ ),
+ secondaryLabel: costValue > 0 ? (
+ { _x( 'Choose a preferred location', 'dhl', 'woocommerce-germanized' ) }
+
+ {
+ setPreferredOption( 'preferred_delivery_type', value );
+ } }
+ options={ options }
+ />
+
+ );
+};
+
+const DhlPreferredOptions = (
+ props
+) => {
+ const { preferredDayEnabled, preferredLocationEnabled, preferredNeighborEnabled } = props;
+
+ return (
+ { _x( 'Choose a delivery type', 'dhl', 'woocommerce-germanized' ) }
+ +
+ { preferredDayEnabled ? (
+
+ );
+};
+
+const DhlPreferredWrapper = ({
+ props,
+ children
+}) => {
+ return (
+
+
+ );
+};
+
+const DhlPreferredDeliveryOptions = ({
+ extensions,
+ cart,
+ components
+}) => {
+ const {
+ shippingRates,
+ needsShipping,
+ isLoadingRates,
+ isSelectingRate,
+ } = useSelect( ( select ) => {
+ const isEditor = !! select( 'core/editor' );
+ const store = select( CART_STORE_KEY );
+ const rates = isEditor
+ ? []
+ : store.getShippingRates();
+ return {
+ shippingRates: rates,
+ needsShipping: store.getNeedsShipping(),
+ isLoadingRates: store.isCustomerDataUpdating(),
+ isSelectingRate: store.isShippingRateBeingSelected(),
+ };
+ } );
+
+ const [ needsUpdate, setNeedsUpdate ] = useState( false );
+ const shippingProviders = getSelectedShippingProviders( shippingRates );
+ const hasDhlProvider = hasShippingProvider( shippingProviders, 'dhl' );
+ const { __internalSetExtensionData } = useDispatch( CHECKOUT_STORE_KEY );
+
+ const { isCustomerDataUpdating } = useSelect(
+ ( select ) => {
+ return {
+ isCustomerDataUpdating: select( CART_STORE_KEY ).isCustomerDataUpdating(),
+ };
+ }
+ );
+
+ const {
+ activePaymentMethod
+ } = useSelect( ( select ) => {
+ const store = select( PAYMENT_STORE_KEY );
+
+ return {
+ activePaymentMethod: store.getActivePaymentMethod()
+ };
+ }, [] );
+
+ const { preferredOptions } = useSelect( ( select ) => {
+ const store = select( CHECKOUT_STORE_KEY );
+
+ return {
+ preferredOptions: getDhlCheckoutData( store.getExtensionData() )
+ };
+ } );
+
+ const dhlOptions = getDhlCheckoutData( extensions );
+ const preferredDayCost = parseInt( dhlOptions.hasOwnProperty( 'preferred_day_cost' ) ? dhlOptions['preferred_day_cost'] : 0, 10 );
+ const homeDeliveryCost = parseInt( dhlOptions.hasOwnProperty( 'preferred_home_delivery_cost' ) ? dhlOptions['preferred_home_delivery_cost'] : 0, 10 );
+
+ const setDhlOption = ( option, value, updateCart = true ) => {
+ const checkoutOptions = { ...preferredOptions };
+ checkoutOptions[ option ] = value;
+
+ setDhlCheckoutData( checkoutOptions );
+
+ if ( updateCart ) {
+ if ( 'preferred_day' === option && preferredDayCost > 0 ) {
+ extensionCartUpdate( {
+ namespace: 'woocommerce-gzd-dhl-checkout-fees',
+ data: checkoutOptions,
+ } );
+ } else if ( 'preferred_delivery_type' === option && homeDeliveryCost > 0 ) {
+ extensionCartUpdate( {
+ namespace: 'woocommerce-gzd-dhl-checkout-fees',
+ data: checkoutOptions,
+ } );
+ }
+ }
+ };
+
+ const setPreferredOption = useCallback(
+ ( option, value ) => {
+ setDhlOption( option, value );
+ },
+ [ setDhlOption, preferredOptions ]
+ );
+
+ const totalsCurrency = getCurrencyFromPriceResponse( cart.cartTotals );
+ const excludedPaymentGateways = getSetting( 'dhlExcludedPaymentGateways', [] );
+ const isGatewayExcluded = _.includes( excludedPaymentGateways, activePaymentMethod );
+
+ const preferredDayEnabled = dhlOptions.preferred_day_enabled && dhlOptions.preferred_days.length > 0;
+ const preferredLocationEnabled = dhlOptions.preferred_location_enabled;
+ const preferredNeighborEnabled = dhlOptions.preferred_neighbor_enabled;
+ const preferredDeliveryTypeEnabled = dhlOptions.preferred_delivery_type_enabled;
+ const cdpCountries = getSetting( 'dhlCdpCountries', [] );
+
+ const preferredOptionsAvailable = 'DE' === cart.shippingAddress.country && ( preferredDayEnabled || preferredNeighborEnabled || preferredLocationEnabled );
+ const isCdpAvailable = preferredDeliveryTypeEnabled && _.includes( cdpCountries, cart.shippingAddress.country );
+ const isAvailable = hasDhlProvider && ! isGatewayExcluded && ( isCdpAvailable || preferredOptionsAvailable );
+
+ useEffect(() => {
+ if ( isAvailable ) {
+ const currentData = getDhlCheckoutData( select( CHECKOUT_STORE_KEY ).getExtensionData() );
+
+ if ( ! preferredOptionsAvailable ) {
+ // Reset data
+ const checkoutOptions = Object.keys( currentData ).reduce(
+ ( accumulator, current ) => {
+ accumulator[current] = '';
+ return accumulator
+ }, {} );
+
+ if ( isCdpAvailable ) {
+ checkoutOptions['preferred_delivery_type'] = dhlOptions['preferred_delivery_type'];
+ }
+
+ setDhlCheckoutData( checkoutOptions );
+ } else {
+ const checkoutOptions = { ...currentData,
+ 'preferred_day': preferredOptionsAvailable && preferredDayEnabled ? dhlOptions['preferred_day'] : '',
+ 'preferred_delivery_type': '',
+ };
+
+ setDhlCheckoutData( checkoutOptions );
+ }
+ }
+ }, [
+ preferredOptionsAvailable,
+ isCdpAvailable,
+ __internalSetExtensionData
+ ] );
+
+ // Debounce re-disable since disabling process itself will incur additional mutations which should be ignored.
+ const maybeUpdate = useDebouncedCallback( () => {
+ const currentData = getDhlCheckoutData( select( CHECKOUT_STORE_KEY ).getExtensionData() );
+
+ if ( ! isCustomerDataUpdating ) {
+ extensionCartUpdate( {
+ namespace: 'woocommerce-gzd-dhl-checkout-fees',
+ data: currentData,
+ } );
+
+ setNeedsUpdate( () => { return false } );
+ }
+ }, 2000 );
+
+ useEffect(() => {
+ if ( isAvailable ) {
+ const currentData = getDhlCheckoutData( select( CHECKOUT_STORE_KEY ).getExtensionData() );
+
+ const checkoutOptions = { ...currentData,
+ 'preferred_day': preferredOptionsAvailable && preferredDayEnabled ? dhlOptions['preferred_day'] : '',
+ 'preferred_delivery_type': isCdpAvailable ? dhlOptions['preferred_delivery_type'] : '',
+ };
+
+ setDhlCheckoutData( checkoutOptions );
+ } else {
+ const currentData = getDhlCheckoutData( select( CHECKOUT_STORE_KEY ).getExtensionData() );
+
+ // Reset data
+ const checkoutOptions = Object.keys( currentData ).reduce(
+ ( accumulator, current ) => {
+ accumulator[current] = '';
+ return accumulator
+ }, {} );
+
+ setDhlCheckoutData( checkoutOptions );
+ }
+
+ setNeedsUpdate( () => { return true } );
+ }, [
+ isAvailable
+ ] );
+
+ /**
+ * Maybe delay the extensionCartUpdate in case shipping data is invalid
+ * to prevent (dirty data) race conditions with the update-customer call as
+ * the update-customer call will only be triggered when the data is errorless.
+ *
+ * Be careful: Calling the extensionCartUpdate overrides the current checkout data
+ * with data from the customer session. If that data has not yet been persisted, the current
+ * checkout data will be replaced with old data.
+ */
+ useEffect(() => {
+ if ( needsUpdate ) {
+ const validationStore = select( VALIDATION_STORE_KEY );
+ const invalidProps = [
+ ...Object.keys( cart.shippingAddress ).filter( ( key ) => {
+ return (
+ validationStore.getValidationError( 'shipping_' + key ) !== undefined
+ );
+ } ),
+ ].filter( Boolean );
+
+ if ( invalidProps.length === 0 ) {
+ // No errors found, lets update.
+ maybeUpdate();
+ }
+ }
+
+ return () => {
+ maybeUpdate.cancel();
+ };
+ }, [
+ needsUpdate,
+ setNeedsUpdate,
+ cart.shippingAddress,
+ isAvailable,
+ maybeUpdate
+ ] );
+
+ if ( ! isAvailable || ( ! preferredOptionsAvailable && ! isCdpAvailable ) ) {
+ return null;
+ }
+
+ return (
+ + { _x( 'DHL Preferred Delivery. Delivered just as you wish.', 'dhl', 'woocommerce-germanized' ) } + +
+ { children } +
+
+ { preferredOptionsAvailable &&
+
+
+ );
+};
+
+const render = () => {
+ return (
+ ' + message + '
- ' + data.messages + '
' + $addressInput.data( 'desc-dhl' ) + '
' ); + } + } + }, + + isEnabled: function() { + var self = germanized.dhl_parcel_locator; + + return self.isAvailable() && $( self.wrapper + ' #shipping_address_type' ).val() === 'dhl'; + }, + + getPaymentMethod: function() { + var $selected = $( '.payment_methods .input-radio:checked' ); + + if ( $selected ) { + return $selected.val(); + } + + return ''; + }, + + 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(), + paymentMethod = self.getPaymentMethod(), + methodData = self.getShippingMethodData( shippingMethod ), + isAvailable = true; + + if ( $.inArray( paymentMethod, self.params.excluded_gateways ) !== -1 ) { + isAvailable = false; + } + + 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/static/preferred-services.js b/packages/woocommerce-germanized-dhl/assets/js/static/preferred-services.js new file mode 100644 index 000000000..7b212fe78 --- /dev/null +++ b/packages/woocommerce-germanized-dhl/assets/js/static/preferred-services.js @@ -0,0 +1,79 @@ + +window.germanized = window.germanized || {}; +window.germanized.dhl_preferred_services = window.germanized.dhl_preferred_services || {}; + +( function( $, germanized ) { + + /** + * Core + */ + germanized.dhl_preferred_services = { + + params: {}, + + init: function () { + var self = germanized.dhl_preferred_services; + self.params = wc_gzd_dhl_preferred_services_params; + + $( document.body ).on( 'updated_checkout', self.afterRefreshCheckout ); + + $( document ) + .on( 'change', '.dhl-preferred-service-content .dhl-preferred-location-types input', self.onChangeLocationType ) + .on( 'change', '.woocommerce-checkout #billing_postcode', self.triggerCheckoutRefresh ) + .on( 'change', '.woocommerce-checkout #shipping_postcode', self.triggerCheckoutRefresh ) + .on( 'change', '.dhl-preferred-service-content .dhl-preferred-service-times input', self.triggerCheckoutRefresh ) + .on( 'change', '.dhl-preferred-service-content .dhl-preferred-delivery-types input', self.triggerCheckoutRefresh ); + + if ( self.params.payment_gateways_excluded ) { + $( document.body ).on( 'payment_method_selected', self.triggerCheckoutRefresh ); + } + + self.afterRefreshCheckout(); + }, + + triggerCheckoutRefresh: function() { + $( document.body ).trigger( 'update_checkout' ); + }, + + afterRefreshCheckout: function() { + var self = germanized.dhl_preferred_services; + + self.initTipTip(); + self.onChangeLocationType(); + }, + + onChangeLocationType: function() { + var self = germanized.dhl_preferred_services, + $box = $( '.dhl-preferred-service-content .dhl-preferred-location-types input:checked' ); + + $( '.dhl-preferred-service-content .dhl-preferred-service-location-data' ).hide(); + + if ( $box.length > 0 ) { + if ( 'place' === $box.val() ) { + $( '.dhl-preferred-service-content .dhl-preferred-service-location-place' ).show(); + } else if ( 'neighbor' === $box.val() ) { + $( '.dhl-preferred-service-content .dhl-preferred-service-location-neighbor' ).show(); + } + } + }, + + initTipTip: function() { + + // Remove any lingering tooltips + $( '#tiptip_holder' ).removeAttr( 'style' ); + $( '#tiptip_arrow' ).removeAttr( 'style' ); + + $( '.dhl-preferred-service-content .woocommerce-help-tip' ).tipTip({ + 'attribute': 'data-tip', + 'fadeIn': 50, + 'fadeOut': 50, + 'delay': 200 + }); + } + }; + + $( document ).ready( function() { + germanized.dhl_preferred_services.init(); + }); + +})( jQuery, window.germanized ); diff --git a/packages/woocommerce-germanized-dhl/assets/wsdl/OneClickForAppV3.wsdl b/packages/woocommerce-germanized-dhl/assets/wsdl/OneClickForAppV3.wsdl new file mode 100644 index 000000000..ee4fe0066 --- /dev/null +++ b/packages/woocommerce-germanized-dhl/assets/wsdl/OneClickForAppV3.wsdl @@ -0,0 +1,2743 @@ +
+ Element provides terms of trades, incoterms codes:
+
+ - DDP (Delivery Duty Paid)
+ - DXV (Delivery Duty Paid (excl. VAT))
+ - DAP (formerly DDU, Delivery At Place)
+ - DDX (Delivery Duty Paid (excl. Duties, taxes and VAT)
+ - CPT (Carriage Paid To (within EU only))
+
+ are vaild values.
+
+ '+e+"
- '+a.messages+"
'+i.data("desc-dhl")+"
")))},isEnabled:function(){var r=a.dhl_parcel_locator;return r.isAvailable()&&"dhl"===e(r.wrapper+" #shipping_address_type").val()},getPaymentMethod:function(){var a=e(".payment_methods .input-radio:checked");return a?a.val():""},getShippingMethod:function(a){var r,o="",p=a||!0;return e("select.shipping_method").length>0?o=e("select.shipping_method").val():e('input[name^="shipping_method"]:checked').length>0?o=e('input[name^="shipping_method"]:checked').val():e('input[name^="shipping_method"][type="hidden"]').length>0&&(o=e('input[name^="shipping_method"][type="hidden"]').val()),p?void 0!==o&&o.length>0&&(r=o.split(":")).length<=1&&(o+=":0"):void 0!==o&&o.length>0&&(r=o.split(":")).length>0&&(o=r[0]),o},pickupTypeIsAvailable:function(e){var r=a.dhl_parcel_locator,o=r.getShippingMethod(),p=!0;return r.shippingMethodSupportsPickupType(o,e)||(p=!1),p},isAvailable:function(){var r=a.dhl_parcel_locator,o=e(r.wrapper+" #shipping_country").val(),p=r.getShippingMethod(),t=r.getPaymentMethod(),d=r.getShippingMethodData(p),i=!0;return-1!==e.inArray(t,r.params.excluded_gateways)&&(i=!1),-1===e.inArray(o,r.params.supported_countries)&&(i=!1),r.isCheckout()&&(d&&0!==d.supports.length||(i=!1)),i}},e(document).ready((function(){a.dhl_parcel_locator.init()})),((window.germanizedShipments=window.germanizedShipments||{}).static=window.germanizedShipments.static||{})["parcel-locator"]={}}(); \ No newline at end of file diff --git a/packages/woocommerce-germanized-dhl/build/static/preferred-services-styles.asset.php b/packages/woocommerce-germanized-dhl/build/static/preferred-services-styles.asset.php new file mode 100644 index 000000000..e150bc586 --- /dev/null +++ b/packages/woocommerce-germanized-dhl/build/static/preferred-services-styles.asset.php @@ -0,0 +1 @@ + array(), 'version' => '8e52d369588e281ba2f7'); diff --git a/packages/woocommerce-germanized-dhl/build/static/preferred-services-styles.css b/packages/woocommerce-germanized-dhl/build/static/preferred-services-styles.css new file mode 100644 index 000000000..9875538b3 --- /dev/null +++ b/packages/woocommerce-germanized-dhl/build/static/preferred-services-styles.css @@ -0,0 +1 @@ +#tiptip_holder{display:none;left:0;position:absolute;top:0;z-index:8675309}#tiptip_holder.tip_top{padding-bottom:5px}#tiptip_holder.tip_top #tiptip_arrow_inner{border-top-color:#333;margin-left:-6px;margin-top:-7px}#tiptip_holder.tip_bottom{padding-top:5px}#tiptip_holder.tip_bottom #tiptip_arrow_inner{border-bottom-color:#333;margin-left:-6px;margin-top:-5px}#tiptip_holder.tip_right{padding-left:5px}#tiptip_holder.tip_right #tiptip_arrow_inner{border-right-color:#333;margin-left:-5px;margin-top:-6px}#tiptip_holder.tip_left{padding-right:5px}#tiptip_holder.tip_left #tiptip_arrow_inner{border-left-color:#333;margin-left:-7px;margin-top:-6px}#tiptip_content{background:#333;border-radius:3px;box-shadow:0 1px 3px rgba(0,0,0,.2);color:#fff;font-size:.8em;max-width:150px;padding:.618em 1em;text-align:center}#tiptip_content code{background:#888;padding:1px}#tiptip_arrow,#tiptip_arrow_inner{border:6px solid transparent;height:0;position:absolute;width:0}.dhl-preferred-service-content{margin-top:1em}.dhl-preferred-service-content .dhl-hidden{display:none}.dhl-preferred-service-content .dhl-preferred-service-cost{font-size:.9em}.dhl-preferred-service-content .dhl-preferred-service-item,.dhl-preferred-service-content .dhl-preferred-service-item .dhl-preferred-service-logo{margin-bottom:1em}.dhl-preferred-service-content .dhl-preferred-service-item .dhl-preferred-service-logo img{background:#fc0;margin:0;max-height:100px;max-width:100px;padding:0}.dhl-preferred-service-content .dhl-preferred-service-item .dhl-preferred-service-title{font-size:1em;font-weight:700;margin-bottom:.5em}.dhl-preferred-service-content .dhl-preferred-service-item .dhl-preferred-service-cost{margin-bottom:.5em}.dhl-preferred-service-content .dhl-preferred-service-item .dhl-preferred-service-desc{font-size:.9em;margin-bottom:.5em}.dhl-preferred-service-content .dhl-preferred-service-item .dhl-preferred-service-times{display:flex;flex-direction:row;flex-wrap:wrap;margin:0;padding:0}.dhl-preferred-service-content .dhl-preferred-service-item .dhl-preferred-service-times li{background-color:#e3e3e3;display:inline-block;flex-basis:10%;margin:0 8px 8px 0;padding:10px 0 0;text-align:center}.dhl-preferred-service-content .dhl-preferred-service-item .dhl-preferred-service-times li label{background-color:#eef4f2;color:#5f7285;cursor:pointer;display:flex;flex-direction:column;flex-wrap:wrap;font-size:.9em;font-weight:700;margin:0;padding:5px 10px;position:relative}.dhl-preferred-service-content .dhl-preferred-service-item .dhl-preferred-service-times li label .dhl-preferred-time-title{font-size:1.2em}.dhl-preferred-service-content .dhl-preferred-service-item .dhl-preferred-service-times li input[type=radio]{height:1px;opacity:0;position:absolute;width:1px}.dhl-preferred-service-content .dhl-preferred-service-item .dhl-preferred-service-times li input[type=radio]:checked~label{background-color:#fc0}.dhl-preferred-service-content .dhl-preferred-service-item .dhl-preferred-service-times.dhl-preferred-service-time li{flex-basis:inherit;flex-grow:inherit}.dhl-preferred-service-content .dhl-preferred-service-item .dhl-preferred-service-times.dhl-preferred-service-time li label .dhl-preferred-time-title{font-size:1em}.dhl-preferred-service-content .dhl-preferred-service-item .dhl-preferred-service-data input[type=text]{margin-bottom:.5em;width:100%}.dhl-preferred-service-content .dhl-preferred-service-item .woocommerce-help-tip{background:#fc0;border-radius:50%;display:inline-block;font-size:1em;font-style:normal;height:18px;line-height:18px;margin-left:5px;margin-top:-5px;padding:3px;position:relative;vertical-align:middle;width:18px}.dhl-preferred-service-content .dhl-preferred-service-item .woocommerce-help-tip:after{content:"?";cursor:help;height:100%;left:0;position:absolute;text-align:center;top:0;width:100%}.dhl-preferred-service-content .dhl-preferred-service-item .dhl-preferred-delivery-types,.dhl-preferred-service-content .dhl-preferred-service-item .dhl-preferred-location-types{align-items:center;display:flex;flex-wrap:wrap;justify-content:flex-start;list-style:none;margin:0 0 1em}.dhl-preferred-service-content .dhl-preferred-service-item .dhl-preferred-delivery-types li,.dhl-preferred-service-content .dhl-preferred-service-item .dhl-preferred-location-types li{margin-right:1em}.dhl-preferred-service-content .dhl-preferred-service-item.dhl-preferred-service-header .dhl-preferred-service-title{font-size:1.1em} diff --git a/packages/woocommerce-germanized-dhl/build/static/preferred-services-styles.js b/packages/woocommerce-germanized-dhl/build/static/preferred-services-styles.js new file mode 100644 index 000000000..4bf49343d --- /dev/null +++ b/packages/woocommerce-germanized-dhl/build/static/preferred-services-styles.js @@ -0,0 +1 @@ +!function(){"use strict";var e={};(function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})})(e),((window.germanizedShipments=window.germanizedShipments||{}).static=window.germanizedShipments.static||{})["preferred-services-styles"]=e}(); \ No newline at end of file diff --git a/packages/woocommerce-germanized-dhl/build/static/preferred-services.asset.php b/packages/woocommerce-germanized-dhl/build/static/preferred-services.asset.php new file mode 100644 index 000000000..d83d8fc4b --- /dev/null +++ b/packages/woocommerce-germanized-dhl/build/static/preferred-services.asset.php @@ -0,0 +1 @@ + array(), 'version' => '004db9f9bf1c616872db'); diff --git a/packages/woocommerce-germanized-dhl/build/static/preferred-services.js b/packages/woocommerce-germanized-dhl/build/static/preferred-services.js new file mode 100644 index 000000000..9c62e9885 --- /dev/null +++ b/packages/woocommerce-germanized-dhl/build/static/preferred-services.js @@ -0,0 +1 @@ +!function(){var e,r;window.germanized=window.germanized||{},window.germanized.dhl_preferred_services=window.germanized.dhl_preferred_services||{},e=jQuery,(r=window.germanized).dhl_preferred_services={params:{},init:function(){var t=r.dhl_preferred_services;t.params=wc_gzd_dhl_preferred_services_params,e(document.body).on("updated_checkout",t.afterRefreshCheckout),e(document).on("change",".dhl-preferred-service-content .dhl-preferred-location-types input",t.onChangeLocationType).on("change",".woocommerce-checkout #billing_postcode",t.triggerCheckoutRefresh).on("change",".woocommerce-checkout #shipping_postcode",t.triggerCheckoutRefresh).on("change",".dhl-preferred-service-content .dhl-preferred-service-times input",t.triggerCheckoutRefresh).on("change",".dhl-preferred-service-content .dhl-preferred-delivery-types input",t.triggerCheckoutRefresh),t.params.payment_gateways_excluded&&e(document.body).on("payment_method_selected",t.triggerCheckoutRefresh),t.afterRefreshCheckout()},triggerCheckoutRefresh:function(){e(document.body).trigger("update_checkout")},afterRefreshCheckout:function(){var e=r.dhl_preferred_services;e.initTipTip(),e.onChangeLocationType()},onChangeLocationType:function(){r.dhl_preferred_services;var t=e(".dhl-preferred-service-content .dhl-preferred-location-types input:checked");e(".dhl-preferred-service-content .dhl-preferred-service-location-data").hide(),t.length>0&&("place"===t.val()?e(".dhl-preferred-service-content .dhl-preferred-service-location-place").show():"neighbor"===t.val()&&e(".dhl-preferred-service-content .dhl-preferred-service-location-neighbor").show())},initTipTip:function(){e("#tiptip_holder").removeAttr("style"),e("#tiptip_arrow").removeAttr("style"),e(".dhl-preferred-service-content .woocommerce-help-tip").tipTip({attribute:"data-tip",fadeIn:50,fadeOut:50,delay:200})}},e(document).ready((function(){r.dhl_preferred_services.init()})),((window.germanizedShipments=window.germanizedShipments||{}).static=window.germanizedShipments.static||{})["preferred-services"]={}}(); \ No newline at end of file diff --git a/packages/woocommerce-germanized-dhl/build/style-checkout.css b/packages/woocommerce-germanized-dhl/build/style-checkout.css new file mode 100644 index 000000000..824d09846 --- /dev/null +++ b/packages/woocommerce-germanized-dhl/build/style-checkout.css @@ -0,0 +1 @@ +.wc-gzd-checkout-dhl .wc-gzd-checkout-dhl-title{display:flex;flex-wrap:wrap;align-items:center;font-size:1em}.wc-gzd-checkout-dhl .wc-gzd-checkout-dhl-title .dhl-icon{width:130px;height:auto;margin-left:auto}.wc-gzd-checkout-dhl .wc-block-components-radio-control-accordion-option{position:relative}.wc-gzd-checkout-dhl .wc-block-components-radio-control-accordion-option .wc-block-components-radio-control__option-layout{font-size:.875em}.wc-gzd-checkout-dhl .wc-block-components-radio-control-accordion-option .wc-block-components-radio-control-accordion-content{font-size:.875em}.wc-gzd-checkout-dhl .wc-block-components-radio-control-accordion-option .wc-block-components-radio-control__option{border-bottom:none;padding-left:56px;padding-right:16px;margin:0;padding-bottom:1em;padding-top:1em}.wc-gzd-checkout-dhl .wc-block-components-radio-control-accordion-option .wc-block-components-radio-control__option::after{border-style:solid;border-width:1px 1px 0;bottom:0;content:"";display:block;left:0;opacity:.3;pointer-events:none;position:absolute;right:0;top:0}.wc-gzd-checkout-dhl .wc-block-components-radio-control-accordion-option .wc-block-components-radio-control__option .wc-block-components-radio-control__input{left:16px}.wc-gzd-checkout-dhl .wc-block-components-radio-control-accordion-option .wc-block-components-radio-control__option::after{border-width:0}.wc-gzd-checkout-dhl .wc-block-components-radio-control-accordion-option::after{border-style:solid;border-width:1px 1px 0;bottom:0;content:"";display:block;left:0;opacity:.3;pointer-events:none;position:absolute;right:0;top:0}.wc-gzd-checkout-dhl .wc-block-components-radio-control-accordion-option:last-child::after{border-width:1px}.wc-gzd-checkout-dhl .wc-gzd-dhl-preferred-day-select{display:flex;flex-direction:row;flex-wrap:wrap;margin:0;padding:0}.wc-gzd-checkout-dhl .wc-gzd-dhl-preferred-day-select .wc-gzd-dhl-preferred-day{color:inherit;flex-basis:10%;flex-grow:1;text-align:center;padding:10px 0 0;margin:0 8px 8px 0;background-color:#e3e3e3;border:none}.wc-gzd-checkout-dhl .wc-gzd-dhl-preferred-day-select .wc-gzd-dhl-preferred-day:last-child{margin-right:0}.wc-gzd-checkout-dhl .wc-gzd-dhl-preferred-day-select .wc-gzd-dhl-preferred-day .inner{position:relative;display:flex;flex-direction:column;flex-wrap:wrap;padding:5px 10px;font-size:1em;background-color:#eef4f2;cursor:pointer;margin:0;line-height:1.8em}.wc-gzd-checkout-dhl .wc-gzd-dhl-preferred-day-select .wc-gzd-dhl-preferred-day .inner .day{font-size:1.4em}.wc-gzd-checkout-dhl .wc-gzd-dhl-preferred-day-select .wc-gzd-dhl-preferred-day.active .inner{background-color:#fc0} diff --git a/packages/woocommerce-germanized-dhl/build/wc-gzd-shipments-blocks-dhl-style.asset.php b/packages/woocommerce-germanized-dhl/build/wc-gzd-shipments-blocks-dhl-style.asset.php new file mode 100644 index 000000000..3ced3c40e --- /dev/null +++ b/packages/woocommerce-germanized-dhl/build/wc-gzd-shipments-blocks-dhl-style.asset.php @@ -0,0 +1 @@ + array(), 'version' => '2303301f334e9e994f3c'); diff --git a/packages/woocommerce-germanized-dhl/build/wc-gzd-shipments-blocks-dhl.asset.php b/packages/woocommerce-germanized-dhl/build/wc-gzd-shipments-blocks-dhl.asset.php new file mode 100644 index 000000000..3ced3c40e --- /dev/null +++ b/packages/woocommerce-germanized-dhl/build/wc-gzd-shipments-blocks-dhl.asset.php @@ -0,0 +1 @@ + array(), 'version' => '2303301f334e9e994f3c'); diff --git a/packages/woocommerce-germanized-dhl/build/wc-gzd-shipments-blocks-dhl.js b/packages/woocommerce-germanized-dhl/build/wc-gzd-shipments-blocks-dhl.js new file mode 100644 index 000000000..c3d6d1e81 --- /dev/null +++ b/packages/woocommerce-germanized-dhl/build/wc-gzd-shipments-blocks-dhl.js @@ -0,0 +1 @@ +((window.wcShipments=window.wcShipments||{}).blocks=window.wcShipments.blocks||{})["wc-gzd-shipments-blocks-dhl"]={}; \ No newline at end of file diff --git a/packages/woocommerce-germanized-dhl/i18n/holidays.php b/packages/woocommerce-germanized-dhl/i18n/holidays.php new file mode 100644 index 000000000..285922ad5 --- /dev/null +++ b/packages/woocommerce-germanized-dhl/i18n/holidays.php @@ -0,0 +1,57 @@ + array( + '2024-01-01', + '2024-01-06', + '2024-03-08', + '2024-03-28', + '2024-03-29', + '2024-03-31', + '2024-04-01', + '2024-05-01', + '2024-05-09', + '2024-05-19', + '2024-05-20', + '2024-05-30', + '2024-08-08', + '2024-08-15', + '2024-09-20', + '2024-10-03', + '2024-10-31', + '2024-11-01', + '2024-11-20', + '2024-12-25', + '2024-12-26', + '2025-01-01', + '2025-01-06', + '2025-03-08', + '2025-04-17', + '2025-04-18', + '2025-04-20', + '2025-04-21', + '2025-05-01', + '2025-05-29', + '2025-06-08', + '2025-06-09', + '2025-06-19', + '2025-08-08', + '2025-08-15', + '2025-09-20', + '2025-10-03', + '2025-10-31', + '2025-11-01', + '2025-11-19', + '2025-12-25', + '2025-12-26', + ), +); diff --git a/packages/woocommerce-germanized-dhl/i18n/iso.php b/packages/woocommerce-germanized-dhl/i18n/iso.php new file mode 100644 index 000000000..75cc005be --- /dev/null +++ b/packages/woocommerce-germanized-dhl/i18n/iso.php @@ -0,0 +1,260 @@ + 'AFG', + 'AX' => 'ALA', + 'AL' => 'ALB', + 'DZ' => 'DZA', + 'AS' => 'ASM', + 'AD' => 'AND', + 'AO' => 'AGO', + 'AI' => 'AIA', + 'AQ' => 'ATA', + 'AG' => 'ATG', + 'AR' => 'ARG', + 'AM' => 'ARM', + 'AW' => 'ABW', + 'AU' => 'AUS', + 'AT' => 'AUT', + 'AZ' => 'AZE', + 'BS' => 'BHS', + 'BH' => 'BHR', + 'BD' => 'BGD', + 'BB' => 'BRB', + 'BY' => 'BLR', + 'BE' => 'BEL', + 'BZ' => 'BLZ', + 'BJ' => 'BEN', + 'BM' => 'BMU', + 'BT' => 'BTN', + 'BO' => 'BOL', + 'BA' => 'BIH', + 'BW' => 'BWA', + 'BV' => 'BVT', + 'BR' => 'BRA', + 'VG' => 'VGB', + 'IO' => 'IOT', + 'BN' => 'BRN', + 'BG' => 'BGR', + 'BF' => 'BFA', + 'BI' => 'BDI', + 'KH' => 'KHM', + 'CM' => 'CMR', + 'CA' => 'CAN', + 'CV' => 'CPV', + 'KY' => 'CYM', + 'CF' => 'CAF', + 'TD' => 'TCD', + 'CL' => 'CHL', + 'CN' => 'CHN', + 'HK' => 'HKG', + 'MO' => 'MAC', + 'CX' => 'CXR', + 'CC' => 'CCK', + 'CO' => 'COL', + 'KM' => 'COM', + 'CG' => 'COG', + 'CD' => 'COD', + 'CK' => 'COK', + 'CR' => 'CRI', + 'CI' => 'CIV', + 'HR' => 'HRV', + 'CU' => 'CUB', + 'CY' => 'CYP', + 'CZ' => 'CZE', + 'DK' => 'DNK', + 'DJ' => 'DJI', + 'DM' => 'DMA', + 'DO' => 'DOM', + 'EC' => 'ECU', + 'EG' => 'EGY', + 'SV' => 'SLV', + 'GQ' => 'GNQ', + 'ER' => 'ERI', + 'EE' => 'EST', + 'ET' => 'ETH', + 'FK' => 'FLK', + 'FO' => 'FRO', + 'FJ' => 'FJI', + 'FI' => 'FIN', + 'FR' => 'FRA', + 'GF' => 'GUF', + 'PF' => 'PYF', + 'TF' => 'ATF', + 'GA' => 'GAB', + 'GM' => 'GMB', + 'GE' => 'GEO', + 'DE' => 'DEU', + 'GH' => 'GHA', + 'GI' => 'GIB', + 'GR' => 'GRC', + 'GL' => 'GRL', + 'GD' => 'GRD', + 'GP' => 'GLP', + 'GU' => 'GUM', + 'GT' => 'GTM', + 'GG' => 'GGY', + 'GN' => 'GIN', + 'GW' => 'GNB', + 'GY' => 'GUY', + 'HT' => 'HTI', + 'HM' => 'HMD', + 'VA' => 'VAT', + 'HN' => 'HND', + 'HU' => 'HUN', + 'IS' => 'ISL', + 'IN' => 'IND', + 'ID' => 'IDN', + 'IR' => 'IRN', + 'IQ' => 'IRQ', + 'IE' => 'IRL', + 'IM' => 'IMN', + 'IL' => 'ISR', + 'IT' => 'ITA', + 'JM' => 'JAM', + 'JP' => 'JPN', + 'JE' => 'JEY', + 'JO' => 'JOR', + 'KZ' => 'KAZ', + 'KE' => 'KEN', + 'KI' => 'KIR', + 'KP' => 'PRK', + 'KR' => 'KOR', + 'KW' => 'KWT', + 'KG' => 'KGZ', + 'LA' => 'LAO', + 'LV' => 'LVA', + 'LB' => 'LBN', + 'LS' => 'LSO', + 'LR' => 'LBR', + 'LY' => 'LBY', + 'LI' => 'LIE', + 'LT' => 'LTU', + 'LU' => 'LUX', + 'MK' => 'MKD', + 'MG' => 'MDG', + 'MW' => 'MWI', + 'MY' => 'MYS', + 'MV' => 'MDV', + 'ML' => 'MLI', + 'MT' => 'MLT', + 'MH' => 'MHL', + 'MQ' => 'MTQ', + 'MR' => 'MRT', + 'MU' => 'MUS', + 'YT' => 'MYT', + 'MX' => 'MEX', + 'FM' => 'FSM', + 'MD' => 'MDA', + 'MC' => 'MCO', + 'MN' => 'MNG', + 'ME' => 'MNE', + 'MS' => 'MSR', + 'MA' => 'MAR', + 'MZ' => 'MOZ', + 'MM' => 'MMR', + 'NA' => 'NAM', + 'NR' => 'NRU', + 'NP' => 'NPL', + 'NL' => 'NLD', + 'AN' => 'ANT', + 'NC' => 'NCL', + 'NZ' => 'NZL', + 'NI' => 'NIC', + 'NE' => 'NER', + 'NG' => 'NGA', + 'NU' => 'NIU', + 'NF' => 'NFK', + 'MP' => 'MNP', + 'NO' => 'NOR', + 'OM' => 'OMN', + 'PK' => 'PAK', + 'PW' => 'PLW', + 'PS' => 'PSE', + 'PA' => 'PAN', + 'PG' => 'PNG', + 'PY' => 'PRY', + 'PE' => 'PER', + 'PH' => 'PHL', + 'PN' => 'PCN', + 'PL' => 'POL', + 'PT' => 'PRT', + 'PR' => 'PRI', + 'QA' => 'QAT', + 'RE' => 'REU', + 'RO' => 'ROU', + 'RU' => 'RUS', + 'RW' => 'RWA', + 'BL' => 'BLM', + 'SH' => 'SHN', + 'KN' => 'KNA', + 'LC' => 'LCA', + 'MF' => 'MAF', + 'PM' => 'SPM', + 'VC' => 'VCT', + 'WS' => 'WSM', + 'SM' => 'SMR', + 'ST' => 'STP', + 'SA' => 'SAU', + 'SN' => 'SEN', + 'RS' => 'SRB', + 'SC' => 'SYC', + 'SL' => 'SLE', + 'SG' => 'SGP', + 'SK' => 'SVK', + 'SI' => 'SVN', + 'SB' => 'SLB', + 'SO' => 'SOM', + 'ZA' => 'ZAF', + 'GS' => 'SGS', + 'SS' => 'SSD', + 'ES' => 'ESP', + 'LK' => 'LKA', + 'SD' => 'SDN', + 'SR' => 'SUR', + 'SJ' => 'SJM', + 'SZ' => 'SWZ', + 'SE' => 'SWE', + 'CH' => 'CHE', + 'SY' => 'SYR', + 'TW' => 'TWN', + 'TJ' => 'TJK', + 'TZ' => 'TZA', + 'TH' => 'THA', + 'TL' => 'TLS', + 'TG' => 'TGO', + 'TK' => 'TKL', + 'TO' => 'TON', + 'TT' => 'TTO', + 'TN' => 'TUN', + 'TR' => 'TUR', + 'TM' => 'TKM', + 'TC' => 'TCA', + 'TV' => 'TUV', + 'UG' => 'UGA', + 'UA' => 'UKR', + 'AE' => 'ARE', + 'GB' => 'GBR', + 'US' => 'USA', + 'UM' => 'UMI', + 'UY' => 'URY', + 'UZ' => 'UZB', + 'VU' => 'VUT', + 'VE' => 'VEN', + 'VN' => 'VNM', + 'VI' => 'VIR', + 'WF' => 'WLF', + 'EH' => 'ESH', + 'YE' => 'YEM', + 'ZM' => 'ZMB', + 'ZW' => 'ZWE', +); diff --git a/packages/woocommerce-germanized-dhl/includes/wc-gzd-dhl-core-functions.php b/packages/woocommerce-germanized-dhl/includes/wc-gzd-dhl-core-functions.php new file mode 100644 index 000000000..8efbce54a --- /dev/null +++ b/packages/woocommerce-germanized-dhl/includes/wc-gzd-dhl-core-functions.php @@ -0,0 +1,639 @@ +get_shipment() ) { + return false; + } + + $customs_data = $label->get_customs_data( $max_desc_length ); + + foreach ( $customs_data['items'] as $key => $item ) { + if ( $shipment_item = $shipment->get_item( $key ) ) { + /** + * Apply legacy filters + */ + $item['description'] = apply_filters( 'woocommerce_gzd_dhl_customs_item_description', $item['description'], $shipment_item, $label, $shipment ); + $item['category'] = apply_filters( 'woocommerce_gzd_dhl_customs_item_category', $item['category'], $shipment_item, $label, $shipment ); + + $customs_data['items'][ $key ] = apply_filters( 'woocommerce_gzd_dhl_customs_item', $item, $shipment_item, $shipment, $label ); + } + } + + return apply_filters( 'woocommerce_gzd_dhl_customs_data', $customs_data, $label, $shipment ); +} + +/** + * @param false|Shipment $shipment + * + * @return array + */ +function wc_gzd_dhl_get_label_payment_ref_placeholder( $shipment = false ) { + return apply_filters( + 'woocommerce_gzd_dhl_label_payment_ref_placeholder', + array( + '{shipment_id}' => $shipment ? $shipment->get_shipment_number() : '', + '{order_id}' => $shipment ? $shipment->get_order_number() : '', + '{email}' => $shipment ? $shipment->get_email() : '', + ) + ); +} + +function wc_gzd_dhl_get_preferred_days_select_options( $days, $current = '' ) { + $preferred_days = array( 0 => _x( 'None', 'dhl day context', 'woocommerce-germanized' ) ); + + if ( ! empty( $days ) ) { + $days = array_keys( $days ); + + foreach ( $days as $day ) { + if ( empty( $day ) ) { + continue; + } + + $date = new \WC_DateTime( $day ); + $date->setTimezone( new DateTimeZone( 'Europe/Berlin' ) ); + + $formatted_day = $date->date_i18n( wc_date_format() ); + $preferred_days = array_merge( $preferred_days, array( $day => $formatted_day ) ); + } + } + + if ( ! empty( $current ) ) { + $date = new \WC_DateTime( $current ); + $date->setTimezone( new DateTimeZone( 'Europe/Berlin' ) ); + + $preferred_days[ $current ] = $date->date_i18n( wc_date_format() ); + } + + return $preferred_days; +} + +function wc_gzd_dhl_get_duties() { + $duties = array( + 'DDP' => _x( 'Delivery Duty Paid', 'dhl', 'woocommerce-germanized' ), + 'DAP' => _x( 'Delivery At Place', 'dhl', 'woocommerce-germanized' ), + 'DXV' => _x( 'Delivery Duty Paid (excl. VAT )', 'dhl', 'woocommerce-germanized' ), + 'DDX' => _x( 'Delivery Duty Paid (excl. Duties, taxes and VAT)', 'dhl', 'woocommerce-germanized' ), + ); + + return $duties; +} + +function wc_gzd_dhl_is_valid_visual_min_age( $min_age ) { + $ages = wc_gzd_dhl_get_visual_min_ages(); + + if ( empty( $min_age ) || ( ! array_key_exists( $min_age, $ages ) && ! in_array( $min_age, $ages, true ) ) ) { + return false; + } + + return true; +} + +function wc_gzd_dhl_is_valid_ident_min_age( $min_age ) { + $ages = wc_gzd_dhl_get_ident_min_ages(); + + if ( empty( $min_age ) || ( ! array_key_exists( $min_age, $ages ) && ! in_array( $min_age, $ages, true ) ) ) { + return false; + } + + return true; +} + +function wc_gzd_dhl_get_visual_min_ages() { + $visual_age = array( + '0' => _x( 'None', 'age context', 'woocommerce-germanized' ), + 'A16' => _x( 'Minimum age of 16', 'dhl', 'woocommerce-germanized' ), + 'A18' => _x( 'Minimum age of 18', 'dhl', 'woocommerce-germanized' ), + ); + + return $visual_age; +} + +function wc_gzd_dhl_get_ident_min_ages() { + return wc_gzd_dhl_get_visual_min_ages(); +} + +function wc_gzd_dhl_get_label_reference( $reference_text, $placeholders = array() ) { + return str_replace( array_keys( $placeholders ), array_values( $placeholders ), $reference_text ); +} + +/** + * @param Label\Label $label + * @param Shipment $shipment + * + * @return string + */ +function wc_gzd_dhl_get_label_customer_reference( $label, $shipment ) { + /** + * Filter to adjust the customer reference field placed on the DHL label. Maximum characeter length: 35. + * + * @param string $text The customer reference text. + * @param Label\Label $label The label instance. + * @param SimpleShipment $shipment The shipment instance. + * + * @since 3.0.0 + * @package Vendidero/Germanized/DHL + */ + $ref = apply_filters( + 'woocommerce_gzd_dhl_label_customer_reference', + wc_gzd_dhl_get_label_reference( + _x( 'Shipment #{shipment_id} to order {order_id}', 'dhl', 'woocommerce-germanized' ), + array( + '{shipment_id}' => $shipment->get_shipment_number(), + '{order_id}' => $shipment->get_order_number(), + ) + ), + $label, + $shipment + ); + + return sanitize_text_field( substr( $ref, 0, 35 ) ); +} + +function wc_gzd_dhl_get_endorsement_types() { + return array( + 'return' => _x( 'Return shipment', 'dhl', 'woocommerce-germanized' ), + 'abandon' => _x( 'Abandon shipment', 'dhl', 'woocommerce-germanized' ), + ); +} + +/** + * @param Label\DHL $label + * @param $shipment + * @param string $api_type + * + * @return string + */ +function wc_gzd_dhl_get_label_endorsement_type( $label, $shipment, $api_type = 'default' ) { + $type = $label->get_endorsement(); + + /** + * Filter to adjust the endorsement type for internation shipments. + * + * @param string $text The endorsement type: return or abandon. + * @param Label\Label $label The label instance. + * @param SimpleShipment $shipment The shipment instance. + * + * @since 3.0.0 + * @package Vendidero/Germanized/DHL + */ + $type = strtolower( apply_filters( 'woocommerce_gzd_dhl_label_endorsement_type', $type, $label, $shipment ) ); + + /** + * SOAP Label API was using IMMEDIATE instead of RETURN + */ + if ( 'immediate' === $type ) { + $type = 'return'; + } elseif ( 'abandonment' === $type ) { + $type = 'abandon'; + } + + if ( ! in_array( $type, array_keys( wc_gzd_dhl_get_endorsement_types() ), true ) ) { + $type = 'return'; + } + + /** + * The SOAP API uses abandonment instead of abandon and + * immediate instead of return. + */ + if ( 'default' === $api_type ) { + if ( 'abandon' === $type ) { + $type = 'abandonment'; + } else { + $type = 'immediate'; + } + } + + return strtoupper( $type ); +} + +function wc_gzd_dhl_get_return_label_customer_reference( $label, $shipment ) { + /** + * Filter to adjust the customer reference field placed on the DHL return label. Maximum characeter length: 30. + * + * @param string $text The customer reference text. + * @param Label\Label $label The label instance. + * @param ReturnShipment $shipment The shipment instance. + * + * @since 3.0.0 + * @package Vendidero/Germanized/DHL + */ + $ref = apply_filters( + 'woocommerce_gzd_dhl_return_label_customer_reference', + wc_gzd_dhl_get_label_reference( + _x( 'Return #{shipment_id} to order {order_id}', 'dhl', 'woocommerce-germanized' ), + array( + '{shipment_id}' => $shipment->get_id(), + '{order_id}' => $shipment->get_order_number(), + ) + ), + $label, + $shipment + ); + + return sanitize_text_field( substr( $ref, 0, 30 ) ); +} + +function wc_gzd_dhl_get_inlay_return_label_reference( $label, $shipment ) { + /** + * Filter to adjust the inlay return reference field placed on the DHL label. Maximum characeter length: 35. + * + * @param string $text The customer reference text. + * @param Label\Label $label The label instance. + * @param SimpleShipment $shipment The shipment instance. + * + * @since 3.0.0 + * @package Vendidero/Germanized/DHL + */ + $ref = apply_filters( + 'woocommerce_gzd_dhl_inlay_return_label_reference', + wc_gzd_dhl_get_label_reference( + _x( 'Return shipment #{shipment_id} to order #{order_id}', 'dhl', 'woocommerce-germanized' ), + array( + '{shipment_id}' => $shipment->get_id(), + '{order_id}' => $shipment->get_order_number(), + ) + ), + $label, + $shipment + ); + + return sanitize_text_field( substr( $ref, 0, 35 ) ); +} + +/** + * @return \Vendidero\Germanized\Shipments\ShippingMethod\ProviderMethod|false + */ +function wc_gzd_dhl_get_current_shipping_method() { + if ( $current = wc_gzd_get_current_shipping_method_id() ) { + return wc_gzd_get_shipping_provider_method( $current ); + } + + return false; +} + +/** + * @param $instance_id + * + * @return \Vendidero\Germanized\Shipments\ShippingMethod\ProviderMethod + */ +function wc_gzd_dhl_get_shipping_method( $instance_id ) { + return wc_gzd_get_shipping_provider_method( $instance_id ); +} + +function wc_gzd_dhl_get_deutsche_post_shipping_method( $instance_id ) { + return wc_gzd_dhl_get_shipping_method( $instance_id ); +} + +function wc_gzd_dhl_get_pickup_types() { + return array( + 'packstation' => _x( 'Packstation', 'dhl', 'woocommerce-germanized' ), + 'postoffice' => _x( 'Postfiliale', 'dhl', 'woocommerce-germanized' ), + 'parcelshop' => _x( 'Postfiliale', 'dhl', 'woocommerce-germanized' ), + ); +} + +function wc_gzd_dhl_is_pickup_type( $maybe_type, $type = 'packstation' ) { + $label = wc_gzd_dhl_get_pickup_type( $type ); + + if ( ! $label ) { + return false; + } + + $label = strtolower( trim( $label ) ); + $maybe_type = strtolower( trim( $maybe_type ) ); + + if ( strpos( $maybe_type, $label ) !== false ) { + return true; + } + + return false; +} + +function wc_gzd_dhl_get_excluded_working_days() { + $work_days = array( + 'mon', + 'tue', + 'wed', + 'thu', + 'fri', + 'sat', + ); + + $excluded = array(); + + foreach ( $work_days as $value ) { + if ( ParcelServices::is_preferred_day_excluded( $value ) ) { + $excluded[] = $value; + } + } + + return $excluded; +} + +function wc_gzd_dhl_order_has_pickup( $order ) { + return ParcelLocator::order_has_pickup( $order ); +} + +function wc_gzd_dhl_get_pickup_type( $type ) { + $types = wc_gzd_dhl_get_pickup_types(); + + if ( array_key_exists( $type, $types ) ) { + return $types[ $type ]; + } elseif ( in_array( $type, $types, true ) ) { + return $type; + } else { + return false; + } +} + +/** + * @param WP_Error $error + * + * @return bool + */ +function wc_gzd_dhl_wp_error_has_errors( $error ) { + return wc_gzd_shipment_wp_error_has_errors( $error ); +} + +function wc_gzd_dhl_is_valid_datetime( $maybe_datetime, $format = 'Y-m-d' ) { + if ( ! is_a( $maybe_datetime, 'DateTime' && ! is_numeric( $maybe_datetime ) ) ) { + if ( ! DateTime::createFromFormat( $format, $maybe_datetime ) ) { + return false; + } + } + + return true; +} + +function wc_gzd_dhl_format_label_state( $state, $country ) { + // If not USA or Australia, then change state from ISO code to name + if ( ! in_array( $country, array( 'US', 'AU' ), true ) ) { + // Get all states for a country + $states = WC()->countries->get_states( $country ); + + // If the state is empty, it was entered as free text + if ( ! empty( $states ) && ! empty( $state ) ) { + // Change the state to be the name and not the code + $state = $states[ $state ]; + + // Remove anything in parentheses (e.g. TH) + $ind = strpos( $state, ' (' ); + + if ( false !== $ind ) { + $state = substr( $state, 0, $ind ); + } + } + } + + return $state; +} + +/** + * @param $the_product + * + * @return \Vendidero\Germanized\Shipments\Product + */ +function wc_gzd_dhl_get_product( $the_product ) { + return wc_gzd_shipments_get_product( $the_product ); +} + +/** + * @param Shipment $shipment + */ +function wc_gzd_dhl_get_label_shipment_address_addition( $shipment ) { + return wc_gzd_get_shipment_address_addition( $shipment ); +} + +/** + * @param Shipment $shipment + * + * @return mixed + */ +function wc_gzd_dhl_get_label_shipment_street_number( $shipment ) { + $street_number = $shipment->get_address_street_number(); + + if ( ! Package::is_shipping_domestic( $shipment->get_country(), $shipment->get_postcode() ) ) { + + if ( empty( $street_number ) ) { + /** + * Filter to adjust the placeholder used as street number for the DHL API in case + * the shipment is not domestic (inner Germnany) and a street number was not provided. + * + * @param string $placeholder The placeholder to use - default 0 as advised by DHL support. + * + * @since 3.1.0 + * @package Vendidero/Germanized/DHL + */ + $street_number = apply_filters( 'woocommerce_gzd_dhl_label_shipment_street_number_placeholder', '0' ); + } + } + + return $street_number; +} + +/** + * @param \Vendidero\Germanized\DHL\Label\ReturnLabel $label + */ +function wc_gzd_dhl_get_return_label_sender_street_number( $label ) { + $street_number = $label->get_sender_street_number(); + + if ( ! Package::is_shipping_domestic( $label->get_sender_country(), $label->get_sender_postcode() ) ) { + if ( empty( $street_number ) ) { + /** + * This filter is documented in includes/wc-gzd-dhl-core-functions.php + */ + $street_number = apply_filters( 'woocommerce_gzd_dhl_label_shipment_street_number_placeholder', '0' ); + } + } + + return $street_number; +} + +/** + * @param Label\DHL $label + * @param string $type + * + * @return mixed|string|void + * @see https://entwickler.dhl.de/group/ep/grundlagen2 + */ +function wc_gzd_dhl_get_custom_label_format( $label, $type = '' ) { + $shipment = $label->get_shipment(); + $available = $shipment ? $shipment->get_shipping_provider_instance()->get_print_formats()->filter( array( 'product_id' => $label->get_product_id() ) )->as_options() : array(); + $label_format = 'default' === $label->get_print_format() ? '' : $label->get_print_format(); + + /** + * This filter allows adjusting the default label format (GUI) to a custom format e.g. 910-300-700. + * The following formats are available: + * + *-
+ *
- A4 + *
- 910-300-700 + *
- 910-300-700-oZ + *
- 910-300-600 + *
- 910-300-610 + *
- 910-300-710 + *
- 100x70mm (Warenpost only) + *
+
+
+
+
+
+ update_products();
+ $settings_url = add_query_arg( array( 'im-refresh-type' => 'products' ), Package::get_deutsche_post_shipping_provider()->get_edit_link( 'config_set_simple_label' ) );
+
+ if ( is_wp_error( $result ) ) {
+ set_transient( '_wc_gzd_dhl_im_products_refresh_error', $result->get_error_message(), MINUTE_IN_SECONDS * 5 );
+
+ $settings_url = add_query_arg( array( 'error' => 1 ), $settings_url );
+ } else {
+ $settings_url = add_query_arg( array( 'success' => 1 ), $settings_url );
+ }
+
+ wp_safe_redirect( esc_url_raw( $settings_url ) );
+ exit();
+ }
+ } elseif ( current_user_can( 'manage_woocommerce' ) && isset( $_GET['action'], $_GET['_wpnonce'] ) && 'wc-gzd-dhl-im-page-formats-refresh' === $_GET['action'] ) {
+ if ( wp_verify_nonce( wp_unslash( $_GET['_wpnonce'] ), 'wc-gzd-dhl-refresh-im-page-formats' ) ) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
+ $result = Package::get_internetmarke_api()->get_page_formats( true );
+ $settings_url = add_query_arg( array( 'im-refresh-type' => 'page_formats' ), Package::get_deutsche_post_shipping_provider()->get_edit_link( 'printing' ) );
+
+ if ( is_wp_error( $result ) ) {
+ set_transient( '_wc_gzd_dhl_im_page_formats_refresh_error', $result->get_error_message(), MINUTE_IN_SECONDS * 5 );
+
+ $settings_url = add_query_arg( array( 'error' => 1 ), $settings_url );
+ } else {
+ $settings_url = add_query_arg( array( 'success' => 1 ), $settings_url );
+ }
+
+ wp_safe_redirect( esc_url_raw( $settings_url ) );
+ exit();
+ }
+ } elseif ( current_user_can( 'manage_woocommerce' ) && isset( $_GET['action'], $_GET['_wpnonce'] ) && 'wc-gzd-dhl-refresh-retoure-receiver-ids' === $_GET['action'] ) {
+ if ( wp_verify_nonce( wp_unslash( $_GET['_wpnonce'] ), 'wc-gzd-dhl-refresh-retoure-receiver-ids' ) ) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
+ $receiver_ids = Package::get_api()->get_return_api()->get_receiver_ids();
+ $settings_url = add_query_arg( array( 'refresh-type' => 'retoure-receiver-ids' ), Package::get_dhl_shipping_provider()->get_edit_link( 'config_set_return_label' ) );
+
+ if ( is_wp_error( $receiver_ids ) ) {
+ $settings_url = add_query_arg( array( 'error' => 1 ), $settings_url );
+ } elseif ( ! empty( $receiver_ids ) ) {
+ if ( $provider = Package::get_dhl_shipping_provider() ) {
+ $existing_retoure_ids = Package::get_return_receivers();
+
+ $provider->update_setting( 'retoure_receiver_ids', array_replace_recursive( $existing_retoure_ids, $receiver_ids ) );
+ $provider->save();
+ }
+
+ $settings_url = add_query_arg( array( 'success' => 1 ), $settings_url );
+ }
+
+ wp_safe_redirect( esc_url_raw( $settings_url ) );
+ exit();
+ }
+ }
+ }
+
+ public static function save_custom_fields( $value, $option, $raw_value ) {
+ if ( ! isset( $option['type'] ) ) {
+ return $value;
+ }
+
+ $type = $option['type'];
+
+ if ( 'dhl_receiver_ids' === $type ) {
+ $receiver = array();
+ $raw_value = is_array( $raw_value ) ? $raw_value : array();
+
+ // phpcs:disable WordPress.Security.NonceVerification.NoNonceVerification -- Nonce verification already handled in WC_Admin_Settings::save()
+ if ( isset( $raw_value['receiver_id'], $raw_value['receiver_country'] ) ) {
+ $receiver_ids = wc_clean( wp_unslash( $raw_value['receiver_id'] ) );
+ $countries = wc_clean( wp_unslash( $raw_value['receiver_country'] ) );
+
+ foreach ( $receiver_ids as $i => $name ) {
+ $country = isset( $countries[ $i ] ) ? substr( strtoupper( $countries[ $i ] ), 0, 2 ) : '';
+ $slug = sanitize_key( $receiver_ids[ $i ] . '_' . $country );
+
+ $receiver[ $slug ] = array(
+ 'id' => $receiver_ids[ $i ],
+ 'country' => $country,
+ 'slug' => $slug,
+ );
+ }
+ }
+
+ return $receiver;
+ }
+
+ return $value;
+ }
+
+ public static function output_dp_charge_field( $option ) {
+ if ( ! Package::get_internetmarke_api()->get_user() ) {
+ return;
+ }
+
+ $balance = Package::get_internetmarke_api()->get_balance();
+ $user_token = Package::get_internetmarke_api()->get_user()->getUserToken();
+ $settings_url = Package::get_deutsche_post_shipping_provider()->get_edit_link();
+ ?>
+
+ easily create DHL labels to your shipments.', 'dhl', 'woocommerce-germanized' ), esc_url( 'https://vendidero.de/dokument/dhl-labels-zu-sendungen-erstellen' ) ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended ?>
+'EUR' ) ) ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>
+
+
+
+
+
+ | + | + | + |
|---|---|---|
| + | + + | ++ + | +
' . esc_html_x( 'This label has been generated by the DHL for WooCommerce Plugin and is shown for legacy purposes.', 'dhl', 'woocommerce-germanized' ) . '
'; + echo '' . esc_html_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 esc_url_raw( $url ); + } + + public static function download_legacy_label() { + if ( isset( $_GET['action'] ) && 'wc-gzd-dhl-download-legacy-label' === $_GET['action'] && isset( $_REQUEST['_wpnonce'] ) ) { + if ( isset( $_GET['order_id'] ) && wp_verify_nonce( wp_unslash( $_REQUEST['_wpnonce'] ), 'dhl-download-legacy-label' ) ) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized + $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( wp_unslash( $_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_build_url( 'static/admin-internetmarke.js' ), array( 'jquery' ), Package::get_version() ); // phpcs:ignore WordPress.WP.EnqueuedResourceParameters.NotInFooter + wp_register_script( 'wc-gzd-admin-deutsche-post-label', Package::get_assets_build_url( 'static/admin-deutsche-post-label.js' ), array( 'wc-gzd-admin-shipment-modal' ), Package::get_version() ); // phpcs:ignore WordPress.WP.EnqueuedResourceParameters.NotInFooter + + if ( wp_script_is( 'wc-gzd-admin-shipment-modal', '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'] ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended + wp_enqueue_script( 'wc-gzd-admin-dhl-internetmarke' ); + } + } + + public static function admin_styles() { + $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_build_url( 'static/admin-styles.css' ), array( 'woocommerce_admin_styles' ), Package::get_version() ); + + // Admin styles for WC pages only. + if ( in_array( $screen_id, self::get_screen_ids(), true ) ) { + wp_enqueue_style( 'woocommerce_gzd_dhl_admin' ); + } + } + + public static function get_screen_ids() { + return \Vendidero\Germanized\Shipments\Admin\Admin::get_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..56d6fe33b --- /dev/null +++ b/packages/woocommerce-germanized-dhl/src/Admin/Importer/DHL.php @@ -0,0 +1,195 @@ +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_V62WP' => 'participation_V62WP', + 'participation_V66WPI' => 'participation_V66WPI', + '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, ( count( $name ) - 1 ) ) ); + $last_name = $name[ count( $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, true ) ) !== false ) { + update_option( 'woocommerce_gzd_shipments_shipper_address_country', $key ); + } + } + + if ( ! empty( $return_country ) && ! empty( $isos ) ) { + if ( ( $key = array_search( $return_country, $isos, true ) ) !== 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 ( false !== $pos_ps || false !== $pos_fl ) { + 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..26abfb1de --- /dev/null +++ b/packages/woocommerce-germanized-dhl/src/Admin/Importer/Internetmarke.php @@ -0,0 +1,54 @@ +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..953d07589 --- /dev/null +++ b/packages/woocommerce-germanized-dhl/src/Admin/Status.php @@ -0,0 +1,118 @@ + +| + + | +||
|---|---|---|
|
+ + '; + } 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 { + if ( ! $api = $this->get_api() ) { + throw new \Exception( $this->get_error_message() ); + } + + $this->page_formats = $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 ( apply_filters( 'woocommerce_gzd_deutsche_post_exclude_page_format', ! $format->isIsAddressPossible(), $format ) ) { + continue; + } + + $options[ $format->getId() ] = $format->getName(); + } + + return $options; + } + + public function get_product_services( $im_product_id ) { + if ( $product = $this->get_product_list()->get_product_data_by_code( $im_product_id ) ) { + return $this->get_product_list()->get_product_services( $product->get_internal_id() ); + } + + return array(); + } + + public function get_product_code( $maybe_parent_product_code, $services = array() ) { + if ( $product = $this->get_product_list()->get_product_data_by_code( $maybe_parent_product_code ) ) { + $new_product_data = $this->get_product_list()->get_product_data_by_services( $product->get_internal_id(), $services ); + + if ( $new_product_data ) { + return $new_product_data->get_id(); + } 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 ( $api = $this->get_api( true ) ) { + 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 = $api->retrievePreviewVoucherPng( $product_id, $address_type, $image_id ); + } + } + } catch ( \Exception $e ) { // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedCatch + } + + 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 ) { + $today = new \DateTime(); + $discontinued_starting_from = new \DateTime( '2022-07-01' ); + + if ( $today >= $discontinued_starting_from ) { + throw new \Exception( sprintf( _x( 'The Deutsche Post WP International API was discontinued. Please use the DHL API for Warenpost labels instead.', 'dhl', 'woocommerce-germanized' ), esc_url( 'https://vendidero.de/dokument/dhl-integration-einrichten' ) ) ); + } else { + 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 ( ! $api = $this->get_api( true ) ) { + throw new \Exception( $this->get_authentication_error() ); + } + + try { + $stamp = $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_core_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 ), $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 = ( empty( $additional ) ? '' : $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 ), + wc_gzd_country_to_alpha3( $this->get_shipment_address_prop( $shipment, 'country', $address_type ) ) + ); + + $named_address = new \baltpeter\Internetmarke\NamedAddress( $name, $address ); + + return $named_address; + } + + /** + * @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() ) ); + } + + $sender = $this->get_shipment_address_data( $shipment, 'sender' ); + $receiver = $this->get_shipment_address_data( $shipment ); + $address_binding = new \baltpeter\Internetmarke\AddressBinding( $sender, $receiver ); + + if ( ! $api = $this->get_api( true ) ) { + throw new \Exception( $this->get_error_message() ); + } + + try { + $shop_order_id = $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', $label->get_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', $label->get_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 = $api->checkoutShoppingCartPdf( $this->get_user()->getUserToken(), $label->get_print_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' ), esc_url( 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; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase + + if ( ! empty( $voucher_list->voucher ) ) { + foreach ( $voucher_list->voucher as $i => $voucher ) { + + if ( isset( $voucher->trackId ) ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase + $label->set_number( $voucher->trackId ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase + } else { + $label->set_number( $voucher->voucherId ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase + } + + $label->set_voucher_id( $voucher->voucherId ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase + } + } + + if ( isset( $stamp->manifestLink ) ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase + $label->set_manifest_url( $stamp->manifestLink ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase + } + + $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() { + return $this->get_product_list()->update(); + } +} diff --git a/packages/woocommerce-germanized-dhl/src/Api/LabelRest.php b/packages/woocommerce-germanized-dhl/src/Api/LabelRest.php new file mode 100644 index 000000000..5762da8c5 --- /dev/null +++ b/packages/woocommerce-germanized-dhl/src/Api/LabelRest.php @@ -0,0 +1,741 @@ +get_basic_auth_encode( 'sandy_sandbox', 'pass' ); + } else { + return $this->get_basic_auth_encode( Package::get_gk_api_user(), Package::get_gk_api_signature() ); + } + } + + protected function handle_get_response( $response_code, $response_body ) { + $this->handle_post_response( $response_code, $response_body ); + } + + protected function handle_post_response( $response_code, $response_body ) { + $response_code = absint( $response_code ); + + switch ( $response_code ) { + case 200: + case 201: + break; + default: + $error_messages = array(); + + if ( isset( $response_body->items ) && isset( $response_body->items[0]->validationMessages ) ) { + foreach ( $response_body->items[0]->validationMessages as $message ) { + if ( ! in_array( $message->validationMessage, $error_messages, true ) ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase + $error_messages[] = $message->validationMessage; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase + } + } + } elseif ( isset( $response_body->items ) && isset( $response_body->items[0]->message ) ) { + foreach ( $response_body->items as $message ) { + $property_path = isset( $message->propertyPath ) ? $message->propertyPath : ''; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase + $property_path = str_replace( 'shipments[0].', '', $property_path ); + + $error_message = ( ! empty( $error_message ) ? "\n" : '' ) . ( ! empty( $property_path ) ? $property_path . ': ' : '' ) . $message->message; + + if ( ! in_array( $error_message, $error_messages, true ) ) { + $error_messages[] = $error_message; + } + } + } elseif ( empty( $response_body->status->detail ) && empty( $response_body->detail ) ) { + $error_message = _x( 'POST error or timeout occurred. Please try again later.', 'dhl', 'woocommerce-germanized' ); + + if ( ! in_array( $error_message, $error_messages, true ) ) { + $error_messages[] = $error_message; + } + } else { + $error_message = ! empty( $response_body->status->detail ) ? $response_body->status->detail : $response_body->detail; + + if ( ! in_array( $error_message, $error_messages, true ) ) { + $error_messages[] = $error_message; + } + } + + Package::log( 'POST Error: ' . $response_code . ' - ' . wc_print_r( $error_messages, true ) ); + + throw new \Exception( implode( "\n", $error_messages ), $response_code ); + } + } + + protected function set_header( $authorization = '', $request_type = 'GET', $endpoint = '' ) { + parent::set_header( $authorization, $request_type, $endpoint ); + + $this->remote_header['Authorization'] = $authorization; + $this->remote_header['dhl-api-key'] = Package::get_dhl_com_api_key(); + $this->remote_header['Accept'] = '*/*'; + } + + /** + * @param \Vendidero\Germanized\DHL\Label\DHL $label + * + * @throws \Exception + */ + public function get_label( $label ) { + return $this->create_label( $label ); + } + + /** + * @param \Vendidero\Germanized\DHL\Label\DHL $label + * + * @return boolean|ShipmentError + * @throws \Exception + */ + public function create_label( $label ) { + $result = true; + $shipment = $label->get_shipment(); + $dhl_provider = Package::get_dhl_shipping_provider(); + + if ( ! $shipment ) { + throw new \Exception( sprintf( _x( 'Could not fetch shipment %d.', 'dhl', 'woocommerce-germanized' ), $label->get_shipment_id() ) ); + } + + $currency = $shipment->get_order() ? $shipment->get_order()->get_currency() : 'EUR'; + $billing_number_args = array( + 'api_type' => 'dhl.com', + 'services' => $label->get_services(), + ); + + $account_number = wc_gzd_dhl_get_billing_number( $label->get_product_id(), $billing_number_args ); + $services = array(); + $bank_data = array(); + + foreach ( $label->get_services() as $service ) { + $service_name = lcfirst( $service ); + + if ( in_array( $service, array( 'GoGreen', 'dhlRetoure' ), true ) ) { + continue; + } + + switch ( $service ) { + case 'AdditionalInsurance': + $services[ $service_name ] = array( + 'currency' => $currency, + 'value' => apply_filters( 'woocommerce_gzd_dhl_label_api_insurance_amount', $shipment->get_total(), $shipment, $label ), + ); + break; + case 'IdentCheck': + $services[ $service_name ] = array( + 'firstName' => $shipment->get_first_name(), + 'lastName' => $shipment->get_last_name(), + 'dateOfBirth' => $label->get_ident_date_of_birth(), + 'minimumAge' => $label->get_ident_min_age(), + ); + break; + case 'CashOnDelivery': + $bank_data_map = array( + 'bank_holder' => 'accountHolder', + 'bank_name' => 'bankName', + 'bank_iban' => 'iban', + 'bank_bic' => 'bic', + 'bank_ref' => 'transferNote1', + 'bank_ref_2' => 'transferNote2', + ); + + $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' ), true ) ) { + $bank_data[ $value ] = str_replace( array_keys( $ref_replacements ), array_values( $ref_replacements ), $bank_data[ $value ] ); + } + } + } + + $services[ $service_name ] = array( + 'amount' => array( + 'currency' => $currency, + 'value' => $label->get_cod_total(), + ), + 'bankAccount' => array_diff_key( + $bank_data, + array( + 'transferNote1' => '', + 'transferNote2' => '', + ) + ), + 'transferNote1' => $bank_data['transferNote1'], + 'transferNote2' => $bank_data['transferNote2'], + ); + break; + case 'PreferredDay': + $services[ $service_name ] = $label->get_preferred_day(); + break; + case 'VisualCheckOfAge': + $services[ $service_name ] = $label->get_visual_min_age(); + break; + case 'PreferredLocation': + $services[ $service_name ] = $label->get_preferred_location(); + break; + case 'PreferredNeighbour': + $services[ $service_name ] = $label->get_preferred_neighbor(); + break; + case 'ParcelOutletRouting': + if ( ! empty( $shipment->get_email() ) ) { + $services[ $service_name ] = $shipment->get_email(); + } + break; + case 'CDP': + $services['closestDropPoint'] = true; + break; + case 'PDDP': + $services['postalDeliveryDutyPaid'] = true; + break; + case 'Endorsement': + $services[ $service_name ] = wc_gzd_dhl_get_label_endorsement_type( $label, $shipment, 'dhl.com' ); + break; + default: + $services[ $service_name ] = true; + } + } + + if ( $label->has_inlay_return() ) { + $services['dhlRetoure'] = array( + 'billingNumber' => wc_gzd_dhl_get_billing_number( 'return', $billing_number_args ), + 'refNo' => wc_gzd_dhl_get_inlay_return_label_reference( $label, $shipment ), + 'returnAddress' => 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() : '', + 'addressStreet' => $label->get_return_street() . ' ' . $label->get_return_street_number(), + 'postalCode' => $label->get_return_postcode(), + 'city' => $label->get_return_city(), + 'state' => wc_gzd_dhl_format_label_state( $label->get_return_state(), $label->get_return_country() ), + 'contactName' => $label->get_return_formatted_full_name(), + 'phone' => $label->get_return_phone(), + 'email' => $label->get_return_email(), + 'country' => wc_gzd_country_to_alpha3( $label->get_return_country() ), + ), + ); + } + + $shipment_request = array( + 'product' => $label->get_product_id(), + 'billingNumber' => $account_number, + 'refNo' => mb_substr( wc_gzd_dhl_get_label_customer_reference( $label, $shipment ), 0, 35 ), + 'shipDate' => Package::get_date_de_timezone( 'Y-m-d' ), + 'shipper' => array(), + 'consignee' => array(), + 'details' => array( + 'weight' => array( + 'uom' => 'kg', + 'value' => $label->get_weight(), + ), + ), + ); + + if ( ! empty( $services ) ) { + $shipment_request['services'] = $services; + } + + if ( $label->has_dimensions() ) { + $shipment_request['details']['dim'] = array( + 'uom' => 'mm', + 'height' => wc_format_decimal( wc_get_dimension( $label->get_height(), 'mm', 'cm' ), 0 ), + 'width' => wc_format_decimal( wc_get_dimension( $label->get_width(), 'mm', 'cm' ), 0 ), + 'length' => wc_format_decimal( wc_get_dimension( $label->get_length(), 'mm', 'cm' ), 0 ), + ); + } + + /** + * 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', $dhl_provider->has_custom_shipper_reference() ? $dhl_provider->get_label_custom_shipper_reference() : '', $label ); + + if ( ! empty( $shipper_reference ) ) { + $shipment_request['shipper']['shipperRef'] = $shipper_reference; + } else { + $name1 = apply_filters( 'woocommerce_gzd_dhl_label_api_shipper_name1', trim( $shipment->get_sender_company() ? $shipment->get_sender_company() : $shipment->get_formatted_sender_full_name() ), $label ); + $name2 = apply_filters( 'woocommerce_gzd_dhl_label_api_shipper_name2', trim( $shipment->get_sender_company() ? $shipment->get_formatted_sender_full_name() : '' ), $label ); + $name3 = apply_filters( 'woocommerce_gzd_dhl_label_api_shipper_name3', trim( $shipment->get_sender_address_2() ), $label ); + $street = apply_filters( 'woocommerce_gzd_dhl_label_api_shipper_street', $shipment->get_sender_address_1(), $label ); + $zip = apply_filters( 'woocommerce_gzd_dhl_label_api_shipper_zip', $shipment->get_sender_postcode(), $label ); + $city = apply_filters( 'woocommerce_gzd_dhl_label_api_shipper_city', $shipment->get_sender_city(), $label ); + $email = apply_filters( 'woocommerce_gzd_dhl_label_api_shipper_email', $shipment->get_sender_email(), $label ); + $country = apply_filters( 'woocommerce_gzd_dhl_label_api_shipper_country', $shipment->get_sender_country(), $label ); + + $fields_necessary = array( + 'street' => $street, + 'full_name' => $name1, + 'postcode' => $zip, + 'city' => $city, + ); + + $address_fields = wc_gzd_get_shipment_setting_default_address_fields(); + $missing_address_fields = array(); + + foreach ( $fields_necessary as $field => $value ) { + if ( empty( $value ) && array_key_exists( $field, $address_fields ) ) { + $missing_address_fields[] = $address_fields[ $field ]; + } + } + + if ( ! empty( $missing_address_fields ) ) { + throw new \Exception( sprintf( _x( 'Your shipper address is incomplete (%1$s). Please validate your settings and try again.', 'dhl', 'woocommerce-germanized' ), implode( ', ', $missing_address_fields ), esc_url( admin_url( 'admin.php?page=wc-settings&tab=germanized-shipments§ion=address' ) ) ) ); + } + + $shipment_request['shipper'] = array( + 'name1' => $name1, + 'name2' => $name2, + 'name3' => $name3, + 'addressStreet' => $street, + 'postalCode' => $zip, + 'city' => $city, + 'country' => wc_gzd_country_to_alpha3( $country ), + 'email' => $email, + 'contactName' => trim( $shipment->get_formatted_sender_full_name() ), + ); + } + + if ( 'DE' === $shipment->get_country() && $shipment->send_to_external_pickup() ) { + if ( $shipment->send_to_external_pickup( 'packstation' ) ) { + $locker_id = filter_var( $shipment->get_address_1(), FILTER_SANITIZE_NUMBER_INT ); + + $shipment_request['consignee'] = array( + 'name' => $shipment->get_formatted_full_name(), + 'lockerID' => $locker_id, + 'postNumber' => ParcelLocator::get_postnumber_by_shipment( $shipment ), + 'city' => $shipment->get_city(), + 'postalCode' => $shipment->get_postcode(), + 'country' => wc_gzd_country_to_alpha3( $shipment->get_country() ), + ); + } else { + $retail_id = filter_var( $shipment->get_address_1(), FILTER_SANITIZE_NUMBER_INT ); + + $shipment_request['consignee'] = array( + 'name' => $shipment->get_formatted_full_name(), + 'retailID' => $retail_id, + 'city' => $shipment->get_city(), + 'postalCode' => $shipment->get_postcode(), + 'country' => wc_gzd_country_to_alpha3( $shipment->get_country() ), + ); + + if ( $post_number = ParcelLocator::get_postnumber_by_shipment( $shipment ) ) { + $shipment_request['consignee']['postNumber'] = $post_number; + } else { + $shipment_request['consignee']['email'] = $shipment->get_email(); + } + } + } else { + $formatted_recipient_state = wc_gzd_dhl_format_label_state( $shipment->get_state(), $shipment->get_country() ); + $street_number = $shipment->get_address_street_number(); + $street_addition = $shipment->get_address_street_addition(); + $address_1 = $shipment->get_address_1(); + $address_2 = $shipment->get_address_2(); + + if ( empty( $street_number ) && ! empty( $address_2 ) ) { + $address_1_tmp = wc_gzd_split_shipment_street( $address_1 . ' ' . $address_2 ); + + $address_1 = $address_1_tmp['street'] . ' ' . $address_1_tmp['number']; + $address_2 = ''; + $street_addition = $address_1_tmp['addition']; + } + + if ( ! empty( $street_addition ) ) { + $address_2 = $street_addition . ( ! empty( $address_2 ) ? ' ' . $address_2 : '' ); + } + + $shipment_request['consignee'] = array( + 'name1' => $shipment->get_company() ? $shipment->get_company() : $shipment->get_formatted_full_name(), + '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', $address_2, $label ), + 'addressStreet' => $address_1, + 'additionalAddressInformation1' => $address_2, + 'postalCode' => $shipment->get_postcode(), + 'city' => $shipment->get_city(), + 'state' => $formatted_recipient_state, + 'country' => wc_gzd_country_to_alpha3( $shipment->get_country() ), + /** + * 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 + */ + 'contactName' => 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() || isset( $services['closestDropPoint'] ) ? $shipment->get_email() : '', $label ), + ); + } + + if ( Package::is_crossborder_shipment( $shipment->get_country(), $shipment->get_postcode() ) ) { + if ( count( $shipment->get_items() ) > 30 ) { + throw new \Exception( sprintf( _x( 'Only %1$s shipment items can be processed, your shipment has %2$s items.', 'dhl', 'woocommerce-germanized' ), 30, count( $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( + 'itemDescription' => $item_data['description'], + 'countryOfOrigin' => wc_gzd_country_to_alpha3( $item_data['origin_code'] ), + 'hsCode' => $item_data['tariff_number'], + 'packagedQuantity' => $item_data['quantity'], + 'itemValue' => array( + 'currency' => $customs_label_data['currency'], + 'value' => $item_data['single_value'], + ), + 'itemWeight' => array( + 'uom' => 'kg', + 'value' => $item_data['single_weight_in_kg'], + ), + ); + } + + /** + * In case the customs item total weight is greater than label weight (e.g. due to rounding issues) replace it + */ + if ( $customs_label_data['item_total_weight_in_kg'] > $label->get_weight() ) { + $shipment_request['details']['weight']['value'] = $customs_label_data['item_total_weight_in_kg'] + $shipment->get_packaging_weight(); + } + + $export_type = $this->get_export_type( $customs_label_data, $label ); + + $customs_data = array( + 'shippingConditions' => $label->get_duties(), + 'postalCharges' => array( + 'value' => $customs_label_data['additional_fee'], + 'currency' => $customs_label_data['currency'], + ), + 'exportDescription' => mb_substr( $customs_label_data['export_reason_description'], 0, 80 ), + 'officeOfOrigin' => $customs_label_data['place_of_commital'], + 'items' => $customs_items, + 'exportType' => strtoupper( $export_type ), + /** + * Filter to allow adjusting the export invoice number. + * + * @param string $invoice_number The invoice number. + * @param Label\Label $label The label instance. + * + * @since 3.3.4 + * @package Vendidero/Germanized/DHL + */ + 'invoiceNo' => apply_filters( 'woocommerce_gzd_dhl_label_api_export_invoice_number', $customs_label_data['invoice_number'], $label ), + ); + + $shipment_request['customs'] = apply_filters( 'woocommerce_gzd_dhl_label_rest_api_customs_data', $customs_data, $label ); + } + + $shipment_request = apply_filters( 'woocommerce_gzd_dhl_label_rest_api_create_label_request', $shipment_request, $label, $shipment, $this ); + $shipment_request = $this->walk_recursive_remove( $shipment_request ); + + $request = array( + 'profile' => $this->get_profile(), + 'shipments' => array( + $shipment_request, + ), + ); + + $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' ); + + $args = array( + 'combine' => 'true', + 'mustEncode' => $label->codeable_address_only() ? 'true' : 'false', + ); + + if ( ! empty( $label_custom_format ) ) { + $args['printFormat'] = $label_custom_format; + } + + if ( ! empty( $label_custom_return_format ) ) { + $args['retourePrintFormat'] = $label_custom_return_format; + } + + $endpoint = add_query_arg( $args, 'orders' ); + $response = $this->post_request( $endpoint, $request ); + + try { + if ( isset( $response->items ) ) { + $shipment_data = $response->items[0]; + + if ( ! isset( $shipment_data->shipmentNo ) ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase + throw new \Exception( _x( 'There was an error generating the label. Please try again or consider switching to sandbox mode.', 'dhl', 'woocommerce-germanized' ) ); + } + + $label->set_number( $shipment_data->shipmentNo ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase + $label->save(); + + $default_file = base64_decode( $shipment_data->label->b64 ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_decode,WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase + + if ( isset( $shipment_data->returnShipmentNo ) ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase + $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( $shipment_data->returnShipmentNo ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase + + $splitter = new PDFSplitter( $default_file, true ); + $pdfs = $splitter->split(); + + if ( $pdfs && ! empty( $pdfs ) && count( $pdfs ) > 1 ) { + $return_file = $pdfs[1]; + } + + if ( $return_file ) { + $return_label->upload_label_file( $return_file ); + } + + $return_label->save(); + } + } + + $default_path = $label->upload_label_file( $default_file, 'default' ); + $label->save(); + + if ( isset( $shipment_data->customsDoc ) ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase + $customs_file = base64_decode( $shipment_data->customsDoc->b64 ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_decode,WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase + + if ( $label->upload_label_file( $customs_file, '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 ); + } + + $label->save(); + } else { + $label->set_path( $default_path ); + } + } + + if ( isset( $shipment_data->validationMessages ) ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase + $result = new ShipmentError(); + + foreach ( $shipment_data->validationMessages as $message ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase + $result->add_soft_error( 'label-soft-error', $message->validationMessage ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase + } + } + + if ( in_array( 'AdditionalInsurance', $label->get_services(), true ) && $shipment->get_total() <= 500 ) { + if ( ! is_a( $result, 'Vendidero\Germanized\Shipments\ShipmentError' ) ) { + $result = new ShipmentError(); + } + + $result->add_soft_error( 'label-soft-error', _x( 'You\'ve explicitly booked the additional insurance service resulting in additional fees although the shipment total does not exceed EUR 500. The label has been created anyway.', 'dhl', 'woocommerce-germanized' ) ); + } + } catch ( \Exception $e ) { + try { + $this->delete_label( $label ); + $label->delete( true ); + } catch ( \Exception $e ) { // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedCatch + } + + throw new \Exception( _x( 'Error while creating and uploading the label', 'dhl', 'woocommerce-germanized' ) ); + } + + return $result; + } + + /** + * @param Label\DHL $label + * + * @throws \Exception + */ + public function delete_label( $label ) { + try { + if ( ! empty( $label->get_number() ) ) { + $response = $this->delete_request( + 'orders', + array( + 'profile' => $this->get_profile(), + 'shipment' => $label->get_number(), + ) + ); + + return true; + } + } catch ( \Exception $e ) { + Package::log( 'Error while cancelling label: ' . $e->getMessage() ); + + throw $e; + } + + return false; + } + + protected function get_profile() { + return 'STANDARD_GRUPPENPROFIL'; + } + + protected function walk_recursive_remove( array $array ) { + foreach ( $array as $k => $v ) { + if ( is_array( $v ) ) { + $array[ $k ] = $this->walk_recursive_remove( $v ); + } + + if ( '' === $v ) { + unset( $array[ $k ] ); + } + } + + return $array; + } + + protected function get_export_type( $customs_data, $label ) { + $export_type = 'commercial_goods'; + + if ( isset( $customs_data['export_reason'] ) && ! empty( $customs_data['export_reason'] ) ) { + if ( 'gift' === $customs_data['export_reason'] ) { + $export_type = 'PRESENT'; + } elseif ( 'sample' === $customs_data['export_reason'] ) { + $export_type = 'COMMERCIAL_SAMPLE'; + } elseif ( 'repair' === $customs_data['export_reason'] ) { + $export_type = 'RETURN_OF_GOODS'; + } elseif ( 'sale' === $customs_data['export_reason'] ) { + $export_type = 'COMMERCIAL_GOODS'; + } else { + $export_type = 'OTHER'; + } + } + + /** + * 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 + *
-
+ *
- OTHER + *
- PRESENT + *
- COMMERCIAL_SAMPLE + *
- DOCUMENT + *
- RETURN_OF_GOODS + *
- COMMERCIAL_GOODS + *
+
+ format( $format );
+
+ return $date_formatted;
+ } catch ( Exception $e ) {
+ return date( $format ); // phpcs:ignore WordPress.DateTime.RestrictedFunctions.date_date
+ }
+ }
+
+ 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_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 legacy_label_table_exists() {
+ global $wpdb;
+
+ $table_name = $wpdb->prefix . 'woocommerce_gzd_dhl_labels';
+ $query = $wpdb->prepare( 'SHOW TABLES LIKE %s', $wpdb->esc_like( $table_name ) );
+
+ if ( $table_name !== $wpdb->get_var( $query ) ) { // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+ return false;
+ }
+
+ return true;
+ }
+
+ 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() {
+ return Helper::instance()->is_shipping_provider_activated( 'dhl' );
+ }
+
+ public static function is_rest_api_request() {
+ return defined( 'REST_REQUEST' ) && REST_REQUEST;
+ }
+
+ public static function get_country_iso_alpha3( $country_code ) {
+ return \Vendidero\Germanized\Shipments\Package::get_country_iso_alpha3( $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() ) {
+ self::container()->get( Bootstrap::class );
+ }
+ }
+
+ /**
+ * Loads the dependency injection container for woocommerce blocks.
+ *
+ * @param boolean $reset Used to reset the container to a fresh instance.
+ * Note: this means all dependencies will be
+ * reconstructed.
+ */
+ public static function container( $reset = false ) {
+ static $container;
+ if (
+ ! $container instanceof Container
+ || $reset
+ ) {
+ $container = new Container();
+
+ // register Bootstrap.
+ $container->register(
+ Bootstrap::class,
+ function ( $container ) {
+ return new Bootstrap(
+ $container
+ );
+ }
+ );
+ }
+ return $container;
+ }
+
+ 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 );
+ }
+
+ 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;
+ }
+
+ /**
+ * @return Internetmarke|null
+ */
+ public static function get_internetmarke_api() {
+ if ( is_null( self::$im_api ) ) {
+ 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( $rel_path = '' ) {
+ return trailingslashit( dirname( __DIR__ ) ) . $rel_path;
+ }
+
+ /**
+ * Return the path to the package.
+ *
+ * @return string
+ */
+ public static function get_i18n_path() {
+ return apply_filters( 'woocommerce_gzd_dhl_get_i18n_path', self::get_path( 'i18n/languages' ) );
+ }
+
+ /**
+ * Return the path to the package.
+ *
+ * @return string
+ */
+ public static function get_i18n_textdomain() {
+ return apply_filters( 'woocommerce_gzd_dhl_get_i18n_textdomain', 'woocommerce-germanized' );
+ }
+
+ public static function get_template_path() {
+ return 'woocommerce-germanized/';
+ }
+
+ /**
+ * Return the path to the package.
+ *
+ * @return string
+ */
+ public static function get_url( $rel_path = '' ) {
+ return trailingslashit( plugins_url( '', __DIR__ ) ) . $rel_path;
+ }
+
+ public static function get_assets_url() {
+ return self::get_url() . '/assets';
+ }
+
+ public static function register_script( $handle, $path, $dep = array(), $ver = '', $in_footer = array( 'strategy' => 'defer' ) ) {
+ global $wp_version;
+
+ if ( version_compare( $wp_version, '6.3', '<' ) ) {
+ $in_footer = true;
+ }
+
+ $ver = empty( $ver ) ? self::get_version() : $ver;
+
+ wp_register_script(
+ $handle,
+ self::get_assets_build_url( $path ),
+ $dep,
+ $ver,
+ $in_footer
+ );
+ }
+
+ public static function get_assets_build_url( $script_or_style ) {
+ $assets_url = self::get_url() . '/build';
+ $is_debug = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG;
+ $is_style = '.css' === substr( $script_or_style, -4 );
+ $is_static = strstr( $script_or_style, 'static/' );
+
+ if ( $is_debug && $is_static && ! $is_style ) {
+ $assets_url = self::get_url() . '/assets/js';
+ }
+
+ return trailingslashit( $assets_url ) . $script_or_style;
+ }
+
+ 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://geschaeftskunden.dhl.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/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 'XfQwh0tsdDF81IfpCKEPigk1US46rabN';
+ }
+
+ 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() {
+ return Helper::instance()->is_shipping_provider_activated( 'deutsche_post' );
+ }
+
+ 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 use_legacy_soap_api() {
+ return apply_filters( 'woocommerce_gzd_dhl_use_legacy_soap_api', ( defined( 'WC_GZD_DHL_LEGACY_SOAP' ) ? WC_GZD_DHL_LEGACY_SOAP : ( 'yes' === get_option( 'woocommerce_gzd_dhl_enable_legacy_soap' ) ) ) );
+ }
+
+ public static function get_label_rest_api_url() {
+ if ( self::is_debug_mode() ) {
+ return 'https://api-sandbox.dhl.com/parcel/de/shipping/v2/';
+ } else {
+ return 'https://api-eu.dhl.com/parcel/de/shipping/v2/';
+ }
+ }
+
+ 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 ) {
+ $receiver_country = empty( $receiver['country'] ) ? $receiver['id'] : $receiver['country'];
+
+ 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.5/geschaeftskundenversand-api-3.5.wsdl' : 'https://cig.dhl.de/cig-wsdls/com/dpdhl/wsdl/geschaeftskundenversand-api/3.5/geschaeftskundenversand-api-3.5.wsdl';
+ }
+
+ public static function get_dhl_com_api_key() {
+ return 'uwi1SH5bHDdMTdcWXB5JIsDCvBOyIawn';
+ }
+
+ public static function get_business_portal_url() {
+ return 'https://geschaeftskunden.dhl.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 ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize
+ }
+
+ 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 = self::get_upload_dir() ) && false === $uploads['error'] ) ) {
+ $file = $uploads['basedir'] . "/$file";
+
+ return $file;
+ } else {
+ return $file;
+ }
+ }
+
+ public static function get_core_wsdl_file( $file ) {
+ $file = basename( $file );
+ $file = str_replace( '?wsdl', '', $file );
+
+ // Add .wsdl as default file extension in case missing (e.g. url)
+ if ( '.wsdl' !== substr( $file, -5 ) && '.xsd' !== substr( $file, -4 ) ) {
+ $file .= '.wsdl';
+ }
+
+ $file = sanitize_file_name( $file );
+ $local_file = trailingslashit( self::get_path() ) . 'assets/wsdl/' . $file;
+
+ if ( file_exists( $local_file ) ) {
+ return $local_file;
+ }
+
+ return null;
+ }
+
+ /**
+ * Retrieves a local, cached, WSDL file by a WSDL link.
+ * In case the file exists in core direction (assets/wsdl) prefer this file otherwise
+ * try to download and cache the WSDL file locally for 14 days.
+ *
+ * In case of enabled debug mode - use WSDL link instead of cached files.
+ *
+ * @param $wsdl_link
+ *
+ * @return false|mixed|string|void
+ */
+ 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;
+ $is_core_file = false;
+
+ // Renew files every 14 days
+ $transient_valid = DAY_IN_SECONDS * 14;
+
+ if ( count( $required_files ) > 1 ) {
+ $file_link = str_replace( '.wsdl', '.zip', $file_link );
+ $new_file_name = str_replace( '.wsdl', '.zip', $new_file_name );
+ $is_zip = true;
+ }
+
+ if ( $file_path = self::get_core_wsdl_file( $main_file ) ) {
+ $files_exist = true;
+ $is_core_file = true;
+ } else {
+ /**
+ * 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 ) {
+ if ( $is_core_file ) {
+ $wsdl_link = $alternate_file ? $alternate_file : $file_path;
+ } else {
+ $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 = trailingslashit( $uploads['path'] ) . $new_file_name;
+ $has_copied = @copy( $tmp_file, $new_file ); // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+
+ 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 ); // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+ } 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 ); // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+ }
+ }
+ }
+ }
+
+ 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, $args = array() ) {
+ $args = wp_parse_args(
+ $args,
+ array(
+ 'gogreen' => false,
+ )
+ );
+
+ $participation = self::get_setting( 'participation_' . $product );
+
+ if ( $args['gogreen'] ) {
+ $participation_gogreen = self::get_setting( 'participation_gogreen_' . $product );
+
+ if ( ! empty( $participation_gogreen ) ) {
+ $participation = $participation_gogreen;
+ }
+ }
+
+ return $participation;
+ }
+
+ /**
+ * @param $name
+ *
+ * @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 = self::get_dhl_shipping_provider() ) {
+ $value = $provider->get_setting( $name, $default );
+ }
+ } else {
+ if ( $provider = self::get_deutsche_post_shipping_provider() ) {
+ $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() {
+ /**
+ * 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', \Vendidero\Germanized\Shipments\Package::get_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, $postcode = '' ) {
+ $is_domestic = \Vendidero\Germanized\Shipments\Package::is_shipping_domestic( $country_receiver, array( 'postcode' => $postcode ) );
+
+ /**
+ * Shipments from DE to Helgoland are not treated as crossborder
+ */
+ if ( ! $is_domestic && 'DE' === $country_receiver && \Vendidero\Germanized\Shipments\Package::base_country_belongs_to_eu_customs_area() ) {
+ $is_domestic = true;
+ }
+
+ return $is_domestic;
+ }
+
+ /**
+ * Check if it is an EU shipment
+ */
+ public static function is_eu_shipment( $country_receiver, $postcode = '' ) {
+ return \Vendidero\Germanized\Shipments\Package::is_shipping_inner_eu_country( $country_receiver, array( 'postcode' => $postcode ) );
+ }
+
+ protected static function get_eu_countries() {
+ $countries = WC()->countries->get_european_union_countries();
+
+ if ( in_array( 'GB', $countries, true ) ) {
+ $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, $postcode = '' ) {
+ $is_crossborder = \Vendidero\Germanized\Shipments\Package::is_shipping_international( $country_receiver, array( 'postcode' => $postcode ) );
+
+ /**
+ * Shipments from DE to Helgoland are not treated as crossborder
+ */
+ if ( $is_crossborder && 'DE' === $country_receiver && \Vendidero\Germanized\Shipments\Package::base_country_belongs_to_eu_customs_area() ) {
+ $is_crossborder = false;
+ }
+
+ return $is_crossborder;
+ }
+}
diff --git a/packages/woocommerce-germanized-dhl/src/ParcelLocator.php b/packages/woocommerce-germanized-dhl/src/ParcelLocator.php
new file mode 100644
index 000000000..678205740
--- /dev/null
+++ b/packages/woocommerce-germanized-dhl/src/ParcelLocator.php
@@ -0,0 +1,1429 @@
+ _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 ( ! isset( $_SERVER['REQUEST_METHOD'] ) || 'POST' !== strtoupper( wc_clean( wp_unslash( $_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( wp_unslash( $_REQUEST[ $nonce_key ] ), 'woocommerce-edit_address' ) ) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
+ 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'] ) {
+ $country = isset( $_POST['shipping_country'] ) ? wc_clean( wp_unslash( $_POST['shipping_country'] ) ) : '';
+ $field_key = self::get_pickup_address_field_by_country( $country );
+
+ $fields[ "shipping_{$field_key}" ]['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( wp_unslash( $_POST['shipping_country'] ) ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Missing
+ $shipping_address_type = isset( $_POST['shipping_address_type'] ) ? wc_clean( wp_unslash( $_POST['shipping_address_type'] ) ) : 'regular'; // phpcs:ignore WordPress.Security.NonceVerification.Missing
+
+ // Not a supported country
+ if ( ! in_array( $shipping_country, self::get_supported_countries(), true ) ) {
+ return '';
+ }
+
+ if ( 'dhl' === $shipping_address_type ) {
+ $args = array(
+ 'address_1' => isset( $_POST['shipping_address_1'] ) ? wc_clean( wp_unslash( $_POST['shipping_address_1'] ) ) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
+ 'address_2' => isset( $_POST['shipping_address_2'] ) ? wc_clean( wp_unslash( $_POST['shipping_address_2'] ) ) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
+ 'postnumber' => isset( $_POST['shipping_dhl_postnumber'] ) ? wc_clean( wp_unslash( $_POST['shipping_dhl_postnumber'] ) ) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
+ 'postcode' => isset( $_POST['shipping_postcode'] ) ? wc_clean( wp_unslash( $_POST['shipping_postcode'] ) ) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
+ 'city' => isset( $_POST['shipping_city'] ) ? wc_clean( wp_unslash( $_POST['shipping_city'] ) ) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
+ 'country' => isset( $_POST['shipping_country'] ) ? wc_clean( wp_unslash( $_POST['shipping_country'] ) ) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
+ );
+
+ $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( wp_unslash( $_POST['shipping_country'] ) ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Missing
+ $shipping_address_type = isset( $_POST['shipping_address_type'] ) ? wc_clean( wp_unslash( $_POST['shipping_address_type'] ) ) : 'regular'; // phpcs:ignore WordPress.Security.NonceVerification.Missing
+
+ // Not a supported country
+ if ( ! in_array( $shipping_country, self::get_supported_countries(), true ) ) {
+ 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( wp_unslash( $_POST['shipping_address_1'] ) ) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
+ 'address_2' => isset( $_POST['shipping_address_2'] ) ? wc_clean( wp_unslash( $_POST['shipping_address_2'] ) ) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
+ 'postnumber' => isset( $_POST['shipping_dhl_postnumber'] ) ? wc_clean( wp_unslash( $_POST['shipping_dhl_postnumber'] ) ) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
+ 'postcode' => isset( $_POST['shipping_postcode'] ) ? wc_clean( wp_unslash( $_POST['shipping_postcode'] ) ) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
+ 'city' => isset( $_POST['shipping_city'] ) ? wc_clean( wp_unslash( $_POST['shipping_city'] ) ) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
+ 'country' => isset( $_POST['shipping_country'] ) ? wc_clean( wp_unslash( $_POST['shipping_country'] ) ) : '', // phpcs:ignore WordPress.Security.NonceVerification.Missing
+ );
+
+ $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'] ) {
+ $address_field_key = self::get_pickup_address_field_by_country( $shipment->get_country() );
+ $address_getter = "get_{$address_field_key}";
+ $address_field_val = is_callable( array( $shipment, $address_getter ) ) ? $shipment->{$address_getter}() : '';
+ $keyword_id = self::extract_pickup_keyword_id( $address_field_val );
+
+ if ( ! empty( $types ) ) {
+ /**
+ * Missing indicator, e.g. Packstation, Postfiliale in address field - lookup actual name via API
+ * and add the prefix to the address field.
+ */
+ if ( is_numeric( $keyword_id ) ) {
+ $pickup_address_details = self::is_valid_pickup_address(
+ array(
+ 'country' => $shipment->get_country(),
+ 'address_1' => $shipment->get_address_1(),
+ 'address_2' => $shipment->get_address_2(),
+ 'postcode' => $shipment->get_postcode(),
+ )
+ );
+
+ if ( ! is_wp_error( $pickup_address_details ) ) {
+ $address_field_val = $pickup_address_details['name'];
+ }
+ }
+
+ foreach ( $types as $type ) {
+ if ( wc_gzd_dhl_is_pickup_type( $address_field_val, $type ) ) {
+ return true;
+ }
+ }
+ } elseif ( ! empty( $keyword_id ) ) {
+ 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_adjust_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() {
+ $countries = array( 'DE', 'AT' );
+
+ /**
+ * Check if the address_2 field has been removed, e.g. via customizer as
+ * the address_2 field is necessary for non-DE pickup stations.
+ */
+ if ( 'hidden' === get_option( 'woocommerce_checkout_address_2_field', 'optional' ) ) {
+ $countries = array( 'DE' );
+ }
+
+ /**
+ * 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', $countries );
+
+ return $codes;
+ }
+
+ public static function get_excluded_gateways() {
+ /**
+ * Filter to disable DHL parcel shop delivery for certain gateways.
+ *
+ * @param array $gateways Array of gateway IDs to exclude.
+ *
+ * @package Vendidero/Germanized/DHL
+ */
+ $codes = apply_filters( 'woocommerce_gzd_dhl_parcel_locator_excluded_gateways', array( 'cod' ) );
+
+ 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 get_pickup_address_by_order( $order ) {
+ if ( is_numeric( $order ) ) {
+ $order = wc_get_order( $order );
+ }
+
+ $address = '';
+
+ if ( $order ) {
+ $address_field = self::get_pickup_address_field_by_country( $order->get_shipping_country() );
+ $address_field_getter = 'get_shipping_' . $address_field;
+
+ if ( is_callable( array( $order, $address_field_getter ) ) ) {
+ $address = $order->{$address_field_getter}();
+ }
+ }
+
+ return $address;
+ }
+
+ 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 );
+ $keyword_id = self::extract_pickup_keyword_id( self::get_pickup_address_by_order( $order ) );
+ $country = $order->get_shipping_country();
+
+ if ( ! empty( $country ) && in_array( $country, self::get_supported_countries(), true ) && 'dhl' === $address_type && ! empty( $keyword_id ) ) {
+ $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 ( 'dhl' === self::get_shipping_address_type_by_order( $order ) ) {
+ $address_value = self::get_pickup_address_by_order( $order );
+
+ if ( $address_value ) {
+ $pickup_types = wc_gzd_dhl_get_pickup_types();
+
+ foreach ( $pickup_types as $pickup_tmp_type => $label ) {
+ if ( wc_gzd_dhl_is_pickup_type( $address_value, $pickup_tmp_type ) ) {
+ $pickup_type = $pickup_tmp_type;
+ break;
+ }
+ }
+
+ if ( empty( $pickup_type ) ) {
+ $pickup_number = preg_replace( '/[^0-9]/', '', $address_value );
+
+ if ( ! empty( $pickup_number ) ) {
+ $pickup_type = 'packstation';
+ }
+ }
+ }
+ }
+ }
+
+ /**
+ * 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_get_shipping_provider_method( $rate ) ) {
+ $provider_name = $method->get_shipping_provider();
+
+ if ( $method->has_shipping_provider( array( 'dhl', 'deutsche_post' ) ) ) {
+ $supports = array();
+
+ foreach ( wc_gzd_dhl_get_pickup_types() as $pickup_type => $title ) {
+ $getter = "is_{$pickup_type}_enabled";
+
+ if ( self::$getter( $provider_name ) ) {
+ $supports[] = $pickup_type;
+ }
+ }
+
+ $data[ self::get_rate_with_instance_id( $rate->id ) ] = array(
+ 'supports' => $supports,
+ 'address_type_options' => self::get_address_types( $provider_name ),
+ 'finder_button' => self::get_button( $provider_name ),
+ 'street_label' => self::get_pickup_type_address_label( $provider_name ),
+ 'street_placeholder' => self::get_pickup_type_address_placeholder( $provider_name ),
+ );
+ }
+ }
+ }
+ }
+
+ 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(), true ) ) {
+ $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'] ) : '',
+ 'address_2' => isset( $data['shipping_address_2'] ) ? wc_clean( $data['shipping_address_2'] ) : '',
+ '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' => '',
+ 'address_2' => '',
+ '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;
+ $field_key = self::get_pickup_address_field_by_country( $args['country'] );
+ $keyword_id = self::extract_pickup_keyword_id( $args[ $field_key ] );
+
+ /**
+ * A number is required for the packstation/parcelshop/postoffice
+ */
+ if ( empty( $keyword_id ) ) {
+ $error->add( 'validation', sprintf( _x( 'Please provide a valid pickup location within the %s field.', 'dhl', 'woocommerce-germanized' ), self::get_type_text( ' / ' ) ) );
+ } else {
+ $result = self::is_valid_pickup_address( $args, true );
+
+ if ( is_wp_error( $result ) ) {
+ $error = $result;
+ } else {
+ if ( 'DE' === $args['country'] ) {
+ 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' ) );
+ }
+ }
+
+ if ( $has_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 && 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 loaded 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(),
+ 'pickup_address_field_keys' => self::get_pickup_address_fields(),
+ 'excluded_gateways' => self::get_excluded_gateways(),
+ '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' );
+ } else {
+ $deps = array_merge( $deps, array( 'woocommerce', 'wc-address-i18n' ) );
+ }
+
+ Package::register_script( 'wc-gzd-parcel-locator-dhl', 'static/parcel-locator.js', $deps );
+ Package::register_script( 'wc-gzd-parcel-finder-dhl', 'static/parcel-finder.js', array( 'jquery-blockui', 'wc-gzd-parcel-locator-dhl' ) );
+
+ wp_register_style( 'wc-gzd-parcel-finder-dhl', Package::get_assets_build_url( 'static/parcel-finder-styles.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( wc_clean( wp_unslash( $_POST['is_checkout'] ) ) ) : true; // phpcs:ignore WordPress.Security.NonceVerification.Missing
+
+ if ( wp_doing_ajax() && $is_forced_checkout ) {
+ $disable_method_check = false;
+ }
+
+ return $disable_method_check;
+ }
+
+ protected static function get_setting( $key ) {
+ $option_key = 'parcel_pickup_' . $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( $provider = false ) {
+ return self::is_packstation_enabled( $provider ) || self::is_parcelshop_enabled( $provider ) || self::is_postoffice_enabled( $provider );
+ }
+
+ protected static function get_current_shipping_provider() {
+ if ( $method = wc_gzd_get_current_shipping_provider_method() ) {
+ return $method->get_shipping_provider();
+ }
+
+ return '';
+ }
+
+ protected static function shipping_provider_supports_locations( $provider, $location_type = 'packstation' ) {
+ if ( 'packstation' === $location_type ) {
+ return in_array( $provider, array( 'dhl', 'deutsche_post' ), true );
+ } else {
+ return in_array( $provider, array( 'dhl' ), true );
+ }
+ }
+
+ protected static function current_shipping_provider_supports_locations( $location_type = 'packstation' ) {
+ return self::shipping_provider_supports_locations( self::get_current_shipping_provider(), $location_type );
+ }
+
+ public static function is_postoffice_enabled( $provider = false ) {
+ $is_enabled = 'yes' === self::get_setting( 'postoffice_enable' );
+
+ if ( false !== $provider ) {
+ if ( ! self::shipping_provider_supports_locations( $provider, 'postoffice' ) ) {
+ $is_enabled = false;
+ }
+ }
+
+ return $is_enabled;
+ }
+
+ public static function is_packstation_enabled( $provider = false ) {
+ $is_enabled = 'yes' === self::get_setting( 'packstation_enable' );
+
+ if ( false !== $provider ) {
+ if ( ! self::shipping_provider_supports_locations( $provider, 'packstation' ) ) {
+ $is_enabled = false;
+ }
+ }
+
+ return $is_enabled;
+ }
+
+ public static function is_parcelshop_enabled( $provider = false ) {
+ $is_enabled = 'yes' === self::get_setting( 'parcelshop_enable' );
+
+ if ( false !== $provider ) {
+ if ( ! self::shipping_provider_supports_locations( $provider, 'parcelshop' ) ) {
+ $is_enabled = false;
+ }
+ }
+
+ return $is_enabled;
+ }
+
+ public static function has_map() {
+ if ( Package::is_debug_mode() ) {
+ return ( 'yes' === self::get_setting( 'map_enable' ) && Package::is_dhl_enabled() );
+ } else {
+ $api_key = self::get_setting( 'map_api_password' );
+
+ return ( 'yes' === self::get_setting( 'map_enable' ) && ! 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( $provider = false ) {
+ $type = '';
+ $text = '';
+
+ if ( self::is_packstation_enabled( $provider ) ) {
+ $type = wc_gzd_dhl_get_pickup_type( 'packstation' );
+ } elseif ( self::is_parcelshop_enabled( $provider ) ) {
+ $type = wc_gzd_dhl_get_pickup_type( 'parcelshop' );
+ } elseif ( self::is_postoffice_enabled( $provider ) ) {
+ $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|string $provider
+ *
+ * @return string
+ */
+ protected static function get_type_text( $sep = '', $plural = true, $provider = false ) {
+ $search_types = '';
+
+ if ( empty( $sep ) ) {
+ $sep = '&';
+ }
+
+ if ( self::is_packstation_enabled( $provider ) ) {
+ $search_types .= _x( 'Packstation', 'dhl', 'woocommerce-germanized' );
+ }
+
+ if ( self::is_parcelshop_enabled( $provider ) || self::is_postoffice_enabled( $provider ) ) {
+ $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( $provider = false ) {
+ return array(
+ 'regular' => _x( 'Regular Address', 'dhl', 'woocommerce-germanized' ),
+ 'dhl' => self::get_type_text( ' / ', true, $provider ),
+ );
+ }
+
+ 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() ) {
+ $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-germanized' ), '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(); + + if ( isset( $fields['shipping_address_2'] ) ) { + $fields['shipping_address_2']['custom_attributes'] = ( isset( $fields['shipping_address_2']['custom_attributes'] ) ? $fields['shipping_address_2']['custom_attributes'] : array() ); + $fields['shipping_address_2']['custom_attributes']['data-label-dhl'] = self::get_pickup_type_address_label(); + $fields['shipping_address_2']['custom_attributes']['data-label-regular'] = $fields['shipping_address_2']['label']; + $fields['shipping_address_2']['custom_attributes']['data-placeholder-dhl'] = self::get_pickup_type_address_placeholder(); + $fields['shipping_address_2']['custom_attributes']['data-placeholder-regular'] = isset( $fields['shipping_address_2']['placeholder'] ) ? $fields['shipping_address_2']['placeholder'] : ''; + $fields['shipping_address_2']['custom_attributes']['data-desc-dhl'] = self::get_button(); + } + } + + return $fields; + } + + protected static function get_pickup_type_address_label( $provider = 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|string $provider Shipping provider name, 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, $provider ), $provider ); + } + + protected static function get_pickup_type_address_placeholder( $provider = 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|string $provider Shipping provider name, if available. + * + * @since 3.0.0 + * @package Vendidero/Germanized/DHL + */ + return apply_filters( 'woocommerce_gzd_dhl_pickup_type_address_placeholder', self::get_street_placeholder( $provider ), $provider ); + } + + protected static function get_icon( $type = 'packstation' ) { + return Package::get_assets_url() . '/img/' . $type . '.png'; + } + + protected static function get_button_text( $provider = false ) { + $text = sprintf( _x( 'Search %s', 'dhl', 'woocommerce-germanized' ), self::get_type_text( '', true, $provider ) ); + + return $text; + } + + protected static function get_button( $provider = false ) { + $text = self::get_button_text( $provider ); + + if ( self::has_map() ) { + return '' . esc_html( $text ) . ''; + } else { + return '' . esc_html( $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(); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped + } + + 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 extract_pickup_keyword_id( $str ) { + $keyword_id = ''; + + preg_match_all( '/([A-Z]{2}-)?[0-9]+/', $str, $matches ); + + if ( $matches && count( $matches ) > 0 ) { + if ( isset( $matches[0][0] ) ) { + $keyword_id = $matches[0][0]; + } + } + + return $keyword_id; + } + + public static function get_pickup_address_field_by_country( $country = '' ) { + $country = '' === $country ? Package::get_base_country() : $country; + + return 'DE' === $country ? 'address_1' : 'address_2'; + } + + public static function get_pickup_address_fields() { + $countries = array(); + + foreach ( self::get_supported_countries() as $country ) { + $countries[ $country ] = self::get_pickup_address_field_by_country( $country ); + } + + return $countries; + } + + /** + * @param $args + * @param $report_invalid_address + * + * @return array|WP_Error + */ + public static function is_valid_pickup_address( $args, $report_invalid_address = false ) { + $address_data = wp_parse_args( + $args, + array( + 'country' => Package::get_base_country(), + 'address_1' => '', + 'address_2' => '', + 'postcode' => '', + 'city' => '', + ) + ); + + foreach ( $address_data as $address_k => $address_d ) { + $address_data[ $address_k ] = trim( $address_d ); + } + + $address_field = self::get_pickup_address_field_by_country( $args['country'] ); + $error = new WP_Error(); + $pickup_address = array( + 'name' => $address_data[ $address_field ], + 'address' => $address_data['address_1'], + 'postcode' => $address_data['postcode'], + 'city' => $address_data['city'], + ); + + if ( ! apply_filters( 'woocommerce_gzd_dhl_validate_pickup_address', true, $args, $report_invalid_address ) ) { + return $pickup_address; + } + + $keyword_id = self::extract_pickup_keyword_id( $address_data[ $address_field ] ); + + if ( ! empty( $address_data[ $address_field ] ) && ! empty( $address_data['postcode'] ) && ! empty( $keyword_id ) ) { + $cache_key = 'woocommerce_gzd_dhl_pickup_' . sanitize_key( $keyword_id ) . '_' . sanitize_key( $address_data['country'] ) . '_' . $address_data['postcode']; + $pickup_address = get_transient( $cache_key ); + + if ( false === $pickup_address ) { + try { + $result = Package::get_api()->get_finder_api()->find_by_id( $keyword_id, $address_data['country'], $address_data['postcode'] ); + + $pickup_address = array( + 'name' => trim( $result->gzd_name ), + 'address' => trim( $result->place->address->streetAddress ), + 'postcode' => trim( $result->place->address->postalCode ), + 'city' => trim( $result->place->address->addressLocality ), + ); + + set_transient( $cache_key, $pickup_address, DAY_IN_SECONDS ); + } catch ( \Exception $e ) { + if ( 404 === $e->getCode() ) { + $error->add( 'pickup', sprintf( _x( 'The pickup location you\'ve chosen cannot be found.', 'dhl', 'woocommerce-germanized' ) ) ); + + set_transient( $cache_key, array(), DAY_IN_SECONDS ); + } + } + } elseif ( empty( $pickup_address ) ) { + $error->add( 'pickup', sprintf( _x( 'The pickup location you\'ve chosen cannot be found.', 'dhl', 'woocommerce-germanized' ) ) ); + } + + if ( wc_gzd_dhl_wp_error_has_errors( $error ) ) { + return $error; + } + + if ( $report_invalid_address ) { + if ( 'address_1' !== $address_field ) { + if ( $pickup_address['address'] !== $address_data['address_1'] ) { + $error->add( 'pickup_address', sprintf( _x( 'Your pickup address seems invalid. Did you mean %s?', 'dhl', 'woocommerce-germanized' ), esc_html( $pickup_address['address'] ) ) ); + } + } + + if ( $pickup_address['city'] !== $address_data['city'] ) { + $error->add( 'pickup_city', sprintf( _x( 'Your pickup city seems invalid. Did you mean %s?', 'dhl', 'woocommerce-germanized' ), esc_html( $pickup_address['city'] ) ) ); + } + } + + if ( wc_gzd_dhl_wp_error_has_errors( $error ) ) { + return $error; + } + + return $pickup_address; + } + + if ( wc_gzd_dhl_wp_error_has_errors( $error ) ) { + return $error; + } + + return $pickup_address; + } + + public static function ajax_validate_address() { + check_ajax_referer( 'dhl-parcel-locator', 'security' ); + + $address = isset( $_POST['address'] ) ? wc_clean( wp_unslash( $_POST['address'] ) ) : ''; + $address_data = wp_parse_args( + $address, + array( + 'country' => Package::get_base_country(), + 'address_1' => '', + 'address_2' => '', + 'postcode' => '', + ) + ); + + $address_field = self::get_pickup_address_field_by_country( $address_data['country'] ); + + $response = array( + 'valid' => true, + 'address_1' => $address_data['address_1'], + 'address_2' => $address_data['address_2'], + 'success' => true, + 'messages' => '', + ); + + $result = self::is_valid_pickup_address( $address_data ); + + if ( is_wp_error( $result ) ) { + $response['valid'] = false; + $response['messages'] = ''; + + foreach ( $result->get_error_messages() as $message ) { + $response['messages'] .= '
';
+
+ if ( self::cart_needs_shipping() && self::is_preferred_option_available() ) {
+ $data = self::get_data();
+ $data['logo_url'] = Package::get_assets_url() . '/img/dhl-official.png';
+
+ if ( self::preferred_services_available() && self::is_preferred_day_enabled() ) {
+ self::refresh_day_session();
+ $data['preferred_day_options'] = WC()->session->get( 'dhl_preferred_day_options' );
+ }
+
+ wc_get_template( 'checkout/dhl/preferred-services.php', $data, Package::get_template_path(), Package::get_path() . '/templates/' );
+ }
+
+ echo '
';
+ }
+
+ 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_delivery_type_enabled() {
+ return wc_string_to_bool( self::get_setting( 'PreferredDeliveryType_enable' ) );
+ }
+
+ public static function is_preferred_neighbor_enabled() {
+ return wc_string_to_bool( self::get_setting( 'PreferredNeighbour_enable' ) );
+ }
+
+ public static function get_default_preferred_delivery_type() {
+ return self::get_setting( 'default_delivery_type' ) ? self::get_setting( 'default_delivery_type' ) : 'home';
+ }
+
+ public static function get_preferred_delivery_types() {
+ return array(
+ 'cdp' => _x( 'Shop', 'dhl delivery type context', 'woocommerce-germanized' ),
+ 'home' => _x( 'Home', 'dhl delivery type context', 'woocommerce-germanized' ),
+ );
+ }
+
+ public static function get_preferred_delivery_type_title( $type ) {
+ $types = self::get_preferred_delivery_types();
+
+ if ( array_key_exists( $type, $types ) ) {
+ return $types[ $type ];
+ } else {
+ return '';
+ }
+ }
+
+ protected static function get_setting( $key ) {
+ if ( strpos( $key, 'Preferred' ) === false ) {
+ $key = 'preferred_' . $key;
+ }
+
+ $preferred_enabled_options = array(
+ 'PreferredDay_enable',
+ 'PreferredLocation_enable',
+ 'PreferredDeliveryType_enable',
+ 'PreferredNeighbour_enable',
+ );
+
+ $setting = Package::get_setting( $key );
+
+ if ( in_array( $key, $preferred_enabled_options, true ) ) {
+ if ( $method = wc_gzd_dhl_get_current_shipping_method() ) {
+ if ( ! $method->has_shipping_provider( 'dhl' ) ) {
+ $setting = 'no';
+ }
+ }
+ }
+
+ 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..7db6cd08e
--- /dev/null
+++ b/packages/woocommerce-germanized-dhl/src/Product.php
@@ -0,0 +1,7 @@
+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, true );
+ }
+
+ protected function register_products() {
+ $this->register_product(
+ 'V01PAK',
+ array(
+ 'label' => _x( 'DHL Paket', 'dhl', 'woocommerce-germanized' ),
+ 'countries' => array( 'DE' ),
+ 'zones' => array( 'dom' ),
+ )
+ );
+
+ $this->register_product(
+ 'V01PRIO',
+ array(
+ 'label' => _x( 'DHL Paket PRIO', 'dhl', 'woocommerce-germanized' ),
+ 'countries' => array( 'DE' ),
+ 'zones' => array( 'dom' ),
+ )
+ );
+
+ $this->register_product(
+ 'V06PAK',
+ array(
+ 'label' => _x( 'DHL Paket Taggleich', 'dhl', 'woocommerce-germanized' ),
+ 'countries' => array( 'DE' ),
+ 'zones' => array( 'dom' ),
+ )
+ );
+
+ $this->register_product(
+ 'V62WP',
+ array(
+ 'label' => _x( 'DHL Warenpost', 'dhl', 'woocommerce-germanized' ),
+ 'countries' => array( 'DE' ),
+ 'zones' => array( 'dom' ),
+ )
+ );
+
+ $this->register_product(
+ 'V66WPI',
+ array(
+ 'label' => _x( 'DHL Warenpost International', 'dhl', 'woocommerce-germanized' ),
+ 'zones' => array( 'eu', 'int' ),
+ )
+ );
+
+ $this->register_product(
+ 'V54EPAK',
+ array(
+ 'label' => _x( 'DHL Europaket (B2B)', 'dhl', 'woocommerce-germanized' ),
+ 'zones' => array( 'eu' ),
+ )
+ );
+
+ $this->register_product(
+ 'V55PAK',
+ array(
+ 'label' => _x( 'DHL Paket Connect', 'dhl', 'woocommerce-germanized' ),
+ 'zones' => array( 'eu' ),
+ )
+ );
+
+ $this->register_product(
+ 'V53WPAK',
+ array(
+ 'label' => _x( 'DHL Paket International', 'dhl', 'woocommerce-germanized' ),
+ 'zones' => array( 'eu', 'int' ),
+ )
+ );
+ }
+
+ protected function register_services() {
+ $this->register_service(
+ 'GoGreen',
+ array(
+ 'label' => _x( 'GoGreen', 'dhl', 'woocommerce-germanized' ),
+ 'description' => _x( 'Ship your parcels climate friendly.', 'dhl', 'woocommerce-germanized' ),
+ 'products' => array( 'V01PAK', 'V53WPAK', 'V54EPAK', 'V62WP', 'V66WPI' ),
+ )
+ );
+
+ $this->register_service( new PreferredLocation( $this ) );
+ $this->register_service( new PreferredNeighbour( $this ) );
+ $this->register_service( new PreferredDay( $this ) );
+ $this->register_service( new VisualCheckOfAge( $this ) );
+ $this->register_service( new IdentCheck( $this ) );
+ $this->register_service( new DHLRetoure( $this ) );
+
+ $this->register_service(
+ 'NoNeighbourDelivery',
+ array(
+ 'label' => _x( 'No Neighbor', 'dhl', 'woocommerce-germanized' ),
+ 'description' => _x( 'Do not deliver to neighbors.', 'dhl', 'woocommerce-germanized' ),
+ 'products' => array( 'V01PAK' ),
+ 'countries' => array( 'DE' ),
+ 'zones' => array( 'dom' ),
+ )
+ );
+
+ $this->register_service(
+ 'signedForByRecipient',
+ array(
+ 'label' => _x( 'Recipient signature', 'dhl', 'woocommerce-germanized' ),
+ 'description' => _x( 'Let recipients sign delivery instead of DHL driver.', 'dhl', 'woocommerce-germanized' ),
+ 'products' => array( 'V01PAK' ),
+ 'countries' => array( 'DE' ),
+ 'zones' => array( 'dom' ),
+ )
+ );
+
+ $this->register_service(
+ 'NamedPersonOnly',
+ array(
+ 'label' => _x( 'Named person only', 'dhl', 'woocommerce-germanized' ),
+ 'description' => _x( 'Do only delivery to named person.', 'dhl', 'woocommerce-germanized' ),
+ 'products' => array( 'V01PAK' ),
+ 'countries' => array( 'DE' ),
+ 'zones' => array( 'dom' ),
+ )
+ );
+
+ $this->register_service(
+ 'AdditionalInsurance',
+ array(
+ 'label' => _x( 'Additional Insurance', 'dhl', 'woocommerce-germanized' ),
+ 'description' => _x( 'Add an additional insurance to labels.', 'dhl', 'woocommerce-germanized' ),
+ 'products' => array( 'V01PAK', 'V53WPAK', 'V54EPAK' ),
+ )
+ );
+
+ $this->register_service(
+ 'BulkyGoods',
+ array(
+ 'label' => _x( 'Bulky Goods', 'dhl', 'woocommerce-germanized' ),
+ 'description' => _x( 'Deliver as bulky goods.', 'dhl', 'woocommerce-germanized' ),
+ 'products' => array( 'V01PAK', 'V53WPAK' ),
+ )
+ );
+
+ $this->register_service(
+ 'ParcelOutletRouting',
+ array(
+ 'label' => _x( 'Retail Outlet Routing', 'dhl', 'woocommerce-germanized' ),
+ 'description' => _x( 'Send undeliverable items to nearest retail outlet instead of immediate return.', 'dhl', 'woocommerce-germanized' ),
+ 'products' => array( 'V01PAK', 'V62WP' ),
+ )
+ );
+
+ $this->register_service( new CashOnDelivery( $this ) );
+
+ $this->register_service(
+ 'Premium',
+ array(
+ 'label' => _x( 'Premium', 'dhl', 'woocommerce-germanized' ),
+ 'description' => _x( 'Premium delivery for international shipments.', 'dhl', 'woocommerce-germanized' ),
+ 'products' => array( 'V53WPAK', 'V66WPI' ),
+ 'zones' => array( 'int', 'eu' ),
+ )
+ );
+
+ $this->register_service(
+ 'Endorsement',
+ array(
+ 'label' => _x( 'Endorsement', 'dhl', 'woocommerce-germanized' ),
+ 'description' => _x( 'Select how DHL should handle international shipments that could not be delivered.', 'dhl', 'woocommerce-germanized' ),
+ 'option_type' => 'select',
+ 'options' => wc_gzd_dhl_get_endorsement_types(),
+ 'default_value' => 'return',
+ 'products' => array( 'V53WPAK' ),
+ 'zones' => array( 'int', 'eu' ),
+ )
+ );
+
+ $this->register_service(
+ 'Economy',
+ array(
+ 'label' => _x( 'Economy', 'dhl', 'woocommerce-germanized' ),
+ 'description' => _x( 'Economy delivery for international shipments.', 'dhl', 'woocommerce-germanized' ),
+ 'products' => array( 'V53WPAK', 'V66WPI' ),
+ 'zones' => array( 'int', 'eu' ),
+ )
+ );
+
+ $this->register_service( new ClosestDropPoint( $this ) );
+
+ $this->register_service(
+ 'PostalDeliveryDutyPaid',
+ array(
+ 'label' => _x( 'Postal Delivery Duty Paid', 'dhl', 'woocommerce-germanized' ),
+ 'description' => _x( 'DHL takes care of customs clearance and export duties (Postal Delivered Duty Paid).', 'dhl', 'woocommerce-germanized' ),
+ 'products' => array( 'V53WPAK' ),
+ 'countries' => ParcelServices::get_pddp_countries(),
+ 'zones' => array( 'int' ),
+ )
+ );
+ }
+
+ protected function register_print_formats() {
+ $this->register_print_format(
+ 'default',
+ array(
+ 'label' => _x( 'Default (User configuration)', 'dhl-print-format', 'woocommerce-germanized' ),
+ 'shipment_types' => array( 'simple' ),
+ )
+ );
+
+ $available = array(
+ 'A4' => _x( 'A4', 'dhl-print-format', 'woocommerce-germanized' ),
+ '910-300-700' => _x( '910-300-700', 'dhl-print-format', 'woocommerce-germanized' ),
+ '910-300-700-oZ' => _x( '910-300-700-oZ', 'dhl-print-format', 'woocommerce-germanized' ),
+ '910-300-710' => _x( '910-300-710', 'dhl-print-format', 'woocommerce-germanized' ),
+ '910-300-600' => _x( '910-300-600', 'dhl-print-format', 'woocommerce-germanized' ),
+ '910-300-610' => _x( '910-300-610', 'dhl-print-format', 'woocommerce-germanized' ),
+ '910-300-400' => _x( '910-300-400', 'dhl-print-format', 'woocommerce-germanized' ),
+ '910-300-410' => _x( '910-300-410', 'dhl-print-format', 'woocommerce-germanized' ),
+ '910-300-300' => _x( '910-300-300', 'dhl-print-format', 'woocommerce-germanized' ),
+ '910-300-300-oz' => _x( '910-300-300-oz', 'dhl-print-format', 'woocommerce-germanized' ),
+ );
+
+ foreach ( $available as $print_format => $label ) {
+ $this->register_print_format(
+ $print_format,
+ array(
+ 'label' => $label,
+ 'shipment_types' => array( 'simple' ),
+ )
+ );
+ }
+
+ $this->register_print_format(
+ '100x70mm',
+ array(
+ 'label' => _x( '100x70mm', 'dhl-print-format', 'woocommerce-germanized' ),
+ 'products' => array( 'V62WP', 'V66WPI' ),
+ 'shipment_types' => array( 'simple' ),
+ )
+ );
+ }
+
+ /**
+ * @param ConfigurationSet $configuration_set
+ *
+ * @return string
+ */
+ protected function get_default_product_for_zone( $configuration_set ) {
+ $default = parent::get_default_product_for_zone( $configuration_set );
+
+ if ( 'simple' === $configuration_set->get_shipment_type() ) {
+ if ( 'dom' === $configuration_set->get_zone() ) {
+ return 'V01PAK';
+ } elseif ( 'eu' === $configuration_set->get_zone() ) {
+ return 'V53WPAK';
+ } elseif ( 'int' === $configuration_set->get_zone() ) {
+ return 'V53WPAK';
+ }
+ }
+
+ return $default;
+ }
+
+ protected function get_config_set_return_label_settings() {
+ $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( 'Create retoure labels to 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',
+ 'settings_url' => $this->get_edit_link( 'label' ),
+ 'default' => array(),
+ ),
+
+ array(
+ 'type' => 'sectionend',
+ 'id' => 'dhl_retoure_options',
+ ),
+ );
+
+ $settings = array_merge( $settings, parent::get_config_set_return_label_settings() );
+
+ return $settings;
+ }
+
+ /**
+ * @param ConfigurationSet $configuration_set
+ *
+ * @return mixed
+ */
+ protected function get_label_settings_by_zone( $configuration_set ) {
+ $settings = parent::get_label_settings_by_zone( $configuration_set );
+
+ if ( 'shipping_provider' === $configuration_set->get_setting_type() ) {
+ if ( 'dom' === $configuration_set->get_zone() && 'simple' === $configuration_set->get_shipment_type() ) {
+ $settings = array_merge(
+ $settings,
+ array(
+ array(
+ 'title' => _x( 'Encodable', 'dhl', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Labels will only be created if an address is encodable by DHL.', 'dhl', 'woocommerce-germanized' ),
+ 'id' => 'label_address_codeable_only',
+ 'value' => $this->get_setting( 'label_address_codeable_only', 'no' ),
+ 'default' => 'no',
+ 'type' => 'gzd_toggle',
+ 'desc_tip' => _x( 'Choose this option if you want to make sure that by default labels are only generated for encodable addresses.', 'dhl', 'woocommerce-germanized' ),
+ ),
+
+ array(
+ 'title' => _x( 'Sync (IdentCheck)', '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',
+ 'custom_attributes' => array(
+ 'data-show_if_label_config_set_' . $configuration_set->get_id() . '-g-product-n-product' => 'V01PAK',
+ ),
+ ),
+
+ 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',
+ 'custom_attributes' => array(
+ 'data-show_if_label_config_set_' . $configuration_set->get_id() . '-g-product-n-product' => 'V01PAK',
+ ),
+ ),
+ )
+ );
+ } elseif ( 'int' === $configuration_set->get_zone() && 'simple' === $configuration_set->get_shipment_type() ) {
+ $settings = array_merge(
+ $settings,
+ array(
+ array(
+ 'title' => _x( 'Default Incoterms', '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 incoterms option.', 'dhl', 'woocommerce-germanized' ),
+ 'desc_tip' => true,
+ 'options' => wc_gzd_dhl_get_duties(),
+ 'class' => 'wc-enhanced-select',
+ ),
+ )
+ );
+ }
+ }
+
+ return $settings;
+ }
+
+ 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_label_custom_shipper_reference( $context = 'view' ) {
+ return $this->get_meta( 'label_custom_shipper_reference', true, $context );
+ }
+
+ public function set_label_custom_shipper_reference( $ref ) {
+ $this->update_meta_data( 'label_custom_shipper_reference', $ref );
+ }
+
+ public function has_custom_shipper_reference() {
+ $ref = $this->get_label_custom_shipper_reference();
+ $has_ref = wc_string_to_bool( $this->get_meta( 'label_use_custom_shipper', true ) );
+
+ return $has_ref && ! empty( $ref );
+ }
+
+ 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 delivery', '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 );
+ $default_args = $this->get_default_label_props( $shipment );
+ $service_supports_args = array(
+ 'shipment' => $shipment,
+ 'product' => $default_args['product_id'],
+ );
+
+ if ( $shipment->is_shipping_international() ) {
+ $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',
+ ),
+ )
+ );
+ } elseif ( $shipment->is_shipping_domestic() ) {
+ $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',
+ ),
+ )
+ );
+ }
+
+ if ( $this->get_service( 'dhlRetoure' )->supports( $service_supports_args ) ) {
+ $settings = array_merge( $settings, $this->get_service( 'dhlRetoure' )->get_label_fields( $shipment ) );
+ }
+
+ 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(
+ 'product_id' => '',
+ )
+ );
+
+ $error = new \WP_Error();
+
+ // We don't need duties for non-cross-border shipments
+ if ( ! Package::is_crossborder_shipment( $shipment->get_country(), $shipment->get_postcode() ) ) {
+ unset( $args['duties'] );
+ } else {
+ 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 ) {
+ $defaults = parent::get_default_label_props( $shipment );
+
+ if ( 'return' === $shipment->get_type() ) {
+ $defaults = $this->get_default_return_label_props( $shipment, $defaults );
+ } else {
+ $defaults = $this->get_default_simple_label_props( $shipment, $defaults );
+ }
+
+ return $defaults;
+ }
+
+ /**
+ * @param Shipment $shipment
+ *
+ * @return array
+ */
+ protected function get_default_return_label_props( $shipment, $defaults = array() ) {
+ $defaults = wp_parse_args(
+ $defaults,
+ array(
+ 'services' => array(),
+ 'receiver_slug' => wc_gzd_dhl_get_default_return_receiver_slug( $shipment->get_sender_country() ),
+ )
+ );
+
+ return $defaults;
+ }
+
+ /**
+ * @param Shipment $shipment
+ *
+ * @return string
+ */
+ protected function get_incoterms( $shipment ) {
+ $incoterms = $this->get_setting( 'label_default_duty' );
+
+ if ( ! empty( $shipment->get_incoterms() ) ) {
+ if ( in_array( $shipment->get_incoterms(), array_keys( wc_gzd_dhl_get_duties() ), true ) ) {
+ $incoterms = $shipment->get_incoterms();
+ }
+ }
+
+ return $incoterms;
+ }
+
+ /**
+ * @param Shipment $shipment
+ *
+ * @return array
+ */
+ protected function get_default_simple_label_props( $shipment, $defaults = array() ) {
+ $dhl_order = wc_gzd_dhl_get_order( $shipment->get_order() );
+ $supports_email_transmission = $dhl_order && $dhl_order->supports_email_notification() ? true : false;
+ $defaults = wp_parse_args(
+ $defaults,
+ array(
+ 'product_id' => '',
+ 'services' => array(),
+ )
+ );
+
+ if ( $shipment->is_shipping_domestic() ) {
+ $defaults['codeable_address_only'] = wc_bool_to_string( $this->get_setting( 'label_address_codeable_only', 'no' ) );
+ }
+
+ // Remove parcel outlet routing default service in case email transmission is not allowed
+ if ( ! $supports_email_transmission && in_array( 'ParcelOutletRouting', $defaults['services'], true ) ) {
+ $defaults['services'] = array_diff( $defaults['services'], array( 'ParcelOutletRouting' ) );
+ }
+
+ if ( Package::is_crossborder_shipment( $shipment->get_country(), $shipment->get_postcode() ) ) {
+ $defaults['duties'] = $this->get_incoterms( $shipment );
+
+ /**
+ * Cash on delivery for Paket International is only available in combination with Premium
+ */
+ if ( in_array( 'CashOnDelivery', $defaults['services'], true ) ) {
+ $defaults['services'][] = 'Premium';
+ }
+ }
+
+ /**
+ * Force home delivery if chosen
+ */
+ if ( $this->get_service( 'ClosestDropPoint' )->supports(
+ array(
+ 'shipment' => $shipment,
+ 'product' => $defaults['product_id'],
+ )
+ ) && $dhl_order && 'home' === $dhl_order->get_preferred_delivery_type() ) {
+ $defaults['services'][] = 'Premium';
+ $defaults['services'] = array_diff( $defaults['services'], array( 'ClosestDropPoint' ) );
+ }
+
+ /**
+ * Prevent certain service-combinations
+ */
+ if ( in_array( 'ClosestDropPoint', $defaults['services'], true ) ) {
+ $defaults['services'] = array_diff( $defaults['services'], array( 'Economy', 'Premium' ) );
+ }
+
+ if ( in_array( 'Premium', $defaults['services'], true ) ) {
+ $defaults['services'] = array_diff( $defaults['services'], array( 'ClosestDropPoint', 'Economy' ) );
+ }
+
+ if ( in_array( 'Economy', $defaults['services'], true ) ) {
+ $defaults['services'] = array_diff( $defaults['services'], array( 'ClosestDropPoint', 'Premium' ) );
+ }
+
+ // Remove duplicates
+ $defaults['services'] = array_unique( $defaults['services'] );
+
+ return $defaults;
+ }
+
+ protected function get_available_base_countries() {
+ return Package::get_available_countries();
+ }
+
+ protected function get_connection_status_html() {
+ $username = wc_string_to_bool( $this->get_setting( 'sandbox_mode', 'no' ) ) ? $this->get_setting( 'api_sandbox_username', '' ) : $this->get_setting( 'api_username', '' );
+
+ if ( empty( $username ) ) {
+ return '';
+ }
+
+ $response = Package::get_api()->test_connection();
+ $has_error = is_wp_error( $response ) ? true : false;
+
+ return '' . ( sprintf( _x( 'Status: %1$s', 'dhl', 'woocommerce-germanized' ), ( $has_error ? $response->get_error_message() : _x( 'Connected', 'dhl', 'woocommerce-germanized' ) ) ) ) . '';
+ }
+
+ protected function get_general_settings() {
+ $screen = function_exists( 'get_current_screen' ) ? get_current_screen() : false;
+ $connection_status_html = ( $this->is_activated() && is_admin() && $screen && 'woocommerce_page_wc-settings' === $screen->id ) ? $this->get_connection_status_html() : '';
+ $ref_placeholders = wc_gzd_dhl_get_label_payment_ref_placeholder();
+ $ref_placeholders_str = implode( ', ', array_keys( $ref_placeholders ) );
+
+ $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',
+ 'desc' => $connection_status_html,
+ ),
+
+ 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_product_options',
+ 'desc' => sprintf( _x( 'Learn how to find your participation numbers in your DHL business portal.', 'dhl', 'woocommerce-germanized' ), 'https://vendidero.de/dokument/dhl-integration-einrichten#produkte-und-teilnahmenummern' ),
+ ),
+ );
+
+ $dhl_available_products = $this->get_products()->as_options() + array( 'return' => _x( 'Inlay Returns', 'dhl', 'woocommerce-germanized' ) );
+ $dhl_products = array();
+
+ foreach ( $dhl_available_products as $product => $title ) {
+ $dhl_products[] = array(
+ 'type' => 'dhl_placeholder',
+ 'id' => 'participation_' . $product,
+ 'default' => '',
+ 'value' => $this->get_setting( 'participation_' . $product, '' ),
+ );
+
+ $dhl_products[] = array(
+ 'type' => 'dhl_placeholder',
+ 'id' => 'participation_gogreen_' . $product,
+ 'default' => '',
+ 'value' => $this->get_setting( 'participation_gogreen_' . $product, '' ),
+ );
+ }
+
+ $settings = array_merge( $settings, $dhl_products );
+
+ $settings = array_merge(
+ $settings,
+ array(
+ array(
+ 'title' => _x( 'Participation Numbers', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'dhl_participation_numbers',
+ 'products' => $dhl_available_products,
+ 'default' => '',
+ 'id' => 'participation_numbers',
+ ),
+ array(
+ 'type' => 'sectionend',
+ 'id' => 'dhl_product_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',
+ ),
+ array(
+ 'title' => _x( 'Tracking', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'title',
+ 'id' => 'tracking_options',
+ ),
+ )
+ );
+
+ $general_settings = parent::get_general_settings();
+
+ $general_settings = array_merge(
+ $general_settings,
+ array(
+ array(
+ 'type' => 'sectionend',
+ 'id' => 'tracking_options',
+ ),
+ )
+ );
+
+ return array_merge( $settings, $general_settings );
+ }
+
+ protected function get_pickup_settings( $for_shipping_method = false ) {
+ $settings = array(
+ array(
+ 'title' => '',
+ 'type' => 'title',
+ 'id' => 'dhl_pickup_options',
+ ),
+
+ 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' ) . '' . esc_html( $ref_placeholders_str ) . '' ) . '' . _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',
+ ),
+
+ 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' => '',
+ ),
+
+ 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;',
+ ),
+
+ array(
+ 'type' => 'sectionend',
+ 'id' => 'dhl_pickup_options',
+ ),
+ );
+
+ return $settings;
+ }
+
+ protected function get_preferred_settings( $for_shipping_method = false ) {
+ $wc_gateway_titles = array();
+
+ /**
+ * Calling WC()->payment_gateways()->payment_gateways() could potentially lead to problems
+ * in case the shipping methods are being loaded from within a gateway constructor (e.g. WC Cash on Pickup)
+ */
+ if ( ! $for_shipping_method && 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',
+ ),
+
+ array(
+ 'title' => _x( 'Drop-off location', 'dhl', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Enable drop-off 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( 'Neighbor', 'dhl', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Enable delivery to a neighbor.', '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( 'Delivery Type (CDP)', 'dhl', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Allow your international customers to choose between home and closest droppoint delivery. ', 'dhl', 'woocommerce-germanized' ) . '' . sprintf( _x( 'Display options for the user to select their preferred delivery type during checkout. Currently available for certain countries only.', 'dhl', 'woocommerce-germanized' ), esc_url( 'https://www.dhl.de/de/geschaeftskunden/paket/leistungen-und-services/internationaler-versand/paket-international.html' ) ) . '
',
+ 'id' => 'PreferredDeliveryType_enable',
+ 'value' => wc_bool_to_string( $this->get_setting( 'PreferredDeliveryType_enable' ) ),
+ 'default' => 'no',
+ 'type' => 'gzd_toggle',
+ ),
+
+ array(
+ 'title' => _x( 'Default Delivery Type', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'select',
+ 'desc' => _x( 'Select the default delivery type presented to the customer during checkout.', 'dhl', 'woocommerce-germanized' ),
+ 'desc_tip' => true,
+ 'id' => 'preferred_default_delivery_type',
+ 'value' => $this->get_setting( 'preferred_default_delivery_type' ),
+ 'options' => ParcelServices::get_preferred_delivery_types(),
+ 'default' => 'shop',
+ 'class' => 'wc-enhanced-select',
+ 'custom_attributes' => array( 'data-show_if_PreferredDeliveryType_enable' => '' ),
+ ),
+
+ array(
+ 'title' => _x( 'Home Delivery Fee', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'desc' => _x( 'Insert gross value as surcharge for home deliveries for countries which support closest droppoint deliveries. Insert 0 to offer service for free.', 'dhl', 'woocommerce-germanized' ),
+ 'desc_tip' => true,
+ 'id' => 'preferred_home_delivery_cost',
+ 'value' => wc_format_localized_decimal( $this->get_setting( 'preferred_home_delivery_cost' ) ),
+ 'default' => '0',
+ 'css' => 'max-width: 60px;',
+ 'class' => 'wc_input_decimal',
+ 'custom_attributes' => array( 'data-show_if_PreferredDeliveryType_enable' => '' ),
+ ),
+
+ array(
+ 'title' => _x( 'Delivery day', 'dhl', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Enable delivery day delivery.', 'dhl', 'woocommerce-germanized' ) . '' . _x( 'Enabling this option will display options for the user to select their delivery 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 delivery day delivery. Insert 0 to offer service for free.', 'dhl', 'woocommerce-germanized' ),
+ 'desc_tip' => true,
+ 'id' => 'PreferredDay_cost',
+ 'value' => wc_format_localized_decimal( $this->get_setting( 'PreferredDay_cost' ) ),
+ 'default' => '1.2',
+ 'css' => 'max-width: 60px;',
+ 'class' => 'wc_input_decimal',
+ 'custom_attributes' => array( 'data-show_if_PreferredDay_enable' => '' ),
+ ),
+
+ array(
+ 'title' => _x( 'Cut-off time', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'time',
+ 'id' => 'PreferredDay_cutoff_time',
+ 'value' => $this->get_setting( 'PreferredDay_cutoff_time' ),
+ 'desc' => '' . _x( 'The cut-off time is the latest possible order time up to which the minimum delivery day (day of order + 2 working days) can be guaranteed. As soon as the time is exceeded, the earliest delivery 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_PreferredDay_enable' => '' ),
+ ),
+
+ array(
+ 'title' => _x( 'Preparation days', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'number',
+ 'id' => 'PreferredDay_preparation_days',
+ '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 delivery day delivery.', 'dhl', 'woocommerce-germanized' ) . '
',
+ 'default' => '0',
+ 'css' => 'max-width: 60px',
+ 'custom_attributes' => array(
+ 'data-show_if_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',
+ 'type' => 'gzd_toggle',
+ 'default' => 'no',
+ 'checkboxgroup' => 'start',
+ 'custom_attributes' => array( 'data-show_if_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',
+ 'default' => 'no',
+ 'checkboxgroup' => '',
+ 'custom_attributes' => array( 'data-show_if_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',
+ 'default' => 'no',
+ 'checkboxgroup' => '',
+ 'custom_attributes' => array( 'data-show_if_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',
+ 'default' => 'no',
+ 'checkboxgroup' => '',
+ 'custom_attributes' => array( 'data-show_if_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',
+ 'default' => 'no',
+ 'checkboxgroup' => '',
+ 'custom_attributes' => array( 'data-show_if_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',
+ 'default' => 'no',
+ 'checkboxgroup' => 'end',
+ 'custom_attributes' => array( 'data-show_if_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,
+ '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() {
+ $settings = array(
+ array(
+ 'title' => '',
+ 'type' => 'title',
+ 'id' => 'shipping_provider_dhl_label_options',
+ ),
+
+ array(
+ 'title' => _x( 'Custom shipper', 'dhl', 'woocommerce-germanized' ),
+ 'desc' => _x( 'Use a custom shipper address managed within your DHL business profile.', 'dhl', 'woocommerce-germanized' ) . '' . sprintf( _x( 'Choose this option if you want to use a custom address profile managed within your DHL business profile as shipper reference for your labels.', 'dhl', 'woocommerce-germanized' ), 'https://vendidero.de/dokument/dhl-integration-einrichten#individuelle-absenderreferenz-samt-logo-nutzen' ) . '
',
+ 'id' => 'label_use_custom_shipper',
+ 'value' => $this->get_setting( 'label_use_custom_shipper', 'no' ),
+ 'default' => 'no',
+ 'type' => 'gzd_toggle',
+ ),
+
+ array(
+ 'title' => _x( 'Shipper reference', 'dhl', 'woocommerce-germanized' ),
+ 'desc' => '' . sprintf( _x( 'Insert the address reference you have chosen within the DHL business portal for your custom shipper address.', 'dhl', 'woocommerce-germanized' ), 'https://vendidero.de/dokument/dhl-integration-einrichten#individuelle-absenderreferenz-samt-logo-nutzen' ) . '
',
+ 'id' => 'label_custom_shipper_reference',
+ 'value' => $this->get_setting( 'label_custom_shipper_reference', '' ),
+ 'default' => '',
+ 'type' => 'text',
+ 'custom_attributes' => array( 'data-show_if_label_use_custom_shipper' => 'yes' ),
+ ),
+
+ array(
+ 'type' => 'sectionend',
+ 'id' => 'shipping_provider_dhl_label_options',
+ ),
+ );
+
+ $settings = array_merge( $settings, parent::get_label_settings() );
+
+ return $settings;
+ }
+
+ public function get_help_link() {
+ return 'https://vendidero.de/dokument/dhl-integration-einrichten';
+ }
+
+ public function get_signup_link() {
+ return 'https://www.dhl.de/dhl-kundewerden?source=woocommercegermanized&cid=c_dhloka_de_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_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( 'Delivery day', 'dhl', 'woocommerce-germanized' ) . '
' . esc_html_x( 'Let your customers choose a delivery 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 delivery 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( 'Drop-off location', 'dhl', 'woocommerce-germanized' ) . '
' . esc_html_x( 'Allow your customers to send their parcels to a drop-off 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; + } + + public function get_supported_label_config_set_shipment_types() { + return array( 'simple' ); + } +} 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..cb047a035 --- /dev/null +++ b/packages/woocommerce-germanized-dhl/src/ShippingProvider/DeutschePost.php @@ -0,0 +1,623 @@ +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, true ); + } + + 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://deutschepost.de/de/s/sendungsverfolgung.html?piececode={tracking_id}'; + } + + 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 ) ); + } + + protected function get_available_base_countries() { + return Package::get_available_countries(); + } + + protected function get_connection_status_html( $maybe_error ) { + return '' . ( sprintf( _x( 'Status: %1$s', 'dhl', 'woocommerce-germanized' ), ( is_wp_error( $maybe_error ) ? $maybe_error->get_error_message() : _x( 'Connected', 'dhl', 'woocommerce-germanized' ) ) ) ) . ''; + } + + protected function get_printing_settings() { + $settings = parent::get_printing_settings(); + $settings_url = $this->get_edit_link( '' ); + + $settings = array_merge( + array( + array( + 'title' => _x( 'Printing', 'dhl', 'woocommerce-germanized' ), + 'type' => 'title', + 'id' => 'shipping_provider_label_printing_options', + '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' ), esc_url( wp_nonce_url( add_query_arg( array( 'action' => 'wc-gzd-dhl-im-page-formats-refresh' ), $settings_url ), 'wc-gzd-dhl-refresh-im-page-formats' ) ) ) . '
',
+ ),
+ 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' => 'shipping_provider_label_format_options',
+ ),
+ ),
+ $settings
+ );
+
+ return $settings;
+ }
+
+ 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',
+ ),
+ );
+
+ if ( $im = Package::get_internetmarke_api() ) {
+ $im->reload_products();
+
+ $screen = function_exists( 'get_current_screen' ) ? get_current_screen() : false;
+
+ if ( is_admin() && $screen && in_array( $screen->id, array( 'woocommerce_page_wc-settings' ), true ) ) {
+ if ( $im->is_configured() && $im->auth() && $im->is_available() ) {
+ if ( isset( $_GET['provider'] ) && 'deutsche_post' === $_GET['provider'] ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+ $balance = $im->get_balance( true );
+
+ $settings = array_merge(
+ $settings,
+ array(
+ array(
+ 'title' => _x( 'Portokasse', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'title',
+ 'id' => 'deutsche_post_portokasse_options',
+ 'desc' => $this->get_connection_status_html( true ),
+ ),
+ 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' => 'dp_charge',
+ ),
+
+ array(
+ 'type' => 'sectionend',
+ 'id' => 'deutsche_post_portokasse_options',
+ ),
+ )
+ );
+ }
+ } elseif ( $im && $im->has_errors() ) {
+ $settings = array_merge(
+ $settings,
+ array(
+ array(
+ 'title' => _x( 'Portokasse', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'title',
+ 'id' => 'deutsche_post_api_error',
+ 'desc' => $this->get_connection_status_html( $im->get_errors() ),
+ ),
+ array(
+ 'type' => 'sectionend',
+ 'id' => 'deutsche_post_api_error',
+ ),
+ )
+ );
+ }
+
+ if ( $im->is_configured() ) {
+ $settings_url = $this->get_edit_link( '' );
+
+ $settings = array_merge(
+ $settings,
+ array(
+ array(
+ 'title' => _x( 'Products', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'title',
+ 'id' => 'deutsche_post_product_refresh_options',
+ 'desc' => '' . esc_html_x( 'Refresh available products', 'dhl', 'woocommerce-germanized' ) . '',
+ ),
+ array(
+ 'type' => 'sectionend',
+ 'id' => 'deutsche_post_product_refresh_options',
+ ),
+ )
+ );
+ }
+ }
+ }
+
+ $settings = array_merge(
+ $settings,
+ array(
+ 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 register_services() {
+ foreach ( Package::get_internetmarke_api()->get_product_list()->get_additional_services() as $service => $label ) {
+ $this->register_service(
+ $service,
+ array(
+ 'label' => $label,
+ 'shipment_types' => array( 'return', 'simple' ),
+ 'excluded_locations' => wc_gzd_get_shipping_provider_service_locations(),
+ )
+ );
+ }
+ }
+
+ protected function register_print_formats() {
+ if ( $im = Package::get_internetmarke_api() ) {
+ foreach ( $im->get_page_format_list() as $page_format_id => $page_format ) {
+ $this->register_print_format(
+ $page_format_id,
+ array(
+ 'label' => $page_format,
+ )
+ );
+ }
+ }
+ }
+
+ protected function register_products() {
+ global $wpdb;
+
+ if ( ! get_transient( 'wc_gzd_dhl_im_products_expire' ) ) {
+ if ( ( $api = Package::get_internetmarke_api() ) && $api->is_configured() ) {
+ $result = Package::get_internetmarke_api()->get_product_list()->update();
+
+ if ( is_wp_error( $result ) ) {
+ Package::log( 'Error while refreshing Internetmarke product data: ' . $result->get_error_message() );
+ }
+ }
+
+ /**
+ * Refresh product data once per day.
+ */
+ set_transient( 'wc_gzd_dhl_im_products_expire', 'yes', DAY_IN_SECONDS );
+ }
+
+ $products = $wpdb->get_results( "SELECT * FROM {$wpdb->gzd_dhl_im_products}" );
+
+ foreach ( $products as $product ) {
+ $this->register_product(
+ $product->product_code,
+ array(
+ 'id' => $product->product_code,
+ 'label' => $product->product_name,
+ 'description' => $product->product_description,
+ 'shipment_types' => array( 'simple', 'return' ),
+ 'internal_id' => $product->product_id,
+ 'parent_id' => $product->product_parent_id,
+ 'zones' => 'national' === $product->product_destination ? array( 'dom' ) : array( 'eu', 'int' ),
+ 'price' => $product->product_price,
+ 'length' => array(
+ 'min' => $product->product_length_min,
+ 'max' => $product->product_length_max,
+ ),
+ 'width' => array(
+ 'min' => $product->product_width_min,
+ 'max' => $product->product_width_max,
+ ),
+ 'height' => array(
+ 'min' => $product->product_height_min,
+ 'max' => $product->product_height_max,
+ ),
+ 'weight' => array(
+ 'min' => $product->product_weight_min,
+ 'max' => $product->product_weight_max,
+ ),
+ 'weight_unit' => 'g',
+ 'dimension_unit' => 'mm',
+ 'meta' => array(
+ 'is_wp_int' => 0 !== absint( $product->product_is_wp_int ) ? true : false,
+ 'information_text' => $product->product_information_text,
+ 'annotation' => $product->product_annotation,
+ 'destination' => $product->product_destination,
+ ),
+ )
+ );
+ }
+ }
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment
+ */
+ public function get_label_fields( $shipment ) {
+ if ( ! Package::get_internetmarke_api()->is_available() ) {
+ return Package::get_internetmarke_api()->get_errors();
+ }
+
+ return parent::get_label_fields( $shipment );
+ }
+
+ 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 ) {
+ $props = $this->get_default_label_props( $shipment );
+ $products = $this->get_products(
+ array(
+ 'shipment' => $shipment,
+ 'parent_id' => 0,
+ )
+ );
+ $settings = parent::get_simple_label_fields( $shipment );
+ $is_wp_int = false;
+
+ /**
+ * When retrieving the label fields make sure to only include parent products
+ */
+ $settings[0]['options'] = $products->as_options();
+
+ if ( ! empty( $props['product_id'] ) ) {
+ $is_wp_int = Package::get_internetmarke_api()->is_warenpost_international( $props['product_id'] );
+ }
+
+ if ( $products->empty() ) {
+ 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' ), esc_url( $this->get_edit_link( 'label' ) ) ) );
+ }
+
+ $settings = array_merge( $settings, $this->get_available_additional_services( $props['product_id'], $props['services'] ) );
+
+ if ( ! $is_wp_int ) {
+ $settings = array_merge(
+ $settings,
+ array(
+ array(
+ 'id' => '',
+ 'type' => 'columns',
+ ),
+ array(
+ 'id' => 'position_x',
+ 'label' => _x( 'Print X-Position', 'dhl', 'woocommerce-germanized' ),
+ 'description' => '',
+ 'type' => 'number',
+ 'wrapper_class' => 'column col-6',
+ 'style' => 'width: 100%;',
+ 'custom_attributes' => array(
+ 'min' => 0,
+ 'step' => 1,
+ ),
+ 'value' => isset( $default_args['position_x'] ) ? $default_args['position_x'] : 1,
+ ),
+ array(
+ 'id' => 'position_y',
+ 'label' => _x( 'Print Y-Position', 'dhl', 'woocommerce-germanized' ),
+ 'description' => '',
+ 'type' => 'number',
+ 'wrapper_class' => 'column col-6',
+ 'style' => 'width: 100%;',
+ 'custom_attributes' => array(
+ 'min' => 0,
+ 'step' => 1,
+ ),
+ 'value' => isset( $default_args['position_y'] ) ? $default_args['position_y'] : 1,
+ ),
+ )
+ );
+ }
+
+ return $settings;
+ }
+
+ public function get_available_additional_services( $product_id, $selected_services = array() ) {
+ $im_product_id = $this->get_product( $product_id )->get_internal_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,
+ 'wrapper_class' => 'form-field-checkbox',
+ 'type' => 'checkbox',
+ 'label' => \Vendidero\Germanized\DHL\Package::get_internetmarke_api()->get_product_list()->get_additional_service_title( $service ),
+ 'value' => in_array( $service, $selected_services, true ) ? 'yes' : 'no',
+ );
+ }
+
+ $settings[] = array(
+ 'type' => 'wrapper_end',
+ );
+
+ return $settings;
+ }
+
+ 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'] ) ) {
+ if ( $product = $this->get_product( $defaults['product_id'] ) ) {
+ $defaults['stamp_total'] = Package::get_internetmarke_api()->get_product_total( $defaults['product_id'] );
+
+ if ( $product->get_parent_id() > 0 ) {
+ $defaults['services'] = Package::get_internetmarke_api()->get_product_services( $product->get_id() );
+ $defaults['product_id'] = Package::get_internetmarke_api()->get_product_parent_code( $product->get_id() );
+ } else {
+ /**
+ * Get current services from the selected product.
+ */
+ $defaults['services'] = Package::get_internetmarke_api()->get_product_services( $defaults['product_id'] );
+ }
+ }
+ }
+
+ return $defaults;
+ }
+
+ protected function get_default_simple_label_props( $shipment ) {
+ $defaults = array(
+ 'position_x' => $this->get_setting( 'label_position_x' ),
+ 'position_y' => $this->get_setting( 'label_position_y' ),
+ 'stamp_total' => 0,
+ 'services' => array(),
+ );
+
+ 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(
+ 'product_id' => '',
+ 'services' => array(),
+ )
+ );
+
+ $error = new \WP_Error();
+
+ if ( ! empty( $args['services'] ) ) {
+ /**
+ * Additional services are requested. Let's 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 = $this->get_products( array( 'shipment' => $shipment ) );
+
+ /**
+ * Check whether the product might not be available for the current shipment
+ */
+ if ( ! $available_products->get( $args['product_id'] ) ) {
+ /**
+ * 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' ), esc_url( $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).
+ */
+ $im_product_code = Package::get_internetmarke_api()->get_product_parent_code( $available_products->get_by_index( 0 )->get_id() );
+
+ 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/Services/CashOnDelivery.php b/packages/woocommerce-germanized-dhl/src/ShippingProvider/Services/CashOnDelivery.php
new file mode 100644
index 000000000..f695b5f60
--- /dev/null
+++ b/packages/woocommerce-germanized-dhl/src/ShippingProvider/Services/CashOnDelivery.php
@@ -0,0 +1,71 @@
+ 'CashOnDelivery',
+ 'label' => _x( 'Cash on Delivery', 'dhl', 'woocommerce-germanized' ),
+ 'products' => array( 'V01PAK', 'V53WPAK' ),
+ 'excluded_locations' => array( 'settings' ),
+ );
+
+ parent::__construct( $shipping_provider, $args );
+ }
+
+ public function get_default_value( $suffix = '' ) {
+ $default_value = parent::get_default_value( $suffix );
+
+ if ( 'cod_total' === $suffix ) {
+ $default_value = '';
+ }
+
+ return $default_value;
+ }
+
+ public function book_as_default( $shipment ) {
+ $book_as_default = parent::book_as_default( $shipment );
+
+ if ( false === $book_as_default ) {
+ $dhl_order = wc_gzd_dhl_get_order( $shipment->get_order() );
+
+ if ( $dhl_order && $dhl_order->has_cod_payment() ) {
+ $book_as_default = true;
+ }
+ }
+
+ return $book_as_default;
+ }
+
+ protected function get_additional_label_fields( $shipment ) {
+ $label_fields = parent::get_additional_label_fields( $shipment );
+ $value = $shipment->get_total() + round( $shipment->get_additional_total(), wc_get_price_decimals() );
+
+ $label_fields = array_merge(
+ $label_fields,
+ array(
+ array(
+ 'id' => $this->get_label_field_id( 'cod_total' ),
+ 'class' => 'wc_input_decimal',
+ 'data_type' => 'price',
+ 'label' => _x( 'COD Amount', 'dhl', 'woocommerce-germanized' ),
+ 'placeholder' => '',
+ 'description' => '',
+ 'value' => wc_format_localized_decimal( $value ),
+ 'type' => 'text',
+ 'custom_attributes' => array( 'data-show-if-service_CashOnDelivery' => '' ),
+ 'is_required' => true,
+ ),
+ )
+ );
+
+ return $label_fields;
+ }
+}
diff --git a/packages/woocommerce-germanized-dhl/src/ShippingProvider/Services/ClosestDropPoint.php b/packages/woocommerce-germanized-dhl/src/ShippingProvider/Services/ClosestDropPoint.php
new file mode 100644
index 000000000..8dc485fba
--- /dev/null
+++ b/packages/woocommerce-germanized-dhl/src/ShippingProvider/Services/ClosestDropPoint.php
@@ -0,0 +1,38 @@
+ 'ClosestDropPoint',
+ 'label' => _x( 'Closest Droppoint (CDP)', 'dhl', 'woocommerce-germanized' ),
+ 'description' => _x( 'Ship to a parcel shop or parcel locker in the vicinity of your customer’s home address.', 'dhl', 'woocommerce-germanized' ),
+ 'products' => array( 'V53WPAK' ),
+ 'countries' => ParcelServices::get_cdp_countries(),
+ 'zones' => array( 'eu' ),
+ );
+
+ parent::__construct( $shipping_provider, $args );
+ }
+
+ public function book_as_default( $shipment ) {
+ $book_as_default = parent::book_as_default( $shipment );
+
+ if ( false === $book_as_default ) {
+ $dhl_order = wc_gzd_dhl_get_order( $shipment->get_order() );
+
+ if ( $dhl_order && $dhl_order->has_cdp_delivery() ) {
+ $book_as_default = true;
+ }
+ }
+
+ return $book_as_default;
+ }
+}
diff --git a/packages/woocommerce-germanized-dhl/src/ShippingProvider/Services/DHLRetoure.php b/packages/woocommerce-germanized-dhl/src/ShippingProvider/Services/DHLRetoure.php
new file mode 100644
index 000000000..1a79e8f37
--- /dev/null
+++ b/packages/woocommerce-germanized-dhl/src/ShippingProvider/Services/DHLRetoure.php
@@ -0,0 +1,202 @@
+ 'dhlRetoure',
+ 'label' => _x( 'Inlay Return Label', 'dhl', 'woocommerce-germanized' ),
+ 'description' => _x( 'Additionally create inlay return labels for shipments that support returns.', 'dhl', 'woocommerce-germanized' ),
+ 'products' => array( 'V01PAK', 'V62WP' ),
+ 'countries' => array( 'DE' ),
+ 'zones' => array( 'dom' ),
+ 'excluded_locations' => array( 'label_services' ),
+ );
+
+ parent::__construct( $shipping_provider, $args );
+ }
+
+ public function get_default_value( $suffix = '' ) {
+ $default_value = parent::get_default_value( $suffix );
+
+ if ( 'cod_total' === $suffix ) {
+ $default_value = '';
+ }
+
+ return $default_value;
+ }
+
+ public function get_label_fields( $shipment, $location = '' ) {
+ $label_fields = parent::get_label_fields( $shipment, $location );
+
+ if ( count( $label_fields ) > 0 ) {
+ $label_fields[0]['class'] = 'show-if-trigger';
+ $label_fields[0]['custom_attributes'] = array( 'data-show-if' => '.show-if-has-return' );
+ }
+
+ return $label_fields;
+ }
+
+ protected function get_additional_label_fields( $shipment ) {
+ $label_fields = parent::get_additional_label_fields( $shipment );
+ $field_prefix = $this->get_label_field_id( 'return_address' );
+ $return_address = array(
+ 'name' => Package::get_dhl_shipping_provider()->get_return_name(),
+ 'company' => Package::get_dhl_shipping_provider()->get_return_company(),
+ 'street' => Package::get_dhl_shipping_provider()->get_return_street(),
+ 'street_number' => Package::get_dhl_shipping_provider()->get_return_street_number(),
+ 'postcode' => Package::get_dhl_shipping_provider()->get_return_postcode(),
+ 'city' => Package::get_dhl_shipping_provider()->get_return_city(),
+ 'phone' => Package::get_dhl_shipping_provider()->get_return_phone(),
+ 'email' => Package::get_dhl_shipping_provider()->get_return_email(),
+ );
+
+ $label_fields = array_merge(
+ $label_fields,
+ array(
+ array(
+ 'id' => $field_prefix . '[name]',
+ 'label' => _x( 'Name', 'dhl', 'woocommerce-germanized' ),
+ 'placeholder' => '',
+ 'description' => '',
+ 'value' => $return_address['name'],
+ 'type' => 'text',
+ 'wrapper_class' => 'show-if-has-return',
+ ),
+ array(
+ 'id' => $field_prefix . '[company]',
+ 'label' => _x( 'Company', 'dhl', 'woocommerce-germanized' ),
+ 'placeholder' => '',
+ 'description' => '',
+ 'wrapper_class' => 'show-if-has-return',
+ 'type' => 'text',
+ 'value' => $return_address['company'],
+ ),
+ array(
+ 'id' => '',
+ 'type' => 'columns',
+ ),
+ array(
+ 'id' => $field_prefix . '[street]',
+ 'label' => _x( 'Street', 'dhl', 'woocommerce-germanized' ),
+ 'placeholder' => '',
+ 'description' => '',
+ 'type' => 'text',
+ 'wrapper_class' => 'show-if-has-return column col-9',
+ 'value' => $return_address['street'],
+ ),
+ array(
+ 'id' => $field_prefix . '[street_number]',
+ 'label' => _x( 'Street No', 'dhl', 'woocommerce-germanized' ),
+ 'placeholder' => '',
+ 'description' => '',
+ 'type' => 'text',
+ 'wrapper_class' => 'show-if-has-return column col-3',
+ 'value' => $return_address['street_number'],
+ ),
+ array(
+ 'id' => '',
+ 'type' => 'columns_end',
+ ),
+ array(
+ 'id' => '',
+ 'type' => 'columns',
+ ),
+ array(
+ 'id' => $field_prefix . '[postcode]',
+ 'label' => _x( 'Postcode', 'dhl', 'woocommerce-germanized' ),
+ 'placeholder' => '',
+ 'description' => '',
+ 'type' => 'text',
+ 'wrapper_class' => 'show-if-has-return column col-6',
+ 'value' => $return_address['postcode'],
+ ),
+ array(
+ 'id' => $field_prefix . '[city]',
+ 'label' => _x( 'City', 'dhl', 'woocommerce-germanized' ),
+ 'placeholder' => '',
+ 'description' => '',
+ 'type' => 'text',
+ 'wrapper_class' => 'show-if-has-return column col-6',
+ 'value' => $return_address['city'],
+ ),
+ array(
+ 'id' => '',
+ 'type' => 'columns_end',
+ ),
+ array(
+ 'id' => '',
+ 'type' => 'columns',
+ ),
+ array(
+ 'id' => $field_prefix . '[phone]',
+ 'label' => _x( 'Phone', 'dhl', 'woocommerce-germanized' ),
+ 'placeholder' => '',
+ 'description' => '',
+ 'type' => 'text',
+ 'wrapper_class' => 'show-if-has-return column col-6',
+ 'value' => $return_address['phone'],
+ ),
+ array(
+ 'id' => $field_prefix . '[email]',
+ 'label' => _x( 'Email', 'dhl', 'woocommerce-germanized' ),
+ 'placeholder' => '',
+ 'description' => '',
+ 'type' => 'text',
+ 'wrapper_class' => 'show-if-has-return column col-6',
+ 'value' => $return_address['email'],
+ ),
+ array(
+ 'id' => '',
+ 'type' => 'columns_end',
+ ),
+ )
+ );
+
+ return $label_fields;
+ }
+
+ public function validate_label_request( $props, $shipment ) {
+ $error = new ShipmentError();
+ $return_address_field = $this->get_label_field_id( 'return_address' );
+ $return_address = wp_parse_args(
+ isset( $props[ $return_address_field ] ) ? (array) $props[ $return_address_field ] : array(),
+ array(
+ 'name' => '',
+ 'company' => '',
+ 'street' => '',
+ 'street_number' => '',
+ 'postcode' => '',
+ 'city' => '',
+ 'phone' => '',
+ 'email' => '',
+ )
+ );
+
+ $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( $return_address[ $mand ] ) ) {
+ $error->add( 500, sprintf( _x( '%s of the return address is a mandatory field.', 'dhl', 'woocommerce-germanized' ), $title ) );
+ }
+ }
+
+ if ( empty( $return_address['name'] ) && empty( $return_address['company'] ) ) {
+ $error->add( 500, _x( 'Please either add a return company or name.', 'dhl', 'woocommerce-germanized' ) );
+ }
+
+ return wc_gzd_shipment_wp_error_has_errors( $error ) ? $error : true;
+ }
+}
diff --git a/packages/woocommerce-germanized-dhl/src/ShippingProvider/Services/IdentCheck.php b/packages/woocommerce-germanized-dhl/src/ShippingProvider/Services/IdentCheck.php
new file mode 100644
index 000000000..a7875b215
--- /dev/null
+++ b/packages/woocommerce-germanized-dhl/src/ShippingProvider/Services/IdentCheck.php
@@ -0,0 +1,151 @@
+ 'IdentCheck',
+ 'label' => _x( 'Ident-Check', 'dhl', 'woocommerce-germanized' ),
+ 'description' => _x( 'Use the DHL Ident-Check service to make sure your parcels are only released to the recipient in person.', 'dhl', 'woocommerce-germanized' ),
+ 'products' => array( 'V01PAK' ),
+ 'countries' => array( 'DE' ),
+ 'zones' => array( 'dom' ),
+ );
+
+ parent::__construct( $shipping_provider, $args );
+ }
+
+ /**
+ * @param ConfigurationSet $configuration_set
+ *
+ * @return array[]
+ */
+ protected function get_additional_setting_fields( $configuration_set ) {
+ $base_setting_id = $this->get_setting_id( $configuration_set );
+ $setting_id = $this->get_setting_id( $configuration_set, 'min_age' );
+ $value = $configuration_set->get_service_meta( $this->get_id(), 'min_age', '0' );
+
+ return array(
+ array(
+ 'title' => _x( 'Minimum age', 'dhl', 'woocommerce-germanized' ),
+ 'id' => $setting_id,
+ 'type' => 'select',
+ 'default' => '0',
+ 'value' => $value,
+ 'options' => wc_gzd_dhl_get_ident_min_ages(),
+ 'custom_attributes' => array( "data-show_if_{$base_setting_id}" => '' ),
+ 'desc_tip' => _x( 'Choose this option if you want to let DHL check your customer\'s identity and age.', 'dhl', 'woocommerce-germanized' ),
+ ),
+ );
+ }
+
+ public function get_default_value( $suffix = '' ) {
+ $default_value = parent::get_default_value( $suffix );
+
+ if ( 'date_of_birth' === $suffix ) {
+ $default_value = '';
+ } elseif ( 'min_age' === $suffix ) {
+ $default_value = '';
+ }
+
+ return $default_value;
+ }
+
+ public function book_as_default( $shipment ) {
+ $book_as_default = parent::book_as_default( $shipment );
+
+ if ( false === $book_as_default ) {
+ $dhl_order = wc_gzd_dhl_get_order( $shipment->get_order() );
+
+ if ( $dhl_order && $dhl_order->needs_age_verification() && 'yes' === $this->get_shipping_provider()->get_setting( 'label_auto_age_check_ident_sync' ) ) {
+ $book_as_default = true;
+ }
+ }
+
+ return $book_as_default;
+ }
+
+ protected function get_additional_label_fields( $shipment ) {
+ $label_fields = parent::get_additional_label_fields( $shipment );
+ $dhl_order = wc_gzd_dhl_get_order( $shipment->get_order() );
+ $min_age = $this->get_value( $shipment, 'min_age' );
+ $date_of_birth = $this->get_value( $shipment, 'date_of_birth' );
+
+ if ( $dhl_order && $dhl_order->needs_age_verification() && 'yes' === $this->get_shipping_provider()->get_setting( 'label_auto_age_check_ident_sync' ) ) {
+ $min_age = $dhl_order->get_min_age();
+ }
+
+ if ( $dhl_order ) {
+ $date_of_birth = $dhl_order->get_date_of_birth();
+ }
+
+ $label_fields = array_merge(
+ $label_fields,
+ array(
+ array(
+ 'id' => '',
+ 'type' => 'columns',
+ ),
+ array(
+ 'id' => $this->get_label_field_id( 'date_of_birth' ),
+ 'label' => _x( 'Date of Birth', 'dhl', 'woocommerce-germanized' ),
+ 'placeholder' => '',
+ 'description' => '',
+ 'value' => $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,
+ 'data-show-if-service_IdentCheck' => '',
+ ),
+ 'class' => 'short date-picker',
+ 'wrapper_class' => 'column col-6',
+ 'type' => 'text',
+ ),
+ array(
+ 'id' => $this->get_label_field_id( 'min_age' ),
+ 'label' => _x( 'Minimum age', 'dhl', 'woocommerce-germanized' ),
+ 'description' => '',
+ 'type' => 'select',
+ 'value' => $min_age,
+ 'options' => wc_gzd_dhl_get_ident_min_ages(),
+ 'custom_attributes' => array( 'data-show-if-service_IdentCheck' => '' ),
+ 'wrapper_class' => 'column col-6',
+ ),
+ array(
+ 'id' => '',
+ 'type' => 'columns_end',
+ ),
+ )
+ );
+
+ return $label_fields;
+ }
+
+ public function validate_label_request( $props, $shipment ) {
+ $error = new ShipmentError();
+ $date_of_birth = isset( $props[ $this->get_label_field_id( 'date_of_birth' ) ] ) ? $props[ $this->get_label_field_id( 'date_of_birth' ) ] : '';
+ $min_age = isset( $props[ $this->get_label_field_id( 'min_age' ) ] ) ? $props[ $this->get_label_field_id( 'min_age' ) ] : '';
+
+ if ( ! empty( $date_of_birth ) && ! wc_gzd_dhl_is_valid_datetime( $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( $min_age ) && ! wc_gzd_dhl_is_valid_ident_min_age( $min_age ) ) {
+ $error->add( 500, _x( 'The minimum age (IdentCheck) supplied is invalid.', 'dhl', 'woocommerce-germanized' ) );
+ }
+
+ if ( empty( $date_of_birth ) && empty( $min_age ) ) {
+ $error->add( 500, _x( 'Either a minimum age or a date of birth is need for the ident check.', 'dhl', 'woocommerce-germanized' ) );
+ }
+
+ return wc_gzd_shipment_wp_error_has_errors( $error ) ? $error : true;
+ }
+}
diff --git a/packages/woocommerce-germanized-dhl/src/ShippingProvider/Services/PreferredDay.php b/packages/woocommerce-germanized-dhl/src/ShippingProvider/Services/PreferredDay.php
new file mode 100644
index 000000000..102e0602c
--- /dev/null
+++ b/packages/woocommerce-germanized-dhl/src/ShippingProvider/Services/PreferredDay.php
@@ -0,0 +1,97 @@
+ 'PreferredDay',
+ 'label' => _x( 'Delivery day', 'dhl', 'woocommerce-germanized' ),
+ 'description' => _x( 'Enable delivery day delivery.', 'dhl', 'woocommerce-germanized' ),
+ 'long_description' => '
+
+
+
+
+
+
+
+
+
+
+
+
+ ' . _x( 'Enabling this option will display options for the user to select their delivery day of delivery during the checkout.', 'dhl', 'woocommerce-germanized' ) . '
',
+ 'setting_id' => 'PreferredDay_enable',
+ 'products' => array( 'V01PAK' ),
+ 'countries' => array( 'DE' ),
+ 'zones' => array( 'dom' ),
+ 'excluded_locations' => array( 'settings' ),
+ );
+
+ parent::__construct( $shipping_provider, $args );
+ }
+
+ protected function get_additional_label_fields( $shipment ) {
+ $label_fields = parent::get_additional_label_fields( $shipment );
+ $preferred_days = $this->get_preferred_day_options( $shipment->get_postcode() );
+ $dhl_order = wc_gzd_dhl_get_order( $shipment->get_order() );
+ $value = '';
+
+ if ( $dhl_order && $dhl_order->has_preferred_day() ) {
+ $value = $dhl_order->get_preferred_day()->format( 'Y-m-d' );
+ }
+
+ $label_fields = array_merge(
+ $label_fields,
+ array(
+ array(
+ 'id' => $this->get_label_field_id( 'day' ),
+ 'label' => _x( 'Delivery day', 'dhl', 'woocommerce-germanized' ),
+ 'description' => '',
+ 'value' => $value,
+ 'options' => wc_gzd_dhl_get_preferred_days_select_options( $preferred_days, '' ),
+ 'custom_attributes' => array( 'data-show-if-service_PreferredDay' => '' ),
+ 'type' => 'select',
+ ),
+ )
+ );
+
+ return $label_fields;
+ }
+
+ protected function get_preferred_day_options( $postcode ) {
+ $preferred_days = array();
+
+ try {
+ $preferred_day_options = Package::get_api()->get_preferred_available_days( $postcode );
+
+ if ( $preferred_day_options ) {
+ $preferred_days = $preferred_day_options;
+ }
+ } catch ( \Exception $e ) { // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedCatch
+ }
+
+ return $preferred_days;
+ }
+
+ public function book_as_default( $shipment ) {
+ $book_as_default = parent::book_as_default( $shipment );
+
+ if ( false === $book_as_default ) {
+ $dhl_order = wc_gzd_dhl_get_order( $shipment->get_order() );
+
+ if ( $dhl_order && $dhl_order->has_preferred_day() ) {
+ $book_as_default = true;
+ }
+ }
+
+ return $book_as_default;
+ }
+
+ public function validate_label_request( $props, $shipment ) {
+ $error = new ShipmentError();
+ $preferred_day = isset( $props[ $this->get_label_field_id( 'day' ) ] ) ? $props[ $this->get_label_field_id( 'day' ) ] : '';
+ $preferred_days = $this->get_preferred_day_options( $shipment->get_postcode() );
+
+ if ( empty( $preferred_day ) || ! array_key_exists( $preferred_day, $preferred_days ) ) {
+ $error->add( 500, _x( 'Please choose a valid preferred delivery day.', 'dhl', 'woocommerce-germanized' ) );
+ }
+
+ return wc_gzd_shipment_wp_error_has_errors( $error ) ? $error : true;
+ }
+}
diff --git a/packages/woocommerce-germanized-dhl/src/ShippingProvider/Services/PreferredLocation.php b/packages/woocommerce-germanized-dhl/src/ShippingProvider/Services/PreferredLocation.php
new file mode 100644
index 000000000..8d654871a
--- /dev/null
+++ b/packages/woocommerce-germanized-dhl/src/ShippingProvider/Services/PreferredLocation.php
@@ -0,0 +1,72 @@
+ 'PreferredLocation',
+ 'label' => _x( 'Drop-off location', 'dhl', 'woocommerce-germanized' ),
+ 'description' => _x( 'Enable drop-off location delivery.', 'dhl', 'woocommerce-germanized' ),
+ 'long_description' => '' . _x( 'Enabling this option will display options for the user to select their preferred delivery location during the checkout.', 'dhl', 'woocommerce-germanized' ) . '
',
+ 'setting_id' => 'PreferredLocation_enable',
+ 'products' => array( 'V01PAK', 'V62WP' ),
+ 'countries' => array( 'DE' ),
+ 'zones' => array( 'dom' ),
+ 'excluded_locations' => array( 'settings' ),
+ );
+
+ parent::__construct( $shipping_provider, $args );
+ }
+
+ protected function get_additional_label_fields( $shipment ) {
+ $label_fields = parent::get_additional_label_fields( $shipment );
+ $dhl_order = wc_gzd_dhl_get_order( $shipment->get_order() );
+ $value = '';
+
+ if ( $dhl_order && $dhl_order->has_preferred_location() ) {
+ $value = $dhl_order->get_preferred_location();
+ }
+
+ $label_fields = array_merge(
+ $label_fields,
+ array(
+ array(
+ 'id' => $this->get_label_field_id( 'location' ),
+ 'label' => _x( 'Drop-off location', 'dhl', 'woocommerce-germanized' ),
+ 'placeholder' => '',
+ 'description' => '',
+ 'value' => $value,
+ 'custom_attributes' => array(
+ 'maxlength' => '80',
+ 'data-show-if-service_PreferredLocation' => '',
+ ),
+ 'type' => 'text',
+ 'is_required' => true,
+ ),
+ )
+ );
+
+ return $label_fields;
+ }
+
+ public function book_as_default( $shipment ) {
+ $book_as_default = parent::book_as_default( $shipment );
+
+ if ( false === $book_as_default ) {
+ $dhl_order = wc_gzd_dhl_get_order( $shipment->get_order() );
+
+ if ( $dhl_order && $dhl_order->has_preferred_location() ) {
+ $book_as_default = true;
+ }
+ }
+
+ return $book_as_default;
+ }
+}
diff --git a/packages/woocommerce-germanized-dhl/src/ShippingProvider/Services/PreferredNeighbour.php b/packages/woocommerce-germanized-dhl/src/ShippingProvider/Services/PreferredNeighbour.php
new file mode 100644
index 000000000..e4a25b00a
--- /dev/null
+++ b/packages/woocommerce-germanized-dhl/src/ShippingProvider/Services/PreferredNeighbour.php
@@ -0,0 +1,72 @@
+ 'PreferredNeighbour',
+ 'label' => _x( 'Neighbor', 'dhl', 'woocommerce-germanized' ),
+ 'description' => _x( 'Enable delivery to a neighbor.', 'dhl', 'woocommerce-germanized' ),
+ 'long_description' => '' . _x( 'Enabling this option will display options for the user to deliver to their preferred neighbor during the checkout.', 'dhl', 'woocommerce-germanized' ) . '
',
+ 'setting_id' => 'PreferredNeighbour_enable',
+ 'products' => array( 'V01PAK', 'V62WP' ),
+ 'countries' => array( 'DE' ),
+ 'zones' => array( 'dom' ),
+ 'excluded_locations' => array( 'settings' ),
+ );
+
+ parent::__construct( $shipping_provider, $args );
+ }
+
+ protected function get_additional_label_fields( $shipment ) {
+ $label_fields = parent::get_additional_label_fields( $shipment );
+ $dhl_order = wc_gzd_dhl_get_order( $shipment->get_order() );
+ $value = '';
+
+ if ( $dhl_order && $dhl_order->has_preferred_neighbor() ) {
+ $value = $dhl_order->get_preferred_neighbor_formatted_address();
+ }
+
+ $label_fields = array_merge(
+ $label_fields,
+ array(
+ array(
+ 'id' => $this->get_label_field_id( 'neighbor' ),
+ 'label' => _x( 'Neighbor', 'dhl', 'woocommerce-germanized' ),
+ 'placeholder' => '',
+ 'description' => '',
+ 'value' => $value,
+ 'custom_attributes' => array(
+ 'maxlength' => '80',
+ 'data-show-if-service_PreferredNeighbour' => '',
+ ),
+ 'type' => 'text',
+ 'is_required' => true,
+ ),
+ )
+ );
+
+ return $label_fields;
+ }
+
+ public function book_as_default( $shipment ) {
+ $book_as_default = parent::book_as_default( $shipment );
+
+ if ( false === $book_as_default ) {
+ $dhl_order = wc_gzd_dhl_get_order( $shipment->get_order() );
+
+ if ( $dhl_order && $dhl_order->has_preferred_neighbor() ) {
+ $book_as_default = true;
+ }
+ }
+
+ return $book_as_default;
+ }
+}
diff --git a/packages/woocommerce-germanized-dhl/src/ShippingProvider/Services/VisualCheckOfAge.php b/packages/woocommerce-germanized-dhl/src/ShippingProvider/Services/VisualCheckOfAge.php
new file mode 100644
index 000000000..9b1fcc91c
--- /dev/null
+++ b/packages/woocommerce-germanized-dhl/src/ShippingProvider/Services/VisualCheckOfAge.php
@@ -0,0 +1,111 @@
+ 'VisualCheckOfAge',
+ 'label' => _x( 'Visual Age check', 'dhl', 'woocommerce-germanized' ),
+ 'description' => _x( 'Let DHL handle the age check for you at the point of delivery.', 'dhl', 'woocommerce-germanized' ),
+ 'products' => array( 'V01PAK' ),
+ 'countries' => array( 'DE' ),
+ 'zones' => array( 'dom' ),
+ );
+
+ parent::__construct( $shipping_provider, $args );
+ }
+
+ /**
+ * @param ConfigurationSet $configuration_set
+ *
+ * @return array[]
+ */
+ protected function get_additional_setting_fields( $configuration_set ) {
+ $base_setting_id = $this->get_setting_id( $configuration_set );
+ $setting_id = $this->get_setting_id( $configuration_set, 'min_age' );
+ $value = $configuration_set->get_service_meta( $this->get_id(), 'min_age', '0' );
+
+ return array(
+ array(
+ 'title' => _x( 'Minimum age', 'dhl', 'woocommerce-germanized' ),
+ 'id' => $setting_id,
+ 'type' => 'select',
+ 'default' => '0',
+ 'value' => $value,
+ 'options' => wc_gzd_dhl_get_ident_min_ages(),
+ 'custom_attributes' => array( "data-show_if_{$base_setting_id}" => '' ),
+ 'desc_tip' => _x( 'Choose this option if you want to let DHL check your customer\'s identity and age.', 'dhl', 'woocommerce-germanized' ),
+ ),
+ );
+ }
+
+ public function get_default_value( $suffix = '' ) {
+ $default_value = parent::get_default_value( $suffix );
+
+ if ( 'min_age' === $suffix ) {
+ $default_value = '';
+ }
+
+ return $default_value;
+ }
+
+ protected function get_additional_label_fields( $shipment ) {
+ $label_fields = parent::get_additional_label_fields( $shipment );
+ $dhl_order = wc_gzd_dhl_get_order( $shipment->get_order() );
+ $min_age = $this->get_value( $shipment, 'min_age' );
+
+ if ( $dhl_order && $dhl_order->needs_age_verification() && 'yes' === $this->get_shipping_provider()->get_setting( 'label_auto_age_check_sync' ) ) {
+ $min_age = $dhl_order->get_min_age();
+ }
+
+ $label_fields = array_merge(
+ $label_fields,
+ array(
+ array(
+ 'id' => $this->get_label_field_id( 'min_age' ),
+ 'label' => _x( 'Minimum Age', 'dhl', 'woocommerce-germanized' ),
+ 'description' => '',
+ 'type' => 'select',
+ 'value' => $min_age,
+ 'options' => wc_gzd_dhl_get_visual_min_ages(),
+ 'custom_attributes' => array( 'data-show-if-service_VisualCheckOfAge' => '' ),
+ ),
+ )
+ );
+
+ return $label_fields;
+ }
+
+ public function book_as_default( $shipment ) {
+ $book_as_default = parent::book_as_default( $shipment );
+
+ if ( false === $book_as_default ) {
+ $dhl_order = wc_gzd_dhl_get_order( $shipment->get_order() );
+
+ if ( $dhl_order && $dhl_order->needs_age_verification() && 'yes' === $this->get_shipping_provider()->get_setting( 'label_auto_age_check_sync' ) ) {
+ $book_as_default = true;
+ }
+ }
+
+ return $book_as_default;
+ }
+
+ public function validate_label_request( $props, $shipment ) {
+ $error = new ShipmentError();
+ $min_age = isset( $props[ $this->get_label_field_id( 'min_age' ) ] ) ? $props[ $this->get_label_field_id( 'min_age' ) ] : '';
+
+ if ( empty( $min_age ) || ! wc_gzd_dhl_is_valid_visual_min_age( $min_age ) ) {
+ $error->add( 500, _x( 'The minimum age (VisualCheckOfAge) supplied is invalid.', 'dhl', 'woocommerce-germanized' ) );
+ }
+
+ return wc_gzd_shipment_wp_error_has_errors( $error ) ? $error : true;
+ }
+}
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..58a543b25
--- /dev/null
+++ b/packages/woocommerce-germanized-dhl/templates/checkout/dhl/parcel-finder-result.php
@@ -0,0 +1,57 @@
+
+
+
+
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..046faca88
--- /dev/null
+++ b/packages/woocommerce-germanized-dhl/templates/checkout/dhl/parcel-finder.php
@@ -0,0 +1,68 @@
+
+gzd_name ); ?>
+
+
+ countries->get_formatted_address(
+ array(
+ 'address_1' => $result->place->address->streetAddress,
+ 'postcode' => $result->place->address->postalCode,
+ 'city' => $result->place->address->addressLocality,
+ 'country' => $result->place->address->countryCode,
+ )
+ )
+ );
+ ?>
+
+
+ gzd_type ) : ?>
+
+
+
+
+ gzd_opening_hours as $time ) : ?>
+ :
+ +
+
+ + +
+
+
+ : serviceTypes, true ) ? esc_html_x( 'Yes', 'dhl', 'woocommerce-germanized' ) : esc_html_x( 'No', 'dhl', 'woocommerce-germanized' ) ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase ?>
+ : serviceTypes, true ) ) ? esc_html_x( 'Yes', 'dhl', 'woocommerce-germanized' ) : esc_html_x( 'No', 'dhl', 'woocommerce-germanized' ) ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase ?>
+
+
+
+
+ + : serviceTypes, true ) ) ? esc_html_x( 'Yes', 'dhl', 'woocommerce-germanized' ) : esc_html_x( 'No', 'dhl', 'woocommerce-germanized' ) ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase ?>
+
+
+
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..8f845be3b
--- /dev/null
+++ b/packages/woocommerce-germanized-dhl/templates/checkout/dhl/preferred-services.php
@@ -0,0 +1,132 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ; ?>)
+
+
+
+
+
+
+ Please choose your preferred delivery option.', 'dhl', 'woocommerce-germanized' ) ); ?>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+ $value ) :
+ $key = empty( $key ) ? '' : $key;
+ $week_day_num = empty( $key ) ? '-' : esc_html( date( 'j', strtotime( $key ) ) ); // phpcs:ignore WordPress.DateTime.RestrictedFunctions.date_date
+ $is_selected = $preferred_day === $key ? 'checked="checked"' : '';
+ ?>
+
- + /> + + + +
+
+
+
+
+
+
+
+
+ -
+
- + /> + + + +
- + /> + + + + +
- + /> + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+ $delivery_type_title ) : ?>
+
- + /> + + + + + + + +
+
+ .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;
+ }
+
+ &.delete {
+ color: #a00;
+ }
+ }
+ }
+ }
+
+ .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: 60px;
+ 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;
+
+ a.wc-gzd-shipment-action-button {
+ margin: 2px 0 2px 7px;
+ }
+
+ .woocommerce-help-tip {
+ margin-left: 0;
+ }
+ }
+
+ a.add_item {
+ 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 {
+ a.add_item {
+ display: inline-flex;
+ }
+ }
+ }
+
+ .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/index.js b/packages/woocommerce-germanized-shipments/assets/js/index.js
new file mode 100644
index 000000000..e69de29bb
diff --git a/packages/woocommerce-germanized-shipments/assets/js/static/admin-packaging.js b/packages/woocommerce-germanized-shipments/assets/js/static/admin-packaging.js
new file mode 100644
index 000000000..bec35dce0
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/assets/js/static/admin-packaging.js
@@ -0,0 +1,32 @@
+window.germanized = window.germanized || {};
+window.germanized.admin = window.germanized.admin || {};
+
+( function( $, admin ) {
+ admin.packaging = {
+ params: {},
+
+ init: function() {
+ var self = germanized.admin.packaging;
+
+ $( document )
+ .on( 'change', 'input.gzd-override-toggle', self.onChangeOverride );
+ },
+
+ onChangeOverride: function() {
+ var $checkbox = $( this ),
+ $wrapper = $checkbox.parents( '.wc-gzd-shipping-provider-override-title-wrapper' ),
+ $next = $wrapper.next( '.wc-gzd-packaging-zone-wrapper' );
+
+ $next.removeClass( 'zone-wrapper-has-override' );
+
+ if ( $checkbox.is( ':checked' ) ) {
+ $next.addClass( 'zone-wrapper-has-override' );
+ }
+ },
+ };
+
+ $( document ).ready( function() {
+ germanized.admin.packaging.init();
+ });
+
+})( jQuery, window.germanized.admin );
\ No newline at end of file
diff --git a/packages/woocommerce-germanized-shipments/assets/js/static/admin-settings.js b/packages/woocommerce-germanized-shipments/assets/js/static/admin-settings.js
new file mode 100644
index 000000000..eec374c14
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/assets/js/static/admin-settings.js
@@ -0,0 +1,172 @@
+window.germanized = window.germanized || {};
+window.germanized.admin = window.germanized.admin || {};
+
+( function( $, admin ) {
+ admin.shipment_settings = {
+ params: {},
+
+ init: function() {
+ var self = germanized.admin.shipment_settings;
+ self.params = wc_gzd_admin_shipment_settings_params;
+
+ $( document )
+ .on( 'click', 'a.woocommerce-gzd-shipment-input-toggle-trigger', self.onInputToggleClick )
+ .on( 'change gzd_shipments_show_or_hide_fields', 'table.form-table :input[id]', self.onChangeInput );
+
+ $( 'table.form-table :input[id]' ).trigger( 'gzd_shipments_show_or_hide_fields' );
+ },
+
+ getCleanInputId: function( $mainInput ) {
+ var self = germanized.admin.shipment_settings,
+ fieldId = $mainInput.attr( 'id' ) ? $mainInput.attr( 'id' ) : $mainInput.attr( 'name' );
+
+ if ( self.params.hasOwnProperty( 'clean_input_callback' ) ) {
+ var callback = self.params.clean_input_callback,
+ params = [],
+ objectName = '',
+ methodName = '';
+
+ if ( callback.substring( 0, 17 ) === 'germanized.admin.' ) {
+ callback = callback.slice( 17 );
+
+ params = callback.split( "." );
+ objectName = germanized.admin[params[0]];
+ methodName = params[1];
+ } else {
+ params = callback.split( "." );
+ objectName = window[params[0]];
+ methodName = params[1];
+ }
+
+ if ( 'object' === typeof objectName && objectName.hasOwnProperty( methodName ) ) {
+ fieldId = objectName[methodName]( $mainInput );
+ }
+ }
+
+ if ( ! fieldId ) {
+ return '';
+ }
+
+ return fieldId;
+ },
+
+ getInputByIdOrName: function( $wrapper , cleanName ) {
+ var self = germanized.admin.shipment_settings;
+ cleanName = self.getCleanDataId( cleanName );
+
+ return $wrapper.find( ':input' ).filter( function() {
+ var id = self.getCleanInputId( $( this ) );
+
+ if ( ! id ) {
+ return false;
+ }
+
+ return self.getCleanDataId( id ) === cleanName;
+ });
+ },
+
+ /**
+ * Make sure to remove any hyphens as data-attributes are stored
+ * camel case without hyphens in the DOM.
+ */
+ getCleanDataId: function( id ) {
+ return id.toLowerCase().replace( /-/g, '' );
+ },
+
+ onChangeInput: function() {
+ var self = germanized.admin.shipment_settings,
+ $mainInput = $( this ),
+ $wrapper = $( this ).parents( 'form' ),
+ mainId = self.getCleanInputId( $mainInput ),
+ $dependentFields = $wrapper.find( ':input[data-show_if_' + $.escapeSelector( mainId ) + ']' );
+
+ var $input, $field, data, meetsConditions, cleanName, $dependentField, valueExpected, val, isChecked;
+
+ $.each( $dependentFields, function () {
+ $input = $( this );
+ $field = $input.parents( 'tr' );
+ data = $input.data();
+ meetsConditions = true;
+
+ for ( var dataName in data ) {
+ if ( data.hasOwnProperty( dataName ) ) {
+ /**
+ * Check all the conditions for a dependent field.
+ */
+ if ( dataName.substring( 0, 8 ) === 'show_if_' ) {
+ cleanName = dataName.replace( 'show_if_', '' );
+ $dependentField = self.getInputByIdOrName( $wrapper, cleanName );
+ valueExpected = $input.data( dataName ) ? $input.data( dataName ).split(',') : [];
+
+ if ( $dependentField.length > 0 ) {
+ val = $dependentField.val();
+ isChecked = false;
+
+ if ( $dependentField.is( ':radio' ) ) {
+ val = $dependentField.parents( 'fieldset' ).find( ':checked' ).length > 0 ? $dependentField.parents( 'fieldset' ).find( ':checked' ).val() : 'no';
+
+ if ( 'no' !== val ) {
+ isChecked = true;
+ }
+ } else if ( $dependentField.is( ':checkbox' ) ) {
+ val = $dependentField.is( ':checked' ) ? 'yes' : 'no';
+
+ if ( 'yes' === val ) {
+ isChecked = true;
+ }
+ } else {
+ isChecked = undefined !== val && '0' !== val && '' !== val;
+ }
+
+ if ( valueExpected && valueExpected.length > 0 ) {
+ if ( $.inArray( val, valueExpected ) === -1 ) {
+ meetsConditions = false;
+ }
+ } else if ( ! isChecked ) {
+ meetsConditions = false;
+ }
+ }
+
+ if ( ! meetsConditions ) {
+ break;
+ }
+ }
+ }
+ }
+
+ if ( meetsConditions ) {
+ $field.show();
+ } else {
+ $field.hide();
+ }
+ } );
+ },
+
+ onInputToggleClick: function() {
+ var $toggle = $( this ).find( 'span.woocommerce-gzd-input-toggle' ),
+ $row = $toggle.parents( 'fieldset' ),
+ $checkbox = $row.find( 'input[type=checkbox]' ),
+ $enabled = $toggle.hasClass( 'woocommerce-input-toggle--enabled' );
+
+ $toggle.removeClass( 'woocommerce-input-toggle--enabled' );
+ $toggle.removeClass( 'woocommerce-input-toggle--disabled' );
+
+ if ( $enabled ) {
+ $checkbox.prop( 'checked', false );
+ $toggle.addClass( 'woocommerce-input-toggle--disabled' );
+ } else {
+ $checkbox.prop( 'checked', true );
+ $toggle.addClass( 'woocommerce-input-toggle--enabled' );
+ }
+
+ $checkbox.trigger( 'change' );
+
+ return false;
+ }
+ };
+
+ $( document ).ready( function() {
+ germanized.admin.shipment_settings.init();
+ });
+
+})( jQuery, window.germanized.admin );
\ No newline at end of file
diff --git a/packages/woocommerce-germanized-shipments/assets/js/static/admin-shipment-modal.js b/packages/woocommerce-germanized-shipments/assets/js/static/admin-shipment-modal.js
new file mode 100644
index 000000000..154f92b22
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/assets/js/static/admin-shipment-modal.js
@@ -0,0 +1,489 @@
+window.germanized = window.germanized || {};
+window.germanized.admin = window.germanized.admin || {};
+
+( function( $, window, document, germanized ) {
+
+ var AdminShipmentModal = function( $modalTrigger ) {
+ var self = this;
+
+ self.params = wc_gzd_admin_shipment_modal_params;
+ self.$modalTrigger = $modalTrigger;
+
+ self.destroy();
+ self.setup();
+
+ self.$modalTrigger.on( 'click.gzd-modal-' + self.modalId, { adminShipmentModal: self }, self.onClick )
+
+ $( document.body )
+ .on( 'wc_backbone_modal_loaded.gzd-modal-' + self.modalId, { adminShipmentModal: self }, self.onOpen )
+ .on( 'wc_backbone_modal_response.gzd-modal-' + self.modalId, { adminShipmentModal: self }, self.response )
+ .on( 'wc_backbone_modal_before_remove.gzd-modal-' + self.modalId, { adminShipmentModal: self }, self.onClose );
+ };
+
+ AdminShipmentModal.prototype.setup = function() {
+ var self = this;
+
+ self.referenceId = self.$modalTrigger.data( 'reference' ) ? self.$modalTrigger.data( 'reference' ) : 0;
+ self.modalClass = self.$modalTrigger.data( 'id' );
+ self.modalId = self.modalClass + '-' + self.referenceId;
+ self.loadAsync = self.$modalTrigger.data( 'load-async' ) ? self.$modalTrigger.data( 'load-async' ) : false;
+ self.nonceParams = self.$modalTrigger.data( 'nonce-params' ) ? self.$modalTrigger.data( 'nonce-params' ) : 'wc_gzd_admin_shipments_params';
+ self.$modal = false;
+
+ self.$modalTrigger.data( 'self', this );
+ };
+
+ AdminShipmentModal.prototype.destroy = function() {
+ var self = this;
+
+ self.$modalTrigger.off( '.gzd-modal-' + self.modalId );
+
+ $( document ).off( '.gzd-modal-' + self.modalId );
+ $( document.body ).off( '.gzd-modal-' + self.modalId );
+ };
+
+ AdminShipmentModal.prototype.getShipment = function( id ) {
+ return $( '#panel-order-shipments' ).find( '#shipment-' + id );
+ };
+
+ AdminShipmentModal.prototype.onRemoveNotice = function( event ) {
+ var self = event.data.adminShipmentModal;
+
+ $( this ).parents( '.notice' ).slideUp( 150, function() {
+ $( this ).remove();
+ });
+
+ return false;
+ };
+
+ AdminShipmentModal.prototype.onClick = function( event ) {
+ var self = event.data.adminShipmentModal;
+
+ self.$modalTrigger.WCBackboneModal({
+ template: self.modalId
+ });
+
+ return false;
+ };
+
+ AdminShipmentModal.prototype.parseFieldId = function( fieldId ) {
+ return fieldId.replace( '[', '_' ).replace( ']', '' );
+ };
+
+ AdminShipmentModal.prototype.onExpandMore = function( event ) {
+ var self = event.data.adminShipmentModal,
+ $wrapper = self.$modal.find( '.show-more-wrapper' ),
+ $triggerWrapper = $( this ).parents( '.show-more-trigger' );
+
+ $wrapper.show();
+ $wrapper.find( ':input:visible' ).trigger( 'change', [self] );
+
+ $triggerWrapper.find( '.show-more' ).hide();
+ $triggerWrapper.find( '.show-fewer' ).show();
+
+ return false;
+ };
+
+ AdminShipmentModal.prototype.onHideMore = function( event ) {
+ var self = event.data.adminShipmentModal,
+ $wrapper = self.$modal.find( '.show-more-wrapper' ),
+ $triggerWrapper = $( this ).parents( '.show-more-trigger' );
+
+ $wrapper.hide();
+
+ $triggerWrapper.find( '.show-further-services' ).show();
+ $triggerWrapper.find( '.show-fewer-services' ).hide();
+
+ return false;
+ };
+
+ AdminShipmentModal.prototype.onChangeField = function( event ) {
+ var self = event.data.adminShipmentModal,
+ $wrapper = self.$modal,
+ fieldId = self.parseFieldId( $( this ).attr( 'id' ) ),
+ val = $( this ).val();
+
+ /**
+ * Limit max quantity
+ */
+ if ( $( this ).attr( 'max' ) ) {
+ var maxQuantity = $( this ).attr( 'max' );
+
+ if ( val > maxQuantity ) {
+ $( this ).val( maxQuantity );
+ }
+ }
+
+ /**
+ * Limit min quantity
+ */
+ if ( $( this ).attr( 'min' ) ) {
+ var minQuantity = $( this ).attr( 'min' );
+
+ if ( val < minQuantity ) {
+ $( this ).val( minQuantity );
+ }
+ }
+
+ /**
+ * Show or hide a wrapper based on checkbox status
+ */
+ if ( $( this ).hasClass( 'show-if-trigger' ) ) {
+ var $show = $wrapper.find( $( this ).data( 'show-if' ) );
+
+ if ( $show.length > 0 ) {
+ if ( $( this ).is( ':checked' ) ) {
+ $show.show();
+ } else {
+ $show.hide();
+ }
+
+ $( document.body ).trigger( 'wc_gzd_admin_shipment_modal_show_if', [self] );
+ self.$modalTrigger.trigger( 'wc_gzd_admin_shipment_modal_show_if', [self] );
+ }
+ } else {
+ $wrapper.find( ':input[data-show-if-' + fieldId + ']' ).parents( '.form-field' ).hide();
+
+ if ( $( this ).is( ':visible' ) ) {
+ if ( $( this ).is( ':checkbox' ) ) {
+ if ( $( this ).is( ':checked' ) ) {
+ $wrapper.find( ':input[data-show-if-' + fieldId + ']' ).parents( '.form-field' ).show();
+ }
+ } else {
+ if ( '0' !== val && '' !== val ) {
+ $wrapper.find( ':input[data-show-if-' + fieldId + '=""]' ).parents( '.form-field' ).show();
+ }
+
+ $wrapper.find( ':input[data-show-if-' + fieldId + '*="' + val + '"]' ).parents( '.form-field' ).show();
+ }
+ }
+
+ /**
+ * Hide the show more trigger in case no visible field is found within the wrapper.
+ * Explicitly check for the display style as the wrapper may be in collapsed state.
+ */
+ $wrapper.find( '.show-more-wrapper' ).each( function() {
+ var $showMoreWrapper = $( this ),
+ hasVisible = $showMoreWrapper.find( 'p.form-field' ).css( 'display' ) !== 'none',
+ $trigger = $showMoreWrapper.data( 'trigger' ) ? $wrapper.find( $showMoreWrapper.data( 'trigger' ) ) : false;
+
+ if ( $trigger.length > 0 ) {
+ if ( ! hasVisible ) {
+ $trigger.hide();
+ } else {
+ $trigger.show();
+ }
+ }
+ } );
+ }
+ };
+
+ AdminShipmentModal.prototype.onClose = function( event, target ) {
+ var self = event.data.adminShipmentModal;
+
+ if ( target.indexOf( self.modalId ) !== -1 ) {
+ if ( self.$modal && self.$modal.length > 0 ) {
+ self.$modal.off( 'click.gzd-modal-' + self.modalId );
+ }
+ }
+ };
+
+ AdminShipmentModal.prototype.onOpen = function( event, target ) {
+ var self = event.data.adminShipmentModal;
+
+ if ( target.indexOf( self.modalId ) !== -1 ) {
+ self.setup();
+
+ self.$modal = $( '.' + self.modalClass );
+ self.$modal.data( 'self', self );
+
+ if ( self.loadAsync ) {
+ params = {
+ 'action' : self.getAction( 'load' ),
+ 'reference_id': self.referenceId,
+ 'security' : self.getNonce( 'load' )
+ };
+
+ self.doAjax( params, self.onLoadSuccess );
+ } else {
+ self.initData();
+ }
+
+ $( document.body ).trigger( 'wc_gzd_admin_shipment_modal_open', [self] );
+ self.$modalTrigger.trigger( 'wc_gzd_admin_shipment_modal_open', [self] );
+ }
+ };
+
+ AdminShipmentModal.prototype.onLoadSuccess = function( data, self ) {
+ self.initData();
+
+ $( document.body ).trigger( 'wc_gzd_admin_shipment_modal_after_load_success', [data, self] );
+ self.$modalTrigger.trigger( 'wc_gzd_admin_shipment_modal_after_load_success', [data, self] );
+ };
+
+ AdminShipmentModal.prototype.onAjaxSuccess = function( data, self ) {
+
+ };
+
+ AdminShipmentModal.prototype.onAjaxError = function( data, self ) {
+
+ };
+
+ AdminShipmentModal.prototype.getModalMainContent = function() {
+ return this.$modal.find( 'article' );
+ };
+
+ AdminShipmentModal.prototype.doAjax = function( params, cSuccess, cError ) {
+ var self = this,
+ $content = self.getModalMainContent();
+
+ cSuccess = cSuccess || self.onAjaxSuccess;
+ cError = cError || self.onAjaxError;
+
+ if ( ! params.hasOwnProperty( 'reference_id' ) ) {
+ params['reference_id'] = self.referenceId;
+ }
+
+ self.$modal.find( '.wc-backbone-modal-content' ).block({
+ message: null,
+ overlayCSS: {
+ background: '#fff',
+ opacity: 0.6
+ }
+ });
+
+ self.$modal.find( '.notice-wrapper' ).empty();
+
+ $.ajax({
+ type: "POST",
+ url: self.params.ajax_url,
+ data: params,
+ success: function( data ) {
+ if ( data.success ) {
+ if ( data.fragments ) {
+ $.each( data.fragments, function ( key, value ) {
+ $( key ).replaceWith( value );
+ });
+ }
+
+ self.$modal.find( '.wc-backbone-modal-content' ).unblock();
+ cSuccess.apply( self, [ data, self ] );
+
+ /**
+ * Refresh shipments data, if available
+ */
+ if ( germanized.admin.shipments ) {
+ germanized.admin.shipments.refresh( data );
+ }
+
+ $( document.body ).trigger( 'wc_gzd_admin_shipment_modal_ajax_success', [data, self] );
+ self.$modalTrigger.trigger( 'wc_gzd_admin_shipment_modal_ajax_success', [data, self] );
+
+ /**
+ * Init JS form field types.
+ */
+ if ( data.fragments ) {
+ self.afterRefresh();
+ }
+ } else {
+ self.$modal.find( '.wc-backbone-modal-content' ).unblock();
+ cError.apply( self, [ data, self ] );
+
+ self.printNotices( $content, data );
+
+ // ScrollTo top of modal
+ $content.animate({
+ scrollTop: 0
+ }, 500 );
+
+ $( document.body ).trigger( 'wc_gzd_admin_shipment_modal_ajax_error', [data, self] );
+ self.$modalTrigger.trigger( 'wc_gzd_admin_shipment_modal_ajax_error', [data, self] );
+ }
+ },
+ error: function( data ) {},
+ dataType: 'json'
+ });
+ };
+
+ AdminShipmentModal.prototype.afterRefresh = function() {
+ var self = this;
+
+ if ( self.$modal.find( '.notice-wrapper' ).length === 0 ) {
+ self.getModalMainContent().prepend( '' );
+ }
+
+ $( document.body ).trigger( 'wc-enhanced-select-init' );
+ $( document.body ).trigger( 'wc-init-datepickers' );
+ $( document.body ).trigger( 'init_tooltips' );
+ };
+
+ AdminShipmentModal.prototype.initData = function() {
+ var self = this;
+
+ self.$modal = $( '.' + self.modalClass );
+ self.$modal.data( 'self', self );
+
+ self.afterRefresh();
+
+ self.$modal.on( 'click.gzd-modal-' + self.modalId, '#btn-ok', { adminShipmentModal: self }, self.onSubmit );
+ self.$modal.on( 'touchstart.gzd-modal-' + self.modalId, '#btn-ok', { adminShipmentModal: self }, self.onSubmit );
+ self.$modal.on( 'keydown.gzd-modal-' + self.modalId, { adminShipmentModal: self }, self.onKeyDown );
+
+ self.$modal.on( 'click.gzd-modal-' + self.modalId, '.notice .notice-dismiss', { adminShipmentModal: self }, self.onRemoveNotice );
+ self.$modal.on( 'change.gzd-modal-' + self.modalId, ':input[id]', { adminShipmentModal: self }, self.onChangeField );
+ self.$modal.on( 'click.gzd-modal-' + self.modalId, '.show-more', { adminShipmentModal: self }, self.onExpandMore );
+ self.$modal.on( 'click.gzd-modal-' + self.modalId, '.show-fewer', { adminShipmentModal: self }, self.onHideMore );
+
+ $( document.body ).trigger( 'wc_gzd_admin_shipment_modal_after_init_data', [self] );
+ self.$modalTrigger.trigger( 'wc_gzd_admin_shipment_modal_after_init_data', [self] );
+
+ self.$modal.find( ':input:visible' ).trigger( "change", [self] );
+ };
+
+ AdminShipmentModal.prototype.printNotices = function( $wrapper, data ) {
+ var self = this;
+
+ if ( data.hasOwnProperty( 'message' ) ) {
+ self.addNotice( data.message, 'error', $wrapper );
+ } else if ( data.hasOwnProperty( 'messages' ) ) {
+ $.each( data.messages, function ( type, typeMessages ) {
+ if ( typeof typeMessages === 'string' || typeMessages instanceof String ) {
+ self.addNotice( typeMessages, 'error', $wrapper );
+ } else {
+ $.each( typeMessages, function ( i, message ) {
+ self.addNotice( message, ( 'soft' === type ? 'warning' : type ), $wrapper );
+ });
+ }
+ });
+ }
+ };
+
+ AdminShipmentModal.prototype.onSubmitSuccess = function( data, self ) {
+ var $content = self.getModalMainContent();
+
+ if ( data.hasOwnProperty( 'messages' ) && ( data.messages.hasOwnProperty( 'error' ) || data.messages.hasOwnProperty( 'soft' ) ) ) {
+ self.printNotices( $content, data );
+
+ self.$modal.find( 'footer' ).find( '#btn-ok' ).addClass( 'modal-close' ).attr( 'id', 'btn-close' ).text( self.params.i18n_modal_close );
+ } else {
+ self.$modal.find( '.modal-close' ).trigger( 'click' );
+ }
+
+ if ( data.hasOwnProperty( 'shipment_id' ) && $( 'div#shipment-' + data['shipment_id'] ).length > 0 ) {
+ germanized.admin.shipments.initShipment( data['shipment_id'] );
+ }
+
+ $( document.body ).trigger( 'wc_gzd_admin_shipment_modal_after_submit_success', [data, self] );
+ self.$modalTrigger.trigger( 'wc_gzd_admin_shipment_modal_after_submit_success', [data, self] );
+ };
+
+ AdminShipmentModal.prototype.getCleanId = function( removePrefix = false ) {
+ var clean = this.modalClass.split( '-' ).join( '_' ).replace( '_modal_', '_' );
+
+ if ( removePrefix ) {
+ clean = clean.replace( 'wc_gzd_', '' ).replace( 'wc_gzdp_', '' );
+ }
+
+ return clean;
+ };
+
+ AdminShipmentModal.prototype.getNonceParams = function() {
+ return window.hasOwnProperty( this.nonceParams ) ? window[ this.nonceParams ] : {};
+ };
+
+ AdminShipmentModal.prototype.getNonce = function( type ) {
+ var nonceKey = this.getCleanId( true ) + '_' + type + '_nonce',
+ nonceParams = this.getNonceParams();
+
+ return nonceParams.hasOwnProperty( nonceKey ) ? nonceParams[ nonceKey ] : this.params[ type + '_nonce' ];
+ };
+
+ AdminShipmentModal.prototype.getAction = function( type ) {
+ return this.getCleanId().replace( 'wc_', 'woocommerce_' ) + '_' + type;
+ };
+
+ AdminShipmentModal.prototype.onKeyDown = function( event ) {
+ var self = event.data.adminShipmentModal,
+ button = event.keyCode || event.which;
+
+ // Enter key
+ if ( 13 === button && ! ( event.target.tagName && ( event.target.tagName.toLowerCase() === 'input' || event.target.tagName.toLowerCase() === 'textarea' ) ) ) {
+ self.onSubmit.apply( self.$modal.find( 'button#btn-ok' ), [ e ] );
+ }
+ };
+
+ AdminShipmentModal.prototype.getFormData = function( $form ) {
+ var data = {}
+
+ $form.find( '.show-more-wrapper' ).each( function() {
+ if ( ! $( this ).is( ':visible' ) ) {
+ $( this ).addClass( 'show-more-wrapper-force-show' ).show();
+ }
+ } );
+
+ /**
+ * Do only transmit data of visible fields
+ */
+ $.each( $form.find( ':input' ).serializeArray(), function( index, item ) {
+ var $item = $form.find( ':input[name="' + item.name + '"]' );
+
+ /**
+ * Skip invisible items except hidden inputs
+ */
+ if ( $item && ! $item.is( ':visible' ) && $item.attr( 'type' ) !== 'hidden' ) {
+ return true;
+ }
+
+ 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;
+ }
+ });
+
+ $form.find( '.show-more-wrapper-force-show' ).each( function() {
+ $( this ).removeClass( 'show-more-wrapper-force-show' ).hide();
+ } );
+
+ return data;
+ };
+
+ AdminShipmentModal.prototype.onSubmit = function( event ) {
+ var self = event.data.adminShipmentModal,
+ $content = self.getModalMainContent(),
+ $form = $content.find( 'form' ),
+ params = self.getFormData( $form );
+
+ params['security'] = self.getNonce( 'submit' );
+ params['reference_id'] = self.referenceId;
+ params['action'] = self.getAction( 'submit' );
+
+ self.doAjax( params, self.onSubmitSuccess );
+
+ event.preventDefault();
+ event.stopPropagation();
+ };
+
+ AdminShipmentModal.prototype.addNotice = function( message, noticeType, $wrapper ) {
+ $wrapper.find( '.notice-wrapper' ).append( '
+ composer install',
+ '' . esc_html( str_replace( ABSPATH, '', __DIR__ ) ) . ''
+ );
+ ?>
+
' + message + '
' + message + '
'+e+'
'+e+'
+
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..4028a912b
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/admin/views/html-order-shipment-item-count.php
@@ -0,0 +1,19 @@
+
+
+
+ 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..9a8d5aa79
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/admin/views/html-order-shipment-item.php
@@ -0,0 +1,69 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + + +
+
+
+ + + + + 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;
+ ?>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $column ) : ?>
+
+
+
+
+
+
+ get_items() as $item ) : ?>
+
+
+
+
+ array(
+ 'action' => 'add_item',
+ 'name' => _x( 'Add item', 'shipments', 'woocommerce-germanized' ),
+ 'classes' => 'add-shipment-item has-shipment-modal create',
+ 'custom_attributes' => array(
+ 'id' => 'wc-gzd-modal-add-shipment-item-' . $shipment->get_id(),
+ 'data-load-async' => true,
+ 'data-reference' => $shipment->get_id(),
+ 'data-id' => 'wc-gzd-modal-add-shipment-item',
+ ),
+ ),
+ 'sync_items' => array(
+ 'action' => 'sync_items',
+ 'name' => _x( 'Sync items', 'shipments', 'woocommerce-germanized' ),
+ 'title' => _x( 'Automatically adjust items and quantities based on order item data.', 'shipments', 'woocommerce-germanized' ),
+ 'classes' => 'sync-shipment-items refresh',
+ ),
+ );
+ ?>
+
+
+
+
+
+
+
+
+
+
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..44a6178c0
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/admin/views/html-order-shipment-list.php
@@ -0,0 +1,36 @@
+get_return_shipments();
+?>
+
+
+ $column ) : ?>
+
+
+
+
+ get_name() ); ?> get_sku() ? '(' . esc_html( $item->get_sku() ) . ')' : '' ); ?>
+
+
+
+
+
+ array(
+ 'classes' => 'remove-shipment-item',
+ 'action' => 'delete',
+ 'name' => _x( 'Delete item', 'shipments', 'woocommerce-germanized' ),
+ 'custom_attributes' => array(
+ 'data-delete' => $item->get_id(),
+ ),
+ ),
+ )
+ );
+ ?>
+
+
+ get_id(), $item, $shipment, $column_name );
+ ?>
+
+
+
+ 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..25fd7d779
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/admin/views/html-order-shipment-packaging-select.php
@@ -0,0 +1,41 @@
+get_available_packaging();
+$available_packaging_ids = array();
+
+foreach ( $available_packaging as $packaging ) {
+ $available_packaging_ids[] = (int) $packaging->get_id();
+}
+
+$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..c5191c14f
--- /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..4d5b03994
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/admin/views/html-order-shipments.php
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+
+ get_type() ) ), esc_html( $shipment->get_shipment_number() ) ); ?>
+ 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..f5d307883
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/admin/views/html-settings-provider-list.php
@@ -0,0 +1,76 @@
+
+
+
+
+
+
+
+ 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..42a9b6f0c
--- /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..67246edf6
--- /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..154f5b414
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/admin/views/label/html-shipment-label.php
@@ -0,0 +1,89 @@
+get_file() ) {
+ $actions['download'] = array(
+ 'url' => $label->get_download_url(),
+ 'name' => _x( 'Download label', 'shipments', 'woocommerce-germanized' ),
+ 'action' => 'download_label',
+ 'classes' => 'download',
+ 'target' => '_blank',
+ );
+ }
+
+ $actions['delete'] = array(
+ 'url' => $label->get_download_url(),
+ 'classes' => 'remove-shipment-label delete',
+ 'name' => _x( 'Delete label', 'shipments', 'woocommerce-germanized' ),
+ 'action' => 'delete_label',
+ 'target' => '_blank',
+ 'custom_attributes' => array(
+ 'data-shipment' => $shipment->get_id(),
+ ),
+ );
+} else {
+ $actions['generate_label'] = array(
+ 'url' => '#',
+ 'name' => _x( 'Create label', 'shipments', 'woocommerce-germanized' ),
+ 'action' => 'create_label',
+ 'classes' => 'create-shipment-label has-shipment-modal create',
+ 'custom_attributes' => array(
+ 'id' => 'wc-gzd-create-label-' . $shipment->get_id(),
+ 'data-id' => 'wc-gzd-modal-create-shipment-label',
+ 'data-load-async' => true,
+ 'data-reference' => $shipment->get_id(),
+ ),
+ );
+}
+
+?>
+
+
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..55e2ea4a4
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/emails/class-wc-gzd-email-customer-guest-return-shipment-request.php
@@ -0,0 +1,214 @@
+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..9b319386d
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/emails/class-wc-gzd-email-customer-return-shipment-delivered.php
@@ -0,0 +1,234 @@
+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..ea763a1a6
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/emails/class-wc-gzd-email-customer-return-shipment.php
@@ -0,0 +1,263 @@
+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..2fffd6cd0
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/emails/class-wc-gzd-email-customer-shipment.php
@@ -0,0 +1,415 @@
+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}' => '',
+ '{current_shipment_num}' => '',
+ '{total_shipments}' => '',
+ );
+
+ // 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 ({current_shipment_num}/{total_shipments})', 'shipments', 'woocommerce-germanized' );
+ } else {
+ return _x( 'Your {site_title} order #{order_number} has been shipped ({current_shipment_num}/{total_shipments})', '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, $this );
+ }
+
+ /**
+ * 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, $this );
+ }
+
+ /**
+ * 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();
+ }
+
+ public function get_shipped_position_number( $shipment_id ) {
+ $shipped_count = 1;
+
+ if ( ! $this->object || ( ! $order = wc_gzd_get_shipment_order( $this->object ) ) ) {
+ return $shipped_count;
+ }
+
+ if ( is_a( $shipment_id, '\Vendidero\Germanized\Shipments\Shipment' ) ) {
+ $shipment_id = $shipment_id->get_id();
+ }
+
+ if ( ! is_numeric( $shipment_id ) ) {
+ return $shipped_count;
+ }
+
+ foreach ( $order->get_simple_shipments() as $key => $shipment ) {
+ if ( $shipment->is_shipped() ) {
+ if ( (int) $shipment->get_id() !== (int) $shipment_id ) {
+ $shipped_count++;
+ }
+ }
+ }
+
+ return $shipped_count;
+ }
+
+ /**
+ * 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();
+ $this->total_shipments = count( $order_shipment->get_simple_shipments() );
+ $this->cur_position = $this->get_shipped_position_number( $shipment_id );
+
+ if ( $order_shipment->needs_shipping() || $this->total_shipments > 1 ) {
+ if ( $order_shipment->needs_shipping() || ( $this->cur_position < $this->total_shipments ) ) {
+ $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();
+ $this->placeholders['{total_shipments}'] = $this->total_shipments;
+ $this->placeholders['{current_shipment_num}'] = $this->cur_position;
+
+ 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,
+ 'cur_position' => $this->cur_position,
+ 'total_shipments' => $this->total_shipments,
+ '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,
+ 'cur_position' => $this->cur_position,
+ 'total_shipments' => $this->total_shipments,
+ '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() ) ? wp_kses_post( 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,
+ 'description' => $placeholder_text,
+ 'placeholder' => $this->get_default_subject(),
+ 'default' => '',
+ ),
+ 'subject_partial' => array(
+ 'title' => _x( 'Partial shipment subject', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'desc_tip' => true,
+ 'description' => $placeholder_text,
+ 'placeholder' => $this->get_default_subject( true ),
+ 'default' => '',
+ ),
+ 'heading_full' => array(
+ 'title' => _x( 'Full shipment email heading', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'desc_tip' => true,
+ 'description' => $placeholder_text,
+ 'placeholder' => $this->get_default_heading(),
+ 'default' => '',
+ ),
+ 'heading_partial' => array(
+ 'title' => _x( 'Partial shipment email heading', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'desc_tip' => true,
+ 'description' => $placeholder_text,
+ '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..447beca08
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/emails/class-wc-gzd-email-new-return-shipment-request.php
@@ -0,0 +1,221 @@
+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..a7b71c78b
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/wc-gzd-label-functions.php
@@ -0,0 +1,152 @@
+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_label_minimum_shipment_weight(), $unit, 'kg' );
+ $default_weight = wc_get_weight( $provider->get_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;
+ }
+ }
+
+ $shipment_weight = wc_format_decimal( $shipment_weight, 3 );
+
+ 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..b234733ce
--- /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( $args = array() ) {
+ $data_store = \WC_Data_Store::load( 'packaging' );
+ $list = $data_store->get_packaging_list( $args );
+
+ 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( $args = array() ) {
+ $list = wc_gzd_get_packaging_list( $args );
+ $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..5efc9d61d
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/wc-gzd-shipment-functions.php
@@ -0,0 +1,1563 @@
+countries ? WC()->countries->get_states( $country ) : array();
+ $formatted_state = ( $states && isset( $states[ $state ] ) ) ? $states[ $state ] : $state;
+
+ return $formatted_state;
+}
+
+function wc_gzd_country_to_alpha3( $country ) {
+ return Package::get_country_iso_alpha3( $country );
+}
+
+function wc_gzd_country_to_alpha2( $country ) {
+ return Package::get_country_iso_alpha2( $country );
+}
+
+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__, array( $order ) );
+ return false;
+ }
+ } elseif ( is_a( $order, 'Vendidero\Germanized\Shipments\Order' ) ) {
+ return $order;
+ }
+
+ 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_shipping_label_zones() {
+ return apply_filters(
+ 'woocommerce_gzd_shipments_shipping_label_zones',
+ array(
+ 'dom' => _x( 'Domestic', 'shipments', 'woocommerce-germanized' ),
+ 'eu' => _x( 'EU', 'shipments', 'woocommerce-germanized' ),
+ 'int' => _x( 'International', 'shipments', 'woocommerce-germanized' ),
+ )
+ );
+}
+
+function wc_gzd_get_shipping_label_zone_title( $zone ) {
+ $zones = wc_gzd_get_shipping_label_zones();
+ $title = array_key_exists( $zone, $zones ) ? $zones[ $zone ] : '';
+
+ return apply_filters( 'woocommerce_gzd_shipments_shipping_label_zone_title', $title, $zone );
+}
+
+function wc_gzd_get_shipping_shipments_label_zone_title( $zone ) {
+ $title = _x( '%1$s shipments', 'shipments-zone-title', 'woocommerce-germanized' );
+
+ $zones = array(
+ 'dom' => _x( 'Domestic Shipments', 'shipments', 'woocommerce-germanized' ),
+ 'eu' => _x( 'EU Shipments', 'shipments', 'woocommerce-germanized' ),
+ 'int' => _x( 'International Shipments', 'shipments', 'woocommerce-germanized' ),
+ );
+
+ $title = array_key_exists( $zone, $zones ) ? $zones[ $zone ] : $title;
+
+ return apply_filters( 'woocommerce_gzd_shipments_shipping_shipments_label_zone_title', $title, $zone );
+}
+
+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' ),
+ 'gzd-partially-delivered' => _x( 'Partially delivered', 'shipments', 'woocommerce-germanized' ),
+ 'gzd-delivered' => _x( 'Delivered', 'shipments', 'woocommerce-germanized' ),
+ 'gzd-no-shipping-needed' => _x( 'No shipping needed', '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 \Vendidero\Germanized\Shipments\ShippingMethod\ProviderMethod|false
+ */
+function wc_gzd_get_shipping_provider_method( $instance_id ) {
+ return \Vendidero\Germanized\Shipments\ShippingMethod\MethodHelper::get_provider_method( $instance_id );
+}
+
+/**
+ * Returns the current shipping method rate id.
+ *
+ * @return false|string
+ */
+function wc_gzd_get_current_shipping_method_id() {
+ $chosen_shipping_methods = WC()->session ? WC()->session->get( 'chosen_shipping_methods' ) : array();
+
+ if ( ! empty( $chosen_shipping_methods ) ) {
+ return reset( $chosen_shipping_methods );
+ }
+
+ return false;
+}
+
+function wc_gzd_get_current_shipping_provider_method() {
+ if ( $current = wc_gzd_get_current_shipping_method_id() ) {
+ return wc_gzd_get_shipping_provider_method( $current );
+ }
+
+ 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' ) );
+}
+
+/**
+ * @param Shipment $shipment
+ */
+function wc_gzd_get_shipment_address_addition( $shipment ) {
+ $addition = $shipment->get_address_2();
+ $street_addition = $shipment->get_address_street_addition();
+
+ if ( ! empty( $street_addition ) ) {
+ $addition = $street_addition . ( ! empty( $addition ) ? ' ' . $addition : '' );
+ }
+
+ return trim( $addition );
+}
+
+function wc_gzd_split_shipment_street( $street_str ) {
+ $return = array(
+ 'street' => $street_str,
+ 'number' => '',
+ 'addition' => '',
+ 'addition_2' => '',
+ );
+
+ try {
+ $split = AddressSplitter::split_address( $street_str );
+
+ $return['street'] = $split['streetName'];
+ $return['number'] = $split['houseNumber'];
+ /**
+ * e.g. 5. OG
+ */
+ $return['addition'] = isset( $split['additionToAddress2'] ) ? $split['additionToAddress2'] : '';
+ /**
+ * E.g. details to the location prefixed to the street name
+ */
+ $return['addition_2'] = isset( $split['additionToAddress1'] ) ? $split['additionToAddress1'] : '';
+ } catch ( Exception $e ) { // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedCatch
+ }
+
+ return $return;
+}
+
+/**
+ * @return ShippingProvider\Auto[]|ShippingProvider\Simple[]
+ */
+function wc_gzd_get_shipping_providers() {
+ return ShippingProvider\Helper::instance()->get_shipping_providers();
+}
+
+function wc_gzd_get_available_shipping_providers() {
+ return ShippingProvider\Helper::instance()->get_available_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( $include_none = true ) {
+ $providers = wc_gzd_get_shipping_providers();
+ $select = $include_none ? array(
+ '' => _x( 'None', 'shipments', 'woocommerce-germanized' ),
+ ) : array();
+
+ 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_service_locations() {
+ return array( 'settings', 'shipping_provider_settings', 'shipping_method_settings', 'packaging_settings', 'labels', 'label_services' );
+}
+
+function wc_gzd_get_shipping_provider_slug( $provider ) {
+ $providers = wc_gzd_get_shipping_providers();
+
+ if ( in_array( $provider, $providers, true ) ) {
+ $slug = array_search( $provider, $providers, true );
+ } 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;
+ }
+}
+
+function wc_gzd_get_shipment_setting_default_address_fields( $type = 'shipper' ) {
+ $address_fields = array(
+ 'first_name' => _x( 'First Name', 'shipments', 'woocommerce-germanized' ),
+ 'last_name' => _x( 'Last Name', 'shipments', 'woocommerce-germanized' ),
+ 'full_name' => _x( 'Full Name', 'shipments', 'woocommerce-germanized' ),
+ 'company' => _x( 'Company', 'shipments', 'woocommerce-germanized' ),
+ 'address_1' => _x( 'Address 1', 'shipments', 'woocommerce-germanized' ),
+ 'address_2' => _x( 'Address 2', 'shipments', 'woocommerce-germanized' ),
+ 'street' => _x( 'Street', 'shipments', 'woocommerce-germanized' ),
+ 'street_number' => _x( 'House Number', 'shipments', 'woocommerce-germanized' ),
+ 'postcode' => _x( 'Postcode', 'shipments', 'woocommerce-germanized' ),
+ 'city' => _x( 'City', 'shipments', 'woocommerce-germanized' ),
+ 'country' => _x( 'Country', 'shipments', 'woocommerce-germanized' ),
+ 'state' => _x( 'State', 'shipments', 'woocommerce-germanized' ),
+ 'phone' => _x( 'Phone', 'shipments', 'woocommerce-germanized' ),
+ 'email' => _x( 'Email', 'shipments', 'woocommerce-germanized' ),
+ 'customs_reference_number' => _x( 'Customs Reference Number', 'shipments', 'woocommerce-germanized' ),
+ 'customs_uk_vat_id' => _x( 'UK VAT ID (HMRC)', 'shipments', 'woocommerce-germanized' ),
+ );
+
+ return apply_filters( 'woocommerce_gzd_shipment_default_address_fields', $address_fields, $type );
+}
+
+/**
+ * @return array
+ */
+function wc_gzd_get_shipment_setting_address_fields( $address_type = 'shipper' ) {
+ $default_address_fields = array_keys( wc_gzd_get_shipment_setting_default_address_fields( $address_type ) );
+ $default_address_data = array();
+
+ if ( 'return' === $address_type ) {
+ $default_address_data = wc_gzd_get_shipment_setting_address_fields( 'shipper' );
+ }
+
+ foreach ( $default_address_fields as $prop ) {
+ $key = "woocommerce_gzd_shipments_{$address_type}_address_{$prop}";
+ $value = get_option( $key, '' );
+
+ if ( '' === $value && array_key_exists( $prop, $default_address_data ) ) {
+ $value = $default_address_data[ $prop ];
+ }
+
+ $address_fields[ $prop ] = $value;
+ }
+
+ if ( ! empty( $address_fields['country'] ) && strlen( $address_fields['country'] ) > 2 ) {
+ $value = wc_format_country_state_string( $address_fields['country'] );
+ $address_fields['country'] = $value['country'];
+ $address_fields['state'] = $value['state'];
+ }
+
+ /**
+ * Format/split address 1 into street and house number
+ */
+ if ( ! empty( $address_fields['address_1'] ) ) {
+ $split = wc_gzd_split_shipment_street( $address_fields['address_1'] );
+
+ $address_fields['street'] = $split['street'];
+ $address_fields['street_number'] = $split['number'];
+ } else {
+ $address_fields['street'] = '';
+ $address_fields['street_number'] = '';
+ }
+
+ /**
+ * Attach formatted full name
+ */
+ $address_fields['full_name'] = trim( sprintf( _x( '%1$s %2$s', 'full name', 'woocommerce-germanized' ), $address_fields['first_name'], $address_fields['last_name'] ) );
+
+ return apply_filters( "woocommerce_gzd_shipment_{$address_type}_address_fields", $address_fields, $address_type );
+}
+
+/**
+ * @param Order $shipment_order
+ *
+ * @return array
+ */
+function wc_gzd_get_shipment_return_address( $shipment_order = false ) {
+ return wc_gzd_get_shipment_setting_address_fields( 'return' );
+}
+
+/**
+ * @param WC_Order $order
+ * @return WC_Order_Item_Shipping|false
+ */
+function wc_gzd_get_shipment_order_shipping_method( $order ) {
+ $methods = $order->get_shipping_methods();
+ $method = false;
+
+ if ( ! empty( $methods ) ) {
+ $method_data = array_values( $methods );
+ $method = array_shift( $method_data );
+
+ if ( ! $method ) {
+ $method = false;
+ }
+ }
+
+ /**
+ * Allows adjusting the shipping method for a certain order.
+ *
+ * @param WC_Order_Item_Shipping|false $method The order item.
+ * @param WC_Order $order The order object.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipment_order_shipping_method', $method, $order );
+}
+
+/**
+ * @param WC_Order $order
+ */
+function wc_gzd_get_shipment_order_shipping_method_id( $order ) {
+ $id = '';
+
+ if ( $method = wc_gzd_get_shipment_order_shipping_method( $order ) ) {
+ $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 ) {
+ $action = wp_parse_args(
+ $action,
+ array(
+ 'url' => '#',
+ 'group' => '',
+ 'action' => '',
+ 'target' => '_self',
+ 'classes' => '',
+ 'name' => '',
+ 'custom_attributes' => array(),
+ 'title' => '',
+ )
+ );
+
+ if ( ! empty( $action['group'] ) ) {
+ $actions_html .= '';
+ } elseif ( isset( $action['action'], $action['url'], $action['name'] ) ) {
+ $classes = 'button wc-gzd-shipment-action-button tip wc-gzd-shipment-action-button-' . $action['action'] . ' ' . $action['action'] . ' ' . $action['classes'];
+
+ if ( empty( $action['title'] ) ) {
+ $action['title'] = $action['name'];
+ }
+
+ $custom_attributes = '';
+
+ foreach ( $action['custom_attributes'] as $attribute => $val ) {
+ $custom_attributes .= ' ' . esc_attr( $attribute ) . '="' . esc_attr( $val ) . '"';
+ }
+
+ $actions_html .= sprintf( '%6$s', esc_attr( $classes ), esc_url( $action['url'] ), esc_attr( $action['title'] ), esc_attr( $action['target'] ), $custom_attributes, 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__, array( $the_item, $item_type ) );
+ 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( $shipment_order->get_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 );
+ } elseif ( is_a( $order, '\Vendidero\Germanized\Shipments\Order' ) ) {
+ $order = $order->get_order();
+ }
+
+ if ( ! $order ) {
+ return false;
+ }
+
+ $provider = false;
+ $method_id = wc_gzd_get_shipment_order_shipping_method_id( $order );
+
+ if ( $method = wc_gzd_get_shipping_provider_method( $method_id ) ) {
+ $provider = $method->get_shipping_provider_instance();
+ }
+
+ if ( ! $provider ) {
+ foreach ( array_reverse( wc_gzd_get_shipment_order( $order )->get_shipments() ) as $shipment ) {
+ if ( $shipment->get_shipping_provider_instance() ) {
+ $provider = $shipment->get_shipping_provider_instance();
+ break;
+ }
+ }
+ }
+
+ /**
+ * 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'] ) ) : '' ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+
+ return $key;
+}
+
+function wc_gzd_customer_can_add_return_shipment( $order_id ) {
+ $can_view_shipments = false;
+
+ if ( isset( $_REQUEST['key'] ) && ! empty( $_REQUEST['key'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+ $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 );
+}
+
+function wc_gzd_shipments_get_product( $the_product ) {
+ try {
+ if ( is_a( $the_product, '\Vendidero\Germanized\Shipments\Product' ) ) {
+ return $the_product;
+ }
+
+ return new \Vendidero\Germanized\Shipments\Product( $the_product );
+ } catch ( \Exception $e ) {
+ return false;
+ }
+}
+
+function wc_gzd_get_volume_dimension( $dimension, $to_unit, $from_unit = '' ) {
+ $to_unit = strtolower( $to_unit );
+
+ if ( empty( $from_unit ) ) {
+ $from_unit = strtolower( get_option( 'woocommerce_dimension_unit' ) );
+ }
+
+ // Unify all units to cm first.
+ if ( $from_unit !== $to_unit ) {
+ switch ( $from_unit ) {
+ case 'm':
+ $dimension *= 1000000;
+ break;
+ case 'mm':
+ $dimension *= 0.001;
+ break;
+ }
+
+ // Output desired unit.
+ switch ( $to_unit ) {
+ case 'm':
+ $dimension *= 0.000001;
+ break;
+ case 'mm':
+ $dimension *= 1000;
+ break;
+ }
+ }
+
+ return ( $dimension < 0 ) ? 0 : $dimension;
+}
+
+if ( ! function_exists( 'wc_gzd_wp_theme_get_element_class_name' ) ) {
+ /**
+ * Given an element name, returns a class name.
+ *
+ * If the WP-related function is not defined, return empty string.
+ *
+ * @param string $element The name of the element.
+ *
+ * @return string
+ */
+ function wc_gzd_wp_theme_get_element_class_name( $element ) {
+ if ( function_exists( 'wc_wp_theme_get_element_class_name' ) ) {
+ return wc_wp_theme_get_element_class_name( $element );
+ } elseif ( function_exists( 'wp_theme_get_element_class_name' ) ) {
+ return wp_theme_get_element_class_name( $element );
+ }
+
+ return '';
+ }
+}
+
+function wc_gzd_shipments_allow_deferred_sync( $type = 'shipments' ) {
+ $allow_defer = true;
+
+ if ( 'shipments' === $type || 'label' === $type || 'return_label' === $type ) {
+ if ( is_admin() && current_user_can( 'manage_woocommerce' ) ) {
+ $allow_defer = false;
+ }
+ }
+
+ if ( apply_filters( 'woocommerce_gzd_shipments_disable_deferred_sync', false ) ) {
+ $allow_defer = false;
+ }
+
+ return apply_filters( "woocommerce_gzd_shipments_allow_{$type}_deferred_sync", $allow_defer );
+}
+
+/**
+ * Forces a WP_Error object to be converted to a ShipmentError.
+ *
+ * @param $error
+ *
+ * @return mixed|\Vendidero\Germanized\Shipments\ShipmentError
+ */
+function wc_gzd_get_shipment_error( $error ) {
+ if ( ! is_wp_error( $error ) ) {
+ return $error;
+ } elseif ( is_a( $error, 'Vendidero\Germanized\Shipments\ShipmentError' ) ) {
+ return $error;
+ } else {
+ return \Vendidero\Germanized\Shipments\ShipmentError::from_wp_error( $error );
+ }
+}
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..c982910df
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/includes/wc-gzd-shipment-template-hooks.php
@@ -0,0 +1,29 @@
+ 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 . '
'; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
+ }
+
+ 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,
+ )
+ );
+ }
+ }
+}
+
+if ( ! function_exists( 'woocommerce_gzd_shipments_template_non_returnable_items_note' ) ) {
+
+ function woocommerce_gzd_shipments_template_non_returnable_items_note( $order ) {
+ if ( $shipment_order = wc_gzd_get_shipment_order( $order ) ) {
+ $non_returnable_items = $shipment_order->get_non_returnable_items();
+
+ if ( ! empty( $non_returnable_items ) ) {
+ $product_names = array();
+
+ foreach ( $non_returnable_items as $non_returnable_item ) {
+ $product_names[] = $non_returnable_item['name'];
+ }
+
+ if ( ! empty( $product_names ) ) {
+ echo '' . sprintf( esc_html_x( 'The following products cannot be returned due to their nature: %1$s', 'shipments', 'woocommerce-germanized' ), esc_html( implode( ', ', $product_names ) ) ) . '
'; + } + } + } + } +} 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.
+
+
+
+
+
+
+ />
+
+
+
+
+
+
+
+
+
+
+ absint( $packaging_id ) );
+
+ if ( ! empty( $provider_name ) ) {
+ $args['provider'] = $provider_name;
+ }
+
+ if ( ! empty( $section ) ) {
+ $args['section'] = $section;
+ }
+
+ return esc_url_raw( add_query_arg( $args, admin_url( 'admin.php?page=shipment-packaging' ) ) );
+ }
+
+ public static function render_packaging_page() {
+ if ( isset( $_GET['packaging'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+ $packaging_id = isset( $_GET['packaging'] ) ? absint( wp_unslash( $_GET['packaging'] ) ) : false; // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+
+ if ( ! $packaging_id ) {
+ return;
+ }
+
+ if ( ! $packaging = wc_gzd_get_packaging( $packaging_id ) ) {
+ return;
+ }
+
+ $current_tab = isset( $_GET['tab'] ) ? wc_clean( wp_unslash( $_GET['tab'] ) ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+ $current_section = isset( $_GET['section'] ) ? wc_clean( wp_unslash( $_GET['section'] ) ) : 'simple'; // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+ $current_settings = PackagingSettings::get_settings( $packaging, $current_tab, $current_section );
+ ?>
+
+ get_id() !== $post_id ) {
+ $the_order = wc_get_order( $post_id );
+ }
+
+ if ( $shipment_order = wc_gzd_get_shipment_order( $the_order ) ) {
+ $shipping_status = $shipment_order->get_shipping_status();
+ $status_html = '' . esc_html( wc_gzd_get_shipment_order_shipping_status_name( $shipping_status ) ) . '';
+
+ if ( in_array( $shipping_status, array( 'shipped', 'partially-shipped' ), true ) && $shipment_order->get_shipments() ) {
+ echo '' . wp_kses_post( $status_html ) . '';
+ } else {
+ echo wp_kses_post( $status_html );
+ }
+ }
+ }
+ }
+
+ public static function register_order_shipping_status_column( $columns ) {
+ $new_columns = array();
+ $added_column = false;
+
+ foreach ( $columns as $column_name => $title ) {
+ if ( ! $added_column && ( 'shipping_address' === $column_name || 'wc_actions' === $column_name ) ) {
+ $new_columns['shipping_status'] = _x( 'Shipping Status', 'shipments-order-column-name', 'woocommerce-germanized' );
+ $added_column = true;
+ }
+
+ $new_columns[ $column_name ] = $title;
+ }
+
+ if ( ! $added_column ) {
+ $new_columns['shipping_status'] = _x( 'Shipping Status', 'shipments-order-column-name', 'woocommerce-germanized' );
+ }
+
+ return $new_columns;
+ }
+
+ /**
+ * In case the shipper/return country is set to AF (or DE with missing state) due to a bug in Woo, make sure
+ * to automatically adjust it to the right value in case the base country option is being saved.
+ *
+ * @return void
+ */
+ public static function observe_base_country_setting() {
+ if ( isset( $_POST['woocommerce_default_country'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
+ $new_base_country = wc_format_country_state_string( get_option( 'woocommerce_default_country' ) );
+
+ if ( 'AF' !== $new_base_country['country'] ) {
+ $shipper_country = wc_format_country_state_string( get_option( 'woocommerce_gzd_shipments_shipper_address_country' ) );
+ $return_country = wc_format_country_state_string( get_option( 'woocommerce_gzd_shipments_return_address_country' ) );
+
+ if ( 'AF' === $shipper_country['country'] || ( 'DE' === $new_base_country['country'] && 'DE' === $shipper_country['country'] && empty( $shipper_country['state'] ) && ! empty( $new_base_country['state'] ) ) ) {
+ update_option( 'woocommerce_gzd_shipments_shipper_address_country', get_option( 'woocommerce_default_country' ) );
+ }
+
+ if ( 'AF' === $return_country['country'] || ( 'DE' === $new_base_country['country'] && 'DE' === $return_country['country'] && empty( $return_country['state'] ) && ! empty( $return_country['state'] ) ) ) {
+ update_option( 'woocommerce_gzd_shipments_return_address_country', get_option( 'woocommerce_default_country' ) );
+ }
+ }
+ }
+ }
+
+ public static function product_options() {
+ global $post, $thepostid, $product_object;
+
+ $_product = wc_get_product( $product_object );
+ $shipments_product = wc_gzd_shipments_get_product( $_product );
+
+ $countries = WC()->countries->get_countries();
+ $countries = array_merge( array( '0' => _x( 'Select a country', 'shipments', 'woocommerce-germanized' ) ), $countries );
+
+ woocommerce_wp_checkbox(
+ array(
+ 'id' => '_is_non_returnable',
+ 'label' => _x( 'Non returnable', 'shipments', 'woocommerce-germanized' ),
+ 'description' => _x( 'Exclude product from returns, e.g. pet food.', 'shipments', 'woocommerce-germanized' ),
+ 'value' => $shipments_product->is_non_returnable( 'edit' ) ? 'yes' : 'no',
+ )
+ );
+ ?>
+
+ '_customs_description',
+ 'label' => _x( 'Description', 'shipments', 'woocommerce-germanized' ),
+ 'desc_tip' => true,
+ 'description' => _x( 'Choose a description to be used for customs documents, e.g. CN23 form.', 'shipments', 'woocommerce-germanized' ),
+ 'value' => $shipments_product->get_customs_description( 'edit' ),
+ )
+ );
+
+ woocommerce_wp_text_input(
+ array(
+ 'id' => '_hs_code',
+ 'label' => _x( 'HS-Code', 'shipments', 'woocommerce-germanized' ),
+ 'desc_tip' => true,
+ 'description' => _x( 'The HS Code is a number assigned to every possible commodity that can be imported or exported from any country.', 'shipments', 'woocommerce-germanized' ),
+ 'value' => $shipments_product->get_hs_code( 'edit' ),
+ )
+ );
+
+ woocommerce_wp_select(
+ array(
+ 'options' => $countries,
+ 'id' => '_manufacture_country',
+ 'label' => _x( 'Country of manufacture', 'shipments', 'woocommerce-germanized' ),
+ 'desc_tip' => true,
+ 'description' => _x( 'The country of manufacture is needed for customs of international shipping.', 'shipments', 'woocommerce-germanized' ),
+ 'value' => $shipments_product->get_manufacture_country( 'edit' ),
+ )
+ );
+
+ do_action( 'woocommerce_gzd_shipments_product_options', $shipments_product );
+ }
+
+ /**
+ * @param \WC_Product $product
+ */
+ public static function save_product( $product ) {
+ $customs_description = isset( $_POST['_customs_description'] ) ? wc_clean( wp_unslash( $_POST['_customs_description'] ) ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Missing
+ $hs_code = isset( $_POST['_hs_code'] ) ? wc_clean( wp_unslash( $_POST['_hs_code'] ) ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Missing
+ $country = isset( $_POST['_manufacture_country'] ) ? wc_clean( wp_unslash( $_POST['_manufacture_country'] ) ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Missing
+ $is_non_returnable = isset( $_POST['_is_non_returnable'] ) ? wc_clean( wp_unslash( $_POST['_is_non_returnable'] ) ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Missing
+
+ $shipments_product = wc_gzd_shipments_get_product( $product );
+ $shipments_product->set_hs_code( $hs_code );
+ $shipments_product->set_customs_description( $customs_description );
+ $shipments_product->set_manufacture_country( $country );
+ $shipments_product->set_is_non_returnable( $is_non_returnable );
+
+ /**
+ * Remove legacy data upon saving in case it is not transmitted (e.g. DHL standalone plugin).
+ */
+ if ( apply_filters( 'woocommerce_gzd_shipments_remove_legacy_customs_meta', isset( $_POST['_dhl_hs_code'] ) ? false : true, $product ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
+ $product->delete_meta_data( '_dhl_hs_code' );
+ $product->delete_meta_data( '_dhl_manufacture_country' );
+ }
+
+ do_action( 'woocommerce_gzd_shipments_save_product_options', $shipments_product );
+ }
+
+ public static function check_upload_dir() {
+ $dir = Package::get_upload_dir();
+ $path = $dir['basedir'];
+ $dirname = basename( $path );
+
+ if ( @is_dir( $dir['basedir'] ) ) { // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+ return;
+ }
+ ?>
+
';
+ }
+
+ public static function render_method_tab_content( $html, $key, $setting, $method ) {
+ $setting = wp_parse_args(
+ $setting,
+ array(
+ 'active' => false,
+ 'id' => '',
+ 'tab' => '',
+ )
+ );
+
+ return '| + | + + + | +||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| + |
+
+
+
+
+
+
+
+
+
|
+ ||||||||||
| + | + + + | +
|
+ 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_submit() {
+ check_ajax_referer( 'create-shipment-label-submit', 'security' );
+
+ if ( ! current_user_can( 'edit_shop_orders' ) || ! isset( $_POST['reference_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['reference_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' ), true ) ) {
+ continue;
+ }
+
+ $data[ $key ] = wc_clean( wp_unslash( $value ) );
+ }
+
+ $result = $shipment->create_label( $data );
+ }
+
+ if ( is_wp_error( $result ) ) {
+ $result = wc_gzd_get_shipment_error( $result );
+ }
+
+ if ( is_wp_error( $result ) && ! $result->is_soft_error() ) {
+ $response = array(
+ 'success' => false,
+ 'messages' => $result->get_error_messages_by_type(),
+ );
+ } elseif ( $label = $shipment->get_label() ) {
+ $order_shipment = wc_gzd_get_shipment_order( $shipment->get_order() );
+ $order_status_html = $order_shipment ? self::get_global_order_status_html( $order_shipment->get_order() ) : array();
+
+ $response = array(
+ 'success' => true,
+ 'label_id' => $label->get_id(),
+ 'shipment_id' => $shipment_id,
+ 'messages' => is_wp_error( $result ) ? $result->get_error_messages_by_type() : array(),
+ '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 ) : '',
+ '.order_data_column p.wc-order-status' => ! empty( $order_status_html ) ? $order_status_html['status'] : '',
+ 'input[name=post_status]' => ! empty( $order_status_html ) ? $order_status_html['input'] : '',
+ 'tr#shipment-' . $shipment_id . ' td.actions .wc-gzd-shipment-action-button-generate-label' => self::label_download_button_html( $label ),
+ ),
+ );
+
+ if ( empty( $response['fragments']['.order_data_column p.wc-order-status'] ) ) {
+ unset( $response['fragments']['.order_data_column p.wc-order-status'] );
+ }
+ } 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( wp_unslash( $_POST['provider'] ) ) );
+ $enable = wc_clean( wp_unslash( $_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( wp_unslash( $_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 sort_shipping_provider() {
+ check_ajax_referer( 'sort-shipping-provider', 'security' );
+
+ if ( ! current_user_can( 'edit_shop_orders' ) || ! isset( $_POST['order'] ) ) {
+ wp_die( -1 );
+ }
+
+ $order = wc_clean( wp_unslash( $_POST['order'] ) );
+ $order_count = 0;
+ $helper = Helper::instance();
+ $response = array(
+ 'success' => true,
+ 'message' => '',
+ );
+
+ $helper->load_shipping_providers();
+
+ foreach ( $order as $shipping_provider_name ) {
+ if ( $shipping_provider = $helper->get_shipping_provider( $shipping_provider_name ) ) {
+ $shipping_provider->set_order( ++$order_count );
+ $shipping_provider->save();
+ }
+ }
+
+ wp_send_json( $response );
+ }
+
+ public static function shipments_bulk_action_handle() {
+ $action = isset( $_POST['bulk_action'] ) ? wc_clean( wp_unslash( $_POST['bulk_action'] ) ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Missing
+ $type = isset( $_POST['type'] ) ? wc_clean( wp_unslash( $_POST['type'] ) ) : 'simple'; // phpcs:ignore WordPress.Security.NonceVerification.Missing
+
+ 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;
+ }
+
+ private static function get_shipment_ids( $shipments ) {
+ return array_values(
+ array_map(
+ function( $s ) {
+ return $s->get_id();
+ },
+ $shipments
+ )
+ );
+ }
+
+ 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 );
+ }
+
+ $shipment_ids = self::get_shipment_ids( $order_shipment->get_shipments() );
+
+ if ( $shipment->delete( true ) ) {
+ $order_shipment->remove_shipment( $shipment_id );
+
+ if ( 'return' === $shipment->get_type() ) {
+ $order_shipment->validate_shipments();
+ }
+
+ /*
+ * Check which shipments have been deleted (e.g. multiple in case a return has been removed)
+ */
+ $shipments_removed = array_values( array_diff( $shipment_ids, self::get_shipment_ids( $order_shipment->get_shipments() ) ) );
+ $response['shipment_id'] = $shipments_removed;
+
+ $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 );
+ }
+
+ $shipments = $order_shipment->create_shipments();
+
+ if ( is_wp_error( $shipments ) || empty( $shipments ) ) {
+ if ( is_wp_error( $shipments ) ) {
+ $response_error['message'] = $shipments->get_error_message();
+ }
+
+ wp_send_json( $response_error );
+ }
+
+ $html = '';
+ $shipment_type = 'simple';
+ $shipment_count = 0;
+
+ foreach ( $shipments as $id => $shipment ) {
+ $shipment_count++;
+ $shipment_type = $shipment->get_type();
+
+ if ( 1 === $shipment_count ) {
+ // Mark as active
+ $is_active = true;
+ } else {
+ // Mark as active
+ $is_active = false;
+ }
+
+ 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_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_submit() {
+ check_ajax_referer( 'add-return-shipment-submit', 'security' );
+
+ if ( ! current_user_can( 'edit_shop_orders' ) || ! isset( $_POST['reference_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['reference_id'] );
+ $items = isset( $_POST['return_item'] ) ? (array) wc_clean( wp_unslash( $_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_shipping_provider() {
+ ob_start();
+
+ check_ajax_referer( 'search-shipping-provider', 'security' );
+
+ if ( ! current_user_can( 'edit_shop_orders' ) ) {
+ wp_die( -1 );
+ }
+
+ $term = isset( $_GET['term'] ) ? (string) wc_clean( wp_unslash( $_GET['term'] ) ) : '';
+ $found_providers = array();
+
+ if ( empty( $term ) ) {
+ wp_die();
+ }
+
+ global $wpdb;
+
+ $names = $wpdb->get_col(
+ $wpdb->prepare(
+ "SELECT DISTINCT p1.shipping_provider_name FROM {$wpdb->gzd_shipping_provider} p1 WHERE p1.shipping_provider_title LIKE %s AND p1.shipping_provider_activated = 1", // @codingStandardsIgnoreLine
+ $wpdb->esc_like( wc_clean( $term ) ) . '%'
+ )
+ );
+
+ foreach ( $names as $name ) {
+ if ( $shipping_provider = wc_gzd_get_shipping_provider( $name ) ) {
+ $found_providers[ $name ] = esc_html( $shipping_provider->get_title() );
+ }
+ }
+
+ /**
+ * Filter to adjust found shipping providers to filter Shipments.
+ *
+ * @param array $result The shipping provider search result.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ wp_send_json( apply_filters( 'woocommerce_gzd_json_search_found_shipment_shipping_providers', $found_providers ) );
+ }
+
+ 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 ( Package::is_hpos_enabled() ) {
+ $ids = wc_get_orders( array( 's' => $term ) );
+ } else {
+ if ( ! is_numeric( $term ) ) {
+ $ids = wc_get_orders( array( 's' => $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 ) ) . '%'
+ )
+ );
+ }
+ }
+
+ $excluded = array();
+
+ if ( ! empty( $_GET['exclude'] ) ) {
+ $excluded = array_map( 'absint', (array) wp_unslash( $_GET['exclude'] ) );
+ }
+
+ foreach ( $ids as $id ) {
+ if ( $order = wc_get_order( $id ) ) {
+ if ( in_array( absint( $order->get_id() ), $excluded, true ) ) {
+ continue;
+ }
+
+ $found_orders[ $order->get_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;
+ }
+
+ /**
+ * @param \WC_Order $order
+ *
+ * @return string[]
+ */
+ private static function get_global_order_status_html( $order ) {
+ $old_status = $order->get_status();
+ $result = array(
+ 'status' => '',
+ 'input' => '',
+ );
+
+ /**
+ * Load a clean instance to make sure order status updates are reflected.
+ */
+ $order = wc_get_order( $order->get_id() );
+
+ /**
+ * In case the current request has not changed the status do not return html
+ */
+ if ( ! $order || $old_status === $order->get_status() ) {
+ return $result;
+ }
+ ob_start();
+ ?>
+ + + +
+ get_status( 'edit' ) ) . '" />'; + + return $result; + } + + 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( wp_unslash( $_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(); + + $order_status_html = self::get_global_order_status_html( $order_shipment->get_order() ); + + $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 ), + '.order_data_column p.wc-order-status' => $order_status_html['status'], + 'input[name="post_status"]' => $order_status_html['input'], + ); + + if ( empty( $fragments['.order_data_column p.wc-order-status'] ) ) { + unset( $fragments['.order_data_column p.wc-order-status'] ); + unset( $fragments['input[name="post_status"]'] ); + } + + return $fragments; + } + + public static function add_return_shipment_load() { + check_ajax_referer( 'add-return-shipment-load', 'security' ); + + if ( ! current_user_can( 'edit_shop_orders' ) || ! isset( $_POST['reference_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' => '', + 'fragments' => array(), + ); + + $order_id = absint( $_POST['reference_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['fragments']['#wc-gzd-return-shipment-items'] = ob_get_clean(); + + self::send_json_success( $response, $order_shipment ); + } + + public static function add_shipment_item_load() { + check_ajax_referer( 'add-shipment-item-load', 'security' ); + + if ( ! current_user_can( 'edit_shop_orders' ) || ! isset( $_POST['reference_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' => '', + 'fragments' => array(), + ); + + $shipment_id = absint( $_POST['reference_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 ); + + $items = array(); + + if ( 'return' === $shipment->get_type() ) { + $items = $order_shipment->get_available_items_for_return( + array( + 'shipment_id' => $shipment->get_id(), + 'disable_duplicates' => true, + ) + ); + } else { + $items = $order_shipment->get_available_items_for_shipment( + array( + 'shipment_id' => $shipment_id, + 'disable_duplicates' => true, + ) + ); + } + + ob_start(); + include Package::get_path() . '/includes/admin/views/html-order-add-shipment-item.php'; + $response['fragments']['.wc-gzd-shipment-add-items-table'] = ob_get_clean(); + + self::send_json_success( $response, $order_shipment ); + } + + public static function add_shipment_item_submit() { + check_ajax_referer( 'add-shipment-item-submit', 'security' ); + + if ( ! current_user_can( 'edit_shop_orders' ) || ! isset( $_POST['reference_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['reference_id'] ); + $original_item_id = isset( $_POST['item_id'] ) ? absint( $_POST['item_id'] ) : 0; + $item_quantity = isset( $_POST['item_qty'] ) ? absint( $_POST['item_qty'] ) : false; + + if ( false !== $item_quantity && 0 === $item_quantity ) { + $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..258ccefe9 --- /dev/null +++ b/packages/woocommerce-germanized-shipments/src/Api.php @@ -0,0 +1,233 @@ +set_data( array_merge( $response->data, self::get_product_data( $product, $context ) ) ); + } + + return $response; + } + + private static function get_product_data( $product, $context = 'view' ) { + $data = array(); + + if ( $shipments_product = wc_gzd_shipments_get_product( $product ) ) { + $data['hs_code'] = $shipments_product->get_hs_code( $context ); + $data['customs_description'] = $shipments_product->get_customs_description( $context ); + $data['manufacture_country'] = $shipments_product->get_manufacture_country( $context ); + } + + return $data; + } + + /** + * @param \WC_Product $product + * @param $request + * + * @return \WC_Product $product + */ + public static function update_product( $product, $request ) { + if ( $shipments_product = wc_gzd_shipments_get_product( $product ) ) { + if ( isset( $request['customs_description'] ) ) { + $shipments_product->set_customs_description( wc_clean( wp_unslash( $request['customs_description'] ) ) ); + } + + if ( isset( $request['hs_code'] ) ) { + $shipments_product->set_hs_code( wc_clean( wp_unslash( $request['hs_code'] ) ) ); + } + + if ( isset( $request['manufacture_country'] ) ) { + $shipments_product->set_manufacture_country( wc_clean( wp_unslash( $request['manufacture_country'] ) ) ); + } + } + + return $product; + } + + public static function remove_status_prefix( $status ) { + if ( 'gzd-' === substr( $status, 0, 4 ) ) { + $status = substr( $status, 4 ); + } + + return $status; + } + + /** + * Extend schema. + * + * @since 1.0.0 + * + * @param array $schema_properties Data used to create the order. + * + * @return array + */ + public static function order_schema( $schema_properties ) { + $statuses = array_map( array( __CLASS__, 'remove_status_prefix' ), array_keys( wc_gzd_get_shipment_order_shipping_statuses() ) ); + + $schema_properties['shipping_status'] = array( + 'description' => _x( 'Shipping status', 'shipments', 'woocommerce-germanized' ), + 'type' => 'string', + 'enum' => $statuses, + 'context' => array( 'view', 'edit' ), + 'readonly' => true, + ); + + return $schema_properties; + } + + /** + * Extend product variation schema. + * + * @since 1.0.0 + * + * @param array $schema_properties Data used to create the product. + * + * @return array + */ + public static function product_variation_schema( $schema_properties ) { + $schema_properties['customs_description'] = array( + 'description' => _x( 'Customs description', 'shipments', 'woocommerce-germanized' ), + 'type' => 'string', + 'context' => array( 'view', 'edit' ), + 'readonly' => true, + ); + + $schema_properties['hs_code'] = array( + 'description' => _x( 'HS-Code', 'shipments', 'woocommerce-germanized' ), + 'type' => 'string', + 'context' => array( 'view', 'edit' ), + 'readonly' => true, + ); + + $schema_properties['manufacture_country'] = array( + 'description' => _x( 'Country of manufacture', 'shipments', 'woocommerce-germanized' ), + 'type' => 'string', + 'context' => array( 'view', 'edit' ), + 'readonly' => true, + ); + + return $schema_properties; + } + + /** + * Extend product schema. + * + * @since 1.0.0 + * + * @param array $schema_properties Data used to create the product. + * + * @return array + */ + public static function product_schema( $schema_properties ) { + $schema_properties['customs_description'] = array( + 'description' => _x( 'Customs description', 'shipments', 'woocommerce-germanized' ), + 'type' => 'string', + 'context' => array( 'view', 'edit' ), + ); + + $schema_properties['hs_code'] = array( + 'description' => _x( 'HS-Code (Customs)', 'shipments', 'woocommerce-germanized' ), + 'type' => 'string', + 'context' => array( 'view', 'edit' ), + ); + + $schema_properties['manufacture_country'] = array( + 'description' => _x( 'Country of manufacture (Customs)', 'shipments', 'woocommerce-germanized' ), + 'type' => 'string', + 'context' => array( 'view', 'edit' ), + ); + + return $schema_properties; + } + + /** + * @param WP_REST_Response $response + * @param $post + * @param WP_REST_Request $request + * + * @return mixed + */ + public static function prepare_order_shipments( $response, $post, $request ) { + $order = wc_get_order( $post ); + $response_order_data = $response->get_data(); + $response_order_data['shipments'] = array(); + $response_order_data['shipping_status'] = 'no-shipping-needed'; + + if ( $order ) { + $order_shipment = wc_gzd_get_shipment_order( $order ); + $shipments = $order_shipment->get_shipments(); + + if ( ! empty( $shipments ) ) { + foreach ( $shipments as $shipment ) { + $response_order_data['shipments'][] = ShipmentsController::prepare_shipment( $shipment, 'view', $request['dp'] ); + } + } + + $response_order_data['shipping_status'] = $order_shipment->get_shipping_status(); + } + + $response->set_data( $response_order_data ); + + return $response; + } + + public static function order_shipments_schema( $schema ) { + $schema['shipments'] = array( + 'description' => _x( 'List of shipments.', 'shipments', 'woocommerce-germanized' ), + 'type' => 'array', + 'context' => array( 'view', 'edit' ), + 'readonly' => true, + 'items' => ShipmentsController::get_single_item_schema(), + ); + + return $schema; + } + + protected static function get_shipment_statuses() { + $statuses = array(); + + foreach ( array_keys( wc_gzd_get_shipment_statuses() ) as $status ) { + $statuses[] = str_replace( 'gzd-', '', $status ); + } + + return $statuses; + } + + public static function register_controllers( $controller ) { + $controller['wc/v3']['shipments'] = ShipmentsController::class; + + 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..8303367d3 --- /dev/null +++ b/packages/woocommerce-germanized-shipments/src/Automation.php @@ -0,0 +1,336 @@ +queue(); + + /** + * Cancel outstanding events and queue new. + */ + $queue->cancel_all( 'woocommerce_gzd_shipments_order_auto_sync_callback', $args, 'woocommerce-gzd-shipments-order-sync' ); + } + + /** + * Make sure that his callback is only executed once for new order requests. + * + * @param WC_Order $order + * + * @return void + */ + public static function after_new_order( $order ) { + if ( self::$current_new_order_id === $order->get_id() ) { + self::maybe_create_shipments( $order ); + + remove_action( 'woocommerce_after_order_object_save', array( __CLASS__, 'after_new_order' ), 150 ); + self::$current_new_order_id = null; + } + } + + /** + * @param $order_id + * @param $old_status + * @param $new_status + * @param WC_Order $order + */ + public static function maybe_mark_shipments_shipped( $order_id, $old_status, $new_status, $order ) { + /** + * Filter to decide which order status is used to determine if a order + * is completed or not to update contained shipment statuses to shipped. + * Does only take effect if the automation option has been set within the shipment settings. + * + * @param string $status The current order status. + * @param integer $order_id The order id. + * + * @since 3.0.5 + * @package Vendidero/Germanized/Shipments + */ + if ( apply_filters( 'woocommerce_gzd_shipments_order_completed_status', 'completed', $order_id ) === $new_status ) { + // 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__, 'mark_shipments_shipped' ), 80 ); + } else { + self::mark_shipments_shipped( $order_id ); + } + } + } + + public static function is_admin_edit_order_request() { + $is_admin_edit_order_request = ( isset( $_POST['action'] ) && ( ( 'editpost' === $_POST['action'] && isset( $_POST['post_type'] ) && 'shop_order' === $_POST['post_type'] ) || 'edit_order' === $_POST['action'] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Missing + + /** + * Check whether the hook has already been firing. + */ + if ( did_action( 'woocommerce_process_shop_order_meta' ) && ! doing_action( 'woocommerce_process_shop_order_meta' ) ) { + $is_admin_edit_order_request = false; + } + + return $is_admin_edit_order_request; + } + + public static function mark_shipments_shipped( $order_id ) { + if ( $order = wc_get_order( $order_id ) ) { + if ( $shipment_order = wc_gzd_get_shipment_order( $order ) ) { + foreach ( $shipment_order->get_simple_shipments() as $shipment ) { + if ( ! $shipment->is_shipped() ) { + $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 ) ? 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' ) ); + } + } + + /** + * @param $order + * + * @return Shipment[]|\WP_Error + */ + public static function create_shipments( $order ) { + $result = array(); + + if ( is_numeric( $order ) ) { + $order = wc_get_order( $order ); + } + + if ( ! $order ) { + return $result; + } + + $shipment_status = Package::get_setting( 'auto_default_status' ); + + if ( empty( $shipment_status ) ) { + $shipment_status = 'processing'; + } + + /** + * In case the order is already completed, e.g. while asynchronously creating shipments, make sure to update the shipment status. + */ + if ( 'yes' === Package::get_setting( 'auto_order_completed_shipped_enable' ) && apply_filters( 'woocommerce_gzd_shipments_order_completed_status', 'completed', $order->get_id() ) === $order->get_status() ) { + $shipment_status = 'shipped'; + } + + /** + * 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. + * @param WC_Order $order The order instance. + * + * @since 3.1.0 + * @package Vendidero/Germanized/Shipments + */ + if ( ! apply_filters( 'woocommerce_gzd_auto_create_shipments_for_order', true, $order->get_id(), $order ) ) { + return $result; + } + + if ( $order_shipment = wc_gzd_get_shipment_order( $order ) ) { + /** + * Sync existing shipments and items before creating new shipments + */ + foreach ( $order_shipment->get_simple_shipments() as $shipment ) { + if ( $shipment->is_editable() ) { + $shipment->sync(); + $shipment->sync_items(); + $shipment->save(); + } + } + + do_action( 'woocommerce_gzd_before_auto_create_shipments_for_order', $order->get_id(), $shipment_status, $order ); + + $result = $order_shipment->create_shipments( $shipment_status ); + + do_action( 'woocommerce_gzd_after_auto_create_shipments_for_order', $order->get_id(), $shipment_status, $order, $result ); + } + + if ( is_wp_error( $result ) ) { + return $result; + } + + return $result; + } + + protected static function get_auto_statuses() { + $statuses = (array) Package::get_setting( 'auto_statuses' ); + $clean_statuses = array(); + + if ( ! empty( $statuses ) ) { + foreach ( $statuses as $status ) { + $status = trim( str_replace( 'wc-', '', $status ) ); + + if ( ! in_array( $status, $clean_statuses, true ) ) { + $clean_statuses[] = $status; + } + } + } + + return $clean_statuses; + } + + public static function maybe_create_shipments( $order_id, $args = array() ) { + $args = wp_parse_args( + (array) $args, + array( + 'allow_deferred_sync' => wc_gzd_shipments_allow_deferred_sync( 'shipments' ), + ) + ); + + $statuses = self::get_auto_statuses(); + $has_status = empty( $statuses ) ? true : false; + + if ( ! $has_status ) { + if ( $order_shipment = wc_gzd_get_shipment_order( $order_id ) ) { + $has_status = $order_shipment->get_order()->has_status( $statuses ); + } + } + + if ( $has_status ) { + // Make sure that MetaBox is saved before we process automation + if ( self::is_admin_edit_order_request() ) { + add_action( + 'woocommerce_process_shop_order_meta', + function( $order_id ) { + self::create_shipments( $order_id ); + }, + 70 + ); + } else { + if ( $args['allow_deferred_sync'] ) { + Package::log( 'Deferring order #' . $order_id . ' shipments sync' ); + + $queue = WC()->queue(); + $defer_args = array( + 'order_id' => $order_id, + ); + + /** + * Cancel outstanding events and queue new. + */ + self::cancel_deferred_sync( $defer_args ); + + $queue->schedule_single( + time() + 50, + 'woocommerce_gzd_shipments_order_auto_sync_callback', + $defer_args, + 'woocommerce-gzd-shipments-order-sync' + ); + } else { + self::create_shipments( $order_id ); + } + } + } + } + + public static function auto_sync_callback( $order_id ) { + /** + * Maybe cancel duplicate deferred syncs. + */ + self::cancel_deferred_sync( array( 'order_id' => $order_id ) ); + + Package::log( 'Starting order #' . $order_id . ' shipments sync (deferred)' ); + + self::create_shipments( $order_id ); + + return true; + } + + public static function maybe_create_subscription_shipments( $renewal_order ) { + self::maybe_create_shipments( $renewal_order->get_id() ); + + return $renewal_order; + } +} diff --git a/packages/woocommerce-germanized-shipments/src/CacheHelper.php b/packages/woocommerce-germanized-shipments/src/CacheHelper.php new file mode 100644 index 000000000..7be2abdfe --- /dev/null +++ b/packages/woocommerce-germanized-shipments/src/CacheHelper.php @@ -0,0 +1,75 @@ +set_date_created( time() ); + + $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 ] = $label->{'get_' . $prop}( 'edit' ) ? gmdate( 'Y-m-d H:i:s', $label->{'get_' . $prop}( 'edit' )->getOffsetTimestamp() ) : null; + $label_data[ 'label_' . $prop . '_gmt' ] = $label->{'get_' . $prop}( 'edit' ) ? gmdate( 'Y-m-d H:i:s', $label->{'get_' . $prop}( 'edit' )->getTimestamp() ) : null; + 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' => Package::is_valid_mysql_date( $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\Shipments\Labels\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, true ) ) { + 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(); // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query + } + + // 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..742a70d40 --- /dev/null +++ b/packages/woocommerce-germanized-shipments/src/DataStores/Packaging.php @@ -0,0 +1,783 @@ +set_date_created( time() ); + + $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_inner_length' => $packaging->get_inner_length(), + 'packaging_inner_width' => $packaging->get_inner_width(), + 'packaging_inner_height' => $packaging->get_inner_height(), + 'packaging_order' => $packaging->get_order(), + 'packaging_date_created' => $packaging->get_date_created( 'edit' ) ? gmdate( 'Y-m-d H:i:s', $packaging->get_date_created( 'edit' )->getOffsetTimestamp() ) : null, + 'packaging_date_created_gmt' => $packaging->get_date_created( 'edit' ) ? gmdate( 'Y-m-d H:i:s', $packaging->get_date_created( 'edit' )->getTimestamp() ) : null, + ); + + $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 ] = $packaging->{'get_' . $prop}( 'edit' ) ? gmdate( 'Y-m-d H:i:s', $packaging->{'get_' . $prop}( 'edit' )->getOffsetTimestamp() ) : null; + $packaging_data[ 'packaging_' . $prop . '_gmt' ] = $packaging->{'get_' . $prop}( 'edit' ) ? gmdate( 'Y-m-d H:i:s', $packaging->{'get_' . $prop}( 'edit' )->getTimestamp() ) : null; + } + 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, + 'inner_length' => $data->packaging_inner_length, + 'inner_width' => $data->packaging_inner_width, + 'inner_height' => $data->packaging_inner_height, + 'order' => $data->packaging_order, + 'date_created' => Package::is_valid_mysql_date( $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' ); + + $this->all_packaging = null; + $this->packaging_lookup = null; + } + + /* + |-------------------------------------------------------------------------- + | 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, true ) ) { + 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(); // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query + } + + // 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 ); + } + + /** + * @return \Vendidero\Germanized\Shipments\Packaging[] + */ + protected function get_all_packaging() { + global $wpdb; + + if ( is_null( $this->all_packaging ) ) { + $query = " + SELECT packaging_id FROM {$wpdb->gzd_packaging} + ORDER BY packaging_order ASC + "; + + // Get from cache if available. + $results = wp_cache_get( 'packaging-list', 'packaging' ); + + if ( false === $results ) { + $results = $wpdb->get_results( $query ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared + + wp_cache_set( 'packaging-list', $results, 'packaging' ); + } + + $all_packaging = array(); + $packaging_lookup = array(); + + foreach ( $results as $key => $packaging ) { + if ( $the_packaging = wc_gzd_get_packaging( $packaging ) ) { + $all_packaging[ $key ] = $the_packaging; + $packaging_lookup[ $the_packaging->get_id() ] = $key; + } + } + + $this->all_packaging = $all_packaging; + $this->packaging_lookup = $packaging_lookup; + } + + return $this->all_packaging; + } + + /** + * @param $args + * + * @return \Vendidero\Germanized\Shipments\Packaging[] + */ + public function get_packaging_list( $args = array() ) { + $the_list = $this->get_all_packaging(); + $all_types = array_keys( wc_gzd_get_packaging_types() ); + $args = wp_parse_args( + $args, + array( + 'type' => $all_types, + 'shipping_provider' => '', + ) + ); + + if ( ! is_array( $args['type'] ) ) { + $args['type'] = array_filter( array( $args['type'] ) ); + } + + $types = array_filter( wc_clean( $args['type'] ) ); + $types = empty( $types ) ? $all_types : $types; + + foreach ( $the_list as $key => $packaging ) { + if ( ! in_array( $packaging->get_type(), $types, true ) ) { + unset( $the_list[ $key ] ); + continue; + } + + if ( ! empty( $args['shipping_provider'] ) && ! $packaging->supports_shipping_provider( $args['shipping_provider'] ) ) { + unset( $the_list[ $key ] ); + } + } + + return array_values( $the_list ); + } + + /** + * @param \Vendidero\Germanized\Shipments\Shipment $shipment + * @param \Vendidero\Germanized\Shipments\Packaging|PackagingBox $packaging + * + * @return bool + */ + public function shipment_fits_into_packaging_naive( $shipment, $packaging ) { + if ( is_a( $packaging, '\Vendidero\Germanized\Shipments\Packing\PackagingBox' ) ) { + $packaging = $packaging->getReference(); + } + + if ( ! $packaging ) { + return false; + } + + if ( ! $packaging->supports_shipping_provider( $shipment->get_shipping_provider() ) ) { + return false; + } + + $weight = (float) wc_format_decimal( empty( $shipment->get_content_weight() ) ? 0 : wc_get_weight( $shipment->get_content_weight(), wc_gzd_get_packaging_weight_unit(), $shipment->get_weight_unit() ), 3 ); + $volume = (float) wc_format_decimal( empty( $shipment->get_content_volume() ) ? 0 : wc_gzd_get_volume_dimension( $shipment->get_content_volume(), wc_gzd_get_packaging_dimension_unit(), $shipment->get_dimension_unit() ), 1 ); + $fits = true; + + if ( $packaging->has_inner_dimensions() ) { + $packaging_volume = (float) $packaging->get_inner_length() * (float) $packaging->get_inner_width() * (float) $packaging->get_inner_height(); + } else { + $packaging_volume = (float) $packaging->get_length() * (float) $packaging->get_width() * (float) $packaging->get_height(); + } + + /** + * The packaging does not fit in case: + * - total weight is greater than it's maximum capability + * - the total volume is greater than the packaging volume + */ + if ( ! empty( $packaging->get_max_content_weight() ) && $weight > $packaging->get_max_content_weight() ) { + $fits = false; + } elseif ( $volume > $packaging_volume ) { + $fits = false; + } + + return $fits; + } + + /** + * @param \Vendidero\Germanized\Shipments\Shipment $shipment + * + * @return \Vendidero\Germanized\Shipments\Packaging[] + */ + public function find_available_packaging_for_shipment( $shipment ) { + $packaging_available = array(); + $items = $shipment->get_items_to_pack(); + $results = false; + + // Get from cache if available. + if ( $shipment->get_id() > 0 ) { + $results = wp_cache_get( 'available-packaging-' . $shipment->get_id(), 'shipments' ); + } + + if ( false === $results && count( $items ) > 0 ) { + $available_packaging_ids = array(); + + if ( Package::is_packing_supported() ) { + $packaging_list = $this->get_packaging_list( array( 'shipping_provider' => $shipment->get_shipping_provider() ) ); + + foreach ( $packaging_list as $packaging ) { + /** + * Make sure to only check naively fitting packaging to improve performance + */ + if ( ! $this->shipment_fits_into_packaging_naive( $shipment, $packaging ) ) { + continue; + } + + $box = new PackagingBox( $packaging ); + $item_count = count( $items ); + + $packer = new VolumePacker( $box, $items ); + $packed = $packer->pack(); + + if ( count( $packed->getItems() ) === $item_count ) { + $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() ), 3 ); + $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, + CASE + WHEN packaging_inner_length > 0 + THEN (packaging_inner_length - %f) + ELSE (packaging_length - %f) + END as length_diff, + CASE + WHEN packaging_inner_width > 0 + THEN (packaging_inner_width - %f) + ELSE (packaging_width - %f) + END as width_diff, + CASE + WHEN packaging_inner_height > 0 + THEN (packaging_inner_height - %f) + ELSE (packaging_height - %f) + END as height_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 (length_diff+width_diff+height_diff) ASC, packaging_weight ASC, packaging_order ASC + "; + + $query = $wpdb->prepare( $query_sql, $length, $length, $width, $width, $height, $height, $weight, $threshold, $threshold, $threshold ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared + $results = $wpdb->get_results( $query ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared + + if ( $results ) { + foreach ( $results as $result ) { + $packaging = wc_gzd_get_packaging( $result->packaging_id ); + + if ( ! $packaging->supports_shipping_provider( $shipment->get_shipping_provider() ) ) { + continue; + } + + $available_packaging_ids[] = $packaging->get_id(); + $packaging_available[] = $packaging; + } + } + } + + wp_cache_set( 'available-packaging-' . $shipment->get_id(), $available_packaging_ids, 'shipments' ); + } elseif ( count( $items ) <= 0 ) { + $packaging_available = $this->get_packaging_list(); + } else { + foreach ( (array) $results as $packaging_id ) { + $packaging = wc_gzd_get_packaging( $packaging_id ); + + if ( ! $packaging->supports_shipping_provider( $shipment->get_shipping_provider() ) ) { + continue; + } + + $packaging_available[] = $packaging; + } + } + + $packaging_list = apply_filters( 'woocommerce_gzd_find_available_packaging_for_shipment', $packaging_available, $shipment ); + + return $this->sort_packaging_list( $packaging_list ); + } + + 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]; + + /** + * In case more than one packaging is available - choose the default packaging in case it is available. + */ + if ( count( $results ) > 1 ) { + $default_packaging_id = Package::get_setting( 'default_packaging' ); + + if ( ! empty( $default_packaging_id ) ) { + $default_packaging_id = absint( $default_packaging_id ); + + foreach ( $results as $result ) { + if ( $result->get_id() === $default_packaging_id ) { + $packaging = $result; + break; + } + } + } + } + } + + 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..cf3cfa38c --- /dev/null +++ b/packages/woocommerce-germanized-shipments/src/DataStores/Shipment.php @@ -0,0 +1,712 @@ +set_date_created( time() ); + $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, true ) ) { + $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, true ) ) { + + 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 ] = $shipment->{'get_' . $prop}( 'edit' ) ? gmdate( 'Y-m-d H:i:s', $shipment->{'get_' . $prop}( 'edit' )->getOffsetTimestamp() ) : null; + $shipment_data[ 'shipment_' . $prop . '_gmt' ] = $shipment->{'get_' . $prop}( 'edit' ) ? gmdate( 'Y-m-d H:i:s', $shipment->{'get_' . $prop}( 'edit' )->getTimestamp() ) : null; + } + 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' => Package::is_valid_mysql_date( $data->shipment_date_created_gmt ) ? wc_string_to_timestamp( $data->shipment_date_created_gmt ) : null, + 'date_sent' => Package::is_valid_mysql_date( $data->shipment_date_sent_gmt ) ? wc_string_to_timestamp( $data->shipment_date_sent_gmt ) : null, + 'est_delivery_date' => Package::is_valid_mysql_date( $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, true ) ) { + 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' ), true ) && ! $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(); // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query + } + + // 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 ) ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared + } +} 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..84dd9af1a --- /dev/null +++ b/packages/woocommerce-germanized-shipments/src/DataStores/ShipmentItem.php @@ -0,0 +1,355 @@ +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, true ) ) { + 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; + + $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..73dc56928 --- /dev/null +++ b/packages/woocommerce-germanized-shipments/src/DataStores/ShippingProvider.php @@ -0,0 +1,492 @@ +set_name( $this->get_unqiue_name( $provider ) ); + + if ( 0 === $provider->get_order( 'edit' ) ) { + $max_order = 1; + $max_order_col = $wpdb->get_col( "SELECT MAX(shipping_provider_order) FROM {$wpdb->gzd_shipping_provider}" ); + + if ( ! empty( $max_order_col ) ) { + $max_order = absint( $max_order_col[0] ) + 1; + } + + $provider->set_order( $max_order ); + } + + $data = array( + 'shipping_provider_activated' => $provider->is_activated() ? 1 : 0, + 'shipping_provider_name' => $provider->get_name( 'edit' ), + 'shipping_provider_title' => $provider->get_title( 'edit' ), + 'shipping_provider_order' => $provider->get_order( '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() ) ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared + + if ( $provider_name_check || ( $this->is_manual_creation_request() && $this->is_reserved_name( $slug ) ) ) { + $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() ) ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared + $suffix++; + } while ( $provider_name_check || ( $this->is_manual_creation_request() && $this->is_reserved_name( $alt_provider_name ) ) ); + $slug = $alt_provider_name; + } + + return $slug; + } + + protected function is_manual_creation_request() { + return apply_filters( 'woocommerce_gzd_shipments_shipping_provider_is_manual_creation_request', false ); + } + + protected function is_reserved_name( $name ) { + $reserved_names = array( + 'dhl', + 'deutsche_post', + 'dpd', + 'gls', + 'ups', + 'hermes', + ); + + return apply_filters( 'woocommerce_gzd_shipments_shipping_provider_is_reserved_name', in_array( $name, $reserved_names, true ) ); + } + + /** + * 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, + 'order' => $data->shipping_provider_order, + ) + ); + + $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' ) ); + } + } + + public function is_activated( $name ) { + global $wpdb; + + $data = $wpdb->get_row( + $wpdb->prepare( + "SELECT shipping_provider_activated FROM {$wpdb->gzd_shipping_provider} WHERE shipping_provider_name = %s LIMIT 1", + $name + ) + ); + + if ( $data ) { + return wc_string_to_bool( $data->shipping_provider_activated ); + } + + return false; + } + + /** + * 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, true ) ) { + 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 ORDER BY shipping_provider_order ASC" ); + $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..8523de1e0 --- /dev/null +++ b/packages/woocommerce-germanized-shipments/src/Emails.php @@ -0,0 +1,229 @@ +id ), $email ) ) ) { + if ( $shipments_order = wc_gzd_get_shipment_order( $order ) ) { + $template = $plain_text ? 'plain/email-order-shipments.php' : 'email-order-shipments.php'; + + wc_get_template( + 'emails/' . $template, + array( + 'shipments' => $shipments_order->get_simple_shipments( true ), + 'sent_to_admin' => $sent_to_admin, + 'plain_text' => $plain_text, + 'email' => $email, + ) + ); + } + } + } + + public static function set_woocommerce_template_dir( $dir, $template ) { + if ( file_exists( Package::get_path() . '/templates/' . $template ) ) { + return 'woocommerce-germanized'; + } + + return $dir; + } + + public static function register_emails( $emails ) { + $emails['WC_GZD_Email_Customer_Shipment'] = include Package::get_path() . '/includes/emails/class-wc-gzd-email-customer-shipment.php'; + $emails['WC_GZD_Email_Customer_Return_Shipment'] = include Package::get_path() . '/includes/emails/class-wc-gzd-email-customer-return-shipment.php'; + $emails['WC_GZD_Email_Customer_Return_Shipment_Delivered'] = include Package::get_path() . '/includes/emails/class-wc-gzd-email-customer-return-shipment-delivered.php'; + $emails['WC_GZD_Email_Customer_Guest_Return_Shipment_Request'] = include Package::get_path() . '/includes/emails/class-wc-gzd-email-customer-guest-return-shipment-request.php'; + $emails['WC_GZD_Email_New_Return_Shipment_Request'] = include Package::get_path() . '/includes/emails/class-wc-gzd-email-new-return-shipment-request.php'; + + return $emails; + } + + public static function email_hooks() { + add_action( 'woocommerce_gzd_email_shipment_details', array( __CLASS__, 'email_return_instructions' ), 5, 4 ); + add_action( 'woocommerce_gzd_email_shipment_details', array( __CLASS__, 'email_tracking' ), 10, 4 ); + add_action( 'woocommerce_gzd_email_shipment_details', array( __CLASS__, 'email_address' ), 20, 4 ); + add_action( 'woocommerce_gzd_email_shipment_details', array( __CLASS__, 'email_details' ), 30, 4 ); + } + + public static function register_email_notifications( $actions ) { + $actions = array_merge( + $actions, + array( + 'woocommerce_gzd_shipment_status_draft_to_processing', + 'woocommerce_gzd_shipment_status_draft_to_shipped', + 'woocommerce_gzd_shipment_status_draft_to_delivered', + 'woocommerce_gzd_shipment_status_processing_to_shipped', + 'woocommerce_gzd_shipment_status_processing_to_delivered', + 'woocommerce_gzd_shipment_status_shipped_to_delivered', + 'woocommerce_gzd_return_shipment_status_draft_to_processing', + 'woocommerce_gzd_return_shipment_status_draft_to_shipped', + 'woocommerce_gzd_return_shipment_status_draft_to_delivered', + 'woocommerce_gzd_return_shipment_status_draft_to_requested', + 'woocommerce_gzd_return_shipment_status_processing_to_shipped', + 'woocommerce_gzd_return_shipment_status_processing_to_delivered', + 'woocommerce_gzd_return_shipment_status_shipped_to_delivered', + 'woocommerce_gzd_return_shipment_status_requested_to_processing', + 'woocommerce_gzd_return_shipment_status_requested_to_shipped', + ) + ); + + return $actions; + } + + /** + * @param Shipment $shipment + * @param bool $sent_to_admin + * @param bool $plain_text + * @param string $email + */ + public static function email_return_instructions( $shipment, $sent_to_admin = false, $plain_text = false, $email = '' ) { + + if ( 'return' !== $shipment->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 ( is_a( $shipment, 'Vendidero\Germanized\Shipments\ReturnShipment' ) ) { + if ( $shipment->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..4881a7460 --- /dev/null +++ b/packages/woocommerce-germanized-shipments/src/FormHandler.php @@ -0,0 +1,337 @@ +' . _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_successful', $order ); + + } catch ( Exception $e ) { + wc_add_notice( $e->getMessage(), 'error' ); + do_action( 'woocommerce_gzd_return_request_failed' ); + } + } + } + + /** + * @param $order_id + * @param $email + * + * @return false|integer + */ + public static function find_order( $order_id, $email ) { + $order_id_parsed = self::get_order_id_from_string( $order_id ); + $db_order_id = false; + $orders = wc_get_orders( + apply_filters( + 'woocommerce_gzd_return_request_order_query_args', + array( + 'billing_email' => $email, + 'post__in' => array( $order_id_parsed ), + 'limit' => 1, + 'return' => 'ids', + ) + ) + ); + + // Now lets try to find the order by a custom order number field + if ( empty( $orders ) ) { + add_filter( 'woocommerce_order_data_store_cpt_get_orders_query', array( __CLASS__, 'filter_query_by_order_number' ), 10, 2 ); + + $orders = wc_get_orders( + apply_filters( + 'woocommerce_gzd_return_request_alternate_order_query_args', + array( + 'billing_email' => $email, + 'order_number' => $order_id, + 'limit' => 1, + 'return' => 'ids', + ) + ) + ); + + remove_filter( 'woocommerce_order_data_store_cpt_get_orders_query', array( __CLASS__, 'filter_query_by_order_number' ), 10 ); + } + + if ( ! empty( $orders ) ) { + $db_order_id = $orders[0]; + } + + return apply_filters( 'woocommerce_gzd_shipments_valid_order_for_return_request', $db_order_id, $order_id, $email ); + } + + public static function filter_query_by_order_number( $query, $query_vars ) { + $meta_field_name = apply_filters( 'woocommerce_gzd_return_request_customer_order_number_meta_key', '_order_number' ); + + if ( ! empty( $query_vars['order_number'] ) ) { + $query['meta_query'][] = array( + 'key' => $meta_field_name, + 'value' => esc_attr( wc_clean( $query_vars['order_number'] ) ), + 'compare' => '=', + ); + } + + return $query; + } + + /** + * 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'] ) ? wp_unslash( $_REQUEST['add-return-shipment-nonce'] ) : ''; // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized + + 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( esc_url_raw( $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..802c9b383 --- /dev/null +++ b/packages/woocommerce-germanized-shipments/src/Install.php @@ -0,0 +1,561 @@ + $value, + ); + } elseif ( 'label_ident_min_age' === $setting_name ) { + $service_name = 'IdentCheck'; + $services[ $service_name ] = 'yes'; + + $service_meta[ $service_name ] = array( + 'min_age' => $value, + ); + } elseif ( 'label_auto_inlay_return_label' === $setting_name ) { + if ( 'no' !== $value ) { + $services['dhlRetoure'] = 'yes'; + } + } + } + + return array( + 'products' => $products, + 'services' => $services, + 'service_meta' => $service_meta, + ); + } + + /** + * @param array $config_set_data + * @param ConfigurationSetTrait $handler + * @param ShippingProvider $provider + * @param string $shipment_type + * + * @return boolean + * @throws \Exception + */ + protected static function create_configuration_set_from_migration_data( $config_set_data, $handler, $provider, $shipment_type = 'simple' ) { + foreach ( $config_set_data['products'] as $zone => $product ) { + $config_set = $handler->get_or_create_configuration_set( + array( + 'shipping_provider_name' => $provider->get_name(), + 'shipment_type' => $shipment_type, + 'zone' => $zone, + ) + ); + + $config_set->update_product( $product ); + + foreach ( $config_set_data['services'] as $service_name => $value ) { + if ( $p_service = $provider->get_service( $service_name ) ) { + if ( $p_service->supports( + array( + 'product_id' => $product, + 'zone' => $zone, + 'shipment_type' => 'simple', + ) + ) ) { + $config_set->update_service( $service_name, $value ); + + if ( array_key_exists( $service_name, $config_set_data['service_meta'] ) ) { + foreach ( $config_set_data['service_meta'][ $service_name ] as $k => $v ) { + $config_set->update_service_meta( $service_name, $k, $v ); + } + } + } + } + } + } + + return true; + } + + public static function migrate_to_configuration_sets( $providers_to_migrate = array() ) { + $providers = empty( $providers_to_migrate ) ? Helper::instance()->get_shipping_providers() : (array) $providers_to_migrate; + $provider_ids = array(); + + foreach ( $providers as $provider ) { + if ( ! is_a( $provider, '\Vendidero\Germanized\Shipments\Interfaces\ShippingProvider' ) ) { + $provider = wc_gzd_get_shipping_provider( $provider ); + } + + if ( is_a( $provider, '\Vendidero\Germanized\Shipments\ShippingProvider\Auto' ) && $provider->is_activated() ) { + $provider_ids[] = $provider->get_id(); + + if ( is_callable( array( $provider, 'get_configuration_sets' ) ) ) { + $config_data = array(); + + foreach ( $provider->get_meta_data() as $meta ) { + $setting_name = $meta->key; + $value = $meta->value; + + if ( 'label_default_page_format' === $setting_name ) { + $provider->set_label_print_format( $value ); + } else { + $config_data = array_replace_recursive( $config_data, self::get_configuration_set_data( $setting_name, $value ) ); + } + } + + if ( isset( $config_data['products'] ) ) { + self::create_configuration_set_from_migration_data( $config_data, $provider, $provider ); + } + + $provider->save(); + } + } + } + + // Make sure shipping zones are loaded + include_once WC_ABSPATH . 'includes/class-wc-shipping-zones.php'; + + foreach ( \WC_Shipping_Zones::get_zones() as $zone_data ) { + if ( $zone = \WC_Shipping_Zones::get_zone( $zone_data['id'] ) ) { + foreach ( $zone->get_shipping_methods() as $method ) { + if ( $shipment_method = MethodHelper::get_provider_method( $method ) ) { + if ( $shipment_method->is_placeholder() || ! $shipment_method->get_method()->supports( 'instance-settings' ) ) { + continue; + } + + $shipment_method->get_method()->init_instance_settings(); + + $settings = $shipment_method->get_method()->instance_settings; + + if ( isset( $settings['configuration_sets'] ) && ! empty( $settings['configuration_sets'] ) ) { + continue; + } + + if ( isset( $settings['shipping_provider'] ) && ! empty( $settings['shipping_provider'] ) ) { + $provider_name = $settings['shipping_provider']; + + if ( $provider = wc_gzd_get_shipping_provider( $provider_name ) ) { + if ( ! in_array( $provider->get_id(), $provider_ids, true ) ) { + continue; + } + + $settings_prefix = "{$provider_name}_"; + $config_data = array(); + + foreach ( $settings as $setting_name => $value ) { + if ( substr( $setting_name, 0, strlen( $settings_prefix ) ) === $settings_prefix ) { + $setting_name = substr( $setting_name, strlen( $settings_prefix ) ); + $config_data = array_replace_recursive( $config_data, self::get_configuration_set_data( $setting_name, $value ) ); + } + } + + if ( isset( $config_data['products'] ) ) { + self::create_configuration_set_from_migration_data( $config_data, $shipment_method, $provider ); + + $configuration_sets = $shipment_method->get_configuration_sets(); + + if ( ! empty( $configuration_sets ) ) { + $current_settings = $shipment_method->get_method()->instance_settings; + + if ( ! empty( $current_settings ) ) { + update_option( $shipment_method->get_method()->get_instance_option_key(), apply_filters( 'woocommerce_shipping_' . $shipment_method->get_method()->id . '_instance_settings_values', $current_settings, $shipment_method->get_method() ), 'yes' ); + } + } + } + } + } + } + } + } + } + } + + private static function update_providers() { + $providers = Helper::instance()->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' => 32.4, + 'width' => 22.9, + '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; + + $current_version = get_option( 'woocommerce_gzd_shipments_version', null ); + $current_db_version = self::get_db_version(); + + /** + * Make possible duplicate names unique. + */ + if ( null !== $current_version && isset( $wpdb->gzd_shipping_provider ) ) { + $providers = $wpdb->get_results( "SELECT * FROM $wpdb->gzd_shipping_provider" ); + $shipping_providers = array(); + + foreach ( $providers as $provider ) { + if ( in_array( $provider->shipping_provider_name, $shipping_providers, true ) ) { + $unique_provider_name = sanitize_title( $provider->shipping_provider_name . '_' . wp_generate_password( 4, false, false ) ); + + $wpdb->update( + $wpdb->gzd_shipping_provider, + array( + 'shipping_provider_name' => $unique_provider_name, + ), + array( 'shipping_provider_id' => $provider->shipping_provider_id ) + ); + } else { + $shipping_providers[] = $provider->shipping_provider_name; + } + } + } + + $wpdb->hide_errors(); + require_once ABSPATH . 'wp-admin/includes/upgrade.php'; + $db_delta_result = dbDelta( self::get_schema() ); + + /** + * Update MySQL datetime default to NULL for MySQL 8 compatibility. + */ + if ( ! empty( $current_db_version ) && version_compare( $current_db_version, '2.3.0', '<' ) ) { + $date_fields = array( + "{$wpdb->prefix}woocommerce_gzd_shipments" => array( + 'shipment_date_created', + 'shipment_date_created_gmt', + 'shipment_date_sent', + 'shipment_date_sent_gmt', + 'shipment_est_delivery_date', + 'shipment_est_delivery_date_gmt', + ), + "{$wpdb->prefix}woocommerce_gzd_shipment_labels" => array( + 'label_date_created', + 'label_date_created_gmt', + ), + "{$wpdb->prefix}woocommerce_gzd_packaging" => array( + 'packaging_date_created', + 'packaging_date_created_gmt', + ), + ); + + foreach ( $date_fields as $table => $columns ) { + foreach ( $columns as $column ) { + $result = $wpdb->query( "ALTER TABLE `$table` CHANGE $column $column datetime DEFAULT NULL;" ); // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared + + if ( true !== $result ) { + $db_delta_result = false; + Package::log( sprintf( 'Error while updating datetime field in %s for column %s', $table, $column ), 'error' ); + } + } + } + } + + return $db_delta_result; + } + + private static function create_upload_dir() { + Package::maybe_set_upload_dir(); + + $dir = Package::get_upload_dir(); + + if ( ! @is_dir( $dir['basedir'] ) ) { // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged + @mkdir( $dir['basedir'] ); // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged + } + + if ( ! file_exists( trailingslashit( $dir['basedir'] ) . '.htaccess' ) ) { + @file_put_contents( trailingslashit( $dir['basedir'] ) . '.htaccess', 'deny from all' ); // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged,WordPress.WP.AlternativeFunctions.file_system_read_file_put_contents + } + + if ( ! file_exists( trailingslashit( $dir['basedir'] ) . 'index.php' ) ) { + @touch( trailingslashit( $dir['basedir'] ) . 'index.php' ); // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged + } + } + + private static function get_schema() { + global $wpdb; + + $collate = ''; + + if ( $wpdb->has_cap( 'collation' ) ) { + $collate = $wpdb->get_charset_collate(); + } + + /** + * Use a varchar(191) for shipping_provider_name as the key length might overflow max key length for older MySQL (< 5.7). + * @see https://stackoverflow.com/a/31474509 + */ + $tables = " +CREATE TABLE {$wpdb->prefix}woocommerce_gzd_shipment_items ( + shipment_item_id bigint(20) unsigned NOT NULL auto_increment, + shipment_id bigint(20) unsigned NOT NULL, + shipment_item_name text NOT NULL, + shipment_item_order_item_id bigint(20) unsigned NOT NULL, + shipment_item_product_id bigint(20) unsigned NOT NULL, + shipment_item_parent_id bigint(20) unsigned NOT NULL, + shipment_item_quantity smallint(4) 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(20) unsigned NOT NULL auto_increment, + gzd_shipment_item_id bigint(20) 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(20) unsigned NOT NULL auto_increment, + shipment_date_created datetime default NULL, + shipment_date_created_gmt datetime default NULL, + 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(20) unsigned NOT NULL DEFAULT 0, + shipment_packaging_id bigint(20) unsigned NOT NULL DEFAULT 0, + shipment_parent_id bigint(20) 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(20) unsigned NOT NULL auto_increment, + label_date_created datetime default NULL, + label_date_created_gmt datetime default NULL, + label_shipment_id bigint(20) unsigned NOT NULL, + label_parent_id bigint(20) 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(20) unsigned NOT NULL auto_increment, + gzd_shipment_label_id bigint(20) 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(20) unsigned NOT NULL auto_increment, + gzd_shipment_id bigint(20) 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(20) unsigned NOT NULL auto_increment, + packaging_date_created datetime default NULL, + packaging_date_created_gmt datetime default NULL, + 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(20) 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, + packaging_inner_length decimal(6,2) unsigned NOT NULL DEFAULT 0, + packaging_inner_width decimal(6,2) unsigned NOT NULL DEFAULT 0, + packaging_inner_height decimal(6,2) unsigned NOT NULL DEFAULT 0, + PRIMARY KEY (packaging_id) +) $collate; +CREATE TABLE {$wpdb->prefix}woocommerce_gzd_packagingmeta ( + meta_id bigint(20) unsigned NOT NULL auto_increment, + gzd_packaging_id bigint(20) 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(20) unsigned NOT NULL auto_increment, + shipping_provider_activated tinyint(1) NOT NULL default 1, + shipping_provider_order smallint(10) NOT NULL DEFAULT 0, + shipping_provider_title varchar(200) NOT NULL DEFAULT '', + shipping_provider_name varchar(191) NOT NULL DEFAULT '', + PRIMARY KEY (shipping_provider_id), + UNIQUE KEY shipping_provider_name (shipping_provider_name) +) $collate; +CREATE TABLE {$wpdb->prefix}woocommerce_gzd_shipping_providermeta ( + meta_id bigint(20) unsigned NOT NULL auto_increment, + gzd_shipping_provider_id bigint(20) 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/LabelConfigurationSet.php b/packages/woocommerce-germanized-shipments/src/Interfaces/LabelConfigurationSet.php new file mode 100644 index 000000000..d0897a9e6 --- /dev/null +++ b/packages/woocommerce-germanized-shipments/src/Interfaces/LabelConfigurationSet.php @@ -0,0 +1,39 @@ +shipment; + + if ( ! $shipment->has_label() && $shipment->needs_label( false ) ) { + if ( $provider = $shipment->get_shipping_provider_instance() ) { + $auto_status = str_replace( 'gzd-', '', $provider->get_label_automation_shipment_status( $shipment ) ); + + if ( $provider->automatically_generate_label( $shipment ) && $auto_status === $shipment->get_status() ) { + self::cancel_deferred_sync( array( 'shipment_id' => $shipment->get_id() ) ); + self::create_label( $shipment->get_id(), $shipment ); + + if ( $shipment->has_label() ) { + $label = $shipment->get_label(); + + if ( $file = $label->get_file() ) { + $attachments[] = $file; + } + } + } + } + } + } + + return $attachments; + } + + public static function auto_sync_callback( $shipment_id ) { + /** + * Maybe cancel duplicate deferred syncs. + */ + self::cancel_deferred_sync( array( 'shipment_id' => $shipment_id ) ); + + Package::log( 'Starting shipment #' . $shipment_id . ' label sync (deferred)' ); + + self::create_label( $shipment_id ); + + return true; + } + + public static function cancel_deferred_sync( $args ) { + $queue = WC()->queue(); + + /** + * Cancel outstanding events and queue new. + */ + $queue->cancel_all( 'woocommerce_gzd_shipments_label_auto_sync_callback', $args, 'woocommerce-gzd-shipments-label-sync' ); + } + + /** + * @param Shipment $shipment + */ + public static function maybe_adjust_shipment_status( $shipment ) { + if ( $provider = $shipment->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::init_automation( $shipment, array( 'is_hook' => false ) ); + } + + /** + * @param Shipment $shipment + * @param boolean $is_hook + */ + protected static function init_automation( $shipment, $args = array() ) { + $label_type = ( 'return' === $shipment->get_type() ? 'return_label' : 'label' ); + + $args = wp_parse_args( + $args, + array( + 'is_hook' => true, + 'allow_deferred_sync' => wc_gzd_shipments_allow_deferred_sync( $label_type ), + ) + ); + + $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 ( $args['is_hook'] ) { + add_action( + $hook_prefix . $status, + function( $shipment_id, $shipment ) use ( $args ) { + self::maybe_create_label( $shipment_id, $shipment, $args ); + }, + 5, + 2 + ); + } elseif ( $shipment->has_status( $status ) ) { + self::maybe_create_label( $shipment->get_id(), $shipment, $args ); + } + } + } + } + + /** + * @param $shipment_id + * @param Shipment $shipment + */ + public static function set_automation( $shipment_id, $shipment ) { + self::init_automation( $shipment ); + } + + 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 ) ) { + $result = wc_gzd_get_shipment_error( $result ); + } + + if ( is_wp_error( $result ) ) { + if ( $result->is_soft_error() ) { + Package::log( sprintf( 'Info while automatically creating label for %1$s: %2$s', $shipment->get_shipment_number(), wc_print_r( $result->get_error_messages(), true ) ) ); + } else { + 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 ) ) ); + } + } + } + } + + protected static function maybe_create_label( $shipment_id, $shipment = false, $args = array() ) { + $args = wp_parse_args( + $args, + array( + 'allow_deferred_sync' => wc_gzd_shipments_allow_deferred_sync( 'label' ), + ) + ); + + $defer_args = array( + 'shipment_id' => $shipment_id, + ); + + /** + * Cancel outstanding events and queue new. + */ + self::cancel_deferred_sync( $defer_args ); + + /** + * In case the shipment has automatically been created within the same request + * and is already marked as shipped (e.g. due to default status set to shipped) + * make sure to prevent a deferred sync as the label would not get attached to the email. + */ + if ( $the_shipment = wc_gzd_get_shipment( $shipment_id ) ) { + if ( $the_shipment->has_status( 'shipped' ) ) { + $args['allow_deferred_sync'] = false; + } + } + + if ( $args['allow_deferred_sync'] ) { + Package::log( 'Deferring shipment #' . $shipment_id . ' label sync' ); + $queue = WC()->queue(); + + $queue->schedule_single( + time() + 50, + 'woocommerce_gzd_shipments_label_auto_sync_callback', + $defer_args, + 'woocommerce-gzd-shipments-label-sync' + ); + } else { + self::create_label( $shipment_id, $shipment ); + } + } +} diff --git a/packages/woocommerce-germanized-shipments/src/Labels/ConfigurationSet.php b/packages/woocommerce-germanized-shipments/src/Labels/ConfigurationSet.php new file mode 100644 index 000000000..299ab0d10 --- /dev/null +++ b/packages/woocommerce-germanized-shipments/src/Labels/ConfigurationSet.php @@ -0,0 +1,390 @@ + '', + 'shipment_type' => 'simple', + 'setting_type' => 'shipping_provider', + 'zone' => 'dom', + 'product' => '', + 'services' => array(), + 'additional' => array(), + ) + ); + + $this->handler = is_a( $handler, '\Vendidero\Germanized\Shipments\Interfaces\LabelConfigurationSet' ) ? $handler : null; + $this->shipment_type = $args['shipment_type']; + $this->setting_type = $args['setting_type']; + $this->zone = $args['zone']; + + $this->product = $args['product']; + $this->services = $args['services']; + $this->additional = $args['additional']; + + if ( is_a( $args['shipping_provider_name'], '\Vendidero\Germanized\Shipments\Interfaces\ShippingProvider' ) ) { + $this->shipping_provider = $args['shipping_provider_name']; + $this->shipping_provider_name = $this->shipping_provider->get_name(); + } else { + $this->shipping_provider_name = $args['shipping_provider_name']; + } + } + + public function get_id() { + return "-p-{$this->get_shipping_provider_name()}-s-{$this->get_shipment_type()}-z-{$this->get_zone()}"; + } + + /** + * @return null|LabelConfigurationSet + */ + public function get_handler() { + return $this->handler; + } + + /** + * @param LabelConfigurationSet|null $handler + */ + public function set_handler( $handler ) { + $this->handler = $handler; + } + + public function get_shipping_provider_name() { + return $this->shipping_provider_name; + } + + public function get_setting_type() { + return $this->setting_type; + } + + public function set_shipping_provider_name( $provider_name ) { + $this->shipping_provider_name = $provider_name; + $this->shipping_provider = null; + } + + public function get_shipping_provider() { + if ( is_null( $this->shipping_provider ) ) { + $this->shipping_provider = wc_gzd_get_shipping_provider( $this->get_shipping_provider_name() ); + } + + return $this->shipping_provider; + } + + public function get_product() { + return $this->product; + } + + public function get_zone() { + return $this->zone; + } + + public function set_zone( $zone ) { + $this->zone = $zone; + } + + public function set_setting_type( $type ) { + $this->setting_type = $type; + } + + public function get_shipment_type() { + return $this->shipment_type; + } + + public function set_shipment_type( $type ) { + $this->shipment_type = $type; + } + + protected function get_all_services() { + if ( is_null( $this->all_services ) ) { + $this->all_services = wp_list_pluck( wp_list_filter( wp_list_filter( $this->services, array( 'value' => 'no' ), 'NOT' ), array( 'value' => '' ), 'NOT' ), 'name' ); + } + + return $this->all_services; + } + + public function get_services() { + return array_values( $this->get_all_services() ); + } + + public function get_service_id( $name ) { + if ( array_key_exists( $name, $this->services ) ) { + return $name; + } else { + if ( $key = array_search( $name, $this->get_all_services(), true ) ) { + return $key; + } + } + + return $name; + } + + public function update_product( $value ) { + $this->product = $value; + $this->update(); + } + + protected function current_product_supports_service( $id ) { + $supports_service = true; + + if ( $shipping_provider = $this->get_shipping_provider() ) { + if ( $service = $shipping_provider->get_service( $id ) ) { + if ( ! $service->supports_product( $this->get_product() ) ) { + $supports_service = false; + } + } + } + + return $supports_service; + } + + public function update_service( $id, $value, $service_name = '' ) { + if ( empty( $service_name ) ) { + $service_name = array_key_exists( $id, $this->services ) ? $this->services[ $id ]['name'] : $id; + } + + if ( ! $this->current_product_supports_service( $id ) ) { + return; + } + + if ( in_array( $value, array( true, false, 'true', 'false', 'yes', 'no' ), true ) ) { + $value = wc_bool_to_string( $value ); + } + + $this->services[ $id ] = array( + 'id' => $id, + 'name' => $service_name, + 'value' => $value, + ); + + $this->all_services = null; + + $this->update(); + } + + public function update_service_meta( $service_id, $meta_key, $value ) { + if ( $this->has_service( $service_id ) ) { + $this->update_setting( $service_id . '_' . $meta_key, $value, 'additional' ); + } + } + + public function has_service( $service ) { + if ( $service_id = $this->get_service_id( $service ) ) { + $service = $service_id; + } + + return in_array( $service, $this->get_all_services(), true ) ? true : false; + } + + public function get_service( $service ) { + if ( $service_id = $this->get_service_id( $service ) ) { + $service = $service_id; + } + + if ( array_key_exists( $service, $this->services ) ) { + return wp_parse_args( + $this->services[ $service ], + array( + 'id' => '', + 'name' => '', + 'value' => null, + ) + ); + } + + return false; + } + + public function get_service_meta( $service_id, $meta_key, $default_value = null ) { + $additional_id = $service_id . '_' . $meta_key; + + return array_key_exists( $additional_id, $this->additional ) ? $this->additional[ $additional_id ] : $default_value; + } + + public function get_service_value( $service, $default = null ) { + if ( $service_id = $this->get_service_id( $service ) ) { + $service = $service_id; + } + + return array_key_exists( $service, $this->services ) ? $this->services[ $service ]['value'] : $default; + } + + public function get_settings() { + if ( is_null( $this->settings ) ) { + $this->settings = array_merge( array( 'product' => $this->product ), wp_list_pluck( $this->services, 'value' ), $this->additional ); + } + + return $this->settings; + } + + public function get_setting_id( $setting_name, $group = '' ) { + if ( 'label_config_set_' === substr( $setting_name, 0, 17 ) ) { + $setting_name = self::get_clean_setting_id( $setting_name ); + } + + if ( 'product' === $setting_name ) { + $group = 'product'; + } elseif ( empty( $group ) ) { + $group = 'additional'; + } + + $setting_id = "label_config_set_{$this->get_id()}-g-{$group}-n-{$setting_name}"; + + return $setting_id; + } + + protected function get_clean_setting_id( $id ) { + $id = strrpos( $id, '-' ) !== false ? substr( $id, strrpos( $id, '-n-' ) + 3 ) : $id; + + return $id; + } + + protected function get_setting_details( $id ) { + $default_args = array( + 'suffix' => $id, + 'group' => '', + 'service_meta' => '', + ); + + $args = Package::extract_args_from_id( $id ); + + if ( ! empty( $args['setting_name'] ) ) { + $default_args['suffix'] = $args['setting_name']; + $default_args['group'] = $args['setting_group']; + $default_args['service_meta'] = $args['meta']; + } + + return $default_args; + } + + public function has_setting( $id ) { + $details = $this->get_setting_details( $id ); + $id = $this->get_clean_setting_id( $id ); + + if ( 'service_meta' === $details['group'] && ! empty( $details['service_meta'] ) ) { + $id = $details['suffix'] . '_' . $details['service_meta']; + } + + $all_settings = $this->get_settings(); + $the_setting = array_key_exists( $id, $all_settings ) ? $all_settings[ $id ] : null; + + if ( 'product' === $id && '' === $the_setting ) { + return false; + } elseif ( ! is_null( $the_setting ) ) { + return true; + } + + return false; + } + + public function get_setting( $id, $default = null, $group = '' ) { + $details = $this->get_setting_details( $id ); + $settings = $this->get_settings(); + + if ( '' === $group && ! empty( $details['group'] ) ) { + $group = $details['group']; + $id = $details['suffix']; + } + + if ( 'service_meta' === $group && ! empty( $details['service_meta'] ) ) { + return $this->get_service_meta( $id, $details['service_meta'], $default ); + } else { + $setting_id = $this->get_clean_setting_id( $id ); + + if ( $this->has_setting( $setting_id ) ) { + return $settings[ $setting_id ]; + } + } + + return $default; + } + + public function update_setting( $id, $value, $group = '' ) { + $details = $this->get_setting_details( $id ); + + if ( '' === $group && ! empty( $details['group'] ) ) { + $group = $details['group']; + $id = $details['suffix']; + } + + if ( ! empty( $group ) ) { + if ( 'product' === $group ) { + $this->update_product( $value ); + } elseif ( 'service' === $group ) { + $this->update_service( $id, $value ); + } elseif ( 'service_meta' === $group && ! empty( $details['service_meta'] ) ) { + $this->update_service_meta( $id, $details['service_meta'], $value ); + } elseif ( 'additional' === $group ) { + $this->update_additional( $id, $value ); + } + } elseif ( 'product' === $id ) { + $this->update_product( $value ); + } elseif ( array_key_exists( $id, $this->services ) ) { + $this->update_service( $id, $value ); + } elseif ( array_key_exists( $id, $this->additional ) ) { + $this->update_additional( $id, $value ); + } + } + + public function update_additional( $key, $value ) { + $this->additional[ $key ] = $value; + $this->update(); + } + + protected function update() { + if ( $handler = $this->get_handler() ) { + $handler->update_configuration_set( $this ); + } + + $this->settings = null; + } + + public function get_data() { + return array( + 'product' => $this->product, + 'services' => $this->services, + 'additional' => $this->additional, + 'shipment_type' => $this->get_shipment_type(), + 'shipping_provider_name' => $this->get_shipping_provider_name(), + 'zone' => $this->get_zone(), + 'setting_type' => $this->get_setting_type(), + ); + } +} diff --git a/packages/woocommerce-germanized-shipments/src/Labels/ConfigurationSetTrait.php b/packages/woocommerce-germanized-shipments/src/Labels/ConfigurationSetTrait.php new file mode 100644 index 000000000..82940e0bb --- /dev/null +++ b/packages/woocommerce-germanized-shipments/src/Labels/ConfigurationSetTrait.php @@ -0,0 +1,246 @@ +get_prop( 'configuration_sets', $context ); + } + + protected function get_configuration_set_default_args( $args ) { + if ( is_array( $args ) ) { + $args = wp_parse_args( + $args, + array( + 'shipping_provider_name' => is_a( $this, '\Vendidero\Germanized\Shipments\Interfaces\ShippingProvider' ) ? $this->get_name() : '', + 'shipment_type' => 'simple', + 'zone' => 'dom', + 'setting_type' => $this->get_configuration_set_setting_type(), + ) + ); + } elseif ( is_a( $args, 'Vendidero\Germanized\Shipments\Shipment' ) ) { + $args = wp_parse_args( + $args, + array( + 'shipping_provider_name' => $args->get_shipping_provider(), + 'shipment_type' => $args->get_type(), + 'zone' => $args->get_shipping_zone(), + 'setting_type' => $this->get_configuration_set_setting_type(), + ) + ); + } else { + $args = $this->get_configuration_set_args_by_id( $args ); + } + + return $args; + } + + protected function get_configuration_set_id( $args ) { + $args = $this->get_configuration_set_default_args( $args ); + $set_id = ''; + + if ( ! empty( $args['shipping_provider_name'] ) ) { + $set_id = '-p-' . $args['shipping_provider_name']; + } + + $set_id = "{$set_id}-s-{$args['shipment_type']}-z-{$args['zone']}"; + + return $set_id; + } + + public function get_configuration_set_args_by_id( $id ) { + return Package::extract_args_from_id( $id ); + } + + /** + * @param $args + * @param $context + * + * @return false|ConfigurationSet + */ + protected function get_configuration_set_data( $args, $context = 'view' ) { + if ( is_string( $args ) ) { + $id = $args; + } else { + $id = $this->get_configuration_set_id( $args ); + } + + $configuration_sets = $this->get_configuration_sets( $context ); + + if ( array_key_exists( $id, $configuration_sets ) ) { + return $configuration_sets[ $id ]; + } + + return false; + } + + public function has_configuration_set( $args, $context = 'view' ) { + return $this->get_configuration_set( $args, $context ) ? true : false; + } + + /** + * @param $args + * @param $context + * + * @return false|ConfigurationSet + */ + public function get_configuration_set( $args, $context = 'view' ) { + if ( is_string( $args ) ) { + $configuration_set_id = $this->get_configuration_set_id( $args ); + } else { + $args = $this->get_configuration_set_default_args( $args ); + $configuration_set_id = $this->get_configuration_set_id( $args ); + } + + $configuration_set = false; + + if ( ! is_null( $this->configuration_sets ) && array_key_exists( $configuration_set_id, $this->configuration_sets ) ) { + return $this->configuration_sets[ $configuration_set_id ]; + } elseif ( $configuration_set_data = $this->get_configuration_set_data( $configuration_set_id, $context ) ) { + $configuration_set = new ConfigurationSet( $configuration_set_data, $this ); + + if ( is_null( $this->configuration_sets ) ) { + $this->configuration_sets = array(); + } + + $this->configuration_sets[ $configuration_set_id ] = $configuration_set; + + return $this->configuration_sets[ $configuration_set_id ]; + } + + return $configuration_set; + } + + public function set_configuration_sets( $sets ) { + $this->set_prop( 'configuration_sets', array_filter( (array) $sets ) ); + $this->configuration_sets = null; + } + + /** + * @param ConfigurationSet $set + * + * @return void + */ + public function update_configuration_set( $set ) { + $configuration_sets = $this->get_configuration_sets( 'edit' ); + $set_id = $this->get_configuration_set_id( + array( + 'shipping_provider_name' => $set->get_shipping_provider_name(), + 'shipment_type' => $set->get_shipment_type(), + 'zone' => $set->get_zone(), + ) + ); + + $configuration_sets[ $set_id ] = $set->get_data(); + + $this->set_configuration_sets( $configuration_sets ); + } + + /** + * @param $args + * + * @return ConfigurationSet + */ + public function get_or_create_configuration_set( $args = array(), $context = 'view' ) { + if ( $configuration_set = $this->get_configuration_set( $args, $context ) ) { + return $configuration_set; + } else { + $args = $this->get_configuration_set_default_args( $args ); + $configuration_set = new ConfigurationSet( $args, $this ); + + $this->update_configuration_set( $configuration_set ); + + return $configuration_set; + } + } + + private function get_configuration_set_setting_parts( $setting_name ) { + if ( 'label_config_set_' === substr( $setting_name, 0, 17 ) ) { + return $this->get_configuration_set_args_by_id( substr( $setting_name, 17 ) ); + } + + return false; + } + + public function get_configuration_set_id_by_setting_name( $setting_name ) { + if ( $this->is_configuration_set_setting( $setting_name ) ) { + if ( $parts = $this->get_configuration_set_setting_parts( $setting_name ) ) { + return $this->get_configuration_set_id( $parts ); + } + } + + return false; + } + + public function is_configuration_set_setting( $setting_name ) { + if ( 'label_config_set_' === substr( $setting_name, 0, 17 ) ) { + return true; + } + + return false; + } + + public function get_configuration_setting_suffix( $setting_name ) { + if ( $this->is_configuration_set_setting( $setting_name ) ) { + if ( $parts = $this->get_configuration_set_setting_parts( $setting_name ) ) { + return $parts['setting_name']; + } + } + + return false; + } + + public function reset_configuration_sets( $args = array() ) { + $args = wp_parse_args( + $args, + array( + 'shipping_provider_name' => '', + 'shipment_type' => '', + 'zone' => '', + ) + ); + + $id_prefix = ''; + + foreach ( $args as $arg => $value ) { + if ( empty( $value ) ) { + continue; + } + + if ( 'shipping_provider_name' === $arg ) { + $id_prefix = '-p-' . $value; + } elseif ( 'shipment_type' === $arg ) { + $id_prefix = $id_prefix . '-s-' . $value; + } elseif ( 'zone' === $arg ) { + $id_prefix = $id_prefix . '-z-' . $value; + } + } + + if ( empty( $id_prefix ) ) { + $this->set_configuration_sets( array() ); + } else { + $configuration_sets = $this->get_configuration_sets( 'edit' ); + + foreach ( $configuration_sets as $set_id => $set ) { + if ( strstr( $set_id, $id_prefix ) ) { + unset( $configuration_sets[ $set_id ] ); + } + } + + $this->set_configuration_sets( $configuration_sets ); + } + } +} 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..a99679a11 --- /dev/null +++ b/packages/woocommerce-germanized-shipments/src/Labels/DownloadHandler.php @@ -0,0 +1,133 @@ + isset( $_GET['force'] ) ? wc_clean( wp_unslash( $_GET['force'] ) ) : 'no', // phpcs:ignore WordPress.Security.NonceVerification.Recommended + 'path' => isset( $_GET['print'] ) ? wc_clean( wp_unslash( $_GET['print'] ) ) : 'no', // phpcs:ignore WordPress.Security.NonceVerification.Recommended + ); + + $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( wp_unslash( $_REQUEST['_wpnonce'] ), 'download-shipment-label' ) ) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotValidated,WordPress.Security.ValidatedSanitizedInput.InputNotSanitized + $shipment_id = absint( $_GET['shipment_id'] ); // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotValidated + $has_permission = current_user_can( 'edit_shop_orders' ); + + $args = self::parse_args( + array( + 'force' => wc_string_to_bool( isset( $_GET['force'] ) ? wc_clean( wp_unslash( $_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 WordPress.PHP.NoSilencedErrors.Discouraged + } + } else { + @ob_end_clean(); // phpcs:ignore WordPress.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 WordPress.PHP.NoSilencedErrors.Discouraged + + if ( ! $file_size ) { + return; + } + + header( 'Content-Length: ' . $file_size ); + + @readfile( $file_path ); // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged,WordPress.WP.AlternativeFunctions.file_system_read_readfile + 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..49d52f456 --- /dev/null +++ b/packages/woocommerce-germanized-shipments/src/Labels/Factory.php @@ -0,0 +1,91 @@ +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; + } + + /** + * Simple shipping provider do not support labels + */ + if ( ! is_a( $shipping_provider, '\Vendidero\Germanized\Shipments\Interfaces\ShippingProviderAuto' ) ) { + 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__, array( $label_id, $shipping_provider_name, $label_type ) ); + 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..ff2b41ea0 --- /dev/null +++ b/packages/woocommerce-germanized-shipments/src/Labels/Label.php @@ -0,0 +1,870 @@ + null, + 'shipment_id' => 0, + 'product_id' => '', + 'parent_id' => 0, + 'number' => '', + 'shipping_provider' => '', + 'weight' => '', + 'net_weight' => '', + 'length' => '', + 'width' => '', + 'height' => '', + 'path' => '', + 'created_via' => '', + 'services' => array(), + 'print_format' => '', + ); + + 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_{$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 get_print_format( $context = 'view' ) { + return $this->get_prop( 'print_format', $context ); + } + + public function has_number() { + $number = $this->get_number(); + + return empty( $number ) ? false : true; + } + + /** + * Returns the weight in kg + * + * @param string $context + * + * @return string + */ + 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; + } + + /** + * Returns the length in cm + * + * @param string $context + * + * @return string + */ + public function get_length( $context = 'view' ) { + return $this->get_prop( 'length', $context ); + } + + /** + * Returns the width in cm + * + * @param string $context + * + * @return string + */ + public function get_width( $context = 'view' ) { + return $this->get_prop( 'width', $context ); + } + + /** + * Returns the height in cm + * + * @param string $context + * + * @return string + */ + public function get_height( $context = 'view' ) { + return $this->get_prop( 'height', $context ); + } + + public function get_dimensions( $context = 'view' ) { + return array( + 'length' => $this->get_length( $context ), + 'width' => $this->get_width( $context ), + 'height' => $this->get_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(), true ) ); + } + + /** + * Retrieve additional data for a certain service, e.g. + * retrieve the min_age for the DHL VisualCheckOfAge service. + * + * @param $service + * @param $prop + * @param $default + * + * @return mixed + */ + public function get_service_prop( $service, $prop, $default = null, $context = 'view' ) { + $meta_key = "service_{$service}_{$prop}"; + + if ( $this->get_meta( $meta_key, true, $context ) ) { + return $this->get_meta( $meta_key, true, $context ); + } else { + return $default; + } + } + + 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_print_format( $format ) { + $this->set_prop( 'print_format', $format ); + } + + 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 count( $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, true ) && in_array( $service, $available_services, true ) ) { + $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, true ) ) { + $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(), true ); + } + + 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 esc_url_raw( apply_filters( "{$this->get_hook_prefix()}download_url", $download_url, $this ) ); + } + + /** + * @return ShipmentError|true + */ + public function fetch() { + $result = new ShipmentError( '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 ); + + $GLOBALS['gzd_shipments_unique_filename'] = $filename; + add_filter( 'wp_unique_filename', '_wc_gzd_shipments_keep_force_filename', 10, 1 ); + + $tmp = wp_upload_bits( $this->get_filename( $file_type ), null, $stream ); + + 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']; + $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 = array( + 'name' => $this->get_filename( $file_type ), + 'type' => 'application/pdf', + 'tmp_name' => $temp_file, + 'error' => 0, + 'size' => filesize( $temp_file ), + ); + + $overrides = array( + '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( $results['error'] ); + } + } catch ( \Exception $e ) { + Package::log( sprintf( 'Error while downloading label file from URL %1$s: %2$s', esc_url( $url ), $e->getMessage() ), 'error' ); + + return false; + } + } + + public function is_trackable() { + return true; + } + + public function supports_third_party_email_notification() { + $supports_email_notification = false; + + if ( ( $shipment = $this->get_shipment() ) && ( $order = $shipment->get_order() ) ) { + $supports_email_notification = wc_gzd_get_shipment_order( $order )->supports_third_party_email_transmission(); + } + + return apply_filters( "{$this->get_general_hook_prefix()}supports_third_party_email_notification", $supports_email_notification, $this ); + } + + /** + * 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; + } + + protected function round_customs_item_weight( $value, $precision = 0 ) { + return \Automattic\WooCommerce\Utilities\NumberUtil::round( $value, $precision, 2 ); + } + + protected function get_per_item_weights( $total_weight, $item_weights, $shipment_items ) { + $item_total_weight = array_sum( $item_weights ); + + /** + * Discrepancies detected between item weights and total shipment weight. + * Try to distribute the mismatch between items. + */ + if ( $item_total_weight != $total_weight ) { // phpcs:ignore WordPress.PHP.StrictComparisons.LooseComparison + $diff = $total_weight - $item_total_weight; + $diff_abs = abs( $diff ); + + if ( $diff_abs > 0 ) { + $diff_left = $diff_abs; + $item_keys = array_keys( $item_weights ); + $current_item_index = 0; + + /** + * Loop over the diff (one step/g a time) and distribute + * the diff evenly for the items included. Respect min weight (1g). + */ + for ( $i = 0; $i < $diff_left; $i++ ) { + if ( ! isset( $item_keys[ $current_item_index ] ) ) { + $current_item_index = 0; + } + + $current_item_key = $item_keys[ $current_item_index ]; + $shipment_item = $shipment_items[ $current_item_key ]; + $item_min_weight = 1 * $shipment_item->get_quantity(); + $diff_to_apply = $diff / $diff_abs; // apply diff in -1/+1 steps + $new_item_weight = $item_weights[ $current_item_key ] + $diff_to_apply; + + if ( $new_item_weight >= $item_min_weight ) { + $item_weights[ $current_item_key ] = $new_item_weight; + } + + $current_item_index = ( $current_item_index >= count( $item_keys ) ) ? 0 : ( $current_item_index + 1 ); + } + } + } + + return $item_weights; + } + + public function get_customs_data( $max_desc_length = 255 ) { + if ( ! $shipment = $this->get_shipment() ) { + return false; + } + + $customs_items = array(); + $item_description = ''; + $total_weight = (int) ceil( (float) wc_get_weight( $this->get_net_weight(), 'g', 'kg' ) ); + $total_gross_weight = (int) ceil( (float) wc_get_weight( $this->get_weight(), 'g', 'kg' ) ); + $item_weights = array(); + $shipment_items = $shipment->get_items(); + $order = $shipment->get_order(); + + foreach ( $shipment_items as $key => $item ) { + $per_item_weight = (int) ceil( (float) wc_get_weight( $item->get_weight(), 'g', $shipment->get_weight_unit() ) ); + $per_item_weight = $per_item_weight * $item->get_quantity(); + $per_item_min_weight = 1 * $item->get_quantity(); + + /** + * Set min weight to 1g to prevent missing weight error messages. + */ + if ( $per_item_weight < $per_item_min_weight ) { + $per_item_weight = $per_item_min_weight; + } + + $item_weights[ $key ] = $per_item_weight; + } + + $item_weights = $this->get_per_item_weights( $total_weight, $item_weights, $shipment_items ); + $item_gross_weights = $this->get_per_item_weights( $total_gross_weight, $item_weights, $shipment_items ); + + $total_weight = 0; + $total_gross_weight = 0; + $total_value = 0; + $use_subtotal = false; + + if ( $order && apply_filters( 'woocommerce_gzd_shipments_order_has_voucher', false, $order ) ) { + $use_subtotal = true; + } + + $use_subtotal = apply_filters( 'woocommerce_gzd_shipments_customs_use_subtotal', $use_subtotal, $this ); + + foreach ( $shipment->get_items() as $key => $item ) { + $product = $item->get_product(); + + if ( $product ) { + $shipment_product = wc_gzd_shipments_get_product( $product ); + } + + $single_item_description = $item->get_customs_description(); + + $item_description .= ! empty( $item_description ) ? ', ' : ''; + $item_description .= $single_item_description; + + // Use total before discounts for customs + $product_total = (float) ( $use_subtotal ? $item->get_subtotal() : $item->get_total() ) / $item->get_quantity(); + + if ( $product_total < 0.01 ) { + // Use the order item data as fallback + if ( ( $order_item = $item->get_order_item() ) && $order ) { + $order_item_total = $use_subtotal ? $order->get_line_subtotal( $order_item, true, false ) : $order->get_line_total( $order_item, true, false ); + $product_total = (float) $order_item_total / $item->get_quantity(); + } + } + + $category = $shipment_product ? $shipment_product->get_main_category() : $item->get_name(); + + if ( empty( $category ) ) { + $category = $item->get_name(); + } + + $product_value = $product_total < 0.01 ? wc_format_decimal( apply_filters( "{$this->get_general_hook_prefix()}customs_item_min_price", 0.01, $item, $this, $shipment ), 2 ) : wc_format_decimal( $product_total, 2 ); + + $customs_items[ $key ] = apply_filters( + "{$this->get_general_hook_prefix()}customs_item", + array( + 'description' => apply_filters( "{$this->get_general_hook_prefix()}item_description", wc_clean( mb_substr( $single_item_description, 0, $max_desc_length ) ), $item, $this, $shipment ), + 'category' => apply_filters( "{$this->get_general_hook_prefix()}item_category", $category, $item, $this, $shipment ), + 'origin_code' => ( $shipment_product && $shipment_product->get_manufacture_country() ) ? $shipment_product->get_manufacture_country() : Package::get_base_country(), + 'tariff_number' => $shipment_product ? $shipment_product->get_hs_code() : '', + 'quantity' => intval( $item->get_quantity() ), + 'weight_in_kg' => $this->round_customs_item_weight( (float) wc_get_weight( $item_weights[ $key ], 'kg', 'g' ), 3 ), + 'weight_in_g' => $item_weights[ $key ], + 'single_weight_in_kg' => $this->round_customs_item_weight( (float) wc_get_weight( $item_weights[ $key ] / $item->get_quantity(), 'kg', 'g' ), 3 ), + 'single_weight_in_g' => ceil( $item_weights[ $key ] / $item->get_quantity() ), + 'gross_weight_in_kg' => $this->round_customs_item_weight( (float) wc_get_weight( $item_gross_weights[ $key ], 'kg', 'g' ), 3 ), + 'gross_weight_in_g' => $item_gross_weights[ $key ], + 'single_value' => $product_value, + 'value' => wc_format_decimal( $product_value * $item->get_quantity(), 2 ), + ), + $item, + $shipment, + $this + ); + + $total_weight += $customs_items[ $key ]['weight_in_g']; + $total_gross_weight += $customs_items[ $key ]['gross_weight_in_g']; + $total_value += (float) $customs_items[ $key ]['value']; + } + + $item_description = mb_substr( $item_description, 0, $max_desc_length ); + + $customs_data = apply_filters( + "{$this->get_general_hook_prefix()}customs_data", + array( + 'shipment_id' => $shipment->get_id(), + 'additional_fee' => wc_format_decimal( $shipment->get_additional_total(), 2 ), + 'place_of_commital' => $shipment->get_sender_city(), + // e.g. EORI number + 'sender_customs_ref_number' => $shipment->get_sender_customs_reference_number(), + 'receiver_customs_ref_number' => $shipment->get_customs_reference_number(), + // Customs UK VAT ID (HMRC) for totals <= 135 GBP + 'sender_customs_uk_vat_id' => $shipment->get_sender_customs_uk_vat_id(), + 'items' => $customs_items, + 'item_total_weight_in_kg' => $this->round_customs_item_weight( (float) wc_get_weight( $total_weight, 'kg', 'g' ), 3 ), + 'item_total_weight_in_g' => $total_weight, + 'item_total_gross_weight_in_kg' => $this->round_customs_item_weight( (float) wc_get_weight( $total_gross_weight, 'kg', 'g' ), 3 ), + 'item_total_gross_weight_in_g' => $total_gross_weight, + 'item_total_value' => $total_value, + 'currency' => $order ? $order->get_currency() : get_woocommerce_currency(), + 'invoice_number' => '', + 'incoterms' => '', + 'export_type' => '', + 'export_reason_description' => $item_description, + 'export_type_description' => $item_description, + 'export_reason' => '', + ), + $this, + $shipment + ); + + return apply_filters( 'woocommerce_gzd_shipments_label_customs_data', $customs_data, $this, $shipment, $max_desc_length ); + } +} 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..8a2d8c8eb --- /dev/null +++ b/packages/woocommerce-germanized-shipments/src/Labels/Query.php @@ -0,0 +1,490 @@ + 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 ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared + } else { + $this->results = $wpdb->get_col( $this->request ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared + } + + if ( isset( $qv['count_total'] ) && $qv['count_total'] ) { + $found_labels_query = 'SELECT FOUND_ROWS()'; + $this->total_labels = (int) $wpdb->get_var( $found_labels_query ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared + } + } + + 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'] ); // phpcs:ignore WordPress.DB.PreparedSQLPlaceholders.QuotedSimplePlaceholder + } + + // Shipping provider + if ( isset( $this->args['shipping_provider'] ) ) { + $this->query_where .= $wpdb->prepare( " AND label_shipping_provider IN ('%s')", $this->args['shipping_provider'] ); // phpcs:ignore WordPress.DB.PreparedSQLPlaceholders.QuotedSimplePlaceholder + } + + // Shipping provider + if ( isset( $this->args['product_id'] ) ) { + $this->query_where .= $wpdb->prepare( " AND label_product_id IN ('%s')", $this->args['product_id'] ); // phpcs:ignore WordPress.DB.PreparedSQLPlaceholders.QuotedSimplePlaceholder + } + + // 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 ); // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared + } else { + $searches[] = $wpdb->prepare( "$col LIKE %s", $like ); // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared + } + } + + 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' ), true ) ) { + $_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..f9c922670 --- /dev/null +++ b/packages/woocommerce-germanized-shipments/src/Labels/ReturnLabel.php @@ -0,0 +1,171 @@ + 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; + } + + /** + * 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 ); + } + + 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' ) { + $sender_address = $this->get_sender_address(); + + if ( array_key_exists( 'street', $sender_address ) ) { + return $this->get_sender_address_prop( 'street', $context ); + } + + $split = wc_gzd_split_shipment_street( $this->{'get_sender_address_1'}() ); + + return $split['street']; + } + + public function get_sender_street_number( $context = 'view' ) { + $sender_address = $this->get_sender_address(); + + if ( array_key_exists( 'street_number', $sender_address ) ) { + return $this->get_sender_address_prop( 'street_number', $context ); + } + + $split = wc_gzd_split_shipment_street( $this->{'get_sender_address_1'}() ); + + return $split['number']; + } + + public function get_sender_street_addition( $context = 'view' ) { + $sender_address = $this->get_sender_address(); + + if ( array_key_exists( 'street_addition', $sender_address ) ) { + return $this->get_sender_address_prop( 'street_addition', $context ); + } + + $split = wc_gzd_split_shipment_street( $this->{'get_sender_address_1'}() ); + + return $split['addition']; + } + + public function get_sender_company( $context = 'view' ) { + return $this->get_sender_address_prop( 'company', $context ); + } + + public function get_sender_name( $context = 'view' ) { + $sender_address = $this->get_sender_address(); + + if ( array_key_exists( 'name', $sender_address ) ) { + return $this->get_sender_address_prop( 'name', $context ); + } + + return ''; + } + + public function get_sender_first_name( $context = 'view' ) { + return $this->get_sender_address_prop( 'first_name', $context ); + } + + public function get_sender_last_name( $context = 'view' ) { + return $this->get_sender_address_prop( 'last_name', $context ); + } + + public function get_sender_formatted_full_name() { + if ( empty( $this->get_sender_first_name() ) ) { + return $this->get_sender_name(); + } + + return sprintf( _x( '%1$s %2$s', 'full name', 'woocommerce-germanized' ), $this->get_sender_first_name(), $this->get_sender_last_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..8ee12353b --- /dev/null +++ b/packages/woocommerce-germanized-shipments/src/Order.php @@ -0,0 +1,1284 @@ +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 is_shipped() { + $shipping_status = $this->get_shipping_status(); + + return apply_filters( 'woocommerce_gzd_shipment_order_shipping_status', ( in_array( $shipping_status, array( 'shipped', 'delivered' ), true ) || ( 'partially-delivered' === $shipping_status && ! $this->needs_shipping( array( 'sent_only' => true ) ) ) ), $this ); + } + + public function get_last_tracking_id() { + $tracking_id = ''; + + foreach ( array_reverse( $this->get_simple_shipments( true ) ) as $shipment ) { + if ( ! empty( $shipment->get_tracking_id() ) ) { + $tracking_id = $shipment->get_tracking_id(); + break; + } + } + + return apply_filters( 'woocommerce_gzd_shipment_order_last_tracking_id', $tracking_id, $this ); + } + + public function get_shipping_status() { + $status = 'not-shipped'; + $shipments = $this->get_simple_shipments(); + $all_shipments_delivered = false; + $all_shipments_shipped = false; + + if ( ! empty( $shipments ) ) { + $all_shipments_delivered = true; + $all_shipments_shipped = true; + + foreach ( $shipments as $shipment ) { + if ( ! $shipment->has_status( 'delivered' ) ) { + $all_shipments_delivered = false; + } else { + $status = 'partially-delivered'; + } + + if ( ! $shipment->is_shipped() ) { + $all_shipments_shipped = false; + } elseif ( 'partially-delivered' !== $status ) { + $status = 'partially-shipped'; + } + } + } + + $needs_shipping = $this->needs_shipping( array( 'sent_only' => true ) ); + + if ( $all_shipments_delivered && ! $needs_shipping ) { + $status = 'delivered'; + } elseif ( 'partially-delivered' !== $status && ( $all_shipments_shipped && ! $needs_shipping ) ) { + $status = 'shipped'; + } elseif ( ! in_array( $status, array( 'partially-shipped', 'partially-delivered' ), true ) && ! $needs_shipping ) { + $status = 'no-shipping-needed'; + } + + return apply_filters( 'woocommerce_gzd_shipment_order_shipping_status', $status, $this ); + } + + public function supports_third_party_email_transmission() { + $supports_email_transmission = function_exists( 'wc_gzd_order_supports_parcel_delivery_reminder' ) ? wc_gzd_order_supports_parcel_delivery_reminder( $this->get_order() ) : 'yes' === $this->get_order()->get_meta( '_parcel_delivery_opted_in' ); + + /** + * Filter to adjust whether the email address may be transmitted to third-parties, e.g. + * the shipping provider (via label requests) or not. + * + * @param boolean $supports_email_transmission Whether the order supports email transmission or not. + * @param Order $order The order instance. + * + * @since 3.0.0 + * @package Vendidero/Germanized/Shipments + */ + return apply_filters( 'woocommerce_gzd_shipment_order_supports_email_transmission', $supports_email_transmission, $this ); + } + + public function has_shipped_shipments() { + $shipments = $this->get_simple_shipments(); + + foreach ( $shipments as $shipment ) { + if ( $shipment->is_shipped() ) { + 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->is_shipped() ) { + $default_provider = $shipment->get_shipping_provider(); + } + } + + return apply_filters( 'woocommerce_gzd_shipment_order_return_default_shipping_provider', $default_provider, $this ); + } + + protected function get_package_data() { + if ( is_null( $this->package_data ) ) { + $items = $this->get_available_items_for_shipment(); + $package_data = array( + 'total' => 0.0, + 'subtotal' => 0.0, + 'weight' => 0.0, + 'volume' => 0.0, + 'products' => array(), + 'shipping_classes' => array(), + 'item_count' => 0, + 'items' => new ItemList(), + ); + + foreach ( $items as $order_item_id => $item ) { + if ( ! $order_item = $this->get_order()->get_item( $order_item_id ) ) { + continue; + } + + $line_total = (float) $order_item->get_total(); + $line_subtotal = (float) $order_item->get_subtotal(); + + if ( $this->get_order()->get_prices_include_tax() ) { + $line_total += (float) $order_item->get_total_tax(); + $line_subtotal += (float) $order_item->get_subtotal_tax(); + } + + $quantity = (int) $item['max_quantity']; + + if ( $product = $order_item->get_product() ) { + $width = ( empty( $product->get_width() ) ? 0 : wc_format_decimal( $product->get_width() ) ) * $quantity; + $length = ( empty( $product->get_length() ) ? 0 : wc_format_decimal( $product->get_length() ) ) * $quantity; + $height = ( empty( $product->get_height() ) ? 0 : wc_format_decimal( $product->get_height() ) ) * $quantity; + $weight = ( empty( $product->get_weight() ) ? 0 : wc_format_decimal( $product->get_weight() ) ) * $quantity; + + $package_data['weight'] += $weight; + $package_data['volume'] += ( $width * $length * $height ); + + if ( $product && ! array_key_exists( $product->get_id(), $package_data['products'] ) ) { + $package_data['products'][ $product->get_id() ] = $product; + + if ( ! empty( $product->get_shipping_class_id() ) ) { + $package_data['shipping_classes'][] = $product->get_shipping_class_id(); + } + } + } + + $package_data['total'] += $line_total; + $package_data['subtotal'] += $line_subtotal; + $package_data['item_count'] += $quantity; + + $box_item = new Packing\OrderItem( $order_item ); + $package_data['items']->insert( $box_item, $quantity ); + } + + $this->package_data = $package_data; + } + + return $this->package_data; + } + + /** + * Create shipments (if needed) based on current packing configuration. + * + * @param string $default_status + * + * @return array|\WP_Error + */ + public function create_shipments( $default_status = 'processing' ) { + $shipments_created = array(); + $errors = new \WP_Error(); + + if ( $this->needs_shipping() ) { + if ( $this->has_auto_packing() ) { + if ( $method = $this->get_builtin_shipping_method() ) { + $packaging_boxes = $method->get_method()->get_available_packaging_boxes( $this->get_package_data() ); + } else { + $available_packaging = wc_gzd_get_packaging_list(); + + if ( $provider = wc_gzd_get_order_shipping_provider( $this ) ) { + $available_packaging = wc_gzd_get_packaging_list( array( 'shipping_provider' => $provider->get_name() ) ); + } + + $packaging_boxes = Helper::get_packaging_boxes( $available_packaging ); + } + + $items = $this->get_items_to_pack_left_for_shipping(); + $packed_boxes = Helper::pack( $items, $packaging_boxes, 'order' ); + + if ( empty( $packaging_boxes ) && 0 === count( $packed_boxes ) ) { + $shipment = wc_gzd_create_shipment( $this, array( 'props' => array( 'status' => $default_status ) ) ); + + if ( ! is_wp_error( $shipment ) ) { + $this->add_shipment( $shipment ); + $shipments_created[ $shipment->get_id() ] = $shipment; + } else { + foreach ( $shipment->get_error_messages() as $code => $message ) { + $errors->add( $code, $message ); + } + } + } else { + if ( 0 === count( $packed_boxes ) ) { + $errors->add( 404, sprintf( _x( 'Seems like none of your packaging options is available for this order.', 'shipments', 'woocommerce-germanized' ), Settings::get_settings_url( 'packaging' ) ) ); + } else { + foreach ( $packed_boxes as $box ) { + $packaging = $box->getBox(); + $items = $box->getItems(); + $shipment_items = array(); + + foreach ( $items as $item ) { + $order_item = $item->getItem(); + + if ( ! isset( $shipment_items[ $order_item->get_id() ] ) ) { + $shipment_items[ $order_item->get_id() ] = 1; + } else { + $shipment_items[ $order_item->get_id() ]++; + } + } + + $shipment = wc_gzd_create_shipment( + $this, + array( + 'items' => $shipment_items, + 'props' => array( + 'packaging_id' => $packaging->get_id(), + 'status' => $default_status, + ), + ) + ); + + if ( ! is_wp_error( $shipment ) ) { + $this->add_shipment( $shipment ); + + $shipments_created[ $shipment->get_id() ] = $shipment; + } else { + foreach ( $shipments_created as $id => $shipment_created ) { + $shipment_created->delete( true ); + $this->remove_shipment( $id ); + } + + foreach ( $shipment->get_error_messages() as $code => $message ) { + $errors->add( $code, $message ); + } + } + } + } + } + } else { + $shipment = wc_gzd_create_shipment( $this, array( 'props' => array( 'status' => $default_status ) ) ); + + if ( ! is_wp_error( $shipment ) ) { + $this->add_shipment( $shipment ); + $shipments_created[ $shipment->get_id() ] = $shipment; + } else { + foreach ( $shipment->get_error_messages() as $code => $message ) { + $errors->add( $code, $message ); + } + } + } + } + + if ( wc_gzd_shipment_wp_error_has_errors( $errors ) ) { + return $errors; + } else { + $this->save(); + } + + return $shipments_created; + } + + 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(); + } + } + + /** + * @param Shipment $shipment + * + * @return float + */ + public function calculate_shipment_additional_total( $shipment ) { + $fees_total = 0.0; + + foreach ( $this->get_order()->get_fees() as $item ) { + $fees_total += ( (float) $item->get_total() + (float) $item->get_total_tax() ); + } + + $additional_total = $fees_total + (float) $this->get_order()->get_shipping_total() + (float) $this->get_order()->get_shipping_tax(); + + foreach ( $this->get_simple_shipments() as $simple_shipment ) { + if ( $shipment->get_id() === $simple_shipment->get_id() ) { + continue; + } + + $additional_total -= (float) $simple_shipment->get_additional_total(); + } + + $additional_total = wc_format_decimal( $additional_total, '' ); + + if ( (float) $additional_total < 0.0 ) { + $additional_total = 0.0; + } + + return $additional_total; + } + + 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 = absint( $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( $shipped_only = false ) { + $simple = array(); + + foreach ( $this->get_shipments() as $shipment ) { + if ( 'simple' === $shipment->get_type() ) { + if ( $shipped_only && ! $shipment->is_shipped() ) { + continue; + } + + $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 ) { + $this->package_data = null; + + $shipments = $this->get_shipments(); + + $this->shipments[] = $shipment; + } + + public function remove_shipment( $shipment_id ) { + $this->package_data = null; + $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_shipments() as $shipment ) { + if ( $args['sent_only'] && ! $shipment->is_shipped() ) { + 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() ) ) { + if ( 'return' === $shipment->get_type() ) { + if ( ! $args['sent_only'] && $shipment->is_shipped() ) { + $quantity_left += absint( $item->get_quantity() ); + } + } else { + $quantity_left -= absint( $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->is_shipped() ) { + continue; + } + + if ( $item = $shipment->get_item_by_order_item_id( $order_item_id ) ) { + $quantity += absint( $item->get_quantity() ); + } + } + + return $quantity; + } + + public function order_item_is_non_returnable( $order_item_id ) { + $is_non_returnable = false; + $order_item = is_a( $order_item_id, 'WC_Order_Item' ) ? $order_item_id : $this->get_order()->get_item( $order_item_id ); + + if ( $order_item ) { + if ( is_callable( array( $order_item, 'get_product' ) ) ) { + if ( $product = $order_item->get_product() ) { + $is_non_returnable = wc_gzd_shipments_get_product( $product )->is_non_returnable(); + } + } + } + + return apply_filters( 'woocommerce_gzd_shipment_order_item_is_non_returnable', $is_non_returnable, $order_item_id, $this ); + } + + /** + * @param ShipmentItem $item + */ + public function get_item_quantity_left_for_returning( $order_item_id, $args = array() ) { + $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 ); + + if ( $this->order_item_is_non_returnable( $order_item_id ) ) { + $quantity_left = 0; + } + + 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 -= absint( $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 ); + } + + /** + * @param false $legacy_group_by_product_group + * + * @return ItemList|OrderItem[] + */ + public function get_items_to_pack_left_for_shipping( $legacy_group_by_product_group = null ) { + $items_to_be_packed = ! is_null( $legacy_group_by_product_group ) ? array() : $this->get_package_data()['items']; + + if ( ! is_null( $legacy_group_by_product_group ) ) { + foreach ( $this->get_available_items_for_shipment() as $order_item_id => $item ) { + if ( ! $order_item = $this->get_order()->get_item( $order_item_id ) ) { + continue; + } + + $box_item = new Packing\OrderItem( $order_item ); + + $product_group = ''; + + if ( $product = $order_item->get_product() ) { + $product_group = ''; + + if ( 'yes' === get_option( 'woocommerce_gzd_shipments_packing_group_by_shipping_class' ) ) { + $product_group = $product->get_shipping_class(); + } + } + + if ( ! array_key_exists( $product_group, $items_to_be_packed ) ) { + $items_to_be_packed[ $product_group ] = new ItemList(); + } + + $items_to_be_packed[ $product_group ]->insert( $box_item, $item['max_quantity'] ); + } + } + + return apply_filters( 'woocommerce_gzd_shipment_order_items_to_pack_left_for_shipping', $items_to_be_packed ); + } + + /** + * @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; + } + + public function get_non_returnable_items() { + $items = array(); + + foreach ( $this->get_returnable_items() as $item ) { + if ( $this->order_item_is_non_returnable( $item->get_order_item_id() ) ) { + $sku = $item->get_sku(); + + $items[ $item->get_order_item_id() ] = array( + 'name' => $item->get_name() . ( ! empty( $sku ) ? ' (' . esc_html( $sku ) . ')' : '' ), + 'max_quantity' => 0, + ); + } + } + + return $items; + } + + /** + * @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->is_shipped() ) { + continue; + } + + foreach ( $shipment->get_items() as $item ) { + if ( $this->order_item_is_non_returnable( $item->get_order_item_id() ) ) { + continue; + } + + if ( ! isset( $items[ $item->get_order_item_id() ] ) ) { + $new_item = clone $item; + $items[ $item->get_order_item_id() ] = $new_item; + } else { + $new_quantity = absint( $items[ $item->get_order_item_id() ]->get_quantity() ) + absint( $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 = absint( $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 = absint( $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 += absint( $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, true ) ) { + $has_pickup = true; + break; + } + } + + return $has_pickup; + } + + /** + * @return ProviderMethod|false + */ + public function get_builtin_shipping_method() { + $method = false; + + if ( Package::is_packing_supported() ) { + $shipping_method_id = wc_gzd_get_shipment_order_shipping_method_id( $this->get_order() ); + + if ( 'shipping_provider_' === substr( $shipping_method_id, 0, 18 ) ) { + if ( $method = MethodHelper::get_provider_method( $shipping_method_id ) ) { + return $method; + } + } + } + + return $method; + } + + public function has_auto_packing() { + $has_auto_packing = false; + + if ( Package::is_packing_supported() ) { + $has_auto_packing = Helper::enable_auto_packing(); + + if ( ! $has_auto_packing ) { + if ( self::get_builtin_shipping_method() ) { + $has_auto_packing = true; + } + } + } + + return apply_filters( 'woocommerce_gzd_shipment_order_has_auto_packing', $has_auto_packing, $this->get_order(), $this ); + } + + /** + * 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(); + } + + $this->package_data = null; + } + + /** + * 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..41131dfc2 --- /dev/null +++ b/packages/woocommerce-germanized-shipments/src/PDFMerger.php @@ -0,0 +1,142 @@ +_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 = array(), $width = 210 ) { + if ( file_exists( $filename ) ) { + $page_count = $this->_pdf->setSourceFile( $filename ); + + for ( $i = 1; $i <= $page_count; $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 $page_number + * + * @throws PdfReaderException + */ + private function _addPage( $page_number, $width = 210 ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore,WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid + $page_id = $this->_pdf->importPage( $page_number ); + $size = $this->_pdf->getTemplateSize( $page_id ); + + $orientation = isset( $size['orientation'] ) ? $size['orientation'] : ''; + + $this->_pdf->addPage( $orientation, $size ); + + if ( ! isset( $size['width'] ) || empty( $size['width'] ) ) { + $this->_pdf->useImportedPage( $page_id, 0, 0, $width, null, true ); + } else { + $this->_pdf->useImportedPage( $page_id ); + } + } + + + /** + * Check if a specific page should be merged. + * If pages are empty, all pages will be merged + * + * @return bool + */ + private function _isPageInRange( $page_number, $pages = array() ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore,WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid + if ( empty( $pages ) ) { + return true; + } + + foreach ( $pages as $range ) { + if ( in_array( $page_number, $this->_getRange( $range ), true ) ) { + return true; + } + } + + return false; + } + + + /** + * Get range by given value + * + * @param mixed $value + * + * @return array + */ + private function _getRange( $value = null ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore,WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid + $value = preg_replace( '/[^0-9\-.]/is', '', $value ); + + if ( '' === $value ) { + return false; + } + + $value = explode( '-', $value ); + + if ( 1 === count( $value ) ) { + 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..ef518b1dd --- /dev/null +++ b/packages/woocommerce-germanized-shipments/src/PDFSplitter.php @@ -0,0 +1,177 @@ +_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 ) { // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedCatch + } catch ( Exception $e ) { // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedCatch + } + } + + 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 = array() ) { + if ( file_exists( $filename ) ) { + $page_count = $this->_pdf->setSourceFile( $filename ); + for ( $i = 1; $i <= $page_count; $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 $page_number + * @throws PdfReaderException + */ + private function _addPage( $page_number ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore,WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid + $page_id = $this->_pdf->importPage( $page_number ); + $this->_pdf->addPage(); + $this->_pdf->useImportedPage( $page_id ); + } + + + /** + * Check if a specific page should be merged. + * If pages are empty, all pages will be merged + * + * @return bool + */ + private function _isPageInRange( $page_number, $pages = array() ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore,WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid + if ( empty( $pages ) ) { + return true; + } + + foreach ( $pages as $range ) { + if ( in_array( $page_number, $this->_getRange( $range ), true ) ) { + return true; + } + } + + return false; + } + + + /** + * Get range by given value + * + * @param mixed $value + * @return array + */ + private function _getRange( $value = null ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore,WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid + $value = preg_replace( '/[^0-9\-.]/is', '', $value ); + + if ( '' === $value ) { + return false; + } + + $value = explode( '-', $value ); + + if ( 1 === count( $value ) ) { + 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..b4b581ed3 --- /dev/null +++ b/packages/woocommerce-germanized-shipments/src/Package.php @@ -0,0 +1,779 @@ +get_shipping_provider(); + } + + return $args; + } + + public static function add_return_shipment_guest_endpoints( $template, $template_name ) { + global $wp; + + if ( 'myaccount/form-login.php' === $template_name ) { + try { + $key = ( isset( $_GET['key'] ) ? wc_clean( wp_unslash( $_GET['key'] ) ) : '' ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended + $order_id = false; + $callback = false; + + if ( isset( $wp->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 get_method_settings( $force_load_all = false ) {
+ wc_deprecated_function( __FUNCTION__, '3.0.0', 'MethodHelper::get_method_settings()' );
+
+ return MethodHelper::get_method_settings( $force_load_all );
+ }
+
+ public static function get_excluded_methods() {
+ wc_deprecated_function( __FUNCTION__, '3.0.0', 'MethodHelper::get_excluded_methods()' );
+
+ return array();
+ }
+
+ /**
+ * 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', '>=' ) && apply_filters( 'woocommerce_gzd_enable_rucksack_packaging', true );
+ }
+
+ public static function is_integration() {
+ $gzd_installed = class_exists( 'WooCommerce_Germanized' );
+
+ return $gzd_installed;
+ }
+
+ /**
+ * @return int[]
+ */
+ public static function get_shipping_classes() {
+ $term_args = array(
+ 'taxonomy' => 'product_shipping_class',
+ 'hide_empty' => 0,
+ 'orderby' => 'name',
+ 'hierarchical' => 0,
+ 'fields' => 'id=>name',
+ );
+
+ $terms = get_terms( $term_args );
+
+ if ( is_wp_error( $terms ) ) {
+ return array();
+ } else {
+ return $terms;
+ }
+ }
+
+ public static function is_hpos_enabled() {
+ if ( ! is_callable( array( '\Automattic\WooCommerce\Utilities\OrderUtil', 'custom_orders_table_usage_is_enabled' ) ) ) {
+ return false;
+ }
+
+ return \Automattic\WooCommerce\Utilities\OrderUtil::custom_orders_table_usage_is_enabled();
+ }
+
+ 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_country_iso_alpha3( $country_code ) {
+ $country_code = strtoupper( $country_code );
+ $iso = self::get_countries_iso_alpha3();
+
+ if ( isset( $iso[ $country_code ] ) ) {
+ return $iso[ $country_code ];
+ }
+
+ return $country_code;
+ }
+
+ protected static function get_countries_iso_alpha3() {
+ if ( is_null( self::$iso ) ) {
+ self::$iso = include self::get_path() . '/i18n/iso-3.php';
+ }
+
+ return (array) self::$iso;
+ }
+
+ public static function get_country_iso_alpha2( $country_code ) {
+ $country_code = strtoupper( $country_code );
+ $iso = self::get_countries_iso_alpha3();
+
+ if ( in_array( $country_code, $iso, true ) ) {
+ return array_search( $country_code, $iso, true );
+ }
+
+ return $country_code;
+ }
+
+ public static function get_base_country() {
+ $default_country = wc_get_base_location()['country'];
+ $shipment_country = wc_format_country_state_string( self::get_setting( 'shipper_address_country' ) )['country'];
+
+ if ( empty( $shipment_country ) ) {
+ $shipment_country = $default_country;
+ }
+
+ return apply_filters( 'woocommerce_gzd_shipment_base_country', $shipment_country );
+ }
+
+ public static function get_base_postcode() {
+ $default_postcode = WC()->countries->get_base_postcode();
+ $shipment_postcode = self::get_setting( 'shipper_address_postcode' );
+
+ if ( empty( $shipment_postcode ) ) {
+ $shipment_postcode = $default_postcode;
+ }
+
+ return apply_filters( 'woocommerce_gzd_shipment_base_postcode', $shipment_postcode );
+ }
+
+ public static function base_country_belongs_to_eu_customs_area() {
+ return self::country_belongs_to_eu_customs_area( self::get_base_country(), self::get_base_postcode() );
+ }
+
+ public static function country_belongs_to_eu_customs_area( $country, $postcode = '' ) {
+ $country = wc_strtoupper( $country );
+ $eu_countries = WC()->countries->get_european_union_countries();
+ $belongs = false;
+ $postcode = wc_normalize_postcode( $postcode );
+ $postcode_wildcards = wc_get_wildcard_postcodes( $postcode, $country );
+
+ if ( in_array( $country, $eu_countries, true ) ) {
+ $belongs = true;
+ }
+
+ if ( $belongs ) {
+ $exemptions = array(
+ 'DE' => array(
+ '27498', // Helgoland
+ '78266', // Büsingen am Hochrhein
+ ),
+ 'ES' => array(
+ '35*', // Canary Islands
+ '38*', // Canary Islands
+ '51*', // Ceuta
+ '52*', // Melilla
+ ),
+ 'GR' => array(
+ '63086', // Mount Athos
+ '63087', // Mount Athos
+ ),
+ 'IT' => array(
+ '22060', // Livigno, Campione d’Italia
+ '23030', // Lake Lugano
+ ),
+ 'FI' => array(
+ 'AX*', // Åland Islands
+ ),
+ 'CY' => array(
+ '9*', // Northern Cyprus
+ '5*', // Northern Cyprus
+ ),
+ );
+
+ if ( array_key_exists( $country, $exemptions ) ) {
+ foreach ( $exemptions[ $country ] as $exempt_postcode ) {
+ if ( in_array( $exempt_postcode, $postcode_wildcards, true ) ) {
+ $belongs = false;
+ break;
+ }
+ }
+ }
+ }
+
+ return apply_filters( 'woocommerce_gzd_country_belongs_to_eu_customs_area', $belongs, $country, $postcode );
+ }
+
+ public static function is_shipping_international( $country, $args = array() ) {
+ $args = self::parse_location_data( $args );
+ /**
+ * In case the sender country belongs to EU customs area, a third country needs to lie outside of the EU customs area
+ */
+ if ( self::country_belongs_to_eu_customs_area( $args['sender_country'], $args['sender_postcode'] ) ) {
+ if ( ! self::country_belongs_to_eu_customs_area( $country, $args['postcode'] ) ) {
+ return true;
+ }
+
+ return false;
+ } else {
+ if ( ! self::is_shipping_domestic( $country, $args ) ) {
+ return true;
+ }
+
+ return false;
+ }
+ }
+
+ public static function is_shipping_domestic( $country, $args = array() ) {
+ $args = self::parse_location_data( $args );
+ $is_domestic = $country === $args['sender_country'];
+
+ /**
+ * If the sender country belongs to EU customs area but the postcode (e.g. Helgoland in DE) not, do not consider domestic shipping
+ */
+ if ( $is_domestic && self::country_belongs_to_eu_customs_area( $args['sender_country'], $args['sender_postcode'] ) ) {
+ if ( ! self::country_belongs_to_eu_customs_area( $country, $args['postcode'] ) ) {
+ $is_domestic = false;
+ }
+ }
+
+ return $is_domestic;
+ }
+
+ private static function parse_location_data( $args = array() ) {
+ $args = wp_parse_args(
+ $args,
+ array(
+ 'postcode' => '',
+ 'sender_country' => self::get_base_country(),
+ 'sender_postcode' => self::get_base_postcode(),
+ )
+ );
+
+ return $args;
+ }
+
+ /**
+ * Whether shipping is inner EU (from one EU country to another) shipment or not.
+ *
+ * @param $country
+ * @param array $args
+ *
+ * @return mixed|void
+ */
+ public static function is_shipping_inner_eu_country( $country, $args = array() ) {
+ $args = self::parse_location_data( $args );
+
+ if ( self::is_shipping_domestic( $country, $args ) || ! self::country_belongs_to_eu_customs_area( $args['sender_country'], $args['sender_postcode'] ) ) {
+ return false;
+ }
+
+ return self::country_belongs_to_eu_customs_area( $country, $args['postcode'] );
+ }
+
+ 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' );
+ }
+ }
+
+ public static function is_feature_plugin() {
+ return defined( 'WC_GZD_SHIPMENTS_IS_FEATURE_PLUGIN' ) && WC_GZD_SHIPMENTS_IS_FEATURE_PLUGIN;
+ }
+
+ public static function check_version() {
+ if ( self::is_feature_plugin() && self::has_dependencies() && ! defined( 'IFRAME_REQUEST' ) && ( get_option( 'woocommerce_gzd_shipments_version' ) !== self::get_version() ) ) {
+ Install::install();
+
+ do_action( 'woocommerce_gzd_shipments_updated' );
+ }
+ }
+
+ /**
+ * 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 ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize
+ }
+
+ public static function log( $message, $type = 'info', $source = '' ) {
+ $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;
+ }
+
+ $logger = wc_get_logger();
+
+ if ( ! $logger ) {
+ return;
+ }
+
+ if ( ! is_callable( array( $logger, $type ) ) ) {
+ $type = 'info';
+ }
+
+ $logger->{$type}( $message, array( 'source' => 'wc-gzd-shipments' . ( ! empty( $source ) ? '-' . $source : '' ) ) );
+ }
+
+ 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();
+ MethodHelper::init();
+ Automation::init();
+ Labels\Automation::init();
+ Labels\DownloadHandler::init();
+ Emails::init();
+ Validation::init();
+ Api::init();
+ FormHandler::init();
+ ReportHelper::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';
+
+ do_action( 'woocommerce_gzd_shipments_registered_data_stores' );
+
+ 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( $rel_path = '' ) {
+ return trailingslashit( dirname( __DIR__ ) ) . $rel_path;
+ }
+
+ /**
+ * Return the path to the package.
+ *
+ * @return string
+ */
+ public static function get_url( $rel_path = '' ) {
+ return trailingslashit( plugins_url( '', __DIR__ ) ) . $rel_path;
+ }
+
+ public static function load_blocks() {
+ $woo_version = defined( 'WC_VERSION' ) ? WC_VERSION : '1.0.0';
+
+ return version_compare( $woo_version, '8.2.0', '>=' );
+ }
+
+ public static function get_assets_url( $script_or_style ) {
+ $assets_url = self::get_url() . '/build';
+ $is_debug = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG;
+ $is_style = '.css' === substr( $script_or_style, -4 );
+ $is_static = strstr( $script_or_style, 'static/' );
+
+ if ( $is_debug && $is_static && ! $is_style ) {
+ $assets_url = self::get_url() . '/assets/js';
+ }
+
+ return trailingslashit( $assets_url ) . $script_or_style;
+ }
+
+ 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'];
+ }
+
+ public static function is_valid_datetime( $maybe_datetime, $format = 'Y-m-d' ) {
+ if ( ! is_a( $maybe_datetime, 'DateTime' && ! is_numeric( $maybe_datetime ) ) ) {
+ if ( ! \DateTime::createFromFormat( $format, $maybe_datetime ) ) {
+ return false;
+ }
+ }
+
+ return true;
+ }
+
+ public static function is_valid_mysql_date( $mysql_date ) {
+ return ( '0000-00-00 00:00:00' === $mysql_date || null === $mysql_date ) ? false : true;
+ }
+
+ public static function extract_args_from_id( $id ) {
+ $args = array(
+ 'shipping_provider_name' => '',
+ 'shipment_type' => '',
+ 'zone' => '',
+ 'setting_group' => '',
+ 'setting_name' => '',
+ 'meta' => '',
+ );
+
+ $data = preg_split( '/-([a-z]-[a-zA-Z_0-9]+)-{0,1}/', $id, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY );
+
+ if ( false !== $data ) {
+ foreach ( $data as $d ) {
+ $arg = substr( $d, 0, 2 );
+ $val = substr( $d, 2 );
+
+ if ( 'p-' === $arg ) {
+ $args['shipping_provider_name'] = $val;
+ } elseif ( 's-' === $arg ) {
+ $args['shipment_type'] = $val;
+ } elseif ( 'z-' === $arg ) {
+ $args['zone'] = $val;
+ } elseif ( 'g-' === $arg ) {
+ $args['setting_group'] = $val;
+ } elseif ( 'n-' === $arg ) {
+ $args['setting_name'] = $val;
+ } elseif ( 'm-' === $arg ) {
+ $args['meta'] = $val;
+ }
+ }
+ }
+
+ return $args;
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Packaging.php b/packages/woocommerce-germanized-shipments/src/Packaging.php
new file mode 100644
index 000000000..40e022297
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Packaging.php
@@ -0,0 +1,540 @@
+ null,
+ 'weight' => 0,
+ 'max_content_weight' => 0,
+ 'width' => 0,
+ 'height' => 0,
+ 'length' => 0,
+ 'inner_width' => 0,
+ 'inner_height' => 0,
+ 'inner_length' => 0,
+ 'order' => 0,
+ 'type' => '',
+ 'description' => '',
+ 'available_shipping_provider' => array(),
+ 'available_shipping_classes' => array(),
+ 'configuration_sets' => array(),
+ );
+
+ /**
+ * 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 );
+ }
+
+ /**
+ * Returns the inner packaging length in cm.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_inner_length( $context = 'view' ) {
+ $inner_length = $this->get_prop( 'inner_length', $context );
+
+ if ( 'view' === $context && empty( $inner_length ) ) {
+ $inner_length = $this->get_length( $context );
+ }
+
+ return $inner_length;
+ }
+
+ /**
+ * Returns the packaging inner width in cm.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_inner_width( $context = 'view' ) {
+ $inner_width = $this->get_prop( 'inner_width', $context );
+
+ if ( 'view' === $context && empty( $inner_width ) ) {
+ $inner_width = $this->get_width( $context );
+ }
+
+ return $inner_width;
+ }
+
+ /**
+ * Returns the packaging inner height in cm.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return string
+ */
+ public function get_inner_height( $context = 'view' ) {
+ $inner_height = $this->get_prop( 'inner_height', $context );
+
+ if ( 'view' === $context && empty( $inner_height ) ) {
+ $inner_height = $this->get_height( $context );
+ }
+
+ return $inner_height;
+ }
+
+ public function has_inner_dimensions() {
+ return ! empty( $this->get_inner_width( 'edit' ) ) || ! empty( $this->get_inner_length( 'edit' ) ) || ! empty( $this->get_inner_height( 'edit' ) );
+ }
+
+ /**
+ * Returns the available shipping provider names.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return array
+ */
+ public function get_available_shipping_provider( $context = 'view' ) {
+ $provider_names = $this->get_prop( 'available_shipping_provider', $context );
+
+ if ( 'view' === $context && empty( $provider_names ) ) {
+ $provider_names = array_keys( Helper::instance()->get_available_shipping_providers() );
+ }
+
+ return $provider_names;
+ }
+
+ /**
+ * Returns the available shipping classes.
+ *
+ * @param string $context What the value is for. Valid values are 'view' and 'edit'.
+ * @return array
+ */
+ public function get_available_shipping_classes( $context = 'view' ) {
+ $classes = $this->get_prop( 'available_shipping_classes', $context );
+
+ if ( 'view' === $context && empty( $classes ) ) {
+ $classes = array_keys( Package::get_shipping_classes() );
+ }
+
+ return $classes;
+ }
+
+ public function supports_shipping_class( $shipping_class ) {
+ $classes = $this->get_available_shipping_classes( 'edit' );
+ $supports = false;
+
+ if ( empty( $classes ) || in_array( $shipping_class, $classes, true ) ) {
+ $supports = true;
+ }
+
+ return $supports;
+ }
+
+ public function supports_shipping_provider( $provider ) {
+ if ( is_a( $provider, 'Vendidero\Germanized\Shipments\Interfaces\ShippingProvider' ) ) {
+ $provider = $provider->get_name();
+ }
+
+ return apply_filters( "{$this->get_general_hook_prefix()}supports_shipping_provider", ( in_array( $provider, $this->get_available_shipping_provider(), true ) || empty( $provider ) ), $provider, $this );
+ }
+
+ 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 ),
+ );
+ }
+
+ /**
+ * Returns inner dimensions.
+ *
+ * @return string|array
+ */
+ public function get_inner_dimensions() {
+ return array(
+ 'length' => wc_format_decimal( $this->get_inner_length(), false, true ),
+ 'width' => wc_format_decimal( $this->get_inner_width(), false, true ),
+ 'height' => wc_format_decimal( $this->get_inner_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_formatted_inner_dimensions() {
+ return wc_gzd_format_shipment_dimensions( $this->get_inner_dimensions(), wc_gzd_get_packaging_dimension_unit() );
+ }
+
+ public function get_volume() {
+ return (float) $this->get_length() * (float) $this->get_width() * (float) $this->get_height();
+ }
+
+ public function get_inner_volume() {
+ return (float) $this->get_inner_length() * (float) $this->get_inner_width() * (float) $this->get_inner_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 shipping providers
+ *
+ * @param array $provider_names The provider names
+ */
+ public function set_available_shipping_provider( $provider_names ) {
+ $this->set_prop( 'available_shipping_provider', array_filter( (array) $provider_names ) );
+ }
+
+ /**
+ * Set packaging shipping classes
+ *
+ * @param array $classes The shipping classes
+ */
+ public function set_available_shipping_classes( $classes ) {
+ $this->set_prop( 'available_shipping_classes', array_filter( array_map( 'absint', (array) $classes ) ) );
+ }
+
+ /**
+ * 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 ) );
+ }
+
+ /**
+ * Set packaging inner width in cm.
+ *
+ * @param string $width The width.
+ */
+ public function set_inner_width( $width ) {
+ $this->set_prop( 'inner_width', empty( $width ) ? 0 : wc_format_decimal( $width, 1, true ) );
+ }
+
+ /**
+ * Set packaging inner length in cm.
+ *
+ * @param string $length The length.
+ */
+ public function set_inner_length( $length ) {
+ $this->set_prop( 'inner_length', empty( $length ) ? 0 : wc_format_decimal( $length, 1, true ) );
+ }
+
+ /**
+ * Set packaging inner height in cm.
+ *
+ * @param string $height The height.
+ */
+ public function set_inner_height( $height ) {
+ $this->set_prop( 'inner_height', empty( $height ) ? 0 : wc_format_decimal( $height, 1, true ) );
+ }
+
+ protected function get_configuration_set_setting_type() {
+ return 'packaging';
+ }
+
+ public function save() {
+ $changes = $this->get_changes();
+
+ /**
+ * Maybe reset inner dimensions when changing outer dimensions.
+ */
+ if ( ! empty( $changes ) ) {
+ foreach ( array( 'length', 'width', 'height' ) as $dim ) {
+ if ( isset( $changes[ $dim ] ) && ! isset( $changes[ "inner_{$dim}" ] ) ) {
+ $this->{"set_inner_{$dim}"}( 0 );
+ }
+ }
+ }
+
+ return parent::save();
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Packaging/AsyncReportGenerator.php b/packages/woocommerce-germanized-shipments/src/Packaging/AsyncReportGenerator.php
new file mode 100644
index 000000000..2fe1db778
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Packaging/AsyncReportGenerator.php
@@ -0,0 +1,195 @@
+type = $type;
+ $default_end = new \WC_DateTime();
+ $default_start = new \WC_DateTime( 'now' );
+ $default_start->modify( '-1 year' );
+
+ $args = wp_parse_args(
+ $args,
+ array(
+ 'start' => $default_start->format( 'Y-m-d' ),
+ 'end' => $default_end->format( 'Y-m-d' ),
+ 'limit' => ReportQueue::get_batch_size(),
+ 'status' => ReportQueue::get_shipment_statuses(),
+ 'offset' => 0,
+ 'type' => apply_filters( 'woocommerce_gzd_shipments_packaging_report_default_shipment_types', array( 'simple' ) ),
+ 'processed' => 0,
+ )
+ );
+
+ foreach ( array( 'start', 'end' ) as $date_field ) {
+ if ( is_a( $args[ $date_field ], 'WC_DateTime' ) ) {
+ $args[ $date_field ] = $args[ $date_field ]->format( 'Y-m-d' );
+ } elseif ( is_numeric( $args[ $date_field ] ) ) {
+ $date = new \WC_DateTime( '@' . $args[ $date_field ] );
+ $args[ $date_field ] = $date->format( 'Y-m-d' );
+ }
+ }
+
+ $this->args = $args;
+ }
+
+ public function get_type() {
+ return $this->type;
+ }
+
+ public function get_args() {
+ return $this->args;
+ }
+
+ public function get_id() {
+ return ReportHelper::get_report_id(
+ array(
+ 'type' => $this->type,
+ 'date_start' => $this->args['start'],
+ 'date_end' => $this->args['end'],
+ )
+ );
+ }
+
+ public function delete() {
+ $report = new Report( $this->get_id() );
+ $report->delete();
+
+ delete_option( $this->get_id() . '_tmp_result' );
+ }
+
+ public function start() {
+ $report = new Report( $this->get_id() );
+ $report->reset();
+ $report->save();
+
+ return $report;
+ }
+
+ /**
+ * @return true|\WP_Error
+ */
+ public function next() {
+ $args = $this->args;
+ $shipments = ReportQueue::query( $args );
+ $shipments_processed = 0;
+ $packaging_data = $this->get_temporary_result();
+
+ Package::log( sprintf( '%d applicable shipments found', count( $shipments ) ) );
+
+ if ( ! empty( $shipments ) ) {
+ foreach ( $shipments as $shipment ) {
+ $packaging_weight = $shipment->get_packaging_weight();
+ $packaging = $shipment->get_packaging();
+ $country = $shipment->get_country();
+ $packaging_id = 'other';
+
+ if ( ! $shipment->get_packaging_weight() ) {
+ Package::log( sprintf( 'Skipping shipment #%1$s due to missing packaging weight.', $shipment->get_id() ) );
+ continue;
+ }
+
+ if ( $packaging ) {
+ $packaging_id = $packaging->get_id();
+ }
+
+ if ( ! isset( $packaging_data[ $country ][ "$packaging_id" ] ) ) {
+ $packaging_data[ $country ][ "$packaging_id" ] = array(
+ 'count' => 0,
+ 'weight_in_kg' => 0.0,
+ );
+ }
+
+ $packaging_data[ $country ][ "$packaging_id" ]['count'] += 1;
+ $packaging_data[ $country ][ "$packaging_id" ]['weight_in_kg'] += wc_add_number_precision( (float) wc_get_weight( $packaging_weight, 'kg', $shipment->get_weight_unit() ), false );
+
+ $shipments_processed++;
+ }
+
+ $this->args['processed'] = absint( $this->args['processed'] ) + $shipments_processed;
+
+ update_option( $this->get_id() . '_tmp_result', $packaging_data, false );
+
+ return true;
+ } else {
+ return new \WP_Error( 'empty', _x( 'No shipments found.', 'shipments', 'woocommerce-germanized' ) );
+ }
+ }
+
+ /**
+ * @return Report
+ */
+ public function complete() {
+ Package::log( sprintf( 'Completed called' ) );
+
+ $tmp_result = $this->get_temporary_result();
+ $report = new Report( $this->get_id() );
+ $count_total = 0;
+ $weight_total = 0.0;
+ $packaging_totals = array();
+
+ foreach ( $tmp_result as $country => $packaging_ids ) {
+ $country_count_total = 0;
+ $country_weight_total = 0.0;
+
+ foreach ( $packaging_ids as $packaging_id => $totals ) {
+ $count_total += (int) $totals['count'];
+ $weight_total += (float) $totals['weight_in_kg'];
+ $country_count_total += (int) $totals['count'];
+ $country_weight_total += (float) $totals['weight_in_kg'];
+
+ if ( ! isset( $packaging_totals[ "$packaging_id" ] ) ) {
+ $packaging_totals[ "$packaging_id" ] = array(
+ 'count' => 0,
+ 'weight_in_kg' => 0.0,
+ );
+ }
+
+ $packaging_totals[ "$packaging_id" ]['count'] += (int) $totals['count'];
+ $packaging_totals[ "$packaging_id" ]['weight_in_kg'] += (float) $totals['weight_in_kg'];
+
+ $report->set_packaging_count_by_country( $country, $packaging_id, (int) $totals['count'] );
+ $report->set_packaging_weight_by_country( $country, $packaging_id, (float) wc_remove_number_precision( $totals['weight_in_kg'] ) );
+ }
+
+ $country_weight_total = (float) wc_remove_number_precision( $country_weight_total );
+
+ $report->set_total_packaging_count_by_country( $country, $country_count_total );
+ $report->set_total_packaging_weight_by_country( $country, $country_weight_total );
+ }
+
+ foreach ( $packaging_totals as $packaging_id => $totals ) {
+ $packaging_weight_total = (float) wc_remove_number_precision( $totals['weight_in_kg'] );
+
+ $report->set_packaging_count( $packaging_id, $totals['count'] );
+ $report->set_packaging_weight( $packaging_id, $packaging_weight_total );
+ }
+
+ $weight_total = (float) wc_remove_number_precision( $weight_total );
+
+ Package::log( sprintf( 'Completed packaging count: %d', $count_total ) );
+ Package::log( sprintf( 'Completed packaging weight: %s', $weight_total ) );
+
+ $report->set_total_count( $count_total );
+ $report->set_total_weight( $weight_total );
+ $report->set_status( 'completed' );
+ $report->set_version( Package::get_version() );
+ $report->save();
+
+ return $report;
+ }
+
+ protected function get_temporary_result() {
+ return (array) get_option( $this->get_id() . '_tmp_result', array() );
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Packaging/Report.php b/packages/woocommerce-germanized-shipments/src/Packaging/Report.php
new file mode 100644
index 000000000..099b06851
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Packaging/Report.php
@@ -0,0 +1,422 @@
+set_id( $id );
+
+ if ( empty( $args ) ) {
+ $args = (array) get_option( $this->id . '_result', array() );
+ }
+
+ $args = wp_parse_args(
+ $args,
+ array(
+ 'packaging' => array(),
+ 'countries' => array(),
+ 'totals' => array(),
+ 'meta' => array(),
+ )
+ );
+
+ $args['totals'] = wp_parse_args(
+ $args['totals'],
+ array(
+ 'weight_in_kg' => 0.0,
+ 'count' => 0,
+ )
+ );
+
+ $args['meta'] = wp_parse_args(
+ $args['meta'],
+ array(
+ 'date_requested' => null,
+ 'status' => 'pending',
+ 'version' => '',
+ )
+ );
+
+ $this->set_date_requested( $args['meta']['date_requested'] );
+ $this->set_status( $args['meta']['status'] );
+ $this->set_version( $args['meta']['version'] );
+
+ $this->args = $args;
+ }
+
+ public function exists() {
+ return get_option( $this->id . '_result', false );
+ }
+
+ public function get_title() {
+ $title = ReportHelper::get_report_title( $this->get_id() );
+
+ if ( $this->get_date_requested() ) {
+ $title = $title . ' @ ' . $this->get_date_requested()->date_i18n();
+ }
+
+ return $title;
+ }
+
+ public function get_url() {
+ return admin_url( 'admin.php?page=shipment-packaging-report&report=' . $this->get_id() );
+ }
+
+ public function get_delete_link() {
+ return add_query_arg(
+ array(
+ 'action' => 'wc_gzd_shipments_packaging_delete_report',
+ 'report_id' => $this->get_id(),
+ ),
+ wp_nonce_url( admin_url( 'admin-post.php' ), 'wc_gzd_shipments_packaging_delete_report' )
+ );
+ }
+
+ public function get_refresh_link() {
+ return add_query_arg(
+ array(
+ 'action' => 'wc_gzd_shipments_packaging_refresh_report',
+ 'report_id' => $this->get_id(),
+ ),
+ wp_nonce_url( admin_url( 'admin-post.php' ), 'wc_gzd_shipments_packaging_refresh_report' )
+ );
+ }
+
+ public function get_cancel_link() {
+ return add_query_arg(
+ array(
+ 'action' => 'wc_gzd_shipments_packaging_cancel_report',
+ 'report_id' => $this->get_id(),
+ ),
+ wp_nonce_url( admin_url( 'admin-post.php' ), 'wc_gzd_shipments_packaging_cancel_report' )
+ );
+ }
+
+ public function get_type() {
+ return $this->type;
+ }
+
+ public function set_type( $type ) {
+ $this->set_id_part( $type, 'type' );
+ }
+
+ public function set_id( $id ) {
+ $this->id = $id;
+ $data = ReportHelper::get_report_data( $this->id );
+ $this->type = $data['type'];
+ $this->date_start = $data['date_start'];
+ $this->date_end = $data['date_end'];
+ }
+
+ public function set_id_part( $value, $part = 'type' ) {
+ $data = ReportHelper::get_report_data( $this->id );
+ $data[ $part ] = $value;
+
+ $this->set_id( ReportHelper::get_report_id( $data ) );
+ }
+
+ public function get_id() {
+ return $this->id;
+ }
+
+ public function get_date_start() {
+ return $this->date_start;
+ }
+
+ public function set_date_start( $date ) {
+ $date = ReportHelper::string_to_datetime( $date );
+
+ $this->set_id_part( $date->format( 'Y-m-d' ), 'date_start' );
+ }
+
+ public function get_date_end() {
+ return $this->date_end;
+ }
+
+ public function set_date_end( $date ) {
+ $date = ReportHelper::string_to_datetime( $date );
+
+ $this->set_id_part( $date->format( 'Y-m-d' ), 'date_end' );
+ }
+
+ public function get_status() {
+ return $this->args['meta']['status'];
+ }
+
+ public function get_version() {
+ return $this->args['meta']['version'];
+ }
+
+ public function set_status( $status ) {
+ $this->args['meta']['status'] = $status;
+ }
+
+ public function set_version( $version ) {
+ $this->args['meta']['version'] = $version;
+ }
+
+ public function get_date_requested() {
+ return is_null( $this->args['meta']['date_requested'] ) ? null : ReportHelper::string_to_datetime( $this->args['meta']['date_requested'] );
+ }
+
+ public function set_date_requested( $date ) {
+ if ( ! empty( $date ) ) {
+ $date = ReportHelper::string_to_datetime( $date );
+ }
+
+ $this->args['meta']['date_requested'] = is_a( $date, 'WC_DateTime' ) ? $date->date( 'Y-m-d' ) : null;
+ }
+
+ /**
+ * @return int
+ */
+ public function get_total_count() {
+ return (int) $this->args['totals']['count'];
+ }
+
+ public function get_total_weight( $round = true, $unit = '' ) {
+ if ( '' === $unit ) {
+ $unit = wc_gzd_get_packaging_weight_unit();
+ }
+
+ $weight = wc_get_weight( $this->args['totals']['weight_in_kg'], $unit, 'kg' );
+
+ return $this->maybe_round( $weight, $round );
+ }
+
+ public function set_total_weight( $weight ) {
+ $this->args['totals']['weight_in_kg'] = wc_format_decimal( floatval( $weight ) );
+ }
+
+ public function set_total_count( $count ) {
+ $this->args['totals']['count'] = absint( $count );
+ }
+
+ public function get_packaging_ids() {
+ return array_keys( $this->args['packaging'] );
+ }
+
+ public function get_countries() {
+ return array_keys( $this->args['countries'] );
+ }
+
+ public function reset() {
+ $this->args['packaging'] = array();
+ $this->args['countries'] = array();
+
+ $this->set_total_count( 0 );
+ $this->set_total_weight( 0 );
+ $this->set_date_requested( new \WC_DateTime() );
+ $this->set_status( 'pending' );
+ $this->set_version( Package::get_version() );
+
+ delete_option( $this->id . '_tmp_result' );
+ }
+
+ public function get_packaging_ids_by_country( $country ) {
+ $packaging_ids = array();
+
+ if ( array_key_exists( $country, $this->args['countries'] ) ) {
+ $packaging_ids = array_keys( $this->args['countries'][ $country ]['packaging'] );
+ }
+
+ return $packaging_ids;
+ }
+
+ public function get_packaging_count( $packaging_id, $country = '' ) {
+ $count = 0;
+
+ if ( '' === $country ) {
+ if ( isset( $this->args['packaging'][ "$packaging_id" ] ) ) {
+ $count = absint( $this->args['packaging'][ "$packaging_id" ]['count'] );
+ }
+ } else {
+ if ( isset( $this->args['countries'][ $country ], $this->args['countries'][ $country ]['packaging'][ "$packaging_id" ] ) ) {
+ $count = absint( $this->args['countries'][ $country ]['packaging'][ "$packaging_id" ]['count'] );
+ }
+ }
+
+ return $count;
+ }
+
+ public function get_packaging_weight( $packaging_id, $country = '', $round = true, $unit = '' ) {
+ $weight = 0.0;
+
+ if ( '' === $country ) {
+ if ( isset( $this->args['packaging'][ "$packaging_id" ] ) ) {
+ $weight = $this->args['packaging'][ "$packaging_id" ]['weight_in_kg'];
+ }
+ } else {
+ if ( isset( $this->args['countries'][ $country ], $this->args['countries'][ $country ]['packaging'][ "$packaging_id" ] ) ) {
+ $weight = $this->args['countries'][ $country ]['packaging'][ "$packaging_id" ]['weight_in_kg'];
+ }
+ }
+
+ $weight = wc_get_weight( $weight, $unit, 'kg' );
+
+ return $this->maybe_round( $weight, $round );
+ }
+
+ public function get_total_packaging_weight_by_country( $country, $round = true, $unit = '' ) {
+ $weight = 0.0;
+
+ if ( isset( $this->args['countries'][ $country ] ) ) {
+ $weight = $this->args['countries'][ $country ]['weight_in_kg'];
+ }
+
+ $weight = wc_get_weight( $weight, $unit, 'kg' );
+
+ return $this->maybe_round( $weight, $round );
+ }
+
+ public function get_total_packaging_count_by_country( $country ) {
+ $count = 0;
+
+ if ( isset( $this->args['countries'][ $country ] ) ) {
+ $count = absint( $this->args['countries'][ $country ]['count'] );
+ }
+
+ return $count;
+ }
+
+ public function set_packaging_count( $packaging_id, $count ) {
+ if ( ! isset( $this->args['packaging'][ "$packaging_id" ] ) ) {
+ $this->args['packaging'][ "$packaging_id" ] = array(
+ 'count' => 0,
+ 'weight_in_kg' => 0.0,
+ );
+ }
+
+ $this->args['packaging'][ "$packaging_id" ]['count'] = absint( $count );
+ }
+
+ public function set_packaging_weight( $packaging_id, $weight ) {
+ if ( ! isset( $this->args['packaging'][ "$packaging_id" ] ) ) {
+ $this->args['packaging'][ "$packaging_id" ] = array(
+ 'count' => 0,
+ 'weight_in_kg' => 0.0,
+ );
+ }
+
+ $this->args['packaging'][ "$packaging_id" ]['weight_in_kg'] = (float) wc_format_decimal( $weight );
+ }
+
+ public function set_packaging_count_by_country( $country, $packaging_id, $count ) {
+ if ( ! isset( $this->args['countries'][ $country ] ) ) {
+ $this->args['countries'][ $country ] = array(
+ 'count' => 0,
+ 'weight_in_kg' => 0.0,
+ 'packaging' => array(),
+ );
+ }
+
+ if ( ! isset( $this->args['countries'][ $country ]['packaging'][ "$packaging_id" ] ) ) {
+ $this->args['countries'][ $country ]['packaging'][ "$packaging_id" ] = array(
+ 'count' => 0,
+ 'weight_in_kg' => 0.0,
+ );
+ }
+
+ $this->args['countries'][ $country ]['packaging'][ "$packaging_id" ]['count'] = absint( $count );
+ }
+
+ public function set_packaging_weight_by_country( $country, $packaging_id, $weight ) {
+ if ( ! isset( $this->args['countries'][ $country ] ) ) {
+ $this->args['countries'][ $country ] = array(
+ 'count' => 0,
+ 'weight_in_kg' => 0.0,
+ 'packaging' => array(),
+ );
+ }
+
+ if ( ! isset( $this->args['countries'][ $country ]['packaging'][ "$packaging_id" ] ) ) {
+ $this->args['countries'][ $country ]['packaging'][ "$packaging_id" ] = array(
+ 'count' => 0,
+ 'weight_in_kg' => 0.0,
+ );
+ }
+
+ $this->args['countries'][ $country ]['packaging'][ "$packaging_id" ]['weight_in_kg'] = (float) wc_format_decimal( $weight );
+ }
+
+ public function set_total_packaging_count_by_country( $country, $count ) {
+ if ( ! isset( $this->args['countries'][ $country ] ) ) {
+ $this->args['countries'][ $country ] = array(
+ 'count' => 0,
+ 'weight_in_kg' => 0.0,
+ 'packaging' => array(),
+ );
+ }
+
+ $this->args['countries'][ $country ]['count'] = absint( $count );
+ }
+
+ public function set_total_packaging_weight_by_country( $country, $weight ) {
+ if ( ! isset( $this->args['countries'][ $country ] ) ) {
+ $this->args['countries'][ $country ] = array(
+ 'count' => 0,
+ 'weight_in_kg' => 0.0,
+ 'packaging' => array(),
+ );
+ }
+
+ $this->args['countries'][ $country ]['weight_in_kg'] = (float) wc_format_decimal( $weight );
+ }
+
+ protected function maybe_round( $total, $round = true ) {
+ $decimals = is_numeric( $round ) ? (int) $round : '';
+
+ return (float) wc_format_decimal( $total, $round ? $decimals : false );
+ }
+
+ public function save() {
+ update_option( $this->id . '_result', $this->args, false );
+
+ $reports_available = ReportHelper::get_report_ids();
+
+ if ( ! in_array( $this->get_id(), $reports_available[ $this->get_type() ], true ) ) {
+ // Add new report to start of the list
+ array_unshift( $reports_available[ $this->get_type() ], $this->get_id() );
+ update_option( 'woocommerce_gzd_shipments_packaging_reports', $reports_available, false );
+ }
+
+ delete_option( $this->id . '_tmp_result' );
+
+ ReportHelper::clear_caches();
+
+ return $this->id;
+ }
+
+ public function delete() {
+ delete_option( $this->id . '_result' );
+ delete_option( $this->id . '_tmp_result' );
+
+ ReportQueue::maybe_stop_report( $this->get_id() );
+ ReportHelper::remove_report( $this );
+
+ ReportHelper::clear_caches();
+
+ return true;
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Packaging/ReportHelper.php b/packages/woocommerce-germanized-shipments/src/Packaging/ReportHelper.php
new file mode 100644
index 000000000..d4990ebb6
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Packaging/ReportHelper.php
@@ -0,0 +1,518 @@
+ array(
+ 'url' => $report->get_url(),
+ 'title' => _x( 'View', 'shipments-packaging-report', 'woocommerce-germanized' ),
+ ),
+ 'refresh' => array(
+ 'url' => $report->get_refresh_link(),
+ 'title' => _x( 'Refresh', 'shipments-packaging-report', 'woocommerce-germanized' ),
+ ),
+ 'delete' => array(
+ 'url' => $report->get_delete_link(),
+ 'title' => _x( 'Delete', 'shipments-packaging-report', 'woocommerce-germanized' ),
+ ),
+ );
+
+ if ( 'completed' !== $report->get_status() ) {
+ $actions['cancel'] = $actions['delete'];
+ $actions['cancel']['title'] = _x( 'Cancel', 'shipments-packaging-report', 'woocommerce-germanized' );
+
+ unset( $actions['view'] );
+ unset( $actions['refresh'] );
+ unset( $actions['delete'] );
+ }
+
+ return $actions;
+ }
+
+ public static function render_report() {
+ if ( isset( $_GET['report'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+ $report_id = isset( $_GET['report'] ) ? wc_clean( wp_unslash( $_GET['report'] ) ) : false; // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+
+ if ( ! $report_id ) {
+ return;
+ }
+
+ if ( ! $report = self::get_report( $report_id ) ) {
+ return;
+ }
+
+ $columns = array(
+ 'packaging' => _x( 'Packaging', 'shipments', 'woocommerce-germanized' ),
+ 'weight' => _x( 'Weight', 'shipments', 'woocommerce-germanized' ),
+ 'count' => _x( 'Count', 'shipments', 'woocommerce-germanized' ),
+ );
+
+ $actions = self::get_report_actions( $report );
+ $countries = WC()->countries->get_countries();
+ $packaging_ids = $report->get_packaging_ids();
+ ?>
+
+
+ + +
+
+
+
+
+ get_countries() as $country ) :
+ ?>
+
+
+
+
+
+
+
+ get_status() ) {
+ $report->delete();
+ }
+ }
+ }
+ }
+
+ $running = array_values( $running );
+
+ update_option( 'woocommerce_gzd_shipments_packaging_reports_running', $running, false );
+ ReportQueue::clear_cache();
+ }
+
+ public static function setup_recurring_actions() {
+ if ( $queue = ReportQueue::get_queue() ) {
+ // Schedule once per day at 2:00
+ if ( null === $queue->get_next( 'woocommerce_gzd_shipments_daily_cleanup', array(), 'woocommerce_gzd_shipments' ) ) {
+ $timestamp = strtotime( 'tomorrow midnight' );
+ $date = new \WC_DateTime();
+
+ $date->setTimestamp( $timestamp );
+ $date->modify( '+2 hours' );
+
+ $queue->cancel_all( 'woocommerce_gzd_shipments_daily_cleanup', array(), 'woocommerce_gzd_shipments' );
+ $queue->schedule_recurring( $date->getTimestamp(), DAY_IN_SECONDS, 'woocommerce_gzd_shipments_daily_cleanup', array(), 'woocommerce_gzd_shipments' );
+ }
+ }
+ }
+
+ public static function get_report_title( $id ) {
+ $args = self::get_report_data( $id );
+ $title = _x( 'Report', 'shipments', 'woocommerce-germanized' );
+
+ if ( 'quarterly' === $args['type'] ) {
+ $date_start = $args['date_start'];
+ $quarter = 1;
+ $month_num = (int) $date_start->date_i18n( 'n' );
+
+ if ( 4 === $month_num ) {
+ $quarter = 2;
+ } elseif ( 7 === $month_num ) {
+ $quarter = 3;
+ } elseif ( 10 === $month_num ) {
+ $quarter = 4;
+ }
+
+ $title = sprintf( _x( 'Q%1$s/%2$s', 'shipments', 'woocommerce-germanized' ), $quarter, $date_start->date_i18n( 'Y' ) );
+ } elseif ( 'monthly' === $args['type'] ) {
+ $date_start = $args['date_start'];
+ $month_num = $date_start->date_i18n( 'm' );
+
+ $title = sprintf( _x( '%1$s/%2$s', 'shipments', 'woocommerce-germanized' ), $month_num, $date_start->date_i18n( 'Y' ) );
+ } elseif ( 'yearly' === $args['type'] ) {
+ $date_start = $args['date_start'];
+
+ $title = sprintf( _x( '%1$s', 'shipments', 'woocommerce-germanized' ), $date_start->date_i18n( 'Y' ) ); // phpcs:ignore WordPress.WP.I18n.NoEmptyStrings
+ } elseif ( 'custom' === $args['type'] ) {
+ $date_start = $args['date_start'];
+ $date_end = $args['date_end'];
+
+ $title = sprintf( _x( '%1$s - %2$s', 'shipments', 'woocommerce-germanized' ), $date_start->date_i18n( 'Y-m-d' ), $date_end->date_i18n( 'Y-m-d' ) );
+ }
+
+ return $title;
+ }
+
+ public static function get_report_id( $parts ) {
+ $parts = wp_parse_args(
+ $parts,
+ array(
+ 'type' => 'daily',
+ 'date_start' => date( 'Y-m-d' ), // phpcs:ignore WordPress.DateTime.RestrictedFunctions.date_date
+ 'date_end' => date( 'Y-m-d' ), // phpcs:ignore WordPress.DateTime.RestrictedFunctions.date_date
+ )
+ );
+
+ if ( is_a( $parts['date_start'], 'WC_DateTime' ) ) {
+ $parts['date_start'] = $parts['date_start']->format( 'Y-m-d' );
+ }
+
+ if ( is_a( $parts['date_end'], 'WC_DateTime' ) ) {
+ $parts['date_end'] = $parts['date_end']->format( 'Y-m-d' );
+ }
+
+ return sanitize_key( 'woocommerce_gzd_shipments_packaging_' . $parts['type'] . '_report_' . $parts['date_start'] . '_' . $parts['date_end'] );
+ }
+
+ public static function get_available_report_types() {
+ $types = array(
+ 'quarterly' => _x( 'Quarterly', 'shipments', 'woocommerce-germanized' ),
+ 'yearly' => _x( 'Yearly', 'shipments', 'woocommerce-germanized' ),
+ 'monthly' => _x( 'Monthly', 'shipments', 'woocommerce-germanized' ),
+ 'custom' => _x( 'Custom', 'shipments', 'woocommerce-germanized' ),
+ );
+
+ return $types;
+ }
+
+ public static function get_report_data( $id ) {
+ $clean_id = str_replace( 'packaging_', '', $id );
+ $clean_id = str_replace( 'woocommerce_gzd_shipments_', '', $clean_id );
+ $id_parts = explode( '_', $clean_id );
+
+ $data = array(
+ 'id' => $id,
+ 'type' => $id_parts[0],
+ 'date_start' => self::string_to_datetime( $id_parts[2] ),
+ 'date_end' => self::string_to_datetime( $id_parts[3] ),
+ );
+
+ return $data;
+ }
+
+ public static function string_to_datetime( $time_string ) {
+ if ( is_string( $time_string ) && ! is_numeric( $time_string ) ) {
+ $time_string = strtotime( $time_string );
+ }
+
+ $date_time = $time_string;
+
+ if ( is_numeric( $date_time ) ) {
+ $date_time = new \WC_DateTime( "@{$date_time}", new \DateTimeZone( 'UTC' ) );
+ }
+
+ if ( ! is_a( $date_time, 'WC_DateTime' ) ) {
+ return null;
+ }
+
+ return $date_time;
+ }
+
+ public static function clear_caches() {
+ delete_transient( 'woocommerce_gzd_shipments_packaging_report_counts' );
+ wp_cache_delete( 'woocommerce_gzd_shipments_packaging_reports', 'options' );
+ }
+
+ public static function get_report_ids() {
+ $reports = (array) get_option( 'woocommerce_gzd_shipments_packaging_reports', array() );
+
+ foreach ( array_keys( self::get_available_report_types() ) as $type ) {
+ if ( ! array_key_exists( $type, $reports ) ) {
+ $reports[ $type ] = array();
+ }
+ }
+
+ return $reports;
+ }
+
+ public static function get_report_status_title( $status ) {
+ if ( 'completed' === $status ) {
+ return _x( 'Completed', 'shipments-report-status', 'woocommerce-germanized' );
+ } else {
+ return _x( 'Pending', 'shipments-report-status', 'woocommerce-germanized' );
+ }
+ }
+
+ /**
+ * @param array $args
+ *
+ * @return Report[]
+ */
+ public static function get_reports( $args = array() ) {
+ $args = wp_parse_args(
+ $args,
+ array(
+ 'type' => '',
+ 'limit' => -1,
+ 'offset' => 0,
+ 'orderby' => 'date_start',
+ )
+ );
+
+ $ids = self::get_report_ids();
+
+ if ( ! empty( $args['type'] ) ) {
+ $report_ids = array_key_exists( $args['type'], $ids ) ? $ids[ $args['type'] ] : array();
+ } else {
+ $report_ids = array_merge( ...array_values( $ids ) );
+ }
+
+ $reports_sorted = array();
+
+ foreach ( $report_ids as $id ) {
+ $reports_sorted[] = self::get_report_data( $id );
+ }
+
+ if ( array_key_exists( $args['orderby'], array( 'date_start', 'date_end' ) ) ) {
+ usort(
+ $reports_sorted,
+ function( $a, $b ) use ( $args ) {
+ if ( $a[ $args['orderby'] ] === $b[ $args['orderby'] ] ) {
+ return 0;
+ }
+
+ return $a[ $args['orderby'] ] < $b[ $args['orderby'] ] ? -1 : 1;
+ }
+ );
+ }
+
+ if ( -1 !== $args['limit'] ) {
+ $reports_sorted = array_slice( $reports_sorted, $args['offset'], $args['limit'] );
+ }
+
+ $reports = array();
+
+ foreach ( $reports_sorted as $data ) {
+ if ( $report = self::get_report( $data['id'] ) ) {
+ $reports[] = $report;
+ }
+ }
+
+ return $reports;
+ }
+
+ /**
+ * @param Report $report
+ */
+ public static function remove_report( $report ) {
+ $reports_available = self::get_report_ids();
+
+ if ( in_array( $report->get_id(), $reports_available[ $report->get_type() ], true ) ) {
+ $reports_available[ $report->get_type() ] = array_diff( $reports_available[ $report->get_type() ], array( $report->get_id() ) );
+
+ update_option( 'woocommerce_gzd_shipments_packaging_reports', $reports_available, false );
+
+ /**
+ * Force non-cached option
+ */
+ wp_cache_delete( 'woocommerce_gzd_shipments_packaging_reports', 'options' );
+ }
+ }
+
+ /**
+ * @param $id
+ *
+ * @return false|Report
+ */
+ public static function get_report( $id ) {
+ $report = new Report( $id );
+
+ if ( $report->exists() ) {
+ return $report;
+ }
+
+ return false;
+ }
+
+ public static function delete_report() {
+ if ( ! current_user_can( 'manage_woocommerce' ) || ! wp_verify_nonce( isset( $_GET['_wpnonce'] ) ? wp_unslash( $_GET['_wpnonce'] ) : '', 'wc_gzd_shipments_packaging_delete_report' ) ) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
+ wp_die();
+ }
+
+ $report_id = isset( $_GET['report_id'] ) ? wc_clean( wp_unslash( $_GET['report_id'] ) ) : '';
+
+ if ( ! empty( $report_id ) && ( $report = self::get_report( $report_id ) ) ) {
+ $report->delete();
+
+ $referer = self::get_clean_referer();
+
+ /**
+ * Do not redirect deleted, refreshed reports back to report details page
+ */
+ if ( strstr( $referer, '&report=' ) ) {
+ $referer = Settings::get_settings_url( 'packaging' );
+ }
+
+ wp_safe_redirect( esc_url_raw( add_query_arg( array( 'report_deleted' => $report_id ), $referer ) ) );
+ exit();
+ }
+
+ wp_safe_redirect( esc_url_raw( wp_get_referer() ) );
+ exit();
+ }
+
+ protected static function get_clean_referer() {
+ $referer = wp_get_referer();
+
+ return remove_query_arg( array( 'report_created', 'report_deleted', 'report_restarted', 'report_cancelled' ), $referer );
+ }
+
+ public static function refresh_report() {
+ if ( ! current_user_can( 'manage_woocommerce' ) || ! wp_verify_nonce( isset( $_GET['_wpnonce'] ) ? wp_unslash( $_GET['_wpnonce'] ) : '', 'wc_gzd_shipments_packaging_refresh_report' ) ) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
+ wp_die();
+ }
+
+ $report_id = isset( $_GET['report_id'] ) ? wc_clean( wp_unslash( $_GET['report_id'] ) ) : '';
+
+ if ( ! empty( $report_id ) && ( $report = self::get_report( $report_id ) ) ) {
+ ReportQueue::start( $report->get_type(), $report->get_date_start(), $report->get_date_end() );
+
+ wp_safe_redirect( esc_url_raw( add_query_arg( array( 'report_restarted' => $report_id ), self::get_clean_referer() ) ) );
+ exit();
+ }
+
+ wp_safe_redirect( esc_url_raw( wp_get_referer() ) );
+ exit();
+ }
+
+ public static function cancel_report() {
+ if ( ! current_user_can( 'manage_woocommerce' ) || ! wp_verify_nonce( isset( $_GET['_wpnonce'] ) ? wp_unslash( $_GET['_wpnonce'] ) : '', 'wc_gzd_shipments_packaging_cancel_report' ) ) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
+ wp_die();
+ }
+
+ $report_id = isset( $_GET['report_id'] ) ? wc_clean( wp_unslash( $_GET['report_id'] ) ) : '';
+
+ if ( ! empty( $report_id ) && ReportQueue::is_running( $report_id ) ) {
+ ReportQueue::cancel( $report_id );
+
+ $referer = self::get_clean_referer();
+
+ /**
+ * Do not redirect deleted, refreshed reports back to report details page
+ */
+ if ( strstr( $referer, '&report=' ) ) {
+ $referer = Settings::get_settings_url( 'packaging' );
+ }
+
+ wp_safe_redirect( esc_url_raw( add_query_arg( array( 'report_cancelled' => $report_id ), $referer ) ) );
+ exit();
+ }
+
+ wp_safe_redirect( esc_url_raw( wp_get_referer() ) );
+ exit();
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Packaging/ReportQueue.php b/packages/woocommerce-germanized-shipments/src/Packaging/ReportQueue.php
new file mode 100644
index 000000000..047953647
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Packaging/ReportQueue.php
@@ -0,0 +1,337 @@
+diff( $args['end'] );
+
+ // Add version
+ $args['version'] = Package::get_version();
+
+ $generator = new AsyncReportGenerator( $type, $args );
+ $queue_args = $generator->get_args();
+ $queue = self::get_queue();
+
+ self::cancel( $generator->get_id() );
+
+ $report = $generator->start();
+
+ if ( is_a( $report, '\Vendidero\Germanized\Shipments\Packaging\Report' ) && $report->exists() ) {
+ Package::log( sprintf( 'Starting new %1$s', $report->get_title() ) );
+ Package::log( sprintf( 'Default report arguments: %s', wc_print_r( $queue_args, true ) ) );
+
+ $queue->schedule_single(
+ time() + 10,
+ self::get_hook_name( $generator->get_id() ),
+ array( 'args' => $queue_args ),
+ 'woocommerce_gzd_shipments'
+ );
+
+ $running = self::get_reports_running();
+
+ if ( ! in_array( $generator->get_id(), $running, true ) ) {
+ $running[] = $generator->get_id();
+ }
+
+ update_option( 'woocommerce_gzd_shipments_packaging_reports_running', $running, false );
+ self::clear_cache();
+
+ return $generator->get_id();
+ }
+
+ return false;
+ }
+
+ public static function clear_cache() {
+ wp_cache_delete( 'woocommerce_gzd_shipments_packaging_reports_running', 'options' );
+ }
+
+ public static function get_queue_details( $report_id ) {
+ $details = array(
+ 'next_date' => null,
+ 'link' => admin_url( 'admin.php?page=wc-status&tab=action-scheduler&s=' . esc_attr( $report_id ) . '&status=pending' ),
+ 'shipment_count' => 0,
+ 'has_action' => false,
+ 'is_finished' => false,
+ 'action' => false,
+ );
+
+ if ( $queue = self::get_queue() ) {
+ if ( $next_date = $queue->get_next( self::get_hook_name( $report_id ) ) ) {
+ $details['next_date'] = $next_date;
+ }
+
+ $search_args = array(
+ 'hook' => self::get_hook_name( $report_id ),
+ 'status' => \ActionScheduler_Store::STATUS_RUNNING,
+ 'order' => 'DESC',
+ 'per_page' => 1,
+ );
+
+ $results = $queue->search( $search_args );
+
+ /**
+ * Search for pending as fallback
+ */
+ if ( empty( $results ) ) {
+ $search_args['status'] = \ActionScheduler_Store::STATUS_PENDING;
+ $results = $queue->search( $search_args );
+ }
+
+ /**
+ * Last resort: Search for completed (e.g. if no pending and no running are found - must have been completed)
+ */
+ if ( empty( $results ) ) {
+ $search_args['status'] = \ActionScheduler_Store::STATUS_COMPLETE;
+ $results = $queue->search( $search_args );
+ }
+
+ if ( ! empty( $results ) ) {
+ $action = array_values( $results )[0];
+ $args = $action->get_args();
+ $processed = isset( $args['args']['processed'] ) ? (int) $args['args']['processed'] : 0;
+
+ $details['shipment_count'] = absint( $processed );
+ $details['has_action'] = true;
+ $details['action'] = $action;
+ $details['is_finished'] = $action->is_finished();
+ }
+ }
+
+ return $details;
+ }
+
+ public static function get_batch_size() {
+ return apply_filters( 'woocommerce_gzd_shipments_packaging_report_batch_size', 25 );
+ }
+
+ public static function get_shipment_statuses() {
+ $statuses = array_keys( wc_gzd_get_shipment_statuses() );
+ $statuses = array_diff( $statuses, array( 'gzd-draft', 'gzd-requested' ) );
+
+ return apply_filters( 'woocommerce_gzd_shipments_packaging_report_valid_statuses', $statuses );
+ }
+
+ /**
+ * @param $args
+ *
+ * @return \Vendidero\Germanized\Shipments\Shipment[]
+ */
+ public static function query( $args ) {
+ $query_args = array(
+ 'date_created' => $args['start'] . '...' . $args['end'],
+ 'offset' => $args['offset'],
+ 'type' => $args['type'],
+ 'status' => $args['status'],
+ 'limit' => $args['limit'],
+ );
+
+ return wc_gzd_get_shipments( $query_args );
+ }
+
+ public static function cancel( $id ) {
+ $data = ReportHelper::get_report_data( $id );
+ $generator = new AsyncReportGenerator( $data['type'], $data );
+ $queue = self::get_queue();
+ $running = self::get_reports_running();
+
+ if ( self::is_running( $id ) ) {
+ $running = array_diff( $running, array( $id ) );
+ Package::log( sprintf( 'Cancelled %s', ReportHelper::get_report_title( $id ) ) );
+
+ update_option( 'woocommerce_gzd_shipments_packaging_reports_running', $running, false );
+ self::clear_cache();
+ $generator->delete();
+ }
+
+ /**
+ * Cancel outstanding events and queue new.
+ */
+ $queue->cancel_all( self::get_hook_name( $id ) );
+ }
+
+ public static function get_queue() {
+ return function_exists( 'WC' ) ? WC()->queue() : false;
+ }
+
+ public static function is_running( $id ) {
+ $running = self::get_reports_running();
+
+ if ( in_array( $id, $running, true ) && self::get_queue()->get_next( self::get_hook_name( $id ) ) ) {
+ return true;
+ }
+
+ return false;
+ }
+
+ public static function get_hook_name( $id ) {
+ if ( ! strstr( $id, 'woocommerce_gzd_shipments_' ) ) {
+ $id = 'woocommerce_gzd_shipments_' . $id;
+ }
+
+ return $id;
+ }
+
+ public static function next( $type, $args ) {
+ $generator = new AsyncReportGenerator( $type, $args );
+ $result = $generator->next();
+ $is_empty = false;
+ $queue = self::get_queue();
+
+ if ( is_wp_error( $result ) ) {
+ $is_empty = $result->get_error_message( 'empty' );
+ }
+
+ if ( ! $is_empty ) {
+ $new_args = $generator->get_args();
+
+ // Increase offset
+ $new_args['offset'] = (int) $new_args['offset'] + (int) $new_args['limit'];
+
+ $queue->cancel_all( self::get_hook_name( $generator->get_id() ) );
+
+ Package::log( sprintf( 'Starting new queue: %s', wc_print_r( $new_args, true ) ) );
+
+ $queue->schedule_single(
+ time() + 10,
+ self::get_hook_name( $generator->get_id() ),
+ array( 'args' => $new_args ),
+ 'woocommerce_gzd_shipments'
+ );
+ } else {
+ self::complete( $generator );
+ }
+ }
+
+ /**
+ * @param AsyncReportGenerator $generator
+ */
+ public static function complete( $generator ) {
+ $queue = self::get_queue();
+ $type = $generator->get_type();
+
+ /**
+ * Cancel outstanding events.
+ */
+ $queue->cancel_all( self::get_hook_name( $generator->get_id() ) );
+
+ $report = $generator->complete();
+ $status = 'failed';
+
+ if ( is_a( $report, '\Vendidero\Germanized\Shipments\Packaging\Report' ) && $report->exists() ) {
+ $status = 'completed';
+ }
+
+ Package::log( sprintf( 'Completed %1$s. Status: %2$s', $report->get_title(), $status ) );
+
+ self::maybe_stop_report( $report->get_id() );
+ }
+
+ public static function maybe_stop_report( $report_id ) {
+ $reports_running = self::get_reports_running();
+
+ if ( in_array( $report_id, $reports_running, true ) ) {
+ $reports_running = array_diff( $reports_running, array( $report_id ) );
+ update_option( 'woocommerce_gzd_shipments_packaging_reports_running', $reports_running, false );
+
+ if ( $queue = self::get_queue() ) {
+ $queue->cancel_all( self::get_hook_name( $report_id ) );
+ }
+
+ /**
+ * Force non-cached running option
+ */
+ wp_cache_delete( 'woocommerce_gzd_shipments_packaging_reports_running', 'options' );
+
+ return true;
+ }
+
+ return false;
+ }
+
+ public static function get_reports_running() {
+ return (array) get_option( 'woocommerce_gzd_shipments_packaging_reports_running', array() );
+ }
+
+ public static function get_timeframe( $type, $date = null, $date_end = null ) {
+ $date_start = null;
+ $date_end = is_null( $date_end ) ? null : $date_end;
+ $start_indicator = is_null( $date ) ? new \WC_DateTime() : $date;
+
+ if ( ! is_a( $start_indicator, 'WC_DateTime' ) && is_numeric( $start_indicator ) ) {
+ $start_indicator = new \WC_DateTime( '@' . $start_indicator );
+ }
+
+ if ( ! is_null( $date_end ) && ! is_a( $date_end, 'WC_DateTime' ) && is_numeric( $date_end ) ) {
+ $date_end = new \WC_DateTime( '@' . $date_end );
+ }
+
+ if ( 'quarterly' === $type ) {
+ $month = $start_indicator->date( 'n' );
+ $quarter = (int) ceil( $month / 3 );
+ $start_month = 'Jan';
+ $end_month = 'Mar';
+
+ if ( 2 === $quarter ) {
+ $start_month = 'Apr';
+ $end_month = 'Jun';
+ } elseif ( 3 === $quarter ) {
+ $start_month = 'Jul';
+ $end_month = 'Sep';
+ } elseif ( 4 === $quarter ) {
+ $start_month = 'Oct';
+ $end_month = 'Dec';
+ }
+
+ $date_start = new \WC_DateTime( 'first day of ' . $start_month . ' ' . $start_indicator->format( 'Y' ) . ' midnight' );
+ $date_end = new \WC_DateTime( 'last day of ' . $end_month . ' ' . $start_indicator->format( 'Y' ) . ' midnight' );
+ } elseif ( 'monthly' === $type ) {
+ $month = $start_indicator->format( 'M' );
+
+ $date_start = new \WC_DateTime( 'first day of ' . $month . ' ' . $start_indicator->format( 'Y' ) . ' midnight' );
+ $date_end = new \WC_DateTime( 'last day of ' . $month . ' ' . $start_indicator->format( 'Y' ) . ' midnight' );
+ } elseif ( 'yearly' === $type ) {
+ $date_end = clone $start_indicator;
+ $date_start = clone $start_indicator;
+
+ $date_end->modify( 'last day of dec ' . $start_indicator->format( 'Y' ) . ' midnight' );
+ $date_start->modify( 'first day of jan ' . $start_indicator->format( 'Y' ) . ' midnight' );
+ } else {
+ if ( is_null( $date_end ) ) {
+ $date_end = clone $start_indicator;
+ $date_end->modify( '-1 year' );
+ }
+
+ $date_start = clone $start_indicator;
+ }
+
+ /**
+ * Always set start and end time to midnight
+ */
+ if ( $date_start ) {
+ $date_start->setTime( 0, 0 );
+ }
+
+ if ( $date_end ) {
+ $date_end->setTime( 0, 0 );
+ }
+
+ return array(
+ 'start' => $date_start,
+ 'end' => $date_end,
+ );
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/PackagingFactory.php b/packages/woocommerce-germanized-shipments/src/PackagingFactory.php
new file mode 100644
index 000000000..4c48f8ec3
--- /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/CartItem.php b/packages/woocommerce-germanized-shipments/src/Packing/CartItem.php
new file mode 100644
index 000000000..fe318c249
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Packing/CartItem.php
@@ -0,0 +1,69 @@
+item = $item;
+
+ if ( ! isset( $this->item['data'] ) || ! is_a( $this->item['data'], 'WC_Product' ) ) {
+ throw new \Exception( 'Invalid item' );
+ }
+
+ $width = empty( $this->get_product()->get_width() ) ? 0 : wc_format_decimal( $this->get_product()->get_width() );
+ $length = empty( $this->get_product()->get_length() ) ? 0 : wc_format_decimal( $this->get_product()->get_length() );
+ $depth = empty( $this->get_product()->get_height() ) ? 0 : wc_format_decimal( $this->get_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->get_product()->get_weight() ) ? 0 : wc_format_decimal( $this->get_product()->get_weight() );
+ $quantity = (int) ceil( (float) $item['quantity'] );
+ $line_total = (int) wc_add_number_precision( $this->item['line_total'] );
+ $line_subtotal = (int) wc_add_number_precision( $this->item['line_subtotal'] );
+
+ if ( $incl_taxes ) {
+ $line_total += (int) wc_add_number_precision( $this->item['line_tax'] );
+ $line_subtotal += (int) wc_add_number_precision( $this->item['line_subtotal_tax'] );
+ }
+
+ $this->weight = (int) wc_get_weight( $weight, 'g' );
+
+ $this->total = $quantity > 0 ? NumberUtil::round( $line_total / $quantity ) : 0;
+ $this->subtotal = $quantity > 0 ? NumberUtil::round( $line_subtotal / $quantity ) : 0;
+ }
+
+ protected function load_product() {
+ $this->product = $this->item['data'];
+ }
+
+ /**
+ * @return array
+ */
+ public function get_cart_item() {
+ return $this->get_reference();
+ }
+
+ public function get_id() {
+ return $this->get_product()->get_id();
+ }
+}
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..65e508857
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Packing/Helper.php
@@ -0,0 +1,127 @@
+get_id() ] = new PackagingBox( $packaging );
+ }
+ }
+
+ if ( false !== $id ) {
+ if ( is_array( $id ) ) {
+ $first_val = ! empty( $id ) ? array_values( $id )[0] : false;
+
+ if ( is_a( $first_val, '\Vendidero\Germanized\Shipments\Packaging' ) ) {
+ $packaging_boxes = array();
+
+ foreach ( $id as $packaging ) {
+ if ( array_key_exists( $packaging->get_id(), self::$packaging ) ) {
+ $packaging_boxes[ $packaging->get_id() ] = self::$packaging[ $packaging->get_id() ];
+ }
+ }
+
+ return $packaging_boxes;
+ } else {
+ return array_intersect_key( self::$packaging, array_flip( $id ) );
+ }
+ } else {
+ return array_key_exists( $id, self::$packaging ) ? self::$packaging[ $id ] : false;
+ }
+ }
+
+ return self::$packaging;
+ }
+
+ /**
+ * @param Packaging $packaging
+ *
+ * @return PackagingBox
+ */
+ public static function get_packaging_box( $packaging ) {
+ $packaging_boxes = self::get_packaging_boxes();
+
+ return array_key_exists( $packaging->get_id(), $packaging_boxes ) ? $packaging_boxes[ $packaging->get_id() ] : new PackagingBox( $packaging );
+ }
+
+ public static function enable_auto_packing() {
+ return 'yes' === get_option( 'woocommerce_gzd_shipments_enable_auto_packing' );
+ }
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Packing\ItemList $items
+ * @param PackingBox[]|BoxList $boxes
+ *
+ * @return PackedBoxList
+ */
+ public static function pack( $items, $boxes, $for = 'order' ) {
+ self::$items_too_large = array();
+
+ /**
+ * @var \Vendidero\Germanized\Shipments\Packing\Packer $packer
+ */
+ $packer = apply_filters( 'woocommerce_gzd_shipments_packer_instance', new Packer(), $items, $boxes, $for );
+ $packer->set_boxes( $boxes );
+ $packer->set_items( $items );
+
+ if ( 'yes' !== get_option( 'woocommerce_gzd_shipments_packing_balance_weights' ) ) {
+ /**
+ * Pack the first available package as full as possible.
+ */
+ $packer->set_max_boxes_to_balance_weight( 0 );
+ }
+
+ do_action( 'woocommerce_gzd_shipments_packer_before_pack', $packer, $for );
+
+ $packed_boxes = $packer->pack();
+
+ // Items that do not fit in any box
+ self::$items_too_large = $packer->get_unpacked_items();
+
+ if ( self::$items_too_large->count() > 0 ) {
+ foreach ( self::$items_too_large as $item_too_large ) {
+ Package::log( sprintf( _x( 'Item %1$s did not fit the available packaging.', 'shipments', 'woocommerce-germanized' ), $item_too_large->getDescription() ), 'info', 'packing' );
+ }
+ }
+
+ return $packed_boxes;
+ }
+
+ /**
+ * @return ItemList|array
+ */
+ public static function get_last_unpacked_items() {
+ return self::$items_too_large;
+ }
+
+ public static function get_available_packaging( $id = false ) {
+ return self::get_packaging_boxes( $id );
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Packing/Item.php b/packages/woocommerce-germanized-shipments/src/Packing/Item.php
new file mode 100644
index 000000000..3a395ef03
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Packing/Item.php
@@ -0,0 +1,155 @@
+ 0,
+ 'length' => 0,
+ 'depth' => 0,
+ );
+
+ protected $weight = 0;
+
+ protected $total = 0;
+
+ protected $subtotal = 0;
+
+ public function get_reference() {
+ return $this->item;
+ }
+
+ protected function load_product() {
+ $this->product = null;
+ }
+
+ /**
+ * @return null|\WC_Product
+ */
+ public function get_product() {
+ if ( is_null( $this->product ) ) {
+ $this->load_product();
+ }
+
+ return $this->product;
+ }
+
+ public function canBePacked( $box, $already_packed_items, int $proposed_x, int $proposed_y, int $proposed_z, int $width, int $length, int $depth ): bool {
+ $fits = true;
+ $args = array(
+ 'x' => $proposed_x,
+ 'y' => $proposed_y,
+ 'z' => $proposed_z,
+ 'length' => $length,
+ 'width' => $width,
+ 'depth' => $depth,
+ );
+
+ if ( $product = $this->get_product() ) {
+ $shipping_class = $product->get_shipping_class_id();
+
+ if ( ! empty( $shipping_class ) ) {
+ if ( ! $box->get_packaging()->supports_shipping_class( $shipping_class ) ) {
+ $fits = false;
+ }
+ }
+
+ /**
+ * In case grouping is activated make sure that a new item with a different shipping class
+ * is not being packed within the same already existing package.
+ */
+ if ( $fits && 'yes' === get_option( 'woocommerce_gzd_shipments_packing_group_by_shipping_class' ) ) {
+ $count = $already_packed_items->count();
+ $last_item = $count > 0 ? $already_packed_items->getIterator()[ $count - 1 ]->getItem() : false;
+
+ if ( $last_item && ( $last_product = $last_item->get_product() ) ) {
+ if ( $last_product->get_shipping_class_id() !== $shipping_class ) {
+ $fits = false;
+ }
+ }
+ }
+ }
+
+ return apply_filters( 'woocommerce_gzd_shipments_item_fits_packaging', $fits, $this, $box->get_packaging(), $already_packed_items, $args );
+ }
+
+ /**
+ * Does this item need to be kept flat / packed "this way up"?
+ */
+ public function getKeepFlat(): bool {
+ return apply_filters( 'woocommerce_gzd_packing_item_keep_flat', false, $this );
+ }
+
+ /**
+ * Item SKU etc.
+ */
+ public function getDescription(): string {
+ $description = $this->get_id();
+
+ if ( $product = $this->get_product() ) {
+ if ( $product->get_sku() ) {
+ $description = $this->get_product()->get_sku();
+ }
+ }
+
+ return apply_filters( 'woocommerce_gzd_packing_item_description', $description, $this );
+ }
+
+ /**
+ * Item width in mm.
+ */
+ public function getWidth(): int {
+ return apply_filters( 'woocommerce_gzd_packing_item_width_in_mm', $this->dimensions['width'], $this );
+ }
+
+ /**
+ * Item length in mm.
+ */
+ public function getLength(): int {
+ return apply_filters( 'woocommerce_gzd_packing_item_length_in_mm', $this->dimensions['length'], $this );
+ }
+
+ /**
+ * Item depth in mm.
+ */
+ public function getDepth(): int {
+ return apply_filters( 'woocommerce_gzd_packing_item_depth_in_mm', $this->dimensions['depth'], $this );
+ }
+
+ /**
+ * Item weight in g.
+ */
+ public function getWeight(): int {
+ return apply_filters( 'woocommerce_gzd_packing_item_weight_in_g', $this->weight, $this );
+ }
+
+ /**
+ * Item total in cents.
+ *
+ * @return int
+ */
+ public function get_total(): int {
+ return apply_filters( 'woocommerce_gzd_packing_item_total_in_cents', $this->total, $this );
+ }
+
+ /**
+ * Item subtotal in cents.
+ *
+ * @return int
+ */
+ public function get_subtotal(): int {
+ return apply_filters( 'woocommerce_gzd_packing_item_subtotal_in_cents', $this->subtotal, $this );
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Packing/ItemList.php b/packages/woocommerce-germanized-shipments/src/Packing/ItemList.php
new file mode 100644
index 000000000..bd02f5b7b
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Packing/ItemList.php
@@ -0,0 +1,12 @@
+item = $item;
+
+ if ( ! is_callable( array( $item, 'get_product' ) ) ) {
+ throw new \Exception( 'Invalid item' );
+ }
+
+ if ( $product = $this->get_product() ) {
+ $width = empty( $product->get_width() ) ? 0 : wc_format_decimal( $product->get_width() );
+ $length = empty( $product->get_length() ) ? 0 : wc_format_decimal( $product->get_length() );
+ $depth = empty( $product->get_height() ) ? 0 : wc_format_decimal( $product->get_height() );
+
+ $this->dimensions = array(
+ 'width' => (int) ceil( (float) wc_get_dimension( $width, 'mm' ) ),
+ 'length' => (int) ceil( (float) wc_get_dimension( $length, 'mm' ) ),
+ 'depth' => (int) ceil( (float) wc_get_dimension( $depth, 'mm' ) ),
+ );
+
+ $weight = empty( $this->product->get_weight() ) ? 0 : wc_format_decimal( $this->product->get_weight() );
+ $this->weight = (int) ceil( (float) wc_get_weight( $weight, 'g' ) );
+ }
+
+ $quantity = (int) ceil( (float) $item->get_quantity() );
+ $incl_taxes = $item->get_order() ? $item->get_order()->get_prices_include_tax() : wc_prices_include_tax();
+ $line_total = (int) wc_add_number_precision( $this->item->get_total() );
+ $line_subtotal = (int) wc_add_number_precision( $this->item->get_subtotal() );
+
+ if ( $incl_taxes ) {
+ $line_total += (int) wc_add_number_precision( $this->item->get_total_tax() );
+ $line_subtotal += (int) wc_add_number_precision( $this->item->get_subtotal_tax() );
+ }
+
+ $this->total = $quantity > 0 ? NumberUtil::round( $line_total / $quantity ) : 0;
+ $this->subtotal = $quantity > 0 ? NumberUtil::round( $line_subtotal / $quantity ) : 0;
+ }
+
+ protected function load_product() {
+ $this->product = $this->item->get_product();
+ }
+
+ public function get_id() {
+ return $this->item->get_id();
+ }
+
+ /**
+ * @return \WC_Order_Item_Product
+ */
+ public function get_order_item() {
+ return $this->get_reference();
+ }
+}
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..b451717d5
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Packing/PackagingBox.php
@@ -0,0 +1,184 @@
+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) floor( (float) wc_get_dimension( $width, 'mm', wc_gzd_get_packaging_dimension_unit() ) ),
+ 'length' => (int) floor( (float) wc_get_dimension( $length, 'mm', wc_gzd_get_packaging_dimension_unit() ) ),
+ 'depth' => (int) floor( (float) wc_get_dimension( $depth, 'mm', wc_gzd_get_packaging_dimension_unit() ) ),
+ );
+
+ if ( $this->packaging->has_inner_dimensions() ) {
+ $inner_width = empty( $this->packaging->get_inner_width() ) ? 0 : wc_format_decimal( $this->packaging->get_inner_width() );
+ $inner_length = empty( $this->packaging->get_inner_length() ) ? 0 : wc_format_decimal( $this->packaging->get_inner_length() );
+ $inner_depth = empty( $this->packaging->get_inner_height() ) ? 0 : wc_format_decimal( $this->packaging->get_inner_height() );
+
+ $this->inner_dimensions = array(
+ 'width' => (int) floor( (float) wc_get_dimension( $inner_width, 'mm', wc_gzd_get_packaging_dimension_unit() ) ),
+ 'length' => (int) floor( (float) wc_get_dimension( $inner_length, 'mm', wc_gzd_get_packaging_dimension_unit() ) ),
+ 'depth' => (int) floor( (float) wc_get_dimension( $inner_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) floor( (float) 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) floor( (float) 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'];
+ }
+
+ /**
+ * @return Packaging
+ */
+ public function get_packaging() {
+ return $this->packaging;
+ }
+
+ /**
+ * 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 ( 'yes' === get_option( 'woocommerce_gzd_shipments_enable_auto_packing' ) ) {
+ if ( apply_filters( 'woocommerce_gzd_packaging_inner_dimension_use_percentage_buffer', ( 'percentage' === get_option( 'woocommerce_gzd_shipments_packing_inner_buffer_type' ) ), $type, $this ) ) {
+ $buffer = (float) wc_format_decimal( get_option( 'woocommerce_gzd_shipments_packing_inner_percentage_buffer', '0.5' ), 2 );
+ $percentage_buffer = apply_filters( 'woocommerce_gzd_packaging_inner_dimension_percentage_buffer', $buffer, $type, $this ) / 100;
+ $value = $value - ( $value * $percentage_buffer );
+ } else {
+ $buffer = absint( get_option( 'woocommerce_gzd_shipments_packing_inner_fixed_buffer', 5 ) );
+ $fixed_buffer = apply_filters( 'woocommerce_gzd_packaging_inner_dimension_fixed_buffer_mm', $buffer, $type, $this );
+ $value = $value - $fixed_buffer;
+ }
+ }
+
+ return (float) max( $value, 0 );
+ }
+
+ /**
+ * Inner width in mm.
+ */
+ public function getInnerWidth(): int {
+ if ( ! empty( $this->inner_dimensions ) ) {
+ $width = $this->inner_dimensions['width'];
+ } else {
+ $width = $this->get_inner_dimension_buffer( $this->dimensions['width'], 'width' );
+ }
+
+ return $width;
+ }
+
+ /**
+ * Inner length in mm.
+ */
+ public function getInnerLength(): int {
+ if ( ! empty( $this->inner_dimensions ) ) {
+ $length = $this->inner_dimensions['length'];
+ } else {
+ $length = $this->get_inner_dimension_buffer( $this->dimensions['length'], 'length' );
+ }
+
+ return $length;
+ }
+
+ /**
+ * Inner depth in mm.
+ */
+ public function getInnerDepth(): int {
+ if ( ! empty( $this->inner_dimensions ) ) {
+ $depth = $this->inner_dimensions['depth'];
+ } else {
+ $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/Packer.php b/packages/woocommerce-germanized-shipments/src/Packing/Packer.php
new file mode 100644
index 000000000..d30520e1b
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Packing/Packer.php
@@ -0,0 +1,44 @@
+packer = new \DVDoug\BoxPacker\InfalliblePacker();
+ }
+
+ public function set_max_boxes_to_balance_weight( $max_boxes ) {
+ $this->packer->setMaxBoxesToBalanceWeight( $max_boxes );
+ }
+
+ public function set_boxes( $boxes ) {
+ if ( ! is_a( $boxes, '\DVDoug\BoxPacker\BoxList' ) ) {
+ $first_box = ! empty( $boxes ) ? array_values( $boxes )[0] : false;
+
+ if ( ! empty( $boxes ) && ! is_a( $first_box, 'Vendidero\Germanized\Shipments\Packing\PackagingBox' ) ) {
+ $boxes = \DVDoug\BoxPacker\BoxList::fromArray( Helper::get_packaging_boxes( $boxes ) );
+ } else {
+ $boxes = \DVDoug\BoxPacker\BoxList::fromArray( $boxes );
+ }
+ }
+
+ $this->packer->setBoxes( $boxes );
+ }
+
+ public function set_items( $items ) {
+ $this->packer->setItems( $items );
+ }
+
+ public function pack() {
+ return $this->packer->pack();
+ }
+
+ public function get_unpacked_items() {
+ return $this->packer->getUnpackedItems();
+ }
+}
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..6378aa2f0
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Packing/ShipmentItem.php
@@ -0,0 +1,65 @@
+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) ceil( (float) wc_get_dimension( $width, 'mm', $dimension_unit ) ),
+ 'length' => (int) ceil( (float) wc_get_dimension( $length, 'mm', $dimension_unit ) ),
+ 'depth' => (int) ceil( (float) wc_get_dimension( $depth, 'mm', $dimension_unit ) ),
+ );
+
+ $weight = empty( $this->item->get_weight() ) ? 0 : wc_format_decimal( $this->item->get_weight() );
+ $quantity = (int) ceil( (float) $item->get_quantity() );
+ $line_total = (int) wc_add_number_precision( $this->item->get_total() );
+ $line_subtotal = (int) wc_add_number_precision( $this->item->get_subtotal() );
+
+ $this->weight = (int) ceil( (float) wc_get_weight( $weight, 'g', $weight_unit ) );
+
+ $this->total = $quantity > 0 ? NumberUtil::round( $line_total / $quantity ) : 0;
+ $this->subtotal = $quantity > 0 ? NumberUtil::round( $line_subtotal / $quantity ) : 0;
+ }
+
+ /**
+ * @return \Vendidero\Germanized\Shipments\ShipmentItem
+ */
+ public function get_shipment_item() {
+ return $this->get_reference();
+ }
+
+ public function get_id() {
+ return $this->item->get_id();
+ }
+
+ protected function load_product() {
+ $this->product = $this->item->get_product();
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Product.php b/packages/woocommerce-germanized-shipments/src/Product.php
new file mode 100644
index 000000000..28ebd83ae
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Product.php
@@ -0,0 +1,150 @@
+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' ) ) {
+ if ( $parent = wc_get_product( $this->product->get_parent_id() ) ) {
+ return $parent;
+ }
+ }
+
+ return $this->product;
+ }
+
+ public function get_customs_description( $context = 'view' ) {
+ $data = $this->get_forced_parent_product()->get_meta( '_customs_description', true, $context );
+
+ return $data;
+ }
+
+ public function is_non_returnable( $context = 'view' ) {
+ $is_non_returnable = wc_string_to_bool( $this->get_forced_parent_product()->get_meta( '_is_non_returnable', true, $context ) );
+
+ return $is_non_returnable;
+ }
+
+ public function get_hs_code( $context = 'view' ) {
+ $legacy_data = $this->get_forced_parent_product()->get_meta( '_dhl_hs_code', true, $context );
+ $data = $this->get_forced_parent_product()->get_meta( '_hs_code', true, $context );
+
+ if ( '' === $data && ! empty( $legacy_data ) ) {
+ $data = $legacy_data;
+ }
+
+ return $data;
+ }
+
+ public function get_manufacture_country( $context = 'view' ) {
+ $legacy_data = $this->get_forced_parent_product()->get_meta( '_dhl_manufacture_country', true, $context );
+ $data = $this->get_forced_parent_product()->get_meta( '_manufacture_country', true, $context );
+
+ if ( '' === $data && ! empty( $legacy_data ) ) {
+ $data = $legacy_data;
+ }
+
+ if ( '' === $data && 'view' === $context ) {
+ return wc_get_base_location()['country'];
+ }
+
+ return $data;
+ }
+
+ 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( '_hs_code', $code );
+ }
+
+ public function set_manufacture_country( $country ) {
+ $this->product->update_meta_data( '_manufacture_country', substr( wc_strtoupper( $country ), 0, 2 ) );
+ }
+
+ public function set_customs_description( $description ) {
+ $this->product->update_meta_data( '_customs_description', $description );
+ }
+
+ public function set_is_non_returnable( $is_non_returnable ) {
+ $this->product->update_meta_data( '_is_non_returnable', wc_bool_to_string( $is_non_returnable ) );
+ }
+
+ /**
+ * 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-shipments/src/Registry/AbstractDependencyType.php b/packages/woocommerce-germanized-shipments/src/Registry/AbstractDependencyType.php
new file mode 100644
index 000000000..04f470893
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Registry/AbstractDependencyType.php
@@ -0,0 +1,54 @@
+callable_or_value = $callable_or_value;
+ }
+
+ /**
+ * Resolver for the internal dependency value.
+ *
+ * @param Container $container The Dependency Injection Container.
+ *
+ * @return mixed
+ */
+ protected function resolve_value( $container ) {
+ $callback = $this->callable_or_value;
+ return \is_callable( $callback )
+ ? $callback( $container )
+ : $callback;
+ }
+
+ /**
+ * Retrieves the value stored internally for this DependencyType
+ *
+ * @param Container $container The Dependency Injection Container.
+ *
+ * @return void
+ */
+ abstract public function get( $container );
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Registry/Container.php b/packages/woocommerce-germanized-shipments/src/Registry/Container.php
new file mode 100644
index 000000000..d6282dbde
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Registry/Container.php
@@ -0,0 +1,96 @@
+register( MyClass::class, $container->factory( $mycallback ) );
+ * ```
+ *
+ * @param Closure $instantiation_callback This will be invoked when the
+ * dependency is required. It will
+ * receive an instance of this
+ * container so the callback can
+ * retrieve dependencies from the
+ * container.
+ *
+ * @return FactoryType An instance of the FactoryType dependency.
+ */
+ public function factory( Closure $instantiation_callback ) {
+ return new FactoryType( $instantiation_callback );
+ }
+
+ /**
+ * Interface for registering a new dependency with the container.
+ *
+ * By default, the $value will be added as a shared dependency. This means
+ * that it will be a single instance shared among any other classes having
+ * that dependency.
+ *
+ * If you want a new instance every time it's required, then wrap the value
+ * in a call to the factory method (@see Container::factory for example)
+ *
+ * Note: Currently if the provided id already is registered in the container,
+ * the provided value is ignored.
+ *
+ * @param string $id A unique string identifier for the provided value.
+ * Typically it's the fully qualified name for the
+ * dependency.
+ * @param mixed $value The value for the dependency. Typically, this is a
+ * closure that will create the class instance needed.
+ */
+ public function register( $id, $value ) {
+ if ( empty( $this->registry[ $id ] ) ) {
+ if ( ! $value instanceof FactoryType ) {
+ $value = new SharedType( $value );
+ }
+ $this->registry[ $id ] = $value;
+ }
+ }
+
+ /**
+ * Interface for retrieving the dependency stored in the container for the
+ * given identifier.
+ *
+ * @param string $id The identifier for the dependency being retrieved.
+ * @throws Exception If there is no dependency for the given identifier in
+ * the container.
+ *
+ * @return mixed Typically a class instance.
+ */
+ public function get( $id ) {
+ if ( ! isset( $this->registry[ $id ] ) ) {
+ // this is a developer facing exception, hence it is not localized.
+ throw new Exception(
+ sprintf(
+ 'Cannot construct an instance of %s because it has not been registered.',
+ $id
+ )
+ );
+ }
+ return $this->registry[ $id ]->get( $this );
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Registry/FactoryType.php b/packages/woocommerce-germanized-shipments/src/Registry/FactoryType.php
new file mode 100644
index 000000000..3e01fafc1
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Registry/FactoryType.php
@@ -0,0 +1,21 @@
+resolve_value( $container );
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Registry/SharedType.php b/packages/woocommerce-germanized-shipments/src/Registry/SharedType.php
new file mode 100644
index 000000000..891017221
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Registry/SharedType.php
@@ -0,0 +1,32 @@
+shared_instance ) ) {
+ $this->shared_instance = $this->resolve_value( $container );
+ }
+ return $this->shared_instance;
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/Rest/ShipmentsController.php b/packages/woocommerce-germanized-shipments/src/Rest/ShipmentsController.php
new file mode 100644
index 000000000..498a6241f
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Rest/ShipmentsController.php
@@ -0,0 +1,2095 @@
+namespace,
+ '/' . $this->rest_base,
+ array(
+ array(
+ 'methods' => WP_REST_Server::READABLE,
+ 'callback' => array( $this, 'get_items' ),
+ 'permission_callback' => array( $this, 'get_items_permissions_check' ),
+ 'args' => $this->get_collection_params(),
+ ),
+ array(
+ 'methods' => WP_REST_Server::CREATABLE,
+ 'callback' => array( $this, 'create_item' ),
+ 'permission_callback' => array( $this, 'create_item_permissions_check' ),
+ 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ),
+ ),
+ 'schema' => array( $this, 'get_public_item_schema' ),
+ )
+ );
+ register_rest_route(
+ $this->namespace,
+ '/' . $this->rest_base . '/(?Pget_title() ); ?>
+ $action ) : + if ( 'view' === $action_type ) { + continue; + } + ?> + + + + get_status() ) : ?> +get_date_start()->date_i18n( wc_date_format() ) ); ?> – get_date_end()->date_i18n( wc_date_format() ) ); ?>: get_total_weight(), wc_gzd_get_packaging_weight_unit() ) ); ?> (get_total_count() ) ); ?>)
++ + +
| + + | ||
|---|---|---|
| get_id() > 0 ? $packaging->get_description() : _x( 'Unknown', 'shipments-packaging-title', 'woocommerce-germanized' ) ) ); ?> | +get_packaging_weight( $packaging_id ), wc_gzd_get_packaging_weight_unit() ) ); ?> | +get_packaging_count( $packaging_id ) ); ?> | +
get_total_packaging_weight_by_country( $country ), wc_gzd_get_packaging_weight_unit() ) ); ?> (get_total_packaging_count_by_country( $country ) ) ); ?>)
+| + + | ||
|---|---|---|
| get_id() > 0 ? $packaging->get_description() : _x( 'Unknown', 'shipments-packaging-title', 'woocommerce-germanized' ) ) ); ?> | +get_packaging_weight( $packaging_id, $country ), wc_gzd_get_packaging_weight_unit() ) ); ?> | +get_packaging_count( $packaging_id, $country ) ); ?> | +
Find pending actions', 'shipments', 'woocommerce-germanized' ), esc_html( $details['shipment_count'] ), ( $details['next_date'] ? esc_html( $details['next_date']->date_i18n( wc_date_format() . ' @ ' . wc_time_format() ) ) : esc_html_x( 'Not yet known', 'shipments', 'woocommerce-germanized' ) ), esc_url( $details['link'] ) ); ?>
+ +', '
' ), '', $entry->display_value ), + 'label' => $entry->display_key, + 'order_item_meta_id' => $meta_id, + ); + } + + $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() ) : '', + 'hs_code' => $s_product ? $s_product->get_hs_code() : '', + 'customs_description' => $s_product ? $s_product->get_customs_description() : '', + 'manufacture_country' => $s_product ? $s_product->get_manufacture_country() : '', + 'attributes' => $attributes, + ) + ); + } + + $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( $context = 'view' ) { + return array( + 'length' => $this->get_length( $context ), + 'width' => $this->get_width( $context ), + 'height' => $this->get_height( $context ), + ); + } + + public function set_quantity( $quantity ) { + $this->set_prop( 'quantity', absint( $quantity ) ); + } + + public function set_name( $name ) { + $this->set_prop( 'name', $name ); + } + + public function set_hs_code( $code ) { + $this->set_prop( 'hs_code', $code ); + } + + public function set_customs_description( $description ) { + $this->set_prop( 'customs_description', $description ); + } + + public function set_manufacture_country( $country ) { + $this->set_prop( 'manufacture_country', wc_strtoupper( $country ) ); + } + + /** + * Set attributes + * + * @param $attributes + */ + public function set_attributes( $attributes ) { + $this->set_prop( 'attributes', (array) $attributes ); + } + + /* + |-------------------------------------------------------------------------- + | 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..eb3ec91b3 --- /dev/null +++ b/packages/woocommerce-germanized-shipments/src/ShipmentQuery.php @@ -0,0 +1,604 @@ + array_keys( wc_gzd_get_shipment_statuses() ), + 'limit' => 10, + 'order_id' => '', + 'parent_id' => '', + 'product_ids' => '', + 'product_category' => '', + 'type' => 'simple', + 'country' => '', + 'tracking_id' => '', + 'order' => 'DESC', + 'orderby' => 'date_created', + 'shipping_provider' => '', + '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; + } + + public function get_max_num_pages() { + return $this->max_num_pages; + } + + /** + * 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 ) { + $clauses = array( + 'fields' => $this->query_fields, + 'from' => $this->query_from, + 'where' => $this->query_where, + 'orderby' => $this->query_orderby, + 'limits' => $this->query_limit, + ); + + /** + * Filters all query clauses for a shipment query at once, for convenience. + * + * @param string[] $clauses Associative array of the clauses for the query. + * @param ShipmentQuery $query The ShipmentQuery instance. + */ + $clauses = (array) apply_filters( 'woocommerce_gzd_shipment_query_clauses', $clauses, $this ); + + $fields = isset( $clauses['fields'] ) ? $clauses['fields'] : ''; + $from = isset( $clauses['from'] ) ? $clauses['from'] : ''; + $where = isset( $clauses['where'] ) ? $clauses['where'] : ''; + $groupby = isset( $clauses['groupby'] ) ? $clauses['groupby'] : ''; + $orderby = isset( $clauses['orderby'] ) ? $clauses['orderby'] : ''; + $limits = isset( $clauses['limits'] ) ? $clauses['limits'] : ''; + + $this->request = "SELECT $fields $from $where $groupby $orderby $limits"; + + if ( is_array( $qv['fields'] ) || 'objects' === $qv['fields'] ) { + $this->results = $wpdb->get_results( $this->request ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared + } else { + $this->results = $wpdb->get_col( $this->request ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared + } + + if ( isset( $qv['count_total'] ) && $qv['count_total'] ) { + $found_shipments_query = 'SELECT FOUND_ROWS()'; + $this->total_shipments = (int) $wpdb->get_var( $found_shipments_query ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared + $this->max_num_pages = ceil( $this->total_shipments / $qv['posts_per_page'] ); + } + } + + 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'] = (array) $this->args['order_id']; + $this->args['order_id'] = array_map( 'absint', $this->args['order_id'] ); + } + + if ( isset( $this->args['shipping_provider'] ) ) { + $this->args['shipping_provider'] = wc_clean( $this->args['shipping_provider'] ); + } + + if ( isset( $this->args['parent_id'] ) ) { + $this->args['parent_id'] = absint( $this->args['parent_id'] ); + } + + if ( isset( $this->args['product_ids'] ) ) { + $this->args['product_ids'] = (array) $this->args['product_ids']; + $this->args['product_ids'] = array_map( 'absint', $this->args['product_ids'] ); + } + + if ( isset( $this->args['product_category'] ) ) { + $this->args['product_category'] = (array) $this->args['product_category']; + $this->args['product_category'] = array_map( 'absint', $this->args['product_category'] ); + } + + 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(), true ) ) { + $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'] ) ) { + $order_ids = array_filter( array_map( 'absint', $this->args['order_id'] ) ); + $placeholders = implode( ',', array_fill( 0, count( $order_ids ), '%d' ) ); + $this->query_where .= $wpdb->prepare( " AND shipment_order_id IN ({$placeholders})", ...$order_ids ); // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.PreparedSQLPlaceholders.UnfinishedPrepare + } + + // order id + if ( isset( $this->args['shipping_provider'] ) ) { + $this->query_where .= $wpdb->prepare( ' AND shipment_shipping_provider = %s', $this->args['shipping_provider'] ); + } + + // tracking id + if ( isset( $this->args['tracking_id'] ) ) { + $this->query_where .= $wpdb->prepare( " AND shipment_tracking_id IN ('%s')", $this->args['tracking_id'] ); // phpcs:ignore WordPress.DB.PreparedSQLPlaceholders.QuotedSimplePlaceholder + } + + // parent id + if ( isset( $this->args['parent_id'] ) ) { + $this->query_where .= $wpdb->prepare( ' AND shipment_parent_id = %d', $this->args['parent_id'] ); + } + + // product ids + if ( isset( $this->args['product_ids'] ) ) { + $product_ids_placeholders = implode( ', ', array_fill( 0, count( $this->args['product_ids'] ), '%d' ) ); + + $this->query_from .= " JOIN {$wpdb->prefix}woocommerce_gzd_shipment_items as shipment_items ON ( shipment_items.shipment_id = {$wpdb->prefix}woocommerce_gzd_shipments.shipment_id ) "; + $this->query_where .= $wpdb->prepare( " AND shipment_items.shipment_item_product_id IN ({$product_ids_placeholders})", $this->args['product_ids'] ); // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.PreparedSQLPlaceholders.UnfinishedPrepare + } + + // product category + if ( isset( $this->args['product_category'] ) ) { + $product_category_placeholders = implode( ', ', array_fill( 0, count( $this->args['product_category'] ), '%d' ) ); + + $this->query_from .= " JOIN {$wpdb->prefix}woocommerce_gzd_shipment_items AS shipment_items ON {$wpdb->prefix}woocommerce_gzd_shipments.shipment_id = shipment_items.shipment_id "; + $this->query_from .= " JOIN {$wpdb->prefix}term_relationships AS term_relationships ON term_relationships.object_id = shipment_items.shipment_item_product_id "; + $this->query_where .= $wpdb->prepare( " AND term_relationships.term_taxonomy_id IN ({$product_category_placeholders})", $this->args['product_category'] ); // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.PreparedSQLPlaceholders.UnfinishedPrepare + } + + // country + if ( isset( $this->args['country'] ) ) { + $this->query_where .= $wpdb->prepare( " AND shipment_country IN ('%s')", $this->args['country'] ); // phpcs:ignore WordPress.DB.PreparedSQLPlaceholders.QuotedSimplePlaceholder + } + + // 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', 'shipment_tracking_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( "$wpdb->gzd_shipments.$col = %s", $string ); // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared + } else { + $searches[] = $wpdb->prepare( "$wpdb->gzd_shipments.$col LIKE %s", $like ); // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared + } + } + + 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' ), true ) ) { + $_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..14bba66d1 --- /dev/null +++ b/packages/woocommerce-germanized-shipments/src/ShipmentReturnItem.php @@ -0,0 +1,32 @@ + '', + ); + + 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/ShippingMethod/MethodHelper.php b/packages/woocommerce-germanized-shipments/src/ShippingMethod/MethodHelper.php new file mode 100644 index 000000000..6ee526eed --- /dev/null +++ b/packages/woocommerce-germanized-shipments/src/ShippingMethod/MethodHelper.php @@ -0,0 +1,642 @@ +get_shipping_providers() as $provider ) { + $methods[ "shipping_provider_{$provider->get_name()}" ] = new ShippingMethod( 0, $provider ); + } + + return $methods; + } + + public static function register_cart_items_to_pack( $cart_contents ) { + if ( ! Package::is_packing_supported() || apply_filters( 'woocommerce_gzd_shipments_disable_cart_packing', false ) ) { + return $cart_contents; + } + + foreach ( $cart_contents as $index => $content ) { + $package_data = array( + 'total' => 0.0, + 'subtotal' => 0.0, + 'weight' => 0.0, + 'volume' => 0.0, + 'products' => array(), + 'shipping_classes' => array(), + 'item_count' => 0, + ); + + $items = new ItemList(); + $bundled_by_map = array(); + + foreach ( $content['contents'] as $content_key => $item ) { + $item = apply_filters( 'woocommerce_gzd_shipments_cart_item', $item, $content_key ); + + /** + * Product Bundles cart item compatibility: + * In case the current item belongs to a parent bundle item (which contains the actual price) + * copy the pricing data from the parent once, e.g. for the first bundled item. + */ + if ( isset( $item['bundled_by'] ) && 0.0 === (float) $item['line_total'] && function_exists( 'wc_pb_get_bundled_cart_item_container' ) ) { + $bundled_by = $item['bundled_by']; + + if ( ! in_array( $bundled_by, $bundled_by_map, true ) ) { + if ( $container = wc_pb_get_bundled_cart_item_container( $item ) ) { + $item['line_total'] = (float) $container['line_total']; + $item['line_subtotal'] = (float) $container['line_subtotal']; + $item['line_tax'] = (float) $container['line_tax']; + $item['line_subtotal_tax'] = (float) $container['line_subtotal_tax']; + + $bundled_by_map[] = $bundled_by; + } + } + } + + $product = $item['data']; + + if ( ! is_a( $product, 'WC_Product' ) ) { + continue; + } + + $line_total = (float) $item['line_total']; + $line_subtotal = (float) $item['line_subtotal']; + + if ( wc()->cart->display_prices_including_tax() ) { + $line_total += (float) $item['line_tax']; + $line_subtotal += (float) $item['line_subtotal_tax']; + } + + $quantity = (int) ceil( (float) $item['quantity'] ); + $width = ( empty( $product->get_width() ) ? 0 : wc_format_decimal( $product->get_width() ) ) * $quantity; + $length = ( empty( $product->get_length() ) ? 0 : wc_format_decimal( $product->get_length() ) ) * $quantity; + $height = ( empty( $product->get_height() ) ? 0 : wc_format_decimal( $product->get_height() ) ) * $quantity; + $weight = ( empty( $product->get_weight() ) ? 0 : wc_format_decimal( $product->get_weight() ) ) * $quantity; + + $package_data['total'] += $line_total; + $package_data['subtotal'] += $line_subtotal; + $package_data['weight'] += $weight; + $package_data['volume'] += ( $width * $length * $height ); + $package_data['item_count'] += $quantity; + + if ( $product && ! array_key_exists( $product->get_id(), $package_data['products'] ) ) { + $package_data['products'][ $product->get_id() ] = $product; + + if ( ! empty( $product->get_shipping_class_id() ) ) { + $package_data['shipping_classes'][] = $product->get_shipping_class_id(); + } + } + + $cart_item = new CartItem( $item, wc()->cart->display_prices_including_tax() ); + $items->insert( $cart_item, $quantity ); + } + + /** + * In case prices have already been calculated, use the official + * Woo API for better compatibility with extensions, e.g. Bundles. + */ + if ( 0 !== WC()->cart->get_subtotal() ) { + $total = (float) WC()->cart->get_cart_contents_total(); + $subtotal = (float) WC()->cart->get_subtotal(); + + if ( wc()->cart->display_prices_including_tax() ) { + $total += (float) WC()->cart->get_cart_contents_tax(); + $subtotal += (float) WC()->cart->get_subtotal_tax(); + } + + $package_data['total'] = NumberUtil::round_to_precision( $total ); + $package_data['subtotal'] = NumberUtil::round_to_precision( $subtotal ); + } + + $cart_contents[ $index ]['package_data'] = $package_data; + $cart_contents[ $index ]['items_to_pack'] = $items; + } + + return $cart_contents; + } + + public static function render_method_configuration_sets() { + return ''; + } + + public static function set_method_filters( $methods ) { + foreach ( $methods as $method => $class ) { + if ( self::method_is_excluded( $method ) ) { + continue; + } + + /** + * Update during save + */ + add_filter( 'woocommerce_shipping_' . $method . '_instance_settings_values', array( __CLASS__, 'filter_method_settings' ), 10, 2 ); + /** + * Register additional setting fields + */ + add_filter( 'woocommerce_shipping_instance_form_fields_' . $method, array( __CLASS__, 'add_method_settings' ), 10, 1 ); + /** + * Lazy-load option values + */ + add_filter( 'woocommerce_shipping_' . $method . '_instance_option', array( __CLASS__, 'filter_method_option_value' ), 10, 3 ); + + /** + * 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 ); + } + + return $methods; + } + + /** + * @param \WC_Shipping_Method|string|integer $method + * + * @return ProviderMethod|false + */ + public static function get_provider_method( $maybe_method ) { + $original_id = $maybe_method; + $method = false; + $method_id = ''; + $instance_id = 0; + + if ( is_a( $original_id, 'WC_Shipping_Rate' ) ) { + $instance_id = $original_id->get_instance_id(); + $method_id = $original_id->get_method_id(); + } elseif ( is_a( $original_id, 'WC_Shipping_Method' ) ) { + $instance_id = $original_id->get_instance_id(); + $method_id = $original_id->id; + $method = $original_id; + } elseif ( ! is_numeric( $original_id ) && is_string( $original_id ) ) { + if ( strpos( $original_id, ':' ) !== false ) { + $expl = explode( ':', $original_id ); + $instance_id = ( ( ! empty( $expl ) && count( $expl ) > 1 ) ? (int) $expl[1] : 0 ); + $method_id = ( ! empty( $expl ) ) ? $expl[0] : $original_id; + } else { + /** + * Plugins like Flexible Shipping use underscores to separate instance ids. + * Example: flexible_shipping_4_1. In this case, 4 ist the instance id. + * method_id: flexible_shipping + * instance_id: 4 + * + * On the other hand legacy shipping methods may be string only, e.g. an instance id might not exist. + * Example: local_pickup_plus + * method: local_pickup_plus + * instance_id: 0 + */ + $expl = explode( '_', $original_id ); + $numbers = array_values( array_filter( $expl, 'is_numeric' ) ); + $method_id = rtrim( preg_replace( '/[0-9]+/', '', $original_id ), '_' ); + + if ( ! empty( $numbers ) ) { + $instance_id = absint( $numbers[0] ); + } else { + $instance_id = 0; + } + } + } elseif ( is_numeric( $original_id ) ) { + $instance_id = absint( $original_id ); + } + + $method_key = $method_id . '_' . $instance_id; + + if ( array_key_exists( $method_key, self::$methods ) ) { + return self::$methods[ $method_key ]; + } else { + if ( ! is_a( $method, 'WC_Shipping_Method' ) && ! empty( $instance_id ) ) { + // Make sure shipping zones are loaded + include_once WC_ABSPATH . 'includes/class-wc-shipping-zones.php'; + + $method = \WC_Shipping_Zones::get_shipping_method( $instance_id ); + } + + /** + * Fallback for legacy shipping methods that do not support instance ids. + */ + if ( ! $method && empty( $instance_id ) && ! empty( $method_id ) ) { + $shipping_methods = WC()->shipping()->get_shipping_methods(); + + if ( array_key_exists( $method_id, $shipping_methods ) ) { + $method = $shipping_methods[ $method_id ]; + } + } + + if ( ! is_a( $method, 'WC_Shipping_Method' ) ) { + self::$methods[ $method_key ] = new ProviderMethodPlaceholder( + array( + 'id' => $method_id, + 'instance_id' => $instance_id, + ) + ); + } else { + self::$methods[ $method_key ] = new ProviderMethod( $method ); + } + } + + return self::$methods[ $method_key ]; + } + + public static function method_is_excluded( $method ) { + $is_excluded = false; + $excluded = apply_filters( 'woocommerce_gzd_shipments_get_methods_excluded_from_provider_settings', array( 'pr_dhl_paket', 'flexible_shipping_info' ) ); + + if ( in_array( $method, $excluded, true ) ) { + $is_excluded = true; + } elseif ( 'shipping_provider_' === substr( $method, 0, 18 ) ) { + $is_excluded = true; + } + + return apply_filters( 'woocommerce_gzd_shipments_shipping_method_is_excluded_from_provider_settings', $is_excluded, $method ); + } + + public static function validate_method_zone_override( $value ) { + return ! is_null( $value ) ? 'yes' : 'no'; + } + + /** + * @param mixed $value + * @param mixed $setting_id + * @param \WC_Shipping_Method $method + * + * @return mixed + */ + public static function filter_method_option_value( $value, $setting_id, $method ) { + $shipping_method = self::get_provider_method( $method ); + + if ( $shipping_method->is_configuration_set_setting( $setting_id ) ) { + if ( $configuration_set = $shipping_method->get_configuration_set( $setting_id ) ) { + $suffix = $shipping_method->get_configuration_setting_suffix( $setting_id ); + + if ( 'override' === $suffix ) { + return 'yes'; + } else { + return $configuration_set->has_setting( $setting_id ) ? $configuration_set->get_setting( $setting_id ) : $value; + } + } + } + + return $value; + } + + /** + * @param array $p_settings + * @param \WC_Shipping_Method $shipping_method + * + * @return array + */ + public static function filter_method_settings( $p_settings, $shipping_method ) { + $shipping_provider = isset( $p_settings['shipping_provider'] ) ? $p_settings['shipping_provider'] : ''; + $method = self::get_provider_method( $shipping_method ); + + $method->set_shipping_provider( $shipping_provider ); + + foreach ( $p_settings as $setting_id => $setting_val ) { + if ( 'configuration_sets' === $setting_id ) { + unset( $p_settings[ $setting_id ] ); + } elseif ( $method->is_configuration_set_setting( $setting_id ) ) { + $args = $method->get_configuration_set_args_by_id( $setting_id ); + + if ( ! empty( $args['shipping_provider_name'] ) && $args['shipping_provider_name'] === $method->get_shipping_provider() ) { + if ( 'override' === $args['setting_name'] ) { + if ( wc_string_to_bool( $setting_val ) ) { + if ( $config_set = $method->get_or_create_configuration_set( $args ) ) { + $config_set->update_setting( $setting_id, $setting_val ); + } + } else { + $method->reset_configuration_sets( $args ); + } + } elseif ( $config_set = $method->get_configuration_set( $args ) ) { + $config_set->update_setting( $setting_id, $setting_val ); + } + } + + unset( $p_settings[ $setting_id ] ); + } + } + + $p_settings['configuration_sets'] = $method->get_configuration_sets(); + + /** + * Force reloading instance default settings to prevent cached values + */ + $shipping_method->instance_settings = array(); + + return $p_settings; + } + + 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 ); + } + + protected static function load_all_method_settings() { + $screen = function_exists( 'get_current_screen' ) ? get_current_screen() : false; + $load_all_setting_fields = false; + + if ( $screen && isset( $screen->id ) && 'woocommerce_page_wc-settings' === $screen->id ) { + $load_all_setting_fields = true; + } + + if ( + doing_action( 'wp_ajax_woocommerce_shipping_zone_methods_save_settings' ) || + doing_action( 'wp_ajax_woocommerce_shipping_zone_add_method' ) || + doing_action( 'wp_ajax_woocommerce_shipping_zone_remove_method' ) + ) { + $load_all_setting_fields = true; + } + + return $load_all_setting_fields; + } + + public static function get_method_settings( $force_load_all = false ) { + $load_all_settings = $force_load_all ? true : self::load_all_method_settings(); + $method_settings = array( + 'label_configuration_set_shipping_provider_title' => array( + 'title' => _x( 'Shipping Provider Settings', 'shipments', 'woocommerce-germanized' ), + 'type' => 'title', + 'id' => 'label_configuration_set_shipping_provider_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' ), + ), + 'configuration_sets' => array( + 'title' => '', + 'type' => 'shipping_provider_method_configuration_sets', + 'default' => array(), + ), + ); + + if ( $load_all_settings ) { + if ( is_null( self::$provider_method_settings ) ) { + self::$provider_method_settings = array(); + + foreach ( wc_gzd_get_shipping_providers() as $provider ) { + if ( ! $provider->is_activated() ) { + continue; + } + + self::$provider_method_settings[ $provider->get_name() ] = $provider->get_shipping_method_settings(); + } + } + + $supported_zones = array_keys( wc_gzd_get_shipping_label_zones() ); + + foreach ( self::$provider_method_settings as $provider => $zone_settings ) { + $provider_tabs = array(); + $provider_inner_settings = array(); + + foreach ( $zone_settings as $zone => $shipment_type_settings ) { + if ( ! in_array( $zone, $supported_zones, true ) ) { + continue; + } + + foreach ( $shipment_type_settings as $shipment_type => $settings ) { + if ( ! isset( $provider_inner_settings[ $shipment_type ] ) ) { + $provider_inner_settings[ $shipment_type ] = array(); + } + + $provider_inner_settings[ $shipment_type ] = array_merge( $provider_inner_settings[ $shipment_type ], $settings ); + $provider_tabs[ $provider . '_' . $shipment_type ] = wc_gzd_get_shipment_label_title( $shipment_type ); + } + } + + if ( ! empty( $provider_inner_settings ) ) { + $tabs_open_id = "label_config_set_tabs_{$provider}"; + + $method_settings = array_merge( + $method_settings, + array( + $tabs_open_id => array( + 'id' => $tabs_open_id, + 'tabs' => $provider_tabs, + 'type' => 'shipping_provider_method_tabs', + 'default' => '', + 'display_only' => true, + 'provider' => $provider, + ), + ) + ); + + $count = 0; + + foreach ( $provider_inner_settings as $shipment_type => $settings ) { + $count ++; + + $tabs_open_id = "label_config_set_tabs_{$provider}_{$shipment_type}_open"; + $tabs_close_id = "label_config_set_tabs_{$provider}_{$shipment_type}_close"; + + $method_settings = array_merge( + $method_settings, + array( + $tabs_open_id => array( + 'id' => $tabs_open_id, + 'type' => 'shipping_provider_method_tabs_open', + 'tab' => $provider . '_' . $shipment_type, + 'default' => '', + 'provider' => $provider, + 'active' => 1 === $count ? true : false, + ), + ) + ); + + $method_settings = array_merge( $method_settings, $settings ); + + $method_settings = array_merge( + $method_settings, + array( + $tabs_close_id => array( + 'id' => $tabs_close_id, + 'type' => 'shipping_provider_method_tabs_close', + 'tab' => $provider . '_' . $shipment_type, + 'default' => '', + 'provider' => $provider, + ), + ) + ); + } + } + } + } + + /** + * Append a stop title to make sure the table is closed within settings. + */ + $method_settings = array_merge( + apply_filters( 'woocommerce_gzd_shipping_provider_method_admin_settings', $method_settings, $load_all_settings ), + array( + 'label_configuration_set_shipping_provider_stop_title' => array( + 'title' => '', + 'id' => 'label_configuration_set_shipping_provider_stop_title', + 'type' => 'title', + 'default' => '', + ), + ) + ); + + return $method_settings; + } + + public static function render_method_tab_content_close( $html, $key, $value, $method ) { + return '';
+ }
+
+ public static function render_zone_override_close( $html, $key, $setting, $method ) {
+ return '
';
+ }
+
+ public static function render_zone_override( $html, $key, $setting, $method ) {
+ $setting = wp_parse_args(
+ $setting,
+ array(
+ 'active' => false,
+ 'id' => '',
+ 'tab' => '',
+ 'class' => '',
+ 'disabled' => false,
+ 'desc_tip' => '',
+ 'css' => '',
+ )
+ );
+ $field_key = $method->get_field_key( $key );
+ $field_value = $method->get_option( $key );
+ ob_start();
+ ?>
+
+
+
+
+
+
+ + +
+
+
+ '',
+ 'tabs' => array(),
+ 'provider' => '',
+ )
+ );
+ $count = 0;
+ ob_start();
+ ?>
+
+
+ method = $method;
+ $this->id = $this->method->id;
+ $this->instance_id = $this->method->get_instance_id();
+ } elseif ( is_array( $method ) ) {
+ $method = wp_parse_args(
+ $method,
+ array(
+ 'id' => '',
+ 'instance_id' => 0,
+ )
+ );
+
+ $this->is_placeholder = true;
+ $this->id = $method['id'];
+ $this->instance_id = $method['instance_id'];
+ }
+ }
+
+ public function get_id() {
+ if ( ! $this->is_placeholder() ) {
+ return $this->method->id;
+ } else {
+ return '';
+ }
+ }
+
+ public function get_instance_id() {
+ if ( ! $this->is_placeholder() ) {
+ return $this->method->get_instance_id();
+ } else {
+ return 0;
+ }
+ }
+
+ /**
+ * Returns the Woo WC_Shipping_Method original object
+ *
+ * @return WC_Shipping_Method|null
+ */
+ public function get_method() {
+ return $this->method;
+ }
+
+ /**
+ * @return false|ShippingProvider
+ */
+ public function get_shipping_provider_instance() {
+ if ( is_a( $this->method, '\Vendidero\Germanized\Shipments\ShippingMethod\ShippingMethod' ) ) {
+ return $this->method->get_shipping_provider();
+ }
+
+ if ( is_null( $this->provider ) ) {
+ $provider = $this->get_shipping_provider();
+
+ if ( ! empty( $provider ) ) {
+ $this->provider = wc_gzd_get_shipping_provider( $provider );
+ }
+ }
+
+ return $this->provider ? $this->provider : false;
+ }
+
+ public function get_shipping_provider() {
+ if ( is_a( $this->method, '\Vendidero\Germanized\Shipments\ShippingMethod\ShippingMethod' ) ) {
+ $provider_slug = $this->method->get_shipping_provider()->get_name();
+ } else {
+ $provider_slug = $this->get_prop( '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 ProviderMethod $method The method instance.
+ *
+ * @since 3.0.6
+ * @package Vendidero/Germanized/Shipments
+ */
+ return apply_filters( 'woocommerce_gzd_shipping_provider_method_provider', $provider_slug, $this->get_id(), $this );
+ }
+
+ public function set_shipping_provider( $shipping_provider_name ) {
+ $this->set_prop( 'shipping_provider', $shipping_provider_name );
+ $this->provider = null;
+ }
+
+ public function has_shipping_provider( $shipping_provider_name ) {
+ if ( ! is_array( $shipping_provider_name ) ) {
+ $shipping_provider_name = array( $shipping_provider_name );
+ }
+
+ return in_array( $this->get_shipping_provider(), $shipping_provider_name, true );
+ }
+
+ public function get_prop( $key, $context = 'view' ) {
+ $default = '';
+
+ if ( 'configuration_sets' === $key ) {
+ $default = array();
+ } elseif ( 'shipping_provider' === $key ) {
+ $default = wc_gzd_get_default_shipping_provider();
+ }
+
+ if ( ! $this->is_placeholder() && ! MethodHelper::method_is_excluded( $this->get_id() ) ) {
+ $value = $this->supports_instance_settings() ? $this->method->get_instance_option( $key, $default ) : $this->method->get_option( $key, $default );
+ } else {
+ $value = $default;
+ }
+
+ return $value;
+ }
+
+ public function set_prop( $key, $value ) {
+ if ( ! $this->is_placeholder() && ! MethodHelper::method_is_excluded( $this->get_id() ) ) {
+ if ( $this->supports_instance_settings() ) {
+ if ( empty( $this->method->instance_settings ) ) {
+ $this->method->init_instance_settings();
+ }
+
+ if ( 'configuration_sets' === $key ) {
+ $this->method->instance_settings[ $key ] = array_filter( (array) $value );
+ } else {
+ $this->method->instance_settings[ $key ] = $value;
+ }
+ } else {
+ if ( empty( $this->method->settings ) ) {
+ $this->method->init_settings();
+ }
+
+ if ( 'configuration_sets' === $key ) {
+ $this->method->settings[ $key ] = array_filter( (array) $value );
+ } else {
+ $this->method->settings[ $key ] = $value;
+ }
+ }
+ }
+ }
+
+ protected function get_configuration_set_setting_type() {
+ return 'shipping_method';
+ }
+
+ protected function supports_instance_settings() {
+ if ( $this->is_placeholder() ) {
+ return false;
+ } else {
+ $supports_settings = ( $this->method->supports( 'instance-settings' ) ) ? true : false;
+
+ return apply_filters( 'woocommerce_gzd_shipping_provider_method_supports_instance_settings', $supports_settings, $this );
+ }
+ }
+
+ public function is_placeholder() {
+ return true === $this->is_placeholder;
+ }
+
+ protected function get_hook_prefix() {
+ $prefix = 'woocommerce_gzd_shipping_provider_method_';
+
+ return $prefix;
+ }
+
+ public function get_option( $key ) {
+ wc_deprecated_function( 'Vendidero\Germanized\Shipments\ShippingProvider\Method::get_option()', '3.0.0' );
+
+ return $this->get_prop( $key );
+ }
+
+ public function set_provider( $shipping_provider_name ) {
+ wc_deprecated_function( 'Vendidero\Germanized\Shipments\ShippingProvider\Method::set_provider()', '3.0.0' );
+
+ $this->set_shipping_provider( $shipping_provider_name );
+ }
+
+ public function get_provider() {
+ wc_deprecated_function( 'Vendidero\Germanized\Shipments\ShippingProvider\Method::get_provider()', '3.0.0' );
+
+ return $this->get_shipping_provider();
+ }
+
+ public function has_option( $key ) {
+ wc_deprecated_function( 'Vendidero\Germanized\Shipments\ShippingProvider\Method::has_option()', '3.0.0' );
+
+ return false;
+ }
+
+ public function is_provider_enabled( $provider ) {
+ wc_deprecated_function( 'Vendidero\Germanized\Shipments\ShippingProvider\Method::is_provider_enabled()', '3.0.0' );
+
+ return ( $this->get_provider() === $provider ) ? true : false;
+ }
+
+ public function setting_belongs_to_provider( $setting_key, $provider = '' ) {
+ wc_deprecated_function( 'Vendidero\Germanized\Shipments\ShippingProvider\Method::setting_belongs_to_provider()', '3.0.0' );
+
+ return false;
+ }
+
+ public static function get_admin_settings() {
+ wc_deprecated_function( 'Vendidero\Germanized\Shipments\ShippingProvider\Method::get_admin_settings()', '3.0.0' );
+
+ return array();
+ }
+
+ public function get_provider_instance() {
+ wc_deprecated_function( 'Vendidero\Germanized\Shipments\ShippingProvider\Method::get_provider_instance()', '3.0.0' );
+
+ return $this->get_shipping_provider_instance();
+ }
+
+ public function get_fallback_setting_value( $setting_key ) {
+ wc_deprecated_function( 'Vendidero\Germanized\Shipments\ShippingProvider\Method::get_fallback_setting_value()', '3.0.0' );
+
+ return '';
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/ShippingMethod/ProviderMethodPlaceholder.php b/packages/woocommerce-germanized-shipments/src/ShippingMethod/ProviderMethodPlaceholder.php
new file mode 100644
index 000000000..4a899879c
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/ShippingMethod/ProviderMethodPlaceholder.php
@@ -0,0 +1,21 @@
+get_method( $instance_id );
+
+ if ( ! empty( $raw_method ) ) {
+ $method_id = str_replace( 'shipping_provider_', '', $raw_method->method_id );
+ $this->shipping_provider = wc_gzd_get_shipping_provider( $method_id );
+ }
+ }
+ } else {
+ $this->shipping_provider = is_a( $shipping_provider, 'Vendidero\Germanized\Shipments\Interfaces\ShippingProvider' ) ? $shipping_provider : wc_gzd_get_shipping_provider( $shipping_provider );
+ }
+
+ if ( ! is_a( $this->shipping_provider, 'Vendidero\Germanized\Shipments\Interfaces\ShippingProvider' ) ) {
+ return;
+ }
+
+ $this->id = 'shipping_provider_' . $this->shipping_provider->get_name();
+ $this->instance_id = absint( $instance_id );
+ $this->method_title = $this->shipping_provider->get_title();
+ $this->method_description = sprintf( _x( 'Apply rule-based shipping costs for shipments handled by %1$s based on your available packaging options. Learn how to configure →', 'shipments', 'woocommerce-germanized' ), $this->shipping_provider->get_title(), 'https://vendidero.de/dokument/versandregeln-erstellen' );
+ $this->title = $this->method_title;
+ $this->supports = array(
+ 'shipping-zones',
+ 'instance-settings',
+ );
+
+ $this->init();
+ }
+
+ /**
+ * Init user set variables.
+ */
+ public function init() {
+ // Load the settings.
+ $this->init_form_fields();
+ $this->init_settings();
+
+ // Define user set variables.
+ $this->title = $this->get_option( 'title' );
+
+ // Actions.
+ add_action( 'woocommerce_update_options_shipping_' . $this->id, array( $this, 'process_admin_options' ) );
+ }
+
+ /**
+ * @return ShippingProvider
+ */
+ public function get_shipping_provider() {
+ return $this->shipping_provider;
+ }
+
+ public function get_all_shipping_rules() {
+ return array_merge( ...array_values( $this->get_shipping_rules() ) );
+ }
+
+ public function get_shipping_rules() {
+ return $this->get_option( 'shipping_rules', array() );
+ }
+
+ public function get_shipping_rule_by_id( $rule_id, $packaging_id ) {
+ $rules = $this->get_shipping_rules_by_packaging( $packaging_id );
+ $rule_key = "rule_{$rule_id}";
+
+ if ( array_key_exists( $rule_key, $rules ) ) {
+ return $rules[ $rule_key ];
+ }
+
+ return false;
+ }
+
+ public function get_shipping_rules_by_packaging( $packaging ) {
+ $shipping_rules = $this->get_shipping_rules();
+ $packaging_rules = array();
+
+ if ( array_key_exists( $packaging, $shipping_rules ) ) {
+ $packaging_rules = $shipping_rules[ $packaging ];
+ }
+
+ return $packaging_rules;
+ }
+
+ public function get_fallback_shipping_rules() {
+ $shipping_rules = $this->get_shipping_rules();
+ $packaging_rules = array();
+
+ if ( array_key_exists( 'all', $shipping_rules ) ) {
+ $packaging_rules = $shipping_rules['all'];
+ }
+
+ return $packaging_rules;
+ }
+
+ public function admin_options() {
+ $locale = localeconv();
+ $decimal_point = isset( $locale['decimal_point'] ) ? $locale['decimal_point'] : '.';
+ $decimal = ( ! empty( wc_get_price_decimal_separator() ) ) ? wc_get_price_decimal_separator() : $decimal_point;
+
+ wp_localize_script(
+ 'wc-gzd-admin-shipping-rules',
+ 'wc_gzd_admin_shipping_rules_params',
+ array(
+ 'rules' => $this->get_option( 'shipping_rules', array() ),
+ 'decimal_separator' => $decimal,
+ 'price_decimal_separator' => wc_get_price_decimal_separator(),
+ 'default_shipping_rule' => array(
+ 'rule_id' => 0,
+ 'packaging' => '',
+ 'costs' => '',
+ 'conditions' => array(
+ array(
+ 'rule_id' => 0,
+ 'condition_id' => 0,
+ 'type' => 'always',
+ 'operator' => '',
+ ),
+ ),
+ ),
+ 'strings' => array(
+ 'unload_confirmation_msg' => _x( 'Your changed data will be lost if you leave this page without saving.', 'shipments', 'woocommerce-germanized' ),
+ ),
+ )
+ );
+ wp_enqueue_script( 'wc-gzd-admin-shipping-rules' );
+
+ parent::admin_options();
+ }
+
+ /**
+ * @return false|\WC_Shipping_Zone
+ */
+ public function get_zone() {
+ if ( $this->get_instance_id() > 0 ) {
+ if ( is_null( $this->zone ) ) {
+ $this->zone = \WC_Shipping_Zones::get_zone_by( 'instance_id', $this->get_instance_id() );
+ }
+
+ return $this->zone;
+ }
+
+ return false;
+ }
+
+ /**
+ * Return admin options as a html string.
+ *
+ * @return string
+ */
+ public function get_admin_options_html() {
+ if ( $this->instance_id ) {
+ $settings_html = $this->generate_settings_html( $this->get_instance_form_fields(), false );
+ } else {
+ $settings_html = $this->generate_settings_html( $this->get_form_fields(), false );
+ }
+
+ return '' . $settings_html . '
';
+ }
+
+ public function init_form_fields() {
+ $this->instance_form_fields = array(
+ 'title' => array(
+ 'title' => _x( 'Title', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'description' => _x( 'This controls the title which the user sees during checkout.', 'shipments', 'woocommerce-germanized' ),
+ 'default' => $this->method_title,
+ 'desc_tip' => true,
+ ),
+ 'free_title' => array(
+ 'title' => _x( 'Title (free shipping)', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'text',
+ 'description' => _x( 'This controls the title which the user sees during checkout in case a free shipping option is available.', 'shipments', 'woocommerce-germanized' ),
+ 'default' => sprintf( _x( 'Free shipping (via %1$s)', 'shipments', 'woocommerce-germanized' ), $this->method_title ),
+ 'desc_tip' => true,
+ ),
+ 'shipping_rules_title' => array(
+ 'title' => _x( 'Shipping Rules', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'title',
+ 'id' => 'shipping_rules_title',
+ 'default' => '',
+ 'description' => sprintf( _x( 'Configure shipping costs per packaging option. Within cart, a rucksack algorithm will automatically fit the items in the packaging option(s) available and calculate it\'s cost.
Some important hints on the calculation logic:
+
+
+
+
+
+ instance_settings ) ) {
+ $this->init_instance_settings();
+ }
+
+ $this->instance_settings[ $key ] = $value;
+
+ return update_option( $this->get_instance_option_key(), apply_filters( 'woocommerce_shipping_' . $this->id . '_instance_settings_values', $this->instance_settings, $this ), 'yes' );
+ }
+}
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..e38123c99
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/ShippingProvider/Auto.php
@@ -0,0 +1,1217 @@
+ '',
+ '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,
+ 'configuration_sets' => array(),
+ );
+
+ public function get_label_default_shipment_weight( $context = 'view' ) {
+ return apply_filters( "{$this->get_hook_prefix()}label_default_shipment_weight", 0.5, $this );
+ }
+
+ protected function get_default_label_default_print_format() {
+ return '';
+ }
+
+ /**
+ * Returns the minimum weight applied to the label. Defaults to 1g.
+ *
+ * @param $context
+ *
+ * @return float
+ */
+ public function get_label_minimum_shipment_weight( $context = 'view' ) {
+ return apply_filters( "{$this->get_hook_prefix()}label_minimum_shipment_weight", 0.001, $this );
+ }
+
+ /**
+ * @param false|Shipment $shipment
+ *
+ * @return boolean
+ */
+ public function automatically_generate_label( $shipment = false ) {
+ if ( $shipment && 'return' === $shipment->get_type() ) {
+ return $this->automatically_generate_return_label();
+ } else {
+ return $this->get_label_auto_enable();
+ }
+ }
+
+ public function automatically_generate_return_label() {
+ return $this->get_label_return_auto_enable();
+ }
+
+ /**
+ * @param false|Shipment $shipment
+ *
+ * @return string
+ */
+ public function get_label_automation_shipment_status( $shipment = false ) {
+ if ( $shipment && 'return' === $shipment->get_type() ) {
+ return $this->get_label_return_auto_shipment_status();
+ }
+
+ return $this->get_label_auto_shipment_status();
+ }
+
+ public function automatically_set_shipment_status_shipped( $shipment = false ) {
+ return $this->get_label_auto_shipment_status_shipped();
+ }
+
+ 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 get_label_return_auto_enable( $context = 'view' ) {
+ return $this->get_prop( 'label_return_auto_enable', $context );
+ }
+
+ public function get_label_print_format( $context = 'view' ) {
+ return $this->get_prop( 'label_print_format', $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_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_print_format( $format ) {
+ $this->set_prop( 'label_print_format', $format );
+ }
+
+ public function set_label_return_auto_shipment_status( $status ) {
+ $this->set_prop( 'label_return_auto_shipment_status', $status );
+ }
+
+ public function get_label_classname( $type ) {
+ $classname = '\Vendidero\Germanized\Shipments\Labels\Label';
+
+ if ( 'return' === $type ) {
+ $classname = '\Vendidero\Germanized\Shipments\Labels\ReturnLabel';
+ }
+
+ return $classname;
+ }
+
+ /**
+ * 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_printing_settings() {
+ $settings = array(
+ array(
+ 'title' => _x( 'Label Format', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'title',
+ 'id' => 'shipping_provider_label_format_options',
+ ),
+ );
+
+ $settings = array_merge(
+ $settings,
+ array(
+ array(
+ 'title' => _x( 'Default Format', 'shipments', 'woocommerce-germanized' ),
+ 'type' => 'select',
+ 'id' => 'label_print_format',
+ 'default' => $this->get_default_label_default_print_format(),
+ 'desc' => _x( 'Set the default print format for a label.', 'shipments', 'woocommerce-germanized' ),
+ 'options' => $this->get_print_formats()->as_options(),
+ 'class' => 'wc-enhanced-select',
+ 'value' => $this->get_setting( 'label_print_format', $this->get_default_label_default_print_format() ),
+ ),
+ )
+ );
+
+ foreach ( $this->get_products( array( 'parent_id' => 0 ) ) as $product ) {
+ $settings = array_merge(
+ $settings,
+ array(
+ array(
+ 'title' => $product->get_label(),
+ 'type' => 'select',
+ 'id' => 'label_print_format_' . $product->get_id(),
+ 'default' => '',
+ 'custom_attributes' => array( 'data-placeholder' => _x( 'Same as default format', 'shipments', 'woocommerce-germanized' ) ),
+ 'options' => array_merge( array( '' => _x( 'Same as default format', 'shipments', 'woocommerce-germanized' ) ), $this->get_print_formats( array( 'product_id' => $product->get_id() ) )->as_options() ),
+ 'class' => 'wc-enhanced-select-nostd',
+ 'value' => $this->get_setting( "label_print_format_{$product->get_id()}" ),
+ ),
+ )
+ );
+ }
+
+ $settings = array_merge(
+ $settings,
+ array(
+ array(
+ 'type' => 'sectionend',
+ 'id' => 'shipping_provider_label_format_options',
+ ),
+ )
+ );
+
+ return $settings;
+ }
+
+ protected function get_automation_settings() {
+ $settings = array(
+ array(
+ 'title' => _x( 'Automation', 'shipments', 'woocommerce-germanized' ),
+ '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' => '
+
diff --git a/packages/woocommerce-germanized-shipments/templates/emails/email-return-shipment-instructions.php b/packages/woocommerce-germanized-shipments/templates/emails/email-return-shipment-instructions.php
new file mode 100644
index 000000000..2789a1d36
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/templates/emails/email-return-shipment-instructions.php
@@ -0,0 +1,26 @@
+get_shipping_provider_instance();
+?>
+
+has_return_instructions() ) : ?>
+
+
diff --git a/packages/woocommerce-germanized-shipments/templates/emails/email-shipment-details.php b/packages/woocommerce-germanized-shipments/templates/emails/email-shipment-details.php
new file mode 100644
index 000000000..a6ed2569d
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/templates/emails/email-shipment-details.php
@@ -0,0 +1,87 @@
+
+
+
+
+ get_name(), $item, false ) );
+
+ // SKU.
+ if ( $show_sku && $sku ) {
+ echo wp_kses_post( ' (#' . $sku . ')' );
+ }
+
+ /*
+ * Action that fires while outputting meta data for a ShipmentItem table display in an Email.
+ *
+ * @param integer $item_id The shipment item id.
+ * @param \Vendidero\Germanized\Shipments\ShipmentItem $item The shipment item instance.
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment The shipment instance.
+ * @param boolean $plain_text Whether this email is in plaintext format or not.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ do_action( 'woocommerce_gzd_shipment_item_meta', $item_id, $item, $shipment, $plain_text );
+
+ ?>
+
+
+ get_quantity(), $item ) );
+ ?>
+
+
+
+
diff --git a/packages/woocommerce-germanized-shipments/templates/emails/email-shipment-tracking.php b/packages/woocommerce-germanized-shipments/templates/emails/email-shipment-tracking.php
new file mode 100644
index 000000000..4d5cf3d4a
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/templates/emails/email-shipment-tracking.php
@@ -0,0 +1,42 @@
+
+
+
+
diff --git a/packages/woocommerce-germanized-shipments/templates/emails/plain/admin-new-return-shipment-request.php b/packages/woocommerce-germanized-shipments/templates/emails/plain/admin-new-return-shipment-request.php
new file mode 100644
index 000000000..14481e946
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/templates/emails/plain/admin-new-return-shipment-request.php
@@ -0,0 +1,41 @@
+get_formatted_sender_full_name() ) ) . "\n\n";
+
+echo "\n\n";
+
+/* This hook is documented in templates/emails/customer-shipment.php */
+do_action( 'woocommerce_gzd_email_shipment_details', $shipment, $sent_to_admin, $plain_text, $email );
+
+/**
+ * Show user-defined additional content - this is set in each email's settings.
+ */
+if ( $additional_content ) {
+ echo esc_html( wp_strip_all_tags( wptexturize( $additional_content ) ) );
+ echo "\n\n----------------------------------------\n\n";
+}
+
+echo "\n----------------------------------------\n\n";
+
+echo wp_kses_post( apply_filters( 'woocommerce_email_footer_text', get_option( 'woocommerce_email_footer_text' ) ) );
diff --git a/packages/woocommerce-germanized-shipments/templates/emails/plain/customer-guest-return-shipment-request.php b/packages/woocommerce-germanized-shipments/templates/emails/plain/customer-guest-return-shipment-request.php
new file mode 100644
index 000000000..132b76d58
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/templates/emails/plain/customer-guest-return-shipment-request.php
@@ -0,0 +1,40 @@
+get_billing_first_name() ) ) . "\n\n"; // phpcs:ignore WordPress.WP.I18n.TextDomainMismatch
+
+echo sprintf( esc_html_x( 'You\'ve requested a return to your order %s. Please follow the link to add your return request.', 'shipments', 'woocommerce-germanized' ), esc_html( $order->get_order_number() ) ) . "\n\n";
+
+echo esc_url( $add_return_request_url ) . "\n\n";
+
+/**
+ * Show user-defined additional content - this is set in each email's settings.
+ */
+if ( $additional_content ) {
+ echo esc_html( wp_strip_all_tags( wptexturize( $additional_content ) ) );
+ echo "\n\n----------------------------------------\n\n";
+}
+
+echo "\n----------------------------------------\n\n";
+
+echo wp_kses_post( apply_filters( 'woocommerce_email_footer_text', get_option( 'woocommerce_email_footer_text' ) ) );
diff --git a/packages/woocommerce-germanized-shipments/templates/emails/plain/customer-return-shipment-delivered.php b/packages/woocommerce-germanized-shipments/templates/emails/plain/customer-return-shipment-delivered.php
new file mode 100644
index 000000000..4c5660934
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/templates/emails/plain/customer-return-shipment-delivered.php
@@ -0,0 +1,43 @@
+get_billing_first_name() ) ) . "\n\n"; // phpcs:ignore WordPress.WP.I18n.TextDomainMismatch
+
+echo esc_html_x( 'Thank you! Your return has been received successfully. There are more details below for your reference:', 'shipments', 'woocommerce-germanized' );
+
+echo "\n\n";
+
+/* This hook is documented in templates/emails/customer-shipment.php */
+do_action( 'woocommerce_gzd_email_shipment_details', $shipment, $sent_to_admin, $plain_text, $email );
+
+/**
+ * Show user-defined additional content - this is set in each email's settings.
+ */
+if ( $additional_content ) {
+ echo esc_html( wp_strip_all_tags( wptexturize( $additional_content ) ) );
+ echo "\n\n----------------------------------------\n\n";
+}
+
+echo "\n----------------------------------------\n\n";
+
+echo wp_kses_post( apply_filters( 'woocommerce_email_footer_text', get_option( 'woocommerce_email_footer_text' ) ) );
diff --git a/packages/woocommerce-germanized-shipments/templates/emails/plain/customer-return-shipment.php b/packages/woocommerce-germanized-shipments/templates/emails/plain/customer-return-shipment.php
new file mode 100644
index 000000000..6f2fcdcd7
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/templates/emails/plain/customer-return-shipment.php
@@ -0,0 +1,48 @@
+get_billing_first_name() ) ) . "\n\n"; // phpcs:ignore WordPress.WP.I18n.TextDomainMismatch
+
+
+if ( $is_confirmation ) {
+ echo esc_html_x( 'Your return request has been accepted. Please follow the instructions beneath to return your shipment.', 'shipments', 'woocommerce-germanized' );
+} else {
+ echo esc_html_x( 'A new return has been added to your order. Please follow the instructions beneath to return your shipment.', 'shipments', 'woocommerce-germanized' );
+}
+
+echo "\n\n";
+
+/* This hook is documented in templates/emails/customer-shipment.php */
+do_action( 'woocommerce_gzd_email_shipment_details', $shipment, $sent_to_admin, $plain_text, $email );
+
+/**
+ * Show user-defined additional content - this is set in each email's settings.
+ */
+if ( $additional_content ) {
+ echo esc_html( wp_strip_all_tags( wptexturize( $additional_content ) ) );
+ echo "\n\n----------------------------------------\n\n";
+}
+
+echo "\n----------------------------------------\n\n";
+
+echo wp_kses_post( apply_filters( 'woocommerce_email_footer_text', get_option( 'woocommerce_email_footer_text' ) ) );
diff --git a/packages/woocommerce-germanized-shipments/templates/emails/plain/customer-shipment.php b/packages/woocommerce-germanized-shipments/templates/emails/plain/customer-shipment.php
new file mode 100644
index 000000000..751b764c4
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/templates/emails/plain/customer-shipment.php
@@ -0,0 +1,49 @@
+get_billing_first_name() ) ) . "\n\n"; // phpcs:ignore WordPress.WP.I18n.TextDomainMismatch
+
+if ( $partial_shipment ) {
+ /* translators: %s: Site title */
+ printf( esc_html_x( 'Your order on %1$s has been partially shipped via %2$s. Find details below for your reference:', 'shipments', 'woocommerce-germanized' ), wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ), wc_gzd_get_shipment_shipping_provider_title( $shipment ) ); // phpcs:ignore WordPress.XSS.EscapeOutput.OutputNotEscaped
+} else {
+ /* translators: %s: Site title */
+ printf( esc_html_x( 'Your order on %1$s has been shipped via %2$s. Find details below for your reference:', 'shipments', 'woocommerce-germanized' ), wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ), wc_gzd_get_shipment_shipping_provider_title( $shipment ) ); // phpcs:ignore WordPress.XSS.EscapeOutput.OutputNotEscaped
+}
+
+echo "\n\n";
+
+/* This hook is documented in templates/emails/customer-shipment.php */
+do_action( 'woocommerce_gzd_email_shipment_details', $shipment, $sent_to_admin, $plain_text, $email );
+
+/**
+ * Show user-defined additional content - this is set in each email's settings.
+ */
+if ( $additional_content ) {
+ echo esc_html( wp_strip_all_tags( wptexturize( $additional_content ) ) );
+ echo "\n\n----------------------------------------\n\n";
+}
+
+echo "\n----------------------------------------\n\n";
+
+echo wp_kses_post( apply_filters( 'woocommerce_email_footer_text', get_option( 'woocommerce_email_footer_text' ) ) );
diff --git a/packages/woocommerce-germanized-shipments/templates/emails/plain/email-order-shipments.php b/packages/woocommerce-germanized-shipments/templates/emails/plain/email-order-shipments.php
new file mode 100644
index 000000000..2c8b85934
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/templates/emails/plain/email-order-shipments.php
@@ -0,0 +1,47 @@
+ $shipment ) {
+ $count++;
+
+ echo "\n";
+
+ if ( count( $shipments ) > 1 ) {
+ echo sprintf( esc_html_x( 'Shipment %1$d of %2$d', 'shipments', 'woocommerce-germanized' ), esc_html( $count ), esc_html( count( $shipments ) ) ) . "\n\n";
+ }
+
+ if ( $shipment->get_est_delivery_date() ) {
+ echo esc_html( _x( 'Estimated date:', 'shipments', 'woocommerce-germanized' ) ) . ' ' . esc_html( wc_format_datetime( $shipment->get_est_delivery_date(), wc_date_format() ) ) . "\n\n";
+ }
+
+ if ( $shipment->has_tracking() ) {
+ if ( $shipment->get_tracking_url() ) {
+ echo esc_html( _x( 'Track your shipment', 'shipments', 'woocommerce-germanized' ) ) . ': ' . esc_url( $shipment->get_tracking_url() ) . "\n";
+ }
+
+ if ( $shipment->has_tracking_instruction() ) {
+ echo esc_html( $shipment->get_tracking_instruction( true ) ) . "\n";
+ }
+ } else {
+ echo esc_html( _x( 'Sorry, this shipment does currently not support tracking.', 'shipments', 'woocommerce-germanized' ) ) . "\n";
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/templates/emails/plain/email-return-shipment-instructions.php b/packages/woocommerce-germanized-shipments/templates/emails/plain/email-return-shipment-instructions.php
new file mode 100644
index 000000000..ee24b7d3b
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/templates/emails/plain/email-return-shipment-instructions.php
@@ -0,0 +1,23 @@
+get_shipping_provider_instance();
+
+if ( $provider && $provider->has_return_instructions() ) {
+ echo wp_kses_post( wpautop( wptexturize( $provider->get_return_instructions() ) ) . PHP_EOL );
+}
diff --git a/packages/woocommerce-germanized-shipments/templates/emails/plain/email-shipment-address.php b/packages/woocommerce-germanized-shipments/templates/emails/plain/email-shipment-address.php
new file mode 100644
index 000000000..2eaac15ae
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/templates/emails/plain/email-shipment-address.php
@@ -0,0 +1,20 @@
+#i', "\n", $shipment->get_formatted_address() ) . "\n"; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
diff --git a/packages/woocommerce-germanized-shipments/templates/emails/plain/email-shipment-details.php b/packages/woocommerce-germanized-shipments/templates/emails/plain/email-shipment-details.php
new file mode 100644
index 000000000..51c4b8206
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/templates/emails/plain/email-shipment-details.php
@@ -0,0 +1,43 @@
+get_type() ) ) : sprintf( _x( '[%1$s #%2$s]', 'shipments', 'woocommerce-germanized' ), wc_gzd_get_shipment_label_title( $shipment->get_type() ), $shipment->get_shipment_number() ) ) ) ) . "\n";
+echo "\n" . wc_gzd_get_email_shipment_items( // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
+ $shipment,
+ array(
+ 'show_sku' => $sent_to_admin,
+ 'show_image' => false,
+ 'image_size' => array( 32, 32 ),
+ 'plain_text' => true,
+ 'sent_to_admin' => $sent_to_admin,
+ )
+);
+
+echo "==========\n\n";
+
+if ( $sent_to_admin ) {
+ /* translators: %s: Shipment link. */
+ echo "\n" . sprintf( esc_html_x( 'View shipment: %s', 'shipments', 'woocommerce-germanized' ), esc_url( $shipment->get_edit_shipment_url() ) ) . "\n";
+}
+
+/* This hook is documented in templates/emails/customer-shipment.php */
+do_action( 'woocommerce_gzd_email_after_shipment_table', $shipment, $sent_to_admin, $plain_text, $email );
diff --git a/packages/woocommerce-germanized-shipments/templates/emails/plain/email-shipment-items.php b/packages/woocommerce-germanized-shipments/templates/emails/plain/email-shipment-items.php
new file mode 100644
index 000000000..2fa1d8308
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/templates/emails/plain/email-shipment-items.php
@@ -0,0 +1,46 @@
+ $item ) :
+ $product = $item->get_product();
+ $sku = $item->get_sku();
+ $purchase_note = '';
+
+ /* This filter is documented in templates/emails/email-shipment-items.php */
+ if ( ! apply_filters( 'woocommerce_gzd_shipment_item_visible', true, $item ) ) {
+ continue;
+ }
+
+ /* This filter is documented in templates/emails/email-shipment-items.php */
+ echo wp_kses_post( apply_filters( 'woocommerce_gzd_shipment_item_name', $item->get_name(), $item, false ) );
+
+ if ( $show_sku && $sku ) {
+ echo ' (#' . esc_html( $sku ) . ')';
+ }
+
+ /* This filter is documented in templates/emails/email-shipment-items.php */
+ echo ' X ' . wp_kses_post( apply_filters( 'woocommerce_gzd_email_shipment_item_quantity', $item->get_quantity(), $item ) );
+ echo "\n";
+
+ /* This hook is documented in templates/emails/email-shipment-items.php */
+ do_action( 'woocommerce_gzd_shipment_item_meta', $item_id, $item, $shipment, $plain_text );
+
+ echo "\n\n";
+endforeach;
diff --git a/packages/woocommerce-germanized-shipments/templates/emails/plain/email-shipment-tracking.php b/packages/woocommerce-germanized-shipments/templates/emails/plain/email-shipment-tracking.php
new file mode 100644
index 000000000..403a94c5a
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/templates/emails/plain/email-shipment-tracking.php
@@ -0,0 +1,33 @@
+get_est_delivery_date() ) {
+ echo esc_html( _x( 'Estimated date:', 'shipments', 'woocommerce-germanized' ) ) . ' ' . esc_html( wc_format_datetime( $shipment->get_est_delivery_date(), wc_date_format() ) ) . "\n\n";
+}
+
+if ( $shipment->get_tracking_url() ) {
+ echo esc_html( _x( 'Track your shipment', 'shipments', 'woocommerce-germanized' ) ) . ': ' . esc_url( $shipment->get_tracking_url() ) . "\n";
+}
+
+if ( $shipment->has_tracking_instruction() ) {
+ echo esc_html( $shipment->get_tracking_instruction( true ) ) . "\n";
+}
diff --git a/packages/woocommerce-germanized-shipments/templates/global/empty.php b/packages/woocommerce-germanized-shipments/templates/global/empty.php
new file mode 100644
index 000000000..fd3489d94
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/templates/global/empty.php
@@ -0,0 +1,21 @@
+
+
diff --git a/packages/woocommerce-germanized-shipments/templates/myaccount/add-return-shipment.php b/packages/woocommerce-germanized-shipments/templates/myaccount/add-return-shipment.php
new file mode 100644
index 000000000..6546c4bb7
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/templates/myaccount/add-return-shipment.php
@@ -0,0 +1,107 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/packages/woocommerce-germanized-shipments/templates/myaccount/order-shipments.php b/packages/woocommerce-germanized-shipments/templates/myaccount/order-shipments.php
new file mode 100644
index 000000000..ed4571e3e
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/templates/myaccount/order-shipments.php
@@ -0,0 +1,53 @@
+
+
+
+
+
+ 'simple',
+ 'shipments' => $shipments,
+ 'order' => $order,
+ )
+ );
+ ?>
+
+
+
+
+
+
+
+
+
+
+
+ 'return',
+ 'shipments' => $returns,
+ 'order' => $order,
+ )
+ );
+ ?>
+
diff --git a/packages/woocommerce-germanized-shipments/templates/myaccount/shipments.php b/packages/woocommerce-germanized-shipments/templates/myaccount/shipments.php
new file mode 100644
index 000000000..71d4cf1fc
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/templates/myaccount/shipments.php
@@ -0,0 +1,113 @@
+
+
+
+
+
+
+
diff --git a/packages/woocommerce-germanized-shipments/templates/myaccount/view-shipment.php b/packages/woocommerce-germanized-shipments/templates/myaccount/view-shipment.php
new file mode 100644
index 000000000..7c28e5636
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/templates/myaccount/view-shipment.php
@@ -0,0 +1,42 @@
+
+
+
+
+
+
+
+
+ get_product();
+ $is_visible = $product && $product->is_visible();
+ $item_sku = $item->get_sku();
+
+ /** This filter is documented in templates/myaccount/shipment/shipment-details-item.php */
+ $product_permalink = apply_filters( 'woocommerce_gzd_shipment_item_permalink', $is_visible ? $product->get_permalink() : '', $item, $order );
+
+ /** This filter is documented in templates/emails/email-shipment-items.php */
+ echo apply_filters( 'woocommerce_gzd_shipment_item_name', ( $product_permalink ? sprintf( '%s', esc_url( $product_permalink ), $item->get_name() ) : $item->get_name() ) . ( ! empty( $item_sku ) ? ' (' . esc_html( $item_sku ) . ')' : '' ), $item, $is_visible ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
+ ?>
+
+
+
+
+
+
+
+
+ 1
+
+ 'item[' . esc_attr( $order_item_id ) . '][quantity]',
+ 'input_value' => 1,
+ 'max_value' => $max_quantity,
+ 'min_value' => 1,
+ ),
+ $item->get_product()
+ );
+ ?>
+
+
diff --git a/packages/woocommerce-germanized-shipments/templates/shipment/shipment-details-address.php b/packages/woocommerce-germanized-shipments/templates/shipment/shipment-details-address.php
new file mode 100644
index 000000000..6e0b8713c
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/templates/shipment/shipment-details-address.php
@@ -0,0 +1,52 @@
+
+
+
+
+
+
+
+
+ get_formatted_address( esc_html_x( 'N/A', 'shipments', 'woocommerce-germanized' ) ) ); ?>
+
+ get_phone() ) : ?>
+
+
+
+
+
diff --git a/packages/woocommerce-germanized-shipments/templates/shipment/shipment-details-item.php b/packages/woocommerce-germanized-shipments/templates/shipment/shipment-details-item.php
new file mode 100644
index 000000000..cee0cfd43
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/templates/shipment/shipment-details-item.php
@@ -0,0 +1,93 @@
+
+
+
+
+ is_visible();
+ $item_sku = $item->get_sku();
+
+ /**
+ * This filter may adjust the shipment item permalink on the customer account page.
+ *
+ * @param string $permalink The permalink.
+ * @param ShipmentItem $item The shipment item instance.
+ * @param Shipment $shipment The shipment instance.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ $product_permalink = apply_filters( 'woocommerce_gzd_shipment_item_permalink', $is_visible ? $product->get_permalink() : '', $item, $shipment );
+
+ /** This filter is documented in templates/emails/email-shipment-items.php */
+ echo apply_filters( 'woocommerce_gzd_shipment_item_name', ( $product_permalink ? sprintf( '%s', esc_url( $product_permalink ), $item->get_name() ) : $item->get_name() ) . ( ! empty( $item_sku ) ? ' (' . esc_html( $item_sku ) . ')' : '' ), $item, $is_visible ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
+ ?>
+
+
+
+ get_quantity();
+ $qty_display = esc_html( $qty );
+
+ /**
+ * This filter may adjust the shipment item quantity HTML on the customer account page.
+ *
+ * @param string $html The HTML output.
+ * @param ShipmentItem $item The shipment item instance.
+ *
+ * @since 3.0.0
+ * @package Vendidero/Germanized/Shipments
+ */
+ echo apply_filters( 'woocommerce_gzd_shipment_item_quantity_html', ' ' . sprintf( '× %s', $qty_display ) . '', $item ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
+ ?>
+
+
+
diff --git a/packages/woocommerce-germanized-shipments/templates/shipment/shipment-details-tracking.php b/packages/woocommerce-germanized-shipments/templates/shipment/shipment-details-tracking.php
new file mode 100644
index 000000000..6cb603862
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/templates/shipment/shipment-details-tracking.php
@@ -0,0 +1,44 @@
+
+
+
+
+
+ get_tracking_url() ) : ?>
+
+
+
+ has_tracking_instruction() ) : ?>
+
+
+
diff --git a/packages/woocommerce-germanized-shipments/templates/shipment/shipment-details.php b/packages/woocommerce-germanized-shipments/templates/shipment/shipment-details.php
new file mode 100644
index 000000000..18587e82c
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/templates/shipment/shipment-details.php
@@ -0,0 +1,121 @@
+get_order(); // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
+$show_receiver_details = is_user_logged_in() && $order && $order->get_user_id() === get_current_user_id();
+$show_tracking = $show_receiver_details && $shipment->has_tracking();
+$shipment_items = $shipment->get_items();
+
+if ( is_a( $shipment, 'Vendidero\Germanized\Shipments\ReturnShipment' ) ) {
+ if ( $shipment->hide_return_address() ) {
+ $show_receiver_details = false;
+ }
+}
+?>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $shipment ) );
+}
+
+if ( $show_tracking ) {
+ wc_get_template( 'shipment/shipment-details-tracking.php', array( 'shipment' => $shipment ) );
+}
diff --git a/packages/woocommerce-germanized-shipments/templates/shipment/shipment-return-instructions.php b/packages/woocommerce-germanized-shipments/templates/shipment/shipment-return-instructions.php
new file mode 100644
index 000000000..624594d02
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/templates/shipment/shipment-return-instructions.php
@@ -0,0 +1,41 @@
+get_shipping_provider_instance();
+?>
+
+has_return_instructions() ) : ?>
+
+
+
+ Some important hints on the calculation logic:
- The from value (e.g. 3) is expected to be inclusive (greater or equal 3). The to value (e.g. 5) is expected to be exclusive (smaller than 5).
- Leave the to value empty for your last packaging rule to match all subsequent values.
- All conditions must be met for the shipping rule to apply.
- In case a free shipping rule is available, the conditional logic automatically stops.
- The all remaining packaging rules will be used for available packaging options without custom rules and serve as fallback in case no applicable rule was found.
- In case no all remaining packaging rule exists, only packaging options with custom rules will be used for packing.
| + | + + | ++ + | ++ + | ++ + | ++ + | +|
|---|---|---|---|---|---|---|
| + + + + | +||||||
' . _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',
+ '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_by_shipment_type( $shipment_type = 'simple' ) {
+ $settings = array();
+
+ foreach ( $this->get_available_label_zones( $shipment_type ) as $zone ) {
+ $setting_id = 'shipping_provider_' . $shipment_type . '_label_' . $zone;
+ $configuration_set = $this->get_or_create_configuration_set(
+ array(
+ 'shipping_provider_name' => $this->get_name(),
+ 'shipment_type' => $shipment_type,
+ 'zone' => $zone,
+ )
+ );
+ $inner_zone_settings = $this->get_label_settings_by_zone( $configuration_set );
+
+ if ( ! empty( $inner_zone_settings ) ) {
+ $settings = array_merge(
+ $settings,
+ array(
+ array(
+ 'title' => wc_gzd_get_shipping_shipments_label_zone_title( $zone ),
+ 'type' => 'title',
+ 'id' => $setting_id,
+ ),
+ ),
+ $inner_zone_settings,
+ array(
+ array(
+ 'type' => 'sectionend',
+ 'id' => $setting_id,
+ ),
+ )
+ );
+ }
+ }
+
+ return $settings;
+ }
+
+ protected function get_config_set_simple_label_settings() {
+ $settings = $this->get_label_settings();
+ $settings = array_merge( $settings, $this->get_label_settings_by_shipment_type( 'simple' ) );
+
+ return $settings;
+ }
+
+ protected function get_config_set_return_label_settings() {
+ $settings = $this->get_label_settings();
+ $settings = array_merge( $settings, $this->get_label_settings_by_shipment_type( 'return' ) );
+
+ return $settings;
+ }
+
+ protected function get_return_label_settings() {
+ return array();
+ }
+
+ protected function get_label_settings() {
+ return array();
+ }
+
+ /**
+ * @param ConfigurationSet $configuration_set
+ *
+ * @return string
+ */
+ protected function get_default_product_for_zone( $configuration_set ) {
+ $products = $this->get_products(
+ array(
+ 'zone' => $configuration_set->get_zone(),
+ 'shipment_type' => $configuration_set->get_shipment_type(),
+ )
+ );
+
+ return $products->get_by_index( 0 )->get_id();
+ }
+
+ /**
+ * @param ConfigurationSet $configuration_set
+ *
+ * @return array
+ */
+ protected function get_label_settings_by_zone( $configuration_set ) {
+ $settings = array();
+ $products = $this->get_products(
+ array(
+ 'zone' => $configuration_set->get_zone(),
+ 'shipment_type' => $configuration_set->get_shipment_type(),
+ )
+ );
+
+ $services = $this->get_services(
+ array(
+ 'zone' => $configuration_set->get_zone(),
+ 'shipment_type' => $configuration_set->get_shipment_type(),
+ )
+ );
+
+ if ( ! $products->empty() ) {
+ $default_product = $this->get_default_product_for_zone( $configuration_set );
+ $product_setting_id = $configuration_set->get_setting_id( 'product' );
+ $select = $products->as_options();
+
+ $settings = array_merge(
+ $settings,
+ array(
+ array(
+ 'title' => _x( 'Default Service', 'dhl', 'woocommerce-germanized' ),
+ 'type' => 'select',
+ 'id' => $product_setting_id,
+ 'default' => 'shipping_provider' === $configuration_set->get_setting_type() ? $default_product : $this->get_setting( $product_setting_id, $default_product ),
+ 'value' => $configuration_set->get_product() ? $configuration_set->get_product() : null,
+ 'desc' => sprintf( _x( 'Select the default service for %1$s.', 'shipments', 'woocommerce-germanized' ), wc_gzd_get_shipping_shipments_label_zone_title( $configuration_set->get_zone() ) ),
+ 'options' => $select,
+ 'class' => 'wc-enhanced-select',
+ 'provider' => $this->get_name(),
+ 'shipment_setting_type' => 'product',
+ 'shipment_zone' => $configuration_set->get_zone(),
+ 'shipment_type' => $configuration_set->get_shipment_type(),
+ ),
+ )
+ );
+
+ foreach ( $services as $service ) {
+ $service_setting_fields = $service->get_setting_fields( $configuration_set );
+
+ if ( ! empty( $product_setting_id ) ) {
+ $count = 0;
+
+ foreach ( $service_setting_fields as $k => $service_setting ) {
+ $count++;
+
+ $service_setting_fields[ $k ] = wp_parse_args(
+ $service_setting_fields[ $k ],
+ array(
+ 'custom_attributes' => array(),
+ 'service' => $service->get_id(),
+ 'provider' => $this->get_name(),
+ 'shipment_setting_type' => 1 === $count ? 'service' : 'service_meta',
+ 'shipment_zone' => $configuration_set->get_zone(),
+ 'shipment_type' => $configuration_set->get_shipment_type(),
+ )
+ );
+
+ $service_setting_fields[ $k ]['default'] = 'shipping_provider' === $configuration_set->get_setting_type() ? $service_setting_fields[ $k ]['default'] : $this->get_setting( $service_setting_fields[ $k ]['id'], $service_setting_fields[ $k ]['default'] );
+ $service_setting_fields[ $k ]['custom_attributes'] = array_merge( array( "data-show_if_{$product_setting_id}" => implode( ',', $service->get_products() ) ), $service_setting_fields[ $k ]['custom_attributes'] );
+ }
+ }
+
+ $settings = array_merge( $settings, $service_setting_fields );
+ }
+ }
+
+ 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' ),
+ );
+
+ foreach ( wc_gzd_get_shipment_types() as $shipment_type ) {
+ $settings = $this->{"get_config_set_{$shipment_type}_label_settings"}();
+
+ if ( ! empty( $settings ) ) {
+ $section_title = 'simple' === $shipment_type ? _x( 'Labels', 'shipments', 'woocommerce-germanized' ) : sprintf( _x( '%1$s labels', 'shipments', 'woocommerce-germanized' ), wc_gzd_get_shipment_label_title( $shipment_type ) );
+ $sections = array_merge(
+ $sections,
+ array(
+ 'config_set_' . $shipment_type . '_label' => $section_title,
+ )
+ );
+ }
+ }
+
+ if ( ! $this->get_print_formats()->empty() ) {
+ $sections = array_merge(
+ $sections,
+ array(
+ 'printing' => _x( 'Printing', 'shipments', 'woocommerce-germanized' ),
+ )
+ );
+ }
+
+ $sections = array_merge(
+ $sections,
+ array(
+ '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() ) {
+ $label_fields = $this->get_return_label_fields( $shipment );
+ } else {
+ $label_fields = $this->get_simple_label_fields( $shipment );
+ }
+
+ if ( ! is_wp_error( $label_fields ) ) {
+ $label_fields = array_merge( $label_fields, $this->get_label_service_fields( $shipment ) );
+ }
+
+ return $label_fields;
+ }
+
+ public function get_label_service_fields( $shipment ) {
+ $service_fields = array();
+ $services = $this->get_services( array( 'shipment' => $shipment ) );
+ $default_props = $this->get_default_label_props( $shipment );
+
+ if ( ! empty( $services ) ) {
+ $service_settings = array();
+ $has_default_service = ! empty( $default_props['services'] ) ? true : false;
+
+ foreach ( $services as $service ) {
+ if ( $service->supports_location( 'label_services' ) ) {
+ $service_settings = array_merge( $service_settings, $service->get_label_fields( $shipment, 'services' ) );
+ }
+ }
+
+ if ( ! empty( $service_settings ) ) {
+ $service_fields[] = array(
+ 'type' => 'services_start',
+ 'hide_default' => $has_default_service ? false : true,
+ 'id' => '',
+ );
+
+ $service_fields = array_merge( $service_fields, $service_settings );
+ }
+ }
+
+ return $service_fields;
+ }
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment
+ */
+ protected function get_simple_label_fields( $shipment ) {
+ $defaults = $this->get_default_label_props( $shipment );
+ $available = $this->get_available_label_products( $shipment );
+ $print_formats = $this->get_available_label_print_formats( $shipment );
+
+ $settings = array(
+ array(
+ 'id' => 'product_id',
+ 'label' => sprintf( _x( '%s Product', 'shipments', 'woocommerce-germanized' ), $this->get_title() ),
+ 'description' => '',
+ 'options' => $available,
+ 'value' => $defaults['product_id'] && array_key_exists( $defaults['product_id'], $available ) ? $defaults['product_id'] : '',
+ 'type' => 'select',
+ ),
+ );
+
+ if ( ! empty( $print_formats ) && count( $print_formats ) > 1 ) {
+ $custom_attributes = array( 'data-products-supported' => '' );
+
+ foreach ( $print_formats as $print_format_id ) {
+ if ( $print_format = $this->get_print_format( $print_format_id ) ) {
+ if ( ! empty( $print_format->get_products() ) ) {
+ $custom_attributes['data-products-supported'] .= '&' . $print_format->get_id() . '=' . implode( ',', $print_format->get_products() );
+ }
+ }
+ }
+
+ $settings = array_merge(
+ $settings,
+ array(
+ array(
+ 'id' => 'print_format',
+ 'label' => _x( 'Print Format', 'shipments', 'woocommerce-germanized' ),
+ 'description' => '',
+ 'custom_attributes' => $custom_attributes,
+ 'options' => $print_formats,
+ 'value' => $defaults['print_format'] && array_key_exists( $defaults['print_format'], $print_formats ) ? $defaults['print_format'] : '',
+ '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 ShipmentError|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 ),
+ 'print_format' => $this->get_default_label_print_format( $shipment ),
+ );
+
+ $dimensions = wc_gzd_get_shipment_label_dimensions( $shipment );
+ $default = array_merge( $default, $dimensions );
+
+ foreach ( $this->get_services(
+ array(
+ 'shipment' => $shipment,
+ 'product_id' => $default['product_id'],
+ )
+ ) as $service ) {
+ if ( $service->book_as_default( $shipment ) ) {
+ $default['services'][] = $service->get_id();
+
+ foreach ( $service->get_label_fields( $shipment ) as $setting ) {
+ if ( isset( $setting['id'], $setting['value'] ) ) {
+ if ( $setting['id'] === $service->get_label_field_id() && 'checkbox' === $setting['type'] ) {
+ continue;
+ } else {
+ $setting_id = $setting['id'];
+
+ /**
+ * Support array input fields, e.g. return_address[name].
+ * Automagically transform those values to associative arrays.
+ */
+ if ( strstr( $setting_id, '[' ) ) {
+ parse_str( $setting_id, $setting_array );
+
+ foreach ( $setting_array as $setting_key => $inner_settings ) {
+ $inner_setting_name = current( array_keys( $inner_settings ) );
+ $setting_array[ $setting_key ][ $inner_setting_name ] = $setting['value'];
+
+ if ( ! isset( $default[ $setting_key ] ) ) {
+ $default[ $setting_key ] = array();
+ }
+
+ $default[ $setting_key ] = array_replace_recursive( (array) $default[ $setting_key ], $setting_array[ $setting_key ] );
+ }
+ } else {
+ $default[ $setting['id'] ] = $setting['value'];
+ }
+ }
+ }
+ }
+ }
+ }
+
+ if ( 'return' === $shipment->get_type() ) {
+ $default['sender_address'] = $shipment->get_sender_address();
+ }
+
+ return $default;
+ }
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment
+ * @param mixed $props
+ *
+ * @return ShipmentError|true
+ */
+ public function create_label( $shipment, $props = false ) {
+ $errors = new ShipmentError();
+ $org_props = $props;
+
+ /**
+ * 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 ) ) {
+ $default_props = $this->get_default_label_props( $shipment );
+ $default_props['services'] = array();
+ $default_props['print_format'] = '';
+
+ $props = wp_parse_args( $props, $default_props );
+ }
+
+ $props = wp_parse_args(
+ $props,
+ array(
+ 'services' => array(),
+ 'print_format' => '',
+ 'product_id' => '',
+ )
+ );
+
+ /**
+ * Neither allow invalid service configuration from automatic nor manual requests.
+ */
+ foreach ( $this->get_services() as $service ) {
+ $label_field_id = $service->get_label_field_id();
+
+ /**
+ * Should only be the case for manual requests, e.g. form submits.
+ */
+ if ( array_key_exists( $label_field_id, $props ) ) {
+ $value = $props[ $label_field_id ];
+
+ if ( 'checkbox' === $service->get_option_type() ) {
+ if ( wc_string_to_bool( $value ) ) {
+ if ( ! in_array( $service->get_id(), $props['services'], true ) ) {
+ $props['services'][] = $service->get_id();
+ }
+ }
+
+ unset( $props[ $label_field_id ] );
+ } elseif ( 'select' === $service->get_option_type() ) {
+ if ( ! empty( $value ) && array_key_exists( $value, $service->get_options() ) ) {
+ if ( ! in_array( $service->get_id(), $props['services'], true ) ) {
+ $props['services'][] = $service->get_id();
+ }
+ } else {
+ $props['services'] = array_diff( $props['services'], array( $service->get_id() ) );
+ unset( $props[ $label_field_id ] );
+ }
+ }
+ }
+
+ /**
+ * Remove services + service meta in case the service is not available or not booked.
+ */
+ if ( ! $service->supports(
+ array(
+ 'shipment' => $shipment,
+ 'product' => $props['product_id'],
+ )
+ ) || ! in_array( $service->get_id(), $props['services'], true ) ) {
+ $props['services'] = array_diff( $props['services'], array( $service->get_id() ) );
+
+ foreach ( $service->get_label_fields( $shipment ) as $setting ) {
+ $setting_id = $setting['id'];
+
+ if ( strstr( $setting_id, '[' ) ) {
+ $setting_parts = explode( '[', $setting_id );
+ $setting_id = $setting_parts[0];
+ }
+
+ if ( array_key_exists( $setting_id, $props ) ) {
+ unset( $props[ $setting_id ] );
+ }
+ }
+
+ if ( array_key_exists( $label_field_id, $props ) ) {
+ unset( $props[ $label_field_id ] );
+ continue;
+ }
+ }
+
+ if ( in_array( $service->get_id(), $props['services'], true ) ) {
+ $valid = $service->validate_label_request( $props, $shipment );
+
+ if ( is_wp_error( $valid ) ) {
+ $errors->merge_from( $valid );
+ } else {
+ foreach ( $service->get_label_fields( $shipment ) as $setting ) {
+ if ( $label_field_id === $setting['id'] ) {
+ continue;
+ }
+
+ if ( array_key_exists( $setting['id'], $props ) ) {
+ $setting = wp_parse_args(
+ $setting,
+ array(
+ 'data_type' => '',
+ )
+ );
+
+ if ( ! empty( $setting['data_type'] ) ) {
+ if ( in_array( $setting['data_type'], array( 'price', 'decimal' ), true ) ) {
+ $props[ $setting['id'] ] = wc_format_decimal( $props[ $setting['id'] ] );
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+
+ $props = $this->validate_label_request( $shipment, $props );
+
+ if ( is_wp_error( $props ) ) {
+ $errors->merge_from( $props );
+ }
+
+ if ( wc_gzd_shipment_wp_error_has_errors( $errors ) ) {
+ return $errors;
+ }
+
+ 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 ) ) {
+ $result = wc_gzd_get_shipment_error( $result );
+
+ if ( ! $result->is_soft_error() ) {
+ $code = absint( $result->get_error_code() );
+
+ /**
+ * Server error and/or too many requests: retry
+ */
+ if ( 500 === $code || 429 === $code ) {
+ $hits = false === get_transient( "{$this->get_general_hook_prefix()}label_rate_limit_hits" ) ? 0 : absint( get_transient( "{$this->get_general_hook_prefix()}label_rate_limit_hits" ) );
+
+ if ( $hits <= apply_filters( 'woocommerce_gzd_shipments_max_api_retries', 5 ) ) {
+ $hits++;
+
+ sleep( 0.25 * $hits );
+ set_transient( "{$this->get_general_hook_prefix()}label_rate_limit_hits", $hits, MINUTE_IN_SECONDS );
+
+ return $this->create_label( $shipment, $org_props );
+ }
+ }
+
+ return $result;
+ }
+ }
+
+ delete_transient( "{$this->get_general_hook_prefix()}label_rate_limit_hits" );
+
+ do_action( "{$this->get_general_hook_prefix()}created_label", $label, $this );
+ $label_id = $label->save();
+
+ return is_wp_error( $result ) && $result->is_soft_error() ? $result : $label_id;
+ }
+
+ return new ShipmentError( 'label-error', _x( 'Error while creating the label.', 'shipments', 'woocommerce-germanized' ) );
+ }
+
+ public function get_available_label_zones( $shipment_type = 'simple' ) {
+ return array(
+ 'dom',
+ 'eu',
+ 'int',
+ );
+ }
+
+ /**
+ * @param Packaging $packaging
+ *
+ * @return array
+ */
+ public function get_packaging_label_settings( $packaging ) {
+ $settings = array();
+
+ foreach ( $this->get_supported_label_config_set_shipment_types() as $shipment_type ) {
+ $settings[ $shipment_type ] = array();
+
+ foreach ( $this->get_available_label_zones( $shipment_type ) as $zone ) {
+ $config_set_args = array(
+ 'shipping_provider_name' => $this->get_name(),
+ 'shipment_type' => $shipment_type,
+ 'zone' => $zone,
+ 'setting_type' => 'packaging',
+ );
+
+ if ( $available_config_set = $packaging->get_configuration_set( $config_set_args ) ) {
+ $configuration_set = $available_config_set;
+ } else {
+ $configuration_set = new ConfigurationSet(
+ array(
+ 'shipping_provider_name' => $this->get_name(),
+ 'shipment_type' => $shipment_type,
+ 'zone' => $zone,
+ 'setting_type' => 'packaging',
+ )
+ );
+ }
+
+ $label_settings = $this->get_label_settings_by_zone( $configuration_set );
+
+ if ( ! empty( $label_settings ) ) {
+ $settings[ $shipment_type ][ $zone ] = array();
+
+ $settings[ $shipment_type ][ $zone ][] = array(
+ 'id' => $configuration_set->get_setting_id( 'override' ),
+ 'default' => '',
+ 'value' => $packaging->has_configuration_set( $config_set_args ) ? 'yes' : 'no',
+ 'type' => 'shipping_provider_packaging_zone_title',
+ 'provider' => $this->get_name(),
+ 'shipment_zone' => $zone,
+ 'shipment_type' => $shipment_type,
+ 'title' => wc_gzd_get_shipping_shipments_label_zone_title( $zone ),
+ );
+
+ $settings[ $shipment_type ][ $zone ] = array_merge( $settings[ $shipment_type ][ $zone ], $label_settings );
+
+ $settings[ $shipment_type ][ $zone ][] = array(
+ 'id' => $configuration_set->get_setting_id( 'override' ),
+ 'type' => 'shipping_provider_packaging_zone_title_close',
+ );
+ }
+ }
+
+ if ( empty( $settings[ $shipment_type ] ) ) {
+ unset( $settings[ $shipment_type ] );
+ }
+ }
+
+ return $settings;
+ }
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment
+ */
+ public function get_available_label_services( $shipment ) {
+ $services = array();
+
+ foreach ( $this->get_services( array( 'shipment' => $shipment ) ) as $service ) {
+ $services[] = $service->get_id();
+ }
+
+ return $services;
+ }
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment
+ */
+ public function get_available_label_products( $shipment ) {
+ return $this->get_products( array( 'shipment' => $shipment ) )->as_options();
+ }
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment
+ */
+ public function get_available_label_print_formats( $shipment ) {
+ $products = $this->get_available_label_products( $shipment );
+
+ return $this->get_print_formats(
+ array(
+ 'shipment' => $shipment,
+ 'products' => array_keys( $products ),
+ )
+ )->as_options();
+ }
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment
+ */
+ public function get_default_label_product( $shipment ) {
+ $product_id = '';
+ $available = $this->get_available_label_products( $shipment );
+
+ if ( $config_set = $shipment->get_label_configuration_set() ) {
+ $product_id = $config_set->get_product();
+ } else {
+ $config_set = $this->get_or_create_configuration_set( $shipment );
+ $product_id = $this->get_default_product_for_zone( $config_set );
+ }
+
+ if ( ! array_key_exists( $product_id, $available ) && ! empty( $available ) ) {
+ $product_id = array_keys( $available )[0];
+ }
+
+ return $product_id;
+ }
+
+ /**
+ * @param \Vendidero\Germanized\Shipments\Shipment $shipment
+ */
+ public function get_default_label_print_format( $shipment ) {
+ $product_id = $this->get_default_label_product( $shipment );
+
+ if ( $this->get_setting( "label_print_format_{$product_id}" ) ) {
+ return $this->get_setting( "label_print_format_{$product_id}" );
+ } elseif ( $this->get_label_print_format() ) {
+ return $this->get_label_print_format();
+ } else {
+ return $this->get_default_label_default_print_format();
+ }
+ }
+
+ public function get_shipping_method_settings() {
+ $method_settings = array();
+
+ foreach ( $this->get_supported_label_config_set_shipment_types() as $shipment_type ) {
+ foreach ( $this->get_available_label_zones( $shipment_type ) as $zone ) {
+ $configuration_set = new ConfigurationSet(
+ array(
+ 'shipping_provider_name' => $this->get_name(),
+ 'shipment_type' => $shipment_type,
+ 'zone' => $zone,
+ 'setting_type' => 'shipping_method',
+ )
+ );
+ $settings = $this->get_label_settings_by_zone( $configuration_set );
+
+ if ( ! empty( $settings ) ) {
+ if ( ! isset( $method_settings[ $zone ][ $shipment_type ] ) ) {
+ $method_settings[ $zone ][ $shipment_type ] = array();
+
+ $title_id = $configuration_set->get_setting_id( 'override' );
+
+ $method_settings[ $zone ][ $shipment_type ][ $title_id ] = array(
+ 'id' => $title_id,
+ 'default' => '',
+ 'type' => 'shipping_provider_method_zone_override_open',
+ 'sanitize_callback' => array( '\Vendidero\Germanized\Shipments\ShippingMethod\MethodHelper', 'validate_method_zone_override' ),
+ 'provider' => $this->get_name(),
+ 'shipment_zone' => $zone,
+ 'shipment_type' => $shipment_type,
+ 'title' => wc_gzd_get_shipping_shipments_label_zone_title( $zone ),
+ );
+ }
+
+ foreach ( $settings as $setting ) {
+ $setting = wp_parse_args(
+ $setting,
+ array(
+ 'default' => '',
+ 'type' => '',
+ 'id' => '',
+ 'custom_attributes' => array(),
+ 'shipment_setting_type' => '',
+ )
+ );
+
+ if ( ! empty( $setting['custom_attributes'] ) ) {
+ foreach ( $setting['custom_attributes'] as $attr => $val ) {
+ $new_attr = $attr;
+
+ if ( 'data-show_if_' === substr( $attr, 0, 13 ) ) {
+ $new_attr = str_replace( 'label_config_set_', '', $attr );
+
+ unset( $setting['custom_attributes'][ $attr ] );
+ }
+
+ $setting['custom_attributes'][ $new_attr ] = $val;
+ }
+ }
+
+ $setting_id = $configuration_set->get_setting_id( $setting['id'], $setting['shipment_setting_type'] );
+
+ if ( 'sectionend' === $setting['type'] ) {
+ $setting['type'] = 'title';
+ } elseif ( 'gzd_toggle' === $setting['type'] ) {
+ $setting['type'] = 'checkbox';
+ }
+
+ if ( 'checkbox' === $setting['type'] ) {
+ $setting['label'] = $setting['desc'];
+ }
+
+ if ( isset( $setting['desc'] ) && 'checkbox' !== $setting['type'] ) {
+ $setting['description'] = $setting['desc'];
+ }
+
+ $method_settings[ $zone ][ $shipment_type ][ $setting_id ] = $setting;
+ }
+
+ $close_id = "label_config_set_override_close_{$this->get_name()}_{$shipment_type}_{$zone}";
+
+ $method_settings[ $zone ][ $shipment_type ][ $close_id ] = array(
+ 'id' => $close_id,
+ 'default' => '',
+ 'display_only' => true,
+ 'provider' => $this->get_name(),
+ 'type' => 'shipping_provider_method_zone_override_close',
+ );
+ }
+ }
+ }
+
+ return $method_settings;
+ }
+
+ public function get_configuration_set_setting_type() {
+ return 'shipping_provider';
+ }
+
+ public function get_setting( $key, $default = null, $context = 'view' ) {
+ $setting_name_clean = $this->unprefix_setting_key( $key );
+
+ if ( $this->is_configuration_set_setting( $setting_name_clean ) ) {
+ if ( $configuration_set = $this->get_configuration_set( $setting_name_clean ) ) {
+ return $configuration_set->get_setting( $setting_name_clean, $default );
+ } else {
+ return $default;
+ }
+ } else {
+ return parent::get_setting( $key, $default, $context );
+ }
+ }
+
+ public function update_settings( $section = '', $data = null, $save = true ) {
+ if ( 'config_set_' === substr( $section, 0, 11 ) ) {
+ $section_parts = explode( '_', substr( $section, 11 ) );
+ $shipment_type = $section_parts[0];
+
+ $this->reset_configuration_sets(
+ array(
+ 'shipment_type' => $shipment_type,
+ )
+ );
+ }
+
+ parent::update_settings( $section, $data, $save );
+ }
+
+ public function update_setting( $setting, $value ) {
+ $setting_name_clean = $this->unprefix_setting_key( $setting );
+
+ if ( $this->is_configuration_set_setting( $setting_name_clean ) ) {
+ if ( $configuration_set = $this->get_or_create_configuration_set( $setting_name_clean ) ) {
+ $configuration_set->update_setting( $setting_name_clean, $value );
+ $this->update_configuration_set( $configuration_set );
+ }
+ } else {
+ parent::update_setting( $setting, $value );
+ }
+ }
+
+ public function get_supported_label_config_set_shipment_types() {
+ return $this->get_supported_shipment_types();
+ }
+}
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..2bee8b299
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/ShippingProvider/Helper.php
@@ -0,0 +1,243 @@
+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 );
+ }
+
+ public function is_shipping_provider_activated( $name ) {
+ /**
+ * Make sure that the plugin has initialised, e.g. during installs of shipping provider
+ */
+ if ( ! did_action( 'woocommerce_gzd_shipments_init' ) ) {
+ Package::init();
+ }
+
+ return WC_Data_Store::load( 'shipping-provider' )->is_activated( $name );
+ }
+
+ /**
+ * Loads all shipping providers which are hooked in.
+ *
+ * @return ShippingProvider[]
+ */
+ public function load_shipping_providers() {
+ if ( ! did_action( 'plugins_loaded' ) || doing_action( 'plugins_loaded' ) ) {
+ wc_doing_it_wrong( __FUNCTION__, _x( 'Loading shipping providers should only be triggered after the plugins_loaded action has fully been executed', 'shipments', 'woocommerce-germanized' ), '2.2.3' );
+ return array();
+ }
+
+ $this->shipping_providers = array();
+
+ $shipping_providers = WC_Data_Store::load( 'shipping-provider' )->get_shipping_providers();
+ $registered_providers = $this->get_shipping_provider_class_names();
+
+ foreach ( $registered_providers as $k => $provider ) {
+ if ( ! array_key_exists( $k, $shipping_providers ) ) {
+ $shipping_providers[ $k ] = $provider;
+ }
+ }
+
+ // 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();
+ }
+
+ if ( is_null( $this->shipping_providers ) ) {
+ return array();
+ }
+
+ return $this->shipping_providers;
+ }
+
+ /**
+ * Returns all available shipping providers for usage.
+ *
+ * @return Simple|Auto|ShippingProvider[]
+ */
+ public function get_available_shipping_providers() {
+ if ( is_null( $this->available_shipping_providers ) || is_null( $this->shipping_providers ) ) {
+ $this->available_shipping_providers = array();
+
+ foreach ( $this->get_shipping_providers() as $name => $shipping_provider ) {
+ if ( $shipping_provider->is_activated() ) {
+ $this->available_shipping_providers[ $name ] = $shipping_provider;
+ }
+ }
+ }
+
+ return $this->available_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/PrintFormat.php b/packages/woocommerce-germanized-shipments/src/ShippingProvider/PrintFormat.php
new file mode 100644
index 000000000..b681f9727
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/ShippingProvider/PrintFormat.php
@@ -0,0 +1,162 @@
+shipping_provider = $shipping_provider;
+ $this->shipping_provider_name = $shipping_provider->get_name();
+ } else {
+ $this->shipping_provider_name = $shipping_provider;
+ }
+
+ $args = wp_parse_args(
+ $args,
+ array(
+ 'id' => '',
+ 'name' => '',
+ 'label' => '',
+ 'description' => '',
+ 'products' => null,
+ 'shipment_types' => wc_gzd_get_shipment_types(),
+ )
+ );
+
+ if ( empty( $args['id'] ) ) {
+ $args['id'] = sanitize_key( $args['label'] );
+ }
+
+ if ( empty( $args['id'] ) ) {
+ throw new \Exception( _x( 'A print format needs an id.', 'shipments', 'woocommerce-germanized' ), 500 );
+ }
+
+ $this->id = $args['id'];
+ $this->label = $args['label'];
+ $this->description = $args['description'];
+ $this->products = is_null( $args['products'] ) ? null : array_filter( (array) $args['products'] );
+ $this->shipment_types = array_filter( (array) $args['shipment_types'] );
+ }
+
+ public function get_id() {
+ return $this->id;
+ }
+
+ public function get_label() {
+ return $this->label;
+ }
+
+ public function get_description() {
+ return $this->description;
+ }
+
+ public function get_products() {
+ return is_null( $this->products ) ? array() : $this->products;
+ }
+
+ public function get_shipment_types() {
+ return $this->shipment_types;
+ }
+
+ public function supports_product( $product ) {
+ return is_null( $this->products ) ? true : in_array( $product, $this->get_products(), true );
+ }
+
+ public function supports_shipment_type( $type ) {
+ return in_array( $type, $this->shipment_types, true );
+ }
+
+ /**
+ * @param Shipment $shipment
+ *
+ * @return boolean
+ */
+ public function supports_shipment( $shipment ) {
+ $supports_shipment = true;
+
+ if ( ! $this->supports_shipment_type( $shipment->get_type() ) ) {
+ $supports_shipment = false;
+ }
+
+ return $supports_shipment;
+ }
+
+ public function supports( $filter_args = array() ) {
+ $filter_args = wp_parse_args(
+ $filter_args,
+ array(
+ 'shipment' => false,
+ 'shipment_type' => '',
+ 'product' => '',
+ 'products' => array(),
+ 'product_id' => '',
+ )
+ );
+
+ if ( ! empty( $filter_args['product_id'] ) ) {
+ $filter_args['products'] = array_merge( $filter_args['products'], (array) $filter_args['product_id'] );
+ }
+
+ if ( ! empty( $filter_args['product'] ) && is_a( $filter_args['product'], '\Vendidero\Germanized\Shipments\ShippingProvider\Product' ) ) {
+ $filter_args['products'] = array_merge( $filter_args['products'], (array) $filter_args['product']->get_id() );
+ }
+
+ $include = true;
+
+ if ( $include && ! empty( $filter_args['shipment'] ) && ( $shipment = wc_gzd_get_shipment( $filter_args['shipment'] ) ) ) {
+ $include = $this->supports_shipment( $shipment );
+
+ $filter_args['shipment_type'] = '';
+ }
+
+ if ( $include && ! empty( $filter_args['shipment_type'] ) && ! $this->supports_shipment_type( $filter_args['shipment_type'] ) ) {
+ $include = false;
+ }
+
+ if ( $include && ! empty( $filter_args['products'] ) ) {
+ $supports_product = false;
+
+ foreach ( $filter_args['products'] as $product_id ) {
+ if ( $this->supports_product( $product_id ) ) {
+ $supports_product = true;
+ break;
+ }
+ }
+
+ if ( ! $supports_product ) {
+ $include = false;
+ }
+ }
+
+ return $include;
+ }
+
+ public function get_shipping_provider() {
+ if ( is_null( $this->shipping_provider ) ) {
+ $this->shipping_provider = wc_gzd_get_shipping_provider( $this->shipping_provider_name );
+ }
+
+ return $this->shipping_provider;
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/ShippingProvider/PrintFormatList.php b/packages/woocommerce-germanized-shipments/src/ShippingProvider/PrintFormatList.php
new file mode 100644
index 000000000..d616baa64
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/ShippingProvider/PrintFormatList.php
@@ -0,0 +1,195 @@
+add( $print_format );
+ }
+ }
+
+ /**
+ * @param PrintFormat $print_format
+ *
+ * @return void
+ */
+ public function add( $print_format ) {
+ $this->list[ $print_format->get_id() ] = $print_format;
+ }
+
+ /**
+ * @param $print_format_id
+ *
+ * @return bool
+ */
+ public function remove( $print_format_id ) {
+ if ( $print_format = $this->get( $print_format_id ) ) {
+ unset( $this->list[ $print_format->get_id() ] );
+
+ return true;
+ }
+
+ return false;
+ }
+
+ /**
+ * @param $print_format_id
+ *
+ * @return PrintFormat|false|PrintFormat[]
+ */
+ public function get( $print_format_id = null ) {
+ if ( $print_format_id ) {
+ if ( array_key_exists( $print_format_id, $this->list ) ) {
+ return $this->list[ $print_format_id ];
+ } else {
+ return false;
+ }
+ } else {
+ return $this->list;
+ }
+ }
+
+ /**
+ * @param integer $index
+ *
+ * @return false|PrintFormat
+ */
+ public function get_by_index( $index ) {
+ $data = array_values( $this->list );
+
+ if ( array_key_exists( $index, $data ) ) {
+ return $data[ $index ];
+ }
+
+ return false;
+ }
+
+ /**
+ * @param $filter_args
+ *
+ * @return PrintFormatList
+ */
+ public function filter( $filter_args = array() ) {
+ $print_formats = new PrintFormatList();
+
+ foreach ( $this->list as $print_format_id => $print_format ) {
+ $include_print_format = $print_format->supports( $filter_args );
+
+ if ( $include_print_format ) {
+ $print_formats->add( $print_format );
+ }
+ }
+
+ return $print_formats;
+ }
+
+ public function as_options() {
+ $options = array();
+
+ foreach ( $this->list as $print_format_id => $print_format ) {
+ $options[ $print_format_id ] = $print_format->get_label();
+ }
+
+ return $options;
+ }
+
+ #[\ReturnTypeWillChange]
+ public function count() {
+ return count( $this->list );
+ }
+
+ public function empty() {
+ return 0 === $this->count();
+ }
+
+ public function __isset( $name ) {
+ return array_key_exists( $name, $this->list );
+ }
+
+ /**
+ * @param $index
+ *
+ * @return void
+ */
+ #[\ReturnTypeWillChange]
+ public function offsetUnset( $index ) {
+ if ( $this->offsetExists( $index ) ) {
+ unset( $this->list[ $index ] );
+ }
+ }
+
+ /**
+ * @param $index
+ * @param PrintFormat $value
+ *
+ * @return void
+ */
+ #[\ReturnTypeWillChange]
+ public function offsetSet( $index, $value ) {
+ if ( $this->offsetExists( $index ) ) {
+ $this->remove( $index );
+ $this->add( $value );
+ }
+ }
+
+ #[\ReturnTypeWillChange]
+ public function offsetGet( $index ) {
+ if ( $this->offsetExists( $index ) ) {
+ return $this->list[ $index ];
+ }
+
+ return null;
+ }
+
+ #[\ReturnTypeWillChange]
+ public function offsetExists( $index ) {
+ if ( isset( $this->list[ $index ] ) ) {
+ return true;
+ }
+
+ return false;
+ }
+
+ public function __get( $name ) {
+ return $this->get( $name );
+ }
+
+ #[\ReturnTypeWillChange]
+ public function rewind() {
+ reset( $this->list );
+ }
+
+ #[\ReturnTypeWillChange]
+ public function current() {
+ return current( $this->list );
+ }
+
+ #[\ReturnTypeWillChange]
+ public function key() {
+ return key( $this->list );
+ }
+
+ #[\ReturnTypeWillChange]
+ public function next(): void {
+ next( $this->list );
+ }
+
+ #[\ReturnTypeWillChange]
+ public function valid(): bool {
+ return key( $this->list ) !== null;
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/ShippingProvider/Product.php b/packages/woocommerce-germanized-shipments/src/ShippingProvider/Product.php
new file mode 100644
index 000000000..2a2893c46
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/ShippingProvider/Product.php
@@ -0,0 +1,444 @@
+shipping_provider = $shipping_provider;
+ $this->shipping_provider_name = $shipping_provider->get_name();
+ } else {
+ $this->shipping_provider_name = $shipping_provider;
+ }
+
+ $args = wp_parse_args(
+ $args,
+ array(
+ 'id' => '',
+ 'internal_id' => 0,
+ 'parent_id' => 0,
+ 'label' => '',
+ 'description' => '',
+ 'shipment_types' => array( 'simple' ),
+ 'countries' => null,
+ 'zones' => array_keys( wc_gzd_get_shipping_label_zones() ),
+ 'price' => 0.0,
+ 'weight' => null,
+ 'length' => null,
+ 'width' => null,
+ 'height' => null,
+ 'dimension_unit' => get_option( 'woocommerce_dimension_unit' ),
+ 'weight_unit' => get_option( 'woocommerce_weight_unit' ),
+ 'meta' => array(),
+ )
+ );
+
+ if ( empty( $args['id'] ) ) {
+ $args['id'] = sanitize_key( $args['label'] );
+ }
+
+ if ( empty( $args['id'] ) ) {
+ throw new \Exception( _x( 'A product needs an id.', 'shipments', 'woocommerce-germanized' ), 500 );
+ }
+
+ $this->id = $args['id'];
+ $this->internal_id = ! empty( $args['internal_id'] ) ? $args['internal_id'] : $this->id;
+ $this->parent_id = $args['parent_id'];
+ $this->label = $args['label'];
+ $this->description = $args['description'];
+ $this->meta = (array) $args['meta'];
+ $this->shipment_types = array_filter( (array) $args['shipment_types'] );
+ $this->countries = is_null( $args['countries'] ) ? null : array_filter( (array) $args['countries'] );
+
+ if ( ! empty( $this->countries ) ) {
+ if ( 1 === count( $this->countries ) && Package::get_base_country() === $this->countries[0] ) {
+ $args['zones'] = array( 'dom' );
+ }
+
+ if ( in_array( 'ALL_EU', $this->countries, true ) ) {
+ $this->countries = array_diff( $this->countries, array( 'ALL_EU' ) );
+ $this->countries = array_unique( array_merge( WC()->countries->get_european_union_countries(), $this->countries ) );
+ }
+ }
+
+ $this->zones = array_filter( (array) $args['zones'] );
+ $this->price = (float) wc_format_decimal( $args['price'] );
+ $this->dimension_unit = $args['dimension_unit'];
+ $this->weight_unit = $args['weight_unit'];
+
+ $this->set_min_max_prop( 'weight', $args['weight'] );
+ $this->set_min_max_prop( 'length', $args['length'] );
+ $this->set_min_max_prop( 'width', $args['width'] );
+ $this->set_min_max_prop( 'height', $args['height'] );
+ }
+
+ private function set_min_max_prop( $prop, $default = null ) {
+ if ( ! is_null( $default ) ) {
+ $default = wp_parse_args(
+ (array) $default,
+ array(
+ 'min' => null,
+ 'max' => null,
+ )
+ );
+
+ if ( is_null( $default['min'] ) && is_null( $default['max'] ) ) {
+ $this->{$prop} = null;
+ } else {
+ $default['min'] = is_null( $default['min'] ) ? null : (float) wc_format_decimal( $default['min'] );
+ $default['max'] = is_null( $default['max'] ) ? null : (float) wc_format_decimal( $default['max'] );
+
+ $this->{$prop} = array(
+ 'min' => $default['min'],
+ 'max' => $default['max'],
+ );
+ }
+ }
+ }
+
+ public function get_id() {
+ return $this->id;
+ }
+
+ public function get_internal_id() {
+ return $this->internal_id;
+ }
+
+ public function get_parent_id() {
+ return $this->parent_id;
+ }
+
+ public function get_label() {
+ return $this->label;
+ }
+
+ public function get_description() {
+ return $this->description;
+ }
+
+ public function get_price() {
+ return $this->price;
+ }
+
+ public function get_dimension_unit() {
+ return $this->dimension_unit;
+ }
+
+ public function get_weight_unit() {
+ return $this->weight_unit;
+ }
+
+ public function supports_zone( $zone ) {
+ return in_array( $zone, $this->zones, true );
+ }
+
+ public function get_meta( $prop = null, $default = false ) {
+ if ( is_null( $prop ) ) {
+ return $this->meta;
+ } elseif ( array_key_exists( $prop, $this->meta ) ) {
+ return $this->meta[ $prop ];
+ } else {
+ return $default;
+ }
+ }
+
+ public function supports_country( $country, $postcode = '' ) {
+ $supports_country = true;
+
+ if ( is_array( $this->countries ) ) {
+ // Northern Ireland
+ if ( 'GB' === $country && 'BT' === strtoupper( substr( trim( $postcode ), 0, 2 ) ) ) {
+ $country = 'IX';
+ }
+
+ $supports_country = in_array( $country, $this->countries, true );
+ }
+
+ return $supports_country;
+ }
+
+ public function supports_shipment_type( $type ) {
+ return in_array( $type, $this->shipment_types, true );
+ }
+
+ protected function supports_min_max_dimension( $value, $dim = 'length', $unit = '' ) {
+ if ( is_null( $this->{$dim} ) || ( is_null( $this->{$dim}['min'] ) && is_null( $this->{$dim}['max'] ) ) ) {
+ return true;
+ }
+
+ $supports = true;
+ $value = (float) wc_format_decimal( $value );
+
+ if ( '' === $unit ) {
+ $unit = get_option( 'woocommerce_dimension_unit' );
+ }
+
+ $dim_in_local_unit = (float) wc_get_dimension( $value, $this->get_dimension_unit(), $unit );
+
+ if ( ! is_null( $this->{$dim}['min'] ) && $dim_in_local_unit < $this->{$dim}['min'] ) {
+ $supports = false;
+ }
+
+ if ( ! is_null( $this->{$dim}['max'] ) && $dim_in_local_unit > $this->{$dim}['max'] ) {
+ $supports = false;
+ }
+
+ return $supports;
+ }
+
+ public function supports_weight( $weight, $unit = '' ) {
+ if ( is_null( $this->weight ) || ( is_null( $this->weight['min'] ) && is_null( $this->weight['max'] ) ) ) {
+ return true;
+ }
+
+ $supports = true;
+ $weight = (float) wc_format_decimal( $weight );
+
+ if ( '' === $unit ) {
+ $unit = get_option( 'woocommerce_weight_unit' );
+ }
+
+ $weight_in_local_unit = (float) wc_get_weight( $weight, $this->get_weight_unit(), $unit );
+
+ if ( ! is_null( $this->weight['min'] ) && $weight_in_local_unit < $this->weight['min'] ) {
+ $supports = false;
+ }
+
+ if ( ! is_null( $this->weight['max'] ) && $weight_in_local_unit > $this->weight['max'] ) {
+ $supports = false;
+ }
+
+ return $supports;
+ }
+
+ public function supports_length( $length, $unit = '' ) {
+ return $this->supports_min_max_dimension( $length, 'length', $unit );
+ }
+
+ public function supports_width( $width, $unit = '' ) {
+ return $this->supports_min_max_dimension( $width, 'width', $unit );
+ }
+
+ public function supports_height( $height, $unit = '' ) {
+ return $this->supports_min_max_dimension( $height, 'height', $unit );
+ }
+
+ public function get_formatted_dimensions( $type = 'length' ) {
+ $formatted_dimension = '';
+
+ if ( ! is_null( $this->{$type} ) ) {
+ $min = $this->{$type}['min'];
+ $max = $this->{$type}['max'];
+ $unit = 'weight' === $type ? $this->get_weight_unit() : $this->get_dimension_unit();
+
+ if ( ! is_null( $min ) && 0.0 !== $min ) {
+ $formatted_dimension .= wc_format_localized_decimal( $min );
+ }
+
+ if ( ! is_null( $max ) ) {
+ $formatted_dimension .= ( empty( $formatted_dimension ) ? sprintf( _x( 'until %s', 'dhl', 'woocommerce-germanized' ), wc_format_localized_decimal( $max ) ) : '-' . wc_format_localized_decimal( $max ) );
+ }
+
+ if ( ! empty( $formatted_dimension ) ) {
+ $formatted_dimension .= ' ' . $unit;
+ }
+ }
+
+ return $formatted_dimension;
+ }
+
+ public function get_formatted_weight() {
+ return $this->get_formatted_dimensions( 'weight' );
+ }
+
+ public function supports( $filter_args = array() ) {
+ $filter_args = wp_parse_args(
+ $filter_args,
+ array(
+ 'country' => '',
+ 'zone' => '',
+ 'shipment' => false,
+ 'shipment_type' => '',
+ 'weight' => null,
+ 'weight_unit' => '',
+ 'length' => null,
+ 'width' => null,
+ 'height' => null,
+ 'dimension_unit' => '',
+ 'parent_id' => null,
+ )
+ );
+
+ $include_product = true;
+
+ if ( ! is_null( $filter_args['parent_id'] ) && (string) $this->get_parent_id() !== (string) $filter_args['parent_id'] ) {
+ $include_product = false;
+ }
+
+ if ( $include_product && ! empty( $filter_args['shipment'] ) && ( $shipment = wc_gzd_get_shipment( $filter_args['shipment'] ) ) ) {
+ $include_product = $this->supports_shipment( $shipment );
+
+ $filter_args['shipment_type'] = '';
+ $filter_args['zone'] = '';
+ $filter_args['country'] = '';
+ $filter_args['weight'] = null;
+ $filter_args['weight_unit'] = '';
+ $filter_args['length'] = null;
+ $filter_args['width'] = null;
+ $filter_args['height'] = null;
+ $filter_args['dimension_unit'] = '';
+ }
+
+ if ( $include_product && ! empty( $filter_args['country'] ) && ! $this->supports_country( $filter_args['country'] ) ) {
+ $include_product = false;
+ }
+
+ if ( $include_product && ! empty( $filter_args['zone'] ) && ! $this->supports_zone( $filter_args['zone'] ) ) {
+ $include_product = false;
+ }
+
+ if ( $include_product && ! empty( $filter_args['shipment_type'] ) && ! $this->supports_shipment_type( $filter_args['shipment_type'] ) ) {
+ $include_product = false;
+ }
+
+ if ( $include_product && ! is_null( $filter_args['weight'] ) && ! $this->supports_weight( $filter_args['weight'], $filter_args['weight_unit'] ) ) {
+ $include_product = false;
+ }
+
+ $dimensions = $this->get_real_dimensions( ( ! is_null( $filter_args['length'] ) ? $filter_args['length'] : 0 ), ( ! is_null( $filter_args['width'] ) ? $filter_args['width'] : 0 ), ( ! is_null( $filter_args['height'] ) ? $filter_args['height'] : 0 ) );
+
+ if ( $include_product && ! is_null( $filter_args['length'] ) && ! $this->supports_length( $dimensions['length'], $filter_args['dimension_unit'] ) ) {
+ $include_product = false;
+ }
+
+ if ( $include_product && ! is_null( $filter_args['width'] ) && ! $this->supports_length( $dimensions['width'], $filter_args['dimension_unit'] ) ) {
+ $include_product = false;
+ }
+
+ if ( $include_product && ! is_null( $filter_args['height'] ) && ! $this->supports_length( $dimensions['height'], $filter_args['dimension_unit'] ) ) {
+ $include_product = false;
+ }
+
+ return $include_product;
+ }
+
+ /**
+ * This helper makes sure that we do always use/compare
+ * the longest side as length.
+ *
+ * @param $length
+ * @param $width
+ * @param $height
+ *
+ * @return float[]
+ */
+ private function get_real_dimensions( $length, $width, $height ) {
+ $length = (float) wc_format_decimal( $length );
+ $width = (float) wc_format_decimal( $width );
+ $height = (float) wc_format_decimal( $height );
+
+ if ( $width > $length ) {
+ $tmp_length = $length;
+
+ $length = $width;
+ $width = $tmp_length;
+ }
+
+ return array(
+ 'length' => $length,
+ 'width' => $width,
+ 'height' => $height,
+ );
+ }
+
+ /**
+ * @param Shipment $shipment
+ *
+ * @return boolean
+ */
+ public function supports_shipment( $shipment ) {
+ $supports_shipment = true;
+
+ if ( ! $this->supports_shipment_type( $shipment->get_type() ) ) {
+ $supports_shipment = false;
+ }
+
+ if ( $supports_shipment && ! $this->supports_zone( $shipment->get_shipping_zone() ) ) {
+ $supports_shipment = false;
+ }
+
+ if ( $supports_shipment && ! $this->supports_country( $shipment->get_country() ) ) {
+ $supports_shipment = false;
+ }
+
+ if ( $supports_shipment && ! $this->supports_weight( $shipment->get_weight(), $shipment->get_weight_unit() ) ) {
+ $supports_shipment = false;
+ }
+
+ $dimensions = $this->get_real_dimensions( $shipment->get_length(), $shipment->get_width(), $shipment->get_height() );
+
+ if ( $supports_shipment && ! $this->supports_length( $dimensions['length'], $shipment->get_dimension_unit() ) ) {
+ $supports_shipment = false;
+ }
+
+ if ( $supports_shipment && ! $this->supports_width( $dimensions['width'], $shipment->get_dimension_unit() ) ) {
+ $supports_shipment = false;
+ }
+
+ if ( $supports_shipment && ! $this->supports_height( $dimensions['height'], $shipment->get_dimension_unit() ) ) {
+ $supports_shipment = false;
+ }
+
+ return $supports_shipment;
+ }
+
+ public function get_shipping_provider() {
+ if ( is_null( $this->shipping_provider ) ) {
+ $this->shipping_provider = wc_gzd_get_shipping_provider( $this->shipping_provider_name );
+ }
+
+ return $this->shipping_provider;
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/ShippingProvider/ProductList.php b/packages/woocommerce-germanized-shipments/src/ShippingProvider/ProductList.php
new file mode 100644
index 000000000..d4be2fd77
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/ShippingProvider/ProductList.php
@@ -0,0 +1,210 @@
+add( $product );
+ }
+ }
+
+ /**
+ * @param Product $product
+ *
+ * @return void
+ */
+ public function add( $product ) {
+ $this->list[ $product->get_id() ] = $product;
+ $this->internal_id_map[ $product->get_internal_id() ] = $product->get_id();
+ }
+
+ /**
+ * @param $product_id
+ *
+ * @return bool
+ */
+ public function remove( $product_id ) {
+ if ( $product = $this->get( $product_id ) ) {
+ unset( $this->internal_id_map[ $product->get_internal_id() ] );
+ unset( $this->list[ $product->get_id() ] );
+
+ return true;
+ }
+
+ return false;
+ }
+
+ /**
+ * @param $product_id
+ *
+ * @return Product|false|Product[]
+ */
+ public function get( $product_id = null ) {
+ if ( $product_id ) {
+ if ( array_key_exists( $product_id, $this->list ) ) {
+ return $this->list[ $product_id ];
+ } else {
+ return false;
+ }
+ } else {
+ return $this->list;
+ }
+ }
+
+ /**
+ * @param $internal_id
+ *
+ * @return false|Product
+ */
+ public function get_by_internal_id( $internal_id ) {
+ if ( array_key_exists( $internal_id, $this->internal_id_map ) ) {
+ return $this->get( $this->internal_id_map[ $internal_id ] );
+ } else {
+ return false;
+ }
+ }
+
+ /**
+ * @param integer $index
+ *
+ * @return false|Product
+ */
+ public function get_by_index( $index ) {
+ $data = array_values( $this->list );
+
+ if ( array_key_exists( $index, $data ) ) {
+ return $data[ $index ];
+ }
+
+ return false;
+ }
+
+ /**
+ * @param $filter_args
+ *
+ * @return ProductList
+ */
+ public function filter( $filter_args = array() ) {
+ $products = new ProductList();
+
+ foreach ( $this->list as $product_id => $product ) {
+ $include_product = $product->supports( $filter_args );
+
+ if ( $include_product ) {
+ $products->add( $product );
+ }
+ }
+
+ return $products;
+ }
+
+ public function as_options() {
+ $options = array();
+
+ foreach ( $this->list as $product_id => $product ) {
+ $options[ $product_id ] = $product->get_label();
+ }
+
+ return $options;
+ }
+
+ #[\ReturnTypeWillChange]
+ public function count(): int {
+ return count( $this->list );
+ }
+
+ public function empty() {
+ return 0 === $this->count();
+ }
+
+ public function __isset( $name ) {
+ return array_key_exists( $name, $this->list );
+ }
+
+ /**
+ * @param $index
+ *
+ * @return void
+ */
+ #[\ReturnTypeWillChange]
+ public function offsetUnset( $index ) {
+ if ( $this->offsetExists( $index ) ) {
+ unset( $this->list[ $index ] );
+ }
+ }
+
+ /**
+ * @param $index
+ * @param Product $value
+ *
+ * @return void
+ */
+ #[\ReturnTypeWillChange]
+ public function offsetSet( $index, $value ) {
+ if ( $this->offsetExists( $index ) ) {
+ $this->remove( $index );
+ $this->add( $value );
+ }
+ }
+
+ #[\ReturnTypeWillChange]
+ public function offsetGet( $index ) {
+ if ( $this->offsetExists( $index ) ) {
+ return $this->list[ $index ];
+ }
+
+ return null;
+ }
+
+ #[\ReturnTypeWillChange]
+ public function offsetExists( $index ) {
+ if ( isset( $this->list[ $index ] ) ) {
+ return true;
+ }
+
+ return false;
+ }
+
+ public function __get( $name ) {
+ return $this->get( $name );
+ }
+
+ #[\ReturnTypeWillChange]
+ public function rewind() {
+ reset( $this->list );
+ }
+
+ #[\ReturnTypeWillChange]
+ public function current() {
+ return current( $this->list );
+ }
+
+ #[\ReturnTypeWillChange]
+ public function key() {
+ return key( $this->list );
+ }
+
+ #[\ReturnTypeWillChange]
+ public function next(): void {
+ next( $this->list );
+ }
+
+ #[\ReturnTypeWillChange]
+ public function valid(): bool {
+ return key( $this->list ) !== null;
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/ShippingProvider/Service.php b/packages/woocommerce-germanized-shipments/src/ShippingProvider/Service.php
new file mode 100644
index 000000000..51d508881
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/ShippingProvider/Service.php
@@ -0,0 +1,490 @@
+shipping_provider = $shipping_provider;
+ $this->shipping_provider_name = $shipping_provider->get_name();
+ } else {
+ $this->shipping_provider_name = $shipping_provider;
+ }
+
+ $args = wp_parse_args(
+ $args,
+ array(
+ 'id' => '',
+ 'internal_id' => '',
+ 'label' => '',
+ 'description' => '',
+ 'long_description' => '',
+ 'option_type' => 'checkbox',
+ 'default_value' => 'no',
+ 'excluded_locations' => array(),
+ 'options' => array(),
+ 'products' => null,
+ 'shipment_types' => array( 'simple' ),
+ 'countries' => null,
+ 'zones' => array_keys( wc_gzd_get_shipping_label_zones() ),
+ )
+ );
+
+ if ( empty( $args['id'] ) ) {
+ $args['id'] = sanitize_key( $args['label'] );
+ }
+
+ if ( empty( $args['id'] ) ) {
+ throw new \Exception( _x( 'A service needs an id.', 'shipments', 'woocommerce-germanized' ), 500 );
+ }
+
+ $this->id = $args['id'];
+ $this->internal_id = empty( $args['internal_id'] ) ? $this->id : $args['internal_id'];
+ $this->label = $args['label'];
+ $this->description = $args['description'];
+ $this->long_description = $args['long_description'];
+ $this->option_type = $args['option_type'];
+ $this->default_value = $args['default_value'];
+ $this->options = array_filter( (array) $args['options'] );
+ $this->locations = array_diff( wc_gzd_get_shipping_provider_service_locations(), array_filter( (array) $args['excluded_locations'] ) );
+ $this->products = is_null( $args['products'] ) ? null : array_filter( (array) $args['products'] );
+ $this->shipment_types = array_filter( (array) $args['shipment_types'] );
+ $this->countries = is_null( $args['countries'] ) ? null : array_filter( (array) $args['countries'] );
+
+ if ( ! empty( $this->countries ) ) {
+ if ( 1 === count( $this->countries ) && Package::get_base_country() === $this->countries[0] ) {
+ $args['zones'] = array( 'dom' );
+ }
+
+ if ( in_array( 'ALL_EU', $this->countries, true ) ) {
+ $this->countries = array_diff( $this->countries, array( 'ALL_EU' ) );
+ $this->countries = array_unique( array_merge( WC()->countries->get_european_union_countries(), $this->countries ) );
+ }
+ }
+
+ $this->zones = array_filter( (array) $args['zones'] );
+ }
+
+ public function get_id() {
+ return $this->id;
+ }
+
+ public function get_internal_id() {
+ return $this->internal_id;
+ }
+
+ public function get_label() {
+ return $this->label;
+ }
+
+ public function get_description() {
+ return $this->description;
+ }
+
+ public function get_option_type() {
+ return $this->option_type;
+ }
+
+ public function get_long_description() {
+ return $this->long_description;
+ }
+
+ public function get_products() {
+ return is_null( $this->products ) ? array() : $this->products;
+ }
+
+ public function get_locations() {
+ return $this->locations;
+ }
+
+ public function get_setting_id( $args = array(), $service_meta = '' ) {
+ if ( is_a( $args, 'Vendidero\Germanized\Shipments\Shipment' ) ) {
+ $args = array(
+ 'zone' => $args->get_shipping_zone(),
+ 'shipment_type' => $args->get_type(),
+ );
+ } elseif ( is_a( $args, 'Vendidero\Germanized\Shipments\Labels\ConfigurationSet' ) ) {
+ $setting_id = $this->get_id() . ( empty( $service_meta ) ? '' : '-m-' . $service_meta );
+ $group = empty( $service_meta ) ? 'service' : 'service_meta';
+
+ return $args->get_setting_id( $setting_id, $group );
+ }
+
+ $args = wp_parse_args(
+ $args,
+ array(
+ 'zone' => 'dom',
+ 'shipment_type' => 'simple',
+ 'shipment' => false,
+ )
+ );
+
+ if ( is_a( $args['shipment'], 'Vendidero\Germanized\Shipments\Shipment' ) ) {
+ $args['zone'] = $args['shipment']->get_shipping_zone();
+ $args['shipment_type'] = $args['shipment']->get_type();
+ }
+
+ $suffix = $this->get_id();
+ $prefix = $args['shipment_type'] . '_' . $args['zone'];
+
+ if ( ! empty( $service_meta ) ) {
+ $suffix = $suffix . '_' . $service_meta;
+ }
+
+ return $prefix . "_label_service_{$suffix}";
+ }
+
+ public function get_label_field_id( $suffix = '' ) {
+ $setting_base_id = $this->get_id();
+
+ if ( ! empty( $suffix ) ) {
+ $setting_base_id .= "_{$suffix}";
+ }
+
+ return "service_{$setting_base_id}";
+ }
+
+ public function get_default_value( $suffix = '' ) {
+ return $this->default_value;
+ }
+
+ public function supports_location( $location ) {
+ return in_array( $location, $this->get_locations(), true );
+ }
+
+ public function supports_product( $product ) {
+ return is_null( $this->products ) ? true : in_array( $product, $this->get_products(), true );
+ }
+
+ public function supports_zone( $zone ) {
+ return in_array( $zone, $this->zones, true );
+ }
+
+ public function get_zones() {
+ return $this->zones;
+ }
+
+ public function supports_country( $country, $postcode = '' ) {
+ $supports_country = true;
+
+ if ( is_array( $this->countries ) ) {
+ // Northern Ireland
+ if ( 'GB' === $country && 'BT' === strtoupper( substr( trim( $postcode ), 0, 2 ) ) ) {
+ $country = 'IX';
+ }
+
+ $supports_country = in_array( $country, $this->countries, true );
+ }
+
+ return $supports_country;
+ }
+
+ public function supports_shipment_type( $type ) {
+ return in_array( $type, $this->shipment_types, true );
+ }
+
+ public function supports( $filter_args = array() ) {
+ $filter_args = wp_parse_args(
+ $filter_args,
+ array(
+ 'country' => '',
+ 'zone' => '',
+ 'location' => '',
+ 'product' => '',
+ 'product_id' => '',
+ 'shipment' => false,
+ 'shipment_type' => '',
+ )
+ );
+
+ if ( ! empty( $filter_args['product_id'] ) ) {
+ $filter_args['product'] = $filter_args['product_id'];
+ }
+
+ if ( ! empty( $filter_args['product'] ) && is_a( $filter_args['product'], '\Vendidero\Germanized\Shipments\ShippingProvider\Product' ) ) {
+ $filter_args['product'] = $filter_args['product']->get_id();
+ }
+
+ $include_service = true;
+
+ if ( ! empty( $filter_args['shipment'] ) && ( $shipment = wc_gzd_get_shipment( $filter_args['shipment'] ) ) ) {
+ $include_service = $this->supports_shipment( $shipment );
+
+ $filter_args['shipment_type'] = '';
+ $filter_args['zone'] = '';
+ $filter_args['country'] = '';
+ }
+
+ if ( $include_service && ! empty( $filter_args['product'] ) && ! $this->supports_product( $filter_args['product'] ) ) {
+ $include_service = false;
+ }
+
+ if ( $include_service && ! empty( $filter_args['location'] ) && ! $this->supports_location( $filter_args['location'] ) ) {
+ $include_service = false;
+ }
+
+ if ( $include_service && ! empty( $filter_args['country'] ) && ! $this->supports_country( $filter_args['country'] ) ) {
+ $include_service = false;
+ }
+
+ if ( $include_service && ! empty( $filter_args['zone'] ) && ! $this->supports_zone( $filter_args['zone'] ) ) {
+ $include_service = false;
+ }
+
+ if ( $include_service && ! empty( $filter_args['shipment_type'] ) && ! $this->supports_shipment_type( $filter_args['shipment_type'] ) ) {
+ $include_service = false;
+ }
+
+ return $include_service;
+ }
+
+ /**
+ * @param Shipment $shipment
+ *
+ * @return boolean
+ */
+ public function supports_shipment( $shipment ) {
+ $supports_shipment = true;
+
+ if ( ! $this->supports_shipment_type( $shipment->get_type() ) ) {
+ $supports_shipment = false;
+ }
+
+ if ( $supports_shipment && ! $this->supports_zone( $shipment->get_shipping_zone() ) ) {
+ $supports_shipment = false;
+ }
+
+ if ( $supports_shipment && ! $this->supports_country( $shipment->get_country() ) ) {
+ $supports_shipment = false;
+ }
+
+ return $supports_shipment;
+ }
+
+ public function get_options() {
+ return $this->options;
+ }
+
+ public function get_shipping_provider() {
+ if ( is_null( $this->shipping_provider ) ) {
+ $this->shipping_provider = wc_gzd_get_shipping_provider( $this->shipping_provider_name );
+ }
+
+ return $this->shipping_provider;
+ }
+
+ /**
+ * @param ConfigurationSet $configuration_set
+ *
+ * @return array
+ */
+ public function get_setting_fields( $configuration_set ) {
+ if ( ! $this->supports_location( $configuration_set->get_setting_type() . '_settings' ) || ! $this->supports_location( 'settings' ) ) {
+ return array();
+ }
+
+ $setting_id = $this->get_setting_id( $configuration_set );
+ $value = $this->get_value( $configuration_set );
+ $option_type = $this->get_option_type();
+
+ if ( 'checkbox' === $this->get_option_type() ) {
+ if ( is_string( $value ) ) {
+ $value = wc_bool_to_string( $value );
+ }
+
+ $option_type = 'gzd_toggle';
+ }
+
+ return array_merge(
+ array(
+ array(
+ 'title' => $this->get_label(),
+ 'desc' => $this->get_description() . ( ! empty( $this->get_long_description() ) ? ' ' . $this->get_long_description() : '' ),
+ 'id' => $setting_id,
+ 'value' => $value,
+ 'default' => $this->get_default_value(),
+ 'options' => $this->options,
+ 'type' => $option_type,
+ ),
+ ),
+ $this->get_additional_setting_fields( $configuration_set )
+ );
+ }
+
+ /**
+ * @param ConfigurationSet $configuration_set
+ *
+ * @return array
+ */
+ protected function get_additional_setting_fields( $configuration_set ) {
+ return array();
+ }
+
+ /**
+ * @param $props
+ * @param Shipment $shipment
+ *
+ * @return true|\WP_Error
+ */
+ public function validate_label_request( $props, $shipment ) {
+ $error = new ShipmentError();
+
+ foreach ( $this->get_additional_label_fields( $shipment ) as $field ) {
+ $field = wp_parse_args(
+ $field,
+ array(
+ 'label' => '',
+ 'id' => '',
+ 'type' => '',
+ 'is_required' => false,
+ 'data_type' => '',
+ )
+ );
+
+ if ( true === $field['is_required'] ) {
+ $value = isset( $props[ $field['id'] ] ) ? $props[ $field['id'] ] : null;
+
+ if ( in_array( $field['data_type'], array( 'price', 'decimal' ), true ) ) {
+ $value = (float) wc_format_decimal( $value );
+ }
+
+ if ( empty( $value ) ) {
+ $error->add( 500, sprintf( _x( 'Please choose a valid value for the service %1$s: %2$s.', 'shipments', 'woocommerce-germanized' ), $this->get_label(), $field['label'] ) );
+ }
+ }
+ }
+
+ if ( wc_gzd_shipment_wp_error_has_errors( $error ) ) {
+ return $error;
+ }
+
+ return true;
+ }
+
+ protected function get_show_if_attributes() {
+ if ( ! empty( $this->get_products() ) ) {
+ return array(
+ 'data-products-supported' => implode( ',', $this->get_products() ),
+ );
+ } else {
+ return array();
+ }
+ }
+
+ /**
+ * @param Shipment|ConfigurationSet $shipment
+ * @param $suffix
+ *
+ * @return mixed
+ */
+ public function get_value( $shipment, $suffix = '' ) {
+ if ( is_a( $shipment, 'Vendidero\Germanized\Shipments\Labels\ConfigurationSet' ) ) {
+ $config_set = $shipment;
+ } else {
+ $config_set = $shipment->get_label_configuration_set();
+ }
+
+ $value = $this->get_default_value( $suffix );
+
+ if ( $config_set ) {
+ if ( empty( $suffix ) ) {
+ $value = $config_set->get_service_value( $this->get_id(), $value );
+ } else {
+ $value = $config_set->get_service_meta( $this->get_id(), $suffix, $value );
+ }
+ }
+
+ if ( 'no' === $value && is_a( $shipment, '\Vendidero\Germanized\Shipments\Shipment' ) && true === $this->book_as_default( $shipment ) ) {
+ $value = 'yes';
+ }
+
+ return $value;
+ }
+
+ /**
+ * @param Shipment $shipment
+ *
+ * @return boolean
+ */
+ public function book_as_default( $shipment ) {
+ $book_as_default = false;
+ $config_set = $shipment->get_label_configuration_set();
+
+ if ( $config_set && $config_set->has_service( $this->get_id() ) ) {
+ $book_as_default = true;
+ }
+
+ return $book_as_default;
+ }
+
+ public function get_label_fields( $shipment, $location = '' ) {
+ if ( ( ! empty( $location ) && ! $this->supports_location( 'label_' . $location ) ) || ! $this->supports_location( 'labels' ) ) {
+ return array();
+ }
+
+ $option_type = $this->get_option_type();
+
+ return array_merge(
+ array(
+ array(
+ 'label' => $this->get_label(),
+ 'description' => $this->get_description(),
+ 'desc_tip' => true,
+ 'wrapper_class' => 'form-field-' . $option_type,
+ 'id' => $this->get_label_field_id(),
+ 'value' => $this->get_value( $shipment ),
+ 'options' => $this->options,
+ 'type' => $option_type,
+ 'custom_attributes' => $this->get_show_if_attributes(),
+ ),
+ ),
+ $this->get_additional_label_fields( $shipment )
+ );
+ }
+
+ protected function get_additional_label_fields( $shipment ) {
+ return array();
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/ShippingProvider/ServiceList.php b/packages/woocommerce-germanized-shipments/src/ShippingProvider/ServiceList.php
new file mode 100644
index 000000000..e967aa4e3
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/ShippingProvider/ServiceList.php
@@ -0,0 +1,210 @@
+add( $service );
+ }
+ }
+
+ /**
+ * @param Service $service
+ *
+ * @return void
+ */
+ public function add( $service ) {
+ $this->list[ $service->get_id() ] = $service;
+ $this->internal_id_map[ $service->get_internal_id() ] = $service->get_id();
+ }
+
+ /**
+ * @param $service_id
+ *
+ * @return bool
+ */
+ public function remove( $service_id ) {
+ if ( $service = $this->get( $service_id ) ) {
+ unset( $this->internal_id_map[ $service->get_internal_id() ] );
+ unset( $this->list[ $service->get_id() ] );
+
+ return true;
+ }
+
+ return false;
+ }
+
+ /**
+ * @param $service_id
+ *
+ * @return Service|false|Service[]
+ */
+ public function get( $service_id = null ) {
+ if ( $service_id ) {
+ if ( array_key_exists( $service_id, $this->list ) ) {
+ return $this->list[ $service_id ];
+ } else {
+ return false;
+ }
+ } else {
+ return $this->list;
+ }
+ }
+
+ /**
+ * @param $internal_id
+ *
+ * @return false|Service
+ */
+ public function get_by_internal_id( $internal_id ) {
+ if ( array_key_exists( $internal_id, $this->internal_id_map ) ) {
+ return $this->get( $this->internal_id_map[ $internal_id ] );
+ } else {
+ return false;
+ }
+ }
+
+ /**
+ * @param integer $index
+ *
+ * @return false|Service
+ */
+ public function get_by_index( $index ) {
+ $data = array_values( $this->list );
+
+ if ( array_key_exists( $index, $data ) ) {
+ return $data[ $index ];
+ }
+
+ return false;
+ }
+
+ /**
+ * @param $filter_args
+ *
+ * @return ServiceList
+ */
+ public function filter( $filter_args = array() ) {
+ $services = new ServiceList();
+
+ foreach ( $this->list as $service_id => $service ) {
+ $include_service = $service->supports( $filter_args );
+
+ if ( $include_service ) {
+ $services->add( $service );
+ }
+ }
+
+ return $services;
+ }
+
+ public function as_options() {
+ $options = array();
+
+ foreach ( $this->list as $service_id => $service ) {
+ $options[ $service_id ] = $service->get_label();
+ }
+
+ return $options;
+ }
+
+ #[\ReturnTypeWillChange]
+ public function count() {
+ return count( $this->list );
+ }
+
+ public function empty() {
+ return 0 === $this->count();
+ }
+
+ public function __isset( $name ) {
+ return array_key_exists( $name, $this->list );
+ }
+
+ /**
+ * @param $index
+ *
+ * @return void
+ */
+ #[\ReturnTypeWillChange]
+ public function offsetUnset( $index ) {
+ if ( $this->offsetExists( $index ) ) {
+ unset( $this->list[ $index ] );
+ }
+ }
+
+ /**
+ * @param $index
+ * @param Service $value
+ *
+ * @return void
+ */
+ #[\ReturnTypeWillChange]
+ public function offsetSet( $index, $value ) {
+ if ( $this->offsetExists( $index ) ) {
+ $this->remove( $index );
+ $this->add( $value );
+ }
+ }
+
+ #[\ReturnTypeWillChange]
+ public function offsetGet( $index ) {
+ if ( $this->offsetExists( $index ) ) {
+ return $this->list[ $index ];
+ }
+
+ return null;
+ }
+
+ #[\ReturnTypeWillChange]
+ public function offsetExists( $index ) {
+ if ( isset( $this->list[ $index ] ) ) {
+ return true;
+ }
+
+ return false;
+ }
+
+ public function __get( $name ) {
+ return $this->get( $name );
+ }
+
+ #[\ReturnTypeWillChange]
+ public function rewind() {
+ reset( $this->list );
+ }
+
+ #[\ReturnTypeWillChange]
+ public function current() {
+ return current( $this->list );
+ }
+
+ #[\ReturnTypeWillChange]
+ public function key() {
+ return key( $this->list );
+ }
+
+ #[\ReturnTypeWillChange]
+ public function next(): void {
+ next( $this->list );
+ }
+
+ #[\ReturnTypeWillChange]
+ public function valid(): bool {
+ return key( $this->list ) !== null;
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/ShippingProvider/Simple.php b/packages/woocommerce-germanized-shipments/src/ShippingProvider/Simple.php
new file mode 100644
index 000000000..45a9016c1
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/ShippingProvider/Simple.php
@@ -0,0 +1,1347 @@
+ true,
+ 'title' => '',
+ 'name' => '',
+ 'description' => '',
+ 'order' => 0,
+ 'supports_customer_returns' => false,
+ 'supports_guest_returns' => false,
+ 'return_manual_confirmation' => true,
+ 'return_instructions' => '',
+ 'tracking_url_placeholder' => '',
+ 'tracking_desc_placeholder' => '',
+ );
+
+ protected $address_data = array(
+ 'shipper' => null,
+ 'return' => null,
+ );
+
+ /**
+ * 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 '';
+ }
+
+ public function is_pro() {
+ return false;
+ }
+
+ /**
+ * 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 esc_url_raw( $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 the provider order.
+ *
+ * @param string $context
+ *
+ * @return int
+ */
+ public function get_order( $context = 'view' ) {
+ return $this->get_prop( 'order', $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;
+ }
+
+ protected function get_address_props( $address_type = 'shipper' ) {
+ if ( is_null( $this->address_data[ $address_type ] ) ) {
+ $this->address_data[ $address_type ] = wc_gzd_get_shipment_setting_address_fields( $address_type );
+ }
+
+ return $this->address_data[ $address_type ];
+ }
+
+ public function get_shipper_address_data() {
+ return $this->get_address_props( 'shipper' );
+ }
+
+ public function get_address_prop( $prop, $type = 'shipper' ) {
+ $address_fields = $this->get_address_props( $type );
+
+ return array_key_exists( $prop, $address_fields ) ? $address_fields[ $prop ] : '';
+ }
+
+ 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_formatted_full_name();
+ }
+
+ public function get_shipper_formatted_full_name() {
+ return $this->get_address_prop( 'full_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_1() {
+ return $this->get_shipper_address();
+ }
+
+ public function get_shipper_address_2() {
+ return $this->get_address_prop( 'address_2' );
+ }
+
+ public function get_shipper_street() {
+ return $this->get_address_prop( 'street' );
+ }
+
+ public function get_shipper_street_number() {
+ return $this->get_address_prop( 'street_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_customs_reference_number() {
+ return $this->get_address_prop( 'customs_reference_number' );
+ }
+
+ public function get_shipper_customs_uk_vat_id() {
+ return $this->get_address_prop( 'customs_uk_vat_id' );
+ }
+
+ public function get_shipper_country() {
+ $country_data = wc_format_country_state_string( $this->get_address_prop( 'country' ) );
+
+ return $country_data['country'];
+ }
+
+ public function get_shipper_state() {
+ $country_data = wc_format_country_state_string( $this->get_address_prop( 'country' ) );
+
+ return $country_data['state'];
+ }
+
+ public function get_return_address_data() {
+ return $this->get_address_props( 'return' );
+ }
+
+ 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_formatted_full_name();
+ }
+
+ public function get_return_formatted_full_name() {
+ return $this->get_address_prop( 'full_name', 'return' );
+ }
+
+ 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() {
+ return $this->get_address_prop( 'street', 'return' );
+ }
+
+ public function get_return_street_number() {
+ return $this->get_address_prop( 'street_number', 'return' );
+ }
+
+ 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() {
+ $country_data = wc_format_country_state_string( $this->get_address_prop( 'country', 'return' ) );
+
+ return $country_data['country'];
+ }
+
+ public function get_return_state() {
+ $country_data = wc_format_country_state_string( $this->get_address_prop( 'country', 'return' ) );
+
+ return $country_data['state'];
+ }
+
+ 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 ) );
+ }
+
+ protected function setting_supports_default_update( $setting ) {
+ $type = isset( $setting['type'] ) ? $setting['type'] : 'title';
+
+ if ( in_array( $type, array( 'title', 'sectionend', 'html' ), true ) || ! isset( $setting['id'] ) || empty( $setting['id'] ) ) {
+ return false;
+ }
+
+ return true;
+ }
+
+ public function update_settings_with_defaults() {
+ foreach ( $this->get_all_settings() as $section => $settings ) {
+ foreach ( $settings as $setting ) {
+ $default = isset( $setting['default'] ) ? $setting['default'] : null;
+
+ if ( ! $this->setting_supports_default_update( $setting ) ) {
+ 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 order of the current shipping provider.
+ *
+ * @param int $order
+ */
+ public function set_order( $order ) {
+ $this->set_prop( 'order', absint( $order ) );
+ }
+
+ /**
+ * 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, $plain = false ) {
+ $tracking_desc = '';
+ $tracking_id = $shipment->get_tracking_id();
+
+ if ( '' !== $this->get_tracking_desc_placeholder() && ! empty( $tracking_id ) ) {
+ $placeholders = $this->get_tracking_placeholders( $shipment );
+
+ if ( ! $plain && apply_filters( "{$this->get_general_hook_prefix()}tracking_id_with_link", true, $shipment ) && $shipment->has_tracking() ) {
+ $placeholders['{tracking_id}'] = '' . $shipment->get_tracking_id() . '';
+ }
+
+ $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 );
+ }
+
+ /**
+ * @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' => $this->get_default_tracking_desc_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 ( $config_set = $shipment->get_label_configuration_set() ) {
+ if ( $config_set->has_setting( $key ) ) {
+ $value = $config_set->get_setting( $key, $default );
+ }
+ }
+
+ 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 );
+
+ if ( '' === $value && 'view' === $context && ! is_null( $default ) ) {
+ $value = $default;
+ }
+ } elseif ( $this->meta_exists( $clean_key ) ) {
+ $value = $this->get_meta( $clean_key, true, $context );
+ }
+
+ if ( strstr( $key, 'password' ) && ! is_null( $value ) ) {
+ 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 is_null( $value ) ? $value : 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 ) { // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedCatch
+ }
+ }
+
+ 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 %1$s. To learn more about return requests by customers and/or guests, please check the %2$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();
+ $sections = array_keys( $this->get_setting_sections() );
+
+ foreach ( $sections as $section ) {
+ $settings[ $section ] = $this->get_settings( $section );
+ }
+
+ return $settings;
+ }
+
+ public function get_shipping_method_settings() {
+ return array();
+ }
+
+ 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;
+ }
+
+ /**
+ * @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 ShipmentError( 'shipping-provider', _x( 'This shipping provider does not support creating labels.', 'shipments', 'woocommerce-germanized' ) );
+
+ return $result;
+ }
+
+ /**
+ * @param $filter_args
+ *
+ * @return ProductList
+ */
+ public function get_products( $filter_args = array() ) {
+ if ( is_null( $this->products ) ) {
+ $this->products = new ProductList();
+ $this->register_products();
+ }
+
+ $products = $this->products;
+
+ if ( ! empty( $filter_args ) ) {
+ return $products->filter( $filter_args );
+ }
+
+ return $products;
+ }
+
+ /**
+ * @param $id
+ *
+ * @return false|Product
+ */
+ public function get_product( $id ) {
+ $products = $this->get_products();
+
+ return $products->get( $id );
+ }
+
+ protected function register_products() {
+
+ }
+
+ protected function register_product( $id, $args = array() ) {
+ if ( is_null( $this->products ) ) {
+ $this->products = new ProductList();
+ }
+
+ if ( is_a( $id, 'Vendidero\Germanized\Shipments\ShippingProvider\Product' ) ) {
+ $this->products->add( $id );
+
+ return true;
+ } else {
+ $args['id'] = $id;
+
+ try {
+ $this->products->add( new Product( $this, $args ) );
+
+ return true;
+ } catch ( Exception $e ) {
+ return new \WP_Error( 'register-product', $e->getMessage() );
+ }
+ }
+ }
+
+ /**
+ * @param $filter_args
+ *
+ * @return PrintFormatList
+ */
+ public function get_print_formats( $filter_args = array() ) {
+ if ( is_null( $this->print_formats ) ) {
+ $this->print_formats = new PrintFormatList();
+ $this->register_print_formats();
+ }
+
+ $print_formats = $this->print_formats;
+
+ if ( ! empty( $filter_args ) ) {
+ return $print_formats->filter( $filter_args );
+ }
+
+ return $print_formats;
+ }
+
+ /**
+ * @param $id
+ *
+ * @return false|PrintFormat
+ */
+ public function get_print_format( $id ) {
+ $print_formats = $this->get_print_formats();
+
+ return $print_formats->get( $id );
+ }
+
+ protected function register_print_formats() {
+
+ }
+
+ protected function register_print_format( $id, $args = array() ) {
+ if ( is_null( $this->print_formats ) ) {
+ $this->print_formats = new PrintFormatList();
+ }
+
+ if ( is_a( $id, 'Vendidero\Germanized\Shipments\ShippingProvider\PrintFormat' ) ) {
+ $this->print_formats->add( $id );
+
+ return true;
+ } else {
+ $args['id'] = $id;
+
+ try {
+ $this->print_formats->add( new PrintFormat( $this, $args ) );
+
+ return true;
+ } catch ( Exception $e ) {
+ return new \WP_Error( 'register-print-format', $e->getMessage() );
+ }
+ }
+ }
+
+ /**
+ * @return ServiceList
+ * @param array $filter_args
+ */
+ public function get_services( $filter_args = array() ) {
+ if ( is_null( $this->services ) ) {
+ $this->services = new ServiceList();
+ $this->register_services();
+ }
+
+ $services = $this->services;
+
+ if ( ! empty( $filter_args ) ) {
+ return $services->filter( $filter_args );
+ }
+
+ return $services;
+ }
+
+ /**
+ * @param $id
+ *
+ * @return false|Service
+ */
+ public function get_service( $id ) {
+ return $this->get_services()->get( $id );
+ }
+
+ protected function register_services() {
+
+ }
+
+ /**
+ * @param string|Service $id
+ * @param $args
+ *
+ * @return true|\WP_Error
+ */
+ protected function register_service( $id, $args = array() ) {
+ if ( is_null( $this->services ) ) {
+ $this->services = new ServiceList();
+ }
+
+ if ( is_a( $id, 'Vendidero\Germanized\Shipments\ShippingProvider\Service' ) ) {
+ $this->services->add( $id );
+
+ return true;
+ } else {
+ $args['id'] = $id;
+
+ try {
+ $this->services->add( new Service( $this, $args ) );
+
+ return true;
+ } catch ( Exception $e ) {
+ return new \WP_Error( 'register-service', $e->getMessage() );
+ }
+ }
+ }
+
+ public function get_supported_shipment_types() {
+ $shipment_types = array();
+
+ foreach ( wc_gzd_get_shipment_types() as $shipment_type ) {
+ if ( $this->supports_labels( $shipment_type ) ) {
+ $shipment_types[] = $shipment_type;
+ }
+ }
+
+ return $shipment_types;
+ }
+}
diff --git a/packages/woocommerce-germanized-shipments/src/SimpleShipment.php b/packages/woocommerce-germanized-shipments/src/SimpleShipment.php
new file mode 100644
index 000000000..3f1a3a983
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/SimpleShipment.php
@@ -0,0 +1,379 @@
+ 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->has_shipping_address() ? $order->get_address( 'shipping' ) : $order->get_address( 'billing' ) ),
+ array(
+ 'email' => $order->get_billing_email(),
+ 'phone' => $order->get_billing_phone(),
+ )
+ );
+
+ // Prefer shipping phone in case exists
+ if ( is_callable( array( $order, 'get_shipping_phone' ) ) && $order->get_shipping_phone() ) {
+ $address_data['phone'] = $order->get_shipping_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->has_shipping_address() ? $order->get_shipping_country() : $order->get_billing_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' => $order_shipment->calculate_shipment_additional_total( $this ),
+ )
+ );
+
+ /**
+ * 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;
+ }
+
+ /**
+ * 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/Utilities/NumberUtil.php b/packages/woocommerce-germanized-shipments/src/Utilities/NumberUtil.php
new file mode 100644
index 000000000..4ce0b7379
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/Utilities/NumberUtil.php
@@ -0,0 +1,54 @@
+get_changes();
+ $screen = is_admin() && function_exists( 'get_current_screen' ) ? get_current_screen() : false;
+ $is_edit_order_request = $screen ? in_array( $screen->id, array( 'woocommerce_page_wc-orders' ), true ) : false;
+ $skip_validation = false;
+
+ /**
+ * Try to detect a edit-lock only save request and skip validation
+ */
+ if ( $is_edit_order_request && ( empty( $changes ) || ( 1 === count( $changes ) && array_key_exists( 'date_modified', $changes ) ) ) ) {
+ $skip_validation = true;
+ }
+
+ if ( ! $skip_validation ) {
+ add_action(
+ 'woocommerce_update_order',
+ function( $order_id ) use ( $order ) {
+ if ( $order_id === $order->get_id() ) {
+ self::update_order( $order_id );
+ }
+ },
+ 10,
+ 1
+ );
+ }
+
+ /**
+ * Prevent additional validation from happening while saving order items.
+ */
+ add_action(
+ 'woocommerce_update_order_item',
+ function( $order_item_id, $order_item ) use ( $order ) {
+ if ( is_a( $order_item, 'WC_Order_Item' ) ) {
+ if ( $order_item->get_order_id() === $order->get_id() ) {
+ remove_action( 'woocommerce_update_order_item', array( __CLASS__, 'update_order_item' ), 10 );
+ }
+ }
+ },
+ 5,
+ 2
+ );
+ },
+ 10
+ );
+
+ add_action(
+ 'woocommerce_new_order',
+ function( $order_id ) {
+ add_action(
+ 'woocommerce_after_order_object_save',
+ function( $order ) use ( $order_id ) {
+ if ( $order_id === $order->get_id() ) {
+ self::new_order( $order );
+ }
+ },
+ 300,
+ 1
+ );
+ },
+ 10,
+ 1
+ );
+
+ add_action( 'woocommerce_delete_order', array( __CLASS__, 'delete_order' ), 10, 1 );
+
+ foreach ( array( 'cancelled', 'failed', 'refunded' ) as $cancelled_status ) {
+ add_action( "woocommerce_order_status_{$cancelled_status}", array( __CLASS__, 'maybe_cancel_shipments' ), 10, 2 );
+ }
+
+ add_action( 'before_delete_post', array( __CLASS__, 'before_delete_refund' ), 10, 1 );
+ add_action( 'woocommerce_delete_order_refund', array( __CLASS__, 'delete_refund_order' ), 10, 1 );
+ add_action( 'woocommerce_order_refund_object_updated_props', array( __CLASS__, 'refresh_refund_order' ), 10, 1 );
+
+ // Check if order is shipped
+ add_action( 'woocommerce_gzd_shipment_before_status_change', array( __CLASS__, 'maybe_update_order_date_shipped' ), 5, 2 );
+
+ add_action( 'woocommerce_gzd_shipping_provider_deactivated', array( __CLASS__, 'maybe_disable_default_shipping_provider' ), 10 );
+ }
+
+ /**
+ * In case a certain shipping provider is being deactivated make sure that the default
+ * shipping provider option is removed in case the option equals the deactivated provider.
+ *
+ * @param ShippingProvider $provider
+ */
+ public static function maybe_disable_default_shipping_provider( $provider ) {
+ $default_provider = wc_gzd_get_default_shipping_provider();
+
+ if ( $default_provider === $provider->get_name() ) {
+ update_option( 'woocommerce_gzd_shipments_default_shipping_provider', '' );
+ }
+ }
+
+ /**
+ * @param integer $shipment_id
+ * @param Shipment $shipment
+ */
+ public static function maybe_update_order_date_shipped( $shipment_id, $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 ( $shipment_order->is_shipped() ) {
+ $order_id = $shipment_order->get_order()->get_id();
+
+ /**
+ * 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', $order_id );
+
+ /**
+ * Make sure to instantiate a new order instance as the woocommerce_gzd_shipments_order_shipped hook
+ * might trigger the order save event. We must prevent old order data to be updated again after the
+ * potential update within the hook. This issue seems to only occur related to the HPOS post sync feature.
+ */
+ if ( $order = wc_get_order( $order_id ) ) {
+ $order->update_meta_data( '_date_shipped', time() );
+ $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 ( false !== self::$current_refund_parent_order ) {
+ 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 ) {
+ if ( $order_shipment = wc_gzd_get_shipment_order( $order ) ) {
+ $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 ) { // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedCatch
+ }
+ }
+
+ 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 && wp_doing_ajax() && isset( $_REQUEST['action'] ) && isset( $_REQUEST['order_id'] ) && strpos( wc_clean( wp_unslash( $_REQUEST['action'] ) ), 'woocommerce_' ) !== false ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+ $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_a( $order_item, 'WC_Order_Item' ) ) {
+ 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..f19e28653
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/src/WPMLHelper.php
@@ -0,0 +1,166 @@
+get_order_id() ) ) {
+ $language = $order->get_meta( 'wpml_language', true );
+
+ foreach ( $args['items'] as $key => $item ) {
+ $id = $item->get_product_id();
+ $id = apply_filters( 'wpml_object_id', $id, get_post_type( $id ), true, $language );
+
+ if ( $product = wc_get_product( $id ) ) {
+ $args['items'][ $key ]->set_name( $product->get_name() );
+ }
+ }
+ }
+
+ return $args;
+ }
+
+ public static function register_provider_filters() {
+ add_filter( 'woocommerce_gzd_shipping_provider_get_tracking_desc_placeholder', array( __CLASS__, 'filter_shipping_provider_placeholder' ), 10, 2 );
+ add_filter( 'woocommerce_gzd_shipping_provider_get_tracking_url_placeholder', array( __CLASS__, 'filter_shipping_provider_url' ), 10, 2 );
+ add_filter( 'woocommerce_gzd_shipping_provider_get_return_instructions', array( __CLASS__, 'filter_shipping_provider_return_instructions' ), 10, 2 );
+
+ foreach ( Helper::instance()->get_shipping_providers() as $provider ) {
+ add_filter( "woocommerce_gzd_shipping_provider_{$provider->get_name()}_get_tracking_desc_placeholder", array( __CLASS__, 'filter_shipping_provider_placeholder' ), 10, 2 );
+ add_filter( "woocommerce_gzd_shipping_provider_{$provider->get_name()}_get_tracking_url_placeholder", array( __CLASS__, 'filter_shipping_provider_url' ), 10, 2 );
+ add_filter( "woocommerce_gzd_shipping_provider_{$provider->get_name()}_get_return_instructions", array( __CLASS__, 'filter_shipping_provider_return_instructions' ), 10, 2 );
+ }
+ }
+
+ public static function filter_shipping_provider_return_instructions( $instructions, $provider ) {
+ $string_name = 'return_instructions';
+ $translated_string = apply_filters( 'wpml_translate_string', $instructions, self::get_shipping_provider_string_id( $string_name, $provider ), self::get_shipping_provider_string_package( $string_name, $provider ) );
+
+ return $translated_string;
+ }
+
+ public static function filter_shipping_provider_url( $placeholder, $provider ) {
+ $string_name = 'tracking_url_placeholder';
+ $translated_string = apply_filters( 'wpml_translate_string', $placeholder, self::get_shipping_provider_string_id( $string_name, $provider ), self::get_shipping_provider_string_package( $string_name, $provider ) );
+
+ return $translated_string;
+ }
+
+ public static function filter_shipping_provider_placeholder( $placeholder, $provider ) {
+ $string_name = 'tracking_desc_placeholder';
+ $translated_string = apply_filters( 'wpml_translate_string', $placeholder, self::get_shipping_provider_string_id( $string_name, $provider ), self::get_shipping_provider_string_package( $string_name, $provider ) );
+
+ return $translated_string;
+ }
+
+ /**
+ * @param integer $provider_id
+ * @param Simple $provider
+ */
+ public static function register_shipping_provider_strings( $provider_id, $provider ) {
+
+ foreach ( self::get_shipping_provider_strings() as $string_name => $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 Simple $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 Simple $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..0b3d10afb
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/templates/emails/admin-new-return-shipment-request.php
@@ -0,0 +1,60 @@
+
+
+
+ get_formatted_sender_full_name() ) ); ?>
+ + + +get_billing_first_name() ) ); // phpcs:ignore WordPress.WP.I18n.TextDomainMismatch ?>
+ ++ get_order_number() ) ); ?> +
+ + + + + + + +get_billing_first_name() ) ); // phpcs:ignore WordPress.WP.I18n.TextDomainMismatch ?>
+ ++ +
+ + + +get_billing_first_name() ) ); // phpcs:ignore WordPress.WP.I18n.TextDomainMismatch ?>
+ ++ +
+ + + +get_billing_first_name() ) ); // phpcs:ignore WordPress.WP.I18n.TextDomainMismatch ?>
+ ++ +
+ +|
+ $shipment ) :
+ $count++;
+ ?>
+ 1 ) : ?>
+
+
+
+ get_est_delivery_date() ) : ?>
+ get_est_delivery_date(), wc_date_format() ) ); ?> + + + has_tracking() ) : ?> + get_tracking_url() ) : ?> + + + + has_tracking_instruction() ) : ?> +get_tracking_instruction() ); ?> + + + + + + |
+
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..f355c2f80 --- /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( '[%1$s #%2$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..e17d2f062
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/templates/emails/email-shipment-items.php
@@ -0,0 +1,114 @@
+ $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() ) ); ?> + + has_tracking() && ! $shipment->has_status( 'delivered' ) ) : ?> + + + + + + $action ) { // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited + 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..d4339fa15 --- /dev/null +++ b/packages/woocommerce-germanized-shipments/templates/shipment/add-return-shipment-item.php @@ -0,0 +1,90 @@ + +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..3b897e9df
--- /dev/null
+++ b/packages/woocommerce-germanized-shipments/woocommerce-germanized-shipments.php
@@ -0,0 +1,76 @@
+
+
+
+
+ composer install',
+ '' . esc_html( str_replace( ABSPATH, '', __DIR__ ) ) . ''
+ );
+ ?>
+