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.
119 global $sort_sales_items;
121 $items = $this->line_items;
122 if (@$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 if ($srcline['id'] == $line->src_id) {
183 if ($this->trans_type == ST_SALESINVOICE)
184 $line->src_no = $srcline['debtor_trans_no'];
185 $line->qty_old = $line->qty_dispatched = $line->quantity;
186 $line->quantity += $srcline['quantity'] -
187 ($src_type==ST_SALESORDER ? $srcline['qty_sent'] : $srcline['qty_done']); // add free qty on src doc
192 if ($src_type == ST_SALESORDER || $src_type == 0) {
193 $this->src_docs = array( $sodata['order_no']=>$sodata['version']);
195 // get src_data from debtor_trans
196 $this->src_docs = get_customer_trans_version($src_type, array_unique($src_docs));
199 //-------------------------------------------------------------------------
200 // Reading document into cart
202 function read($type, $trans_no=0, $prepare_child=false) {
204 global $SysPrefs, $Refs;
206 if (!is_array($trans_no)) $trans_no = array($trans_no);
208 if ($trans_no[0]) { // read old transaction
209 if ($type == ST_SALESORDER || $type == ST_SALESQUOTE) { // sales order || sales quotation
210 read_sales_order($trans_no[0], $this, $type);
211 } else { // other type of sales transaction
212 read_sales_trans($type, $trans_no, $this);
213 $this->prepayments = get_payments_for($trans_no[0], $type);
214 if ($this->order_no) { // free hand credit notes have no order_no
215 $sodata = get_sales_order_header($this->order_no, ST_SALESORDER);
216 $this->cust_ref = $sodata["customer_ref"];
217 // currently currency is hard linked to debtor account
218 // $this->customer_currency = $sodata["curr_code"];
219 $this->delivery_to = $sodata["deliver_to"];
220 $this->delivery_address = $sodata["delivery_address"];
221 // child transaction reedition - update with parent info unless it is freehand
222 if (!$this->is_prepaid() && !$prepare_child) // this is read for view/reedition
223 $this->set_parent_constraints($sodata, $trans_no[0]);
226 // convert document into child and prepare qtys for entry
228 $this->prepare_child($prepare_child);
230 } else { // new document
231 $this->trans_type = $type;
233 $this->customer_currency = get_company_currency();
234 // set new sales document defaults here
235 if (get_global_customer() != ALL_TEXT)
236 $this->customer_id = get_global_customer();
238 $this->customer_id = '';
239 $this->document_date = new_doc_date();
240 if (!is_date_in_fiscalyear($this->document_date))
241 $this->document_date = end_fiscalyear();
242 $this->reference = $Refs->get_next($this->trans_type);
243 if ($type != ST_SALESORDER && $type != ST_SALESQUOTE) // Added 2.1 Joe Hunt 2008-11-12
245 $dim = get_company_pref('use_dimension');
248 if ($this->customer_id == '')
249 $this->dimension_id = 0;
252 $cust = get_customer($this->customer_id);
253 $this->dimension_id = $cust['dimension_id'];
257 if ($this->customer_id == '')
258 $this->dimension2_id = 0;
260 $this->dimension2_id = $cust['dimension2_id'];
264 if ($type == ST_SALESINVOICE) {
266 get_invoice_duedate($this->payment, $this->document_date);
269 add_days($this->document_date, $SysPrefs->default_delivery_required_by());
271 $this->credit = get_current_cust_credit($this->customer_id);
274 //-------------------------------------------------------------------------
275 // Writing new/modified sales document to database.
276 // Makes parent documents for direct delivery/invoice by recurent call.
277 // $policy - 0 or 1: writeoff/return for IV, back order/cancel for DN
278 function write($policy=0) {
280 begin_transaction(); // prevents partial database changes in case of direct delivery/invoice
281 if ($this->reference != 'auto' && $this->trans_no == 0 && !is_new_reference($this->reference, $this->trans_type))
283 commit_transaction();
286 if (count($this->src_docs) == 0 && ($this->trans_type == ST_SALESINVOICE || $this->trans_type == ST_CUSTDELIVERY) && !$this->is_prepaid()) {
287 // this is direct document - first add parent
288 $ref = $this->reference;
289 $date = $this->document_date;
290 $due_date = $this->due_date;
291 $dimension_id = $this->dimension_id;
292 $dimension2_id = $this->dimension2_id;
293 $this->trans_type = get_parent_type($this->trans_type);
295 $this->reference = 'auto';
296 $trans_no = $this->write(1);
298 // re-read parent document converting it to child
299 $this->read($this->trans_type, $trans_no, true);
300 $this->document_date = $date;
301 $this->reference = $ref;
302 $this->due_date = $due_date;
303 $this->dimension_id = $dimension_id;
304 $this->dimension2_id = $dimension2_id;
306 $this->reference = @html_entity_decode($this->reference, ENT_QUOTES);
307 $this->Comments = @html_entity_decode($this->Comments, ENT_QUOTES);
308 foreach($this->line_items as $lineno => $line) {
309 $this->line_items[$lineno]->stock_id = @html_entity_decode($line->stock_id, ENT_QUOTES);
310 $this->line_items[$lineno]->item_description = @html_entity_decode($line->item_description, ENT_QUOTES);
312 switch($this->trans_type) {
313 case ST_SALESINVOICE:
314 $ret = write_sales_invoice($this); break;
316 $ret = write_credit_note($this, $policy); break;
317 case ST_CUSTDELIVERY:
318 $ret = write_sales_delivery($this, $policy); break;
321 if ($this->trans_no==0) // new document
322 $ret = add_sales_order($this);
324 $ret = update_sales_order($this);
327 commit_transaction();
332 function set_customer($customer_id, $customer_name, $currency, $discount, $payment, $cdiscount=0)
334 $this->customer_name = $customer_name;
335 $this->customer_id = $customer_id;
336 $this->default_discount = $discount;
337 $this->customer_currency = $currency;
338 $this->payment = $payment;
339 $this->payment_terms = get_payment_terms($payment);
340 $this->cash_discount = $cdiscount;
342 if ($this->payment_terms['cash_sale']) {
343 $this->Location = $this->pos['pos_location'];
344 $this->location_name = $this->pos['location_name'];
346 $this->credit = get_current_cust_credit($customer_id);
349 function set_branch($branch_id, $tax_group_id, $tax_group_name, $phone='', $email='')
351 $this->Branch = $branch_id;
352 $this->phone = $phone;
353 $this->email = $email;
354 $this->tax_group_id = $tax_group_id;
355 $this->tax_group_array = get_tax_group_items_as_array($tax_group_id);
358 function set_sales_type($sales_type, $sales_name, $tax_included=0, $factor=0)
360 $this->sales_type = $sales_type;
361 $this->sales_type_name = $sales_name;
362 $this->tax_included = $tax_included;
363 $this->price_factor = $factor;
366 function set_location($id, $name)
368 $this->Location = $id;
369 $this->location_name = $name;
372 function set_delivery($shipper, $destination, $address, $freight_cost=null)
374 $this->ship_via = $shipper;
375 $this->deliver_to = $destination;
376 $this->delivery_address = $address;
377 if (isset($freight_cost))
378 $this->freight_cost = $freight_cost;
381 function add_to_cart($line_no, $stock_id, $qty, $price, $disc, $qty_done=0, $standard_cost=0, $description=null, $id=0, $src_no=0,
384 $line = new line_details($stock_id, $qty, $price, $disc,
385 $qty_done, $standard_cost, $description, $id, $src_no, $src_id);
388 $this->line_items[$line_no] = $line;
391 display_error(_("You have to enter valid stock code or nonempty description"));
395 function update_cart_item($line_no, $qty, $price, $disc, $description="")
397 if ($description != "")
398 $this->line_items[$line_no]->item_description = $description;
399 $this->line_items[$line_no]->quantity = $qty;
400 $this->line_items[$line_no]->qty_dispatched = $qty;
401 $this->line_items[$line_no]->price = $price;
402 $this->line_items[$line_no]->discount_percent = $disc;
405 function update_add_cart_item_qty($line_no, $qty)
407 $this->line_items[$line_no]->quantity += $qty;
410 function remove_from_cart($line_no)
412 array_splice($this->line_items, $line_no, 1);
415 function clear_items()
417 unset($this->line_items);
418 $this->line_items = array();
419 $this->sales_type = "";
421 $this->customer_id = $this->order_no = 0;
424 function count_items()
427 foreach ($this->line_items as $line) {
428 if ($line->quantity!=$line->qty_done) $counter++;
433 function get_items_total()
437 foreach ($this->line_items as $ln_itm) {
438 $price = $ln_itm->line_price();
439 $total += round($ln_itm->quantity * $price * (1 - $ln_itm->discount_percent),
445 function get_items_total_dispatch()
449 foreach ($this->line_items as $ln_itm) {
450 $price = $ln_itm->line_price();
451 $total += round(($ln_itm->qty_dispatched * $price * (1 - $ln_itm->discount_percent)),
457 function has_items_dispatch()
459 foreach ($this->line_items as $ln_itm) {
460 if ($ln_itm->qty_dispatched > 0)
466 function any_already_delivered()
468 /* Checks if there have been any line item processed */
470 foreach ($this->line_items as $stock_item) {
471 if ($stock_item->qty_done !=0) {
480 function some_already_delivered($line_no)
482 /* Checks if there have been deliveries of a specific line item */
483 if (isset($this->line_items[$line_no]) &&
484 $this->line_items[$line_no]->qty_done != 0) {
490 function get_taxes($shipping_cost=null)
494 if($shipping_cost==null)
495 $shipping_cost = $this->freight_cost;
497 foreach ($this->line_items as $ln_itm) {
498 $items[] = $ln_itm->stock_id;
500 $this->trans_type==ST_SALESORDER ? $ln_itm->quantity : $ln_itm->qty_dispatched) *
501 $ln_itm->line_price()* (1 - $ln_itm->discount_percent)), user_price_dec());
504 $taxes = get_tax_for_items($items, $prices, $shipping_cost,
505 $this->tax_group_id, $this->tax_included, $this->tax_group_array);
507 // Adjustment for swiss franken, we always have 5 rappen = 1/20 franken
508 if ($this->customer_currency == 'CHF') {
509 $val = $taxes['1']['Value'];
510 $val1 = (floatval((intval(round(($val*20),0)))/20));
511 $taxes['1']['Value'] = $val1;
517 function get_tax_free_shipping()
520 if ($this->tax_included==0)
521 return $this->freight_cost;
523 return ($this->freight_cost - $this->get_shipping_tax());
526 function get_shipping_tax()
529 $tax_items = get_shipping_tax_as_array($this->tax_group_id);
531 if ($tax_items != null) {
532 foreach ($tax_items as $item_tax) {
533 $index = $item_tax['tax_type_id'];
534 if (isset($this->tax_group_array[$index]['rate'])) {
535 $tax_rate += $item_tax['rate'];
539 if($this->tax_included)
540 return round($this->freight_cost*$tax_rate/($tax_rate+100), user_price_dec());
542 return round($this->freight_cost*$tax_rate/100, user_price_dec());
545 Returns transaction value including all taxes
547 function get_trans_total() {
549 $total = $this->get_items_total() + $this->freight_cost;
550 $dec = user_price_dec();
551 if (!$this->tax_included ) {
552 $total += $this->get_shipping_tax();
553 $taxes = $this->get_taxes();
554 foreach($taxes as $tax)
555 $total += round($tax['Value'], $dec);
562 Returns true for documents issued in prepayment cycle.
564 function is_prepaid()
566 return $this->prepaid; //floatcmp($this->prep_amount, 0) > 0;
569 Order is ready for delivery in prepament mode.
571 function is_released()
573 return floatcmp($this->sum_paid, $this->prep_amount) >= 0;
577 Check whether order has been already invoiced/send or not.
579 function is_started()
581 if ($this->trans_no==0)
583 $order_no = array_keys($this->trans_no);
585 return is_sales_order_started(reset($order_no));
589 Check payment terms and prepayments selected for this invoice,
590 and updates partial/final invoice value respectively.
592 function update_payments()
594 $remainder = prepaid_invoice_remainder($this->order_no);
596 // recalculate prepaid part from payments
597 if ($this->payment_terms['days_before_due'] < 0)
598 { // this is partial invoice for selected prepayments made.
600 foreach($this->prepayments as $payment)
601 $paid += $payment['amt'];
602 $this->prep_amount = min($remainder, $paid);
603 } else // this is final invoice
604 $this->prep_amount = $remainder;
606 } /* end of class defintion */
612 var $item_description;
617 var $src_no; // number of src doc for this line
620 var $discount_percent;
625 var $valid; // validation in constructor
627 Line quantity properties in various cart create modes:
630 $quantity - quantity on current document
631 $qty_done - quantity processed on all child documents
632 $qty_dispatched - not used
636 $quantity - free parent quantity including this doc (= max allowed quantity)
637 $qty_done - qty processed on child documents (= min allowed qty)
638 $qty_dispatched - quantity currently selected to process
639 $qty_old - quantity processed on this document before reedition
641 new child entry (view parent followed by prepare_child() call):
642 $quantity - max allowed quantity (get from parent)
643 $qty_done - qty processed on other child documents
644 $qty_dispatched - quantity currently selected to process
645 $qty_old - 0; not used
653 function line_details ($stock_id, $qty, $prc, $disc_percent,
654 $qty_done, $standard_cost, $description, $id=0, $src_no=0, $src_id=0)
656 /* Constructor function to add a new LineDetail object with passed params */
659 $this->src_no = $src_no;
660 $this->src_id = $src_id;
661 $item_row = get_item($stock_id);
666 $this->mb_flag = $item_row["mb_flag"];
667 $this->units = $item_row["units"];
668 $this->descr_editable = $item_row["editable"];
669 if ($description == null || !$this->descr_editable)
670 $this->item_description = $item_row["description"];
672 $this->item_description = $description;
673 //$this->standard_cost = $item_row["material_cost"] + $item_row["labour_cost"] + $item_row["overhead_cost"];
674 $this->tax_type = $item_row["tax_type_id"];
675 $this->tax_type_name = $item_row["tax_type_name"];
676 $this->stock_id = $stock_id;
677 $this->quantity = $qty;
678 $this->qty_dispatched = $qty;
680 $this->discount_percent = $disc_percent;
681 $this->qty_done = $qty_done;
682 $this->standard_cost = $standard_cost;
686 // get unit price as stated on document
687 function line_price()