Merged last changes from stable.
[fa-stable.git] / sales / includes / cart_class.inc
index 64a237f320aa824db88f3377e653e6615cbc7132..60491f564b3202acbc4ba095236198337462d906 100644 (file)
@@ -64,22 +64,31 @@ class cart
        var $tax_group_array = null; // saves db queries
        var $price_factor;       // ditto for price calculations
 
-       var     $pos;                   // user assigned POS (contains cash accont number/name)
+       var     $pos;                   // user assigned POS
+       var $cash_account;
+       var $account_name;
        var $cash_discount;     // not used as of FA 2.1
        var $dimension_id;
        var $dimension2_id;
        var $payment;
        var $payment_terms; // cached payment terms
        var $credit;
+       // prepayment mode:
+       var $prepaid;           // true for documents issued in prepayment mode
+       var $prep_amount;       // prepayment required for SO, invoiced amount for prepaiament invoice
+       var $sum_paid;          // sum of all allocated prepayments both to order and related invoices
+       var $alloc;             // sum of payments allocated to this document
+       var $prepayments = array(); // allocation records for this document
        var $ex_rate;
 
        //-------------------------------------------------------------------------
        //
        //  $trans_no==0 => open new/direct document
-       //  $trans_no!=0 && $prep_child==false => update with parent constarints for reedition
-       //  $trans_no!=0 && $prep_child==true => prepare for child doc entry
+       //  $trans_no!=0 && $prepare_child==false => update with parent constarints for reedition
+       //  $trans_no!=0 && $prepare_child==true => prepare for child doc entry
+       //      $prepare_child is set to ST_SALESINVOICE for prepayment invoices
        //
