Cleanups and comments
authorJanusz Dobrowolski <janusz@frontaccounting.eu>
Sun, 13 Jun 2010 18:36:23 +0000 (18:36 +0000)
committerJanusz Dobrowolski <janusz@frontaccounting.eu>
Sun, 13 Jun 2010 18:36:23 +0000 (18:36 +0000)
sales/includes/cart_class.inc

index 3566d686ff14bdd4c2bb82ee91d9b686d9da9f66..53a21e97a316b7df8a2bdf8a26fc1907d68bd2b6 100644 (file)
@@ -77,10 +77,10 @@ class cart
        //-------------------------------------------------------------------------
        //
        //  $trans_no==0 => open new/direct document
-       //  $trans_no!=0 && $view==false => read for view
-       //  $trans_no!=0 && $view==true => read for edit (qty update from parent doc)
+       //  $trans_no!=0 && $no_edit==false => update with parent constarints for reedition
+       //  $trans_no!=0 && $no_edit==true => read only: for view, or later child doc entry
        //
-       function Cart($type, $trans_no=0, $view=false ) {
+       function Cart($type, $trans_no=0, $no_edit=false) {
                /*Constructor function initialises a new shopping cart */
                $this->line_items = array();
                $this->sales_type = "";
@@ -90,29 +90,84 @@ class cart
                        $this->trans_type = ST_SALESORDER;
                $this->dimension_id = 0;
                $this->dimension2_id = 0;
-               $this->read($type, $trans_no, $view );
+               $this->read($type, $trans_no, $no_edit);
                $this->cart_id = uniqid('');
        }
+       
+       //
+       //      Prepare cart to new child document entry, just after initial parent doc read.
+       //
+       function prepare_child()
+       {
+               global $Refs;
+
+               $type = get_child_type($this->trans_type);
+
+               $this->trans_type = $type;
+               $this->reference = $Refs->get_next($this->trans_type);
+               $this->document_date = new_doc_date();
+
+               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_min = 0;
+//                     $line->qty_max = $line->quantity - $line->qty_done;
+                       $line->qty_dispatched = $type == ST_CUSTCREDIT ? '0' : $line->quantity - $line->qty_done;
+                       $line->qty_old = 0;
+               }
+               unset($line);
+               
+               if ($type == ST_CUSTDELIVERY)
+                       $this->order_no = key($this->trans_no);
 
+               if ($type == ST_SALESINVOICE) {
+                       $this->due_date = get_invoice_duedate($this->payment, $this->document_date);
+               }
+
+               if ($type == ST_CUSTCREDIT)
+                   $this->src_date = $this->document_date;
+
+               $this->src_docs = $this->trans_no;
+               $this->trans_no = 0;
+       }
+
+       //
+       //      Prepares transaction for reedition updating with parent transaction data 
+       //
+       function set_parent_constraints($sodata, $src_no) {
+
+               $src_type = get_parent_type($this->trans_type);
+               if ($src_type == ST_SALESORDER || $src_type == 0) { // get src data from sales_orders
+                       $this->src_docs = array( $sodata['order_no']=>$sodata['version']);
+                       $srcdetails = get_sales_order_details($this->order_no, $this->trans_type);
+               } else {        // get src_data from debtor_trans
+                       $this->src_docs = get_customer_trans_version($src_type, 
+                                       get_parent_trans($this->trans_type, $src_no));
+                       $srcdetails = get_customer_trans_details($src_type, array_keys($this->src_docs));
+               }
+               // calculate & save: qtys on other docs and free qtys on src doc
+               for($line_no = 0; $srcline = db_fetch($srcdetails); $line_no++) {
+                       $line = &$this->line_items[$line_no];
+
+                       $line->src_id = $srcline['id']; // save src line ids for update
+                       if ($this->trans_type == ST_SALESINVOICE)
+                               $line->src_no = $srcline['debtor_trans_no'];
+                       $line->qty_old = $line->qty_dispatched = $line->quantity;
+                       $line->quantity += $srcline['quantity'] - $srcline['qty_done']; // add free qty on src doc
+               }
+       }
        //-------------------------------------------------------------------------
        // Reading document into cart
        //
