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