<?php
-
+/**********************************************************************
+ Copyright (C) FrontAccounting, LLC.
+ Released under the terms of the GNU General Public License, GPL,
+ as published by the Free Software Foundation, either version 3
+ of the License, or (at your option) any later version.
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ See the License here <http://www.gnu.org/licenses/gpl-3.0.html>.
+***********************************************************************/
/* Definition of the cart class
this class can hold all the information for:
class cart
{
- var $trans_type; // invoice, order, delivery note ...
+ var $trans_type; // invoice, order, quotation, delivery note ...
var $trans_no = array();// array (num1=>ver1,..) or 0 for new
var $so_type = 0; // for sales order: simple=0 template=1
-
+ var $cart_id; // used to detect multi-tab edition conflits
var $line_items; //array of objects of class line_details
var $src_docs = array(); // array of arrays(num1=>ver1,...) or 0 for no src
var $Location;
var $location_name;
var $order_no; // the original order number
- var $trans_link = 0;
var $ship_via;
var $freight_cost = 0;
var $tax_group_name;
var $tax_group_array = null; // saves db queries
var $price_factor; // ditto for price calculations
+
+ var $pos; // user assigned POS (contains cash accont number/name)
+ var $cash_discount; // not used as of FA 2.1
+ var $dimension_id;
+ var $dimension2_id;
+ var $payment;
+ var $payment_terms; // cached payment terms
+ var $credit;
+
//-------------------------------------------------------------------------
//
// $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 && $prep_child==false => update with parent constarints for reedition
+ // $trans_no!=0 && $prep_child==true => prepare for child doc entry
//
- function Cart($type, $trans_no=0, $view=false ) {
+ function Cart($type, $trans_no=0, $prep_child=false) {
/*Constructor function initialises a new shopping cart */
$this->line_items = array();
$this->sales_type = "";
- $this->trans_type = 30;
- $this->read($type, $trans_no, $view );
+ if ($type == ST_SALESQUOTE)
+ $this->trans_type = $type;
+ else
+ $this->trans_type = ST_SALESORDER;
+ $this->dimension_id = 0;
+ $this->dimension2_id = 0;
+ $this->pos = get_sales_point(user_pos());
+ $this->read($type, $trans_no, $prep_child);
+ $this->cart_id = uniqid('');
+ }
+
+ //
+ // Prepare cart to new child document entry, just after initial parent doc read.
+ //
+ function prepare_child()
+ {
+ global $Refs;
+
+ $type = get_child_type($this->trans_type);
+
+ $this->trans_type = $type;
+ $this->reference = $Refs->get_next($this->trans_type);
+ $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' : $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);
+ }
+
+ if ($type == ST_CUSTCREDIT)
+ $this->src_date = $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'];
+ 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, $prep_child=false) {
+
+ global $SysPrefs, $Refs;
if (!is_array($trans_no)) $trans_no = array($trans_no);
- if ($trans_no[0]) {
- if ($type == 30) { // sales order
- read_sales_order($trans_no[0], $this);
- 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 { // derivative transaction
- read_sales_trans($type, $trans_no, $this);
+
+ 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);
+ } 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);
+ $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"];
+ // child transaction reedition - update with parent info unless it is freehand
+ if (!$prep_child) // this is read for view/reedition
+ $this->set_parent_constraints($sodata, $trans_no[0]);
}
- if (!$view && ($type!=11 || $this->trans_link!=0)) {
- $src_type = get_parent_type($type);
- $src_details = 0;
- if ($src_type == 30) { // get src data from sales_orders
- $this->src_docs = array( $sodata['order_no']=>$sodata['version']);
- $srcdetails = get_sales_order_details($this->order_no);
- } 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
- $line_no = 0;
- 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 {
- 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;
- }
- }
- }
- } else {
+ }
+ // convert document into child and prepare qtys for entry
+ if ($prep_child)
+ $this->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() != reserved_words::get_all())
+ if (get_global_customer() != ALL_TEXT)
$this->customer_id = get_global_customer();
else
$this->customer_id = '';
- $this->document_date = Today();
+ $this->document_date = new_doc_date();
if (!is_date_in_fiscalyear($this->document_date))
$this->document_date = end_fiscalyear();
- $this->reference = references::get_next($this->trans_type);
- if ($type == 10)
- $this->due_date =
- get_invoice_duedate($this->customer_id, $this->document_date);
- else
- $this->due_date =
- add_days($this->document_date, sys_prefs::default_delivery_required_by());
- }
+ $this->reference = $Refs->get_next($this->trans_type);
+ if ($type != ST_SALESORDER && $type != ST_SALESQUOTE) // Added 2.1 Joe Hunt 2008-11-12
+ {
+ $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->dimension2_id = 0;
+ else
+ $this->dimension2_id = $cust['dimension2_id'];
+ }
+ }
+ }
+ 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);
}
//-------------------------------------------------------------------------
// Writing new/modified sales document to database.
// 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) {
- if (count($this->src_docs) == 0 && ($this->trans_type == 10 || $this->trans_type == 13)) {
+ function write($policy=0) {
+ 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)) {
// 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;
+ $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==13 ? key($src->trans_no) : $src->order_no;
+ $this->due_date = $due_date;
}
-// if we want to save old or derivative document first decode html entities
-// from text fields. For new documents this is not needed.
- if ($this->trans_no || $this->trans_type != 30) {
- $this->reference = @html_entity_decode($this->reference);
- $this->Comments = @html_entity_decode($this->Comments);
- foreach($this->line_items as $lineno => $line) {
- $this->line_items[$lineno]->stock_id = @html_entity_decode($line->stock_id);
- $this->line_items[$lineno]->description = @html_entity_decode($line->description);
- }
+ $this->reference = @html_entity_decode($this->reference, ENT_QUOTES);
+ $this->Comments = @html_entity_decode($this->Comments, ENT_QUOTES);
+ foreach($this->line_items as $lineno => $line) {
+ $this->line_items[$lineno]->stock_id = @html_entity_decode($line->stock_id, ENT_QUOTES);
+ $this->line_items[$lineno]->item_description = @html_entity_decode($line->item_description, ENT_QUOTES);
}
switch($this->trans_type) {
- case 10:
- return write_sales_invoice($this);
- case 11:
- return write_credit_note($this, $policy);
- case 13:
- return write_sales_delivery($this, $policy);
- case 30:
+ case ST_SALESINVOICE:
+ $ret = write_sales_invoice($this); break;
+ case ST_CUSTCREDIT:
+ $ret = write_credit_note($this, $policy); break;
+ case ST_CUSTDELIVERY:
+ $ret = write_sales_delivery($this, $policy); break;
+ case ST_SALESORDER:
+ case ST_SALESQUOTE:
if ($this->trans_no==0) // new document
- return add_sales_order($this);
+ $ret = add_sales_order($this);
else
- return update_sales_order($this);
+ $ret = update_sales_order($this);
}
+
+ commit_transaction();
+
+ return $ret;
}
- function set_customer($customer_id, $customer_name, $currency, $discount)
+ function set_customer($customer_id, $customer_name, $currency, $discount, $payment, $cdiscount=0)
{
$this->customer_name = $customer_name;
$this->customer_id = $customer_id;
$this->default_discount = $discount;
$this->customer_currency = $currency;
+ $this->payment = $payment;
+ $this->payment_terms = get_payment_terms($payment);
+ $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='')
$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)
{
- if (isset($stock_id) && $stock_id != "" && isset($qty)/* && $qty > 0*/) {
- $this->line_items[$line_no] = new line_details($stock_id, $qty, $price, $disc,
- $qty_done, $standard_cost, $description, $id, $src_no);
+ $line = new line_details($stock_id, $qty, $price, $disc,
+ $qty_done, $standard_cost, $description, $id, $src_no, $src_id);
+
+ if ($line->valid) {
+ $this->line_items[$line_no] = $line;
return 1;
- } else {
- // shouldn't come here under normal circumstances
- display_db_error("unexpected - adding an invalid item or null quantity", "", true);
- }
+ } else
+ display_error(_("You have to enter valid stock code or nonempty description"));
return 0;
}
- function update_cart_item($line_no, $qty, $price, $disc)
+ function update_cart_item($line_no, $qty, $price, $disc, $description="")
{
+ if ($description != "")
+ $this->line_items[$line_no]->item_description = $description;
$this->line_items[$line_no]->quantity = $qty;
$this->line_items[$line_no]->qty_dispatched = $qty;
$this->line_items[$line_no]->price = $price;
function remove_from_cart($line_no)
{
- unset($this->line_items[$line_no]);
+ array_splice($this->line_items, $line_no, 1);
}
function clear_items()
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());
}
// 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;
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'];
}
}
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;
+ }
} /* end of class defintion */
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 )
+ $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 == null)
- display_db_error("invalid item added to order : $stock_id", "");
-
+ if (!$item_row)
+ return;
+
$this->mb_flag = $item_row["mb_flag"];
$this->units = $item_row["units"];
- if ($description == null)
+ $this->descr_editable = $item_row["editable"];
+ if ($description == null || !$this->descr_editable)
$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;
$this->quantity = $qty;
$this->qty_dispatched = $qty;
$this->discount_percent = $disc_percent;
$this->qty_done = $qty_done;
$this->standard_cost = $standard_cost;
+ $this->valid = true;
}
// get unit price as stated on document