Allow to accept/reject multiple drawdowns at once

Author: Dominic Tubach

Civi/Api4/FundingDrawdown.php

@@ -4,10 +4,12 @@
 namespace Civi\Api4;
 
 use Civi\Funding\Api4\Action\FundingDrawdown\AcceptAction;
+use Civi\Funding\Api4\Action\FundingDrawdown\AcceptMultipleAction;
 use Civi\Funding\Api4\Action\FundingDrawdown\CreateAction;
 use Civi\Funding\Api4\Action\FundingDrawdown\GetAction;
 use Civi\Funding\Api4\Action\FundingDrawdown\GetFieldsAction;
 use Civi\Funding\Api4\Action\FundingDrawdown\RejectAction;
+use Civi\Funding\Api4\Action\FundingDrawdown\RejectMultipleAction;
 use Civi\Funding\Api4\Action\FundingDrawdown\SaveAction;
 use Civi\Funding\Api4\Action\FundingDrawdown\UpdateAction;
 use Civi\Funding\Api4\Permissions;
@@ -30,6 +32,10 @@ public static function accept(bool $checkPermissions = TRUE): AcceptAction {
     return \Civi::service(AcceptAction::class)->setCheckPermissions($checkPermissions);
   }
 
+  public static function acceptMultiple(bool $checkPermissions = TRUE): AcceptMultipleAction {
+    return (new AcceptMultipleAction())->setCheckPermissions($checkPermissions);
+  }
+
   public static function create($checkPermissions = TRUE) {
     return \Civi::service(CreateAction::class)->setCheckPermissions($checkPermissions);
   }
@@ -46,6 +52,10 @@ public static function reject(bool $checkPermissions = TRUE): RejectAction {
     return \Civi::service(RejectAction::class)->setCheckPermissions($checkPermissions);
   }
 
+  public static function rejectMultiple(bool $checkPermissions = TRUE): RejectMultipleAction {
+    return (new RejectMultipleAction())->setCheckPermissions($checkPermissions);
+  }
+
   public static function save($checkPermissions = TRUE) {
     return \Civi::service(SaveAction::class)->setCheckPermissions($checkPermissions);
   }

Civi/Funding/Api4/Action/FundingDrawdown/AcceptMultipleAction.php

@@ -0,0 +1,48 @@
+<?php
+/*
+ * Copyright (C) 2025 SYSTOPIA GmbH
+ *
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU Affero General Public License as published by
+ *  the Free Software Foundation in version 3.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU Affero General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Affero General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+declare(strict_types = 1);
+
+namespace Civi\Funding\Api4\Action\FundingDrawdown;
+
+use Civi\Api4\FundingDrawdown;
+use Civi\Api4\Generic\AbstractAction;
+use Civi\Api4\Generic\Result;
+use Civi\Funding\Api4\Action\Traits\IdsParameterTrait;
+
+class AcceptMultipleAction extends AbstractAction {
+
+  use IdsParameterTrait;
+
+  public function __construct() {
+    parent::__construct(FundingDrawdown::getEntityName(), 'acceptMultiple');
+  }
+
+  /**
+   * @inheritDoc
+   * @throws \CRM_Core_Exception
+   */
+  public function _run(Result $result): void {
+    foreach ($this->getIds() as $id) {
+      $result[$id] = FundingDrawdown::accept()
+        ->setId($id)
+        ->execute()
+        ->single();
+    }
+  }
+
+}

Civi/Funding/Api4/Action/FundingDrawdown/RejectMultipleAction.php

@@ -0,0 +1,48 @@
+<?php
+/*
+ * Copyright (C) 2025 SYSTOPIA GmbH
+ *
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU Affero General Public License as published by
+ *  the Free Software Foundation in version 3.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU Affero General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Affero General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+declare(strict_types = 1);
+
+namespace Civi\Funding\Api4\Action\FundingDrawdown;
+
+use Civi\Api4\FundingDrawdown;
+use Civi\Api4\Generic\AbstractAction;
+use Civi\Api4\Generic\Result;
+use Civi\Funding\Api4\Action\Traits\IdsParameterTrait;
+
+class RejectMultipleAction extends AbstractAction {
+
+  use IdsParameterTrait;
+
+  public function __construct() {
+    parent::__construct(FundingDrawdown::getEntityName(), 'rejectMultiple');
+  }
+
+  /**
+   * @inheritDoc
+   * @throws \CRM_Core_Exception
+   */
+  public function _run(Result $result): void {
+    foreach ($this->getIds() as $id) {
+      $result[$id] = FundingDrawdown::reject()
+        ->setId($id)
+        ->execute()
+        ->single();
+    }
+  }
+
+}

Civi/Funding/Controller/DrawdownDocumentDownloadController.php

@@ -23,13 +23,18 @@
 use Civi\Funding\FundingAttachmentManagerInterface;
 use Civi\Funding\PayoutProcess\DrawdownManager;
 use CRM_Funding_ExtensionUtil as E;
+use setasign\Fpdi\Fpdi;
 use Symfony\Component\HttpFoundation\BinaryFileResponse;
