Make a shipping module to show a cost or not depending on the free shipping cart stat

[enzo-ita]

I want to make the pick up in shop module (the one mod by dr byte) to show a cost when nothing in the cart is free shipping, and do not show a cost when something in the cart is free shipping or the cart is free shipping because the freeoptions are met (ie value of the cart).

this is the file storepickup.php

<?php
/**
* @package shippingMethod
* @copyright Copyright 2003-2013 Zen Cart Development Team
* @copyright Portions Copyright 2003 osCommerce
* @license http://www.zen-cart.com/license/2_0.txt GNU Public License V2.0
* @version $Id: multiple-choice edition, Feb 8, 2013 - based on: storepickup.php 14498 2009-10-01 20:16:16Z ajeh $
*/
/**
* Store-Pickup / Will-Call shipping method
*
*/
class storepickup extends base {
/**
* $code determines the internal 'code' name used to designate "this" payment module
*
* @var string
*/
var $code;
/**
* $title is the displayed name for this payment method
*
* @var string
*/
var $title;
/**
* $description is a soft name for this payment method
*
* @var string
*/
var $description;
/**
* module's icon
*
* @var string
*/
var $icon;
/**
* $enabled determines whether this module shows or not... during checkout.
*
* @var boolean
*/
var $enabled;
/**
* constructor
*
* @return storepickup
*/
function storepickup() {
global $order, $db;

$this->code = 'storepickup';
$this->title = MODULE_SHIPPING_STOREPICKUP_TEXT_TITLE;
$this->description = MODULE_SHIPPING_STOREPICKUP_TEXT_DESCRIPTION;
$this->sort_order = MODULE_SHIPPING_STOREPICKUP_SORT_ORDER;
$this->icon = ''; // add image filename here; must be uploaded to the /images/ subdirectory
$this->tax_class = MODULE_SHIPPING_STOREPICKUP_TAX_CLASS;
$this->tax_basis = MODULE_SHIPPING_STOREPICKUP_TAX_BASIS;
$this->enabled = ((MODULE_SHIPPING_STOREPICKUP_STATUS == 'True') ? true : false);

if ( ($this->enabled == true) && ((int)MODULE_SHIPPING_STOREPICKUP_ZONE > 0) ) {
$check_flag = false;
$check = $db->Execute("select zone_id from " . TABLE_ZONES_TO_GEO_ZONES . "
where geo_zone_id = '" . MODULE_SHIPPING_STOREPICKUP_ZONE . "'
and zone_country_id = '" . $order->delivery['country']['id'] . "'
order by zone_id");
while (!$check->EOF) {
if ($check->fields['zone_id'] < 1) {
$check_flag = true;
break;
} elseif ($check->fields['zone_id'] == $order->delivery['zone_id']) {
$check_flag = true;
break;
}
$check->MoveNext();
}

if ($check_flag == false) {
$this->enabled = false;
}
}
}

/**
* Obtain quote from shipping system/calculations
*
* @param string $method
* @return array
*/
function quote($method = '') {
global $order;

$this->locations = explode(';', (string)MODULE_SHIPPING_STOREPICKUP_LOCATIONS_LIST);
$this->methodsList = array();
foreach ($this->locations as $key => $val)
{
if ($method != '' && $method != $this->code . (string)$key) continue;
$cost = MODULE_SHIPPING_STOREPICKUP_COST;
$title = $val;
if (strstr($val, ',')) {
list($title, $cost) = explode(',', $val);
}
$this->methodsList[] = array('id' => $this->code . (string)$key,
'title' => trim($title),
'cost' => $cost);
}

$this->quotes = array('id' => $this->code,
'module' => MODULE_SHIPPING_STOREPICKUP_TEXT_TITLE,
'methods' => $this->methodsList);

if ($this->tax_class > 0) {
$this->quotes['tax'] = zen_get_tax_rate($this->tax_class, $order->delivery['country']['id'], $order->delivery['zone_id']);
}

if (zen_not_null($this->icon)) $this->quotes['icon'] = zen_image($this->icon, $this->title);

return $this->quotes;
}
/**
* Check to see whether module is installed
*
* @return boolean
*/
function check() {
global $db;
if (!isset($this->_check)) {
$check_query = $db->Execute("select configuration_value from " . TABLE_CONFIGURATION . " where configuration_key = 'MODULE_SHIPPING_STOREPICKUP_STATUS'");
$this->_check = $check_query->RecordCount();
}
if ($this->_check > 0 && !defined('MODULE_SHIPPING_STOREPICKUP_LOCATIONS_LIST')) $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, date_added) values ('Pickup Locations', 'MODULE_SHIPPING_STOREPICKUP_LOCATIONS_LIST', 'Walk In', 'Enter a list of locations, separated by semicolons (;).<br>Optionally you may specify a fee/surcharge for each location by adding a comma and an amount. If no amount is specified, then the generic Shipping Cost amount from the next setting will be applied.<br><br>Examples:<br>121 Main Street;20 Church Street<br>Sunnyside,4.00;Lee Park,5.00;High Street,0.00<br>Dallas;Tulsa,5.00;Phoenix,0.00', '6', '0', now())");
return $this->_check;
}
/**
* Install the shipping module and its configuration settings
*
*/
function install() {
global $db;
$db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, date_added) values ('Enable Store Pickup Shipping', 'MODULE_SHIPPING_STOREPICKUP_STATUS', 'True', 'Do you want to offer In Store rate shipping?', '6', '0', 'zen_cfg_select_option(array(\'True\', \'False\'), ', now())");
$db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, date_added) values ('Pickup Locations', 'MODULE_SHIPPING_STOREPICKUP_LOCATIONS_LIST', 'Walk In', 'Enter a list of locations, separated by semicolons (;).<br>Optionally you may specify a fee/surcharge for each location by adding a comma and an amount. If no amount is specified, then the generic Shipping Cost amount from the next setting will be applied.<br><br>Examples:<br>121 Main Street;20 Church Street<br>Sunnyside,4.00;Lee Park,5.00;High Street,0.00<br>Dallas;Tulsa,5.00;Phoenix,0.00', '6', '0', now())");
$db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, date_added) values ('Shipping Cost', 'MODULE_SHIPPING_STOREPICKUP_COST', '0.00', 'The shipping cost for all orders using this shipping method.', '6', '0', now())");
$db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, use_function, set_function, date_added) values ('Tax Class', 'MODULE_SHIPPING_STOREPICKUP_TAX_CLASS', '0', 'Use the following tax class on the shipping fee.', '6', '0', 'zen_get_tax_class_title', 'zen_cfg_pull_down_tax_classes(', now())");
$db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, date_added) values ('Tax Basis', 'MODULE_SHIPPING_STOREPICKUP_TAX_BASIS', 'Shipping', 'On what basis is Shipping Tax calculated. Options are<br />Shipping - Based on customers Shipping Address<br />Billing Based on customers Billing address<br />Store - Based on Store address if Billing/Shipping Zone equals Store zone', '6', '0', 'zen_cfg_select_option(array(\'Shipping\', \'Billing\'), ', now())");
$db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, use_function, set_function, date_added) values ('Shipping Zone', 'MODULE_SHIPPING_STOREPICKUP_ZONE', '0', 'If a zone is selected, only enable this shipping method for that zone.', '6', '0', 'zen_get_zone_class_title', 'zen_cfg_pull_down_zone_classes(', now())");
$db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, date_added) values ('Sort Order', 'MODULE_SHIPPING_STOREPICKUP_SORT_ORDER', '0', 'Sort order of display.', '6', '0', now())");
}
/**
* Remove the module and all its settings
*
*/
function remove() {
global $db;
$db->Execute("delete from " . TABLE_CONFIGURATION . " where configuration_key like 'MODULE\_SHIPPING\_STOREPICKUP\_%'");
}
/**
* Internal list of configuration keys used for configuration of the module
*
* @return array
*/
function keys() {
return array('MODULE_SHIPPING_STOREPICKUP_STATUS', 'MODULE_SHIPPING_STOREPICKUP_LOCATIONS_LIST', 'MODULE_SHIPPING_STOREPICKUP_COST', 'MODULE_SHIPPING_STOREPICKUP_TAX_CLASS', 'MODULE_SHIPPING_STOREPICKUP_TAX_BASIS', 'MODULE_SHIPPING_STOREPICKUP_ZONE', 'MODULE_SHIPPING_STOREPICKUP_SORT_ORDER');
}
}

