Helpers for js confirmation dialog before data entry is abandoned.
[fa-stable.git] / includes / ui / allocation_cart.inc
index 864d117f12e32e7c2d27e51d2f071aa99a44d774..d408c80a6d0c52e4d7419974af23a749bf1ad089 100644 (file)
@@ -9,8 +9,10 @@
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  
     See the License here <http://www.gnu.org/licenses/gpl-3.0.html>.
 ***********************************************************************/
-/* definition of the Debtor Receipt/Credit note allocation class */
-
+/*
+       Class for supplier/customer payment/credit allocations edition
+       and related helpers.
+*/
 //-----------------------------------------------------------------------------------
 
 class allocation 
@@ -18,32 +20,30 @@ class allocation
 
        var $trans_no; 
        var $type;
-       var $person_id;
-       var $person_name;
+       var $person_id = '';
+       var $person_name = '';
+       var $person_type;       // true - supplier, otherwise customer
        var $date_;
-       var $amount; /*Total amount of the transaction in FX */
+       var $amount = 0; /*Total amount of the transaction in FX */
        
        var $allocs; /*array of transactions allocated to */    
 
-       function allocation($trans_no, $type, $person_id, $person_name, $amount, $date_)
+       function allocation($type, $trans_no)
        {
                $this->allocs = array();
                
                $this->trans_no = $trans_no;
                $this->type = $type;
-               $this->person_id = $person_id;
-               $this->person_name = $person_name;
-               $this->amount = $amount;
-               $this->date_ = $date_;
+               $this->read(); // read payment or credit
        }
 
        function add_item($type, $type_no, $date_, $due_date, $amount, $amount_allocated, 
-               $current_allocated)
+               $current_allocated, $ref)
        {
                if ($amount > 0)
                {
                        $this->allocs[count($this->allocs)] = new allocation_item($type, $type_no, 
-                               $date_, $due_date, $amount, $amount_allocated, $current_allocated);
+                               $date_, $due_date, $amount, $amount_allocated, $current_allocated, $ref);
                        return true;
                } 
                else 
@@ -53,12 +53,12 @@ class allocation
        }
        
        function update_item($index, $type, $type_no, $date_, $due_date, 
-               $amount, $amount_allocated, $current_allocated)
+               $amount, $amount_allocated, $current_allocated, $ref)
        {
                if ($amount > 0)
                {
                        $this->allocs[$index] = new allocation_item($type, $type_no, 
-                               $date_, $due_date, $amount, $amount_allocated, $current_allocated);
+                               $date_, $due_date, $amount, $amount_allocated, $current_allocated, $ref);
                        return true;
                } 
                else 
