From efaca2d66295fbdad5154c3a6e59fcf22c44af76 Mon Sep 17 00:00:00 2001
From: Steve Blamey <sblamey@uzerp.com>
Date: Wed, 19 Jul 2023 11:42:17 +0100
Subject: [PATCH] Update plapayments to use DummyPayment class with no payment
 file output

---
 assets/css/uzerp/screen.less                  | 17 ++++
 .../templates/elements/select_for_output.tpl  | 19 +++--
 .../controllers/PlpaymentsController.php      | 83 ++++++++++++++++---
 .../controllers/PltransactionsController.php  |  7 +-
 .../purchase_ledger/models/PLPayment.php      | 41 +++++++--
 .../models/PLTransactionCollection.php        |  6 +-
 .../purchase_ledger/reports/DummyPayment.php  | 49 +++++++++++
 .../templates/plpayments/index.tpl            |  8 +-
 .../templates/plpayments/view.tpl             | 13 ++-
 9 files changed, 210 insertions(+), 33 deletions(-)
 create mode 100644 modules/public_pages/erp/ledger/purchase_ledger/reports/DummyPayment.php

diff --git a/assets/css/uzerp/screen.less b/assets/css/uzerp/screen.less
index 941b960a..8c1c9591 100644
--- a/assets/css/uzerp/screen.less
+++ b/assets/css/uzerp/screen.less
@@ -1296,6 +1296,23 @@
 			font-size: 7px;
 		}
 	}
+
+	/* modules/common/templates/elements/select_for_output.tpl */
+	div[data-action=select_for_output] {
+		.form-actions {
+			display: flex;
+			column-gap: 10px;
+			align-items: center;
+
+			.select-all {
+				order: 2;
+			}
+
+			input[name=save] {
+				order: 3;
+			}
+		}
+	}
 	
 	/* we could use attribute selectors here, however we might not want to apply these styles everywhere */
 	
diff --git a/modules/common/templates/elements/select_for_output.tpl b/modules/common/templates/elements/select_for_output.tpl
index 52d6f0e6..5fe2cb94 100644
--- a/modules/common/templates/elements/select_for_output.tpl
+++ b/modules/common/templates/elements/select_for_output.tpl
@@ -108,14 +108,17 @@
 		{/data_table}
 		<input type="hidden" id="link" value="{$link}">
 		{paging}
-		Select count <input type='text' readonly id=selected_count name=selected_count value="{$count_selected}" class='numeric'>
-		{submit tags='none' name='save' value='Save Selection'}
-	{/form}
-	{form controller=$self.controller action='select_all' notags=true}
-		<input type='hidden' name='type' value={$type}>
-		<input type='hidden' name='id' value={$type_id}>
-		{submit tags='none' name='save' value='Select All'}
-	{/form}
+		<div class="form-actions">
+			<label for="selected_count">Select count</label> <input type='text' readonly id=selected_count name=selected_count value="{$count_selected}" class='numeric'>
+			{submit tags='none' name='save' value='Save Selection'}
+			</div>
+			{/form}
+			{form controller=$self.controller action='select_all' notags=true class='select-all'}
+				<input type='hidden' name='type' value={$type}>
+				<input type='hidden' name='id' value={$type_id}>
+				{submit tags='none' name='save' value='Select All'}
+			{/form}
+
 	<script type="text/javascript">
 		$(document).ready(function() {
 			legacyForceChange('#printtype');
diff --git a/modules/public_pages/erp/ledger/purchase_ledger/controllers/PlpaymentsController.php b/modules/public_pages/erp/ledger/purchase_ledger/controllers/PlpaymentsController.php
index 4cf28933..ed33c599 100755
--- a/modules/public_pages/erp/ledger/purchase_ledger/controllers/PlpaymentsController.php
+++ b/modules/public_pages/erp/ledger/purchase_ledger/controllers/PlpaymentsController.php
@@ -30,9 +30,9 @@ public function index($collection = null, $sh = '', &$c_query = null)
 // Set context from calling module
 
 		$this->setSearch('pltransactionsSearch', 'payments', $s_data);
-				
+	    $this->_templateobject->orderby = ['created'];
 		parent::index(new PLPaymentCollection($this->_templateobject));
-		
+
 		$sidebar = new SidebarController($this->view);
 		
 		$sidebarlist=array();
@@ -81,15 +81,17 @@ public function view()
 										 )
 				);
 			