Can someone help?
Thanks
Ciao from Italy
enzo

[RodG]

I want to make the pick up in shop module to show a cost when nothing in the cart is free shipping

Am I reading this right and you wish to apply a 'shipping cost' for store pickups for products not eligible for free shipping?

Far be it for me to criticise your objectives, but I'd suspect that this could have a negative impact on any local sales you make. Why would you want to do that?

Cheers
Rod

[enzo-ita]

Hi,
thanks for your reply.
The word store pick up can be confusing.
Actually is "Delivery at Pick up Point".
Pick up point is a place close to your address that you can chose from a huge list, were you can go at your easy, also on Saturday, to pick up your parcel.
It can be very usefull for people who can not be at home at delivery time or want to pay cod and are not at home or do not want to give money to a nighborough, etc etc etc.
This is very close to a normal delivery service, therefore it must follow the rules of normal delivery.
I hope this makes it clear.
Do you have any suggestions about the code to mod?
Ciao from Italy.
enzo

[enzo-ita]

I have created (it is just a copy of another working module) a file called pickuppoint.php.
Here it is:

// $Id: pickuppoint.php 1969 2013-05-03 06:57:21Z enzo $
//

  class pickuppoint {
    var $code, $title, $description, $icon, $enabled;

// class constructor
    function pickuppoint() {
      global $order, $db;

      $this->code = 'pickuppoint';
      $this->title = MODULE_SHIPPING_CELERE3_PICKUPPOINT_TEXT_TITLE;
      $this->description = MODULE_SHIPPING_CELERE3_PICKUPPOINT_TEXT_DESCRIPTION;
      $this->sort_order = MODULE_SHIPPING_CELERE3_PICKUPPOINT_SORT_ORDER;
      $this->icon = '';
      $this->tax_class = MODULE_SHIPPING_CELERE3_PICKUPPOINT_TAX_CLASS;
      $this->tax_basis = MODULE_SHIPPING_CELERE3_PICKUPPOINT_TAX_BASIS;

      // disable only when entire cart is free shipping
      if (zen_get_shipping_enabled($this->code)) {
        $this->enabled = ((MODULE_SHIPPING_CELERE3_PICKUPPOINT_STATUS == 'True') ? true : false);
      }

      if ( ($this->enabled == true) && ((int)MODULE_SHIPPING_CELERE3_PICKUPPOINT_ZONE > 0) ) {
        $check_flag = false;
        $check = $db->Execute("select zone_id from " . TABLE_ZONES_TO_GEO_ZONES . " where geo_zone_id = '" . MODULE_SHIPPING_CELERE3_PICKUPPOINT_ZONE . "' and zone_country_id = '" . $order->delivery['country']['id'] . "' order by zone_id");
        while (!$check->EOF) {
          if ($check->fields['zone_id'] < 1) {
            $check_flag =  true;
            break;
          } elseif ($check->fields['zone_id'] == $order->delivery['zone_id']) {
            $check_flag = true;
            break;
          }
          $check->MoveNext();
        }

        if ($check_flag == false) {
          $this->enabled = false;
        }
      }
 //     if (($this->enabled == true) && (IS_ADMIN_FLAG === false && $_SESSION['cart']->weight > 30)) $this->enabled = false;
    }

// class methods
    function quote($method = '') {
      global $order;

      $this->quotes = array('id' => $this->code,
                            'module' => MODULE_SHIPPING_CELERE3_PICKUPPOINT_TEXT_TITLE,
                            'methods' => array(array('id' => $this->code,
                                                     'title' => MODULE_SHIPPING_CELERE3_PICKUPPOINT_TEXT_WAY,
                                                     'cost' => MODULE_SHIPPING_CELERE3_PICKUPPOINT_COST)));
      if ($this->tax_class > 0) {
        $this->quotes['tax'] = zen_get_tax_rate($this->tax_class, $order->delivery['country']['id'], $order->delivery['zone_id']);
      }

      if (zen_not_null($this->icon)) $this->quotes['icon'] = zen_image($this->icon, $this->title);

      return $this->quotes;
    }

    function check() {
      global $db;
      if (!isset($this->_check)) {
        $check_query = $db->Execute("select configuration_value from " . TABLE_CONFIGURATION . " where configuration_key = 'MODULE_SHIPPING_CELERE3_PICKUPPOINT_STATUS'");
        $this->_check = $check_query->RecordCount();
      }
      return $this->_check;
    }

    function install() {
      global $db;
      $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, date_added) values ('Abilita la spedizione PickUpPoin via Paccocelere 3', 'MODULE_SHIPPING_CELERE3_PICKUPPOINT_STATUS', 'True', 'Abilitare la spedizione PickUpPoint via Paccocelere 3?', '6', '0', 'zen_cfg_select_option(array(\'True\', \'False\'), ', now())");
      $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, date_added) values ('Costo di Spedizione', 'MODULE_SHIPPING_CELERE3_PICKUPPOINT_COST', '7.74', 'Spese di Spedizione per PickUpPoint Paccocelere 3 fino a 30 KG.', '6', '0', now())");
      $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, use_function, set_function, date_added) values ('Classe IVA', 'MODULE_SHIPPING_CELERE3_PICKUPPOINT_TAX_CLASS', '0', 'Applica la seguente aliquota IVA ai costi di spedizione.', '6', '0', 'zen_get_tax_class_title', 'zen_cfg_pull_down_tax_classes(', now())");
      $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, date_added) values ('Base di Tassa', 'MODULE_SHIPPING_CELERE3_PICKUPPOINT_TAX_BASIS', 'Shipping', 'Su quali basi vengono calcolate le Tasse sulle Spese di Spedizione.  Le opzioni sono:<br />Shipping - Basata sull\'indirizzo di Spedizione del Cliente<br />Billing - Basata sull\'indirizzo di Fatturazione del Cliente<br />Store - Basata sull\'indirizzo del Negozio se la Zona di Fatturazione/Spedizione &egrave; uguale alla Zona del Negozio', '6', '0', 'zen_cfg_select_option(array(\'Shipping\', \'Billing\', \'Store\'), ', now())");
      $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, use_function, set_function, date_added) values ('Zona di Spedizione', 'MODULE_SHIPPING_CELERE3_PICKUPPOINT_ZONE', '0', 'Se viene selezionata una Zona, il metodo di spedizione viene abilitato solo per la Zona indicata.', '6', '0', 'zen_get_zone_class_title', 'zen_cfg_pull_down_zone_classes(', now())");
      $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, date_added) values ('Ordine di Visualizzazione', 'MODULE_SHIPPING_CELERE3_PICKUPPOINT_SORT_ORDER', '0', 'Ordine di Visualizzazione.', '6', '0', now())");
    }

    function remove() {
      global $db;
      $db->Execute("delete from " . TABLE_CONFIGURATION . " where configuration_key like 'MODULE\_SHIPPING\_CELERE3\_PICKUPPOINT\_%'");
    }

    function keys() {
      return array('MODULE_SHIPPING_CELERE3_PICKUPPOINT_STATUS', 'MODULE_SHIPPING_CELERE3_PICKUPPOINT_COST', 'MODULE_SHIPPING_CELERE3_PICKUPPOINT_TAX_CLASS', 'MODULE_SHIPPING_CELERE3_PICKUPPOINT_TAX_BASIS', 'MODULE_SHIPPING_CELERE3_PICKUPPOINT_ZONE', 'MODULE_SHIPPING_CELERE3_PICKUPPOINT_SORT_ORDER');
    }
  }