-       function read($type, $trans_no = 0, $view=false ) {
+       function read($type, $trans_no = 0, $no_edit=false) {
 
                global $SysPrefs, $Refs;
 
                if (!is_array($trans_no)) $trans_no = array($trans_no);
-               if ($trans_no[0]) // read old transaction
-               {
+
+               if ($trans_no[0]) { // read old transaction
                        if ($type == ST_SALESORDER || $type == ST_SALESQUOTE) { // sales order || sales quotation
                                read_sales_order($trans_no[0], $this, $type);
-                               if ($view) {    // prepare for DN/IV entry
-                                       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 = $line->quantity - $line->qty_done;
-                                       }
-                               }
                        } else {        // other type of sales transaction
                                        read_sales_trans($type, $trans_no, $this);
                                        if ($this->order_no) { // free hand credit notes have no order_no
@@ -123,33 +178,10 @@ class cart
                                                $this->delivery_to = $sodata["deliver_to"];
                                                $this->delivery_address = $sodata["delivery_address"];
                                        }
-                                       // old derivative transaction edit
-                                       if (!$view && ($type!=ST_CUSTCREDIT || $this->trans_link!=0)) {
-                                               $src_type = get_parent_type($type);
-                                               if ($src_type == ST_SALESORDER) { // get src data from sales_orders
-                                                       $this->src_docs = array( $sodata['order_no']=>$sodata['version']);
-                                                       $srcdetails = get_sales_order_details($this->order_no, ST_SALESORDER);
-                                               } else {        // get src_data from debtor_trans
-                                                       $this->src_docs = get_customer_trans_version($src_type, get_parent_trans($type,$trans_no[0]));
-                                                       $srcdetails = get_customer_trans_details($src_type,array_keys($this->src_docs));
-                                               }
-                                               // calculate & save: qtys on other docs and free qtys on src doc
-                                               for($line_no = 0; $srcline = db_fetch($srcdetails); $line_no++) {
-                                                       $sign = 1; // $type==13 ?  1 : -1; // this is strange debtor_trans atavism
-                                                       $line = &$this->line_items[$line_no];
-
-                                                       $line->src_id = $srcline['id']; // save src line ids for update
-                                                       $line->qty_old = $line->qty_dispatched = $line->quantity;
-                                                       $line->quantity += $sign * ($srcline['quantity'] - $srcline['qty_done']); // add free qty on src doc
-                                               }
-                                       } else { // prepare qtys for derivative document entry (not used in display)
-                                               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 = $line->quantity - $line->qty_done;
-                                               }
-                                       }
-                               }
+                                       // child transaction reedition - update with parent info unless it is freehand
+                                       if (!$no_edit && !($type==ST_CUSTCREDIT && $this->trans_link==0))
+                                               $this->set_parent_constraints($sodata, $trans_no[0]);
+                       }
                } else { // new document
                                $this->trans_type = $type;
                                $this->trans_no = 0;
@@ -237,20 +269,22 @@ class cart
                }
                switch($this->trans_type) {
                        case ST_SALESINVOICE:
-                               write_sales_invoice($this); break;
+                               $ret = write_sales_invoice($this); break;
                        case ST_CUSTCREDIT:
-                               write_credit_note($this, $policy); break;
+                               $ret = write_credit_note($this, $policy); break;
                        case ST_CUSTDELIVERY:
-                               write_sales_delivery($this, $policy); break;
+                               $ret = write_sales_delivery($this, $policy); break;
                        case ST_SALESORDER:
                        case ST_SALESQUOTE:
                                if ($this->trans_no==0) // new document
-                                       add_sales_order($this);
+                                       $ret = add_sales_order($this);
                                else
-                                       update_sales_order($this);
+                                       $ret = update_sales_order($this);
                }
 
                commit_transaction();
+
+               return $ret;
        }
 
        function set_customer($customer_id, $customer_name, $currency, $discount, $payment, $cdiscount=0)
@@ -472,16 +506,39 @@ class line_details
        var $tax_type_name;
        var $src_no;    // number of src doc for this line
        var $src_id;
-       var $quantity;
        var $price;
        var $discount_percent;
-       var $qty_done;  // quantity processed on child documents
-       var $qty_dispatched; // quantity selected to process
-       var $qty_old=0; // quantity dispatched before edition
+       
        var $standard_cost;
        var $descr_editable;
 
        var $valid; // validation in constructor
+       /*
+               Line quantity properties in various cart create modes:
+               
+               view:
+               $quantity - quantity on current document
+               $qty_done - quantity processed on all child documents
+               $qty_dispatched - not used
+               $qty_old - not used
+
+               edit:
+               $quantity - free parent quantity including this doc (= max allowed quantity)
+               $qty_done - qty processed on child documents (= min allowed qty)
+               $qty_dispatched - quantity currently selected to process
+               $qty_old - quantity processed on this document before reedition 
+
+               new child entry (view parent followed by prepare_child() call):
+               $quantity - max allowed quantity (get from parent)
+               $qty_done - qty processed on other child documents
+               $qty_dispatched - quantity currently selected to process
+               $qty_old - 0; not used
+       */
+       var $quantity;
+       var $qty_done;
+       var $qty_dispatched;
+       var $qty_old = 0;
+
 
        function line_details ($stock_id, $qty, $prc, $disc_percent,
                $qty_done, $standard_cost, $description, $id=0, $src_no=0 )