# woo-vipps/6.1.4/payment/VippsCheckoutShippingMethods.php

Pay with Vipps and MobilePay for WooCommerce, version 6.1.4. 560 lines.

- Page: https://pluginprobe.com/plugins/woo-vipps/6.1.4/code/payment/VippsCheckoutShippingMethods.php
- Raw: https://pluginprobe.com/plugins/woo-vipps/6.1.4/raw/payment/VippsCheckoutShippingMethods.php
- Modified: 2025-10-20T07:28:04+00:00

Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/woo-vipps/6.1.4/code/payment/VippsCheckoutShippingMethods.php#L10-L20`.

```php
<?php
add_action( 'woocommerce_shipping_init', function () {
  //add your shipping method to WooCommers list of Shipping methods
  add_filter( 'woocommerce_shipping_methods',  function ($methods) {
      $vc_activated =  get_option('woo_vipps_checkout_activated', false);
      if (!$vc_activated) return $methods;

      $gw = Vipps::instance()->gateway();
      if (!$gw) return $methods;

      $vc_enabled =  $gw->get_option('vipps_checkout_enabled') === 'yes';
      if (!$vc_enabled) return $methods;

//      $methods['vipps_checkout'] = 'VippsCheckout_Shipping_Method';
      if ("yes" == $gw->get_option('vcs_posten'))     $methods['vipps_checkout_posten'] = 'VippsCheckout_Shipping_Method_Posten';
      if ("yes" == $gw->get_option('vcs_postnord'))   $methods['vipps_checkout_postnord'] = 'VippsCheckout_Shipping_Method_Postnord';
      if ("yes" == $gw->get_option('vcs_helthjem'))   $methods['vipps_checkout_helthjem'] = 'VippsCheckout_Shipping_Method_Helthjem';
      if ("yes" == $gw->get_option('vcs_porterbuddy'))$methods['vipps_checkout_porterbuddy'] = 'VippsCheckout_Shipping_Method_Porterbuddy';
      if ("yes" == $gw->get_option('vcs_posti'))   $methods['vipps_checkout_posti'] = 'VippsCheckout_Shipping_Method_Posti';

      return $methods;
  });

  $extended_classes = ['flat_rate', 'free_shipping', 'local_pickup'];
  foreach($extended_classes as $key) {
      add_filter('woocommerce_shipping_instance_form_fields_' . $key, array('VippsCheckout_Shipping_Method', 'add_description_field'));
  }
}, 20);


/* This file is required_once'd early in woocommerce_shipping_init, only if the classes do not already exist. */

/* Abstract class used just to mark the special Vipps Checkout shipping methods. Don't instantiate this */
class VippsCheckout_Shipping_Method extends WC_Shipping_Method {
    public $defaulttitle = "";
    // Basic price, set by options
    public $cost = 0;
    // Some methods may support free shipping
    public $supports_free_shipping = true;
    // Porterbuddy (only) supports having the cost calculated in Vipps Checkout itself.
    public $supports_dynamic_cost = false;
    // Does not need to set "type"
    public $no_type_needed = true;
    public $default_delivery_method = '';

    // True for the instances where this has been set to true
    public $dynamic_cost = false;

    public function preinit () {
    }
    public function init () {
    }
    public function postinit () {
    }

    public function instance_form_fields() {
       return [];
    }

    // From WooCommerces' NumberUtil class
    public static function round( $val, int $precision = 0, int $mode = PHP_ROUND_HALF_UP ) : float {
                if ( ! is_numeric( $val ) ) {
                        $val = floatval( $val );
                }
                return round( $val, $precision, $mode );
    }

    public function free_shipping_form_fields() {
        return array(
                'title'            => array(
                    'title'       => __( 'Title', 'woocommerce' ),
                    'type'        => 'text',
                    'description' => __( 'This controls the title which the user sees during checkout.', 'woocommerce' ),
                    'default'     => $this->method_title,
                    'desc_tip'    => true,
                    ),
                'requires'         => array(
                    'title'   => __( 'Free shipping requires...', 'woocommerce' ),
                    'type'    => 'select',
                    'class'   => 'wc-enhanced-select vipps_checkout_free_shipping',
                    'default' => '',
                    'options' => array(
                        ''           => __( 'N/A', 'woocommerce' ),
                        'coupon'     => __( 'A valid free shipping coupon', 'woocommerce' ),
                        'min_amount' => __( 'A minimum order amount', 'woocommerce' ),
                        'either'     => __( 'A minimum order amount OR a coupon', 'woocommerce' ),
                        'both'       => __( 'A minimum order amount AND a coupon', 'woocommerce' ),
                        ),
                    ),
                'min_amount'       => array(
                        'title'       => __( 'Minimum order amount', 'woocommerce' ),
                        'type'        => 'price',
                        'placeholder' => wc_format_localized_price( 0 ),
                        'description' => __( 'Users will need to spend this amount to get free shipping (if enabled above).', 'woocommerce' ),
                        'default'     => '0',
                        'class'       => 'vipps_checkout_min_amount_field',
                        'desc_tip'    => true,
                        ),
                'ignore_discounts' => array(
                        'title'       => __( 'Coupons discounts', 'woocommerce' ),
                        'label'       => __( 'Apply minimum order rule before coupon discount', 'woocommerce' ),
                        'type'        => 'checkbox',
                        'description' => __( 'If checked, free shipping would be available based on pre-discount order amount.', 'woocommerce' ),
                        'default'     => 'no',
                        'class'       => 'vipps_checkout_ignore_discounts_field',
                        'desc_tip'    => true,
                        ),
                );



    }


    // Add a description field to a standard shipping method
    public static function add_description_field($form_fields) {
        if (! array_key_exists('description', $form_fields)) {
            $description = array('description' =>  array( 
                        'title' => __( 'Description', 'woo-vipps' ),
                        'type' => 'text',
                        'description' => sprintf(__( 'Short description of shipping method used in %1$s', 'woo-vipps' ), Vipps::CheckoutName()),
                        'default' => "",
                        ));
            $index = array_search('title', array_keys($form_fields));
            if ($index === false) {
                $form_fields['description'] = $description['description'];
            } else {
                $pos = $index+1;
                $form_fields = array_merge(array_slice($form_fields, 0, $pos), $description, array_slice($form_fields, $pos));
            }
        }
          return $form_fields;
    }

    // Instance setting, common for all submethods
    public function init_form_fields() {
        $this->instance_form_fields = array(
                'title' => array(
                    'title' => __( 'Title', 'woo-vipps' ),
                    'type' => 'text',
                    'description' => __( 'Title to be display on site', 'woo-vipps' ),
                    'default' => $this->defaulttitle
                    ),

                'description' => array(
                    'title' => __( 'Description', 'woo-vipps' ),
                    'type' => 'text',
                    'description' => __( 'Short description of shipping method', 'woo-vipps' ),
                    'default' => "",
                    'desc_tip'=>true
                    ));

        if ($this->supports_dynamic_cost) {
            $this->instance_form_fields['dynamic_cost'] = array(
                    'title'       => __( 'Calculate cost in Checkout', 'woo-vipps' ),
                    'label'       => __( 'Calculate costs in the Checkout window', 'woo-vipps' ),
                    'type'        => 'checkbox',
                    'class'       => 'vipps_checkout_dynamic_cost_field',
                    'description' => sprintf(__( 'If checked, cost of shipping will be calculated dynamically in the %1$s window', 'woo-vipps' ), Vipps::CheckoutName()),
                    'default'     => 'no',
                    'desc_tip'    => true,
                    );

        }
       $this->instance_form_fields['cost'] = array(
                    'title' => __( 'Cost', 'woo-vipps' ),
                    'type' => 'price',
                    'class' => 'vipps_checkout_cost_field',
                    'description' => __( 'Cost of shipping', 'woo-vipps' ),
                    'default' => 0,
                    'desc_tip'=>true
                    );
        // Support pickup point/home delivery where appropriate
        if (!empty($this->delivery_types)) {
            $options = array();
            if ($this->no_type_needed) {
                $options[''] = __('No delivery method specified', 'woo-vipps');
            }
            foreach($this->delivery_types as $type) {
                switch ($type) {
                    case 'MAILBOX':
                        $options[$type] = __('Deliver to customers\' mailbox', 'woo-vipps');
                        break;
                    case 'PICKUP_POINT':
                        $options[$type] = __('Allow user to choose pickup point', 'woo-vipps');
                        break;
                    case 'HOME_DELIVERY':
                        $options[$type] = __('Deliver to customers\' home address', 'woo-vipps');
                        break;
                    default:
                            // inconceivable!
                }
            }
            $this->instance_form_fields['type'] = array(
                    'title'       => __( 'Delivery method', 'woocommerce' ),
                    'type'        => 'select',
                    'class'       => 'wc-enhanced-select',
                    'description' => sprintf(__( 'If you are using %1$s, you can select extended delivery method options here. If you do, these methods will not appear in Express Checkout or the standard WooCommerce checkout page.', 'woo-vipps' ), Vipps::CheckoutName()),
                    'default'     => $this->default_delivery_method,
                    'options'     => $options,
                    'desc_tip'    => true,
                    );
        }

        $this->instance_form_fields['tax_status'] =  array(
                'title'   => __( 'Tax status', 'woocommerce' ),
                'type'    => 'select',
                'class'   => 'wc-enhanced-select',
                'default' => 'taxable',
                'options' => array(
                    'taxable' => __( 'Taxable', 'woocommerce' ),
                    'none'    => _x( 'None', 'Tax status', 'woocommerce' ),
                    ),
                );


        // From subclasses
        foreach($this->instance_form_fields() as $key=>$setting) {
            $this->instance_form_fields[$key] = $setting;
        }

        if ($this->supports_free_shipping) {
            $this->instance_form_fields = array_merge($this->instance_form_fields, $this->free_shipping_form_fields());
         }

    }


    // True if the method contains extended options for Vipps Checkout
    public function is_extended() {
       $delivery = $this->get_option('type', false);
       return ($delivery == "PICKUP_POINT");
    }

    public function __construct( $instance_id = 0 ) {
        $this->instance_id 	  = absint( $instance_id );

        //add to shipping zones list
        $this->supports = array( 'instance-settings', 'instance-settings-modal');

        // Subclasses support shipping zones, parent does not. With this we could add a global 
        // settings page using the never-available parent method.
        if (get_class($this) == "VippsCheckout_Shipping_Method") {
            // nop
        } else {
            $this->supports[] = 'shipping-zones';
        }


        $this->preinit();
        // Load the settings API
        $this->init_form_fields();
        $this->init_settings();

        $this->title                = $this->get_option( 'title' );
        $this->tax_status           = $this->get_option( 'tax_status' );
        $this->dynamic_cost = $this->supports_dynamic_cost && ('yes' == $this->get_option('dynamic_cost'));

        // Never enable parent method
        if (get_class($this) == "VippsCheckout_Shipping_Method") {
           $this->enabled = "no";
        }

        $this->init();
        $this->postinit();

        add_action( 'admin_footer', array( 'VippsCheckout_Shipping_Method', 'enqueue_admin_js' ), 10 ); // Priority needs to be higher than wc_print_js (25).

        add_action( 'woocommerce_update_options_shipping_' . $this->id, array( $this, 'process_admin_options' ) );
    }


    public function free_shipping_ok($package) {
        if (!$this->supports_free_shipping) return false;

        $has_coupon         = false;
        $has_met_min_amount = false;

        $requires = $this->get_option('requires', false);

        if ( in_array( $requires , array( 'coupon', 'either', 'both' ), true ) ) {
            $coupons = WC()->cart->get_coupons();
            if ( $coupons ) {
                foreach ( $coupons as $code => $coupon ) {
                    if ( $coupon->is_valid() && $coupon->get_free_shipping() ) {
                        $has_coupon = true;
                        break;
                    }
                }
            }
        }

        if ( in_array( $requires, array( 'min_amount', 'either', 'both' ), true ) ) {
            $total = WC()->cart->get_displayed_subtotal();

            if ( WC()->cart->display_prices_including_tax() ) {
                $total = $total - WC()->cart->get_discount_tax();
            }

            if ( 'no' === $this->get_option('ignore_discounts')) {
                $total = $total - WC()->cart->get_discount_total();
            }

            $total = static::round( $total, wc_get_price_decimals() );

            if ( $total >= $this->get_option('min_amount',0) ) {
                $has_met_min_amount = true;
            }
        }

        switch ( $requires ) {
            case 'min_amount':
                $is_available = $has_met_min_amount;
                break;
            case 'coupon':
                $is_available = $has_coupon;
                break;
            case 'both':
                $is_available = $has_met_min_amount && $has_coupon;
                break;
            case 'either':
                $is_available = $has_met_min_amount || $has_coupon;
                break;
            default:
                $is_available = false;
                break;
        }

        return $is_available;
    }


    public function get_cost($package) {

        $cost = $this->get_option('cost');

        if ($this->supports_dynamic_cost && $this->dynamic_cost ) {
              $cost = 0;
        }
        if ($this->free_shipping_ok($package)) {
              $cost = 0;
        }

        $cost = apply_filters('woo_vipps_vipps_checkout_shipping_cost', $cost, $this);
        return $cost ?: 0;
    }

    // Add free shipping trigger etc?
    public function calculate_shipping( $package = array()) {
        $instance_settings =  $this->instance_settings;
        $meta = array();
        $meta['brand'] = $this->brand;
        $option = $this->get_option('type', false);
        $description = $this->get_option('description', '');

        if ($option) {
           $meta['type'] = $option;
        }

        $cost = $this->get_cost($package);
        if ($cost == 0 && $this->free_shipping_ok($package)) {
            $meta['free_shipping'] = true;
        } else {
            unset($meta['free_shipping']);
        }

        $ratedata = array(
                    'id'      => $this->get_rate_id(),
                    'label'   => $this->get_option('title'),
                    'cost'    => $cost,
                    'package' => $package,
                    'meta_data' => $meta,
                    );


        $ratedata = apply_filters('woo_vipps_vipps_checkout_shipping_rate', $ratedata, $this);

        $this->add_rate($ratedata);
    }

    public function is_enabled() {
        $vc_activated =  get_option('woo_vipps_checkout_activated', false);
        return $vc_activated;
    }

    public function is_available($package) {

        // Never show the parent method
        if (get_class($this) == "VippsCheckout_Shipping_Method") {
           return false;
        }

        // This handles zones etc as well as the basic filter
        $ok = parent::is_available($package);

        // We'll show all methods in Vipps Checkout or on the cart page, otherwise
        // we'll not show the extended methods
        $is_vipps_checkout = apply_filters('woo_vipps_is_vipps_checkout', false);
        if ($is_vipps_checkout || is_cart()) {
            $ok = true;
        } else if ($this->is_extended()) {
            $ok = false;
        }

        return apply_filters('vipps_checkout_shipping_available', $ok, $this, $package);
    }


    // Static so it gets loaded just once; must be loaded before 25. (See Free Shipping).
    public static function enqueue_admin_js() {
        wc_enqueue_js( "jQuery(document).ready(function () {

          function vipps_checkout_hide_cost_for_dynamic_pricing (el) {
              let form = jQuery( el ).closest( 'form' );
              let costfield = jQuery( '.vipps_checkout_cost_field', form ).closest( 'tr' );
              if (jQuery(el).is(':checked')) {
                  costfield.hide();
              } else {
                  costfield.show();
              }
          }

          jQuery( document.body ).on( 'change', '.vipps_checkout_dynamic_cost_field', function() {
             vipps_checkout_hide_cost_for_dynamic_pricing( this );
          });
          jQuery( '.vipps_checkout_dynamic_cost_field' ).trigger( 'change' );
          jQuery(document.body).on( 'wc_backbone_modal_loaded', function( evt, target ) {
            if ( 'wc-modal-shipping-method-settings' === target ) {
                vipps_checkout_hide_cost_for_dynamic_pricing(jQuery('#wc-backbone-modal-dialog .vipps_checkout_dynamic_cost_field', evt.currentTarget));
            }
          });


          /* Support Free Shipping for Vipps Checkout methods */
          function vipps_checkoutFreeShippingShowHideMinAmountField( el ) {
              var form = jQuery( el ).closest( 'form' );
              var minAmountField = jQuery( '.vipps_checkout_min_amount_field', form ).closest( 'tr' );
              var ignoreDiscountField = jQuery( '.vipps_checkout_ignore_discounts_field', form ).closest( 'tr' );
              if ( 'coupon' === jQuery( el ).val() || '' === jQuery( el ).val() ) {
                  minAmountField.hide();
                  ignoreDiscountField.hide();
              } else {
                  minAmountField.show();
                  ignoreDiscountField.show();
              }
          }
          jQuery( document.body ).on( 'change', '.vipps_checkout_free_shipping', function() {
                  vipps_checkoutFreeShippingShowHideMinAmountField( this );
          });
          jQuery( '.vipps_checkout_free_shipping' ).trigger( 'change' );
          jQuery( document.body ).on( 'wc_backbone_modal_loaded', function( evt, target ) {
           if ( 'wc-modal-shipping-method-settings' === target ) {
                     vipps_checkoutFreeShippingShowHideMinAmountField( jQuery( '#wc-backbone-modal-dialog .vipps_checkout_free_shipping', evt.currentTarget ) );
                  }
          });

         });");


    }

}

class VippsCheckout_Shipping_Method_Posten extends VippsCheckout_Shipping_Method {
    public $id = 'vipps_checkout_posten';
    public $delivery_types = ['MAILBOX','PICKUP_POINT','HOME_DELIVERY'];
    public $brand = "POSTEN";
    public $no_type_needed = false;
    public $default_delivery_method = "MAILBOX";

    // Called by the parent constructor before loading settings
    function preinit() {
        $this->defaulttitle = __( 'Posten Norge', 'woo-vipps' );
        $this->method_title = sprintf(__( '%1$s: %2$s', 'woo-vipps' ), Vipps::CheckoutName(), $this->defaulttitle);
        $this->method_description = sprintf(__( 'Shipping method for %1$s only: %2$s', 'woo-vipps'), Vipps::CheckoutName(), $this->defaulttitle);
    }

}

class VippsCheckout_Shipping_Method_Posti extends VippsCheckout_Shipping_Method {
    public $id = 'vipps_checkout_posti';
    public $delivery_types = ['PICKUP_POINT'];
    public $brand = "POSTI";
    public $no_type_needed = false;
    public $default_delivery_method = "PICKUP_POINT";

    // Called by the parent constructor before loading settings
    function preinit() {
        $this->defaulttitle = __( 'Posti', 'woo-vipps' );
        $this->method_title = sprintf(__( '%1$s: %2$s', 'woo-vipps' ), Vipps::CheckoutName(), $this->defaulttitle);
        $this->method_description = sprintf(__( 'Shipping method for %1$s only: %2$s', 'woo-vipps'), Vipps::CheckoutName(), $this->defaulttitle);
    }
}

class VippsCheckout_Shipping_Method_Helthjem extends VippsCheckout_Shipping_Method {
    public $id = 'vipps_checkout_helthjem';
    public $delivery_types = ['HOME_DELIVERY', 'PICKUP_POINT'];
    public $brand = "HELTHJEM";
    public $no_type_needed = false;
    public $default_delivery_method = 'HOME_DELIVERY';

     // Only useable by Vipps Checkout
    public function is_extended() {
       return true;
    }

    // Called by the parent constructor before loading settings
    function preinit() {
        $this->defaulttitle = __( 'Helthjem', 'woo-vipps' );
        $this->method_title = sprintf(__( '%1$s: %2$s', 'woo-vipps' ), Vipps::CheckoutName(), $this->defaulttitle);
        $this->method_description = sprintf(__( 'Shipping method for %1$s only: %2$s', 'woo-vipps'), Vipps::CheckoutName(), $this->defaulttitle);
    }
}


class VippsCheckout_Shipping_Method_Postnord extends VippsCheckout_Shipping_Method {
    public $id = 'vipps_checkout_postnord';
    public $delivery_types = ['PICKUP_POINT','HOME_DELIVERY'];
    public $brand = "POSTNORD";
    public $no_type_needed = true;
    public $default_delivery_method = '';

    // Called by the parent constructor before loading settings
    function preinit() {
        $this->defaulttitle = __( 'Postnord', 'woo-vipps' );
        $this->method_title = sprintf(__( '%1$s: %2$s', 'woo-vipps' ), Vipps::CheckoutName(), $this->defaulttitle);
        $this->method_description = sprintf(__( 'Shipping method for %1$s only: %2$s', 'woo-vipps'), Vipps::CheckoutName(), $this->defaulttitle);
    }
}

class VippsCheckout_Shipping_Method_Porterbuddy extends VippsCheckout_Shipping_Method {
    public $id = 'vipps_checkout_porterbuddy';
    public $delivery_types = ['HOME_DELIVERY'];
    public $brand = "PORTERBUDDY";
    public $supports_free_shipping = true;
    public $supports_dynamic_cost = true;
    public $no_type_needed = false;
    public $default_delivery_method = 'HOME_DELIVERY';

    // Only useable by Vipps Checkout
    public function is_extended() {
       return true;
    }

    // Called by the parent constructor before loading settings
    function preinit() {
        $this->defaulttitle = __( 'Porterbuddy', 'woo-vipps' );
        $this->method_title = sprintf(__( '%1$s: %2$s', 'woo-vipps' ), Vipps::CheckoutName(), $this->defaulttitle);
        $this->method_description = sprintf(__( 'Shipping method for %1$s only: %2$s', 'woo-vipps'), Vipps::CheckoutName(), $this->defaulttitle);
    }





}




```