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