Zen Cart Logo
Forums / Built-in Shipping and Payment Modules / Cloned Shipping Module not appearing in Admin

Cloned Shipping Module not appearing in Admin

Views: 964

Results 1 to 4 of 4
25 Jun 2012, 12:48 PM
#1
sbloomer avatar

sbloomer

New Zenner

Join Date:
Jun 2012
Posts:
7
Plugin Contributions:
0

Cloned Shipping Module not appearing in Admin

Hi all

I HATE posting problems I encounter when I know a thorough search should reveal the answer, but I'm stumped having searched for over an hour.

I am new to Zen Cart but I have a grasp of the basics. New installation, v1.5. I have everything else working, bar this.

I have cloned the Table Rate shipping module to tailor it, but it's just not appearing in my Admin console, leaving me with this:

Attachment 10702

Note the absence of the right hand panel and the directory text at the bottom.

I have (I believe) correctly cloned the module and language file, but obviously something is amiss.

Here is the module file (zapostoffice.php)

<?php
/**
 * @package shippingMethod
 * @copyright Copyright 2003-2009 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: table.php 14498 2009-10-01 20:16:16Z ajeh $
 */
/**
 * Enter description here...
 *
 */
class table extends base {
  /**
   * Enter description here...
   *
   * @var unknown_type
   */
  var $code;
  /**
   * Enter description here...
   *
   * @var unknown_type
   */
  var $title;
  /**
   * Enter description here...
   *
   * @var unknown_type
   */
  var $description;
  /**
   * Enter description here...
   *
   * @var unknown_type
   */
  var $icon;
  /**
   * Enter description here...
   *
   * @var unknown_type
   */
  var $enabled;
  /**
   * Enter description here...
   *
   * @return table
   */
  function table() {
    global $order, $db;

    $this->code = 'zapostoffice';
    $this->title = MODULE_SHIPPING_ZAPOSTOFFICE_TEXT_TITLE;
    $this->description = MODULE_SHIPPING_ZAPOSTOFFICE_TEXT_DESCRIPTION;
    $this->sort_order = MODULE_SHIPPING_ZAPOSTOFFICE_SORT_ORDER;
    $this->icon = '';
    $this->tax_class = MODULE_SHIPPING_ZAPOSTOFFICE_TAX_CLASS;
    $this->tax_basis = MODULE_SHIPPING_ZAPOSTOFFICE_TAX_BASIS;
    // disable only when entire cart is free shipping
    if (zen_get_shipping_enabled($this->code)) {
      $this->enabled = ((MODULE_SHIPPING_ZAPOSTOFFICE_STATUS == 'True') ? true : false);
    }

    if ($this->enabled) {
      // check MODULE_SHIPPING_ZAPOSTOFFICE_HANDLING_METHOD is in
      $check_query = $db->Execute("select configuration_value from " . TABLE_CONFIGURATION . " where configuration_key = 'MODULE_SHIPPING_ZAPOSTOFFICE_HANDLING_METHOD'");
      if ($check_query->EOF) {
        $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, date_added) values ('Handling Per Order or Per Box', 'MODULE_SHIPPING_ZAPOSTOFFICE_HANDLING_METHOD', 'Order', 'Do you want to charge Handling Fee Per Order or Per Box?', '6', '0', 'zen_cfg_select_option(array(\'Order\', \'Box\'), ', now())");
      }
    }

