X-Cart forums

[stanlee]

In case someone is having the same problem I did after upgrading to 4.1.8, here's the solution:
The sql patch that comes with the upgrade will wipe out FREEOVERX from the shipping table in the database (if you used 150 as your "shippingid").
Simply reinsert the line with a different shippingid, the original 103 will work.
Of course the database has changed since the mod was posted, so you'll need a line like this one:

INSERT INTO xcart_shipping VALUES (103, 'Free Shipping - Orders Over $99', '', 'L', 'FREEOVERX', '201', 5, 'Y', '', 0.00, 0.00, 0, '', '');

Hope this will save some time for someone. It took me a while to figure it out...

[hhiker]

Ok, I got the updated sql patch installed. I did nothing to myshipper.php since it has the lines:

foreach ($ship_mods as $ship_mod) {
if (file_exists($xcart_dir."/shipping/mod_".$ship_mod.".php"))
include_once $xcart_dir."/shipping/mod_".$ship_mod.".php";
$func_ship = "func_shipper_".$ship_mod;
if (function_exists($func_ship))
$func_ship($weight, $userinfo, $debug, $cart);
}
if ($ups_rates_only) {
$tmp_rates = $intershipper_rates;
$intershipper_rates = array();
foreach ($alt_ship_mods as $alt_ship_mod) {
if (file_exists($xcart_dir."/shipping/mod_".$alt_ship_mod.".php"))
include_once $xcart_dir."/shipping/mod_".$alt_ship_mod.".php";
$func_ship = "func_shipper_".$alt_ship_mod;
if (function_exists($func_ship))
$func_ship($weight, $userinfo, $debug, $cart);
}
if (empty($intershipper_rates)) {
$empty_other_carriers = "Y";
}
$intershipper_rates = $tmp_rates;
}

I have tried the original mod_CUSTOM.php code, I have tried the code in post 80 as well. Nothing seems to be working. Luckily, I have a testing playground installed that mirrors the live site.

Any help would be appreciated.

Thanks!!!

[levo]

Extended 'FreeOverX' shipping module:
-----------------------------------------------

First and foremost, I'd like to thank the original creator of the 'FreeOverX' mod and everyone else who has helped - , it is the starting point for the extensions I've detailed below. In short, one creates a new real-time shipping method and sets a threshold amount for a customer's order over which free shipping is given.

Additions:

- It is configurable via the admin back-end. It shows up in the Modules area as 'FreeOverX_Shipping', and both the shipping method and the threshold amount can be configured via the backend as well.

- This mod will properly display the FreeOverX threshold amount and the shipping method on order invoices, rather than displaying the current freeoverx settings even on past invoices.

I hope some of you find this useful - I've learned a lot from reading these forums and wanted to offer my contribution. This is my first post, and I've tried to be as thorough as possible, but any suggestions are welcome.

Thanks - Nate


Part 1 - The base FreeOverX code mods
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

NOTE: I began working on this in version 4.1.7 and have it successfully working in v4.1.9 as of now - I have not tested other configurations.

Without going into too much detail here, the original implementation requires adding a file under <x-cart root>/shipping called mod_CUSTOM.php. In the same directory a file called 'myshipper.php' needs a couple of changes. Following is my 'mod_CUSTOM.php' and the edited part of 'myshipper.php'. I'll follow up with the requisite DB changes since mine also vary from the original.

* ./shipping/mod_CUSTOM.php follows:

<?php

// Custom shipping methods
// Get the 'FreeOverX' threshold value from the field 'freeoverx_shipping_x' in the 'xcart_config' table...

if ( !defined('XCART_SESSION_START') ) { header("Location: ../"); die("Access denied"); }
global $products, $cart, $userinfo, $current_area, $login;

$fsconf = func_query_first("SELECT value FROM $sql_tbl[config] WHERE name = 'freeoverx_shipping_x'");
if ($fsconf) $freeOverAmount = $fsconf['value'];

