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 $price_factor; // ditto for price calculations
66 var $pos; // user assigned POS
72 var $payment_terms; // cached payment terms
75 var $prepaid=false; // true for documents issued in prepayment mode
76 var $prep_amount=0; // prepayment required for SO, invoiced amount for prepaiament invoice
77 var $sum_paid; // sum of all allocated prepayments both to order and related invoices
78 var $alloc; // sum of payments allocated to this document
79 var $prepayments = array(); // allocation records for this document
82 var $fixed_asset = false;
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 __construct($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, null, array('date' => $this->document_date,
139 'customer' => $this->customer_id, 'branch' => $this->Branch));
140 if ($type == ST_CUSTCREDIT)
141 $this->src_date = $this->document_date;
143 $this->document_date = new_doc_date();
145 for($line_no = 0; $line_no < count($this->line_items); $line_no++) {
146 $line = &$this->line_items[$line_no];
147 $line->src_id = $line->id; // save src line ids for update
148 $line->qty_dispatched = $type == ST_CUSTCREDIT ? '0' :
149 (($this->prepaid && $type == ST_SALESINVOICE) ? $line->quantity : $line->quantity - $line->qty_done);
154 if ($type == ST_CUSTDELIVERY) {
155 $this->order_no = key($this->trans_no);
156 $cust = get_customer($this->customer_id);
157 $this->dimension_id = $cust['dimension_id'];
158 $this->dimension2_id = $cust['dimension2_id'];
160 if ($type == ST_SALESINVOICE) {
161 $this->due_date = get_invoice_duedate($this->payment, $this->document_date);
164 $this->src_docs = $this->trans_no;
169 // Prepares transaction for reedition updating with parent transaction data
171 function set_parent_constraints($sodata, $src_no) {
173 $srcdetails = get_sales_parent_lines($this->trans_type, $src_no);
174 $src_type = get_parent_type($this->trans_type);
176 // calculate & save: qtys on other docs and free qtys on src doc
177 $line_no = 0; $src_docs = array();
178 // Loop speed optimisation below depends on fact
179 // that child line_items contains subset of parent lines in _the_same_ order !
180 while (($line_no < count($this->line_items)) && ($srcline = db_fetch($srcdetails))) {
181 $line = &$this->line_items[$line_no];
182 $src_docs[] = $src_type == ST_SALESORDER ? $srcline['order_no'] : $srcline['debtor_trans_no'];
183 while($srcline['id'] != $line->src_id) // Logic : This will increment the line_items array till sales_order line is matched.
184 { // Fixes Delivery note bug : Parent constraints not working if sales order line deleted after delivery
186 $line = &$this->line_items[$line_no];
188 if ($srcline['id'] == $line->src_id) {
189 if ($this->trans_type == ST_SALESINVOICE)
190 $line->src_no = $srcline['debtor_trans_no'];
191 $line->qty_old = $line->qty_dispatched = $line->quantity;
192 $line->quantity += $srcline['quantity'] -
193 ($src_type==ST_SALESORDER ? $srcline['qty_sent'] : $srcline['qty_done']); // add free qty on src doc
198 if ($src_type == ST_SALESORDER || $src_type == 0) {
199 $this->src_docs = array( $sodata['order_no']=>$sodata['version']);
201 // get src_data from debtor_trans
202 $this->src_docs = get_customer_trans_version($src_type, array_unique($src_docs));
205 //-------------------------------------------------------------------------
206 // Reading document into cart
208 function read($type, $trans_no=0, $prepare_child=false) {
210 global $SysPrefs, $Refs;
212 if (!is_array($trans_no)) $trans_no = array($trans_no);
214 if ($trans_no[0]) { // read old transaction
215 if ($type == ST_SALESORDER || $type == ST_SALESQUOTE) { // sales order || sales quotation
216 read_sales_order($trans_no[0], $this, $type);
217 } else { // other type of sales transaction
218 read_sales_trans($type, $trans_no, $this);
219 $this->prepayments = get_payments_for($trans_no[0], $type, $this->customer_id);
220 $this->update_payments();
221 if ($this->order_no) { // free hand credit notes have no order_no
222 $sodata = get_sales_order_header($this->order_no, ST_SALESORDER);
223 $this->cust_ref = $sodata["customer_ref"];
224 // currently currency is hard linked to debtor account
225 $this->delivery_to = $sodata["deliver_to"];
226 $this->delivery_address = $sodata["delivery_address"];
227 // child transaction reedition - update with parent info unless it is freehand
228 if (!$this->is_prepaid() && !$prepare_child) // this is read for view/reedition
229 $this->set_parent_constraints($sodata, $trans_no[0]);
232 // convert document into child and prepare qtys for entry
234 $this->prepare_child($prepare_child);
236 } else { // new document
237 $this->trans_type = $type;
239 $this->customer_currency = get_company_currency();
240 // set new sales document defaults here
241 if (get_global_customer() != ALL_TEXT)
242 $this->customer_id = get_global_customer();
244 $this->customer_id = '';
245 $this->document_date = new_doc_date();
246 if (!is_date_in_fiscalyear($this->document_date))
247 $this->document_date = end_fiscalyear();
248 $this->reference = $Refs->get_next($this->trans_type, null, array('date' => Today(),
249 'customer' => $this->customer_id));
250 if ($type != ST_SALESORDER && $type != ST_SALESQUOTE) // Added 2.1 Joe Hunt 2008-11-12
252 $dim = get_company_pref('use_dimension');
255 if ($this->customer_id == '')
256 $this->dimension_id = 0;
259 $cust = get_customer($this->customer_id);
260 $this->dimension_id = $cust['dimension_id'];
264 if ($this->customer_id == '')
265 $this->dimension2_id = 0;
267 $this->dimension2_id = $cust['dimension2_id'];
271 if ($type == ST_SALESINVOICE) {
273 get_invoice_duedate($this->payment, $this->document_date);
276 add_days($this->document_date, $SysPrefs->default_delivery_required_by());
278 $this->credit = get_current_cust_credit($this->customer_id);
281 //-------------------------------------------------------------------------
282 // Writing new/modified sales document to database.
283 // Makes parent documents for direct delivery/invoice by recurent call.
284 // $policy - 0 or 1: writeoff/return for IV, back order/cancel for DN
285 function write($policy=0) {
287 global $SysPrefs, $Refs;
289 begin_transaction(); // prevents partial database changes in case of direct delivery/invoice
290 if ($this->reference != 'auto' && $this->trans_no == 0 && !is_new_reference($this->reference, $this->trans_type))
292 if (!empty($SysPrefs->prefs['ref_no_auto_increase']))
293 $this->reference = $Refs->get_next($this->trans_type, null, array('date' => Today()));
294 if (!is_new_reference($this->reference, $this->trans_type))
296 commit_transaction();
300 if (count($this->src_docs) == 0 && ($this->trans_type == ST_SALESINVOICE || $this->trans_type == ST_CUSTDELIVERY) && !$this->is_prepaid()) {
301 // this is direct document - first add parent
302 $ref = $this->reference;
303 $date = $this->document_date;
304 $due_date = $this->due_date;
305 $dimension_id = $this->dimension_id;
306 $dimension2_id = $this->dimension2_id;
307 $this->trans_type = get_parent_type($this->trans_type);
309 $this->reference = 'auto';
310 $trans_no = $this->write(1);
312 // re-read parent document converting it to child
313 $this->read($this->trans_type, $trans_no, true);
314 $this->document_date = $date;
315 $this->reference = $ref;
316 $this->due_date = $due_date;
317 $this->dimension_id = $dimension_id;
318 $this->dimension2_id = $dimension2_id;
320 $this->reference = @html_entity_decode($this->reference, ENT_QUOTES);
321 $this->Comments = @html_entity_decode($this->Comments, ENT_QUOTES);
322 foreach($this->line_items as $lineno => $line) {
323 $this->line_items[$lineno]->stock_id = @html_entity_decode($line->stock_id, ENT_QUOTES);
324 $this->line_items[$lineno]->item_description = @html_entity_decode($line->item_description, ENT_QUOTES);
326 switch($this->trans_type) {
327 case ST_SALESINVOICE:
328 $ret = write_sales_invoice($this); break;
330 $ret = write_credit_note($this, $policy); break;
331 case ST_CUSTDELIVERY:
332 $ret = write_sales_delivery($this, $policy); break;
335 if ($this->trans_no==0) // new document
336 $ret = add_sales_order($this);
338 $ret = update_sales_order($this);
341 commit_transaction();
346 function set_customer($customer_id, $customer_name, $currency, $discount, $payment)
348 $this->customer_name = $customer_name;
349 $this->customer_id = $customer_id;
350 $this->default_discount = $discount;
351 $this->customer_currency = $currency;
352 $this->payment = $payment;
353 $this->payment_terms = get_payment_terms($payment);
355 if ($this->payment_terms['type'] == PTT_CASH) {
356 $this->Location = $this->pos['pos_location'];
357 $this->location_name = $this->pos['location_name'];
359 $this->credit = get_current_cust_credit($customer_id);
362 function set_branch($branch_id, $tax_group_id, $tax_group_name, $phone='', $email='')
364 $this->Branch = $branch_id;
365 $this->phone = $phone;
366 $this->email = $email;
367 $this->tax_group_id = $tax_group_id;
370 function set_sales_type($sales_type, $sales_name, $tax_included=0, $factor=0)
372 $this->sales_type = $sales_type;
373 $this->sales_type_name = $sales_name;
374 $this->tax_included = $tax_included;
375 $this->price_factor = $factor;
378 function set_location($id, $name)
380 $this->Location = $id;
381 $this->location_name = $name;
384 function set_delivery($shipper, $destination, $address, $freight_cost=null)
386 $this->ship_via = $shipper;
387 $this->deliver_to = $destination;
388 $this->delivery_address = $address;
389 if (isset($freight_cost))
390 $this->freight_cost = $freight_cost;
393 function add_to_cart($line_no, $stock_id, $qty, $price, $disc, $qty_done=0, $unit_cost=0, $description=null, $id=0, $src_no=0,
396 $line = new line_details($stock_id, $qty, $price, $disc,
397 $qty_done, $unit_cost, $description, $id, $src_no, $src_id);
401 $this->line_items[$line_no] = $line;
404 display_error(_("You have to enter valid stock code or nonempty description"));
408 function update_cart_item($line_no, $qty, $price, $disc, $description="")
410 if ($description != "")
411 $this->line_items[$line_no]->item_description = $description;
412 $this->line_items[$line_no]->quantity = $qty;
413 $this->line_items[$line_no]->qty_dispatched = $qty;
414 $this->line_items[$line_no]->price = $price;
415 $this->line_items[$line_no]->discount_percent = $disc;
418 function update_add_cart_item_qty($line_no, $qty)
420 $this->line_items[$line_no]->quantity += $qty;
423 function remove_from_cart($line_no)
425 array_splice($this->line_items, $line_no, 1);
428 function clear_items()
430 unset($this->line_items);
431 $this->line_items = array();
432 $this->sales_type = "";
434 $this->customer_id = $this->order_no = 0;
437 function count_items()
440 foreach ($this->line_items as $line) {
441 if ($line->quantity!=$line->qty_done) $counter++;
446 function get_items_total()
450 foreach ($this->line_items as $ln_itm) {
451 $price = $ln_itm->line_price();
452 $total += round($ln_itm->quantity * $price * (1 - $ln_itm->discount_percent),
458 function get_items_total_dispatch()
462 foreach ($this->line_items as $ln_itm) {
463 $price = $ln_itm->line_price();
464 $total += round(($ln_itm->qty_dispatched * $price * (1 - $ln_itm->discount_percent)),
470 function has_items_dispatch()
472 foreach ($this->line_items as $ln_itm) {
473 if ($ln_itm->qty_dispatched > 0)
479 function any_already_delivered()
481 /* Checks if there have been any line item processed */
483 foreach ($this->line_items as $stock_item) {
484 if ($stock_item->qty_done !=0) {
493 function some_already_delivered($line_no)
495 /* Checks if there have been deliveries of a specific line item */
496 if (isset($this->line_items[$line_no]) &&
497 $this->line_items[$line_no]->qty_done != 0) {
504 Split line value to cost and taxes.
505 Stores calculated amounts in $line->gl_amounts arrays.
507 function split_line_values()
509 // split nominal line values
510 foreach ($this->line_items as $line)
511 $line->split_item_value();
514 function get_taxes($shipping_cost=null)
518 if ($this->ship_via != '') {
519 if ($shipping_cost == null)
520 $shipping_cost = $this->freight_cost;
521 $items[] = $this->ship_via;
522 $prices[] = $shipping_cost;
525 foreach ($this->line_items as $ln_itm) {
526 $items[] = $ln_itm->stock_id;
528 $this->trans_type==ST_SALESORDER ? $ln_itm->quantity : $ln_itm->qty_dispatched) *
529 $ln_itm->line_price()* (1 - $ln_itm->discount_percent)), user_price_dec());
532 $taxes = get_tax_for_items($this->trans_type, $items, $prices, $this->tax_group_id, $this->tax_included);
534 // Adjustment for swiss franken, we always have 5 rappen = 1/20 franken
535 if ($this->customer_currency == 'CHF') {
536 $val = $taxes['1']['Value'];
537 $val1 = (floatval((intval(round(($val*20),0)))/20));
538 $taxes['1']['Value'] = $val1;
544 function get_tax_free_shipping()
547 if ($this->tax_included==0)
548 return $this->freight_cost;
550 return ($this->freight_cost - $this->get_shipping_tax());
553 function get_shipping_tax()
555 $freight = split_item_price($this->ship_via, $this->freight_cost, $this->tax_group_id, $this->tax_included, $this->trans_type);
557 return $freight['Tax'];
560 Returns transaction value including all taxes
562 function get_trans_total() {
564 $total = $this->get_items_total() + $this->freight_cost;
565 $dec = user_price_dec();
566 if (!$this->tax_included ) {
567 $total += $this->get_shipping_tax();
568 $taxes = $this->get_taxes();
569 foreach($taxes as $tax)
570 $total += round($tax['Value'], $dec);
577 Checks cart quantities on document_date.
578 Returns array of stock_ids which stock quantities would go negative on some day.
580 function check_qoh($date=null, $location=null)
582 $low_stock = array();
583 // check only for customer delivery and direct sales invoice
584 if (!($this->trans_type == ST_CUSTDELIVERY || ($this->trans_type == ST_SALESINVOICE && $this->trans_no==0)))
587 // collect quantities by stock_id
589 foreach ($this->line_items as $line_no => $line_item)
591 if (has_stock_holding($line_item->mb_flag))
593 if (!$this->trans_no) // new delivery
594 $qtys[$line_item->stock_id]['qty'] = $line_item->qty_dispatched + @$qtys[$line_item->stock_id]['qty'];
595 else // DN modification: check change in quantity
596 $qtys[$line_item->stock_id]['qty'] = ($line_item->qty_dispatched-$line_item->qty_old) + @$qtys[$line_item->stock_id]['qty'];
597 $qtys[$line_item->stock_id]['line'] = $line_no;
601 foreach($qtys as $stock_id => $sum)
603 if (check_negative_stock($stock_id, -$sum['qty'], $location ? $location : $this->Location, $date ? $date : $this->document_date))
604 $low_stock[] = $stock_id;
611 Returns true for documents issued in prepayment cycle.
613 function is_prepaid()
615 return $this->prepaid;
618 Order is ready for delivery in prepament mode.
620 function is_released()
622 return floatcmp($this->sum_paid, $this->prep_amount) >= 0;
626 Check whether order has been already invoiced/send or not.
628 function is_started()
630 if ($this->trans_no==0)
632 $order_no = array_keys($this->trans_no);
634 return is_sales_order_started(reset($order_no));
638 Check payment terms and prepayments selected for this invoice,
639 and updates partial/final invoice value respectively.
641 function update_payments()
643 $remainder = prepaid_invoice_remainder($this->order_no);
645 // recalculate prepaid part from payments
646 if ($this->payment_terms['type'] == PTT_PREPAY)
647 { // this is partial invoice for selected prepayments made.
649 foreach($this->prepayments as $payment)
650 $paid += $payment['amt'];
651 $this->prep_amount = $this->trans_no ? $paid : min($remainder, $paid);
652 } else // this is final invoice
653 $this->prep_amount = $remainder;
655 } /* end of class defintion */
661 var $item_description;
666 var $src_no; // number of src doc for this line
669 var $discount_percent;
674 var $cart; // line context
675 var $valid; // validation in constructor
677 Line quantity properties in various cart create modes:
680 $quantity - quantity on current document
681 $qty_done - quantity processed on all child documents
682 $qty_dispatched - not used
686 $quantity - free parent quantity including this doc (= max allowed quantity)
687 $qty_done - qty processed on child documents (= min allowed qty)
688 $qty_dispatched - quantity currently selected to process
689 $qty_old - quantity processed on this document before reedition
691 new child entry (view parent followed by prepare_child() call):
692 $quantity - max allowed quantity (get from parent)
693 $qty_done - qty processed on other child documents
694 $qty_dispatched - quantity currently selected to process
695 $qty_old - 0; not used
703 function __construct($stock_id, $qty, $prc, $disc_percent,
704 $qty_done, $unit_cost, $description, $id=0, $src_no=0, $src_id=0)
706 /* Constructor function to add a new LineDetail object with passed params */
709 $this->src_no = $src_no;
710 $this->src_id = $src_id;
711 $item_row = get_item($stock_id);
716 $this->mb_flag = $item_row["mb_flag"];
717 $this->units = $item_row["units"];
718 $this->descr_editable = $item_row["editable"];
719 if ($description == null || !$this->descr_editable)
720 $this->item_description = $item_row["description"];
722 $this->item_description = $description;
723 $this->tax_type = $item_row["tax_type_id"];
724 $this->tax_type_name = $item_row["tax_type_name"];
725 $this->stock_id = $stock_id;
726 $this->quantity = $qty;
727 $this->qty_dispatched = $qty;
729 $this->discount_percent = $disc_percent;
730 $this->qty_done = $qty_done;
731 $this->unit_cost = $unit_cost;
735 // get unit price as stated on document
736 function line_price()
741 function taxfree_charge_price()
743 $this->split_item_value();
744 return $this->gl_amounts['Net'];
748 Splits item value to parts posted to GL.
750 function split_item_value()
752 return $this->gl_amounts = split_item_price($this->stock_id, $this->price*$this->quantity, $this->cart->tax_group_id, $this->cart->tax_included,
753 $this->cart->trans_type);