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:
21 include_once($path_to_root . "/inventory/includes/inventory_db.inc");
22 include_once($path_to_root . "/taxes/tax_calc.inc");
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
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)
37 var $sales_type; // set to the customer's sales type
38 var $sales_type_name; // set to customer's sales type name
41 var $customer_currency; // set to the customer's currency
42 var $default_discount; // set to the customer's discount %
49 var $delivery_address;
57 var $order_no; // the original order number
60 var $freight_cost = 0;
64 var $tax_group_array = null; // saves db queries
65 var $price_factor; // ditto for price calculations
67 var $pos; // user assigned POS
70 var $cash_discount; // not used as of FA 2.1
74 var $payment_terms; // cached payment terms
78 var $prepaid; // true for documents issued in prepayment mode
79 var $prep_amount; // prepayment required for SO, invoiced amount for prepaiament invoice
80 var $sum_paid; // sum of all allocated prepayments both to order and related invoices
81 var $alloc; // sum of payments allocated to this document
82 var $prepayments = array(); // allocation records for this document
83 //-------------------------------------------------------------------------
85 // $trans_no==0 => open new/direct document
86 // $trans_no!=0 && $prepare_child==false => update with parent constarints for reedition
87 // $trans_no!=0 && $prepare_child==true => prepare for child doc entry
88 // $prepare_child is set to ST_SALESINVOICE for prepayment invoices
90 function Cart($type, $trans_no=0, $prepare_child=false) {
91 /*Constructor function initialises a new shopping cart */
92 $this->line_items = array();
93 $this->sales_type = "";
94 if ($type == ST_SALESQUOTE)
95 $this->trans_type = $type;
97 $this->trans_type = ST_SALESORDER;
98 $this->dimension_id = 0;
99 $this->dimension2_id = 0;
100 $this->pos = get_sales_point(user_pos());
101 $this->read($type, $trans_no, $prepare_child);
102 $this->cart_id = uniqid('');
106 Optional sorting items by stock_id.
108 function _cmp_lines($a, $b)
110 return strcmp($a->stock_id, $b->stock_id);
114 Returns items array optionally sorted by item code.
118 global $sort_sales_items;
120 $items = $this->line_items;
121 if (@$sort_sales_items)
122 uasort($items, array($this, '_cmp_lines'));
127 // Prepare cart to new child document entry, just after initial parent doc read.
129 function prepare_child($type)
134 $type = get_child_type($this->trans_type);
136 $this->trans_type = $type;
137 $this->reference = $Refs->get_next($this->trans_type);
138 if ($type == ST_CUSTCREDIT)
139 $this->src_date = $this->document_date;
141 $this->document_date = new_doc_date();
143 for($line_no = 0; $line_no < count($this->line_items); $line_no++) {
144 $line = &$this->line_items[$line_no];
145 $line->src_id = $line->id; // save src line ids for update
146 $line->qty_dispatched = $type == ST_CUSTCREDIT ? '0' :
147 (($this->prepaid && $type == ST_SALESINVOICE) ? $line->quantity : $line->quantity - $line->qty_done);
152 if ($type == ST_CUSTDELIVERY) {
153 $this->order_no = key($this->trans_no);
154 $cust = get_customer($this->customer_id);
155 $this->dimension_id = $cust['dimension_id'];
156 $this->dimension2_id = $cust['dimension2_id'];
158 if ($type == ST_SALESINVOICE) {
159 $this->due_date = get_invoice_duedate($this->payment, $this->document_date);
162 $this->src_docs = $this->trans_no;
167 // Prepares transaction for reedition updating with parent transaction data
169 function set_parent_constraints($sodata, $src_no) {
171 $srcdetails = get_sales_parent_lines($this->trans_type, $src_no);
172 $src_type = get_parent_type($this->trans_type);
174 // calculate & save: qtys on other docs and free qtys on src doc
175 $line_no = 0; $src_docs = array();
176 // Loop speed optimisation below depends on fact
177 // that child line_items contains subset of parent lines in _the_same_ order !
178 while (($line_no < count($this->line_items)) && ($srcline = db_fetch($srcdetails))) {
179 $line = &$this->line_items[$line_no];
180 $src_docs[] = $src_type == ST_SALESORDER ? $srcline['order_no'] : $srcline['debtor_trans_no'];
181 if ($srcline['id'] == $line->src_id) {
182 if ($this->trans_type == ST_SALESINVOICE)
183 $line->src_no = $srcline['debtor_trans_no'];
184 $line->qty_old = $line->qty_dispatched = $line->quantity;
185 $line->quantity += $srcline['quantity'] -
186 ($src_type==ST_SALESORDER ? $srcline['qty_sent'] : $srcline['qty_done']); // add free qty on src doc
191 if ($src_type == ST_SALESORDER || $src_type == 0) {
192 $this->src_docs = array( $sodata['order_no']=>$sodata['version']);
194 // get src_data from debtor_trans
195 $this->src_docs = get_customer_trans_version($src_type, array_unique($src_docs));
198 //-------------------------------------------------------------------------
199 // Reading document into cart
201 function read($type, $trans_no=0, $prepare_child=false) {
203 global $SysPrefs, $Refs;
205 if (!is_array($trans_no)) $trans_no = array($trans_no);
207 if ($trans_no[0]) { // read old transaction
208 if ($type == ST_SALESORDER || $type == ST_SALESQUOTE) { // sales order || sales quotation
209 read_sales_order($trans_no[0], $this, $type);
210 } else { // other type of sales transaction
211 read_sales_trans($type, $trans_no, $this);
212 $this->prepayments = get_payments_for($trans_no[0], $type);
213 if ($this->order_no) { // free hand credit notes have no order_no
214 $sodata = get_sales_order_header($this->order_no, ST_SALESORDER);
215 $this->cust_ref = $sodata["customer_ref"];
216 // currently currency is hard linked to debtor account
217 // $this->customer_currency = $sodata["curr_code"];
218 $this->delivery_to = $sodata["deliver_to"];
219 $this->delivery_address = $sodata["delivery_address"];
220 // child transaction reedition - update with parent info unless it is freehand
221 if (!$this->is_prepaid() && !$prepare_child) // this is read for view/reedition
222 $this->set_parent_constraints($sodata, $trans_no[0]);
225 // convert document into child and prepare qtys for entry
227 $this->prepare_child($prepare_child);
229 } else { // new document
230 $this->trans_type = $type;
232 $this->customer_currency = get_company_currency();
233 // set new sales document defaults here
234 if (get_global_customer() != ALL_TEXT)
235 $this->customer_id = get_global_customer();
237 $this->customer_id = '';
238 $this->document_date = new_doc_date();
239 if (!is_date_in_fiscalyear($this->document_date))
240 $this->document_date = end_fiscalyear();
241 $this->reference = $Refs->get_next($this->trans_type);
242 if ($type != ST_SALESORDER && $type != ST_SALESQUOTE) // Added 2.1 Joe Hunt 2008-11-12
244 $dim = get_company_pref('use_dimension');
247 if ($this->customer_id == '')
248 $this->dimension_id = 0;
251 $cust = get_customer($this->customer_id);
252 $this->dimension_id = $cust['dimension_id'];
256 if ($this->customer_id == '')
257 $this->dimension2_id = 0;
259 $this->dimension2_id = $cust['dimension2_id'];
263 if ($type == ST_SALESINVOICE) {
265 get_invoice_duedate($this->payment, $this->document_date);
268 add_days($this->document_date, $SysPrefs->default_delivery_required_by());
270 $this->credit = get_current_cust_credit($this->customer_id);
273 //-------------------------------------------------------------------------
274 // Writing new/modified sales document to database.
275 // Makes parent documents for direct delivery/invoice by recurent call.
276 // $policy - 0 or 1: writeoff/return for IV, back order/cancel for DN
277 function write($policy=0) {
279 begin_transaction(); // prevents partial database changes in case of direct delivery/invoice
280 if ($this->reference != 'auto' && $this->trans_no == 0 && !is_new_reference($this->reference, $this->trans_type))
282 commit_transaction();
285 if (count($this->src_docs) == 0 && ($this->trans_type == ST_SALESINVOICE || $this->trans_type == ST_CUSTDELIVERY) && !$this->is_prepaid()) {
286 // this is direct document - first add parent
287 $ref = $this->reference;
288 $date = $this->document_date;
289 $due_date = $this->due_date;
290 $dimension_id = $this->dimension_id;
291 $dimension2_id = $this->dimension2_id;
292 $this->trans_type = get_parent_type($this->trans_type);
294 $this->reference = 'auto';
295 $trans_no = $this->write(1);
297 // re-read parent document converting it to child
298 $this->read($this->trans_type, $trans_no, true);
299 $this->document_date = $date;
300 $this->reference = $ref;
301 $this->due_date = $due_date;
302 $this->dimension_id = $dimension_id;
303 $this->dimension2_id = $dimension2_id;
305 $this->reference = @html_entity_decode($this->reference, ENT_QUOTES);
306 $this->Comments = @html_entity_decode($this->Comments, ENT_QUOTES);
307 foreach($this->line_items as $lineno => $line) {
308 $this->line_items[$lineno]->stock_id = @html_entity_decode($line->stock_id, ENT_QUOTES);
309 $this->line_items[$lineno]->item_description = @html_entity_decode($line->item_description, ENT_QUOTES);
311 switch($this->trans_type) {
312 case ST_SALESINVOICE:
313 $ret = write_sales_invoice($this); break;
315 $ret = write_credit_note($this, $policy); break;
316 case ST_CUSTDELIVERY:
317 $ret = write_sales_delivery($this, $policy); break;
320 if ($this->trans_no==0) // new document
321 $ret = add_sales_order($this);
323 $ret = update_sales_order($this);
326 commit_transaction();
331 function set_customer($customer_id, $customer_name, $currency, $discount, $payment, $cdiscount=0)
333 $this->customer_name = $customer_name;
334 $this->customer_id = $customer_id;
335 $this->default_discount = $discount;
336 $this->customer_currency = $currency;
337 $this->payment = $payment;
338 $this->payment_terms = get_payment_terms($payment);
339 $this->cash_discount = $cdiscount;
341 if ($this->payment_terms['cash_sale']) {
342 $this->Location = $this->pos['pos_location'];
343 $this->location_name = $this->pos['location_name'];
345 $this->credit = get_current_cust_credit($customer_id);
348 function set_branch($branch_id, $tax_group_id, $tax_group_name, $phone='', $email='')
350 $this->Branch = $branch_id;
351 $this->phone = $phone;
352 $this->email = $email;
353 $this->tax_group_id = $tax_group_id;
354 $this->tax_group_array = get_tax_group_items_as_array($tax_group_id);
357 function set_sales_type($sales_type, $sales_name, $tax_included=0, $factor=0)
359 $this->sales_type = $sales_type;
360 $this->sales_type_name = $sales_name;
361 $this->tax_included = $tax_included;
362 $this->price_factor = $factor;
365 function set_location($id, $name)
367 $this->Location = $id;
368 $this->location_name = $name;
371 function set_delivery($shipper, $destination, $address, $freight_cost=null)
373 $this->ship_via = $shipper;
374 $this->deliver_to = $destination;
375 $this->delivery_address = $address;
376 if (isset($freight_cost))
377 $this->freight_cost = $freight_cost;
380 function add_to_cart($line_no, $stock_id, $qty, $price, $disc, $qty_done=0, $standard_cost=0, $description=null, $id=0, $src_no=0,
383 $line = new line_details($stock_id, $qty, $price, $disc,
384 $qty_done, $standard_cost, $description, $id, $src_no, $src_id);
387 $this->line_items[$line_no] = $line;
390 display_error(_("You have to enter valid stock code or nonempty description"));
394 function update_cart_item($line_no, $qty, $price, $disc, $description="")
396 if ($description != "")
397 $this->line_items[$line_no]->item_description = $description;
398 $this->line_items[$line_no]->quantity = $qty;
399 $this->line_items[$line_no]->qty_dispatched = $qty;
400 $this->line_items[$line_no]->price = $price;
401 $this->line_items[$line_no]->discount_percent = $disc;
404 function update_add_cart_item_qty($line_no, $qty)
406 $this->line_items[$line_no]->quantity += $qty;
409 function remove_from_cart($line_no)
411 array_splice($this->line_items, $line_no, 1);
414 function clear_items()
416 unset($this->line_items);
417 $this->line_items = array();
418 $this->sales_type = "";
420 $this->customer_id = $this->order_no = 0;
423 function count_items()
426 foreach ($this->line_items as $line) {
427 if ($line->quantity!=$line->qty_done) $counter++;
432 function get_items_total()
436 foreach ($this->line_items as $ln_itm) {
437 $price = $ln_itm->line_price();
438 $total += round($ln_itm->quantity * $price * (1 - $ln_itm->discount_percent),
444 function get_items_total_dispatch()
448 foreach ($this->line_items as $ln_itm) {
449 $price = $ln_itm->line_price();
450 $total += round(($ln_itm->qty_dispatched * $price * (1 - $ln_itm->discount_percent)),
456 function has_items_dispatch()
458 foreach ($this->line_items as $ln_itm) {
459 if ($ln_itm->qty_dispatched > 0)
465 function any_already_delivered()
467 /* Checks if there have been any line item processed */
469 foreach ($this->line_items as $stock_item) {
470 if ($stock_item->qty_done !=0) {
479 function some_already_delivered($line_no)
481 /* Checks if there have been deliveries of a specific line item */
482 if (isset($this->line_items[$line_no]) &&
483 $this->line_items[$line_no]->qty_done != 0) {
489 function get_taxes($shipping_cost=null)
493 if($shipping_cost==null)
494 $shipping_cost = $this->freight_cost;
496 foreach ($this->line_items as $ln_itm) {
497 $items[] = $ln_itm->stock_id;
499 $this->trans_type==ST_SALESORDER ? $ln_itm->quantity : $ln_itm->qty_dispatched) *
500 $ln_itm->line_price()* (1 - $ln_itm->discount_percent)), user_price_dec());
503 $taxes = get_tax_for_items($items, $prices, $shipping_cost,
504 $this->tax_group_id, $this->tax_included, $this->tax_group_array);
506 // Adjustment for swiss franken, we always have 5 rappen = 1/20 franken
507 if ($this->customer_currency == 'CHF') {
508 $val = $taxes['1']['Value'];
509 $val1 = (floatval((intval(round(($val*20),0)))/20));
510 $taxes['1']['Value'] = $val1;
516 function get_tax_free_shipping()
519 if ($this->tax_included==0)
520 return $this->freight_cost;
522 return ($this->freight_cost - $this->get_shipping_tax());
525 function get_shipping_tax()
528 $tax_items = get_shipping_tax_as_array($this->tax_group_id);
530 if ($tax_items != null) {
531 foreach ($tax_items as $item_tax) {
532 $index = $item_tax['tax_type_id'];
533 if (isset($this->tax_group_array[$index]['rate'])) {
534 $tax_rate += $item_tax['rate'];
538 if($this->tax_included)
539 return round($this->freight_cost*$tax_rate/($tax_rate+100), user_price_dec());
541 return round($this->freight_cost*$tax_rate/100, user_price_dec());
544 Returns transaction value including all taxes
546 function get_trans_total() {
548 $total = $this->get_items_total() + $this->freight_cost;
549 $dec = user_price_dec();
550 if (!$this->tax_included ) {
551 $total += $this->get_shipping_tax();
552 $taxes = $this->get_taxes();
553 foreach($taxes as $tax)
554 $total += round($tax['Value'], $dec);
561 Returns true for documents issued in prepayment cycle.
563 function is_prepaid()
565 return $this->prepaid; //floatcmp($this->prep_amount, 0) > 0;
568 Order is ready for delivery in prepament mode.
570 function is_released()
572 return floatcmp($this->sum_paid, $this->prep_amount) >= 0;
576 Check whether order has been already invoiced/send or not.
578 function is_started()
580 if ($this->trans_no==0)
582 $order_no = array_keys($this->trans_no);
584 return is_sales_order_started(reset($order_no));
588 Check payment terms and prepayments selected for this invoice,
589 and updates partial/final invoice value respectively.
591 function update_payments()
593 $remainder = prepaid_invoice_remainder($this->order_no);
595 // recalculate prepaid part from payments
596 if ($this->payment_terms['days_before_due'] < 0)
597 { // this is partial invoice for selected prepayments made.
599 foreach($this->prepayments as $payment)
600 $paid += $payment['amt'];
601 $this->prep_amount = min($remainder, $paid);
602 } else // this is final invoice
603 $this->prep_amount = $remainder;
605 } /* end of class defintion */
611 var $item_description;
616 var $src_no; // number of src doc for this line
619 var $discount_percent;
624 var $valid; // validation in constructor
626 Line quantity properties in various cart create modes:
629 $quantity - quantity on current document
630 $qty_done - quantity processed on all child documents
631 $qty_dispatched - not used
635 $quantity - free parent quantity including this doc (= max allowed quantity)
636 $qty_done - qty processed on child documents (= min allowed qty)
637 $qty_dispatched - quantity currently selected to process
638 $qty_old - quantity processed on this document before reedition
640 new child entry (view parent followed by prepare_child() call):
641 $quantity - max allowed quantity (get from parent)
642 $qty_done - qty processed on other child documents
643 $qty_dispatched - quantity currently selected to process
644 $qty_old - 0; not used
652 function line_details ($stock_id, $qty, $prc, $disc_percent,
653 $qty_done, $standard_cost, $description, $id=0, $src_no=0, $src_id=0)
655 /* Constructor function to add a new LineDetail object with passed params */
658 $this->src_no = $src_no;
659 $this->src_id = $src_id;
660 $item_row = get_item($stock_id);
665 $this->mb_flag = $item_row["mb_flag"];
666 $this->units = $item_row["units"];
667 $this->descr_editable = $item_row["editable"];
668 if ($description == null || !$this->descr_editable)
669 $this->item_description = $item_row["description"];
671 $this->item_description = $description;
672 //$this->standard_cost = $item_row["material_cost"] + $item_row["labour_cost"] + $item_row["overhead_cost"];
673 $this->tax_type = $item_row["tax_type_id"];
674 $this->tax_type_name = $item_row["tax_type_name"];
675 $this->stock_id = $stock_id;
676 $this->quantity = $qty;
677 $this->qty_dispatched = $qty;
679 $this->discount_percent = $disc_percent;
680 $this->qty_done = $qty_done;
681 $this->standard_cost = $standard_cost;
685 // get unit price as stated on document
686 function line_price()