-			$sidebarlist['process_payment'] = array(
-							'tag'=>'Process Payment',
-							'link'=>array('modules'				=> $this->_modules
-										 ,'controller'			=> $this->name
-										 ,'action'				=> 'printDialog'
-										 ,'printaction'			=> 'make_batch_payment'
-										 ,$plpayment->idField	=> $plpayment->{$plpayment->idField}
-										 )
-				);
+			if ($plpayment->getNoOutput() !== 't') {
+				$sidebarlist['process_payment'] = array(
+								'tag'=>'Process Payment',
+								'link'=>array('modules'				=> $this->_modules
+											,'controller'			=> $this->name
+											,'action'				=> 'printDialog'
+											,'printaction'			=> 'make_batch_payment'
+											,$plpayment->idField	=> $plpayment->{$plpayment->idField}
+											)
+					);
+			}
 		}
 		
 		if ($plpayment->isProcessed())
@@ -109,6 +111,9 @@ public function view()
 		$this->view->register('sidebar',$sidebar);
 		
 		$this->view->set('sidebar',$sidebar);
+
+		$r = $plpayment->getRemittanceOutputHeaders();
+		$this->view->set('outputs', $r);
 	}
 
 	public function process_override()
@@ -583,12 +588,48 @@ public function save_payments ()
 			{
 				$payclass = new $paytype->payment_class->class_name($this);
 				$payclass->validate($this->_data, $errors);
+				if (isset($payclass->no_output)) {
+					$payment->no_output = 't';
+				}
 			}
 			
 		}
 		
 		if (count($errors)==0 && $payment && $payment->savePLPayment($this->_data, $errors))
 		{
+			if (isset($payclass->no_output)) {
+				$paid_suppliers = array_keys($this->_data['PLTransaction']);
+				$supplier_has_remittance = new PLSupplierCollection();
+				$sh = new SearchHandler($supplier_has_remittance, false);
+				$cc = new ConstraintChain();
+				$cc->add(new Constraint('remittance_advice', 'IS', true));
+				if (count($paid_suppliers) > 1) {
+					$cc->add(new Constraint('id', 'in', '(' . implode(',', $paid_suppliers) . ')'));
+				} else {
+					$cc->add(new Constraint('id', '=', $paid_suppliers[0]));
+				}
+				$sh->addConstraintChain($cc);
+				$supplier_has_remittance->load($sh);
+
+				$payment->status = 'P';
+				$payment->save();
+				$flash->addMessage('Payment processed.');
+				
+				if (count($supplier_has_remittance) > 0) {
+					// Allow the user to output a remittance advice
+					// for suppliers that need it
+					sendTo(
+						'pltransactions',
+						'select_remittances',
+						$this->_modules,
+						array('id'=>$payment->id)
+					);
+				}
+			}
+
+			// Not outputting remittance advice at this point.
+			// Return to the payment list where the user can
+			// select 'Proccess' to continue to the next stage.
 			sendTo($this->name
 				,'index'
 				,$this->_modules);
@@ -611,8 +652,28 @@ public function save_payments ()
 			{
 				$params['payment_type_id']=$this->_data['payment_type_id'];
 			}
+
+			$callback = function($errors) {
+				if (count($errors > 0)) {
+					return false;
+				}
+			};
+			
+			// Kill off the progress bars
+			$progressNames = [
+				'checking_supplier_details',
+				'creating_pl_transactions',
+				'allocate_payments'
+			];
+			foreach($progressNames as $name) {
+				$progressbar = new Progressbar($name);
+				$progressbar->process([], $callback);
+			}
 		
 			$flash->addErrors($errors);
+			if (isset($payclass->no_output)) {
+				sendBack();
+			}
 			$this->refresh();
 		}
 	}
diff --git a/modules/public_pages/erp/ledger/purchase_ledger/controllers/PltransactionsController.php b/modules/public_pages/erp/ledger/purchase_ledger/controllers/PltransactionsController.php
index 9cfc4c97..90885dd8 100755
--- a/modules/public_pages/erp/ledger/purchase_ledger/controllers/PltransactionsController.php
+++ b/modules/public_pages/erp/ledger/purchase_ledger/controllers/PltransactionsController.php
@@ -38,7 +38,7 @@ public function __construct($module = null, $action = null)
 	
 	}
 