+use Symfony\Component\HttpFoundation\HeaderUtils;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpFoundation\ResponseHeaderBag;
 use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
 use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
+use Tomsgu\PdfMerger\PdfCollection;
+use Tomsgu\PdfMerger\PdfFile;
+use Tomsgu\PdfMerger\PdfMerger;
 
 final class DrawdownDocumentDownloadController implements PageControllerInterface {
 
@@ -47,6 +52,19 @@ public function __construct(FundingAttachmentManagerInterface $attachmentManager
    * @throws \CRM_Core_Exception
    */
   public function handle(Request $request): Response {
+    if ($request->query->has('drawdownIds')) {
+      $drawdownIds = (string) $request->query->get('drawdownIds');
+
+      if (preg_match('/^[1-9][0-9]*(,[1-9][0-9]*)*$/', $drawdownIds) !== 1) {
+        throw new BadRequestHttpException('Invalid drawdown IDs');
+      }
+
+      $drawdownIds = array_map(fn (string $id) => (int) $id, explode(',', $drawdownIds));
+      /** @phpstan-var list<int> $drawdownIds */
+
+      return $this->downloadMultiple($drawdownIds);
+    }
+
     $drawdownId = $request->query->get('drawdownId');
 
     if (!is_numeric($drawdownId)) {
@@ -92,4 +110,46 @@ private function download(int $drawdownId): Response {
       ->setMaxAge(300);
   }
 
+  /**
+   * @phpstan-param list<int> $drawdownIds
+   *
+   * @throws \CRM_Core_Exception
+   * @throws \Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
+   * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
+   */
+  private function downloadMultiple(array $drawdownIds): Response {
+    $pdfCollection = new PdfCollection();
+    foreach ($drawdownIds as $drawdownId) {
+      $drawdown = $this->drawdownManager->get($drawdownId);
+      if (NULL === $drawdown) {
+        throw new AccessDeniedHttpException();
+      }
+
+      $attachment = $this->attachmentManager->getLastByFileType(
+        'civicrm_funding_drawdown',
+        $drawdownId,
+        $drawdown->getAmount() < 0 ? FileTypeNames::PAYBACK_CLAIM : FileTypeNames::PAYMENT_INSTRUCTION,
+      );
+
+      if (NULL === $attachment) {
+        throw new NotFoundHttpException("Drawdown document (ID: $drawdownId) does not exist");
+      }
+
+      $pdfCollection->addPdf($attachment->getPath());
+    }
+
+    $filename = E::ts('payment-instructions') . '.pdf';
+    $headers = [
+      'Content-Type' => 'application/pdf',
+      'Content-Disposition' => HeaderUtils::makeDisposition(HeaderUtils::DISPOSITION_INLINE, $filename),
+    ];
+
+    $merger = new PdfMerger(new Fpdi());
+    return (new Response(
+      $merger->merge($pdfCollection, $filename, PdfMerger::MODE_STRING, PdfFile::ORIENTATION_AUTO_DETECT),
+      200,
+      $headers
+    ))->setMaxAge(300);
+  }
+
 }

Civi/Funding/Page/RemoteTransferContractDownloadPage.php

@@ -10,7 +10,7 @@
 /**
  * @codeCoverageIgnore
  */
-class RemoteTransferContractDownloadPage extends AbstractRemoteControllerPage {
+final class RemoteTransferContractDownloadPage extends AbstractRemoteControllerPage {
 
   protected function getController(): PageControllerInterface {
     return \Civi::service(TransferContractDownloadController::class);

ang/afsearchDrawdowns.aff.html

@@ -0,0 +1,9 @@
+<div af-fieldset="">
+  <div class="af-container af-layout-inline">
+    <af-field name="creation_date" defn="{search_range: true, input_attrs: {}, required: false, input_type: 'Select'}" />
+    <af-field name="status" defn="{required: false, input_attrs: {}}" />
+    <af-field name="FundingDrawdown_FundingPayoutProcess_payout_process_id_01_FundingPayoutProcess_FundingCase_funding_case_id_01.recipient_contact_id" defn="{required: false, input_attrs: {}}" />
+    <af-field name="FundingDrawdown_FundingPayoutProcess_payout_process_id_01_FundingPayoutProcess_FundingCase_funding_case_id_01.funding_program_id" defn="{input_type: 'Select', input_attrs: {multiple: true}, required: false}" />
+  </div>
+  <crm-search-display-table search-name="FundingDrawdownsAll" display-name="Table"></crm-search-display-table>
+</div>

ang/afsearchDrawdowns.aff.php

@@ -0,0 +1,20 @@
+<?php
+use CRM_Funding_ExtensionUtil as E;
+
+return [
+  'type' => 'search',
+  'requires' => [
+    'crmFunding',
+  ],
+  'title' => E::ts('Drawdowns'),
+  'icon' => 'fa-list-alt',
+  'server_route' => 'civicrm/funding/drawdown/list',
+  'permission' => [
+    'access Funding',
+    'administer Funding',
+  ],
+  'permission_operator' => 'OR',
+  'search_displays' => [
+    'FundingDrawdownsAll.Table',
+  ],
+];