From: Janusz Dobrowolski <janusz@frontaccounting.eu>
Date: Fri, 10 Jul 2009 13:00:29 +0000 (+0000)
Subject: Changed allocation cart API - included items read/write.
X-Git-Tag: v2.4.2~19^2~1334
X-Git-Url: https://delta.frontaccounting.com/gitweb/?a=commitdiff_plain;h=dca46563d3e8b7546e7095b7d96b40d9838c4c75;p=fa-stable.git

Changed allocation cart API - included items read/write.
---

diff --git a/includes/ui/allocation_cart.inc b/includes/ui/allocation_cart.inc
index 864d117f..6945a4b7 100644
--- a/includes/ui/allocation_cart.inc
+++ b/includes/ui/allocation_cart.inc
@@ -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,23 +20,20 @@ class allocation
 
 	var $trans_no; 
 	var $type;
-	var $person_id;
-	var $person_name;
+	var $person_id = '';
+	var $person_name = '';
 	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, 
@@ -80,9 +79,137 @@ class allocation
 			}  
 		}
         return $this->add_item($type, $type_no, $date_, $due_date, 
-        	$amount, $amount_allocated, $current_allocated);				
+        	$amount, $amount_allocated, $current_allocated);
 	}						
 
+	//
+	//	Read payment or credit current/available allocations to cart.
+	//
+	function read($type = null, $trans_no = 0) 
+	{
+		if ($type == null) {	// re-read
+			$type = $this->type;
+			$trans_no = $this->trans_no;
+		}
+		
+		$sup = $type == 21 || $type == 22;
+		$this->allocs = array();
+
+		if ($trans_no) {
+			$trans = $sup ? get_supp_trans($trans_no, $type) 
+				: get_customer_trans($trans_no, $type);
+
+			$this->person_id = $trans[$sup ? 'supplier_id':'debtor_no'];
+			$this->person_name = $trans[$sup ? "supplier_name":"DebtorName"];
+			$this->amount = $trans["Total"];
+			$this->date_ = sql2date($trans["tran_date"]);
+		} 
+		else {
+			$this->person_id = get_post($sup ? 'supplier_id':'customer_id');
+			$this->date_ = get_post($sup ? '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 ($sup)
+			$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); // 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($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"]);
+		}
+	}
+	//
+	//	Update allocations in database.
+	//
+	function write()
+	{
+		$sup = $this->type == 21 || $this->type == 22;
+
+		begin_transaction();
+
+		if ($sup)
+			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 ($sup) {
+					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,
+					$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($this->type, $this->trans_no, 
+				$total_allocated);
+		else
+		 	update_debtor_trans_allocation($this->type,	$this->trans_no, 
+				$total_allocated);
+	
+		commit_transaction();
+
+	}
+
 } 
 
 //-----------------------------------------------------------------------------------
@@ -118,64 +245,6 @@ 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) {
 
@@ -278,61 +347,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();
-
-}
 ?>
