X-Git-Url: https://delta.frontaccounting.com/gitweb/?a=blobdiff_plain;f=sales%2Fincludes%2Fcart_class.inc;h=1bc3db242f5b0528d2f98a2a65bde6275125bd14;hb=2bcdab793e406bb5a44d2c4e079ec7cc2a1aa857;hp=3566d686ff14bdd4c2bb82ee91d9b686d9da9f66;hpb=aa3baa1fadd3c56034dbe371ae864bc0346b3c4d;p=fa-stable.git diff --git a/sales/includes/cart_class.inc b/sales/includes/cart_class.inc index 3566d686..1bc3db24 100644 --- a/sales/includes/cart_class.inc +++ b/sales/includes/cart_class.inc @@ -21,7 +21,7 @@ iv) a delivery note include_once($path_to_root . "/inventory/includes/inventory_db.inc"); include_once($path_to_root . "/taxes/tax_calc.inc"); -class cart +class Cart { var $trans_type; // invoice, order, quotation, delivery note ... var $trans_no = array();// array (num1=>ver1,..) or 0 for new @@ -55,7 +55,6 @@ class cart var $Location; var $location_name; var $order_no; // the original order number - var $trans_link = 0; var $ship_via; var $freight_cost = 0; @@ -66,7 +65,6 @@ class cart var $price_factor; // ditto for price calculations var $pos; // user assigned POS - var $cash; // cash transaction - helper variable not stored in db var $cash_account; var $account_name; var $cash_discount; // not used as of FA 2.1 @@ -74,13 +72,25 @@ class cart var $dimension2_id; var $payment; var $payment_terms; // cached payment terms + var $credit; + // prepayment mode: + var $prepaid=false; // true for documents issued in prepayment mode + var $prep_amount=0; // prepayment required for SO, invoiced amount for prepaiament invoice + var $sum_paid; // sum of all allocated prepayments both to order and related invoices + var $alloc; // sum of payments allocated to this document + var $prepayments = array(); // allocation records for this document + var $ex_rate; + + var $fixed_asset = false; + //------------------------------------------------------------------------- // // $trans_no==0 => open new/direct document - // $trans_no!=0 && $view==false => read for view - // $trans_no!=0 && $view==true => read for edit (qty update from parent doc) + // $trans_no!=0 && $prepare_child==false => update with parent constarints for reedition + // $trans_no!=0 && $prepare_child==true => prepare for child doc entry + // $prepare_child is set to ST_SALESINVOICE for prepayment invoices // - function Cart($type, $trans_no=0, $view=false ) { + function __construct($type, $trans_no=0, $prepare_child=false) { /*Constructor function initialises a new shopping cart */ $this->line_items = array(); $this->sales_type = ""; @@ -90,118 +100,184 @@ class cart $this->trans_type = ST_SALESORDER; $this->dimension_id = 0; $this->dimension2_id = 0; - $this->read($type, $trans_no, $view ); + $this->pos = get_sales_point(user_pos()); + $this->read($type, $trans_no, $prepare_child); $this->cart_id = uniqid(''); } + /* + Optional sorting items by stock_id. + */ + function _cmp_lines($a, $b) + { + return strcmp($a->stock_id, $b->stock_id); + } + + /* + Returns items array optionally sorted by item code. + */ + function get_items() + { + global $SysPrefs; + + $items = $this->line_items; + if (@$SysPrefs->sort_sales_items) + uasort($items, array($this, '_cmp_lines')); + + return $items; + } + // + // Prepare cart to new child document entry, just after initial parent doc read. + // + function prepare_child($type) + { + global $Refs; + + if ($type === true) + $type = get_child_type($this->trans_type); + + $this->trans_type = $type; + $this->reference = $Refs->get_next($this->trans_type, null, array('date' => $this->document_date, + 'customer' => $this->customer_id, 'branch' => $this->Branch)); + if ($type == ST_CUSTCREDIT) + $this->src_date = $this->document_date; + + $this->document_date = new_doc_date(); + + for($line_no = 0; $line_no < count($this->line_items); $line_no++) { + $line = &$this->line_items[$line_no]; + $line->src_id = $line->id; // save src line ids for update + $line->qty_dispatched = $type == ST_CUSTCREDIT ? '0' : + (($this->prepaid && $type == ST_SALESINVOICE) ? $line->quantity : $line->quantity - $line->qty_done); + $line->qty_old = 0; + } + unset($line); + + if ($type == ST_CUSTDELIVERY) { + $this->order_no = key($this->trans_no); + $cust = get_customer($this->customer_id); + $this->dimension_id = $cust['dimension_id']; + $this->dimension2_id = $cust['dimension2_id']; + } + if ($type == ST_SALESINVOICE) { + $this->due_date = get_invoice_duedate($this->payment, $this->document_date); + } + + $this->src_docs = $this->trans_no; + $this->trans_no = 0; + } + + // + // Prepares transaction for reedition updating with parent transaction data + // + function set_parent_constraints($sodata, $src_no) { + + $srcdetails = get_sales_parent_lines($this->trans_type, $src_no); + $src_type = get_parent_type($this->trans_type); + + // calculate & save: qtys on other docs and free qtys on src doc + $line_no = 0; $src_docs = array(); + // Loop speed optimisation below depends on fact + // that child line_items contains subset of parent lines in _the_same_ order ! + while (($line_no < count($this->line_items)) && ($srcline = db_fetch($srcdetails))) { + $line = &$this->line_items[$line_no]; + $src_docs[] = $src_type == ST_SALESORDER ? $srcline['order_no'] : $srcline['debtor_trans_no']; + while($srcline['id'] != $line->src_id) // Logic : This will increment the line_items array till sales_order line is matched. + { // Fixes Delivery note bug : Parent constraints not working if sales order line deleted after delivery + $line_no++; + $line = &$this->line_items[$line_no]; + } + if ($srcline['id'] == $line->src_id) { + if ($this->trans_type == ST_SALESINVOICE) + $line->src_no = $srcline['debtor_trans_no']; + $line->qty_old = $line->qty_dispatched = $line->quantity; + $line->quantity += $srcline['quantity'] - + ($src_type==ST_SALESORDER ? $srcline['qty_sent'] : $srcline['qty_done']); // add free qty on src doc + $line_no++; + } + } + + if ($src_type == ST_SALESORDER || $src_type == 0) { + $this->src_docs = array( $sodata['order_no']=>$sodata['version']); + } else { + // get src_data from debtor_trans + $this->src_docs = get_customer_trans_version($src_type, array_unique($src_docs)); + } + } //------------------------------------------------------------------------- // Reading document into cart // - function read($type, $trans_no = 0, $view=false ) { + function read($type, $trans_no=0, $prepare_child=false) { global $SysPrefs, $Refs; if (!is_array($trans_no)) $trans_no = array($trans_no); - if ($trans_no[0]) // read old transaction - { + + if ($trans_no[0]) { // read old transaction if ($type == ST_SALESORDER || $type == ST_SALESQUOTE) { // sales order || sales quotation read_sales_order($trans_no[0], $this, $type); - if ($view) { // prepare for DN/IV entry - for($line_no = 0; $line_no < count($this->line_items); $line_no++) { - $line = &$this->line_items[$line_no]; - $line->src_id = $line->id; // save src line ids for update - $line->qty_dispatched = $line->quantity - $line->qty_done; - } - } } else { // other type of sales transaction - read_sales_trans($type, $trans_no, $this); - if ($this->order_no) { // free hand credit notes have no order_no - $sodata = get_sales_order_header($this->order_no, ST_SALESORDER); - $this->cust_ref = $sodata["customer_ref"]; - // currently currency is hard linked to debtor account - // $this->customer_currency = $sodata["curr_code"]; - $this->delivery_to = $sodata["deliver_to"]; - $this->delivery_address = $sodata["delivery_address"]; - } - // old derivative transaction edit - if (!$view && ($type!=ST_CUSTCREDIT || $this->trans_link!=0)) { - $src_type = get_parent_type($type); - if ($src_type == ST_SALESORDER) { // get src data from sales_orders - $this->src_docs = array( $sodata['order_no']=>$sodata['version']); - $srcdetails = get_sales_order_details($this->order_no, ST_SALESORDER); - } else { // get src_data from debtor_trans - $this->src_docs = get_customer_trans_version($src_type, get_parent_trans($type,$trans_no[0])); - $srcdetails = get_customer_trans_details($src_type,array_keys($this->src_docs)); - } - // calculate & save: qtys on other docs and free qtys on src doc - for($line_no = 0; $srcline = db_fetch($srcdetails); $line_no++) { - $sign = 1; // $type==13 ? 1 : -1; // this is strange debtor_trans atavism - $line = &$this->line_items[$line_no]; - - $line->src_id = $srcline['id']; // save src line ids for update - $line->qty_old = $line->qty_dispatched = $line->quantity; - $line->quantity += $sign * ($srcline['quantity'] - $srcline['qty_done']); // add free qty on src doc - } - } else { // prepare qtys for derivative document entry (not used in display) - for($line_no = 0; $line_no < count($this->line_items); $line_no++) { - $line = &$this->line_items[$line_no]; - $line->src_id = $line->id; // save src line ids for update - $line->qty_dispatched = $line->quantity - $line->qty_done; - } - } + read_sales_trans($type, $trans_no, $this); + $this->prepayments = get_payments_for($trans_no[0], $type, $this->customer_id); + $this->update_payments(); + if ($this->order_no) { // free hand credit notes have no order_no + $sodata = get_sales_order_header($this->order_no, ST_SALESORDER); + $this->cust_ref = $sodata["customer_ref"]; + // currently currency is hard linked to debtor account + $this->delivery_to = $sodata["deliver_to"]; + $this->delivery_address = $sodata["delivery_address"]; + // child transaction reedition - update with parent info unless it is freehand + if (!$this->is_prepaid() && !$prepare_child) // this is read for view/reedition + $this->set_parent_constraints($sodata, $trans_no[0]); } + } + // convert document into child and prepare qtys for entry + if ($prepare_child) + $this->prepare_child($prepare_child); + } else { // new document - $this->trans_type = $type; - $this->trans_no = 0; - $this->customer_currency = get_company_currency(); - // set new sales document defaults here - if (get_global_customer() != ALL_TEXT) - $this->customer_id = get_global_customer(); - else - $this->customer_id = ''; - $this->document_date = new_doc_date(); - if (!is_date_in_fiscalyear($this->document_date)) - $this->document_date = end_fiscalyear(); - $this->reference = $Refs->get_next($this->trans_type); - if ($type != ST_SALESORDER && $type != ST_SALESQUOTE) // Added 2.1 Joe Hunt 2008-11-12 + $this->trans_type = $type; + $this->trans_no = 0; + $this->customer_currency = get_company_currency(); + // set new sales document defaults here + if (get_global_customer() != ALL_TEXT) + $this->customer_id = get_global_customer(); + else + $this->customer_id = ''; + $this->document_date = new_doc_date(); + if (!is_date_in_fiscalyear($this->document_date)) + $this->document_date = end_fiscalyear(); + $this->reference = $Refs->get_next($this->trans_type, null, array('date' => Today(), + 'customer' => $this->customer_id)); + if ($type != ST_SALESORDER && $type != ST_SALESQUOTE) // Added 2.1 Joe Hunt 2008-11-12 + { + $dim = get_company_pref('use_dimension'); + if ($dim > 0) { - $dim = get_company_pref('use_dimension'); - if ($dim > 0) + if ($this->customer_id == '') + $this->dimension_id = 0; + else + { + $cust = get_customer($this->customer_id); + $this->dimension_id = $cust['dimension_id']; + } + if ($dim > 1) { if ($this->customer_id == '') - $this->dimension_id = 0; + $this->dimension2_id = 0; else - { - $cust = get_customer($this->customer_id); - $this->dimension_id = $cust['dimension_id']; - } - if ($dim > 1) - { - if ($this->customer_id == '') - $this->dimension2_id = 0; - else - $this->dimension2_id = $cust['dimension2_id']; - } + $this->dimension2_id = $cust['dimension2_id']; } - } - if ($type == ST_SALESINVOICE) { - $this->due_date = - get_invoice_duedate($this->payment, $this->document_date); - $this->cash = $this->payment_terms['cash_sale']; - if ($this->cash) { - $this->Location = $pos['pos_location']; - $this->location_name = $pos['location_name']; - $this->cash_account = $pos['pos_account']; - $this->account_name = $pos['bank_account_name']; - } - } else - $this->due_date = - add_days($this->document_date, $SysPrefs->default_delivery_required_by()); - } - $this->pos = user_pos(); - $pos = get_sales_point($this->pos); - if (!$pos['cash_sale'] && !$pos['credit_sale']) - $this->pos = -1; // mark not editable payment type + } + } + if ($type == ST_SALESINVOICE) { + $this->due_date = + get_invoice_duedate($this->payment, $this->document_date); + } else + $this->due_date = + add_days($this->document_date, $SysPrefs->default_delivery_required_by()); + } + $this->credit = get_current_cust_credit($this->customer_id); } //------------------------------------------------------------------------- @@ -209,25 +285,39 @@ class cart // Makes parent documents for direct delivery/invoice by recurent call. // $policy - 0 or 1: writeoff/return for IV, back order/cancel for DN function write($policy=0) { + + global $SysPrefs, $Refs; + begin_transaction(); // prevents partial database changes in case of direct delivery/invoice - if (count($this->src_docs) == 0 && ($this->trans_type == ST_SALESINVOICE || $this->trans_type == ST_CUSTDELIVERY)) { + if ($this->reference != 'auto' && $this->trans_no == 0 && !is_new_reference($this->reference, $this->trans_type)) + { + if (!empty($SysPrefs->prefs['ref_no_auto_increase'])) + $this->reference = $Refs->get_next($this->trans_type, null, array('date' => Today())); + if (!is_new_reference($this->reference, $this->trans_type)) + { + commit_transaction(); + return -1; + } + } + if (count($this->src_docs) == 0 && ($this->trans_type == ST_SALESINVOICE || $this->trans_type == ST_CUSTDELIVERY) && !$this->is_prepaid()) { // this is direct document - first add parent - $src = (PHP_VERSION<5) ? $this : clone( $this ); // make local copy of this cart - $src->trans_type = get_parent_type($src->trans_type); - $src->reference = 'auto'; - - $src->write(1); - $type = $this->trans_type; $ref = $this->reference; $date = $this->document_date; - // re-read document - $this->read($src->trans_type, key($src->trans_no), true); + $due_date = $this->due_date; + $dimension_id = $this->dimension_id; + $dimension2_id = $this->dimension2_id; + $this->trans_type = get_parent_type($this->trans_type); + + $this->reference = 'auto'; + $trans_no = $this->write(1); + + // re-read parent document converting it to child + $this->read($this->trans_type, $trans_no, true); $this->document_date = $date; $this->reference = $ref; - $this->trans_type = $type; - $this->src_docs= $this->trans_no; - $this->trans_no = 0; - $this->order_no= $this->trans_type==ST_CUSTDELIVERY ? key($src->trans_no) : $src->order_no; + $this->due_date = $due_date; + $this->dimension_id = $dimension_id; + $this->dimension2_id = $dimension2_id; } $this->reference = @html_entity_decode($this->reference, ENT_QUOTES); $this->Comments = @html_entity_decode($this->Comments, ENT_QUOTES); @@ -237,20 +327,22 @@ class cart } switch($this->trans_type) { case ST_SALESINVOICE: - write_sales_invoice($this); break; + $ret = write_sales_invoice($this); break; case ST_CUSTCREDIT: - write_credit_note($this, $policy); break; + $ret = write_credit_note($this, $policy); break; case ST_CUSTDELIVERY: - write_sales_delivery($this, $policy); break; + $ret = write_sales_delivery($this, $policy); break; case ST_SALESORDER: case ST_SALESQUOTE: if ($this->trans_no==0) // new document - add_sales_order($this); + $ret = add_sales_order($this); else - update_sales_order($this); + $ret = update_sales_order($this); } commit_transaction(); + + return $ret; } function set_customer($customer_id, $customer_name, $currency, $discount, $payment, $cdiscount=0) @@ -261,8 +353,13 @@ class cart $this->customer_currency = $currency; $this->payment = $payment; $this->payment_terms = get_payment_terms($payment); - $this->cash = $this->payment_terms['cash_sale']; $this->cash_discount = $cdiscount; + + if ($this->payment_terms['cash_sale']) { + $this->Location = $this->pos['pos_location']; + $this->location_name = $this->pos['location_name']; + } + $this->credit = get_current_cust_credit($customer_id); } function set_branch($branch_id, $tax_group_id, $tax_group_name, $phone='', $email='') @@ -297,10 +394,11 @@ class cart $this->freight_cost = $freight_cost; } - function add_to_cart($line_no, $stock_id, $qty, $price, $disc, $qty_done=0, $standard_cost=0, $description=null, $id=0, $src_no=0) + function add_to_cart($line_no, $stock_id, $qty, $price, $disc, $qty_done=0, $standard_cost=0, $description=null, $id=0, $src_no=0, + $src_id=0) { $line = new line_details($stock_id, $qty, $price, $disc, - $qty_done, $standard_cost, $description, $id, $src_no); + $qty_done, $standard_cost, $description, $id, $src_no, $src_id); if ($line->valid) { $this->line_items[$line_no] = $line; @@ -414,17 +512,18 @@ class cart foreach ($this->line_items as $ln_itm) { $items[] = $ln_itm->stock_id; - $prices[] = round(($ln_itm->qty_dispatched * + $prices[] = round((( + $this->trans_type==ST_SALESORDER ? $ln_itm->quantity : $ln_itm->qty_dispatched) * $ln_itm->line_price()* (1 - $ln_itm->discount_percent)), user_price_dec()); } $taxes = get_tax_for_items($items, $prices, $shipping_cost, - $this->tax_group_id, $this->tax_included, $this->tax_group_array); + $this->tax_group_id, $this->tax_included, $this->tax_group_array); // Adjustment for swiss franken, we always have 5 rappen = 1/20 franken if ($this->customer_currency == 'CHF') { $val = $taxes['1']['Value']; - $val1 = (floatval((intval(round(($val*20),0)))/20)); + $val1 = (floatval((intval(round(($val*20),0)))/20)); $taxes['1']['Value'] = $val1; } return $taxes; @@ -443,12 +542,12 @@ class cart function get_shipping_tax() { - $tax_items = get_shipping_tax_as_array(); + $tax_items = get_shipping_tax_as_array($this->tax_group_id); $tax_rate = 0; if ($tax_items != null) { foreach ($tax_items as $item_tax) { $index = $item_tax['tax_type_id']; - if (isset($this->tax_group_array[$index])) { + if (isset($this->tax_group_array[$index]['rate'])) { $tax_rate += $item_tax['rate']; } } @@ -458,7 +557,102 @@ class cart else return round($this->freight_cost*$tax_rate/100, user_price_dec()); } + /* + Returns transaction value including all taxes + */ + function get_trans_total() { + + $total = $this->get_items_total() + $this->freight_cost; + $dec = user_price_dec(); + if (!$this->tax_included ) { + $total += $this->get_shipping_tax(); + $taxes = $this->get_taxes(); + foreach($taxes as $tax) + $total += round($tax['Value'], $dec); + } + + return $total; + } + + /* + Checks cart quantities on document_date. + Returns array of stock_ids which stock quantities would go negative on some day. + */ + function check_qoh($date=null, $location=null) + { + $low_stock = array(); + // check only for customer delivery and direct sales invoice + if (!($this->trans_type == ST_CUSTDELIVERY || ($this->trans_type == ST_SALESINVOICE && $this->trans_no==0))) + return $low_stock; + + // collect quantities by stock_id + $qtys = array(); + foreach ($this->line_items as $line_no => $line_item) + { + if (has_stock_holding($line_item->mb_flag)) + { + if (!$this->trans_no) // new delivery + $qtys[$line_item->stock_id]['qty'] = $line_item->qty_dispatched + @$qtys[$line_item->stock_id]['qty']; + else // DN modification: check change in quantity + $qtys[$line_item->stock_id]['qty'] = ($line_item->qty_dispatched-$line_item->qty_old) + @$qtys[$line_item->stock_id]['qty']; + $qtys[$line_item->stock_id]['line'] = $line_no; + } + } + + foreach($qtys as $stock_id => $sum) + { + if (check_negative_stock($stock_id, -$sum['qty'], $location ? $location : $this->Location, $date ? $date : $this->document_date)) + $low_stock[] = $stock_id; + } + + return $low_stock; + } + + /* + Returns true for documents issued in prepayment cycle. + */ + function is_prepaid() + { + return $this->prepaid; + } + /* + Order is ready for delivery in prepament mode. + */ + function is_released() + { + return floatcmp($this->sum_paid, $this->prep_amount) >= 0; + } + + /* + Check whether order has been already invoiced/send or not. + */ + function is_started() + { + if ($this->trans_no==0) + return false; + $order_no = array_keys($this->trans_no); + + return is_sales_order_started(reset($order_no)); + } + /* + Check payment terms and prepayments selected for this invoice, + and updates partial/final invoice value respectively. + */ + function update_payments() + { + $remainder = prepaid_invoice_remainder($this->order_no); + + // recalculate prepaid part from payments + if ($this->payment_terms['days_before_due'] == -1) + { // this is partial invoice for selected prepayments made. + $paid = 0; + foreach($this->prepayments as $payment) + $paid += $payment['amt']; + $this->prep_amount = $this->trans_no ? $paid : min($remainder, $paid); + } else // this is final invoice + $this->prep_amount = $remainder; + } } /* end of class defintion */ class line_details @@ -472,24 +666,48 @@ class line_details var $tax_type_name; var $src_no; // number of src doc for this line var $src_id; - var $quantity; var $price; var $discount_percent; - var $qty_done; // quantity processed on child documents - var $qty_dispatched; // quantity selected to process - var $qty_old=0; // quantity dispatched before edition + var $standard_cost; var $descr_editable; var $valid; // validation in constructor + /* + Line quantity properties in various cart create modes: + + view: + $quantity - quantity on current document + $qty_done - quantity processed on all child documents + $qty_dispatched - not used + $qty_old - not used + + edit: + $quantity - free parent quantity including this doc (= max allowed quantity) + $qty_done - qty processed on child documents (= min allowed qty) + $qty_dispatched - quantity currently selected to process + $qty_old - quantity processed on this document before reedition + + new child entry (view parent followed by prepare_child() call): + $quantity - max allowed quantity (get from parent) + $qty_done - qty processed on other child documents + $qty_dispatched - quantity currently selected to process + $qty_old - 0; not used + */ + var $quantity; + var $qty_done; + var $qty_dispatched; + var $qty_old = 0; + - function line_details ($stock_id, $qty, $prc, $disc_percent, - $qty_done, $standard_cost, $description, $id=0, $src_no=0 ) + function __construct($stock_id, $qty, $prc, $disc_percent, + $qty_done, $standard_cost, $description, $id=0, $src_no=0, $src_id=0) { /* Constructor function to add a new LineDetail object with passed params */ $this->id = $id; $this->src_no = $src_no; + $this->src_id = $src_id; $item_row = get_item($stock_id); if (!$item_row) @@ -502,7 +720,6 @@ class line_details $this->item_description = $item_row["description"]; else $this->item_description = $description; - //$this->standard_cost = $item_row["material_cost"] + $item_row["labour_cost"] + $item_row["overhead_cost"]; $this->tax_type = $item_row["tax_type_id"]; $this->tax_type_name = $item_row["tax_type_name"]; $this->stock_id = $stock_id; @@ -522,4 +739,3 @@ class line_details } } -?>