-       function Cart($type, $trans_no=0, $prep_child=false) {
+       function Cart($type, $trans_no=0, $prepare_child=false) {
                /*Constructor function initialises a new shopping cart */
                $this->line_items = array();
                $this->sales_type = "";
@@ -90,7 +99,7 @@ class cart
                $this->dimension_id = 0;
                $this->dimension2_id = 0;
                $this->pos = get_sales_point(user_pos());
-               $this->read($type, $trans_no, $prep_child);
+               $this->read($type, $trans_no, $prepare_child);
                $this->cart_id = uniqid('');
        }
 
@@ -118,11 +127,12 @@ class cart
        //
        //      Prepare cart to new child document entry, just after initial parent doc read.
        //
-       function prepare_child()
+       function prepare_child($type)
        {
                global $Refs;
 
-               $type = get_child_type($this->trans_type);
+               if ($type === true)
+                       $type = get_child_type($this->trans_type);
 
                $this->trans_type = $type;
                $this->reference = $Refs->get_next($this->trans_type);
@@ -134,7 +144,8 @@ class cart
                for($line_no = 0; $line_no < count($this->line_items); $line_no++) {
                        $line = &$this->line_items[$line_no];
                        $line->src_id = $line->id; // save src line ids for update
-                       $line->qty_dispatched = $type == ST_CUSTCREDIT ? '0' : $line->quantity - $line->qty_done;
+                       $line->qty_dispatched = $type == ST_CUSTCREDIT ? '0' : 
+                                (($this->prepaid && $type == ST_SALESINVOICE) ? $line->quantity : $line->quantity - $line->qty_done);
                        $line->qty_old = 0;
                }
                unset($line);
@@ -188,7 +199,7 @@ class cart
        //-------------------------------------------------------------------------
        // Reading document into cart
        //
-       function read($type, $trans_no=0, $prep_child=false) {
+       function read($type, $trans_no=0, $prepare_child=false) {
 
                global $SysPrefs, $Refs;
 
@@ -198,7 +209,8 @@ class cart
                        if ($type == ST_SALESORDER || $type == ST_SALESQUOTE) { // sales order || sales quotation
                                read_sales_order($trans_no[0], $this, $type);
                        } else {        // other type of sales transaction
-                                       read_sales_trans($type, $trans_no, $this); 
+                                       read_sales_trans($type, $trans_no, $this);
+                                       $this->prepayments = get_payments_for($trans_no[0], $type);
                                        if ($this->order_no) { // free hand credit notes have no order_no
                                                $sodata = get_sales_order_header($this->order_no, ST_SALESORDER);
                                                $this->cust_ref = $sodata["customer_ref"];
@@ -207,13 +219,13 @@ class cart
                                                $this->delivery_to = $sodata["deliver_to"];
                                                $this->delivery_address = $sodata["delivery_address"];
                                        // child transaction reedition - update with parent info unless it is freehand
-                                       if (!$prep_child) // this is read for view/reedition
+                                       if (!$this->is_prepaid() && !$prepare_child) // this is read for view/reedition
                                                $this->set_parent_constraints($sodata, $trans_no[0]);
                                        }
                        }
                        // convert document into child and prepare qtys for entry
-                       if ($prep_child)
-                               $this->prepare_child();
+                       if ($prepare_child)
+                               $this->prepare_child($prepare_child);
 
                } else { // new document
                                $this->trans_type = $type;
@@ -263,14 +275,15 @@ class cart
        // Writing new/modified sales document to database.
        // Makes parent documents for direct delivery/invoice by recurent call.
        // $policy - 0 or 1:  writeoff/return for IV, back order/cancel for DN
-       function write($policy=0) { 
+       function write($policy=0) {
+
                begin_transaction(); // prevents partial database changes in case of direct delivery/invoice
                if ($this->reference != 'auto' && $this->trans_no == 0 && !is_new_reference($this->reference, $this->trans_type))
                {
                        commit_transaction();
                        return -1;
-               }       
-               if (count($this->src_docs) == 0 && ($this->trans_type == ST_SALESINVOICE || $this->trans_type == ST_CUSTDELIVERY)) {
+               }
+               if (count($this->src_docs) == 0 && ($this->trans_type == ST_SALESINVOICE || $this->trans_type == ST_CUSTDELIVERY) && !$this->is_prepaid()) {
                        // this is direct document - first add parent
                        $ref = $this->reference;
                        $date = $this->document_date;
@@ -513,7 +526,7 @@ class cart
        function get_shipping_tax()
        {
 
-               $tax_items = get_shipping_tax_as_array();
+               $tax_items = get_shipping_tax_as_array($this->tax_group_id);
                $tax_rate = 0;
                if ($tax_items != null) {
                        foreach ($tax_items as $item_tax) {
@@ -544,6 +557,52 @@ class cart
 
                return $total;
        }
+
+       /*
+               Returns true for documents issued in prepayment cycle.
+       */
+       function is_prepaid()
+       {
+               return $this->prepaid; //floatcmp($this->prep_amount, 0) > 0;
+       }
+       /*
+               Order is ready for delivery in prepament mode.
+       */
+       function is_released()
+       {
+               return floatcmp($this->sum_paid, $this->prep_amount) >= 0;
+       }
+
+       /*
+               Check whether order has been already invoiced/send or not.
+       */
+       function is_started()
+       {
+               if ($this->trans_no==0)
+                       return false;
+               $order_no = array_keys($this->trans_no);
+
+               return  is_sales_order_started(reset($order_no));
+       }
+
+       /*
+               Check payment terms and prepayments selected for this invoice,
+               and updates     partial/final invoice value respectively.
+       */
+       function update_payments()
+       {
+               $remainder = prepaid_invoice_remainder($this->order_no);
+
+               // recalculate prepaid part from payments
+               if ($this->payment_terms['days_before_due'] < 0)
+               {       // this is partial invoice for selected prepayments made.
+                       $paid = 0;
+                       foreach($this->prepayments as $payment)
+                               $paid += $payment['amt'];
+                       $this->prep_amount = min($remainder, $paid);
+               } else  // this is final invoice
+                       $this->prep_amount = $remainder;
+       }
 } /* end of class defintion */
 
 class line_details