sales/includes/cart_class.inc

   1 <?php
   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:
  14
  15 i)   a sales order
  16 ii)  an invoice
  17 iii) a credit note
  18 iv)  a delivery note
  19 */
  20
  21 include_once($path_to_root . "/inventory/includes/inventory_db.inc");
  22 include_once($path_to_root . "/taxes/tax_calc.inc");
  23
  24 class cart
  25 {
  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
  31
  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)
  34
  35         var $document_date;
  36         var $due_date;
  37         var $sales_type; // set to the customer's sales type
  38         var $sales_type_name; // set to customer's sales type name
  39         var $tax_included;
  40
  41         var $customer_currency; // set to the customer's currency
  42         var $default_discount; // set to the customer's discount %
  43         var $customer_name;
  44         var $customer_id;
  45         var $Branch;
  46         var $email;
  47
  48         var $deliver_to;
  49         var $delivery_address;
  50         var $phone;
  51
  52         var $cust_ref;
  53         var $reference;
  54         var $Comments;
  55         var $Location;
  56         var $location_name;
  57         var $order_no;          // the original order number
  58         var $trans_link = 0;
  59
  60         var $ship_via;
  61         var $freight_cost = 0;
  62
  63         var $tax_group_id;
  64         var $tax_group_name;
  65         var $tax_group_array = null; // saves db queries
  66         var $price_factor;       // ditto for price calculations
  67
  68         var     $pos;                   // user assigned POS
  69         var $cash;                      // cash transaction - helper variable not stored in db
  70         var $cash_account;
  71         var $account_name;
  72         var $cash_discount;     // not used as of FA 2.1
  73         var $dimension_id;
  74         var $dimension2_id;
  75         var $payment;
  76         var $payment_terms; // cached payment terms
  77         //-------------------------------------------------------------------------
  78         //
  79         //  $trans_no==0 => open new/direct document
  80         //  $trans_no!=0 && $view==false => read for view
  81         //  $trans_no!=0 && $view==true => read for edit (qty update from parent doc)
  82         //
  83         function Cart($type, $trans_no=0, $view=false ) {
  84                 /*Constructor function initialises a new shopping cart */
  85                 $this->line_items = array();
  86                 $this->sales_type = "";
  87                 if ($type == ST_SALESQUOTE)
  88                         $this->trans_type = $type;
  89                 else
  90                         $this->trans_type = ST_SALESORDER;
  91                 $this->dimension_id = 0;
  92                 $this->dimension2_id = 0;
  93                 $this->read($type, $trans_no, $view );
  94                 $this->cart_id = uniqid('');
  95         }
  96
  97         //-------------------------------------------------------------------------
  98         // Reading document into cart
  99         //
 100         function read($type, $trans_no = 0, $view=false ) {
 101
 102                 global $SysPrefs, $Refs;
 103
 104                 if (!is_array($trans_no)) $trans_no = array($trans_no);
 105                 if ($trans_no[0]) // read old transaction
 106                 {
 107                         if ($type == ST_SALESORDER || $type == ST_SALESQUOTE) { // sales order || sales quotation
 108                                 read_sales_order($trans_no[0], $this, $type);
 109                                 if ($view) {    // prepare for DN/IV entry
 110                                         for($line_no = 0; $line_no < count($this->line_items); $line_no++) {
 111                                                 $line = &$this->line_items[$line_no];
 112                                                 $line->src_id = $line->id; // save src line ids for update
 113                                                 $line->qty_dispatched = $line->quantity - $line->qty_done;
 114                                         }
 115                                 }
 116                         } else {        // other type of sales transaction
 117                                         read_sales_trans($type, $trans_no, $this);
 118                                         if ($this->order_no) { // free hand credit notes have no order_no
 119                                                 $sodata = get_sales_order_header($this->order_no, ST_SALESORDER);
 120                                                 $this->cust_ref = $sodata["customer_ref"];
 121                                         // currently currency is hard linked to debtor account
 122                                         //      $this->customer_currency = $sodata["curr_code"];
 123                                                 $this->delivery_to = $sodata["deliver_to"];
 124                                                 $this->delivery_address = $sodata["delivery_address"];
 125                                         }
 126                                         // old derivative transaction edit
 127                                         if (!$view && ($type!=ST_CUSTCREDIT || $this->trans_link!=0)) {
 128                                                 $src_type = get_parent_type($type);
 129                                                 if ($src_type == ST_SALESORDER) { // get src data from sales_orders
 130                                                         $this->src_docs = array( $sodata['order_no']=>$sodata['version']);
 131                                                         $srcdetails = get_sales_order_details($this->order_no, ST_SALESORDER);
 132                                                 } else {        // get src_data from debtor_trans
 133                                                         $this->src_docs = get_customer_trans_version($src_type, get_parent_trans($type,$trans_no[0]));
 134                                                         $srcdetails = get_customer_trans_details($src_type,array_keys($this->src_docs));
 135                                                 }
 136                                                 // calculate & save: qtys on other docs and free qtys on src doc
 137                                                 for($line_no = 0; $srcline = db_fetch($srcdetails); $line_no++) {
 138                                                         $sign = 1; // $type==13 ?  1 : -1; // this is strange debtor_trans atavism
 139                                                         $line = &$this->line_items[$line_no];
 140
 141                                                         $line->src_id = $srcline['id']; // save src line ids for update
 142                                                         $line->qty_old = $line->qty_dispatched = $line->quantity;
 143                                                         $line->quantity += $sign * ($srcline['quantity'] - $srcline['qty_done']); // add free qty on src doc
 144                                                 }
 145                                         } else { // prepare qtys for derivative document entry (not used in display)
 146                                                 for($line_no = 0; $line_no < count($this->line_items); $line_no++) {
 147                                                         $line = &$this->line_items[$line_no];
 148                                                         $line->src_id = $line->id; // save src line ids for update
 149                                                         $line->qty_dispatched = $line->quantity - $line->qty_done;
 150                                                 }
 151                                         }
 152                                 }
 153                 } else { // new document
 154                                 $this->trans_type = $type;
 155                                 $this->trans_no = 0;
 156                                 $this->customer_currency = get_company_currency();
 157                                 // set new sales document defaults here
 158                                 if (get_global_customer() != ALL_TEXT)
 159                                   $this->customer_id = get_global_customer();
 160                                 else
 161                                   $this->customer_id = '';
 162                                 $this->document_date =  new_doc_date();
 163                                 if (!is_date_in_fiscalyear($this->document_date))
 164                                         $this->document_date = end_fiscalyear();
 165                                 $this->reference = $Refs->get_next($this->trans_type);
 166                                 if ($type != ST_SALESORDER && $type != ST_SALESQUOTE) // Added 2.1 Joe Hunt 2008-11-12
 167                                 {
 168                                         $dim = get_company_pref('use_dimension');
 169                                         if ($dim > 0)
 170                                         {
 171                                                 if ($this->customer_id == '')
 172                                                         $this->dimension_id = 0;
 173                                                 else
 174                                                 {
 175                                                         $cust = get_customer($this->customer_id);
 176                                                         $this->dimension_id = $cust['dimension_id'];
 177                                                 }
 178                                                 if ($dim > 1)
 179                                                 {
 180                                                         if ($this->customer_id == '')
 181                                                                 $this->dimension2_id = 0;
 182                                                         else
 183                                                                 $this->dimension2_id = $cust['dimension2_id'];
 184                                                 }
 185                                         }
 186                                 }
 187                                 if ($type == ST_SALESINVOICE) {
 188                                         $this->due_date =
 189                                                 get_invoice_duedate($this->payment, $this->document_date);
 190                                         $this->cash = $this->payment_terms['cash_sale'];
 191                                         if ($this->cash) {
 192                                                 $this->Location = $pos['pos_location'];
 193                                                 $this->location_name = $pos['location_name'];
 194                                                 $this->cash_account = $pos['pos_account'];
 195                                                 $this->account_name = $pos['bank_account_name'];
 196                                         }
 197                                 } else
 198                                         $this->due_date =
 199                                                 add_days($this->document_date, $SysPrefs->default_delivery_required_by());
 200                         }
 201                 $this->pos = user_pos();
 202                 $pos = get_sales_point($this->pos);
 203                 if (!$pos['cash_sale'] && !$pos['credit_sale'])
 204                         $this->pos = -1; // mark not editable payment type
 205         }
 206
 207         //-------------------------------------------------------------------------
 208         // Writing new/modified sales document to database.
 209         // Makes parent documents for direct delivery/invoice by recurent call.
 210         // $policy - 0 or 1:  writeoff/return for IV, back order/cancel for DN
 211         function write($policy=0) {
 212                 begin_transaction(); // prevents partial database changes in case of direct delivery/invoice
 213                 if (count($this->src_docs) == 0 && ($this->trans_type == ST_SALESINVOICE || $this->trans_type == ST_CUSTDELIVERY)) {
 214                         // this is direct document - first add parent
 215                         $src = (PHP_VERSION<5) ? $this : clone( $this ); // make local copy of this cart
 216                         $src->trans_type = get_parent_type($src->trans_type);
 217                         $src->reference = 'auto';
 218
 219                         $src->write(1);
 220                         $type = $this->trans_type;
 221                         $ref = $this->reference;
 222                         $date = $this->document_date;
 223                         // re-read document
 224                         $this->read($src->trans_type, key($src->trans_no), true);
 225                         $this->document_date = $date;
 226                         $this->reference = $ref;
 227                         $this->trans_type = $type;
 228                         $this->src_docs= $this->trans_no;
 229                         $this->trans_no = 0;
 230                         $this->order_no= $this->trans_type==ST_CUSTDELIVERY ? key($src->trans_no) : $src->order_no;
 231                 }
 232                 $this->reference = @html_entity_decode($this->reference, ENT_QUOTES);
 233                 $this->Comments = @html_entity_decode($this->Comments, ENT_QUOTES);
 234                 foreach($this->line_items as $lineno => $line) {
 235                         $this->line_items[$lineno]->stock_id = @html_entity_decode($line->stock_id, ENT_QUOTES);
 236                         $this->line_items[$lineno]->item_description = @html_entity_decode($line->item_description, ENT_QUOTES);
 237                 }
 238                 switch($this->trans_type) {
 239                         case ST_SALESINVOICE:
 240                                 write_sales_invoice($this); break;
 241                         case ST_CUSTCREDIT:
 242                                 write_credit_note($this, $policy); break;
 243                         case ST_CUSTDELIVERY:
 244                                 write_sales_delivery($this, $policy); break;
 245                         case ST_SALESORDER:
 246                         case ST_SALESQUOTE:
 247                                 if ($this->trans_no==0) // new document
 248                                         add_sales_order($this);
 249                                 else
 250                                         update_sales_order($this);
 251                 }
 252
 253                 commit_transaction();
 254         }
 255
 256         function set_customer($customer_id, $customer_name, $currency, $discount, $payment, $cdiscount=0)
 257         {
 258                 $this->customer_name = $customer_name;
 259                 $this->customer_id = $customer_id;
 260                 $this->default_discount = $discount;
 261                 $this->customer_currency = $currency;
 262                 $this->payment = $payment;
 263                 $this->payment_terms = get_payment_terms($payment);
 264                 $this->cash = $this->payment_terms['cash_sale'];
 265                 $this->cash_discount = $cdiscount;
 266         }
 267
 268         function set_branch($branch_id, $tax_group_id, $tax_group_name, $phone='', $email='')
 269         {
 270                 $this->Branch = $branch_id;
 271                 $this->phone = $phone;
 272                 $this->email = $email;
 273                 $this->tax_group_id = $tax_group_id;
 274                 $this->tax_group_array = get_tax_group_items_as_array($tax_group_id);
 275         }
 276
 277         function set_sales_type($sales_type, $sales_name, $tax_included=0, $factor=0)
 278         {
 279             $this->sales_type = $sales_type;
 280             $this->sales_type_name = $sales_name;
 281             $this->tax_included = $tax_included;
 282             $this->price_factor = $factor;
 283         }
 284
 285         function set_location($id, $name)
 286         {
 287                 $this->Location = $id;
 288                 $this->location_name = $name;
 289         }
 290
 291         function set_delivery($shipper, $destination, $address, $freight_cost=null)
 292         {
 293                 $this->ship_via = $shipper;
 294                 $this->deliver_to = $destination;
 295                 $this->delivery_address = $address;
 296                 if (isset($freight_cost))
 297                         $this->freight_cost = $freight_cost;
 298         }
 299
 300         function add_to_cart($line_no, $stock_id, $qty, $price, $disc, $qty_done=0, $standard_cost=0, $description=null, $id=0, $src_no=0)
 301         {
 302                 $line = new line_details($stock_id, $qty, $price, $disc,
 303                         $qty_done,  $standard_cost, $description, $id, $src_no);
 304
 305                 if ($line->valid) {
 306                         $this->line_items[$line_no] = $line;
 307                         return 1;
 308                 } else
 309                         display_error(_("You have to enter valid stock code or nonempty description"));
 310                 return 0;
 311         }
 312
 313         function update_cart_item($line_no, $qty, $price, $disc, $description="")
 314         {
 315                 if ($description != "")
 316                         $this->line_items[$line_no]->item_description = $description;
 317                 $this->line_items[$line_no]->quantity = $qty;
 318                 $this->line_items[$line_no]->qty_dispatched = $qty;
 319                 $this->line_items[$line_no]->price = $price;
 320                 $this->line_items[$line_no]->discount_percent = $disc;
 321         }
 322
 323         function update_add_cart_item_qty($line_no, $qty)
 324         {
 325                 $this->line_items[$line_no]->quantity += $qty;
 326         }
 327
 328         function remove_from_cart($line_no)
 329         {
 330                 array_splice($this->line_items, $line_no, 1);
 331         }
 332
 333         function clear_items()
 334         {
 335                 unset($this->line_items);
 336                 $this->line_items = array();
 337                 $this->sales_type = "";
 338                 $this->trans_no = 0;
 339                 $this->customer_id = $this->order_no = 0;
 340         }
 341
 342         function count_items()
 343         {
 344                 $counter=0;
 345                 foreach ($this->line_items as $line) {
 346                         if ($line->quantity!=$line->qty_done) $counter++;
 347                 }
 348                 return $counter;
 349         }
 350
 351         function get_items_total()
 352         {
 353                 $total = 0;
 354
 355                 foreach ($this->line_items as $ln_itm) {
 356                         $price = $ln_itm->line_price();
 357                         $total += round($ln_itm->quantity * $price * (1 - $ln_itm->discount_percent),
 358                            user_price_dec());
 359                 }
 360                 return $total;
 361         }
 362
 363         function get_items_total_dispatch()
 364         {
 365                 $total = 0;
 366
 367                 foreach ($this->line_items as $ln_itm) {
 368                         $price = $ln_itm->line_price();
 369                         $total += round(($ln_itm->qty_dispatched * $price * (1 - $ln_itm->discount_percent)),
 370                            user_price_dec());
 371                 }
 372                 return $total;
 373         }
 374
 375         function has_items_dispatch()
 376         {
 377                 foreach ($this->line_items as $ln_itm) {
 378                         if ($ln_itm->qty_dispatched > 0)
 379                                 return true;
 380                 }
 381                 return false;
 382         }
 383
 384         function any_already_delivered()
 385         {
 386                 /* Checks if there have been any line item processed */
 387
 388                 foreach ($this->line_items as $stock_item) {
 389                         if ($stock_item->qty_done !=0) {
 390                                 return 1;
 391                         }
 392                 }
 393
 394                 return 0;
 395
 396         }
 397
 398         function some_already_delivered($line_no)
 399         {
 400                 /* Checks if there have been deliveries of a specific line item */
 401                 if (isset($this->line_items[$line_no]) &&
 402                         $this->line_items[$line_no]->qty_done != 0) {
 403                         return 1;
 404                 }
 405                 return 0;
 406         }
 407
 408         function get_taxes($shipping_cost=null)
 409         {
 410                 $items = array();
 411                 $prices = array();
 412                 if($shipping_cost==null)
 413                         $shipping_cost = $this->freight_cost;
 414
 415                 foreach ($this->line_items as $ln_itm) {
 416                         $items[] = $ln_itm->stock_id;
 417                         $prices[] = round(($ln_itm->qty_dispatched *
 418                                 $ln_itm->line_price()* (1 - $ln_itm->discount_percent)),  user_price_dec());
 419                 }
 420
 421                 $taxes = get_tax_for_items($items, $prices, $shipping_cost,
 422                   $this->tax_group_id, $this->tax_included,  $this->tax_group_array);
 423
 424     // Adjustment for swiss franken, we always have 5 rappen = 1/20 franken
 425     if ($this->customer_currency == 'CHF') {
 426                         $val = $taxes['1']['Value'];
 427       $val1 = (floatval((intval(round(($val*20),0)))/20));
 428                         $taxes['1']['Value'] = $val1;
 429                 }
 430                 return $taxes;
 431         }
 432
 433
 434         function get_tax_free_shipping()
 435         {
 436
 437                 if ($this->tax_included==0)
 438                         return $this->freight_cost;
 439                 else
 440                         return ($this->freight_cost - $this->get_shipping_tax());
 441         }
 442
 443         function get_shipping_tax()
 444         {
 445
 446                 $tax_items = get_shipping_tax_as_array();
 447                 $tax_rate = 0;
 448                 if ($tax_items != null) {
 449                         foreach ($tax_items as $item_tax) {
 450                                 $index = $item_tax['tax_type_id'];
 451                                 if (isset($this->tax_group_array[$index])) {
 452                                         $tax_rate += $item_tax['rate'];
 453                                 }
 454                         }
 455                 }
 456                 if($this->tax_included)
 457                         return round($this->freight_cost*$tax_rate/($tax_rate+100),  user_price_dec());
 458                 else
 459                         return round($this->freight_cost*$tax_rate/100,  user_price_dec());
 460         }
 461
 462 } /* end of class defintion */
 463
 464 class line_details
 465 {
 466         var $id;
 467         var $stock_id;
 468         var $item_description;
 469         var $units;
 470         var $mb_flag;
 471         var $tax_type;
 472         var $tax_type_name;
 473         var $src_no;    // number of src doc for this line
 474         var $src_id;
 475         var $quantity;
 476         var $price;
 477         var $discount_percent;
 478         var $qty_done;  // quantity processed on child documents
 479         var $qty_dispatched; // quantity selected to process
 480         var $qty_old=0; // quantity dispatched before edition
 481         var $standard_cost;
 482         var $descr_editable;
 483
 484         var $valid; // validation in constructor
 485
 486         function line_details ($stock_id, $qty, $prc, $disc_percent,
 487                 $qty_done, $standard_cost, $description, $id=0, $src_no=0 )
 488         {
 489         /* Constructor function to add a new LineDetail object with passed params */
 490
 491                 $this->id = $id;
 492                 $this->src_no = $src_no;
 493                 $item_row = get_item($stock_id);
 494
 495                 if (!$item_row)
 496                         return;
 497
 498                 $this->mb_flag = $item_row["mb_flag"];
 499                 $this->units = $item_row["units"];
 500                 $this->descr_editable = $item_row["editable"];
 501                 if ($description == null || !$this->descr_editable)
 502                         $this->item_description = $item_row["description"];
 503                 else
 504                         $this->item_description = $description;
 505                 //$this->standard_cost = $item_row["material_cost"] + $item_row["labour_cost"] + $item_row["overhead_cost"];
 506                 $this->tax_type = $item_row["tax_type_id"];
 507                 $this->tax_type_name = $item_row["tax_type_name"];
 508                 $this->stock_id = $stock_id;
 509                 $this->quantity = $qty;
 510                 $this->qty_dispatched = $qty;
 511                 $this->price = $prc;
 512                 $this->discount_percent = $disc_percent;
 513                 $this->qty_done = $qty_done;
 514                 $this->standard_cost = $standard_cost;
 515                 $this->valid = true;
 516         }
 517
 518         // get unit price as stated on document
 519         function line_price()
 520         {
 521                 return $this->price;
 522         }
 523 }
 524
 525 ?>