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
  59         var $ship_via;
  60         var $freight_cost = 0;
  61
  62         var $tax_group_id;
  63         var $tax_group_name;
  64         var $tax_group_array = null; // saves db queries
  65         var $price_factor;       // ditto for price calculations
  66
  67         var     $pos;                   // user assigned POS
  68         var $cash_account;
  69         var $account_name;
  70         var $cash_discount;     // not used as of FA 2.1
  71         var $dimension_id;
  72         var $dimension2_id;
  73         var $payment;
  74         var $payment_terms; // cached payment terms
  75         var $credit;
  76         // prepayment mode:
  77         var $prepaid;           // true for documents issued in prepayment mode
  78         var $prep_amount;       // prepayment required for SO, invoiced amount for prepaiament invoice
  79         var $sum_paid;          // sum of all allocated prepayments both to order and related invoices
  80         var $alloc;             // sum of payments allocated to this document
  81         var $prepayments = array(); // allocation records for this document
  82         var $ex_rate;
  83
  84         //-------------------------------------------------------------------------
  85         //
  86         //  $trans_no==0 => open new/direct document
  87         //  $trans_no!=0 && $prepare_child==false => update with parent constarints for reedition
  88         //  $trans_no!=0 && $prepare_child==true => prepare for child doc entry
  89         //      $prepare_child is set to ST_SALESINVOICE for prepayment invoices
  90         //
  91         function Cart($type, $trans_no=0, $prepare_child=false) {
  92                 /*Constructor function initialises a new shopping cart */
  93                 $this->line_items = array();
  94                 $this->sales_type = "";
  95                 if ($type == ST_SALESQUOTE)
  96                         $this->trans_type = $type;
  97                 else
  98                         $this->trans_type = ST_SALESORDER;
  99                 $this->dimension_id = 0;
 100                 $this->dimension2_id = 0;
 101                 $this->pos = get_sales_point(user_pos());
 102                 $this->read($type, $trans_no, $prepare_child);
 103                 $this->cart_id = uniqid('');
 104         }
 105
 106         /*
 107                 Optional sorting items by stock_id.
 108         */
 109         function _cmp_lines($a, $b)
 110         {
 111                 return strcmp($a->stock_id, $b->stock_id);
 112         }
 113
 114         /*
 115                 Returns items array optionally sorted by item code.
 116         */
 117         function get_items()
 118         {
 119                 global $SysPrefs;
 120
 121                 $items = $this->line_items;
 122                 if (@$SysPrefs->sort_sales_items)
 123                         uasort($items, array($this, '_cmp_lines'));
 124
 125                 return $items;
 126         }
 127         //
 128         //      Prepare cart to new child document entry, just after initial parent doc read.
 129         //
 130         function prepare_child($type)
 131         {
 132                 global $Refs;
 133
 134                 if ($type === true)
 135                         $type = get_child_type($this->trans_type);
 136
 137                 $this->trans_type = $type;
 138                 $this->reference = $Refs->get_next($this->trans_type, null, array('date' => $this->document_date,
 139                         'customer' => $this->customer_id, 'branch' => $this->Branch));
 140                 if ($type == ST_CUSTCREDIT)
 141                     $this->src_date = $this->document_date;
 142
 143                 $this->document_date = new_doc_date();
 144
 145                 for($line_no = 0; $line_no < count($this->line_items); $line_no++) {
 146                         $line = &$this->line_items[$line_no];
 147                         $line->src_id = $line->id; // save src line ids for update
 148                         $line->qty_dispatched = $type == ST_CUSTCREDIT ? '0' :
 149                                  (($this->prepaid && $type == ST_SALESINVOICE) ? $line->quantity : $line->quantity - $line->qty_done);
 150                         $line->qty_old = 0;
 151                 }
 152                 unset($line);
 153
 154                 if ($type == ST_CUSTDELIVERY) {
 155                         $this->order_no = key($this->trans_no);
 156                         $cust = get_customer($this->customer_id);
 157                         $this->dimension_id = $cust['dimension_id'];
 158                         $this->dimension2_id = $cust['dimension2_id'];
 159                 }
 160                 if ($type == ST_SALESINVOICE) {
 161                         $this->due_date = get_invoice_duedate($this->payment, $this->document_date);
 162                 }
 163
 164                 $this->src_docs = $this->trans_no;
 165                 $this->trans_no = 0;
 166         }
 167
 168         //
 169         //      Prepares transaction for reedition updating with parent transaction data
 170         //
 171         function set_parent_constraints($sodata, $src_no) {
 172
 173                 $srcdetails = get_sales_parent_lines($this->trans_type, $src_no);
 174                 $src_type = get_parent_type($this->trans_type);
 175
 176                 // calculate & save: qtys on other docs and free qtys on src doc
 177                 $line_no = 0; $src_docs = array();
 178                 // Loop speed optimisation below depends on fact
 179                 // that child line_items contains subset of parent lines in _the_same_ order !
 180                 while (($line_no < count($this->line_items)) && ($srcline = db_fetch($srcdetails))) {
 181                         $line = &$this->line_items[$line_no];
 182                         $src_docs[] = $src_type == ST_SALESORDER ?  $srcline['order_no'] : $srcline['debtor_trans_no'];
 183                         while($srcline['id'] != $line->src_id) // Logic : This will increment the line_items array till sales_order line is matched.
 184                         {       // Fixes Delivery note bug : Parent constraints not working if sales order line deleted after delivery
 185                         $line_no++;
 186                         $line = &$this->line_items[$line_no];
 187                         }
 188                         if ($srcline['id'] == $line->src_id) {
 189                                 if ($this->trans_type == ST_SALESINVOICE)
 190                                         $line->src_no = $srcline['debtor_trans_no'];
 191                                 $line->qty_old = $line->qty_dispatched = $line->quantity;
 192                                 $line->quantity += $srcline['quantity'] -
 193                                         ($src_type==ST_SALESORDER ? $srcline['qty_sent'] : $srcline['qty_done']); // add free qty on src doc
 194                                 $line_no++;
 195                         }
 196                 }
 197
 198                 if ($src_type == ST_SALESORDER || $src_type == 0) {
 199                         $this->src_docs = array( $sodata['order_no']=>$sodata['version']);
 200                 } else {
 201                         // get src_data from debtor_trans
 202                         $this->src_docs = get_customer_trans_version($src_type, array_unique($src_docs));
 203                 }
 204         }
 205         //-------------------------------------------------------------------------
 206         // Reading document into cart
 207         //
 208         function read($type, $trans_no=0, $prepare_child=false) {
 209
 210                 global $SysPrefs, $Refs;
 211
 212                 if (!is_array($trans_no)) $trans_no = array($trans_no);
 213
 214                 if ($trans_no[0]) { // read old transaction
 215                         if ($type == ST_SALESORDER || $type == ST_SALESQUOTE) { // sales order || sales quotation
 216                                 read_sales_order($trans_no[0], $this, $type);
 217                         } else {        // other type of sales transaction
 218                                 read_sales_trans($type, $trans_no, $this);
 219                                 $this->prepayments = get_payments_for($trans_no[0], $type);
 220                                 if ($this->order_no) { // free hand credit notes have no order_no
 221                                         $sodata = get_sales_order_header($this->order_no, ST_SALESORDER);
 222                                         $this->cust_ref = $sodata["customer_ref"];
 223                                 // currently currency is hard linked to debtor account
 224                                         $this->delivery_to = $sodata["deliver_to"];
 225                                         $this->delivery_address = $sodata["delivery_address"];
 226                                 // child transaction reedition - update with parent info unless it is freehand
 227                                 if (!$this->is_prepaid() && !$prepare_child) // this is read for view/reedition
 228                                         $this->set_parent_constraints($sodata, $trans_no[0]);
 229                                 }
 230                         }
 231                         // convert document into child and prepare qtys for entry
 232                         if ($prepare_child)
 233                                 $this->prepare_child($prepare_child);
 234
 235                 } else { // new document
 236                         $this->trans_type = $type;
 237                         $this->trans_no = 0;
 238                         $this->customer_currency = get_company_currency();
 239                         // set new sales document defaults here
 240                         if (get_global_customer() != ALL_TEXT)
 241                           $this->customer_id = get_global_customer();
 242                         else
 243                           $this->customer_id = '';
 244                         $this->document_date = new_doc_date();
 245                         if (!is_date_in_fiscalyear($this->document_date))
 246                                 $this->document_date = end_fiscalyear();
 247                         $this->reference = $Refs->get_next($this->trans_type, null, array('date' => Today(),
 248                                 'customer' => $this->customer_id));
 249                         if ($type != ST_SALESORDER && $type != ST_SALESQUOTE) // Added 2.1 Joe Hunt 2008-11-12
 250                         {
 251                                 $dim = get_company_pref('use_dimension');
 252                                 if ($dim > 0)
 253                                 {
 254                                         if ($this->customer_id == '')
 255                                                 $this->dimension_id = 0;
 256                                         else
 257                                         {
 258                                                 $cust = get_customer($this->customer_id);
 259                                                 $this->dimension_id = $cust['dimension_id'];
 260                                         }
 261                                         if ($dim > 1)
 262                                         {
 263                                                 if ($this->customer_id == '')
 264                                                         $this->dimension2_id = 0;
 265                                                 else
 266                                                         $this->dimension2_id = $cust['dimension2_id'];
 267                                         }
 268                                 }
 269                         }
 270                         if ($type == ST_SALESINVOICE) {
 271                                 $this->due_date =
 272                                         get_invoice_duedate($this->payment, $this->document_date);
 273                         } else
 274                                 $this->due_date =
 275                                         add_days($this->document_date, $SysPrefs->default_delivery_required_by());
 276                 }
 277                 $this->credit = get_current_cust_credit($this->customer_id);
 278         }
 279
 280         //-------------------------------------------------------------------------
 281         // Writing new/modified sales document to database.
 282         // Makes parent documents for direct delivery/invoice by recurent call.
 283         // $policy - 0 or 1:  writeoff/return for IV, back order/cancel for DN
 284         function write($policy=0) {
 285
 286                 begin_transaction(); // prevents partial database changes in case of direct delivery/invoice
 287                 if ($this->reference != 'auto' && $this->trans_no == 0 && !is_new_reference($this->reference, $this->trans_type))
 288                 {
 289                         commit_transaction();
 290                         return -1;
 291                 }
 292                 if (count($this->src_docs) == 0 && ($this->trans_type == ST_SALESINVOICE || $this->trans_type == ST_CUSTDELIVERY) && !$this->is_prepaid()) {
 293                         // this is direct document - first add parent
 294                         $ref = $this->reference;
 295                         $date = $this->document_date;
 296                         $due_date = $this->due_date;
 297                         $dimension_id = $this->dimension_id;
 298                         $dimension2_id = $this->dimension2_id;
 299                         $this->trans_type = get_parent_type($this->trans_type);
 300
 301                         $this->reference = 'auto';
 302                         $trans_no = $this->write(1);
 303
 304                         // re-read parent document converting it to child
 305                         $this->read($this->trans_type, $trans_no, true);
 306                         $this->document_date = $date;
 307                         $this->reference = $ref;
 308                         $this->due_date = $due_date;
 309                         $this->dimension_id = $dimension_id;
 310                         $this->dimension2_id = $dimension2_id;
 311                 }
 312                 $this->reference = @html_entity_decode($this->reference, ENT_QUOTES);
 313                 $this->Comments = @html_entity_decode($this->Comments, ENT_QUOTES);
 314                 foreach($this->line_items as $lineno => $line) {
 315                         $this->line_items[$lineno]->stock_id = @html_entity_decode($line->stock_id, ENT_QUOTES);
 316                         $this->line_items[$lineno]->item_description = @html_entity_decode($line->item_description, ENT_QUOTES);
 317                 }
 318                 switch($this->trans_type) {
 319                         case ST_SALESINVOICE:
 320                                 $ret = write_sales_invoice($this); break;
 321                         case ST_CUSTCREDIT:
 322                                 $ret = write_credit_note($this, $policy); break;
 323                         case ST_CUSTDELIVERY:
 324                                 $ret = write_sales_delivery($this, $policy); break;
 325                         case ST_SALESORDER:
 326                         case ST_SALESQUOTE:
 327                                 if ($this->trans_no==0) // new document
 328                                         $ret = add_sales_order($this);
 329                                 else
 330                                         $ret = update_sales_order($this);
 331                 }
 332
 333                 commit_transaction();
 334
 335                 return $ret;
 336         }
 337
 338         function set_customer($customer_id, $customer_name, $currency, $discount, $payment, $cdiscount=0)
 339         {
 340                 $this->customer_name = $customer_name;
 341                 $this->customer_id = $customer_id;
 342                 $this->default_discount = $discount;
 343                 $this->customer_currency = $currency;
 344                 $this->payment = $payment;
 345                 $this->payment_terms = get_payment_terms($payment);
 346                 $this->cash_discount = $cdiscount;
 347
 348                 if ($this->payment_terms['cash_sale']) {
 349                         $this->Location = $this->pos['pos_location'];
 350                         $this->location_name = $this->pos['location_name'];
 351                 }
 352                 $this->credit = get_current_cust_credit($customer_id);
 353         }
 354
 355         function set_branch($branch_id, $tax_group_id, $tax_group_name, $phone='', $email='')
 356         {
 357                 $this->Branch = $branch_id;
 358                 $this->phone = $phone;
 359                 $this->email = $email;
 360                 $this->tax_group_id = $tax_group_id;
 361                 $this->tax_group_array = get_tax_group_items_as_array($tax_group_id);
 362         }
 363
 364         function set_sales_type($sales_type, $sales_name, $tax_included=0, $factor=0)
 365         {
 366             $this->sales_type = $sales_type;
 367             $this->sales_type_name = $sales_name;
 368             $this->tax_included = $tax_included;
 369             $this->price_factor = $factor;
 370         }
 371
 372         function set_location($id, $name)
 373         {
 374                 $this->Location = $id;
 375                 $this->location_name = $name;
 376         }
 377
 378         function set_delivery($shipper, $destination, $address, $freight_cost=null)
 379         {
 380                 $this->ship_via = $shipper;
 381                 $this->deliver_to = $destination;
 382                 $this->delivery_address = $address;
 383                 if (isset($freight_cost))
 384                         $this->freight_cost = $freight_cost;
 385         }
 386
 387         function add_to_cart($line_no, $stock_id, $qty, $price, $disc, $qty_done=0, $standard_cost=0, $description=null, $id=0, $src_no=0,
 388                 $src_id=0)
 389         {
 390                 $line = new line_details($stock_id, $qty, $price, $disc,
 391                         $qty_done,  $standard_cost, $description, $id, $src_no, $src_id);
 392
 393                 if ($line->valid) {
 394                         $this->line_items[$line_no] = $line;
 395                         return 1;
 396                 } else
 397                         display_error(_("You have to enter valid stock code or nonempty description"));
 398                 return 0;
 399         }
 400
 401         function update_cart_item($line_no, $qty, $price, $disc, $description="")
 402         {
 403                 if ($description != "")
 404                         $this->line_items[$line_no]->item_description = $description;
 405                 $this->line_items[$line_no]->quantity = $qty;
 406                 $this->line_items[$line_no]->qty_dispatched = $qty;
 407                 $this->line_items[$line_no]->price = $price;
 408                 $this->line_items[$line_no]->discount_percent = $disc;
 409         }
 410
 411         function update_add_cart_item_qty($line_no, $qty)
 412         {
 413                 $this->line_items[$line_no]->quantity += $qty;
 414         }
 415
 416         function remove_from_cart($line_no)
 417         {
 418                 array_splice($this->line_items, $line_no, 1);
 419         }
 420
 421         function clear_items()
 422         {
 423                 unset($this->line_items);
 424                 $this->line_items = array();
 425                 $this->sales_type = "";
 426                 $this->trans_no = 0;
 427                 $this->customer_id = $this->order_no = 0;
 428         }
 429
 430         function count_items()
 431         {
 432                 $counter=0;
 433                 foreach ($this->line_items as $line) {
 434                         if ($line->quantity!=$line->qty_done) $counter++;
 435                 }
 436                 return $counter;
 437         }
 438
 439         function get_items_total()
 440         {
 441                 $total = 0;
 442
 443                 foreach ($this->line_items as $ln_itm) {
 444                         $price = $ln_itm->line_price();
 445                         $total += round($ln_itm->quantity * $price * (1 - $ln_itm->discount_percent),
 446                            user_price_dec());
 447                 }
 448                 return $total;
 449         }
 450
 451         function get_items_total_dispatch()
 452         {
 453                 $total = 0;
 454
 455                 foreach ($this->line_items as $ln_itm) {
 456                         $price = $ln_itm->line_price();
 457                         $total += round(($ln_itm->qty_dispatched * $price * (1 - $ln_itm->discount_percent)),
 458                            user_price_dec());
 459                 }
 460                 return $total;
 461         }
 462
 463         function has_items_dispatch()
 464         {
 465                 foreach ($this->line_items as $ln_itm) {
 466                         if ($ln_itm->qty_dispatched > 0)
 467                                 return true;
 468                 }
 469                 return false;
 470         }
 471
 472         function any_already_delivered()
 473         {
 474                 /* Checks if there have been any line item processed */
 475
 476                 foreach ($this->line_items as $stock_item) {
 477                         if ($stock_item->qty_done !=0) {
 478                                 return 1;
 479                         }
 480                 }
 481
 482                 return 0;
 483
 484         }
 485
 486         function some_already_delivered($line_no)
 487         {
 488                 /* Checks if there have been deliveries of a specific line item */
 489                 if (isset($this->line_items[$line_no]) &&
 490                         $this->line_items[$line_no]->qty_done != 0) {
 491                         return 1;
 492                 }
 493                 return 0;
 494         }
 495
 496         function get_taxes($shipping_cost=null)
 497         {
 498                 $items = array();
 499                 $prices = array();
 500                 if($shipping_cost==null)
 501                         $shipping_cost = $this->freight_cost;
 502
 503                 foreach ($this->line_items as $ln_itm) {
 504                         $items[] = $ln_itm->stock_id;
 505                         $prices[] = round(((
 506                                 $this->trans_type==ST_SALESORDER ?      $ln_itm->quantity : $ln_itm->qty_dispatched) *
 507                                 $ln_itm->line_price()* (1 - $ln_itm->discount_percent)),  user_price_dec());
 508                 }
 509
 510                 $taxes = get_tax_for_items($items, $prices, $shipping_cost,
 511                         $this->tax_group_id, $this->tax_included,  $this->tax_group_array);
 512
 513     // Adjustment for swiss franken, we always have 5 rappen = 1/20 franken
 514     if ($this->customer_currency == 'CHF') {
 515                         $val = $taxes['1']['Value'];
 516                         $val1 = (floatval((intval(round(($val*20),0)))/20));
 517                         $taxes['1']['Value'] = $val1;
 518                 }
 519                 return $taxes;
 520         }
 521
 522
 523         function get_tax_free_shipping()
 524         {
 525
 526                 if ($this->tax_included==0)
 527                         return $this->freight_cost;
 528                 else
 529                         return ($this->freight_cost - $this->get_shipping_tax());
 530         }
 531
 532         function get_shipping_tax()
 533         {
 534
 535                 $tax_items = get_shipping_tax_as_array($this->tax_group_id);
 536                 $tax_rate = 0;
 537                 if ($tax_items != null) {
 538                         foreach ($tax_items as $item_tax) {
 539                                 $index = $item_tax['tax_type_id'];
 540                                 if (isset($this->tax_group_array[$index]['rate'])) {
 541                                         $tax_rate += $item_tax['rate'];
 542                                 }
 543                         }
 544                 }
 545                 if($this->tax_included)
 546                         return round($this->freight_cost*$tax_rate/($tax_rate+100),  user_price_dec());
 547                 else
 548                         return round($this->freight_cost*$tax_rate/100,  user_price_dec());
 549         }
 550         /*
 551                 Returns transaction value including all taxes
 552         */
 553         function get_trans_total() {
 554
 555                 $total = $this->get_items_total() + $this->freight_cost;
 556                 $dec = user_price_dec();
 557                 if (!$this->tax_included ) {
 558                         $total += $this->get_shipping_tax();
 559                         $taxes = $this->get_taxes();
 560                         foreach($taxes as $tax)
 561                                 $total += round($tax['Value'], $dec);
 562                 }
 563
 564                 return $total;
 565         }
 566
 567         /*
 568                 Checks cart quantities on document_date.
 569                 Returns array of stock_ids which stock quantities would go negative on some day.
 570         */
 571         function check_qoh($date=null, $location=null)
 572         {
 573                 $low_stock = array();
 574                 // check only for customer delivery and direct sales invoice
 575                 if (!($this->trans_type == ST_CUSTDELIVERY || ($this->trans_type == ST_SALESINVOICE && $this->trans_no==0)))
 576                         return $low_stock;
 577
 578                 // collect quantities by stock_id
 579                 $qtys = array();
 580                 foreach ($this->line_items as $line_no => $line_item)
 581                 {
 582                         if (has_stock_holding($line_item->mb_flag))
 583                         {
 584                                 if (!$this->trans_no) // new delivery
 585                                         $qtys[$line_item->stock_id]['qty'] = $line_item->qty_dispatched + @$qtys[$line_item->stock_id]['qty'];
 586                                 else    // DN modification: check change in quantity
 587                                         $qtys[$line_item->stock_id]['qty'] = ($line_item->qty_dispatched-$line_item->qty_old) + @$qtys[$line_item->stock_id]['qty'];
 588                                 $qtys[$line_item->stock_id]['line'] = $line_no;
 589                         }
 590                 }
 591
 592                 foreach($qtys as $stock_id => $sum)
 593                 {
 594                         if (check_negative_stock($stock_id, -$sum['qty'], $location ? $location : $this->Location, $date ? $date : $this->document_date))
 595                                 $low_stock[] = $stock_id;
 596                 }
 597
 598                 return $low_stock;
 599         }
 600
 601         /*
 602                 Returns true for documents issued in prepayment cycle.
 603         */
 604         function is_prepaid()
 605         {
 606                 return $this->prepaid;
 607         }
 608         /*
 609                 Order is ready for delivery in prepament mode.
 610         */
 611         function is_released()
 612         {
 613                 return floatcmp($this->sum_paid, $this->prep_amount) >= 0;
 614         }
 615
 616         /*
 617                 Check whether order has been already invoiced/send or not.
 618         */
 619         function is_started()
 620         {
 621                 if ($this->trans_no==0)
 622                         return false;
 623                 $order_no = array_keys($this->trans_no);
 624
 625                 return  is_sales_order_started(reset($order_no));
 626         }
 627
 628         /*
 629                 Check payment terms and prepayments selected for this invoice,
 630                 and updates     partial/final invoice value respectively.
 631         */
 632         function update_payments()
 633         {
 634                 $remainder = prepaid_invoice_remainder($this->order_no);
 635
 636                 // recalculate prepaid part from payments
 637                 if ($this->payment_terms['days_before_due'] < 0)
 638                 {       // this is partial invoice for selected prepayments made.
 639                         $paid = 0;
 640                         foreach($this->prepayments as $payment)
 641                                 $paid += $payment['amt'];
 642                         $this->prep_amount = min($remainder, $paid);
 643                 } else  // this is final invoice
 644                         $this->prep_amount = $remainder;
 645         }
 646 } /* end of class defintion */
 647
 648 class line_details
 649 {
 650         var $id;
 651         var $stock_id;
 652         var $item_description;
 653         var $units;
 654         var $mb_flag;
 655         var $tax_type;
 656         var $tax_type_name;
 657         var $src_no;    // number of src doc for this line
 658         var $src_id;
 659         var $price;
 660         var $discount_percent;
 661
 662         var $standard_cost;
 663         var $descr_editable;
 664
 665         var $valid; // validation in constructor
 666         /*
 667                 Line quantity properties in various cart create modes:
 668
 669                 view:
 670                 $quantity - quantity on current document
 671                 $qty_done - quantity processed on all child documents
 672                 $qty_dispatched - not used
 673                 $qty_old - not used
 674
 675                 edit:
 676                 $quantity - free parent quantity including this doc (= max allowed quantity)
 677                 $qty_done - qty processed on child documents (= min allowed qty)
 678                 $qty_dispatched - quantity currently selected to process
 679                 $qty_old - quantity processed on this document before reedition
 680
 681                 new child entry (view parent followed by prepare_child() call):
 682                 $quantity - max allowed quantity (get from parent)
 683                 $qty_done - qty processed on other child documents
 684                 $qty_dispatched - quantity currently selected to process
 685                 $qty_old - 0; not used
 686         */
 687         var $quantity;
 688         var $qty_done;
 689         var $qty_dispatched;
 690         var $qty_old = 0;
 691
 692
 693         function line_details ($stock_id, $qty, $prc, $disc_percent,
 694                 $qty_done, $standard_cost, $description, $id=0, $src_no=0, $src_id=0)
 695         {
 696         /* Constructor function to add a new LineDetail object with passed params */
 697
 698                 $this->id = $id;
 699                 $this->src_no = $src_no;
 700                 $this->src_id = $src_id;
 701                 $item_row = get_item($stock_id);
 702
 703                 if (!$item_row)
 704                         return;
 705
 706                 $this->mb_flag = $item_row["mb_flag"];
 707                 $this->units = $item_row["units"];
 708                 $this->descr_editable = $item_row["editable"];
 709                 if ($description == null || !$this->descr_editable)
 710                         $this->item_description = $item_row["description"];
 711                 else
 712                         $this->item_description = $description;
 713                 $this->tax_type = $item_row["tax_type_id"];
 714                 $this->tax_type_name = $item_row["tax_type_name"];
 715                 $this->stock_id = $stock_id;
 716                 $this->quantity = $qty;
 717                 $this->qty_dispatched = $qty;
 718                 $this->price = $prc;
 719                 $this->discount_percent = $disc_percent;
 720                 $this->qty_done = $qty_done;
 721                 $this->standard_cost = $standard_cost;
 722                 $this->valid = true;
 723         }
 724
 725         // get unit price as stated on document
 726         function line_price()
 727         {
 728                 return $this->price;
 729         }
 730 }
 731