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
77 var $prepaid; // true for documents issued in prepayment mode
78 var $prep_amount; // prepayment required for SO, invoiced amount for prepaiament invoice
79 var $sum_paid; // sum of all allocated prepayments both to order and related invoices
80 var $alloc; // sum of payments allocated to this document
81 var $prepayments = array(); // allocation records for this document
84 //-------------------------------------------------------------------------
86 // $trans_no==0 => open new/direct document
87 // $trans_no!=0 && $prepare_child==false => update with parent constarints for reedition
88 // $trans_no!=0 && $prepare_child==true => prepare for child doc entry
89 // $prepare_child is set to ST_SALESINVOICE for prepayment invoices
91 function Cart($type, $trans_no=0, $prepare_child=false) {
92 /*Constructor function initialises a new shopping cart */
93 $this->line_items = array();
94 $this->sales_type = "";
95 if ($type == ST_SALESQUOTE)
96 $this->trans_type = $type;
98 $this->trans_type = ST_SALESORDER;
99 $this->dimension_id = 0;
100 $this->dimension2_id = 0;
101 $this->pos = get_sales_point(user_pos());
102 $this->read($type, $trans_no, $prepare_child);
103 $this->cart_id = uniqid('');
107 Optional sorting items by stock_id.
109 function _cmp_lines($a, $b)
111 return strcmp($a->stock_id, $b->stock_id);
115 Returns items array optionally sorted by item code.
121 $items = $this->line_items;
122 if (@$SysPrefs->sort_sales_items)
123 uasort($items, array($this, '_cmp_lines'));
128 // Prepare cart to new child document entry, just after initial parent doc read.
130 function prepare_child($type)
135 $type = get_child_type($this->trans_type);
137 $this->trans_type = $type;
138 $this->reference = $Refs->get_next($this->trans_type);
139 if ($type == ST_CUSTCREDIT)
140 $this->src_date = $this->document_date;
142 $this->document_date = new_doc_date();
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 = $type == ST_CUSTCREDIT ? '0' :
148 (($this->prepaid && $type == ST_SALESINVOICE) ? $line->quantity : $line->quantity - $line->qty_done);
153 if ($type == ST_CUSTDELIVERY) {
154 $this->order_no = key($this->trans_no);
155 $cust = get_customer($this->customer_id);
156 $this->dimension_id = $cust['dimension_id'];
157 $this->dimension2_id = $cust['dimension2_id'];
159 if ($type == ST_SALESINVOICE) {
160 $this->due_date = get_invoice_duedate($this->payment, $this->document_date);
163 $this->src_docs = $this->trans_no;
168 // Prepares transaction for reedition updating with parent transaction data
170 function set_parent_constraints($sodata, $src_no) {
172 $srcdetails = get_sales_parent_lines($this->trans_type, $src_no);
173 $src_type = get_parent_type($this->trans_type);
175 // calculate & save: qtys on other docs and free qtys on src doc
176 $line_no = 0; $src_docs = array();
177 // Loop speed optimisation below depends on fact
178 // that child line_items contains subset of parent lines in _the_same_ order !
179 while (($line_no < count($this->line_items)) && ($srcline = db_fetch($srcdetails))) {
180 $line = &$this->line_items[$line_no];
181 $src_docs[] = $src_type == ST_SALESORDER ? $srcline['order_no'] : $srcline['debtor_trans_no'];
182 while($srcline['id'] != $line->src_id) // Logic : This will increment the line_items array till sales_order line is matched.
183 { // 0002259: Fixes Delivery note bug : Parent constraints not working if sales order line deleted after delivery
185 $line = &$this->line_items[$line_no];
187 if ($srcline['id'] == $line->src_id) {
188 if ($this->trans_type == ST_SALESINVOICE)
189 $line->src_no = $srcline['debtor_trans_no'];
190 $line->qty_old = $line->qty_dispatched = $line->quantity;
191 $line->quantity += $srcline['quantity'] -
192 ($src_type==ST_SALESORDER ? $srcline['qty_sent'] : $srcline['qty_done']); // add free qty on src doc
197 if ($src_type == ST_SALESORDER || $src_type == 0) {
198 $this->src_docs = array( $sodata['order_no']=>$sodata['version']);
200 // get src_data from debtor_trans
201 $this->src_docs = get_customer_trans_version($src_type, array_unique($src_docs));
204 //-------------------------------------------------------------------------
205 // Reading document into cart
207 function read($type, $trans_no=0, $prepare_child=false) {
209 global $SysPrefs, $Refs;
211 if (!is_array($trans_no)) $trans_no = array($trans_no);
213 if ($trans_no[0]) { // read old transaction
214 if ($type == ST_SALESORDER || $type == ST_SALESQUOTE) { // sales order || sales quotation
215 read_sales_order($trans_no[0], $this, $type);
216 } else { // other type of sales transaction
217 read_sales_trans($type, $trans_no, $this);
218 $this->prepayments = get_payments_for($trans_no[0], $type);
219 if ($this->order_no) { // free hand credit notes have no order_no
220 $sodata = get_sales_order_header($this->order_no, ST_SALESORDER);
221 $this->cust_ref = $sodata["customer_ref"];
222 // currently currency is hard linked to debtor account
223 // $this->customer_currency = $sodata["curr_code"];
224 $this->delivery_to = $sodata["deliver_to"];
225 $this->delivery_address = $sodata["delivery_address"];
226 // child transaction reedition - update with parent info unless it is freehand
227 if (!$this->is_prepaid() && !$prepare_child) // this is read for view/reedition
228 $this->set_parent_constraints($sodata, $trans_no[0]);
231 // convert document into child and prepare qtys for entry
233 $this->prepare_child($prepare_child);
235 } else { // new document
236 $this->trans_type = $type;
238 $this->customer_currency = get_company_currency();
239 // set new sales document defaults here
240 if (get_global_customer() != ALL_TEXT)
241 $this->customer_id = get_global_customer();
243 $this->customer_id = '';
244 $this->document_date = new_doc_date();
245 if (!is_date_in_fiscalyear($this->document_date))
246 $this->document_date = end_fiscalyear();
247 $this->reference = $Refs->get_next($this->trans_type);
248 if ($type != ST_SALESORDER && $type != ST_SALESQUOTE) // Added 2.1 Joe Hunt 2008-11-12
250 $dim = get_company_pref('use_dimension');
253 if ($this->customer_id == '')
254 $this->dimension_id = 0;
257 $cust = get_customer($this->customer_id);
258 $this->dimension_id = $cust['dimension_id'];
262 if ($this->customer_id == '')
263 $this->dimension2_id = 0;
265 $this->dimension2_id = $cust['dimension2_id'];
269 if ($type == ST_SALESINVOICE) {
271 get_invoice_duedate($this->payment, $this->document_date);
274 add_days($this->document_date, $SysPrefs->default_delivery_required_by());
276 $this->credit = get_current_cust_credit($this->customer_id);
279 //-------------------------------------------------------------------------
280 // Writing new/modified sales document to database.
281 // Makes parent documents for direct delivery/invoice by recurent call.
282 // $policy - 0 or 1: writeoff/return for IV, back order/cancel for DN
283 function write($policy=0) {
285 begin_transaction(); // prevents partial database changes in case of direct delivery/invoice
286 if ($this->reference != 'auto' && $this->trans_no == 0 && !is_new_reference($this->reference, $this->trans_type))
288 commit_transaction();
291 if (count($this->src_docs) == 0 && ($this->trans_type == ST_SALESINVOICE || $this->trans_type == ST_CUSTDELIVERY) && !$this->is_prepaid()) {
292 // this is direct document - first add parent
293 $ref = $this->reference;
294 $date = $this->document_date;
295 $due_date = $this->due_date;
296 $dimension_id = $this->dimension_id;
297 $dimension2_id = $this->dimension2_id;
298 $this->trans_type = get_parent_type($this->trans_type);
300 $this->reference = 'auto';
301 $trans_no = $this->write(1);
303 // re-read parent document converting it to child
304 $this->read($this->trans_type, $trans_no, true);
305 $this->document_date = $date;
306 $this->reference = $ref;
307 $this->due_date = $due_date;
308 $this->dimension_id = $dimension_id;
309 $this->dimension2_id = $dimension2_id;
311 $this->reference = @html_entity_decode($this->reference, ENT_QUOTES);
312 $this->Comments = @html_entity_decode($this->Comments, ENT_QUOTES);
313 foreach($this->line_items as $lineno => $line) {
314 $this->line_items[$lineno]->stock_id = @html_entity_decode($line->stock_id, ENT_QUOTES);
315 $this->line_items[$lineno]->item_description = @html_entity_decode($line->item_description, ENT_QUOTES);
317 switch($this->trans_type) {
318 case ST_SALESINVOICE:
319 $ret = write_sales_invoice($this); break;
321 $ret = write_credit_note($this, $policy); break;
322 case ST_CUSTDELIVERY:
323 $ret = write_sales_delivery($this, $policy); break;
326 if ($this->trans_no==0) // new document
327 $ret = add_sales_order($this);
329 $ret = update_sales_order($this);
332 commit_transaction();
337 function set_customer($customer_id, $customer_name, $currency, $discount, $payment, $cdiscount=0)
339 $this->customer_name = $customer_name;
340 $this->customer_id = $customer_id;
341 $this->default_discount = $discount;
342 $this->customer_currency = $currency;
343 $this->payment = $payment;
344 $this->payment_terms = get_payment_terms($payment);
345 $this->cash_discount = $cdiscount;
347 if ($this->payment_terms['cash_sale']) {
348 $this->Location = $this->pos['pos_location'];
349 $this->location_name = $this->pos['location_name'];
351 $this->credit = get_current_cust_credit($customer_id);
354 function set_branch($branch_id, $tax_group_id, $tax_group_name, $phone='', $email='')
356 $this->Branch = $branch_id;
357 $this->phone = $phone;
358 $this->email = $email;
359 $this->tax_group_id = $tax_group_id;
360 $this->tax_group_array = get_tax_group_items_as_array($tax_group_id);
363 function set_sales_type($sales_type, $sales_name, $tax_included=0, $factor=0)
365 $this->sales_type = $sales_type;
366 $this->sales_type_name = $sales_name;
367 $this->tax_included = $tax_included;
368 $this->price_factor = $factor;
371 function set_location($id, $name)
373 $this->Location = $id;
374 $this->location_name = $name;
377 function set_delivery($shipper, $destination, $address, $freight_cost=null)
379 $this->ship_via = $shipper;
380 $this->deliver_to = $destination;
381 $this->delivery_address = $address;
382 if (isset($freight_cost))
383 $this->freight_cost = $freight_cost;
386 function add_to_cart($line_no, $stock_id, $qty, $price, $disc, $qty_done=0, $standard_cost=0, $description=null, $id=0, $src_no=0,
389 $line = new line_details($stock_id, $qty, $price, $disc,
390 $qty_done, $standard_cost, $description, $id, $src_no, $src_id);
393 $this->line_items[$line_no] = $line;
396 display_error(_("You have to enter valid stock code or nonempty description"));
400 function update_cart_item($line_no, $qty, $price, $disc, $description="")
402 if ($description != "")
403 $this->line_items[$line_no]->item_description = $description;
404 $this->line_items[$line_no]->quantity = $qty;
405 $this->line_items[$line_no]->qty_dispatched = $qty;
406 $this->line_items[$line_no]->price = $price;
407 $this->line_items[$line_no]->discount_percent = $disc;
410 function update_add_cart_item_qty($line_no, $qty)
412 $this->line_items[$line_no]->quantity += $qty;
415 function remove_from_cart($line_no)
417 array_splice($this->line_items, $line_no, 1);
420 function clear_items()
422 unset($this->line_items);
423 $this->line_items = array();
424 $this->sales_type = "";
426 $this->customer_id = $this->order_no = 0;
429 function count_items()
432 foreach ($this->line_items as $line) {
433 if ($line->quantity!=$line->qty_done) $counter++;
438 function get_items_total()
442 foreach ($this->line_items as $ln_itm) {
443 $price = $ln_itm->line_price();
444 $total += round($ln_itm->quantity * $price * (1 - $ln_itm->discount_percent),
450 function get_items_total_dispatch()
454 foreach ($this->line_items as $ln_itm) {
455 $price = $ln_itm->line_price();
456 $total += round(($ln_itm->qty_dispatched * $price * (1 - $ln_itm->discount_percent)),
462 function has_items_dispatch()
464 foreach ($this->line_items as $ln_itm) {
465 if ($ln_itm->qty_dispatched > 0)
471 function any_already_delivered()
473 /* Checks if there have been any line item processed */
475 foreach ($this->line_items as $stock_item) {
476 if ($stock_item->qty_done !=0) {
485 function some_already_delivered($line_no)
487 /* Checks if there have been deliveries of a specific line item */
488 if (isset($this->line_items[$line_no]) &&
489 $this->line_items[$line_no]->qty_done != 0) {
495 function get_taxes($shipping_cost=null)
499 if($shipping_cost==null)
500 $shipping_cost = $this->freight_cost;
502 foreach ($this->line_items as $ln_itm) {
503 $items[] = $ln_itm->stock_id;
505 $this->trans_type==ST_SALESORDER ? $ln_itm->quantity : $ln_itm->qty_dispatched) *
506 $ln_itm->line_price()* (1 - $ln_itm->discount_percent)), user_price_dec());
509 $taxes = get_tax_for_items($items, $prices, $shipping_cost,
510 $this->tax_group_id, $this->tax_included, $this->tax_group_array);
512 // Adjustment for swiss franken, we always have 5 rappen = 1/20 franken
513 if ($this->customer_currency == 'CHF') {
514 $val = $taxes['1']['Value'];
515 $val1 = (floatval((intval(round(($val*20),0)))/20));
516 $taxes['1']['Value'] = $val1;
522 function get_tax_free_shipping()
525 if ($this->tax_included==0)
526 return $this->freight_cost;
528 return ($this->freight_cost - $this->get_shipping_tax());
531 function get_shipping_tax()
534 $tax_items = get_shipping_tax_as_array($this->tax_group_id);
536 if ($tax_items != null) {
537 foreach ($tax_items as $item_tax) {
538 $index = $item_tax['tax_type_id'];
539 if (isset($this->tax_group_array[$index]['rate'])) {
540 $tax_rate += $item_tax['rate'];
544 if($this->tax_included)
545 return round($this->freight_cost*$tax_rate/($tax_rate+100), user_price_dec());
547 return round($this->freight_cost*$tax_rate/100, user_price_dec());
550 Returns transaction value including all taxes
552 function get_trans_total() {
554 $total = $this->get_items_total() + $this->freight_cost;
555 $dec = user_price_dec();
556 if (!$this->tax_included ) {
557 $total += $this->get_shipping_tax();
558 $taxes = $this->get_taxes();
559 foreach($taxes as $tax)
560 $total += round($tax['Value'], $dec);
567 Checks cart quantities on document_date.
568 Returns array of stock_ids which stock quantities would go negative on some day.
570 function check_qoh($date=null, $location=null)
572 $low_stock = array();
573 // check only for customer delivery and direct sales invoice
574 if (!($this->trans_type == ST_CUSTDELIVERY || ($this->trans_type == ST_SALESINVOICE && $this->trans_no==0)))
577 // collect quantities by stock_id
579 foreach ($this->line_items as $line_no => $line_item)
581 if (has_stock_holding($line_item->mb_flag))
583 if (!$this->trans_no) // new delivery
584 $qtys[$line_item->stock_id]['qty'] = $line_item->qty_dispatched + @$qtys[$line_item->stock_id]['qty'];
585 else // DN modification: check change in quantity
586 $qtys[$line_item->stock_id]['qty'] = ($line_item->qty_dispatched-$line_item->qty_old) + @$qtys[$line_item->stock_id]['qty'];
587 $qtys[$line_item->stock_id]['line'] = $line_no;
591 foreach($qtys as $stock_id => $sum)
593 if (check_negative_stock($stock_id, -$sum['qty'], $location ? $location : $this->Location, $date ? $date : $this->document_date))
594 $low_stock[] = $stock_id;
601 Returns true for documents issued in prepayment cycle.
603 function is_prepaid()
605 return $this->prepaid; //floatcmp($this->prep_amount, 0) > 0;
608 Order is ready for delivery in prepament mode.
610 function is_released()
612 return floatcmp($this->sum_paid, $this->prep_amount) >= 0;
616 Check whether order has been already invoiced/send or not.
618 function is_started()
620 if ($this->trans_no==0)
622 $order_no = array_keys($this->trans_no);
624 return is_sales_order_started(reset($order_no));
628 Check payment terms and prepayments selected for this invoice,
629 and updates partial/final invoice value respectively.
631 function update_payments()
633 $remainder = prepaid_invoice_remainder($this->order_no);
635 // recalculate prepaid part from payments
636 if ($this->payment_terms['days_before_due'] < 0)
637 { // this is partial invoice for selected prepayments made.
639 foreach($this->prepayments as $payment)
640 $paid += $payment['amt'];
641 $this->prep_amount = min($remainder, $paid);
642 } else // this is final invoice
643 $this->prep_amount = $remainder;
645 } /* end of class defintion */
651 var $item_description;
656 var $src_no; // number of src doc for this line
659 var $discount_percent;
664 var $valid; // validation in constructor
666 Line quantity properties in various cart create modes:
669 $quantity - quantity on current document
670 $qty_done - quantity processed on all child documents
671 $qty_dispatched - not used
675 $quantity - free parent quantity including this doc (= max allowed quantity)
676 $qty_done - qty processed on child documents (= min allowed qty)
677 $qty_dispatched - quantity currently selected to process
678 $qty_old - quantity processed on this document before reedition
680 new child entry (view parent followed by prepare_child() call):
681 $quantity - max allowed quantity (get from parent)
682 $qty_done - qty processed on other child documents
683 $qty_dispatched - quantity currently selected to process
684 $qty_old - 0; not used
692 function line_details ($stock_id, $qty, $prc, $disc_percent,
693 $qty_done, $standard_cost, $description, $id=0, $src_no=0, $src_id=0)
695 /* Constructor function to add a new LineDetail object with passed params */
698 $this->src_no = $src_no;
699 $this->src_id = $src_id;
700 $item_row = get_item($stock_id);
705 $this->mb_flag = $item_row["mb_flag"];
706 $this->units = $item_row["units"];
707 $this->descr_editable = $item_row["editable"];
708 if ($description == null || !$this->descr_editable)
709 $this->item_description = $item_row["description"];
711 $this->item_description = $description;
712 //$this->standard_cost = $item_row["material_cost"] + $item_row["labour_cost"] + $item_row["overhead_cost"];
713 $this->tax_type = $item_row["tax_type_id"];
714 $this->tax_type_name = $item_row["tax_type_name"];
715 $this->stock_id = $stock_id;
716 $this->quantity = $qty;
717 $this->qty_dispatched = $qty;
719 $this->discount_percent = $disc_percent;
720 $this->qty_done = $qty_done;
721 $this->standard_cost = $standard_cost;
725 // get unit price as stated on document
726 function line_price()