sales/includes/cart_class.inc

   1 <?php
   2
   3 /* Definition of the cart class
   4 this class can hold all the information for:
   5
   6 i)   a sales order
   7 ii)  an invoice
   8 iii) a credit note
   9 iv)  a delivery note
  10 */
  11
  12 include_once($path_to_root . "/inventory/includes/inventory_db.inc");
  13 include_once($path_to_root . "/taxes/tax_calc.inc");
  14
  15 class cart
  16 {
  17         var $trans_type; // invoice, order, delivery note ...
  18         var $trans_no = array();// array (num1=>ver1,..) or 0 for new
  19         var $so_type = 0;               // for sales order: simple=0 template=1
  20
  21         var $line_items;  //array of objects of class line_details
  22
  23         var $src_docs = array();        // array of arrays(num1=>ver1,...) or 0 for no src
  24         var $src_date;                  // src document date (for info only)
  25
  26         var $document_date;
  27         var $due_date;
  28         var $default_sales_type; // set to the customer's sales type
  29         var $sales_type_name; // set to customer's sales type name
  30         var $tax_included;
  31
  32         var $customer_currency; // set to the customer's currency
  33         var $default_discount; // set to the customer's discount %
  34         var $customer_name;
  35         var $customer_id;
  36         var $Branch;
  37         var $email;
  38
  39         var $deliver_to;
  40         var $delivery_address;
  41         var $phone;
  42
  43         var $cust_ref;
  44         var $reference;
  45         var $Comments;
  46         var $Location;
  47         var $location_name;
  48         var $order_no;          // the original order number
  49         var $trans_link = 0;
  50
  51         var $ship_via;
  52         var $freight_cost = 0;
  53
  54         var $tax_group_id;
  55         var $tax_group_name;
  56         var $tax_group_array = null; // saves db queries
  57
  58         //-------------------------------------------------------------------------
  59         //
  60         //  $trans_no==0 => open new/direct document
  61         //  $trans_no!=0 && $view==false => read for view
  62         //  $trans_no!=0 && $view==true => read for edit (qty update from parent doc)
  63         //
  64         function Cart($type, $trans_no=0, $view=false ) {
  65                 /*Constructor function initialises a new shopping cart */
  66                 $this->line_items = array();
  67                 $this->default_sales_type = "";
  68                 $this->trans_type = 30;
  69                 $this->read($type, $trans_no, $view );
  70
  71         }
  72
  73
  74         function read($type, $trans_no=0, $view=false ) {
  75
  76         if (!is_array($trans_no)) $trans_no = array($trans_no);
  77
  78         if ($trans_no[0]) {
  79                 if ($type==30) { // sales order
  80                         read_sales_order($trans_no[0], $this);
  81                         if ($view) {    // prepare for DN/IV entry
  82                                 for($line_no=0; $line_no<count($this->line_items); $line_no++) {
  83                                         $line= &$this->line_items[$line_no];
  84                                         $line->qty_dispatched = $line->quantity-$line->qty_done;
  85                                 }
  86                         }
  87                         } else {        // derivative transaction
  88                                 read_sales_trans($type, $trans_no, $this);
  89                                 if ($this->order_no) { // free hand credit notes have no order_no
  90                                         $sodata = get_sales_order_header($this->order_no);
  91                                         $this->cust_ref = $sodata["customer_ref"];
  92 //set_customer($customer_name, $customer_id, $currency, $discount)
  93 //*                                     $this->customer_name = $sodata["name"];
  94 //*                                     $this->customer_currency = $sodata["curr_code"];
  95 //*                                     $this->Comments = $sodata["comments"];
  96                                         $this->delivery_address = $sodata["delivery_address"];
  97 //                                      $this->location_name = $sodata["location_name"];
  98 //                                      $this->document_date = sql2date($myrow["ord_date"]);
  99                                 }
 100                                 if (!$view && ($type!=11 || $this->trans_link!=0)) {
 101                                         $src_type = get_parent_type($type);
 102                                         $src_details = 0;
 103                                         if ($src_type==30) { // get src data from sales_orders
 104                                                 $this->src_docs = array( $sodata['order_no']=>$sodata['version']);
 105                                                 $srcdetails = get_sales_order_details($this->order_no);
 106                                         } else {        // get src_data from debtor_trans
 107                                                 $this->src_docs = get_customer_trans_version($src_type, get_parent_trans($type,$trans_no[0]));
 108                                                 $srcdetails = get_customer_trans_details($src_type,array_keys($this->src_docs));
 109                                         }
 110                                         // calculate & save: qtys on other docs and free qtys on src doc
 111                                         $line_no = 0;
 112                                         for($line_no=0; $srcline = db_fetch($srcdetails); $line_no++) {
 113                                                 $sign = 1; // $type==13 ?  1 : -1; // this is strange debtor_trans atavism
 114                                                 $line = &$this->line_items[$line_no];
 115
 116                                                 $line->qty_old = $line->qty_dispatched = $line->quantity;
 117                                                 $line->quantity += $sign*($srcline['quantity']-$srcline['qty_done']); // add free qty on src doc
 118                                         }
 119                                 } else {
 120                                         for($line_no=0; $line_no<count($this->line_items); $line_no++) {
 121                                                 $line= &$this->line_items[$line_no];
 122                                                 $line->qty_dispatched = $line->quantity;
 123                                         }
 124                                 }
 125                         }
 126                 } else {
 127                         $this->trans_type = $type;
 128                         $this->trans_no = 0;
 129                         // set new sales document defaults here
 130                         $this->customer_id='';
 131                         $this->document_date = Today();
 132                         if (!is_date_in_fiscalyear($this->document_date))
 133                         $this->document_date = end_fiscalyear();
 134                         $this->reference = references::get_next($this->trans_type);
 135                 }
 136         }
 137
 138         //-------------------------------------------------------------------------
 139         // Writing new/modified sales document to database.
 140         // Makes parent documents for direct delivery/invoice by recurent call.
 141
 142         function write($policy=0) {
 143                 if (count($this->src_docs) == 0 && ($this->trans_type == 10 || $this->trans_type == 13)) {
 144                         // direct document -> first add parent
 145                         $src = $this; // make local copy of this cart
 146                         $src->trans_type = get_parent_type($src->trans_type);
 147                         $src->reference = 'auto';
 148
 149                         $src->write(1);
 150                         $type = $this->trans_type;
 151                         $ref = $this->reference;
 152                         // re-read document
 153                         $this->read($src->trans_type, key($src->trans_no), true);
 154
 155                         $this->reference = $ref;
 156                         $this->trans_type = $type;
 157                         $this->src_docs= $this->trans_no;
 158                         $this->trans_no = 0;
 159                         $this->order_no= $this->trans_type==13 ? key($src->trans_no) : $src->order_no;
 160                 }
 161                 switch($this->trans_type) {
 162                         case 10:
 163                                 return write_sales_invoice($this);
 164                         case 11:
 165                                 return write_credit_note($this, $policy);
 166                         case 13:
 167                                 return write_sales_delivery($this, $policy);
 168                         case 30:
 169                                 if ($this->trans_no==0) // new document
 170                                         return add_sales_order($this);
 171                                 else
 172                                         return update_sales_order($this);
 173                 }
 174         }
 175
 176         function set_customer($customer_id, $customer_name, $currency, $discount)
 177         {
 178                 $this->customer_name = $customer_name;
 179                 $this->customer_id = $customer_id;
 180                 $this->default_discount = $discount;
 181                 $this->customer_currency = $currency;
 182         }
 183
 184         function set_branch($branch_id, $tax_group_id, $tax_group_name, $phone='', $email='')
 185         {
 186                 $this->Branch = $branch_id;
 187                 $this->phone = $phone;
 188                 $this->email = $email;
 189                 $this->tax_group_id = $tax_group_id;
 190                 $this->tax_group_array = get_tax_group_items_as_array($tax_group_id);
 191         }
 192
 193         function set_sales_type($sales_type, $sales_name, $tax_included=0)
 194         {
 195                 $this->default_sales_type = $sales_type;
 196                 $this->sales_type_name = $sales_name;
 197                 $this->tax_included = $tax_included;
 198         }
 199
 200         function set_location($id, $name)
 201         {
 202                 $this->Location = $id;
 203                 $this->location_name = $name;
 204         }
 205
 206         function set_delivery($shipper, $destination, $address, $freight_cost=null)
 207         {
 208                 $this->ship_via = $shipper;
 209                 $this->deliver_to = $destination;
 210                 $this->delivery_address = $address;
 211                 if (isset($freight_cost))
 212                         $this->freight_cost = $freight_cost;
 213         }
 214
 215         function add_to_cart($line_no,$stock_id, $qty, $price, $disc, $qty_done=0, $standard_cost=0, $description=null, $id=0, $src_no=0)
 216         {
 217                 if (isset($stock_id) && $stock_id != "" && isset($qty)/* && $qty > 0*/) {
 218                         $this->line_items[$line_no] = new line_details($stock_id, $qty, $price, $disc,
 219                                 $qty_done,  $standard_cost, $description, $id, $src_no);
 220                         return 1;
 221                 } else {
 222                         // shouldn't come here under normal circumstances
 223                         display_db_error("unexpected - adding an invalid item or null quantity", "", true);
 224                 }
 225                 return 0;
 226         }
 227
 228         function update_cart_item($line_no, $qty, $price, $disc)
 229         {
 230
 231                 $this->line_items[$line_no]->quantity = $qty;
 232                 $this->line_items[$line_no]->qty_dispatched = $qty;
 233                 $this->line_items[$line_no]->price = $price;
 234                 $this->line_items[$line_no]->discount_percent = $disc;
 235         }
 236
 237         function update_add_cart_item_qty($line_no, $qty)
 238         {
 239                 $this->line_items[$line_no]->quantity += $qty;
 240         }
 241
 242         function remove_from_cart($line_no)
 243         {
 244                 unset($this->line_items[$line_no]);
 245         }
 246
 247         function clear_items()
 248         {
 249                 unset($this->line_items);
 250                 $this->line_items = array();
 251                 $this->default_sales_type = "";
 252                 $this->trans_no = 0;
 253                 $this->customer_id = $this->order_no = 0;
 254         }
 255
 256         function count_items()
 257         {
 258                 $counter=0;
 259                 foreach ($this->line_items as $line) {
 260                         if ($line->quantity!=$line->qty_done) $counter++;
 261                 }
 262                 return $counter;
 263         }
 264
 265         function get_items_total()
 266         {
 267                 $total = 0;
 268
 269                 foreach ($this->line_items as $ln_itm) {
 270                         $price = $ln_itm->line_price();
 271                         $total += ($ln_itm->quantity * $price * (1 - $ln_itm->discount_percent));
 272                 }
 273                 return $total;
 274         }
 275
 276         function get_items_total_dispatch()
 277         {
 278                 $total = 0;
 279
 280                 foreach ($this->line_items as $ln_itm) {
 281                         $price = $ln_itm->line_price();
 282                         $total += ($ln_itm->qty_dispatched * $price * (1 - $ln_itm->discount_percent));
 283                 }
 284                 return $total;
 285         }
 286
 287         function has_items_dispatch()
 288         {
 289                 foreach ($this->line_items as $ln_itm) {
 290                         if ($ln_itm->qty_dispatched > 0)
 291                                 return true;
 292                 }
 293                 return false;
 294         }
 295
 296         function any_already_delivered()
 297         {
 298                 /* Checks if there have been any line item processed */
 299
 300                 foreach ($this->line_items as $stock_item) {
 301                         if ($stock_item->qty_done !=0) {
 302                                 return 1;
 303                         }
 304                 }
 305
 306                 return 0;
 307
 308         }
 309
 310         function some_already_delivered($line_no)
 311         {
 312                 /* Checks if there have been deliveries of a specific line item */
 313                 if (isset($this->line_items[$line_no]) &&
 314                         $this->line_items[$line_no]->qty_done != 0) {
 315                         return 1;
 316                 }
 317                 return 0;
 318         }
 319
 320         function get_taxes($shipping_cost=null)
 321         {
 322                 $items = array();
 323                 $prices = array();
 324                 if($shipping_cost==null)
 325                         $shipping_cost = $this->freight_cost;
 326
 327                 foreach ($this->line_items as $ln_itm) {
 328                         $items[] = $ln_itm->stock_id;
 329                         $prices[] = ($ln_itm->qty_dispatched *
 330                                 $ln_itm->line_price()* (1 - $ln_itm->discount_percent));
 331                 }
 332
 333                 $taxes = get_tax_for_items($items, $prices, $shipping_cost,
 334                 $this->tax_group_id, $this->tax_included,  $this->tax_group_array);
 335
 336                 return $taxes;
 337         }
 338
 339
 340         function get_tax_free_shipping() {
 341
 342                 if ($this->tax_included==0)
 343                         return $this->freight_cost;
 344                 else
 345                         return ($this->freight_cost - $this->get_shipping_tax());
 346         }
 347
 348         function get_shipping_tax() {
 349
 350                 $tax_items = get_shipping_tax_as_array();
 351                 $tax_rate = 0;
 352                 if ($tax_items != null) {
 353                         foreach ($tax_items as $item_tax) {
 354                                 $index = $item_tax['tax_type_id'];
 355                                 if (isset($this->tax_group_array[$index])) {
 356                                         $tax_rate += $item_tax['rate'];
 357                                 }
 358                         }
 359                 }
 360                 if($this->tax_included)
 361                         return $this->freight_cost*$tax_rate/($tax_rate+100);
 362                 else
 363                         return $this->freight_cost*$tax_rate/100;
 364         }
 365
 366 } /* end of class defintion */
 367
 368 class line_details
 369 {
 370         var $id;
 371         var $stock_id;
 372         var $item_description;
 373         var $units;
 374         var $mb_flag;
 375         var $tax_type;
 376         var $tax_type_name;
 377         var $src_no;    // number of src doc for this line
 378         var $quantity;
 379         var $price;
 380         var $discount_percent;
 381         var $qty_done;  // quantity processed on child documents
 382         var $qty_dispatched; // quantity selected to process
 383         var $qty_old=0; // quantity dispatched before edition
 384         var $standard_cost;
 385
 386         function line_details ($stock_id, $qty, $prc, $disc_percent,
 387                 $qty_done, $standard_cost, $description, $id=0, $src_no=0 )
 388         {
 389         /* Constructor function to add a new LineDetail object with passed params */
 390
 391                 $this->id = $id;
 392                 $this->src_no = $src_no;
 393                 $item_row = get_item($stock_id);
 394
 395                 if ($item_row == null)
 396                         display_db_error("invalid item added to order : $stock_id", "");
 397
 398                 $this->mb_flag = $item_row["mb_flag"];
 399                 $this->units = $item_row["units"];
 400                 if ($description == null)
 401                         $this->item_description = $item_row["description"];
 402                 else
 403                         $this->item_description = $description;
 404                 //$this->standard_cost = $item_row["material_cost"] + $item_row["labour_cost"] + $item_row["overhead_cost"];
 405                 $this->tax_type = $item_row["tax_type_id"];
 406                 $this->tax_type_name = $item_row["tax_type_name"];
 407
 408                 $this->stock_id = $stock_id;
 409                 $this->quantity = $qty;
 410                 $this->qty_dispatched = $qty;
 411                 $this->price = $prc;
 412                 $this->discount_percent = $disc_percent;
 413                 $this->qty_done = $qty_done;
 414                 $this->standard_cost = $standard_cost;
 415         }
 416
 417         // get unit price as stated on document
 418         function line_price()
 419         {
 420                 return $this->price;
 421         }
 422 }
 423
 424 ?>