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