@@ -68,7 +68,7 @@ class allocation
        }       
        
        function add_or_update_item($type, $type_no, $date_, $due_date, 
-               $amount, $amount_allocated, $current_allocated)
+               $amount, $amount_allocated, $current_allocated, $ref)
        {
                for ($i = 0; $i < count($this->allocs); $i++) 
                {
@@ -76,12 +76,141 @@ class allocation
                        if (($item->type == $type) && ($item->type_no == $type_no)) 
                        {
                                return $this->update_item($i, $type, $type_no, $date_, $due_date, 
-                                       $amount, $amount_allocated, $current_allocated);
+                                       $amount, $amount_allocated, $current_allocated, $ref);
                        }  
                }
         return $this->add_item($type, $type_no, $date_, $due_date, 
-               $amount, $amount_allocated, $current_allocated);                                
-       }                                               
+               $amount, $amount_allocated, $current_allocated, $ref);
+       }
+
+       //
+       //      Read payment or credit current/available allocations to cart.
+       //
+       // FIXME - read all transactions below twice seems to be suboptimal
+       //
+       function read($type = null, $trans_no = 0) 
+       {
+               if ($type == null) {    // re-read
+                       $type = $this->type;
+                       $trans_no = $this->trans_no;
+               }
+               if ($type == ST_BANKPAYMENT || $type == ST_BANKDEPOSIT) {
+                       $bank_trans = db_fetch(get_bank_trans($type, $trans_no));
+                       $this->person_type = $bank_trans['person_type_id'] == PT_SUPPLIER;
+               } else
+                       $this->person_type = $type == ST_SUPPCREDIT || $type == ST_SUPPAYMENT;
+               $this->allocs = array();
+
+               if ($trans_no) {
+                       $trans = $this->person_type ? get_supp_trans($trans_no, $type) 
+                               : get_customer_trans($trans_no, $type);
+
+                       $this->person_id = $trans[$this->person_type ? 'supplier_id':'debtor_no'];
+                       $this->person_name = $trans[$this->person_type ? "supplier_name":"DebtorName"];
+                       $this->amount = $trans["Total"];
+                       $this->date_ = sql2date($trans["tran_date"]);
+               } 
+               else {
+                       $this->person_id = get_post($this->person_type ? 'supplier_id':'customer_id');
+                       $this->date_ = get_post($this->person_type ? 'DatePaid':'DateBanked', Today());
+               }
+
+       /* Now populate the array of possible (and previous actual) allocations 
+               for this customer/supplier. First get the transactions that have 
+               outstanding balances ie Total-alloc >0 */
+
+               if ($this->person_type)
+                       $trans_items = get_allocatable_to_supp_transactions($this->person_id);
+               else
+                       $trans_items = get_allocatable_to_cust_transactions($this->person_id);
+
+               while ($myrow = db_fetch($trans_items))
+               {
+                       $this->add_item($myrow["type"], $myrow["trans_no"],
+                               sql2date($myrow["tran_date"]),
+                               sql2date($myrow["due_date"]),
+                               $myrow["Total"], // trans total
+                               $myrow["alloc"], // trans total allocated
+                               0,
+                               $myrow["reference"]); // this allocation
+               }
+               if ($trans_no == 0) return; // this is new payment
+
+       /* Now get trans that might have previously been allocated to by this trans
+       NB existing entries where still some of the trans outstanding entered from
+       above logic will be overwritten with the prev alloc detail below */
+
+               if ($this->person_type)
+                       $trans_items = get_allocatable_to_supp_transactions($this->person_id, 
+                               $trans_no, $type);
+               else
+                       $trans_items = get_allocatable_to_cust_transactions($this->person_id, 
+                               $trans_no, $type);
+
+               while ($myrow = db_fetch($trans_items))
+               {
+                       $this->add_or_update_item ($myrow["type"], $myrow["trans_no"],
+                               sql2date($myrow["tran_date"]),
+                               sql2date($myrow["due_date"]),
+                               $myrow["Total"],
+                               $myrow["alloc"] - $myrow["amt"], $myrow["amt"], $myrow["reference"]);
+               }
+       }
+       //
+       //      Update allocations in database.
+       //
+       function write()
+       {
+               begin_transaction();
+
+               if ($this->person_type)
+                       clear_supp_alloctions($this->type, $this->trans_no, $this->date_);
+               else
+                       clear_cust_alloctions($this->type, $this->trans_no, $this->date_);
+
+               // now add the new allocations
+               $total_allocated = 0;
+               foreach ($this->allocs as $alloc_item)
+               {
+                       if ($alloc_item->current_allocated > 0)
+                       {
+                               if ($this->person_type) {
+                                       add_supp_allocation($alloc_item->current_allocated,
+                                               $this->type, $this->trans_no,
+                                       $alloc_item->type, $alloc_item->type_no, $this->date_);
+
+                                       update_supp_trans_allocation($alloc_item->type, 
+                                               $alloc_item->type_no, $alloc_item->current_allocated);
+                               } else {
+                                       add_cust_allocation($alloc_item->current_allocated,
+                                               $this->type, $this->trans_no,
+                                       $alloc_item->type, $alloc_item->type_no, $this->date_);
+                       
+                                       update_debtor_trans_allocation($alloc_item->type, 
+                                               $alloc_item->type_no, $alloc_item->current_allocated);
+                               }
+                               // Exchange Variations Joe Hunt 2008-09-20 ////////////////////
+                               exchange_variation($this->type, $this->trans_no,
+                                       $alloc_item->type, $alloc_item->type_no, $this->date_,
+                                       $alloc_item->current_allocated,
+                                       $this->person_type ? PT_SUPPLIER : PT_CUSTOMER);
+                               
+
+                               //////////////////////////////////////////////////////////////
+                               $total_allocated += $alloc_item->current_allocated;
+                       }
+
+               }  /*end of the loop through the array of allocations made */
+               if ($this->person_type)
+                       update_supp_trans_allocation($this->type, $this->trans_no, 
+                               $total_allocated);
+               else
+                       update_debtor_trans_allocation($this->type,     $this->trans_no, 
+                               $total_allocated);
+
+               commit_transaction();
+
+       }
 
 } 
 
@@ -98,16 +227,19 @@ class allocation_item
        
        var $amount_allocated;
        var $amount;
+       var $ref;
        
        var $current_allocated;
        
        function allocation_item ($type, $type_no, $date_, $due_date, $amount, 
-               $amount_allocated, $current_allocated)
+               $amount_allocated, $current_allocated, $ref)
        {
 
                $this->type = $type;
                $this->type_no = $type_no;
-               
+
+               $this->ref = $ref;
+
                $this->date_ = $date_;
                $this->due_date = $due_date;
                
@@ -118,83 +250,26 @@ class allocation_item
 }
 
 //--------------------------------------------------------------------------------
