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 // Prepare cart to new child document entry, just after initial parent doc read.
108 function prepare_child($type)
113 $type = get_child_type($this->trans_type);
115 $this->trans_type = $type;
116 $this->reference = $Refs->get_next($this->trans_type);
117 $this->document_date = new_doc_date();
119 for($line_no = 0; $line_no < count($this->line_items); $line_no++) {
120 $line = &$this->line_items[$line_no];
121 $line->src_id = $line->id; // save src line ids for update
122 $line->qty_dispatched = $type == ST_CUSTCREDIT ? '0' :
123 (($this->prepaid && $type == ST_SALESINVOICE) ? $line->quantity : $line->quantity - $line->qty_done);
128 if ($type == ST_CUSTDELIVERY) {
129 $this->order_no = key($this->trans_no);
130 $cust = get_customer($this->customer_id);
131 $this->dimension_id = $cust['dimension_id'];
132 $this->dimension2_id = $cust['dimension2_id'];
134 if ($type == ST_SALESINVOICE) {
135 $this->due_date = get_invoice_duedate($this->payment, $this->document_date);
138 if ($type == ST_CUSTCREDIT)
139 $this->src_date = $this->document_date;
141 $this->src_docs = $this->trans_no;
146 // Prepares transaction for reedition updating with parent transaction data
148 function set_parent_constraints($sodata, $src_no) {
150 $srcdetails = get_sales_parent_lines($this->trans_type, $src_no);
151 $src_type = get_parent_type($this->trans_type);
153 // calculate & save: qtys on other docs and free qtys on src doc
154 $line_no = 0; $src_docs = array();
155 // Loop speed optimisation below depends on fact
156 // that child line_items contains subset of parent lines in _the_same_ order !
157 while (($line_no < count($this->line_items)) && ($srcline = db_fetch($srcdetails))) {
158 $line = &$this->line_items[$line_no];
159 $src_docs[] = $src_type == ST_SALESORDER ? $srcline['order_no'] : $srcline['debtor_trans_no'];
160 if ($srcline['id'] == $line->src_id) {
161 if ($this->trans_type == ST_SALESINVOICE)
162 $line->src_no = $srcline['debtor_trans_no'];
163 $line->qty_old = $line->qty_dispatched = $line->quantity;
164 $line->quantity += $srcline['quantity'] -
165 ($src_type==ST_SALESORDER ? $srcline['qty_sent'] : $srcline['qty_done']); // add free qty on src doc
170 if ($src_type == ST_SALESORDER || $src_type == 0) {
171 $this->src_docs = array( $sodata['order_no']=>$sodata['version']);
173 // get src_data from debtor_trans
174 $this->src_docs = get_customer_trans_version($src_type, array_unique($src_docs));
177 //-------------------------------------------------------------------------
178 // Reading document into cart
180 function read($type, $trans_no=0, $prepare_child=false) {
182 global $SysPrefs, $Refs;
184 if (!is_array($trans_no)) $trans_no = array($trans_no);
186 if ($trans_no[0]) { // read old transaction
187 if ($type == ST_SALESORDER || $type == ST_SALESQUOTE) { // sales order || sales quotation
188 read_sales_order($trans_no[0], $this, $type);
189 } else { // other type of sales transaction
190 read_sales_trans($type, $trans_no, $this);
191 $this->prepayments = get_payments_for($trans_no[0], $type);
192 if ($this->order_no) { // free hand credit notes have no order_no
193 $sodata = get_sales_order_header($this->order_no, ST_SALESORDER);
194 $this->cust_ref = $sodata["customer_ref"];
195 // currently currency is hard linked to debtor account
196 // $this->customer_currency = $sodata["curr_code"];
197 $this->delivery_to = $sodata["deliver_to"];
198 $this->delivery_address = $sodata["delivery_address"];
199 // child transaction reedition - update with parent info unless it is freehand
200 if (!$this->is_prepaid() && !$prepare_child) // this is read for view/reedition
201 $this->set_parent_constraints($sodata, $trans_no[0]);
204 // convert document into child and prepare qtys for entry
206 $this->prepare_child($prepare_child);
208 } else { // new document
209 $this->trans_type = $type;
211 $this->customer_currency = get_company_currency();
212 // set new sales document defaults here
213 if (get_global_customer() != ALL_TEXT)
214 $this->customer_id = get_global_customer();
216 $this->customer_id = '';
217 $this->document_date = new_doc_date();
218 if (!is_date_in_fiscalyear($this->document_date))
219 $this->document_date = end_fiscalyear();
220 $this->reference = $Refs->get_next($this->trans_type);
221 if ($type != ST_SALESORDER && $type != ST_SALESQUOTE) // Added 2.1 Joe Hunt 2008-11-12
223 $dim = get_company_pref('use_dimension');
226 if ($this->customer_id == '')
227 $this->dimension_id = 0;
230 $cust = get_customer($this->customer_id);
231 $this->dimension_id = $cust['dimension_id'];
235 if ($this->customer_id == '')
236 $this->dimension2_id = 0;
238 $this->dimension2_id = $cust['dimension2_id'];
242 if ($type == ST_SALESINVOICE) {
244 get_invoice_duedate($this->payment, $this->document_date);
247 add_days($this->document_date, $SysPrefs->default_delivery_required_by());
249 $this->credit = get_current_cust_credit($this->customer_id);
252 //-------------------------------------------------------------------------
253 // Writing new/modified sales document to database.
254 // Makes parent documents for direct delivery/invoice by recurent call.
255 // $policy - 0 or 1: writeoff/return for IV, back order/cancel for DN
256 function write($policy=0) {
258 begin_transaction(); // prevents partial database changes in case of direct delivery/invoice
259 if ($this->reference != 'auto' && $this->trans_no == 0 && !is_new_reference($this->reference, $this->trans_type))
261 commit_transaction();
264 if (count($this->src_docs) == 0 && ($this->trans_type == ST_SALESINVOICE || $this->trans_type == ST_CUSTDELIVERY) && !$this->is_prepaid()) {
265 // this is direct document - first add parent
266 $ref = $this->reference;
267 $date = $this->document_date;
268 $due_date = $this->due_date;
269 $this->trans_type = get_parent_type($this->trans_type);
271 $this->reference = 'auto';
272 $trans_no = $this->write(1);
274 // re-read parent document converting it to child
275 $this->read($this->trans_type, $trans_no, true);
276 $this->document_date = $date;
277 $this->reference = $ref;
278 $this->due_date = $due_date;
280 $this->reference = @html_entity_decode($this->reference, ENT_QUOTES);
281 $this->Comments = @html_entity_decode($this->Comments, ENT_QUOTES);
282 foreach($this->line_items as $lineno => $line) {
283 $this->line_items[$lineno]->stock_id = @html_entity_decode($line->stock_id, ENT_QUOTES);
284 $this->line_items[$lineno]->item_description = @html_entity_decode($line->item_description, ENT_QUOTES);
286 switch($this->trans_type) {
287 case ST_SALESINVOICE:
288 $ret = write_sales_invoice($this); break;
290 $ret = write_credit_note($this, $policy); break;
291 case ST_CUSTDELIVERY:
292 $ret = write_sales_delivery($this, $policy); break;
295 if ($this->trans_no==0) // new document
296 $ret = add_sales_order($this);
298 $ret = update_sales_order($this);
301 commit_transaction();
306 function set_customer($customer_id, $customer_name, $currency, $discount, $payment, $cdiscount=0)
308 $this->customer_name = $customer_name;
309 $this->customer_id = $customer_id;
310 $this->default_discount = $discount;
311 $this->customer_currency = $currency;
312 $this->payment = $payment;
313 $this->payment_terms = get_payment_terms($payment);
314 $this->cash_discount = $cdiscount;
316 if ($this->payment_terms['cash_sale']) {
317 $this->Location = $this->pos['pos_location'];
318 $this->location_name = $this->pos['location_name'];
320 $this->credit = get_current_cust_credit($customer_id);
323 function set_branch($branch_id, $tax_group_id, $tax_group_name, $phone='', $email='')
325 $this->Branch = $branch_id;
326 $this->phone = $phone;
327 $this->email = $email;
328 $this->tax_group_id = $tax_group_id;
329 $this->tax_group_array = get_tax_group_items_as_array($tax_group_id);
332 function set_sales_type($sales_type, $sales_name, $tax_included=0, $factor=0)
334 $this->sales_type = $sales_type;
335 $this->sales_type_name = $sales_name;
336 $this->tax_included = $tax_included;
337 $this->price_factor = $factor;
340 function set_location($id, $name)
342 $this->Location = $id;
343 $this->location_name = $name;
346 function set_delivery($shipper, $destination, $address, $freight_cost=null)
348 $this->ship_via = $shipper;
349 $this->deliver_to = $destination;
350 $this->delivery_address = $address;
351 if (isset($freight_cost))
352 $this->freight_cost = $freight_cost;
355 function add_to_cart($line_no, $stock_id, $qty, $price, $disc, $qty_done=0, $standard_cost=0, $description=null, $id=0, $src_no=0,
358 $line = new line_details($stock_id, $qty, $price, $disc,
359 $qty_done, $standard_cost, $description, $id, $src_no, $src_id);
362 $this->line_items[$line_no] = $line;
365 display_error(_("You have to enter valid stock code or nonempty description"));
369 function update_cart_item($line_no, $qty, $price, $disc, $description="")
371 if ($description != "")
372 $this->line_items[$line_no]->item_description = $description;
373 $this->line_items[$line_no]->quantity = $qty;
374 $this->line_items[$line_no]->qty_dispatched = $qty;
375 $this->line_items[$line_no]->price = $price;
376 $this->line_items[$line_no]->discount_percent = $disc;
379 function update_add_cart_item_qty($line_no, $qty)
381 $this->line_items[$line_no]->quantity += $qty;
384 function remove_from_cart($line_no)
386 array_splice($this->line_items, $line_no, 1);
389 function clear_items()
391 unset($this->line_items);
392 $this->line_items = array();
393 $this->sales_type = "";
395 $this->customer_id = $this->order_no = 0;
398 function count_items()
401 foreach ($this->line_items as $line) {
402 if ($line->quantity!=$line->qty_done) $counter++;
407 function get_items_total()
411 foreach ($this->line_items as $ln_itm) {
412 $price = $ln_itm->line_price();
413 $total += round($ln_itm->quantity * $price * (1 - $ln_itm->discount_percent),
419 function get_items_total_dispatch()
423 foreach ($this->line_items as $ln_itm) {
424 $price = $ln_itm->line_price();
425 $total += round(($ln_itm->qty_dispatched * $price * (1 - $ln_itm->discount_percent)),
431 function has_items_dispatch()
433 foreach ($this->line_items as $ln_itm) {
434 if ($ln_itm->qty_dispatched > 0)
440 function any_already_delivered()
442 /* Checks if there have been any line item processed */
444 foreach ($this->line_items as $stock_item) {
445 if ($stock_item->qty_done !=0) {
454 function some_already_delivered($line_no)
456 /* Checks if there have been deliveries of a specific line item */
457 if (isset($this->line_items[$line_no]) &&
458 $this->line_items[$line_no]->qty_done != 0) {
464 function get_taxes($shipping_cost=null)
468 if($shipping_cost==null)
469 $shipping_cost = $this->freight_cost;
471 foreach ($this->line_items as $ln_itm) {
472 $items[] = $ln_itm->stock_id;
474 $this->trans_type==ST_SALESORDER ? $ln_itm->quantity : $ln_itm->qty_dispatched) *
475 $ln_itm->line_price()* (1 - $ln_itm->discount_percent)), user_price_dec());
478 $taxes = get_tax_for_items($items, $prices, $shipping_cost,
479 $this->tax_group_id, $this->tax_included, $this->tax_group_array);
481 // Adjustment for swiss franken, we always have 5 rappen = 1/20 franken
482 if ($this->customer_currency == 'CHF') {
483 $val = $taxes['1']['Value'];
484 $val1 = (floatval((intval(round(($val*20),0)))/20));
485 $taxes['1']['Value'] = $val1;
491 function get_tax_free_shipping()
494 if ($this->tax_included==0)
495 return $this->freight_cost;
497 return ($this->freight_cost - $this->get_shipping_tax());
500 function get_shipping_tax()
503 $tax_items = get_shipping_tax_as_array($this->tax_group_id);
505 if ($tax_items != null) {
506 foreach ($tax_items as $item_tax) {
507 $index = $item_tax['tax_type_id'];
508 if (isset($this->tax_group_array[$index]['rate'])) {
509 $tax_rate += $item_tax['rate'];
513 if($this->tax_included)
514 return round($this->freight_cost*$tax_rate/($tax_rate+100), user_price_dec());
516 return round($this->freight_cost*$tax_rate/100, user_price_dec());
519 Returns transaction value including all taxes
521 function get_trans_total() {
523 $total = $this->get_items_total() + $this->freight_cost;
524 $dec = user_price_dec();
525 if (!$this->tax_included ) {
526 $total += $this->get_shipping_tax();
527 $taxes = $this->get_taxes();
528 foreach($taxes as $tax)
529 $total += round($tax['Value'], $dec);
536 Returns true for documents issued in prepayment cycle.
538 function is_prepaid()
540 return $this->prepaid; //floatcmp($this->prep_amount, 0) > 0;
543 Order is ready for delivery in prepament mode.
545 function is_released()
547 return floatcmp($this->sum_paid, $this->prep_amount) >= 0;
551 Check whether order has been already invoiced/send or not.
553 function is_started()
555 if ($this->trans_no==0)
557 $order_no = array_keys($this->trans_no);
559 return is_sales_order_started(reset($order_no));
563 Check payment terms and prepayments selected for this invoice,
564 and updates partial/final invoice value respectively.
566 function update_payments()
568 $remainder = prepaid_invoice_remainder($this->order_no);
570 // recalculate prepaid part from payments
571 if ($this->payment_terms['days_before_due'] < 0)
572 { // this is partial invoice for selected prepayments made.
574 foreach($this->prepayments as $payment)
575 $paid += $payment['amt'];
576 $this->prep_amount = min($remainder, $paid);
577 } else // this is final invoice
578 $this->prep_amount = $remainder;
580 } /* end of class defintion */
586 var $item_description;
591 var $src_no; // number of src doc for this line
594 var $discount_percent;
599 var $valid; // validation in constructor
601 Line quantity properties in various cart create modes:
604 $quantity - quantity on current document
605 $qty_done - quantity processed on all child documents
606 $qty_dispatched - not used
610 $quantity - free parent quantity including this doc (= max allowed quantity)
611 $qty_done - qty processed on child documents (= min allowed qty)
612 $qty_dispatched - quantity currently selected to process
613 $qty_old - quantity processed on this document before reedition
615 new child entry (view parent followed by prepare_child() call):
616 $quantity - max allowed quantity (get from parent)
617 $qty_done - qty processed on other child documents
618 $qty_dispatched - quantity currently selected to process
619 $qty_old - 0; not used
627 function line_details ($stock_id, $qty, $prc, $disc_percent,
628 $qty_done, $standard_cost, $description, $id=0, $src_no=0, $src_id=0)
630 /* Constructor function to add a new LineDetail object with passed params */
633 $this->src_no = $src_no;
634 $this->src_id = $src_id;
635 $item_row = get_item($stock_id);
640 $this->mb_flag = $item_row["mb_flag"];
641 $this->units = $item_row["units"];
642 $this->descr_editable = $item_row["editable"];
643 if ($description == null || !$this->descr_editable)
644 $this->item_description = $item_row["description"];
646 $this->item_description = $description;
647 //$this->standard_cost = $item_row["material_cost"] + $item_row["labour_cost"] + $item_row["overhead_cost"];
648 $this->tax_type = $item_row["tax_type_id"];
649 $this->tax_type_name = $item_row["tax_type_name"];
650 $this->stock_id = $stock_id;
651 $this->quantity = $qty;
652 $this->qty_dispatched = $qty;
654 $this->discount_percent = $disc_percent;
655 $this->qty_done = $qty_done;
656 $this->standard_cost = $standard_cost;
660 // get unit price as stated on document
661 function line_price()