<?php
/**
* ot_coupon order-total module
*
* @package orderTotal
* @copyright Copyright 2003-2010 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: ot_coupon.php 16819 2010-06-30 22:39:54Z wilt $
*/
/**
* Order Total class to handle discount coupons
*
*/
class ot_coupon {
/**
* coupon title
*
* @var unknown_type
*/
var $title;
/**
* Output used on checkout pages
*
* @var unknown_type
*/
var $output;
/**
* Enter description here...
*
* @return ot_coupon
*/
function ot_coupon() {
$this->code = 'ot_coupon';
$this->header = MODULE_ORDER_TOTAL_COUPON_HEADER;
$this->title = MODULE_ORDER_TOTAL_COUPON_TITLE;
$this->description = MODULE_ORDER_TOTAL_COUPON_DESCRIPTION;
$this->user_prompt = '';
$this->sort_order = MODULE_ORDER_TOTAL_COUPON_SORT_ORDER;
$this->include_shipping = MODULE_ORDER_TOTAL_COUPON_INC_SHIPPING;
$this->include_tax = MODULE_ORDER_TOTAL_COUPON_INC_TAX;
$this->calculate_tax = MODULE_ORDER_TOTAL_COUPON_CALC_TAX;
$this->tax_class = MODULE_ORDER_TOTAL_COUPON_TAX_CLASS;
$this->credit_class = true;
if (IS_ADMIN_FLAG === true) {
if ($this->include_tax == 'true' && $this->calculate_tax != "None") {
$this->title .= '<span class="alert">' . MODULE_ORDER_TOTAL_COUPON_INCLUDE_ERROR . '</span>';
}
}
}
/**
* Method used to produce final figures for deductions. This information is used to produce the output<br>
* shown on the checkout pages
*
*/
function process() {
$order_total = $this->get_order_total();
$od_amount = $this->calculate_deductions($order_total['total']);
$this->deduction = $od_amount['total'];
if ($od_amount['total'] > 0) {
reset($order->info['tax_groups']); $tax = 0;
while (list($key, $value) = each($order->info['tax_groups'])) { if ($od_amount['tax_groups'][$key]) {
$order->info['tax_groups'][$key] -= $od_amount['tax_groups'][$key];
$tax += $od_amount['tax_groups'][$key];
}
}
if ($od_amount['type'] == 'S') $order->info['shipping_cost'] = 0;
$order->info['total'] = $order->info['total'] - $od_amount['total'];
if (DISPLAY_PRICE_WITH_TAX != 'true') {
$order->info['total'] -= $tax;
}
$order->info['tax'] = $order->info['tax'] - $tax;
// if ($this->calculate_tax == "Standard") $order->info['total'] -= $tax;
if ($order->info['total'] < 0) $order->info['total'] = 0;
$this->output[] = array('title' => $this->title . ': ' . $this->coupon_code . ' :', 'text' => '-' . $currencies->format($od_amount['total']),
'value' => $od_amount['total']);
}
}
/**
* Enter description here...
*
* @return unknown
*/
function selection_test() {
return false;
}
/**
* Enter description here...
*
*/
function clear_posts() {
unset($_POST['dc_redeem_code']); unset($_SESSION['cc_id']); }
/**
* Enter description here...
*
* @param unknown_type $order_total
* @return unknown
*/
function pre_confirmation_check($order_total) {
$od_amount = $this->calculate_deductions($order_total);
// print_r($od_amount);
$order->info['total'] = $order->info['total'] - $od_amount['total'];
if (DISPLAY_PRICE_WITH_TAX != 'true') {
$order->info['total'] -= $tax;
}
return $od_amount['total'] + (DISPLAY_PRICE_WITH_TAX == 'true' ? 0 : $od_amount['tax']);
}
/**
* Enter description here...
*
* @return unknown
*/
function use_credit_amount() {
return false;
}
/**
* Enter description here...
*
* @return unknown
*/
function credit_selection() {
// note the placement of the redeem code can be moved within the array on the instructions or the title
$selection = array('id' => $this->code, 'module' => $this->title,
'redeem_instructions' => MODULE_ORDER_TOTAL_COUPON_REDEEM_INSTRUCTIONS . ($discount_coupon->fields['coupon_code'] != '' ? MODULE_ORDER_TOTAL_COUPON_REMOVE_INSTRUCTIONS : ''),
'fields' => array(array('title' => ($discount_coupon->fields['coupon_code'] != '' ? MODULE_ORDER_TOTAL_COUPON_TEXT_CURRENT_CODE
. '<a href="javascript:couponpopupWindow(\'' . zen_href_link(FILENAME_POPUP_COUPON_HELP, 'cID
=' . $_SESSION['cc_id
']) . '\
')">' . $discount_coupon->fields['coupon_code'] . '</a><br />' : '') . MODULE_ORDER_TOTAL_COUPON_TEXT_ENTER_CODE
, 'field' => zen_draw_input_field('dc_redeem_code', '', 'id="disc-' . $this->code . '" onkeyup="submitFunction(0,0)"'),
'tag' => 'disc-'.$this->code
)));
return $selection;
}
/**
* Enter description here...
*
*/
function collect_posts() {
global $db, $currencies, $messageStack, $order; // remove discount coupon by request
if (isset($_POST['dc_redeem_code']) && strtoupper($_POST['dc_redeem_code']) == 'REMOVE') { unset($_POST['dc_redeem_code']); unset($_SESSION['cc_id']); $messageStack->add_session('checkout_payment', TEXT_REMOVE_REDEEM_COUPON, 'caution');
}
// print_r($_SESSION);
// bof: Discount Coupon zoned always validate coupon for payment address changes
// eof: Discount Coupon zoned always validate coupon for payment address changes
if ((isset($_POST['dc_redeem_code']) && $_POST['dc_redeem_code'] != '') || (isset($discount_coupon->fields['coupon_code']) && $discount_coupon->fields['coupon_code'] != '')) { // set current Discount Coupon based on current or existing
if (isset($_POST['dc_redeem_code']) && $discount_coupon->fields['coupon_code'] == '') { $dc_check = $_POST['dc_redeem_code'];
} else {
$dc_check = $discount_coupon->fields['coupon_code'];
}
$sql = "select coupon_id, coupon_amount, coupon_type, coupon_minimum_order, uses_per_coupon, uses_per_user,
restrict_to_products, restrict_to_categories, coupon_zone_restriction
from " . TABLE_COUPONS . "
where coupon_code= :couponCodeEntered
and coupon_active='Y'";
$sql = $db->bindVars($sql, ':couponCodeEntered', $dc_check, 'string');
$coupon_result=$db->Execute($sql);
if ($coupon_result->fields['coupon_type'] != 'G') {
if ($coupon_result->RecordCount() < 1 ) {
$messageStack->add_session('redemptions', TEXT_INVALID_REDEEM_COUPON,'caution');
$this->clear_posts();
zen_redirect(zen_href_link(FILENAME_CHECKOUT_PAYMENT, '', 'SSL',true, false));
}
$order_total = $this->get_order_total();
// left for total order amount vs qualified order amount just switch the commented lines
// if ($order_total['totalFull'] < $coupon_result->fields['coupon_minimum_order']) {
if (strval($order_total['total']) < $coupon_result->fields['coupon_minimum_order']) {
$messageStack->add_session('redemptions', sprintf(TEXT_INVALID_REDEEM_COUPON_MINIMUM
, $currencies->format($coupon_result->fields['coupon_minimum_order'])),'caution'); $this->clear_posts();
zen_redirect(zen_href_link(FILENAME_CHECKOUT_PAYMENT, '', 'SSL',true, false));
}
// JTD - added missing code here to handle coupon product restrictions
// look through the items in the cart to see if this coupon is valid for any item in the cart
$products = $_SESSION['cart']->get_products();
$foundvalid = true;
if ($foundvalid == true) {
$foundvalid = false;
for ($i=0; $i<sizeof($products); $i++) {
if (is_product_valid($products[$i]['id'], $coupon_result->fields['coupon_id'])) {
$foundvalid = true;
continue;
}
}
}
if (!$foundvalid) {
$this->clear_posts();
}
if (!$foundvalid) zen_redirect
(zen_href_link
(FILENAME_CHECKOUT_PAYMENT
, 'credit_class_error_code=' . $this->code . '&credit_class_error=' . urlencode(TEXT_INVALID_COUPON_PRODUCT
. ' ' . $dc_check), 'SSL',true, false)); // JTD - end of additions of missing code to handle coupon product restrictions
$date_query=$db->Execute("select coupon_start_date from " . TABLE_COUPONS . "
where coupon_start_date <= now() and
coupon_code='" . zen_db_prepare_input($dc_check) . "'");
if ($date_query->RecordCount() < 1 ) {
$messageStack->add_session('redemptions', TEXT_INVALID_STARTDATE_COUPON,'caution');
$this->clear_posts();
zen_redirect(zen_href_link(FILENAME_CHECKOUT_PAYMENT, '', 'SSL', true, false));
}
$date_query=$db->Execute("select coupon_expire_date from " . TABLE_COUPONS . "
where coupon_expire_date >= now() and
coupon_code='" . zen_db_prepare_input($dc_check) . "'");
if ($date_query->RecordCount() < 1 ) {
$messageStack->add_session('redemptions', TEXT_INVALID_FINISHDATE_COUPON,'caution');
$this->clear_posts();
zen_redirect(zen_href_link(FILENAME_CHECKOUT_PAYMENT, '', 'SSL', true, false));
}
$coupon_count = $db->Execute("select coupon_id from " . TABLE_COUPON_REDEEM_TRACK . "
where coupon_id = '" . (int)$coupon_result->fields['coupon_id']."'");
$coupon_count_customer = $db->Execute("select coupon_id from " . TABLE_COUPON_REDEEM_TRACK . "
where coupon_id = '" . $coupon_result->fields['coupon_id']."' and
customer_id = '" . (int)$_SESSION['customer_id'] . "'");
if ($coupon_count->RecordCount() >= $coupon_result->fields['uses_per_coupon'] && $coupon_result->fields['uses_per_coupon'] > 0) {
$messageStack->add_session('redemptions', TEXT_INVALID_USES_COUPON . $coupon_result->fields['uses_per_coupon'] . TIMES ,'caution');
$this->clear_posts();
zen_redirect(zen_href_link(FILENAME_CHECKOUT_PAYMENT, '', 'SSL', true, false));
}
if ($coupon_count_customer->RecordCount() >= $coupon_result->fields['uses_per_user'] && $coupon_result->fields['uses_per_user'] > 0) {
$messageStack->add_session('redemptions', sprintf(TEXT_INVALID_USES_USER_COUPON
, $dc_check) . $coupon_result->fields['uses_per_user'] . ($coupon_result->fields['uses_per_user'] == 1 ?
TIME : TIMES
) ,'caution'); $this->clear_posts();
zen_redirect(zen_href_link(FILENAME_CHECKOUT_PAYMENT, '', 'SSL', true, false));
}
$_SESSION['cc_id'] = $coupon_result->fields['coupon_id'];
if ($_SESSION['cc_id'] > 0) {
$sql = "select coupon_id, coupon_amount, coupon_type, coupon_minimum_order, uses_per_coupon, uses_per_user,
restrict_to_products, restrict_to_categories, coupon_zone_restriction, coupon_code
from " . TABLE_COUPONS . "
where coupon_id= :couponIDEntered
and coupon_active='Y'";
$sql = $db->bindVars($sql, ':couponIDEntered', $_SESSION['cc_id'], 'string');
$coupon_result=$db->Execute($sql);
$foundvalid = true;
$check_flag = false;
// base restrictions zone restrictions for Delivery or Billing address
switch($coupon_result->fields['coupon_type']) {
case 'S': // shipping
// use delivery address
$check_zone_country_id = $order->delivery['country']['id'];
break;
case 'F': // amount
// use billing address
$check_zone_country_id = $order->billing['country']['id'];
break;
case 'P': // percentage
// use billing address
$check_zone_country_id = $order->billing['country']['id'];
break;
default:
// use billing address
$check_zone_country_id = $order->billing['country']['id'];
break;
}
// $sql = "select zone_id, zone_country_id from " . TABLE_ZONES_TO_GEO_ZONES . " where geo_zone_id = '" . $coupon_result->fields['coupon_zone_restriction'] . "' and zone_country_id = '" . $order->billing['country']['id'] . "' order by zone_id";
$sql = "select zone_id, zone_country_id from " . TABLE_ZONES_TO_GEO_ZONES . " where geo_zone_id = '" . $coupon_result->fields['coupon_zone_restriction'] . "' and zone_country_id = '" . $check_zone_country_id . "' order by zone_id";
$check = $db->Execute($sql);
// base restrictions zone restrictions for Delivery or Billing address
switch($coupon_result->fields['coupon_type']) {
case 'S': // shipping
// use delivery address
$check_zone_id = $order->delivery['zone_id'];
break;
case 'F': // amount
// use billing address
$check_zone_id = $order->billing['zone_id'];
break;
case 'P': // percentage
// use billing address
$check_zone_id = $order->billing['zone_id'];
break;
default:
// use billing address
$check_zone_id = $order->billing['zone_id'];
break;
}
if ($coupon_result->fields['coupon_zone_restriction'] > 0) {
while (!$check->EOF) {
if ($check->fields['zone_id'] < 1) {
$check_flag = true;
break;
// } elseif ($check->fields['zone_id'] == $order->billing['zone_id']) {
} elseif ($check->fields['zone_id'] == $check_zone_id) {
$check_flag = true;
break;
}
$check->MoveNext();
}
$foundvalid = $check_flag;
}
// remove if fails address validation
if (!$foundvalid) {
$messageStack->add_session('checkout_payment', TEXT_REMOVE_REDEEM_COUPON_ZONE, 'caution');
$this->clear_posts();
if (!$foundvalid) zen_redirect(zen_href_link(FILENAME_CHECKOUT_PAYMENT, '', 'SSL',true, false));
}
}
}
// if ($_POST['submit_redeem_coupon_x'] && !$_POST['gv_redeem_code']) zen_redirect(zen_href_link(FILENAME_CHECKOUT_PAYMENT, 'credit_class_error_code=' . $this->code . '&credit_class_error=' . urlencode(TEST_NO_REDEEM_CODE), 'SSL', true, false));
$messageStack->add('checkout', TEXT_VALID_COUPON,'success');
}
}
/**
* Enter description here...
*
* @param unknown_type $i
* @return unknown
*/
function update_credit_account($i) {
return false;
}
/**
* Enter description here...
*
*/
function apply_credit() {
$cc_id = $_SESSION['cc_id'];
if ($this->deduction !=0) {
$db->Execute("insert into " . TABLE_COUPON_REDEEM_TRACK . "
(coupon_id, redeem_date, redeem_ip, customer_id, order_id)
values ('" . (int)$cc_id . "', now(), '" . $_SERVER['REMOTE_ADDR'] . "', '" . (int)$_SESSION['customer_id'] . "', '" . (int)$insert_id . "')");
}
$_SESSION['cc_id'] = "";
}
/**
* Enter description here...
*
* @param unknown_type $order_total
* @return unknown
*/
function calculate_deductions($order_total) {
global $db, $order, $messageStack, $currencies; $tax_address = zen_get_tax_locations();
$orderTotalDetails = $this->get_order_total();
$orderTotalTax = $orderTotalDetails['tax'];
$orderTotal = $orderTotalDetails['total'];
if ($_SESSION['cc_id']) {
$coupon = $db->Execute("select * from " . TABLE_COUPONS . " where coupon_id = '" . (int)$_SESSION['cc_id'] . "'");
$this->coupon_code = $coupon->fields['coupon_code'];
if (($coupon->RecordCount() > 0 && $orderTotal !=0) || ($coupon->RecordCount() > 0 && $coupon->fields['coupon_type']=='S') ) {
// left for total order amount vs qualified order amount just switch the commented lines
// if ($orderTotalDetails['totalFull'] >= $coupon->fields['coupon_minimum_order']) {
if (strval($orderTotalDetails['total']) >= $coupon->fields['coupon_minimum_order']) {
if ($coupon->fields['coupon_type']=='S') {
$od_amount['total'] = $_SESSION['shipping']['cost'];
$od_amount['type'] = 'S';
$od_amount['tax'] = ($this->calculate_tax == 'Standard') ? $_SESSION['shipping_tax_amount'] : 0;
if (DISPLAY_PRICE_WITH_TAX == 'true')
{
$od_amount['total'] += $od_amount['tax'];
}
if (isset($_SESSION['shipping_tax_description']) && $_SESSION['shipping_tax_description'] != '') { $od_amount['tax_groups'][$_SESSION['shipping_tax_description']] = $od_amount['tax'];
}
return $od_amount;
}
if ($coupon->fields['coupon_type'] == 'P') {
$od_amount['total'] = round($orderTotal*($coupon->fields['coupon_amount']/100), 2); $od_amount['type'] = 'P';
$ratio = $od_amount['total']/$orderTotal;
} elseif ($coupon->fields['coupon_type'] == 'F') {
$od_amount['total'] = round($coupon->fields['coupon_amount'] * ($orderTotal>0), 2); $od_amount['type'] = 'F';
$ratio = $od_amount['total']/$orderTotal;
}
if ($od_amount['total'] > $orderTotal) $od_amount['total'] = $orderTotal;
switch ($this->calculate_tax) {
case 'None':
if ($this->include_tax == 'true') {
reset($order->info['tax_groups']); foreach ($order->info['tax_groups'] as $key=>$value) {
$od_amount['tax_groups'][$key] = $order->info['tax_groups'][$key] * $ratio;
}
}
break;
case 'Standard':
if ($od_amount['total'] >= $orderTotal) {
$ratio = 1;
}
$adjustedTax = $orderTotalTax * $ratio;
// echo "order total tax = $orderTotalTax";
$ratioTax = (isset($order->info['tax']) && $order->info['tax'] != 0) ?
$adjustedTax/$order->info['tax'] : 0; reset($order->info['tax_groups']); $tax_deduct = 0;
foreach ($order->info['tax_groups'] as $key=>$value) {
$od_amount['tax_groups'][$key] = $order->info['tax_groups'][$key] * $ratioTax;
$tax_deduct += $od_amount['tax_groups'][$key];
}
$od_amount['tax'] = $tax_deduct;
break;
case 'Credit Note':
$tax_rate = zen_get_tax_rate($this->tax_class);
$od_amount['tax'] = zen_calculate_tax($od_amount['total'], $tax_rate);
$tax_description = zen_get_tax_description($this->tax_class);
$od_amount['tax_groups'][$tax_description] = $od_amount['tax'];
break;
default:
}
} else {
$messageStack->add_session('redemptions', sprintf(TEXT_INVALID_REDEEM_COUPON_MINIMUM
, $currencies->format($coupon->fields['coupon_minimum_order'])),'caution'); $this->clear_posts();
zen_redirect(zen_href_link(FILENAME_CHECKOUT_PAYMENT, '', 'SSL',true, false));
}
}
}
return $od_amount;
}
/**
* Enter description here...
*
* @return unknown
*/
function get_order_total() {
$order_total_tax = $order->info['tax'];
$order_total = $order->info['total'];
// echo "order total = $order_total<br>";
// echo "order total shipping = {$order->info['shipping_cost']}<br>";
// echo "order total tax = {$order->info['tax']}<br>";
if ($this->include_shipping != 'true') $order_total -= $order->info['shipping_cost'];
if ($this->include_shipping != 'true') $order_total_tax -= $order->info['shipping_tax'];
if ($this->include_tax != 'true') $order_total -= $order->info['tax'];
// if ($this->include_tax != "true" && $this->include_shipping != 'true') $order_total -= $order->info['shipping_tax'];
// echo "order total = $order_total<br>";
$orderTotalFull = $order_total;
$products = $_SESSION['cart']->get_products();
for ($i=0; $i<sizeof($products); $i++) {
if (!is_product_valid($products[$i]['id'], $_SESSION['cc_id'])) {
$order_total -= $products[$i]['final_price'] * $products[$i]['quantity'];
if ($this->include_tax == 'true') {
$products_tax = zen_get_tax_rate($products[$i]['tax_class_id']);
$order_total -= (zen_calculate_tax($products[$i]['final_price'], $products_tax)) * $products[$i]['quantity'];
}
$order_total_tax -= (zen_calculate_tax($products[$i]['final_price'], zen_get_tax_rate($products[$i]['tax_class_id']))) * $products[$i]['quantity'];
}
}
$orderTotalInclusive = $order_total + $order_total_tax;
if (DISPLAY_PRICE_WITH_TAX == 'true') $order_total += $order_total_tax;
$order_total = array('totalFull'=>$orderTotalFull, 'total'=>$order_total, 'tax'=>$order_total_tax, 'totalInclusive'=>$orderTotalInclusive); return $order_total;
}
/**
* Enter description here...
*
* @return unknown
*/
function check() {
if (!isset($this->check)) { $check_query = $db->Execute("select configuration_value from " . TABLE_CONFIGURATION . " where configuration_key = 'MODULE_ORDER_TOTAL_COUPON_STATUS'");
$this->check = $check_query->RecordCount();
}
return $this->check;
}
/**
* Enter description here...
*
* @return unknown
*/
function keys() {
return array('MODULE_ORDER_TOTAL_COUPON_STATUS', 'MODULE_ORDER_TOTAL_COUPON_SORT_ORDER', 'MODULE_ORDER_TOTAL_COUPON_INC_SHIPPING', 'MODULE_ORDER_TOTAL_COUPON_INC_TAX', 'MODULE_ORDER_TOTAL_COUPON_CALC_TAX', 'MODULE_ORDER_TOTAL_COUPON_TAX_CLASS'); }
/**
* Enter description here...
*
*/
function install() {
$db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, date_added) values ('该模块已安装', 'MODULE_ORDER_TOTAL_COUPON_STATUS', 'true', '', '6', '1','zen_cfg_select_option(array(\'true\'), ', now())");
$db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, date_added) values ('排序顺序', 'MODULE_ORDER_TOTAL_COUPON_SORT_ORDER', '280', '显示的排序顺序。', '6', '2', 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 ('含运费', 'MODULE_ORDER_TOTAL_COUPON_INC_SHIPPING', 'true', '计算时含运费', '6', '5', '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, set_function ,date_added) values ('含税', 'MODULE_ORDER_TOTAL_COUPON_INC_TAX', 'false', '计算时含税。', '6', '6','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, set_function ,date_added) values ('重新计算税', 'MODULE_ORDER_TOTAL_COUPON_CALC_TAX', 'Standard', '重新计算税', '6', '7','zen_cfg_select_option(array(\'None\', \'Standard\', \'Credit Note\'), ', 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 ('税率种类', 'MODULE_ORDER_TOTAL_COUPON_TAX_CLASS', '0', '收取优惠券时，使用以下的税率种类。', '6', '0', 'zen_get_tax_class_title', 'zen_cfg_pull_down_tax_classes(', now())");
}
/**
* Enter description here...
*
*/
function remove() {
$keys = '';
$keys_array = $this->keys();
for ($i=0; $i<sizeof($keys_array); $i++) {
$keys .= "'" . $keys_array[$i] . "',";
}
$db->Execute("delete from " . TABLE_CONFIGURATION . " where configuration_key in (" . $keys . ")");
}
}
News
Site map
SitemapIndex
RSS Feed