-function get_allocations_for_transaction($type, $trans_no)
-{
-       $sup = $type == 21 || $type == 22;
-
-       if ($trans_no) {
-               $trans = $sup ? get_supp_trans($trans_no, $type) 
-                       : get_customer_trans($trans_no, $type);
-
-               $_SESSION['alloc'] = new allocation($trans_no, $type,
-                       $trans[$sup ? 'supplier_id':'debtor_no'], 
-                       $trans[$sup ? "supplier_name":"DebtorName"],
-                       $trans["Total"], sql2date($trans["tran_date"]));
-       } else {
-               $_SESSION['alloc'] = new allocation($trans_no, $type,
-                       $_POST[$sup ? 'supplier_id':'customer_id'], '', 0, 
-                       $_POST[$sup ? 'DatePaid':'DateBanked'] );
-       }
-
-       /* Now populate the array of possible (and previous actual) allocations for this customer/supplier */
-       /*First get the transactions that have outstanding balances ie Total-alloc >0 */
-
-       if ($sup)
-               $trans_items = get_allocatable_to_supp_transactions($_SESSION['alloc']->person_id);
-       else
-               $trans_items = get_allocatable_to_cust_transactions($_SESSION['alloc']->person_id);
-
-       while ($myrow = db_fetch($trans_items))
-       {
-               $_SESSION['alloc']->add_item($myrow["type"], $myrow["trans_no"],
-                       sql2date($myrow["tran_date"]),
-                       sql2date($myrow["due_date"]),
-                       $myrow["Total"], // trans total
-                       $myrow["alloc"], // trans total allocated
-                       0); // this allocation
-       }
-
-       if ($trans_no == 0) return; // this is new payment
-
-       /* Now get trans that might have previously been allocated to by this trans
-       NB existing entries where still some of the trans outstanding entered from
-       above logic will be overwritten with the prev alloc detail below */
-
-       if ($sup)
-               $trans_items = get_allocatable_to_supp_transactions($_SESSION['alloc']->person_id, $trans_no, $type);
-       else
-               $trans_items = get_allocatable_to_cust_transactions($_SESSION['alloc']->person_id, $trans_no, $type);
-       
-       while ($myrow = db_fetch($trans_items))
-       {
-               $_SESSION['alloc']->add_or_update_item ($myrow["type"], $myrow["trans_no"],
-                       sql2date($myrow["tran_date"]),
-                       sql2date($myrow["due_date"]),
-                       $myrow["Total"],
-                       $myrow["alloc"] - $myrow["amt"], $myrow["amt"]);
-       }
-}
-
-//---------------------------------------------------------------------------------------------------
 
 function show_allocatable($show_totals) {
 
-       global $table_style;
+       global $systypes_array;
        
     $k = $counter = $total_allocated = 0;
 
        if (count($_SESSION['alloc']->allocs)) 
        {
-               start_table($table_style);
-               $th = array(_("Transaction Type"), _("#"), _("Date"), _("Due Date"), _("Amount"),
+               start_table(TABLESTYLE, "width=60%");
+               $th = array(_("Transaction Type"), _("#"), _("Ref"), _("Date"), _("Due Date"), _("Amount"),
                        _("Other Allocations"), _("This Allocation"), _("Left to Allocate"),'','');
                table_header($th);
 
                foreach ($_SESSION['alloc']->allocs as $alloc_item)
            {
                        alt_table_row_color($k);
-               label_cell(systypes::name($alloc_item->type));
+               label_cell($systypes_array[$alloc_item->type]);
                        label_cell(get_trans_view_str($alloc_item->type, $alloc_item->type_no));
+                       label_cell($alloc_item->ref);
                label_cell($alloc_item->date_, "align=right");
                label_cell($alloc_item->due_date, "align=right");
                amount_cell($alloc_item->amount);
@@ -204,7 +279,7 @@ function show_allocatable($show_totals) {
                amount_cells(null, "amount" . $counter, price_format('amount' . $counter));
 
                $un_allocated = round($alloc_item->amount - $alloc_item->amount_allocated, 6);
-               amount_cell($un_allocated);
+               amount_cell($un_allocated, false,'', 'maxval'.$counter);
                        label_cell("<a href='#' name=Alloc$counter onclick='allocate_all(this.name.substr(5));return true;'>"
                                 . _("All") . "</a>");
                        label_cell("<a href='#' name=DeAll$counter onclick='allocate_none(this.name.substr(5));return true;'>"
@@ -220,7 +295,9 @@ function show_allocatable($show_totals) {
                        "colspan=6 align=right", "align=right id='total_allocated'", 3);
                        $amount = $_SESSION['alloc']->amount;
 
-                       if ($_SESSION['alloc']->type == 21 || $_SESSION['alloc']->type == 22) 
+                       if ($_SESSION['alloc']->type == ST_SUPPCREDIT
+                               || $_SESSION['alloc']->type == ST_SUPPAYMENT
+                               ||  $_SESSION['alloc']->type == ST_BANKPAYMENT)
                                $amount = -$amount;
                        
                        if ($amount - $total_allocated < 0)
@@ -243,6 +320,8 @@ function show_allocatable($show_totals) {
 
 function check_allocations()
 {
+       global $SysPrefs;
+
        $total_allocated = 0;
 
        for ($counter = 0; $counter < $_POST["TotalNumberOfAllocs"]; $counter++)
@@ -256,9 +335,11 @@ function check_allocations()
 
                  /*Now check to see that the AllocAmt is no greater than the
                 amount left to be allocated against the transaction under review */
-                if (input_num('amount' . $counter) > get_post('un_allocated' . $counter))
+                if (input_num('amount' . $counter) > input_num('un_allocated' . $counter))
                 {
-                    //$_POST['amount' . $counter] = $_POST['un_allocated' . $counter];
+                       display_error(_("At least one transaction is overallocated."));
+                       set_focus('amount'.$counter);
+                       return false;
                 }
 
                 $_SESSION['alloc']->allocs[$counter]->current_allocated = input_num('amount' . $counter);
@@ -267,10 +348,12 @@ function check_allocations()
        }
 
        $amount = $_SESSION['alloc']->amount;
-       if ($_SESSION['alloc']->type == 21 || $_SESSION['alloc']->type == 22) 
+       
+
+       if (in_array($_SESSION['alloc']->type, array(ST_BANKPAYMENT, ST_SUPPCREDIT, ST_SUPPAYMENT)))
                $amount = -$amount;
 
-       if ($total_allocated - $amount  > sys_prefs::allocation_settled_allowance())
+       if ($total_allocated - ($amount + input_num('discount'))  > $SysPrefs->allocation_settled_allowance())
        {
                display_error(_("These allocations cannot be processed because the amount allocated is more than the total amount left to allocate."));
                return false;
@@ -278,61 +361,5 @@ function check_allocations()
 
        return true;
 }
-//-----------------------------------------------------------------------------------
-
-function handle_allocate()
-{
-       $sup = $_SESSION['alloc']->type == 21 || $_SESSION['alloc']->type == 22;
-
-       begin_transaction();
-
-       if ($sup)
-               clear_supp_alloctions($_SESSION['alloc']->type, $_SESSION['alloc']->trans_no, $_SESSION['alloc']->date_);
-       else
-               clear_cust_alloctions($_SESSION['alloc']->type, $_SESSION['alloc']->trans_no, $_SESSION['alloc']->date_);
-
-       // now add the new allocations
-       $total_allocated = 0;
-       foreach ($_SESSION['alloc']->allocs as $alloc_item)
-       {
-               if ($alloc_item->current_allocated > 0)
-               {
-                       if ($sup) {
-                               add_supp_allocation($alloc_item->current_allocated,
-                                       $_SESSION['alloc']->type, $_SESSION['alloc']->trans_no,
-                               $alloc_item->type, $alloc_item->type_no, $_SESSION['alloc']->date_);
-
-                               update_supp_trans_allocation($alloc_item->type, $alloc_item->type_no,
-                                       $alloc_item->current_allocated);
-                       } else {
-                               add_cust_allocation($alloc_item->current_allocated,
-                                       $_SESSION['alloc']->type, $_SESSION['alloc']->trans_no,
-                               $alloc_item->type, $alloc_item->type_no, $_SESSION['alloc']->date_);
-                       
-                               update_debtor_trans_allocation($alloc_item->type, $alloc_item->type_no,
-                                       $alloc_item->current_allocated);
-                       }
-                       // Exchange Variations Joe Hunt 2008-09-20 ////////////////////////////////////////
-
-                       exchange_variation($_SESSION['alloc']->type, $_SESSION['alloc']->trans_no,
-                               $alloc_item->type, $alloc_item->type_no, $_SESSION['alloc']->date_,
-                               $alloc_item->current_allocated,
-                               $sup ? payment_person_types::supplier() :payment_person_types::customer());
-                               
 
-                       ///////////////////////////////////////////////////////////////////////////
-                       $total_allocated += $alloc_item->current_allocated;
-               }
-
-       }  /*end of the loop through the array of allocations made */
-       if ($sup)
-               update_supp_trans_allocation($_SESSION['alloc']->type,
-                       $_SESSION['alloc']->trans_no, $total_allocated);
-       else
-               update_debtor_trans_allocation($_SESSION['alloc']->type,
-                       $_SESSION['alloc']->trans_no, $total_allocated);
-       
-       commit_transaction();
-
-}
 ?>