?> 

It works without problemas but, given that this module has a cost for the user, what I want is to either:
Show this module only when the cart is free shipping (for any reason)
or better
show this module with a higher cost when the cart is not free shipping.
Can someone help with this?
Thanks
ciao from Italy
enzo

[enzo-ita]

Hi, I have mod the file again so taht now it created when installed the field MODULE_SHIPPING_CELERE3_PICKUPPOINT_COST_1 which will bear a different cost from MODULE_SHIPPING_CELERE3_PICKUPPOINT_COST
Now I need help in understanding how to change the cod in this area

// class methods
    function quote($method = '') {
      global $order;

      $this->quotes = array('id' => $this->code,
                            'module' => MODULE_SHIPPING_CELERE3_PICKUPPOINT_TEXT_TITLE,
                            'methods' => array(array('id' => $this->code,
                                                     'title' => MODULE_SHIPPING_CELERE3_PICKUPPOINT_TEXT_WAY,
                                                     'cost' => MODULE_SHIPPING_CELERE3_PICKUPPOINT_COST))); 

The mod should simply check the cart and

if ($free_ship_on == 'true') 

it should use the value contained in MODULE_SHIPPING_CELERE3_PICKUPPOINT_COST_1 instead.
Can someone help me?
I know it should not be difficult, but I do not know how to do it.
Thanks again.
Ciao from Italy
enzo

[Ajeh]

Could you zip both of your files for this so we can try it?

[enzo-ita]

Dear Linda,
thanks for answering.
You are always precious.
Are you coming to Italy soon?
Attached the files you required.
Ciao From Italy.
enzo
pickuppoint.zip
P.S. Please notice that the orginal title of the post does not reflect the actual objective. Now I want to show a different price for this module depending on the shipping cart status (free shipping or not)

[Ajeh]

Let's get specific and do some baby steps ...

Is your definition of Free Shipping defined as 0 weight or Always Free Shipping of *every* Product in the cart?

If the cart is Free Shipping, should this module show?

If the cart is NOT Free Shipping should this module show?

[enzo-ita]

A cart is free shipping when:
A minimum value of order is met
or
A product in the cart is always free shipping
or
A mix of always free shipping and not always free shipping products is in the cart even if the minimum order value is not met.

If the cart is free shipping the module is shown at xxx fee (MODULE_SHIPPING_CELERE3_PICKUPPOINT_COST)
If the cart is not free shipping the module is show at yyy fee (MODULE_SHIPPING_CELERE3_PICKUPPOINT_COST_1)

The free shipping module will be shown together with this module if the cart is free shipping, and the customer will have the possibility to choose this module instead of the free one. It will be possible to choose other shipping options.
The free shipping module will NOT be shown together with this module if the cart is free shipping, and the customer will have the possibility to choose this module instead of the other modules shown.
Thanks

[Ajeh]

Is this closer to what you are trying to do?