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