3 /* Definition of the cart class
4 this class can hold all the information for:
12 include_once($path_to_root . "/inventory/includes/inventory_db.inc");
13 include_once($path_to_root . "/taxes/tax_calc.inc");
17 var $trans_type; // invoice, order, delivery note ...
18 var $trans_no = array();// array (num1=>ver1,..) or 0 for new
19 var $so_type = 0; // for sales order: simple=0 template=1
21 var $line_items; //array of objects of class line_details
23 var $src_docs = array(); // array of arrays(num1=>ver1,...) or 0 for no src
24 var $src_date; // src document date (for info only)
28 var $sales_type; // set to the customer's sales type
29 var $sales_type_name; // set to customer's sales type name
32 var $customer_currency; // set to the customer's currency
33 var $default_discount; // set to the customer's discount %
40 var $delivery_address;
48 var $order_no; // the original order number
52 var $freight_cost = 0;
56 var $tax_group_array = null; // saves db queries
57 var $price_factor; // ditto for price calculations
58 //-------------------------------------------------------------------------
60 // $trans_no==0 => open new/direct document
61 // $trans_no!=0 && $view==false => read for view
62 // $trans_no!=0 && $view==true => read for edit (qty update from parent doc)
64 function Cart($type, $trans_no=0, $view=false ) {
65 /*Constructor function initialises a new shopping cart */
66 $this->line_items = array();
67 $this->sales_type = "";
68 $this->trans_type = 30;
69 $this->read($type, $trans_no, $view );
72 //-------------------------------------------------------------------------
73 // Reading document into cart
75 function read($type, $trans_no = 0, $view=false ) {
77 if (!is_array($trans_no)) $trans_no = array($trans_no);
80 if ($type == 30) { // sales order
81 read_sales_order($trans_no[0], $this);
82 if ($view) { // prepare for DN/IV entry
83 for($line_no = 0; $line_no < count($this->line_items); $line_no++) {
84 $line = &$this->line_items[$line_no];
85 $line->qty_dispatched = $line->quantity - $line->qty_done;
87 $this->document_date = Today();
89 } else { // derivative transaction
90 read_sales_trans($type, $trans_no, $this);
91 if ($this->order_no) { // free hand credit notes have no order_no
92 $sodata = get_sales_order_header($this->order_no);
93 $this->cust_ref = $sodata["customer_ref"];
94 // currently currency is hard linked to debtor account
95 // $this->customer_currency = $sodata["curr_code"];
96 $this->delivery_to = $sodata["deliver_to"];
97 $this->delivery_address = $sodata["delivery_address"];
99 if (!$view && ($type!=11 || $this->trans_link!=0)) {
100 $src_type = get_parent_type($type);
102 if ($src_type == 30) { // get src data from sales_orders
103 $this->src_docs = array( $sodata['order_no']=>$sodata['version']);
104 $srcdetails = get_sales_order_details($this->order_no);
105 } else { // get src_data from debtor_trans
106 $this->src_docs = get_customer_trans_version($src_type, get_parent_trans($type,$trans_no[0]));
107 $srcdetails = get_customer_trans_details($src_type,array_keys($this->src_docs));
109 // calculate & save: qtys on other docs and free qtys on src doc
111 for($line_no = 0; $srcline = db_fetch($srcdetails); $line_no++) {
112 $sign = 1; // $type==13 ? 1 : -1; // this is strange debtor_trans atavism
113 $line = &$this->line_items[$line_no];
115 $line->qty_old = $line->qty_dispatched = $line->quantity;
116 $line->quantity += $sign * ($srcline['quantity'] - $srcline['qty_done']); // add free qty on src doc
119 for($line_no = 0; $line_no < count($this->line_items); $line_no++) {
120 $line = &$this->line_items[$line_no];
121 $line->qty_dispatched = $line->quantity;
126 $this->trans_type = $type;
128 // set new sales document defaults here
129 if (get_global_customer() != reserved_words::get_all())
130 $this->customer_id = get_global_customer();
132 $this->customer_id = '';
133 $this->document_date = Today();
134 if (!is_date_in_fiscalyear($this->document_date))
135 $this->document_date = end_fiscalyear();
136 $this->reference = references::get_next($this->trans_type);
139 get_invoice_duedate($this->customer_id, $this->document_date);
142 add_days($this->document_date, 10); // FIX this should be in company prefs
146 //-------------------------------------------------------------------------
147 // Writing new/modified sales document to database.
148 // Makes parent documents for direct delivery/invoice by recurent call.
149 // $policy - 0 or 1: writeoff/return for IV, back order/cancel for DN
150 function write($policy=0) {
151 if (count($this->src_docs) == 0 && ($this->trans_type == 10 || $this->trans_type == 13)) {
152 // this is direct document - first add parent
153 $src = (PHP_VERSION<5) ? $this : clone( $this ); // make local copy of this cart
154 $src->trans_type = get_parent_type($src->trans_type);
155 $src->reference = 'auto';
159 $type = $this->trans_type;
160 $ref = $this->reference;
162 $this->read($src->trans_type, key($src->trans_no), true);
163 $this->reference = $ref;
164 $this->trans_type = $type;
165 $this->src_docs= $this->trans_no;
167 $this->order_no= $this->trans_type==13 ? key($src->trans_no) : $src->order_no;
169 switch($this->trans_type) {
171 return write_sales_invoice($this);
173 return write_credit_note($this, $policy);
175 return write_sales_delivery($this, $policy);
177 if ($this->trans_no==0) // new document
178 return add_sales_order($this);
180 return update_sales_order($this);
184 function set_customer($customer_id, $customer_name, $currency, $discount)
186 $this->customer_name = $customer_name;
187 $this->customer_id = $customer_id;
188 $this->default_discount = $discount;
189 $this->customer_currency = $currency;
192 function set_branch($branch_id, $tax_group_id, $tax_group_name, $phone='', $email='')
194 $this->Branch = $branch_id;
195 $this->phone = $phone;
196 $this->email = $email;
197 $this->tax_group_id = $tax_group_id;
198 $this->tax_group_array = get_tax_group_items_as_array($tax_group_id);
201 function set_sales_type($sales_type, $sales_name, $tax_included=0, $factor=0)
203 $this->sales_type = $sales_type;
204 $this->sales_type_name = $sales_name;
205 $this->tax_included = $tax_included;
206 $this->price_factor = $factor;
209 function set_location($id, $name)
211 $this->Location = $id;
212 $this->location_name = $name;
215 function set_delivery($shipper, $destination, $address, $freight_cost=null)
217 $this->ship_via = $shipper;
218 $this->deliver_to = $destination;
219 $this->delivery_address = $address;
220 if (isset($freight_cost))
221 $this->freight_cost = $freight_cost;
224 function add_to_cart($line_no,$stock_id, $qty, $price, $disc, $qty_done=0, $standard_cost=0, $description=null, $id=0, $src_no=0)
226 if (isset($stock_id) && $stock_id != "" && isset($qty)/* && $qty > 0*/) {
227 $this->line_items[$line_no] = new line_details($stock_id, $qty, $price, $disc,
228 $qty_done, $standard_cost, $description, $id, $src_no);
231 // shouldn't come here under normal circumstances
232 display_db_error("unexpected - adding an invalid item or null quantity", "", true);
237 function update_cart_item($line_no, $qty, $price, $disc)
239 $this->line_items[$line_no]->quantity = $qty;
240 $this->line_items[$line_no]->qty_dispatched = $qty;
241 $this->line_items[$line_no]->price = $price;
242 $this->line_items[$line_no]->discount_percent = $disc;
245 function update_add_cart_item_qty($line_no, $qty)
247 $this->line_items[$line_no]->quantity += $qty;
250 function remove_from_cart($line_no)
252 unset($this->line_items[$line_no]);
255 function clear_items()
257 unset($this->line_items);
258 $this->line_items = array();
259 $this->sales_type = "";
261 $this->customer_id = $this->order_no = 0;
264 function count_items()
267 foreach ($this->line_items as $line) {
268 if ($line->quantity!=$line->qty_done) $counter++;
273 function get_items_total()
277 foreach ($this->line_items as $ln_itm) {
278 $price = $ln_itm->line_price();
279 $total += round($ln_itm->quantity * $price * (1 - $ln_itm->discount_percent),
285 function get_items_total_dispatch()
289 foreach ($this->line_items as $ln_itm) {
290 $price = $ln_itm->line_price();
291 $total += round(($ln_itm->qty_dispatched * $price * (1 - $ln_itm->discount_percent)),
297 function has_items_dispatch()
299 foreach ($this->line_items as $ln_itm) {
300 if ($ln_itm->qty_dispatched > 0)
306 function any_already_delivered()
308 /* Checks if there have been any line item processed */
310 foreach ($this->line_items as $stock_item) {
311 if ($stock_item->qty_done !=0) {
320 function some_already_delivered($line_no)
322 /* Checks if there have been deliveries of a specific line item */
323 if (isset($this->line_items[$line_no]) &&
324 $this->line_items[$line_no]->qty_done != 0) {
330 function get_taxes($shipping_cost=null)
334 if($shipping_cost==null)
335 $shipping_cost = $this->freight_cost;
337 foreach ($this->line_items as $ln_itm) {
338 $items[] = $ln_itm->stock_id;
339 $prices[] = round(($ln_itm->qty_dispatched *
340 $ln_itm->line_price()* (1 - $ln_itm->discount_percent)), user_price_dec());
343 $taxes = get_tax_for_items($items, $prices, $shipping_cost,
344 $this->tax_group_id, $this->tax_included, $this->tax_group_array);
346 // Adjustment for swiss franken, we always have 5 rappen = 1/20 franken
347 if ($this->customer_currency == 'CHF') {
348 $val = $taxes['1']['Value'];
349 $val1 = (floatval((intval(round(($val*20),0)))/20));
350 $taxes['1']['Value'] = $val1;
356 function get_tax_free_shipping()
359 if ($this->tax_included==0)
360 return $this->freight_cost;
362 return ($this->freight_cost - $this->get_shipping_tax());
365 function get_shipping_tax()
368 $tax_items = get_shipping_tax_as_array();
370 if ($tax_items != null) {
371 foreach ($tax_items as $item_tax) {
372 $index = $item_tax['tax_type_id'];
373 if (isset($this->tax_group_array[$index])) {
374 $tax_rate += $item_tax['rate'];
378 if($this->tax_included)
379 return round($this->freight_cost*$tax_rate/($tax_rate+100), user_price_dec());
381 return round($this->freight_cost*$tax_rate/100, user_price_dec());
384 } /* end of class defintion */
390 var $item_description;
395 var $src_no; // number of src doc for this line
398 var $discount_percent;
399 var $qty_done; // quantity processed on child documents
400 var $qty_dispatched; // quantity selected to process
401 var $qty_old=0; // quantity dispatched before edition
404 function line_details ($stock_id, $qty, $prc, $disc_percent,
405 $qty_done, $standard_cost, $description, $id=0, $src_no=0 )
407 /* Constructor function to add a new LineDetail object with passed params */
410 $this->src_no = $src_no;
411 $item_row = get_item($stock_id);
413 if ($item_row == null)
414 display_db_error("invalid item added to order : $stock_id", "");
416 $this->mb_flag = $item_row["mb_flag"];
417 $this->units = $item_row["units"];
418 if ($description == null)
419 $this->item_description = $item_row["description"];
421 $this->item_description = $description;
422 //$this->standard_cost = $item_row["material_cost"] + $item_row["labour_cost"] + $item_row["overhead_cost"];
423 $this->tax_type = $item_row["tax_type_id"];
424 $this->tax_type_name = $item_row["tax_type_name"];
426 $this->stock_id = $stock_id;
427 $this->quantity = $qty;
428 $this->qty_dispatched = $qty;
430 $this->discount_percent = $disc_percent;
431 $this->qty_done = $qty_done;
432 $this->standard_cost = $standard_cost;
435 // get unit price as stated on document
436 function line_price()