Changed all numeric constants to the new defined constants. A huge task.
[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         var $trans_link = 0;
59
60         var $ship_via;
61         var $freight_cost = 0;
62
63         var $tax_group_id;
64         var $tax_group_name;
65         var $tax_group_array = null; // saves db queries
66         var $price_factor;       // ditto for price calculations
67
68         var     $pos;                   // user assigned POS
69         var $cash;                      // cash transaction
70         var $cash_account;
71         var $account_name;
72         var $cash_discount;     // not used as of FA 2.1
73         var $dimension_id;
74         var $dimension2_id;
75         //-------------------------------------------------------------------------
76         //
77         //  $trans_no==0 => open new/direct document
78         //  $trans_no!=0 && $view==false => read for view
79         //  $trans_no!=0 && $view==true => read for edit (qty update from parent doc)
80         //
81         function Cart($type, $trans_no=0, $view=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->read($type, $trans_no, $view );
92                 $this->cart_id = uniqid('');
93         }
94
95         //-------------------------------------------------------------------------
96         // Reading document into cart
97         //
98         function read($type, $trans_no = 0, $view=false ) {
99
100                 global $SysPrefs, $Refs;
101
102                 if (!is_array($trans_no)) $trans_no = array($trans_no);
103                 if ($trans_no[0]) {
104                         if ($type == ST_SALESORDER || $type == ST_SALESQUOTE) { // sales order || sales quotation
105                                 read_sales_order($trans_no[0], $this, $type);
106                                 if ($view) {    // prepare for DN/IV entry
107                                         for($line_no = 0; $line_no < count($this->line_items); $line_no++) {
108                                                 $line = &$this->line_items[$line_no];
109                                                 $line->src_id = $line->id; // save src line ids for update
110                                                 $line->qty_dispatched = $line->quantity - $line->qty_done;
111                                         }
112                                 }
113                         } else {        // derivative transaction
114                                         read_sales_trans($type, $trans_no, $this);
115                                         if ($this->order_no) { // free hand credit notes have no order_no
116                                                 $sodata = get_sales_order_header($this->order_no, ST_SALESORDER);
117                                                 $this->cust_ref = $sodata["customer_ref"];
118                                         // currently currency is hard linked to debtor account
119                                         //      $this->customer_currency = $sodata["curr_code"];
120                                                 $this->delivery_to = $sodata["deliver_to"];
121                                                 $this->delivery_address = $sodata["delivery_address"];
122                                         }
123                                         if (!$view && ($type!=11 || $this->trans_link!=0)) {
124                                                 $src_type = get_parent_type($type);
125                                                 $src_details = 0;
126                                                 if ($src_type == ST_SALESORDER) { // get src data from sales_orders
127                                                         $this->src_docs = array( $sodata['order_no']=>$sodata['version']);
128                                                         $srcdetails = get_sales_order_details($this->order_no, ST_SALESORDER);
129                                                 } else {        // get src_data from debtor_trans
130                                                         $this->src_docs = get_customer_trans_version($src_type, get_parent_trans($type,$trans_no[0]));
131                                                         $srcdetails = get_customer_trans_details($src_type,array_keys($this->src_docs));
132                                                 }
133                                                 // calculate & save: qtys on other docs and free qtys on src doc
134                                                 $line_no = 0;
135                                                 for($line_no = 0; $srcline = db_fetch($srcdetails); $line_no++) {
136                                                         $sign = 1; // $type==13 ?  1 : -1; // this is strange debtor_trans atavism
137                                                         $line = &$this->line_items[$line_no];
138
139                                                         $line->src_id = $srcline['id']; // save src line ids for update
140                                                         $line->qty_old = $line->qty_dispatched = $line->quantity;
141                                                         $line->quantity += $sign * ($srcline['quantity'] - $srcline['qty_done']); // add free qty on src doc
142                                                 }
143                                         } else {
144                                                 for($line_no = 0; $line_no < count($this->line_items); $line_no++) {
145                                                         $line = &$this->line_items[$line_no];
146                                                         $line->src_id = $line->id; // save src line ids for update
147                                                         $line->qty_dispatched = $line->quantity;
148                                                 }
149                                         }
150                                 }
151                         } else {
152                                 $this->trans_type = $type;
153                                 $this->trans_no = 0;
154                                 // set new sales document defaults here
155                                 if (get_global_customer() != ALL_TEXT)
156                                   $this->customer_id = get_global_customer();
157                                 else
158                                   $this->customer_id = '';
159                                 $this->document_date =  new_doc_date();
160                                 if (!is_date_in_fiscalyear($this->document_date))
161                                         $this->document_date = end_fiscalyear();
162                                 $this->reference = $Refs->get_next($this->trans_type);
163                                 if ($type != ST_SALESORDER && $type != ST_SALESQUOTE) // Added 2.1 Joe Hunt 2008-11-12
164                                 {
165                                         $dim = get_company_pref('use_dimension');
166                                         if ($dim > 0)
167                                         {
168                                                 if ($this->customer_id == '')
169                                                         $this->dimension_id = 0;
170                                                 else
171                                                 {
172                                                         $cust = get_customer($this->customer_id);
173                                                         $this->dimension_id = $cust['dimension_id'];
174                                                 }       
175                                                 if ($dim > 1)
176                                                 {
177                                                         if ($this->customer_id == '')
178                                                                 $this->dimension2_id = 0;
179                                                         else
180                                                                 $this->dimension2_id = $cust['dimension2_id'];
181                                                 }               
182                                         }               
183                                 }       
184                                 if ($type == ST_SALESINVOICE) {
185                                   $this->due_date =
186                                         get_invoice_duedate($this->customer_id, $this->document_date);
187                                   $this->pos = user_pos();
188                                   $pos = get_sales_point($this->pos);
189                                   $this->cash = !$pos['credit_sale'];
190                                   if (!$pos['cash_sale'] || !$pos['credit_sale']) 
191                                         $this->pos = -1; // mark not editable payment type
192                                   else
193                                         $this->cash = date_diff2($this->due_date, Today(), 'd')<2;
194                                 if ($this->cash) {
195                                         $this->Location = $pos['pos_location'];
196                                         $this->location_name = $pos['location_name'];
197                                         $this->cash_account = $pos['pos_account'];
198                                         $this->account_name = $pos['bank_account_name'];
199                                 }
200                                 } else
201                                   $this->due_date =
202                                         add_days($this->document_date, $SysPrefs->default_delivery_required_by());
203                         }
204         }
205
206         //-------------------------------------------------------------------------
207         // Writing new/modified sales document to database.
208         // Makes parent documents for direct delivery/invoice by recurent call.
209         // $policy - 0 or 1:  writeoff/return for IV, back order/cancel for DN
210         function write($policy=0) {
211                 if (count($this->src_docs) == 0 && ($this->trans_type == ST_SALESINVOICE || $this->trans_type == ST_CUSTDELIVERY)) {
212                         // this is direct document - first add parent
213                         $src = (PHP_VERSION<5) ? $this : clone( $this ); // make local copy of this cart
214                         $src->trans_type = get_parent_type($src->trans_type);
215                         $src->reference = 'auto';
216
217                         $src->write(1);
218                         $type = $this->trans_type;
219                         $ref = $this->reference;
220                         $date = $this->document_date;
221                         // re-read document
222                         $this->read($src->trans_type, key($src->trans_no), true);
223                         $this->document_date = $date;
224                         $this->reference = $ref;
225                         $this->trans_type = $type;
226                         $this->src_docs= $this->trans_no;
227                         $this->trans_no = 0;
228                         $this->order_no= $this->trans_type==ST_CUSTDELIVERY ? key($src->trans_no) : $src->order_no;
229                 }
230                 $this->reference = @html_entity_decode($this->reference);
231                 $this->Comments = @html_entity_decode($this->Comments);
232                 foreach($this->line_items as $lineno => $line) {
233                         $this->line_items[$lineno]->stock_id = @html_entity_decode($line->stock_id);
234                         $this->line_items[$lineno]->item_description = @html_entity_decode($line->item_description);
235                 }
236                 switch($this->trans_type) {
237                         case ST_SALESINVOICE:
238                                 return write_sales_invoice($this);
239                         case ST_CUSTCREDIT:
240                                 return write_credit_note($this, $policy);
241                         case ST_CUSTDELIVERY:
242                                 return write_sales_delivery($this, $policy);
243                         case ST_SALESORDER:
244                         case ST_SALESQUOTE:
245                                 if ($this->trans_no==0) // new document
246                                         return add_sales_order($this);
247                                 else
248                                         return update_sales_order($this);
249                 }
250         }
251
252         function set_customer($customer_id, $customer_name, $currency, $discount, $cdiscount=0)
253         {
254                 $this->customer_name = $customer_name;
255                 $this->customer_id = $customer_id;
256                 $this->default_discount = $discount;
257                 $this->cash_discount = $cdiscount;
258                 $this->customer_currency = $currency;
259         }
260
261         function set_branch($branch_id, $tax_group_id, $tax_group_name, $phone='', $email='')
262         {
263                 $this->Branch = $branch_id;
264                 $this->phone = $phone;
265                 $this->email = $email;
266                 $this->tax_group_id = $tax_group_id;
267                 $this->tax_group_array = get_tax_group_items_as_array($tax_group_id);
268         }
269
270         function set_sales_type($sales_type, $sales_name, $tax_included=0, $factor=0)
271         {
272             $this->sales_type = $sales_type;
273             $this->sales_type_name = $sales_name;
274             $this->tax_included = $tax_included;
275             $this->price_factor = $factor;
276         }
277
278         function set_location($id, $name)
279         {
280                 $this->Location = $id;
281                 $this->location_name = $name;
282         }
283
284         function set_delivery($shipper, $destination, $address, $freight_cost=null)
285         {
286                 $this->ship_via = $shipper;
287                 $this->deliver_to = $destination;
288                 $this->delivery_address = $address;
289                 if (isset($freight_cost))
290                         $this->freight_cost = $freight_cost;
291         }
292
293         function add_to_cart($line_no,$stock_id, $qty, $price, $disc, $qty_done=0, $standard_cost=0, $description=null, $id=0, $src_no=0)
294         {
295                 if (isset($stock_id) && $stock_id != "" && isset($qty)/* && $qty > 0*/) {
296                         $this->line_items[$line_no] = new line_details($stock_id, $qty, $price, $disc,
297                                 $qty_done,  $standard_cost, $description, $id, $src_no);
298                         return 1;
299                 } else {
300                         // shouldn't come here under normal circumstances
301                         display_db_error("unexpected - adding an invalid item or null quantity", "", true);
302                 }
303                 return 0;
304         }
305
306         function update_cart_item($line_no, $qty, $price, $disc, $description="")
307         {
308                 if ($description != "")
309                         $this->line_items[$line_no]->item_description = $description;
310                 $this->line_items[$line_no]->quantity = $qty;
311                 $this->line_items[$line_no]->qty_dispatched = $qty;
312                 $this->line_items[$line_no]->price = $price;
313                 $this->line_items[$line_no]->discount_percent = $disc;
314         }
315
316         function update_add_cart_item_qty($line_no, $qty)
317         {
318                 $this->line_items[$line_no]->quantity += $qty;
319         }
320
321         function remove_from_cart($line_no)
322         {
323                 array_splice($this->line_items, $line_no, 1);
324         }
325
326         function clear_items()
327         {
328                 unset($this->line_items);
329                 $this->line_items = array();
330                 $this->sales_type = "";
331                 $this->trans_no = 0;
332                 $this->customer_id = $this->order_no = 0;
333         }
334
335         function count_items()
336         {
337                 $counter=0;
338                 foreach ($this->line_items as $line) {
339                         if ($line->quantity!=$line->qty_done) $counter++;
340                 }
341                 return $counter;
342         }
343
344         function get_items_total()
345         {
346                 $total = 0;
347
348                 foreach ($this->line_items as $ln_itm) {
349                         $price = $ln_itm->line_price();
350                         $total += round($ln_itm->quantity * $price * (1 - $ln_itm->discount_percent), 
351                            user_price_dec());
352                 }
353                 return $total;
354         }
355
356         function get_items_total_dispatch()
357         {
358                 $total = 0;
359
360                 foreach ($this->line_items as $ln_itm) {
361                         $price = $ln_itm->line_price();
362                         $total += round(($ln_itm->qty_dispatched * $price * (1 - $ln_itm->discount_percent)), 
363                            user_price_dec());
364                 }
365                 return $total;
366         }
367
368         function has_items_dispatch()
369         {
370                 foreach ($this->line_items as $ln_itm) {
371                         if ($ln_itm->qty_dispatched > 0)
372                                 return true;
373                 }
374                 return false;
375         }
376
377         function any_already_delivered()
378         {
379                 /* Checks if there have been any line item processed */
380
381                 foreach ($this->line_items as $stock_item) {
382                         if ($stock_item->qty_done !=0) {
383                                 return 1;
384                         }
385                 }
386
387                 return 0;
388
389         }
390
391         function some_already_delivered($line_no)
392         {
393                 /* Checks if there have been deliveries of a specific line item */
394                 if (isset($this->line_items[$line_no]) &&
395                         $this->line_items[$line_no]->qty_done != 0) {
396                         return 1;
397                 }
398                 return 0;
399         }
400
401         function get_taxes($shipping_cost=null)
402         {
403                 $items = array();
404                 $prices = array();
405                 if($shipping_cost==null)
406                         $shipping_cost = $this->freight_cost;
407
408                 foreach ($this->line_items as $ln_itm) {
409                         $items[] = $ln_itm->stock_id;
410                         $prices[] = round(($ln_itm->qty_dispatched *
411                                 $ln_itm->line_price()* (1 - $ln_itm->discount_percent)),  user_price_dec());
412                 }
413
414                 $taxes = get_tax_for_items($items, $prices, $shipping_cost,
415                   $this->tax_group_id, $this->tax_included,  $this->tax_group_array);
416
417     // Adjustment for swiss franken, we always have 5 rappen = 1/20 franken
418     if ($this->customer_currency == 'CHF') {
419                         $val = $taxes['1']['Value'];
420       $val1 = (floatval((intval(round(($val*20),0)))/20));
421                         $taxes['1']['Value'] = $val1;
422                 } 
423                 return $taxes;
424         }
425
426
427         function get_tax_free_shipping()
428         {
429
430                 if ($this->tax_included==0)
431                         return $this->freight_cost;
432                 else
433                         return ($this->freight_cost - $this->get_shipping_tax());
434         }
435
436         function get_shipping_tax()
437         {
438
439                 $tax_items = get_shipping_tax_as_array();
440                 $tax_rate = 0;
441                 if ($tax_items != null) {
442                         foreach ($tax_items as $item_tax) {
443                                 $index = $item_tax['tax_type_id'];
444                                 if (isset($this->tax_group_array[$index])) {
445                                         $tax_rate += $item_tax['rate'];
446                                 }
447                         }
448                 }
449                 if($this->tax_included)
450                         return round($this->freight_cost*$tax_rate/($tax_rate+100),  user_price_dec());
451                 else
452                         return round($this->freight_cost*$tax_rate/100,  user_price_dec());
453         }
454
455 } /* end of class defintion */
456
457 class line_details
458 {
459         var $id;
460         var $stock_id;
461         var $item_description;
462         var $units;
463         var $mb_flag;
464         var $tax_type;
465         var $tax_type_name;
466         var $src_no;    // number of src doc for this line
467         var $src_id;
468         var $quantity;
469         var $price;
470         var $discount_percent;
471         var $qty_done;  // quantity processed on child documents
472         var $qty_dispatched; // quantity selected to process
473         var $qty_old=0; // quantity dispatched before edition
474         var $standard_cost;
475
476         function line_details ($stock_id, $qty, $prc, $disc_percent,
477                 $qty_done, $standard_cost, $description, $id=0, $src_no=0 )
478         {
479         /* Constructor function to add a new LineDetail object with passed params */
480
481                 $this->id = $id;
482                 $this->src_no = $src_no;
483                 $item_row = get_item($stock_id);
484
485                 if ($item_row == null)
486                         display_db_error("invalid item added to order : $stock_id", "");
487
488                 $this->mb_flag = $item_row["mb_flag"];
489                 $this->units = $item_row["units"];
490                 if ($description == null)
491                         $this->item_description = $item_row["description"];
492                 else
493                         $this->item_description = $description;
494                 //$this->standard_cost = $item_row["material_cost"] + $item_row["labour_cost"] + $item_row["overhead_cost"];
495                 $this->tax_type = $item_row["tax_type_id"];
496                 $this->tax_type_name = $item_row["tax_type_name"];
497
498                 $this->stock_id = $stock_id;
499                 $this->quantity = $qty;
500                 $this->qty_dispatched = $qty;
501                 $this->price = $prc;
502                 $this->discount_percent = $disc_percent;
503                 $this->qty_done = $qty_done;
504                 $this->standard_cost = $standard_cost;
505         }
506
507         // get unit price as stated on document
508         function line_price()
509         {
510                 return $this->price;
511         }
512 }
513
514 ?>