sales/includes/cart_class.inc

   1 <?php
   2 /**********************************************************************
   3     Copyright (C) FrontAccounting, LLC.
   4         Released under the terms of the GNU Affero General Public License,
   5         AGPL, as published by the Free Software Foundation, either version
   6         3 of the License, or (at your option) any later version.
   7     This program is distributed in the hope that it will be useful,
   8     but WITHOUT ANY WARRANTY; without even the implied warranty of
   9     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  10     See the License here <http://www.gnu.org/licenses/agpl-3.0.html>.
  11 ***********************************************************************/
  12 /* Definition of the cart class
  13 this class can hold all the information for:
  14
  15 i)   a sales order
  16 ii)  an invoice
  17 iii) a credit note
  18 iv)  a delivery note
  19 */
  20
  21 include_once($path_to_root . "/inventory/includes/inventory_db.inc");
  22 include_once($path_to_root . "/taxes/tax_calc.inc");
  23
  24 class cart
  25 {
  26         var $trans_type; // invoice, order, delivery note ...
  27         var $trans_no = array();// array (num1=>ver1,..) or 0 for new
  28         var $so_type = 0;               // for sales order: simple=0 template=1
  29         var $cart_id;           // used to detect multi-tab edition conflits
  30         var $line_items;  //array of objects of class line_details
  31
  32         var $src_docs = array();        // array of arrays(num1=>ver1,...) or 0 for no src
  33         var $src_date;                  // src document date (for info only)
  34
  35         var $document_date;
  36         var $due_date;
  37         var $sales_type; // set to the customer's sales type
  38         var $sales_type_name; // set to customer's sales type name
  39         var $tax_included;
  40
  41         var $customer_currency; // set to the customer's currency
  42         var $default_discount; // set to the customer's discount %
  43         var $customer_name;
  44         var $customer_id;
  45         var $Branch;
  46         var $email;
  47
  48         var $deliver_to;
  49         var $delivery_address;
  50         var $phone;
  51
  52         var $cust_ref;
  53         var $reference;
  54         var $Comments;
  55         var $Location;
  56         var $location_name;
  57         var $order_no;          // the original order number
  58         var $trans_link = 0;
  59
  60         var $ship_via;
  61         var $freight_cost = 0;
  62
  63         var $tax_group_id;
  64         var $tax_group_name;
  65         var $tax_group_array = null; // saves db queries
  66         var $price_factor;       // ditto for price calculations
  67
  68         var     $pos;                   // user assigned POS
  69         var $cash;                      // cash transaction
  70         var $cash_account;
  71         var $account_name;
  72         var $cash_discount;     // not used as of FA 2.1
  73         var $dimension_id;
  74         var $dimension2_id;
  75         //-------------------------------------------------------------------------
  76         //
  77         //  $trans_no==0 => open new/direct document
  78         //  $trans_no!=0 && $view==false => read for view
  79         //  $trans_no!=0 && $view==true => read for edit (qty update from parent doc)
  80         //
  81         function Cart($type, $trans_no=0, $view=false ) {
  82                 /*Constructor function initialises a new shopping cart */
  83                 $this->line_items = array();
  84                 $this->sales_type = "";
  85                 $this->trans_type = 30;
  86                 $this->dimension_id = 0;
  87                 $this->dimension2_id = 0;
  88                 $this->read($type, $trans_no, $view );
  89                 $this->cart_id = uniqid('');
  90         }
  91
  92         //-------------------------------------------------------------------------
  93         // Reading document into cart
  94         //
  95         function read($type, $trans_no = 0, $view=false ) {
  96
  97                 if (!is_array($trans_no)) $trans_no = array($trans_no);
  98                 if ($trans_no[0]) {
  99                         if ($type == 30) { // sales order
 100                                 read_sales_order($trans_no[0], $this);
 101                                 if ($view) {    // prepare for DN/IV entry
 102                                         for($line_no = 0; $line_no < count($this->line_items); $line_no++) {
 103                                                 $line = &$this->line_items[$line_no];
 104                                                 $line->src_id = $line->id; // save src line ids for update
 105                                                 $line->qty_dispatched = $line->quantity - $line->qty_done;
 106                                         }
 107                                 }
 108                         } else {        // derivative transaction
 109                                         read_sales_trans($type, $trans_no, $this);
 110                                         if ($this->order_no) { // free hand credit notes have no order_no
 111                                                 $sodata = get_sales_order_header($this->order_no);
 112                                                 $this->cust_ref = $sodata["customer_ref"];
 113                                         // currently currency is hard linked to debtor account
 114                                         //      $this->customer_currency = $sodata["curr_code"];
 115                                                 $this->delivery_to = $sodata["deliver_to"];
 116                                                 $this->delivery_address = $sodata["delivery_address"];
 117                                         }
 118                                         if (!$view && ($type!=11 || $this->trans_link!=0)) {
 119                                                 $src_type = get_parent_type($type);
 120                                                 $src_details = 0;
 121                                                 if ($src_type == 30) { // get src data from sales_orders
 122                                                         $this->src_docs = array( $sodata['order_no']=>$sodata['version']);
 123                                                         $srcdetails = get_sales_order_details($this->order_no);
 124                                                 } else {        // get src_data from debtor_trans
 125                                                         $this->src_docs = get_customer_trans_version($src_type, get_parent_trans($type,$trans_no[0]));
 126                                                         $srcdetails = get_customer_trans_details($src_type,array_keys($this->src_docs));
 127                                                 }
 128                                                 // calculate & save: qtys on other docs and free qtys on src doc
 129                                                 $line_no = 0;
 130                                                 for($line_no = 0; $srcline = db_fetch($srcdetails); $line_no++) {
 131                                                         $sign = 1; // $type==13 ?  1 : -1; // this is strange debtor_trans atavism
 132                                                         $line = &$this->line_items[$line_no];
 133
 134                                                         $line->src_id = $srcline['id']; // save src line ids for update
 135                                                         $line->qty_old = $line->qty_dispatched = $line->quantity;
 136                                                         $line->quantity += $sign * ($srcline['quantity'] - $srcline['qty_done']); // add free qty on src doc
 137                                                 }
 138                                         } else {
 139                                                 for($line_no = 0; $line_no < count($this->line_items); $line_no++) {
 140                                                         $line = &$this->line_items[$line_no];
 141                                                         $line->src_id = $line->id; // save src line ids for update
 142                                                         $line->qty_dispatched = $line->quantity;
 143                                                 }
 144                                         }
 145                                 }
 146                         } else {
 147                                 $this->trans_type = $type;
 148                                 $this->trans_no = 0;
 149                                 // set new sales document defaults here
 150                                 if (get_global_customer() != reserved_words::get_all())
 151                                   $this->customer_id = get_global_customer();
 152                                 else
 153                                   $this->customer_id = '';
 154                                 $this->document_date = Today();
 155                                 if (!is_date_in_fiscalyear($this->document_date))
 156                                         $this->document_date = end_fiscalyear();
 157                                 $this->reference = references::get_next($this->trans_type);
 158                                 if ($type != 30) // Added 2.1 Joe Hunt 2008-11-12
 159                                 {
 160                                         $dim = get_company_pref('use_dimension');
 161                                         if ($dim > 0)
 162                                         {
 163                                                 if ($this->customer_id == '')
 164                                                         $this->dimension_id = 0;
 165                                                 else
 166                                                 {
 167                                                         $cust = get_customer($this->customer_id);
 168                                                         $this->dimension_id = $cust['dimension_id'];
 169                                                 }
 170                                                 if ($dim > 1)
 171                                                 {
 172                                                         if ($this->customer_id == '')
 173                                                                 $this->dimension2_id = 0;
 174                                                         else
 175                                                                 $this->dimension2_id = $cust['dimension2_id'];
 176                                                 }
 177                                         }
 178                                 }
 179                                 if ($type == 10) {
 180                                   $this->due_date =
 181                                         get_invoice_duedate($this->customer_id, $this->document_date);
 182                                   $this->pos = user_pos();
 183                                   $pos = get_sales_point($this->pos);
 184                                   $this->cash = !$pos['credit_sale'];
 185                                   if (!$pos['cash_sale'] || !$pos['credit_sale'])
 186                                         $this->pos = -1; // mark not editable payment type
 187                                   else
 188                                         $this->cash = date_diff($this->due_date, Today(), 'd')<2;
 189                                 if ($this->cash) {
 190                                         $this->Location = $pos['pos_location'];
 191                                         $this->location_name = $pos['location_name'];
 192                                         $this->cash_account = $pos['pos_account'];
 193                                         $this->account_name = $pos['bank_account_name'];
 194                                 }
 195                                 } else
 196                                   $this->due_date =
 197                                         add_days($this->document_date, sys_prefs::default_delivery_required_by());
 198                         }
 199         }
 200
 201         //-------------------------------------------------------------------------
 202         // Writing new/modified sales document to database.
 203         // Makes parent documents for direct delivery/invoice by recurent call.
 204         // $policy - 0 or 1:  writeoff/return for IV, back order/cancel for DN
 205         function write($policy=0) {
 206                 if (count($this->src_docs) == 0 && ($this->trans_type == 10 || $this->trans_type == 13)) {
 207                         // this is direct document - first add parent
 208                         $src = (PHP_VERSION<5) ? $this : clone( $this ); // make local copy of this cart
 209                         $src->trans_type = get_parent_type($src->trans_type);
 210                         $src->reference = 'auto';
 211
 212                         $src->write(1);
 213                         $type = $this->trans_type;
 214                         $ref = $this->reference;
 215                         $date = $this->document_date;
 216                         // re-read document
 217                         $this->read($src->trans_type, key($src->trans_no), true);
 218                         $this->document_date = $date;
 219                         $this->reference = $ref;
 220                         $this->trans_type = $type;
 221                         $this->src_docs= $this->trans_no;
 222                         $this->trans_no = 0;
 223                         $this->order_no= $this->trans_type==13 ? key($src->trans_no) : $src->order_no;
 224                 }
 225 // if we want to save old or derivative document first decode html entities
 226 // from text fields. For new documents this is not needed.
 227                 if ($this->trans_no || $this->trans_type != 30) {
 228                         $this->reference = @html_entity_decode($this->reference);
 229                         $this->Comments = @html_entity_decode($this->Comments);
 230                         foreach($this->line_items as $lineno => $line) {
 231                                 $this->line_items[$lineno]->stock_id = @html_entity_decode($line->stock_id);
 232                                 $this->line_items[$lineno]->description = @html_entity_decode($line->description);
 233                         }
 234                 }
 235                 switch($this->trans_type) {
 236                         case 10:
 237                                 return write_sales_invoice($this);
 238                         case 11:
 239                                 return write_credit_note($this, $policy);
 240                         case 13:
 241                                 return write_sales_delivery($this, $policy);
 242                         case 30:
 243                                 if ($this->trans_no==0) // new document
 244                                         return add_sales_order($this);
 245                                 else
 246                                         return update_sales_order($this);
 247                 }
 248         }
 249
 250         function set_customer($customer_id, $customer_name, $currency, $discount, $cdiscount=0)
 251         {
 252                 $this->customer_name = $customer_name;
 253                 $this->customer_id = $customer_id;
 254                 $this->default_discount = $discount;
 255                 $this->cash_discount = $cdiscount;
 256                 $this->customer_currency = $currency;
 257         }
 258
 259         function set_branch($branch_id, $tax_group_id, $tax_group_name, $phone='', $email='')
 260         {
 261                 $this->Branch = $branch_id;
 262                 $this->phone = $phone;
 263                 $this->email = $email;
 264                 $this->tax_group_id = $tax_group_id;
 265                 $this->tax_group_array = get_tax_group_items_as_array($tax_group_id);
 266         }
 267
 268         function set_sales_type($sales_type, $sales_name, $tax_included=0, $factor=0)
 269         {
 270             $this->sales_type = $sales_type;
 271             $this->sales_type_name = $sales_name;
 272             $this->tax_included = $tax_included;
 273             $this->price_factor = $factor;
 274         }
 275
 276         function set_location($id, $name)
 277         {
 278                 $this->Location = $id;
 279                 $this->location_name = $name;
 280         }
 281
 282         function set_delivery($shipper, $destination, $address, $freight_cost=null)
 283         {
 284                 $this->ship_via = $shipper;
 285                 $this->deliver_to = $destination;
 286                 $this->delivery_address = $address;
 287                 if (isset($freight_cost))
 288                         $this->freight_cost = $freight_cost;
 289         }
 290
 291         function add_to_cart($line_no,$stock_id, $qty, $price, $disc, $qty_done=0, $standard_cost=0, $description=null, $id=0, $src_no=0)
 292         {
 293                 if (isset($stock_id) && $stock_id != "" && isset($qty)/* && $qty > 0*/) {
 294                         $this->line_items[$line_no] = new line_details($stock_id, $qty, $price, $disc,
 295                                 $qty_done,  $standard_cost, $description, $id, $src_no);
 296                         return 1;
 297                 } else {
 298                         // shouldn't come here under normal circumstances
 299                         display_db_error("unexpected - adding an invalid item or null quantity", "", true);
 300                 }
 301                 return 0;
 302         }
 303
 304         function update_cart_item($line_no, $qty, $price, $disc, $description="")
 305         {
 306                 if ($description != "")
 307                         $this->line_items[$line_no]->item_description = $description;
 308                 $this->line_items[$line_no]->quantity = $qty;
 309                 $this->line_items[$line_no]->qty_dispatched = $qty;
 310                 $this->line_items[$line_no]->price = $price;
 311                 $this->line_items[$line_no]->discount_percent = $disc;
 312         }
 313
 314         function update_add_cart_item_qty($line_no, $qty)
 315         {
 316                 $this->line_items[$line_no]->quantity += $qty;
 317         }
 318
 319         function remove_from_cart($line_no)
 320         {
 321                 array_splice($this->line_items, $line_no, 1);
 322         }
 323
 324         function clear_items()
 325         {
 326                 unset($this->line_items);
 327                 $this->line_items = array();
 328                 $this->sales_type = "";
 329                 $this->trans_no = 0;
 330                 $this->customer_id = $this->order_no = 0;
 331         }
 332
 333         function count_items()
 334         {
 335                 $counter=0;
 336                 foreach ($this->line_items as $line) {
 337                         if ($line->quantity!=$line->qty_done) $counter++;
 338                 }
 339                 return $counter;
 340         }
 341
 342         function get_items_total()
 343         {
 344                 $total = 0;
 345
 346                 foreach ($this->line_items as $ln_itm) {
 347                         $price = $ln_itm->line_price();
 348                         $total += round($ln_itm->quantity * $price * (1 - $ln_itm->discount_percent),
 349                            user_price_dec());
 350                 }
 351                 return $total;
 352         }
 353
 354         function get_items_total_dispatch()
 355         {
 356                 $total = 0;
 357
 358                 foreach ($this->line_items as $ln_itm) {
 359                         $price = $ln_itm->line_price();
 360                         $total += round(($ln_itm->qty_dispatched * $price * (1 - $ln_itm->discount_percent)),
 361                            user_price_dec());
 362                 }
 363                 return $total;
 364         }
 365
 366         function has_items_dispatch()
 367         {
 368                 foreach ($this->line_items as $ln_itm) {
 369                         if ($ln_itm->qty_dispatched > 0)
 370                                 return true;
 371                 }
 372                 return false;
 373         }
 374
 375         function any_already_delivered()
 376         {
 377                 /* Checks if there have been any line item processed */
 378
 379                 foreach ($this->line_items as $stock_item) {
 380                         if ($stock_item->qty_done !=0) {
 381                                 return 1;
 382                         }
 383                 }
 384
 385                 return 0;
 386
 387         }
 388
 389         function some_already_delivered($line_no)
 390         {
 391                 /* Checks if there have been deliveries of a specific line item */
 392                 if (isset($this->line_items[$line_no]) &&
 393                         $this->line_items[$line_no]->qty_done != 0) {
 394                         return 1;
 395                 }
 396                 return 0;
 397         }
 398
 399         function get_taxes($shipping_cost=null)
 400         {
 401                 $items = array();
 402                 $prices = array();
 403                 if($shipping_cost==null)
 404                         $shipping_cost = $this->freight_cost;
 405
 406                 foreach ($this->line_items as $ln_itm) {
 407                         $items[] = $ln_itm->stock_id;
 408                         $prices[] = round(($ln_itm->qty_dispatched *
 409                                 $ln_itm->line_price()* (1 - $ln_itm->discount_percent)),  user_price_dec());
 410                 }
 411
 412                 $taxes = get_tax_for_items($items, $prices, $shipping_cost,
 413                   $this->tax_group_id, $this->tax_included,  $this->tax_group_array);
 414
 415     // Adjustment for swiss franken, we always have 5 rappen = 1/20 franken
 416     if ($this->customer_currency == 'CHF') {
 417                         $val = $taxes['1']['Value'];
 418       $val1 = (floatval((intval(round(($val*20),0)))/20));
 419                         $taxes['1']['Value'] = $val1;
 420                 }
 421                 return $taxes;
 422         }
 423
 424
 425         function get_tax_free_shipping()
 426         {
 427
 428                 if ($this->tax_included==0)
 429                         return $this->freight_cost;
 430                 else
 431                         return ($this->freight_cost - $this->get_shipping_tax());
 432         }
 433
 434         function get_shipping_tax()
 435         {
 436
 437                 $tax_items = get_shipping_tax_as_array();
 438                 $tax_rate = 0;
 439                 if ($tax_items != null) {
 440                         foreach ($tax_items as $item_tax) {
 441                                 $index = $item_tax['tax_type_id'];
 442                                 if (isset($this->tax_group_array[$index])) {
 443                                         $tax_rate += $item_tax['rate'];
 444                                 }
 445                         }
 446                 }
 447                 if($this->tax_included)
 448                         return round($this->freight_cost*$tax_rate/($tax_rate+100),  user_price_dec());
 449                 else
 450                         return round($this->freight_cost*$tax_rate/100,  user_price_dec());
 451         }
 452
 453 } /* end of class defintion */
 454
 455 class line_details
 456 {
 457         var $id;
 458         var $stock_id;
 459         var $item_description;
 460         var $units;
 461         var $mb_flag;
 462         var $tax_type;
 463         var $tax_type_name;
 464         var $src_no;    // number of src doc for this line
 465         var $src_id;
 466         var $quantity;
 467         var $price;
 468         var $discount_percent;
 469         var $qty_done;  // quantity processed on child documents
 470         var $qty_dispatched; // quantity selected to process
 471         var $qty_old=0; // quantity dispatched before edition
 472         var $standard_cost;
 473
 474         function line_details ($stock_id, $qty, $prc, $disc_percent,
 475                 $qty_done, $standard_cost, $description, $id=0, $src_no=0 )
 476         {
 477         /* Constructor function to add a new LineDetail object with passed params */
 478
 479                 $this->id = $id;
 480                 $this->src_no = $src_no;
 481                 $item_row = get_item($stock_id);
 482
 483                 if ($item_row == null)
 484                         display_db_error("invalid item added to order : $stock_id", "");
 485
 486                 $this->mb_flag = $item_row["mb_flag"];
 487                 $this->units = $item_row["units"];
 488                 if ($description == null)
 489                         $this->item_description = $item_row["description"];
 490                 else
 491                         $this->item_description = $description;
 492                 //$this->standard_cost = $item_row["material_cost"] + $item_row["labour_cost"] + $item_row["overhead_cost"];
 493                 $this->tax_type = $item_row["tax_type_id"];
 494                 $this->tax_type_name = $item_row["tax_type_name"];
 495
 496                 $this->stock_id = $stock_id;
 497                 $this->quantity = $qty;
 498                 $this->qty_dispatched = $qty;
 499                 $this->price = $prc;
 500                 $this->discount_percent = $disc_percent;
 501                 $this->qty_done = $qty_done;
 502                 $this->standard_cost = $standard_cost;
 503         }
 504
 505         // get unit price as stated on document
 506         function line_price()
 507         {
 508                 return $this->price;
 509         }
 510 }
 511
 512 ?>