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