sales/includes/cart_class.inc

   1 <?php
   2 /**********************************************************************
   3     Copyright (C) FrontAccounting, LLC.
   4         Released under the terms of the GNU General Public License, GPL,
   5         as published by the Free Software Foundation, either version 3
   6         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/gpl-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, quotation, 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 - helper variable not stored in db
  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         var $payment;
  76         var $payment_terms; // cached payment terms
  77         //-------------------------------------------------------------------------
  78         //
  79         //  $trans_no==0 => open new/direct document
  80         //  $trans_no!=0 && $no_edit==false => update with parent constarints for reedition
  81         //  $trans_no!=0 && $no_edit==true => read only: for view, or later child doc entry
  82         //
  83         function Cart($type, $trans_no=0, $no_edit=false) {
  84                 /*Constructor function initialises a new shopping cart */
  85                 $this->line_items = array();
  86                 $this->sales_type = "";
  87                 if ($type == ST_SALESQUOTE)
  88                         $this->trans_type = $type;
  89                 else
  90                         $this->trans_type = ST_SALESORDER;
  91                 $this->dimension_id = 0;
  92                 $this->dimension2_id = 0;
  93                 $this->read($type, $trans_no, $no_edit);
  94                 $this->cart_id = uniqid('');
  95         }
  96
  97         //
  98         //      Prepare cart to new child document entry, just after initial parent doc read.
  99         //
 100         function prepare_child()
 101         {
 102                 global $Refs;
 103
 104                 $type = get_child_type($this->trans_type);
 105
 106                 $this->trans_type = $type;
 107                 $this->reference = $Refs->get_next($this->trans_type);
 108                 $this->document_date = new_doc_date();
 109
 110                 for($line_no = 0; $line_no < count($this->line_items); $line_no++) {
 111                         $line = &$this->line_items[$line_no];
 112                         $line->src_id = $line->id; // save src line ids for update
 113 //                      $line->qty_min = 0;
 114 //                      $line->qty_max = $line->quantity - $line->qty_done;
 115                         $line->qty_dispatched = $type == ST_CUSTCREDIT ? '0' : $line->quantity - $line->qty_done;
 116                         $line->qty_old = 0;
 117                 }
 118                 unset($line);
 119
 120                 if ($type == ST_CUSTDELIVERY)
 121                         $this->order_no = key($this->trans_no);
 122
 123                 if ($type == ST_SALESINVOICE) {
 124                         $this->due_date = get_invoice_duedate($this->payment, $this->document_date);
 125                 }
 126
 127                 if ($type == ST_CUSTCREDIT)
 128                     $this->src_date = $this->document_date;
 129
 130                 $this->src_docs = $this->trans_no;
 131                 $this->trans_no = 0;
 132         }
 133
 134         //
 135         //      Prepares transaction for reedition updating with parent transaction data
 136         //
 137         function set_parent_constraints($sodata, $src_no) {
 138
 139                 $src_type = get_parent_type($this->trans_type);
 140                 if ($src_type == ST_SALESORDER || $src_type == 0) { // get src data from sales_orders
 141                         $this->src_docs = array( $sodata['order_no']=>$sodata['version']);
 142                         $srcdetails = get_sales_order_details($this->order_no, $this->trans_type);
 143                 } else {        // get src_data from debtor_trans
 144                         $this->src_docs = get_customer_trans_version($src_type,
 145                                         get_parent_trans($this->trans_type, $src_no));
 146                         $srcdetails = get_customer_trans_details($src_type, array_keys($this->src_docs));
 147                 }
 148                 // calculate & save: qtys on other docs and free qtys on src doc
 149                 for($line_no = 0; $srcline = db_fetch($srcdetails); $line_no++) {
 150                         $line = &$this->line_items[$line_no];
 151
 152                         $line->src_id = $srcline['id']; // save src line ids for update
 153                         if ($this->trans_type == ST_SALESINVOICE)
 154                                 $line->src_no = $srcline['debtor_trans_no'];
 155                         $line->qty_old = $line->qty_dispatched = $line->quantity;
 156                         $line->quantity += $srcline['quantity'] - $srcline['qty_done']; // add free qty on src doc
 157                 }
 158         }
 159         //-------------------------------------------------------------------------
 160         // Reading document into cart
 161         //
 162         function read($type, $trans_no = 0, $no_edit=false) {
 163
 164                 global $SysPrefs, $Refs;
 165
 166                 if (!is_array($trans_no)) $trans_no = array($trans_no);
 167
 168                 if ($trans_no[0]) { // read old transaction
 169                         if ($type == ST_SALESORDER || $type == ST_SALESQUOTE) { // sales order || sales quotation
 170                                 read_sales_order($trans_no[0], $this, $type);
 171                         } else {        // other type of sales transaction
 172                                         read_sales_trans($type, $trans_no, $this);
 173                                         if ($this->order_no) { // free hand credit notes have no order_no
 174                                                 $sodata = get_sales_order_header($this->order_no, ST_SALESORDER);
 175                                                 $this->cust_ref = $sodata["customer_ref"];
 176                                         // currently currency is hard linked to debtor account
 177                                         //      $this->customer_currency = $sodata["curr_code"];
 178                                                 $this->delivery_to = $sodata["deliver_to"];
 179                                                 $this->delivery_address = $sodata["delivery_address"];
 180                                         }
 181                                         // child transaction reedition - update with parent info unless it is freehand
 182                                         if (!$no_edit && !($type==ST_CUSTCREDIT && $this->trans_link==0))
 183                                                 $this->set_parent_constraints($sodata, $trans_no[0]);
 184                         }
 185                         // prepare qtys for derivative document entry (not used in display)
 186                         if($no_edit) {
 187                                 for($line_no = 0; $line_no < count($this->line_items); $line_no++) {
 188                                         $line = &$this->line_items[$line_no];
 189                                         $line->src_id = $line->id; // save src line ids for update
 190                                         $line->qty_dispatched = $line->quantity - $line->qty_done;
 191                                 }
 192                         }
 193                 } else { // new document
 194                                 $this->trans_type = $type;
 195                                 $this->trans_no = 0;
 196                                 $this->customer_currency = get_company_currency();
 197                                 // set new sales document defaults here
 198                                 if (get_global_customer() != ALL_TEXT)
 199                                   $this->customer_id = get_global_customer();
 200                                 else
 201                                   $this->customer_id = '';
 202                                 $this->document_date =  new_doc_date();
 203                                 if (!is_date_in_fiscalyear($this->document_date))
 204                                         $this->document_date = end_fiscalyear();
 205                                 $this->reference = $Refs->get_next($this->trans_type);
 206                                 if ($type != ST_SALESORDER && $type != ST_SALESQUOTE) // Added 2.1 Joe Hunt 2008-11-12
 207                                 {
 208                                         $dim = get_company_pref('use_dimension');
 209                                         if ($dim > 0)
 210                                         {
 211                                                 if ($this->customer_id == '')
 212                                                         $this->dimension_id = 0;
 213                                                 else
 214                                                 {
 215                                                         $cust = get_customer($this->customer_id);
 216                                                         $this->dimension_id = $cust['dimension_id'];
 217                                                 }
 218                                                 if ($dim > 1)
 219                                                 {
 220                                                         if ($this->customer_id == '')
 221                                                                 $this->dimension2_id = 0;
 222                                                         else
 223                                                                 $this->dimension2_id = $cust['dimension2_id'];
 224                                                 }
 225                                         }
 226                                 }
 227                                 if ($type == ST_SALESINVOICE) {
 228                                         $this->due_date =
 229                                                 get_invoice_duedate($this->payment, $this->document_date);
 230                                         $this->cash = $this->payment_terms['cash_sale'];
 231                                         if ($this->cash) {
 232                                                 $this->Location = $pos['pos_location'];
 233                                                 $this->location_name = $pos['location_name'];
 234                                                 $this->cash_account = $pos['pos_account'];
 235                                                 $this->account_name = $pos['bank_account_name'];
 236                                         }
 237                                 } else
 238                                         $this->due_date =
 239                                                 add_days($this->document_date, $SysPrefs->default_delivery_required_by());
 240                         }
 241                 $this->pos = user_pos();
 242                 $pos = get_sales_point($this->pos);
 243                 if (!$pos['cash_sale'] && !$pos['credit_sale'])
 244                         $this->pos = -1; // mark not editable payment type
 245         }
 246
 247         //-------------------------------------------------------------------------
 248         // Writing new/modified sales document to database.
 249         // Makes parent documents for direct delivery/invoice by recurent call.
 250         // $policy - 0 or 1:  writeoff/return for IV, back order/cancel for DN
 251         function write($policy=0) {
 252                 begin_transaction(); // prevents partial database changes in case of direct delivery/invoice
 253                 if (count($this->src_docs) == 0 && ($this->trans_type == ST_SALESINVOICE || $this->trans_type == ST_CUSTDELIVERY)) {
 254                         // this is direct document - first add parent
 255                         $src = (PHP_VERSION<5) ? $this : clone( $this ); // make local copy of this cart
 256                         $src->trans_type = get_parent_type($src->trans_type);
 257                         $src->reference = 'auto';
 258
 259                         $src->write(1);
 260                         $type = $this->trans_type;
 261                         $ref = $this->reference;
 262                         $date = $this->document_date;
 263                         // re-read document
 264                         $this->read($src->trans_type, key($src->trans_no), true);
 265                         $this->document_date = $date;
 266                         $this->reference = $ref;
 267                         $this->trans_type = $type;
 268                         $this->src_docs= $this->trans_no;
 269                         $this->trans_no = 0;
 270                         $this->order_no= $this->trans_type==ST_CUSTDELIVERY ? key($src->trans_no) : $src->order_no;
 271                 }
 272                 $this->reference = @html_entity_decode($this->reference, ENT_QUOTES);
 273                 $this->Comments = @html_entity_decode($this->Comments, ENT_QUOTES);
 274                 foreach($this->line_items as $lineno => $line) {
 275                         $this->line_items[$lineno]->stock_id = @html_entity_decode($line->stock_id, ENT_QUOTES);
 276                         $this->line_items[$lineno]->item_description = @html_entity_decode($line->item_description, ENT_QUOTES);
 277                 }
 278                 switch($this->trans_type) {
 279                         case ST_SALESINVOICE:
 280                                 $ret = write_sales_invoice($this); break;
 281                         case ST_CUSTCREDIT:
 282                                 $ret = write_credit_note($this, $policy); break;
 283                         case ST_CUSTDELIVERY:
 284                                 $ret = write_sales_delivery($this, $policy); break;
 285                         case ST_SALESORDER:
 286                         case ST_SALESQUOTE:
 287                                 if ($this->trans_no==0) // new document
 288                                         $ret = add_sales_order($this);
 289                                 else
 290                                         $ret = update_sales_order($this);
 291                 }
 292
 293                 commit_transaction();
 294
 295                 return $ret;
 296         }
 297
 298         function set_customer($customer_id, $customer_name, $currency, $discount, $payment, $cdiscount=0)
 299         {
 300                 $this->customer_name = $customer_name;
 301                 $this->customer_id = $customer_id;
 302                 $this->default_discount = $discount;
 303                 $this->customer_currency = $currency;
 304                 $this->payment = $payment;
 305                 $this->payment_terms = get_payment_terms($payment);
 306                 $this->cash = $this->payment_terms['cash_sale'];
 307                 $this->cash_discount = $cdiscount;
 308         }
 309
 310         function set_branch($branch_id, $tax_group_id, $tax_group_name, $phone='', $email='')
 311         {
 312                 $this->Branch = $branch_id;
 313                 $this->phone = $phone;
 314                 $this->email = $email;
 315                 $this->tax_group_id = $tax_group_id;
 316                 $this->tax_group_array = get_tax_group_items_as_array($tax_group_id);
 317         }
 318
 319         function set_sales_type($sales_type, $sales_name, $tax_included=0, $factor=0)
 320         {
 321             $this->sales_type = $sales_type;
 322             $this->sales_type_name = $sales_name;
 323             $this->tax_included = $tax_included;
 324             $this->price_factor = $factor;
 325         }
 326
 327         function set_location($id, $name)
 328         {
 329                 $this->Location = $id;
 330                 $this->location_name = $name;
 331         }
 332
 333         function set_delivery($shipper, $destination, $address, $freight_cost=null)
 334         {
 335                 $this->ship_via = $shipper;
 336                 $this->deliver_to = $destination;
 337                 $this->delivery_address = $address;
 338                 if (isset($freight_cost))
 339                         $this->freight_cost = $freight_cost;
 340         }
 341
 342         function add_to_cart($line_no, $stock_id, $qty, $price, $disc, $qty_done=0, $standard_cost=0, $description=null, $id=0, $src_no=0)
 343         {
 344                 $line = new line_details($stock_id, $qty, $price, $disc,
 345                         $qty_done,  $standard_cost, $description, $id, $src_no);
 346
 347                 if ($line->valid) {
 348                         $this->line_items[$line_no] = $line;
 349                         return 1;
 350                 } else
 351                         display_error(_("You have to enter valid stock code or nonempty description"));
 352                 return 0;
 353         }
 354
 355         function update_cart_item($line_no, $qty, $price, $disc, $description="")
 356         {
 357                 if ($description != "")
 358                         $this->line_items[$line_no]->item_description = $description;
 359                 $this->line_items[$line_no]->quantity = $qty;
 360                 $this->line_items[$line_no]->qty_dispatched = $qty;
 361                 $this->line_items[$line_no]->price = $price;
 362                 $this->line_items[$line_no]->discount_percent = $disc;
 363         }
 364
 365         function update_add_cart_item_qty($line_no, $qty)
 366         {
 367                 $this->line_items[$line_no]->quantity += $qty;
 368         }
 369
 370         function remove_from_cart($line_no)
 371         {
 372                 array_splice($this->line_items, $line_no, 1);
 373         }
 374
 375         function clear_items()
 376         {
 377                 unset($this->line_items);
 378                 $this->line_items = array();
 379                 $this->sales_type = "";
 380                 $this->trans_no = 0;
 381                 $this->customer_id = $this->order_no = 0;
 382         }
 383
 384         function count_items()
 385         {
 386                 $counter=0;
 387                 foreach ($this->line_items as $line) {
 388                         if ($line->quantity!=$line->qty_done) $counter++;
 389                 }
 390                 return $counter;
 391         }
 392
 393         function get_items_total()
 394         {
 395                 $total = 0;
 396
 397                 foreach ($this->line_items as $ln_itm) {
 398                         $price = $ln_itm->line_price();
 399                         $total += round($ln_itm->quantity * $price * (1 - $ln_itm->discount_percent),
 400                            user_price_dec());
 401                 }
 402                 return $total;
 403         }
 404
 405         function get_items_total_dispatch()
 406         {
 407                 $total = 0;
 408
 409                 foreach ($this->line_items as $ln_itm) {
 410                         $price = $ln_itm->line_price();
 411                         $total += round(($ln_itm->qty_dispatched * $price * (1 - $ln_itm->discount_percent)),
 412                            user_price_dec());
 413                 }
 414                 return $total;
 415         }
 416
 417         function has_items_dispatch()
 418         {
 419                 foreach ($this->line_items as $ln_itm) {
 420                         if ($ln_itm->qty_dispatched > 0)
 421                                 return true;
 422                 }
 423                 return false;
 424         }
 425
 426         function any_already_delivered()
 427         {
 428                 /* Checks if there have been any line item processed */
 429
 430                 foreach ($this->line_items as $stock_item) {
 431                         if ($stock_item->qty_done !=0) {
 432                                 return 1;
 433                         }
 434                 }
 435
 436                 return 0;
 437
 438         }
 439
 440         function some_already_delivered($line_no)
 441         {
 442                 /* Checks if there have been deliveries of a specific line item */
 443                 if (isset($this->line_items[$line_no]) &&
 444                         $this->line_items[$line_no]->qty_done != 0) {
 445                         return 1;
 446                 }
 447                 return 0;
 448         }
 449
 450         function get_taxes($shipping_cost=null)
 451         {
 452                 $items = array();
 453                 $prices = array();
 454                 if($shipping_cost==null)
 455                         $shipping_cost = $this->freight_cost;
 456
 457                 foreach ($this->line_items as $ln_itm) {
 458                         $items[] = $ln_itm->stock_id;
 459                         $prices[] = round(($ln_itm->qty_dispatched *
 460                                 $ln_itm->line_price()* (1 - $ln_itm->discount_percent)),  user_price_dec());
 461                 }
 462
 463                 $taxes = get_tax_for_items($items, $prices, $shipping_cost,
 464                   $this->tax_group_id, $this->tax_included,  $this->tax_group_array);
 465
 466     // Adjustment for swiss franken, we always have 5 rappen = 1/20 franken
 467     if ($this->customer_currency == 'CHF') {
 468                         $val = $taxes['1']['Value'];
 469       $val1 = (floatval((intval(round(($val*20),0)))/20));
 470                         $taxes['1']['Value'] = $val1;
 471                 }
 472                 return $taxes;
 473         }
 474
 475
 476         function get_tax_free_shipping()
 477         {
 478
 479                 if ($this->tax_included==0)
 480                         return $this->freight_cost;
 481                 else
 482                         return ($this->freight_cost - $this->get_shipping_tax());
 483         }
 484
 485         function get_shipping_tax()
 486         {
 487
 488                 $tax_items = get_shipping_tax_as_array();
 489                 $tax_rate = 0;
 490                 if ($tax_items != null) {
 491                         foreach ($tax_items as $item_tax) {
 492                                 $index = $item_tax['tax_type_id'];
 493                                 if (isset($this->tax_group_array[$index])) {
 494                                         $tax_rate += $item_tax['rate'];
 495                                 }
 496                         }
 497                 }
 498                 if($this->tax_included)
 499                         return round($this->freight_cost*$tax_rate/($tax_rate+100),  user_price_dec());
 500                 else
 501                         return round($this->freight_cost*$tax_rate/100,  user_price_dec());
 502         }
 503
 504 } /* end of class defintion */
 505
 506 class line_details
 507 {
 508         var $id;
 509         var $stock_id;
 510         var $item_description;
 511         var $units;
 512         var $mb_flag;
 513         var $tax_type;
 514         var $tax_type_name;
 515         var $src_no;    // number of src doc for this line
 516         var $src_id;
 517         var $price;
 518         var $discount_percent;
 519
 520         var $standard_cost;
 521         var $descr_editable;
 522
 523         var $valid; // validation in constructor
 524         /*
 525                 Line quantity properties in various cart create modes:
 526
 527                 view:
 528                 $quantity - quantity on current document
 529                 $qty_done - quantity processed on all child documents
 530                 $qty_dispatched - not used
 531                 $qty_old - not used
 532
 533                 edit:
 534                 $quantity - free parent quantity including this doc (= max allowed quantity)
 535                 $qty_done - qty processed on child documents (= min allowed qty)
 536                 $qty_dispatched - quantity currently selected to process
 537                 $qty_old - quantity processed on this document before reedition
 538
 539                 new child entry (view parent followed by prepare_child() call):
 540                 $quantity - max allowed quantity (get from parent)
 541                 $qty_done - qty processed on other child documents
 542                 $qty_dispatched - quantity currently selected to process
 543                 $qty_old - 0; not used
 544         */
 545         var $quantity;
 546         var $qty_done;
 547         var $qty_dispatched;
 548         var $qty_old = 0;
 549
 550
 551         function line_details ($stock_id, $qty, $prc, $disc_percent,
 552                 $qty_done, $standard_cost, $description, $id=0, $src_no=0 )
 553         {
 554         /* Constructor function to add a new LineDetail object with passed params */
 555
 556                 $this->id = $id;
 557                 $this->src_no = $src_no;
 558                 $item_row = get_item($stock_id);
 559
 560                 if (!$item_row)
 561                         return;
 562
 563                 $this->mb_flag = $item_row["mb_flag"];
 564                 $this->units = $item_row["units"];
 565                 $this->descr_editable = $item_row["editable"];
 566                 if ($description == null || !$this->descr_editable)
 567                         $this->item_description = $item_row["description"];
 568                 else
 569                         $this->item_description = $description;
 570                 //$this->standard_cost = $item_row["material_cost"] + $item_row["labour_cost"] + $item_row["overhead_cost"];
 571                 $this->tax_type = $item_row["tax_type_id"];
 572                 $this->tax_type_name = $item_row["tax_type_name"];
 573                 $this->stock_id = $stock_id;
 574                 $this->quantity = $qty;
 575                 $this->qty_dispatched = $qty;
 576                 $this->price = $prc;
 577                 $this->discount_percent = $disc_percent;
 578                 $this->qty_done = $qty_done;
 579                 $this->standard_cost = $standard_cost;
 580                 $this->valid = true;
 581         }
 582
 583         // get unit price as stated on document
 584         function line_price()
 585         {
 586                 return $this->price;
 587         }
 588 }
 589
 590 ?>