diff --git a/purchasing/allocations/supplier_allocate.php b/purchasing/allocations/supplier_allocate.php
index 6b9b94b6..2a19c464 100644
--- a/purchasing/allocations/supplier_allocate.php
+++ b/purchasing/allocations/supplier_allocate.php
@@ -80,7 +80,7 @@ if (isset($_POST['Process']))
 {
 	if (check_allocations())
 	{
-		handle_allocate();
+		$_SESSION['alloc']->write();
 		clear_allocations();
 		$_POST['Cancel'] = 1;
 	}
@@ -98,15 +98,12 @@ if (isset($_POST['Cancel']))
 
 if (isset($_GET['trans_no']) && isset($_GET['trans_type']))
 {
-	clear_allocations();
-	get_allocations_for_transaction($_GET['trans_type'], $_GET['trans_no']);
+	$_SESSION['alloc'] = new allocation($_GET['trans_type'], $_GET['trans_no']);
 }
-if(get_post('UpdateDisplay'))
+
+if (get_post('UpdateDisplay'))
 {
-	$trans_no = $_SESSION['alloc']->trans_no;
-	$type = $_SESSION['alloc']->type;
-	clear_allocations();
-	get_allocations_for_transaction($type, $trans_no);
+	$_SESSION['alloc']->read();
 	$Ajax->activate('alloc_tbl');
 }
 
diff --git a/purchasing/supplier_payment.php b/purchasing/supplier_payment.php
index 93cda07e..4843e2b6 100644
--- a/purchasing/supplier_payment.php
+++ b/purchasing/supplier_payment.php
@@ -67,7 +67,7 @@ if (isset($_POST['_DatePaid_changed'])) {
 }
 
 if (list_updated('supplier_id') || list_updated('bank_account')) {
-  get_allocations_for_transaction(22, 0);
+  $_SESSION['alloc']->read();
   $Ajax->activate('alloc_tbl');
 }
 //----------------------------------------------------------------------------------------
@@ -183,7 +183,7 @@ function handle_add_payment()
 	new_doc_date($_POST['DatePaid']);
 
 	$_SESSION['alloc']->trans_no = $payment_id;
-	handle_allocate();
+	$_SESSION['alloc']->write();
 	//unset($_POST['supplier_id']);
    	unset($_POST['bank_account']);
    	unset($_POST['DatePaid']);
@@ -223,7 +223,7 @@ start_form();
     supplier_list_row(_("Payment To:"), 'supplier_id', null, false, true);
 
 	if (!isset($_POST['bank_account'])) // first page call
-		  get_allocations_for_transaction(22, 0);
+		  $_SESSION['alloc'] = new allocation(22, 0);
 
 	set_global_supplier($_POST['supplier_id']);
 	
diff --git a/sales/allocations/customer_allocate.php b/sales/allocations/customer_allocate.php
index 6132c4f5..14f87fb8 100644
--- a/sales/allocations/customer_allocate.php
+++ b/sales/allocations/customer_allocate.php
@@ -46,7 +46,7 @@ if (isset($_POST['Process']))
 {
 	if (check_allocations())
 	{
-		handle_allocate();
+		$_SESSION['alloc']->write();
 		clear_allocations();
 		$_POST['Cancel'] = 1;
 	}
@@ -97,7 +97,7 @@ function edit_allocations_for_transaction($type, $trans_no)
 if (isset($_GET['trans_no']) && isset($_GET['trans_type']))
 {
 	clear_allocations();
-	get_allocations_for_transaction($_GET['trans_type'], $_GET['trans_no']);
+	$_SESSION['alloc'] = new allocation($_GET['trans_type'], $_GET['trans_no']);
 }
 if(get_post('UpdateDisplay'))
 {
diff --git a/sales/customer_payments.php b/sales/customer_payments.php
index 5c7b55ba..27c29cce 100644
--- a/sales/customer_payments.php
+++ b/sales/customer_payments.php
@@ -157,7 +157,7 @@ if (isset($_POST['_DateBanked_changed'])) {
   $Ajax->activate('_ex_rate');
 }
 if (list_updated('customer_id') || list_updated('bank_account')) {
-  get_allocations_for_transaction(12, 0);
+  $_SESSION['alloc']->read();
   $Ajax->activate('alloc_tbl');
 }
 //----------------------------------------------------------------------------------------------
@@ -179,7 +179,7 @@ if (isset($_POST['AddPaymentItem'])) {
 		input_num('amount'), input_num('discount'), $_POST['memo_'], $rate, input_num('charge'));
 
 	$_SESSION['alloc']->trans_no = $payment_no;
-	handle_allocate();
+	$_SESSION['alloc']->write();
 
 	meta_forward($_SERVER['PHP_SELF'], "AddedID=$payment_no");
 }
@@ -212,7 +212,8 @@ start_form();
 
 	customer_list_row(_("From Customer:"), 'customer_id', null, false, true);
 	if (!isset($_POST['bank_account'])) // first page call
-		  get_allocations_for_transaction(12, 0);
+		  $_SESSION['alloc'] = new allocation(12,0);
+
 	if (db_customer_has_branches($_POST['customer_id'])) {
 		customer_branches_list_row(_("Branch:"), $_POST['customer_id'], 'BranchID', null, false, true, true);
 	} else {