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