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