// Make sure this shipping method is available
foreach ($allowed_shipping_methods as $key=>$value)
if ($value["code"] == "FREEOVERX")
$FREEOVERX_FOUND = true;

if ($FREEOVERX_FOUND)
{
$tempcart = func_calculate($cart, $products, $login, $current_area);
$row = func_query_first("SELECT shippingid, subcode FROM $sql_tbl[shipping] WHERE code='FREEOVERX' AND active='Y'");
if ($row && ($tempcart["subtotal"]>= $freeOverAmount))
{
$rate = 0;
$intershipper_rates[] = array("methodid" => $row['subcode'], "rate" => $rate);
}
}

// Use if national shipping is not working right:
// if ($userinfo["s_country"]=="US" && is_numeric($zp3))
// ...

?>


* modify ./shipping/myshipper.php as follows:

#
# Shipping modules depend on XML parser (EXPAT extension)
#
if (test_expat() != "") {
// if ($ups_rates_only) {
$ship_mods[] = "UPS";

$alt_ship_mods[] = "USPS";
$alt_ship_mods[] = "CPC";
$alt_ship_mods[] = "ARB";
$alt_ship_mods[] = "DHL";
$alt_ship_mods[] = "CUSTOM";
if ($fedex_mod == 'FEDEX_direct')
$alt_ship_mods[] = $fedex_mod;
// } else {
$ship_mods[] = "USPS";
$ship_mods[] = "CPC";
$ship_mods[] = "ARB";
$ship_mods[] = "DHL";
$ship_mods[] = "CUSTOM";
if ($fedex_mod == 'FEDEX_direct')
$ship_mods[] = $fedex_mod;
// }
}

(basically, just comment out the three lines indicated...)


Part 2 - Database modifications
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

First we'll need to insert a few records into the database and a minor alteration of one table. The following SQL script can be run from the command line as follows:

mysql -u <username> -p <dbname> < freeoverx_shipping.sql > sql.out

(see the output file 'sql.out' to check for any errors)

/*
* BEGIN FREEOVERX SHIPPING MODULE SQL SCRIPT
*
* The following alteration is needed to display the correct shipping
* method/order cost threshold on invoices, because by default x-cart
* looks up the shipping type in the shipping table, which won't work
* for us because this data can change. So to retain that historical
* data we need this db alteration - and the associated order insert
* SQL, which I'll cover later.
*/

ALTER TABLE xcart_orders ADD freeoverx_shipping_method VARCHAR(128) NULL AFTER shippingid;

/*
* Add the following records to the table 'xcart_config'. These will
* be modifiable in the administrative back-end at:
* Modules :: FreeOverX_Shipping :: Configure
* Note that that second insert (freeoverx_shipping_method) creates
* a pulldown menu in the admin area where you will choose the shipping
* method that you will use for orders that meet the minimum order
* threshold (freeoverx_shipping_x). Thus you'll need to customize the
* selector variants according to the methods you intend to use (see
* the 'shipping' table for the appropriate shippingid/shipping fields).
*/

INSERT INTO xcart_config VALUES ('freeoverx_shipping_x', 'The value of \'x\' in the FreeOverX shipping module.', '200', 'FreeOverX_Shipping', 0, 'numeric', '0', '');
INSERT INTO xcart_config VALUES ('freeoverx_shipping_method', 'The shipping method to be used in the FreeOverX shipping module.', '23', 'FreeOverX_Shipping', 20, 'selector', '1', '1:UPS Ground\n2:UPS 2nd Day Air\n23:UPS 3 Day Select\n20:UPS Next Day Air\n65:UPS Standard');

/*
* Add the following record to the table 'xcart_modules':
*/

INSERT INTO xcart_modules VALUES ('', 'FreeOverX_Shipping', 'Free shipping for orders over $x.', 'Y');