-	public function index()
+	public function index($collection = null, $sh = '', &$c_query = null)
 	{
 		$this->view->set('clickaction', 'view');
 		
@@ -152,7 +152,8 @@ public function select_remittances ()
 			{
 				$pltransactions = new PLTransactionCollection();
 				
-				$pltransactions->paidList($plpayment->id);
+				// Get payments for suppliers that require a remittance advice
+				$pltransactions->paidList($plpayment->id, true);
 				
 				foreach ($pltransactions as $pltransaction) {
 					$pltransaction->gross_value = bcmul($pltransaction->gross_value,-1);
@@ -185,7 +186,7 @@ public function select_remittances ()
 			{
 				if (isset($output_details['identifier']))
 				{
-					$new_selection[$detail->id]['description'] = prettify($output_details['identifier']).' : '.$detail->$output_details['identifier'];
+					$new_selection[$detail->id]['description'] = prettify($output_details['identifier']).' : '.$detail->{$output_details['identifier']};
 				}
 				else
 				{
diff --git a/modules/public_pages/erp/ledger/purchase_ledger/models/PLPayment.php b/modules/public_pages/erp/ledger/purchase_ledger/models/PLPayment.php
index 55a4e591..774218db 100755
--- a/modules/public_pages/erp/ledger/purchase_ledger/models/PLPayment.php
+++ b/modules/public_pages/erp/ledger/purchase_ledger/models/PLPayment.php
@@ -295,14 +295,24 @@ public function paymentClass()
 		return null;
 	}
 
-	public function outputPaymentFile()
+	/**
+	 * Get no_output value
+	 * 
+	 * no_output is not in the collection DB view.
+	 * Not likely needed elsewhere and I'm too lazy
+	 * to do a migration to add it in so that it
+	 * appears in collections :-)
+	 *
+	 * @return bool
+	 */
+	public function getNoOutput()
 	{
-		$iclass_name = $this->paymentClass();
-		$c = new $iclass_name($this);
-		if (isset($c->noFile)) {
-			return false;
+		if (!isset($this->no_output)) {
+			$plpayment = new PLPayment();
+			$plpayment->load($this->id);
+			return $plpayment->no_output;
 		}
-		return true;
+		return $this->no_output;
 	}
 	
 	public function isNewStatus()
@@ -314,6 +324,25 @@ public function isProcessed()
 	{
 		return ($this->status == 'P');
 	}
+
+	public function getRemittanceOutputHeaders()
+	{
+		// SQL to get the output header ids related to
+		// this PLPayment via the associated PLTransactions.
+		// Match the PLTransaction.ext_reference to the PLPayment.id
+		$SQL = "select distinct od.output_header_id, oh.created
+		from pltransactions as plt
+		join output_details od on od.select_id = plt.id
+		left join output_header as oh on oh.id = od.output_header_id
+		where plt.ext_reference = ? and oh.type = 'remittance'
+		order by oh.created";
+
+		$db = DB::Instance();
+		$query = $db->prepare($SQL);
+		$values = [$this->id];
+		$result = $db->execute($query, $values);
+		return $result;
+	}
 	
 }
 
diff --git a/modules/public_pages/erp/ledger/purchase_ledger/models/PLTransactionCollection.php b/modules/public_pages/erp/ledger/purchase_ledger/models/PLTransactionCollection.php
index 34e67ef2..327c1fc5 100755
--- a/modules/public_pages/erp/ledger/purchase_ledger/models/PLTransactionCollection.php
+++ b/modules/public_pages/erp/ledger/purchase_ledger/models/PLTransactionCollection.php
@@ -84,13 +84,17 @@ function summaryPayments()
 		$this->load($sh);		
 	}
 
-	function paidList($payment_id)
+	function paidList($payment_id, $requires_remittance_advice=false)
 	{
 		$sh = new SearchHandler($this, false);
 		
 		$sh->addConstraint(new Constraint('status', '=', 'P'));
 		$sh->addConstraint(new Constraint('transaction_type', '=', 'P'));
 		$sh->addConstraint(new Constraint('cross_ref', '=', $payment_id));
+
+		if ($requires_remittance_advice) {
+			$sh->addConstraint(new Constraint('remittance_advice', 'IS', true));
+		}
 		
 		$sh->setOrderby(array('supplier', 'ext_reference'));
 		
diff --git a/modules/public_pages/erp/ledger/purchase_ledger/reports/DummyPayment.php b/modules/public_pages/erp/ledger/purchase_ledger/reports/DummyPayment.php
new file mode 100644
index 00000000..1e0ff801
--- /dev/null
+++ b/modules/public_pages/erp/ledger/purchase_ledger/reports/DummyPayment.php
@@ -0,0 +1,49 @@
+<?php
+
+class DummyPayment
+{
+    public $testprint = FALSE;
+	public $no_output = true;
+
+
+	function setData() {
+		return;
+	}
+	
+	function constructPrint() {
+		return true;
+	}
+
+    function validate($data, &$errors)
+	{
+		
+		$return			= true;
+		
+		if (isset($data['PLTransaction'])) 
+		{
+			$progressbar = new Progressbar('checking_supplier_details');
+			
+			$callback = function($unused, $supplier_id) use (&$errors)
+			{
+				
+				$supplier = DataObjectFactory::Factory('PLSupplier');
+				$supplier->load($supplier_id);
+				
+				if (!$supplier->isLoaded())
+				{
+					$errors[] = 'Error checking supplier';
+					return false;
+				}
+
+				
+			};
+			
+			$return = $progressbar->process($data['PLTransaction'], $callback);
+			
+		}
+		
+		return $return;
+
+	}
+
+}
\ No newline at end of file
diff --git a/modules/public_pages/erp/ledger/purchase_ledger/templates/plpayments/index.tpl b/modules/public_pages/erp/ledger/purchase_ledger/templates/plpayments/index.tpl
index 8e38231c..583a6c30 100755
--- a/modules/public_pages/erp/ledger/purchase_ledger/templates/plpayments/index.tpl
+++ b/modules/public_pages/erp/ledger/purchase_ledger/templates/plpayments/index.tpl
@@ -9,6 +9,9 @@
 	{paging}
 	{data_table}
 		{heading_row}
+			{heading_cell field="created"}
+			Created
+			{/heading_cell}
 			{heading_cell field="payment_date"}
 				Payment Date
 			{/heading_cell}
@@ -39,8 +42,9 @@
 		{foreach name=transactions item=transaction from=$plpayments}
 			<tr>
 				<td align=left>
-					{link_to module=$module controller=$controller action='view' id=$transaction->id value=$transaction->payment_date|un_fix_date}
+					{link_to module=$module controller=$controller action='view' id=$transaction->id value=$transaction->created|un_fix_date}
 				</td>
+				<td align=left>{$transaction->payment_date|un_fix_date}</td>
 				<td align=left>{$transaction->getFormatted('status')}</td>
 				<td align=left>{$transaction->reference}</td>
 				<td align=center>{$transaction->number_transactions}</td>
@@ -49,7 +53,7 @@
 				<td align=left>{$transaction->currency}</td>
 				<td align=right>{$transaction->payment_total|string_format:"%.2f"}</td>
 				<td align=right>
-					{if $transaction->status=='N'}
+					{if $transaction->status=='N' && $transaction->getNoOutput() !== 't'}
 						{link_to module=$module controller=$controller action='printDialog' printaction='make_batch_payment' id=$transaction->id value='Process'}
 					{/if}
 				</td>
diff --git a/modules/public_pages/erp/ledger/purchase_ledger/templates/plpayments/view.tpl b/modules/public_pages/erp/ledger/purchase_ledger/templates/plpayments/view.tpl
index 235c3785..598c1f5a 100755
--- a/modules/public_pages/erp/ledger/purchase_ledger/templates/plpayments/view.tpl
+++ b/modules/public_pages/erp/ledger/purchase_ledger/templates/plpayments/view.tpl
@@ -20,8 +20,17 @@
 				{view_data attribute='currency_id'}
 				{view_data attribute='payment_type_id'}
 				{view_data attribute='payment_total'}
-				{view_data attribute='remittance_printed'}
-				{view_data attribute='remittance_date'}
+				<dt>Remmitances printed</dt>
+				<dd><ul>
+				{foreach name=output item=output from=$outputs}
+					{assign d $output.created|un_fix_date}
+					{assign t $output.created|date_format:'%H:%M'}
+					{assign l  $d|cat: ' - '|cat: $t}
+					<li>{link_to module=$module controller='pltransactions' action='output_detail' id=$output.output_header_id value=$l}</li>
+				{foreachelse}
+					None
+				{/foreach}
+				</dd></ul>
 			</dl>
 		{/with}
 	</div>