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