/*
* Add the following record to the table 'xcart_shipping':
* This code is from the original 'FreeOverX' shipping mod.
* Again, I am very grateful for his
* contribution as it is the foundation for this extended mod.
*/

INSERT INTO xcart_shipping VALUES (333,'Free shipping for orders over $x','','L','FREEOVERX','333',689,'Y','','0.00','0. 00',0,'','');

/*
* NOTE :: It is very important that the shippingid is 333, because
* several other parts of the code depend on it. If you do use a
* different value, be aware that you'll need to make the appropriate
* changes elsewhere.
*
* END FREEOVERX SHIPPING MODULE SQL SCRIPT
*/


* add the following to ./admin/modules.php:

approx. lines 54-55:

# nth :: disable FreeOverX_Shipping module by default
db_query("update $sql_tbl[shipping] set active='N' where shippingid = 333");

approx. lines 71-74:

# nth :: enable FreeOverX_Shipping module if checked on modules admin form
} elseif ($module_name == "FreeOverX_Shipping") {
db_query("update $sql_tbl[shipping] set active = 'Y' where shippingid = 333");


* ./admin/configuration.php should be modified as follows at line 167 (approx):

if (!empty($active_modules['FreeOverX_Shipping'])) {
include $xcart_dir."/modules/FreeOverX_Shipping/admin_config.php";
}


* Create the file ./modules/FreeOverX_Shipping/admin_config.php (you'll need to
create the 'FreeOverX_Shipping' directory first):

<?php

/**
* Filename: $xcart_dir/modules/FreeOverX_Shipping/admin_config.php
* Author: Nathan T. Harper <n_harper@ameritech.net>
* Created: 24 November 2007
* Last modified: 24 November 2007
* Description: This gets included by $xcart_dir/admin/configuration.php if the 'FreeOverX_Shipping'
* module is enabled. If this module's config setting(s) are being altered, this code updates the
* 'shipping' field in the xcart_shipping table to reflect the updated free shipping threshold
* and/or shipping method.
*/

if (!defined('XCART_START')) { header("Location: ../../"); die("Access denied"); }

// process 'freeoverx_shipping_x' and 'freeoverx_shipping_method' configuration options...
if (!empty($active_modules['FreeOverX_Shipping'])) {
if ((!empty($HTTP_POST_VARS['freeoverx_shipping_x'])) || (!empty($HTTP_POST_VARS['freeoverx_shipping_method']))) {
$new_shippingid = $HTTP_POST_VARS['freeoverx_shipping_method'];
$new_freeoverx_shipping_x = $HTTP_POST_VARS['freeoverx_shipping_x'];
$new_shipping_method = func_query_first_cell("SELECT shipping from $sql_tbl[shipping] WHERE shippingid = $new_shippingid");
$shipping_method_text = "Free " . $new_shipping_method . " shipping for orders over \$" . $new_freeoverx_shipping_x;
db_query("UPDATE $sql_tbl[shipping] SET shipping = '" . $shipping_method_text . "' WHERE shippingid = 333");
}
}

?>


* Modify the file ./include/func/func.order.php as follows (this will ensure that invoices show the FreeOverX shipping method/threshold correctly):

insert at approx lines 567-570:

// nth :: special case for freeoverx shipping...
if ($cart['shippingid'] == 333) {
$current_order['freeoverx_shipping_method'] = func_query_first_cell("SELECT shipping from $sql_tbl[shipping] WHERE shippingid = 333");
}

and insert the following at approx. line 585:

'freeoverx_shipping_method' => $current_order['freeoverx_shipping_method'],


* change ./skin1/main/order_info.tpl (approx. lines 163-175) to:

<tr>
<td valign="top">{$lng.lbl_delivery}</td>
<td valign="top">
{* nth :: if 'freeoverx' shipping method was used, display the 'freeoverx_shipping_method' field from the orders table *}
{if $order.freeoverx_shipping_method ne ''}
<span style="color: red;">{$order.freeoverx_shipping_method|trademark} </span>
{else}
{$order.shipping|trademark}
{/if}
{if $order.extra.shipping_warning ne ''}<br /><font class="ErrorMessage">{$order.extra.shipping_warnin g}</font>{/if}
{if $order.extra.dhl_ext_country}<br />{$lng.lbl_dhl_ext_country}: {$order.extra.dhl_ext_country}{/if}
</td>
</tr>


(continued in the next post)

-Nate

[levo]

... continued from my previous post, this is the rest of the 'extended FreeOverX shipping module'. - Nate

+++++

* modify ./skin1/modules/Fast_Lane_Checkout/shipping_methods.tpl beginning at approx. line 64 and through the closing 'if' after the </table>: (the whole block occupies approx. line 64-95)

{* nth :: loop through shipping opt and see if freeoverx is enabled *}
{foreach from=$shipping item=sm}
{if $sm.shippingid eq 333}{assign var=freeoverx_enabled value=1}{/if}
{/foreach}

{if $login ne "" || $config.General.apply_default_country eq "Y" || $cart.shipping_cost gt 0}
{foreach from=$shipping item=s}

{if (($s.shippingid eq 333) and ($freeoverx_enabled eq 1))}
{assign var=checked value="checked"}
{elseif (($s.shippingid eq $cart.shippingid) and ($freeoverx_enabled ne 1))}
{assign var=checked value="checked"}
{else}
{assign var=checked value=""}
{/if}

{if (($freeoverx_enabled ne 1) || ($config.FreeOverX_Shipping.freeoverx_shipping_met hod ne $s.shippingid))}
<table cellpadding="1" cellspacing="0" width="100%"{cycle values=" class='TableSubHead', "}>
<tr>

<td width="5"><input type="radio" id="shippingid{$s.shippingid}" name="shippingid" value="{$s.shippingid}" {$checked} {if $allow_cod} onclick="javascript: display_cod({if $s.is_cod eq 'Y'}true{else}false{/if});"{/if} /></td>
<td><label for="shippingid{$s.shippingid}">{if $s.shippingid eq 333}<span style="color: red;">{/if}{$s.shipping|trademark:$insert_trademark}{if $s.shippingid eq 333}</span>{/if}{if $s.shipping_time ne ""} - {$s.shipping_time}{/if}{if $config.Appearance.display_shipping_cost eq "Y" and ($login ne "" or $config.General.apply_default_country eq "Y" or $cart.shipping_cost gt 0)} ({include file="currency.tpl" value=$s.rate}){/if}</label></td>
</tr>
{if $s.warning ne ""}
<tr>
<td>&nbsp;</td>
<td class="{if $s.shippingid eq $cart.shippingid}ErrorMessage{else}SmallText{/if}">{$s.warning}</td>
</tr>
{/if}
</table>
{/if}
{/foreach}


* As I'm running v4.1.9 I applied the 'no shipping methods available for your location' patch that thankfully appeared on the forums yesterday...


* The following 'order by shipping cost ascending' modification comes from another recent post - Thanks!!!

change ./shipping/shipping.php at approx. line 288 as follows:
first comment out the two lines shown below and replace with the following code:

// if (is_array($shipping)) {
// $tmp_cart = $cart;

function sort_shipping($a, $b) {
return $a["rate"] - $b["rate"];
}

if (is_array($shipping)) {
usort($shipping, "sort_shipping");
$tmp_cart = $cart;


* To get the shipping methods to appear together without the annoying 'other carriers' selection...

at approx. line 212 (also in ./shipping/shipping.php) change the show_carriers_selector var from 'Y' to 'N':

$smarty->assign("show_carriers_selector", "N");


Thanks again to everyone out there.

Regards,

Nate

[DataViking]

thank you i will try it out

[hhiker]

Ok, this is great. I am working hard to understand what you are saying but your instructions are hard to follow. What do I put the following after? I have no clue what your lines look like & it makes no sense for me to put this in the middle of my line numbers.

* Modify the file ./include/func/func.order.php as follows (this will ensure that invoices show the FreeOverX shipping method/threshold correctly):

insert at approx lines 567-570:

// nth :: special case for freeoverx shipping...
if ($cart['shippingid'] == 333) {
$current_order['freeoverx_shipping_method'] = func_query_first_cell("SELECT shipping from $sql_tbl[shipping] WHERE shippingid = 333");
}

and insert the following at approx. line 585:

'freeoverx_shipping_method' => $current_order['freeoverx_shipping_method'],

[levo]

Hi,

Yes, the line numbers I gave were based on unmodified 4.1.9 code, which doesn't help when the code has been customized previously, so I'll be sure to be more clear in the future - thanks for the feedback. Here's the code in better context for the file:

'./include/func/func.order.php':


// added by nth 24nov2007 :: special case for freeoverx shipping...
if ($cart['shippingid'] == 333) {
$current_order['freeoverx_shipping_method'] = func_query_first_cell("SELECT shipping from $sql_tbl[shipping] WHERE shippingid = 333");
}

#
# Insert into orders
#
$insert_data = array (
'login' => addslashes($userinfo['login']),
'membershipid' => $userinfo['membershipid'],
'membership' => addslashes($userinfo['membership']),
'total' => $current_order['total_cost'],
'giftcert_discount' => $giftcert_discount,
'giftcert_ids' => @$giftcert_str,
'subtotal' => $current_order['subtotal'],
'shipping_cost' => $current_order['shipping_cost'],
'shippingid' => $cart['shippingid'],
'freeoverx_shipping_method' => $current_order['freeoverx_shipping_method'],
'tax' => $current_order['tax_cost'],
'taxes_applied' => $taxes_applied,
'discount' => $current_order['discount'],
'coupon' => addslashes(@$current_order['coupon']),
'coupon_discount' => $current_order['coupon_discount'],
'date' => time(),
'status' => $order_status,
'payment_method' => addslashes($payment_method),
'paymentid' => $cart['paymentid'],
'payment_surcharge' => $current_order['payment_surcharge'],
'flag' => 'N',
'details' => addslashes(text_crypt($order_details)),
'customer_notes' => $customer_notes,
'clickid' => $partner_clickid,
'language' => $userinfo['language'],
'extra' => addslashes(serialize($_extra)));



I'll work on clarifying the other parts this evening so there won't be dependencies on the base 4.1.9 code's line numbers and post that asap, and I'll try to help in any way I can if you run into any other problems with the mod.

Regards,

Nate

[hhiker]

Thanks so much. If you will bear with me on getting through this & helping me figure out where it all goes, I will create a new post that lays it out better. I am running 4.1.8 right now on this site and am dreading upgrading b/c I know I will have to manually modify a lot of it. Probably be after the first of the year since we are in the middle of the Christmas shopping season.

I can not wait to get it installed!!! This is one that is long over due for x-cart and I appreciate all those who contributed to getting it working.

[hhiker]

Ok, I am going back to look at things. What I have happening is that it will now not show any shipping options. However, after I select the payment method, it will show UPS Ground and is still calculating shipping for orders over $100. And, if I click on the link on the review order page that says UPS Ground in there, it takes me back to the previous page where I generally select shipping & payment methods but I can not change from UPS Ground.

I have done a lot of modifications to this and I am sure somewhere in there that has to do with it so I am going back to the drawing board

We ship USPS, FedEx, and UPS Ground so we need all options and also the option for them to upgrade service.

I did install the mod that makes the drop down box go away and gives you all your shipping options right there with radial buttons. I am going to remove that and see if that is where the conflict is but I don't think it is.

Long day, lots of interruptions, brain not functioning anymore.

[hhiker]

Ok, I am going back to the original files I had in here, without the other mod, and see if I can get this one to work first, then install the other. I am wondering if I did not botch something up by mistake.

Thank goodness for backups!!!