    if ( ($this->enabled == true) && ((int)MODULE_SHIPPING_ZAPOSTOFFICE_ZONE > 0) ) {
      $check_flag = false;
      $check = $db->Execute("select zone_id from " . TABLE_ZONES_TO_GEO_ZONES . " where geo_zone_id = '" . MODULE_SHIPPING_ZAPOSTOFFICE_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;
      }
    }
  }
  /**
   * Enter description here...
   *
   * @param unknown_type $method
   * @return unknown
   */
  function quote($method = '') {
    global $order, $shipping_weight, $shipping_num_boxes, $total_count;

    // shipping adjustment
    switch (MODULE_SHIPPING_ZAPOSTOFFICE_MODE) {
      case ('price'):
        $order_total = $_SESSION['cart']->show_total() - $_SESSION['cart']->free_shipping_prices() ;
        break;
      case ('weight'):
        $order_total = $shipping_weight;
        break;
      case ('item'):
        $order_total = $total_count - $_SESSION['cart']->free_shipping_items();
        break;
    }

    $order_total_amount = $_SESSION['cart']->show_total() - $_SESSION['cart']->free_shipping_prices() ;

    $table_cost = preg_split("/[:,]/" , MODULE_SHIPPING_ZAPOSTOFFICE_COST);
    $size = sizeof($table_cost);
    for ($i=0, $n=$size; $i<$n; $i+=2) {
      if (round($order_total,9) <= $table_cost[$i]) {
        if (strstr($table_cost[$i+1], '%')) {
          $shipping = ($table_cost[$i+1]/100) * $order_total_amount;
        } else {
          $shipping = $table_cost[$i+1];
        }
        break;
      }
    }

    if (MODULE_SHIPPING_ZAPOSTOFFICE_MODE == 'weight') {
      $shipping = $shipping * $shipping_num_boxes;
      // show boxes if weight
      switch (SHIPPING_BOX_WEIGHT_DISPLAY) {
        case (0):
        $show_box_weight = '';
        break;
        case (1):
        $show_box_weight = ' (' . $shipping_num_boxes . ' ' . TEXT_SHIPPING_BOXES . ')';
        break;
        case (2):
        $show_box_weight = ' (' . number_format($shipping_weight * $shipping_num_boxes,2) . TEXT_SHIPPING_WEIGHT . ')';
        break;
        default:
        $show_box_weight = ' (' . $shipping_num_boxes . ' x ' . number_format($shipping_weight,2) . TEXT_SHIPPING_WEIGHT . ')';
        break;
      }
    }

    $this->quotes = array('id' => $this->code,
    'module' => MODULE_SHIPPING_ZAPOSTOFFICE_TEXT_TITLE . $show_box_weight,
    'methods' => array(array('id' => $this->code,
    'title' => MODULE_SHIPPING_ZAPOSTOFFICE_TEXT_WAY,
    'cost' => $shipping + (MODULE_SHIPPING_ZAPOSTOFFICE_HANDLING_METHOD == 'Box' ? MODULE_SHIPPING_ZAPOSTOFFICE_HANDLING * $shipping_num_boxes : MODULE_SHIPPING_ZAPOSTOFFICE_HANDLING) ) ));

    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;
  }
  /**
   * Enter description here...
   *
   * @return unknown
   */
  function check() {
    global $db;
    if (!isset($this->_check)) {
      $check_query = $db->Execute("select configuration_value from " . TABLE_CONFIGURATION . " where configuration_key = 'MODULE_SHIPPING_ZAPOSTOFFICE_STATUS'");
      $this->_check = $check_query->RecordCount();
    }
    return $this->_check;
  }
  /**
   * Enter description here...
   *
   */
  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 Table Method', 'MODULE_SHIPPING_ZAPOSTOFFICE_STATUS', 'True', 'Do you want to offer table rate shipping for Post Office?', '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, set_function, date_added) values ('Shipping Table', 'MODULE_SHIPPING_ZAPOSTOFFICE_COST', '25:8.50,50:5.50,10000:0.00', 'The shipping cost is based on the total cost or weight of items or count of the items. Example: 25:8.50,50:5.50,etc.. Up to 25 charge 8.50, from there to 50 charge 5.50, etc<br />You can also use percentage amounts, such 25:8.50,35:5%,40:9.50,10000:7% to charge a percentage value of the Order Total', '6', '0', 'zen_cfg_textarea(', 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 ('Table Method', 'MODULE_SHIPPING_ZAPOSTOFFICE_MODE', 'weight', 'The shipping cost is based on the order total or the total weight of the items ordered or the total number of items orderd.', '6', '0', 'zen_cfg_select_option(array(\'weight\', \'price\', \'item\'), ', now())");
    $db->Execute("insert into " . TABLE_CONFIGURATION . " (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, date_added) values ('Handling Fee', 'MODULE_SHIPPING_ZAPOSTOFFICE_HANDLING', '0', 'Handling fee for 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, set_function, date_added) values ('Handling Per Order or Per Box', 'MODULE_SHIPPING_ZAPOSTOFFICE_HANDLING_METHOD', 'Order', 'Do you want to charge Handling Fee Per Order or Per Box?', '6', '0', 'zen_cfg_select_option(array(\'Order\', \'Box\'), ', 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_ZAPOSTOFFICE_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_ZAPOSTOFFICE_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, use_function, set_function, date_added) values ('Shipping Zone', 'MODULE_SHIPPING_ZAPOSTOFFICE_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_ZAPOSTOFFICE_SORT_ORDER', '0', 'Sort order of display.', '6', '0', now())");
  }
  /**
   * Enter description here...
   *
   */
    function remove() {
      global $db;
      $db->Execute("delete from " . TABLE_CONFIGURATION . " where configuration_key like 'MODULE\_SHIPPING\_ZAPOSTOFFICE\_%'");
    }

  /**
   * Enter description here...
   *
   * @return unknown
   */
  function keys() {
    return array('MODULE_SHIPPING_ZAPOSTOFFICE_STATUS', 'MODULE_SHIPPING_ZAPOSTOFFICE_COST', 'MODULE_SHIPPING_ZAPOSTOFFICE_MODE', 'MODULE_SHIPPING_ZAPOSTOFFICE_HANDLING', 'MODULE_SHIPPING_ZAPOSTOFFICE_HANDLING_METHOD', 'MODULE_SHIPPING_ZAPOSTOFFICE_TAX_CLASS', 'MODULE_SHIPPING_ZAPOSTOFFICE_TAX_BASIS', 'MODULE_SHIPPING_ZAPOSTOFFICE_ZONE', 'MODULE_SHIPPING_ZAPOSTOFFICE_SORT_ORDER');
  }
}
?>

