A client has a custom shipping module in Zen Cart 1.5. Yesterday I adapted the module to be zone-aware (they wanted the original module to apply to the USA, and a copy to be tweaked for non-USA orders).
Now I only have one shipping option in that module, not the configured four. The zone awareness seems to be working (my test orders show the USA fee, not the international fee, for the option that shows) but only the first option shows up.
Here's the code of the module:
/*include functions/functions_categories.pnp for zen_product_in_category method
*/
class tfn
{
var $code, $title, $description, $icon, $enabled, $types;
// class constructor
function tfn() {
global $order, $db, $types, $fees;
$this->code = 'tfn';
$this->title = MODULE_SHIPPING_TFN_TEXT_TITLE;
$this->description = MODULE_SHIPPING_TFN_TEXT_DESCRIPTION;
$this->sort_order = MODULE_SHIPPING_TFN_SORT_ORDER;
$this->icon = '';
$this->tax_class = MODULE_SHIPPING_TFN_TAX_CLASS;
$this->tax_basis = MODULE_SHIPPING_TFN_TAX_BASIS;
// disable only when entire cart is free shipping
if (zen_get_shipping_enabled($this->code)) {
$this->enabled = ((MODULE_SHIPPING_TFN_STATUS == 'True') ? true : false);
}
if (($this->enabled == true) && ((int)MODULE_SHIPPING_TFN_ZONE > 0)) {
$check_flag = false;
$check = $db->Execute("select zone_id from " . TABLE_ZONES_TO_GEO_ZONES . " where geo_zone_id = '" . MODULE_SHIPPING_TFN_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;
}
}
$types = array(
'STD' => 'Standard',
'FXH' => 'USPS Priority Mail',
'FXES' => 'USPS Express Mail',
'FXSO' => 'FedEx Overnight'
);
// 'FAM' => 'Foreign Airmail',
// 'FXG' => 'USPS Priority Mail with Delivery Confirmation',
// 'FX2D' => 'FedEx 2nd Day',
$fees = array(
'STD' => '0.00',
'FXH' => '4.50',
'FXES' => '17.50',
'FXSO' => '28.00'
);
// 'FAM' => '15.00',
// 'FXG' => '5.50',
// 'FX2D' => '10.00',
}
// class methods
function quote($method = '') {
global $order, $types, $fees;
$methods = array();
$this->quotes = array(
'id' => $this->code,
'module' => $this->title
);
if (($method == '') || (!isset($method))) {
foreach ($fees as $type => $cost) {
$methods[] = array(
'id' => $type,
'title' => $types[$type],
'cost' => $this->_calculateBaseCost() + $cost
);
}
} else {
$cost = $fees[$method];
$methods[] = array(
'id' => $method,
'title' => $types[$method],
'cost' => $this->_calculateBaseCost() + $cost
);
}
$this->quotes['methods'] = $methods;
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 _calculateBaseCost() {
global $db, $shipping_cost;
$total_count = $_SESSION['cart']->count_contents();
$total_count = $total_count - $_SESSION['cart']->free_shipping_items();
$foreign_charge = $this->_additionalForeignCharge();
$shipping_cost = ($total_count * (MODULE_SHIPPING_TFN_BASE_COST + $foreign_charge));
return $shipping_cost;
}
function _additionalForeignCharge() {
global $db, $order;
$foreign_charge = 0;
$dest_country = $order->delivery['country']['iso_code_2'];
if ($dest_country != 'US') {
$foreign_charge = MODULE_SHIPPING_TFN_FOREIGN_COST;
}
return $foreign_charge;
}
function check() {
global $db;
if (!isset($this->_check)) {
$check_query = $db->Execute("select configuration_value from " . TABLE_CONFIGURATION . " where configuration_key = 'MODULE_SHIPPING_TFN_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 ('Enable Item Shipping', 'MODULE_SHIPPING_TFN_STATUS', 'True', 'Do you want to offer per item 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 ('Shipping Cost', 'MODULE_SHIPPING_TFN_BASE_COST', '2.50', 'The shipping cost will be multiplied by the number of items in an order that uses 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, date_added) values ('Additional Foreign Shipping Cost', 'MODULE_SHIPPING_TFN_FOREIGN_COST', '4.00', 'The additional foreign shipping cost will be multiplied by the number of items and added to the base cost.', '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_TFN_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_TFN_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\', \'Store\'), ', 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_TFN_SORT_ORDER', '0', 'Sort order of display.', '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 ('Sort Order', 'MODULE_SHIPPING_TFN_SHIPPING_TYPES', '0', 'Code and Name for each kind of shipping offered.', '6', '0', 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 ( 'Shipping Methods: <br />Standard, Foreign Airmail, FedEx Home Delivery, FedEx Ground, FedEx Express Saver, FedEx 2nd Day, FedEx Standard Overnight', 'MODULE_SHIPPING_TFN_TYPES', 'STD, FAM, FXHD, FXG, FXES, FX2D, FXSO', 'Select the TFN services to be offered.', '6', '13', 'zen_cfg_select_multioption(array(\'STD\',\'FAM\',\'FXHD\', \'FXG\', \'FXES\', \'FX2D\', \'FXSO\'), ', 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_TFN_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())");
}
function remove() {
global $db;
$db->Execute("delete from " . TABLE_CONFIGURATION . " where configuration_key in ('" . implode("', '", $this->keys()) . "')");
}
function keys() {
return array(
'MODULE_SHIPPING_TFN_STATUS', 'MODULE_SHIPPING_TFN_BASE_COST',
'MODULE_SHIPPING_TFN_FOREIGN_COST', 'MODULE_SHIPPING_TFN_TAX_CLASS',
'MODULE_SHIPPING_TFN_TAX_BASIS', 'MODULE_SHIPPING_TFN_SORT_ORDER',
'MODULE_SHIPPING_TFN_TYPES', 'MODULE_SHIPPING_TFN_ZONE'
);
}
}
?>
The admin page shows eight shipping options, with the four listed in the code selected.
Here's the relevant database entries, including the international module:
mysql> select configuration_value, configuration_key from configuration where configuration_key LIKE 'MODULE_SHIPPING_%_TYPES';
+-----------------------+----------------------------------------+
| configuration_value | configuration_key |
+-----------------------+----------------------------------------+
| 0 | MODULE_SHIPPING_TFN_INT_SHIPPING_TYPES |
| STD | MODULE_SHIPPING_TFN_INT_TYPES |
| 0 | MODULE_SHIPPING_TFN_SHIPPING_TYPES |
| STD, FXHD, FXES, FXSO | MODULE_SHIPPING_TFN_TYPES |
+-----------------------+----------------------------------------+
4 rows in set (0.00 sec)
Updating the _SHIPPING_TYPES settings directly in the database (e.g. setting it to 1 instead of 0) doesn't seem to change anything. I can't find any code which seems to call this setting.
Where is Zen Cart determining the shipping options? How can I make it show the ones I want?
$types
and$fees
arrays. – Lagan