and the language file (zapostoffice.php)

<?php
//
// +----------------------------------------------------------------------+
// |zen-cart Open Source E-commerce                                       |
// +----------------------------------------------------------------------+
// | Copyright (c) 2003 The zen-cart developers                           |
// |                                                                      |   
// | http://www.zen-cart.com/index.php                                    |   
// |                                                                      |   
// | Portions Copyright (c) 2003 osCommerce                               |
// +----------------------------------------------------------------------+
// | This source file is subject to version 2.0 of the GPL license,       |
// | that is bundled with this package in the file LICENSE, and is        |
// | available through the world-wide-web at the following url:           |
// | http://www.zen-cart.com/license/2_0.txt.                             |
// | If you did not receive a copy of the zen-cart license and are unable |
// | to obtain it through the world-wide-web, please send a note to       |
// | [email protected] so we can mail you a copy immediately.          |
// +----------------------------------------------------------------------+
// $Id: zapostoffice.php 1969 2005-09-13 06:57:21Z drbyte $
//

define('MODULE_SHIPPING_ZAPOSTOFFICE_TEXT_TITLE', 'SA Post Office Table Rate');
define('MODULE_SHIPPING_ZAPOSTOFFICE_TEXT_DESCRIPTION', 'SA Post Office Table Rate');
define('MODULE_SHIPPING_ZAPOSTOFFICE_TEXT_WAY', 'Best Way');
define('MODULE_SHIPPING_ZAPOSTOFFICE_TEXT_WEIGHT', 'Weight');
define('MODULE_SHIPPING_ZAPOSTOFFICE_TEXT_AMOUNT', 'Amount');
?>

I'm stumped. I've done it about 5 times with the same result.

25 Jun 2012, 12:57 PM
#2
lat9 avatar

lat9

Administrator

Join Date:
Sep 2009
Location:
Stuart, FL
Posts:
14,089
Plugin Contributions:
56

Re: Cloned Shipping Module not appearing in Admin

Are there any admin log files in your /cache folder? A partially-displayed screen in your admin is usually indicative of a PHP parsing error ...

25 Jun 2012, 1:06 PM
#3
sbloomer avatar

sbloomer

New Zenner

Join Date:
Jun 2012
Posts:
7
Plugin Contributions:
0

Re: Cloned Shipping Module not appearing in Admin

lat9:

Are there any admin log files in your /cache folder? A partially-displayed screen in your admin is usually indicative of a PHP parsing error ...

Well, would you look at that..

Here's the error

[25-Jun-2012 14:34:44] PHP Fatal error:  Cannot redeclare class table in /home/pajerxga/public_html/shop/includes/modules/shipping/zapostoffice.php on line 209

Line 209 has a "}" but I know line counts aren't always accurate... Let me hunt for this

25 Jun 2012, 1:18 PM
#4
sbloomer avatar

sbloomer

New Zenner

Join Date:
Jun 2012
Posts:
7
Plugin Contributions:
0

Re: Cloned Shipping Module not appearing in Admin

Ok found it:

class table extends base {

and

function table() {

also needed to be changed. Seems like a Table Rate clone requires a bit more care...