Refactor get form actions to get rid of some legacy code

Author: Dominic Tubach

Civi/Api4/RemoteFundingApplicationProcess.php

@@ -61,7 +61,7 @@ public static function submitAddForm(): SubmitAddFormAction {
   }
 
   public static function getForm(): GetFormAction {
-    return \Civi::service(GetFormAction::class);
+    return new GetFormAction();
   }
 
   public static function submitForm(): SubmitFormAction {

Civi/Api4/RemoteFundingCase.php

@@ -67,7 +67,7 @@ public static function validateNewForm(): ValidateNewFormAction {
   }
 
   public static function getNewApplicationForm(): GetNewApplicationFormAction {
-    return \Civi::service(GetNewApplicationFormAction::class);
+    return new GetNewApplicationFormAction();
   }
 
   public static function submitNewApplicationForm(): SubmitNewApplicationFormAction {

Civi/Funding/Api4/Action/Remote/ApplicationProcess/GetFormAction.php

@@ -19,55 +19,16 @@
 
 namespace Civi\Funding\Api4\Action\Remote\ApplicationProcess;
 
-use Civi\Api4\Generic\Result;
-use Civi\Core\CiviEventDispatcherInterface;
+use Civi\Api4\RemoteFundingApplicationProcess;
+use Civi\Funding\Api4\Action\Remote\AbstractRemoteFundingAction;
 use Civi\Funding\Api4\Action\Traits\ApplicationProcessIdParameterTrait;
-use Civi\Funding\ApplicationProcess\ApplicationProcessBundleLoader;
-use Civi\Funding\Event\Remote\ApplicationProcess\GetApplicationFormEvent;
-use Civi\Funding\Exception\FundingException;
-use CRM_Funding_ExtensionUtil as E;
 
-class GetFormAction extends AbstractFormAction {
+class GetFormAction extends AbstractRemoteFundingAction {
 
   use ApplicationProcessIdParameterTrait;
 
-  public function __construct(
-    ApplicationProcessBundleLoader $applicationProcessBundleLoader,
-    CiviEventDispatcherInterface $eventDispatcher
-  ) {
-    parent::__construct('getForm', $applicationProcessBundleLoader, $eventDispatcher);
-  }
-
-  /**
-   * @inheritDoc
-   *
-   * @throws \CRM_Core_Exception
-   */
-  public function _run(Result $result): void {
-    $event = $this->createEvent();
-    $this->dispatchEvent($event);
-
-    $result->debug['event'] = $event->getDebugOutput();
-    if (NULL === $event->getJsonSchema() || NULL === $event->getUiSchema()) {
-      throw new FundingException(
-        E::ts('Application process with ID "%1" not found', [1 => $this->applicationProcessId]),
-        'invalid_arguments'
-      );
-    }
-
-    $result->rowCount = 1;
-    $result->exchangeArray([
-      'jsonSchema' => $event->getJsonSchema(),
-      'uiSchema' => $event->getUiSchema(),
-      'data' => $event->getData(),
-    ]);
-  }
-
-  /**
-   * @throws \CRM_Core_Exception
-   */
-  private function createEvent(): GetApplicationFormEvent {
-    return GetApplicationFormEvent::fromApiRequest($this, $this->createEventParams($this->getApplicationProcessId()));
+  public function __construct() {
+    parent::__construct(RemoteFundingApplicationProcess::getEntityName(), 'getForm');
   }
 
 }

Civi/Funding/Api4/Action/Remote/FundingCase/GetNewApplicationFormAction.php

@@ -19,72 +19,22 @@
 
 namespace Civi\Funding\Api4\Action\Remote\FundingCase;
 
-use Civi\Api4\Generic\Result;
-use Civi\Core\CiviEventDispatcherInterface;
+use Civi\Api4\RemoteFundingCase;
+use Civi\Funding\Api4\Action\Remote\AbstractRemoteFundingAction;
 use Civi\Funding\Api4\Action\Remote\FundingCase\Traits\NewApplicationFormActionTrait;
 use Civi\Funding\Api4\Action\Traits\FundingCaseTypeIdParameterTrait;
 use Civi\Funding\Api4\Action\Traits\FundingProgramIdParameterTrait;
-use Civi\Funding\Event\Remote\FundingCase\GetNewApplicationFormEvent;
-use Civi\Funding\Exception\FundingException;
-use Civi\Funding\FundingProgram\FundingCaseTypeManager;
-use Civi\Funding\FundingProgram\FundingCaseTypeProgramRelationChecker;
-use Civi\Funding\FundingProgram\FundingProgramManager;
-use CRM_Funding_ExtensionUtil as E;
 
-class GetNewApplicationFormAction extends AbstractNewApplicationFormAction {
+class GetNewApplicationFormAction extends AbstractRemoteFundingAction {
 
   use FundingCaseTypeIdParameterTrait;
 
   use FundingProgramIdParameterTrait;
 
   use NewApplicationFormActionTrait;
 
-  public function __construct(
-    FundingCaseTypeManager $fundingCaseTypeManager,
-    FundingProgramManager $fundingProgramManager,
-    CiviEventDispatcherInterface $eventDispatcher,
-    FundingCaseTypeProgramRelationChecker $relationChecker
-  ) {
-    parent::__construct(
-      'getNewApplicationForm',
-      $fundingCaseTypeManager,
-      $fundingProgramManager,
-      $eventDispatcher,
-      $relationChecker,
-    );
-  }
-
-  /**
-   * @inheritDoc
-   *
-   * @throws \CRM_Core_Exception
-   */
-  public function _run(Result $result): void {
-    $this->assertFundingCaseTypeAndProgramRelated($this->getFundingCaseTypeId(), $this->getFundingProgramId());
-    $event = $this->createEvent();
-    $this->dispatchEvent($event);
-
-    $result->debug['event'] = $event->getDebugOutput();
-    if (NULL === $event->getJsonSchema() || NULL === $event->getUiSchema()) {
-      throw new FundingException(E::ts('Invalid funding program ID or funding case type ID'), 'invalid_arguments');
-    }
-
-    $result->rowCount = 1;
-    $result->exchangeArray([
-      'jsonSchema' => $event->getJsonSchema(),
-      'uiSchema' => $event->getUiSchema(),
-      'data' => $event->getData(),
-    ]);
-  }
-
-  /**
-   * @throws \CRM_Core_Exception
-   */
-  private function createEvent(): GetNewApplicationFormEvent {
-    return GetNewApplicationFormEvent::fromApiRequest(
-      $this,
-      $this->createEventParams($this->getFundingCaseTypeId(), $this->getFundingProgramId()),
-    );
+  public function __construct() {
+    parent::__construct(RemoteFundingCase::getEntityName(), 'getNewApplicationForm');
   }
 
 }

Civi/Funding/ApplicationProcess/Api4/ActionHandler/GetFormActionHandler.php

@@ -56,7 +56,7 @@ public function __construct(
    */
   public function getForm(GetFormAction $action): array {
     $applicationProcessBundle = $this->applicationProcessBundleLoader->get($action->getId());
-    Assert::notNull($applicationProcessBundle, sprintf('Application process with ID %d not found', $action->getId()));
+    Assert::notNull($applicationProcessBundle, sprintf('Application process with ID "%d" not found', $action->getId()));
     $applicationProcessStatusList = $this->applicationProcessBundleLoader->getStatusList($applicationProcessBundle);
 
     $form = $this->createHandler->handle(new ApplicationFormCreateCommand(

Civi/Funding/ApplicationProcess/Api4/ActionHandler/RemoteGetFormActionHandler.php

@@ -0,0 +1,44 @@
+<?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\ApplicationProcess\Api4\ActionHandler;
+
+use Civi\Api4\FundingApplicationProcess;
+use Civi\Api4\Generic\Result;
+use Civi\Funding\Api4\Action\Remote\ApplicationProcess\GetFormAction;
+use Civi\RemoteTools\ActionHandler\ActionHandlerInterface;
+use Civi\RemoteTools\Api4\Api4Interface;
+
+final class RemoteGetFormActionHandler implements ActionHandlerInterface {
+
+  public const ENTITY_NAME = 'RemoteFundingApplicationProcess';
+
+  private Api4Interface $api4;
+
+  public function __construct(Api4Interface $api4) {
+    $this->api4 = $api4;
+  }
+
+  public function getForm(GetFormAction $action): Result {
+    return $this->api4->execute(FundingApplicationProcess::getEntityName(), 'getForm', [
+      'id' => $action->getApplicationProcessId(),
+    ]);
+  }
+
+}

Civi/Funding/ApplicationProcess/Command/ApplicationFormNewCreateCommand.php

@@ -24,26 +24,18 @@
 
 final class ApplicationFormNewCreateCommand {
 
-  private int $contactId;
-
   private FundingCaseTypeEntity $fundingCaseType;
 
   private FundingProgramEntity $fundingProgram;
 
   public function __construct(
-    int $contactId,
     FundingCaseTypeEntity $fundingCaseType,
     FundingProgramEntity $fundingProgram
   ) {
-    $this->contactId = $contactId;
     $this->fundingCaseType = $fundingCaseType;
     $this->fundingProgram = $fundingProgram;
   }
 
-  public function getContactId(): int {
-    return $this->contactId;
-  }
-
   public function getFundingCaseType(): FundingCaseTypeEntity {
     return $this->fundingCaseType;
   }

Civi/Funding/ApplicationProcess/Handler/ApplicationFormNewCreateHandler.php

@@ -27,32 +27,37 @@
 use Civi\Funding\Form\JsonSchema\JsonFormsSubmitButtonsFactory;
 use Civi\RemoteTools\Form\RemoteForm;
 use Civi\RemoteTools\Form\RemoteFormInterface;
+use Civi\RemoteTools\RequestContext\RequestContextInterface;
 
 final class ApplicationFormNewCreateHandler implements ApplicationFormNewCreateHandlerInterface {
 
   private ApplicationJsonSchemaCreateHelper $jsonSchemaCreateHelper;
 
   private NonCombinedApplicationJsonSchemaFactoryInterface $jsonSchemaFactory;
 
+  private RequestContextInterface $requestContext;
+
   private ApplicationSubmitActionsFactoryInterface $submitActionsFactory;
 
   private NonCombinedApplicationUiSchemaFactoryInterface $uiSchemaFactory;
 
   public function __construct(
     ApplicationJsonSchemaCreateHelper $jsonSchemaCreateHelper,
     NonCombinedApplicationJsonSchemaFactoryInterface $jsonSchemaFactory,
+    RequestContextInterface $requestContext,
     ApplicationSubmitActionsFactoryInterface $submitActionsFactory,
     NonCombinedApplicationUiSchemaFactoryInterface $uiSchemaFactory
   ) {
     $this->jsonSchemaCreateHelper = $jsonSchemaCreateHelper;
     $this->jsonSchemaFactory = $jsonSchemaFactory;
+    $this->requestContext = $requestContext;
     $this->submitActionsFactory = $submitActionsFactory;
     $this->uiSchemaFactory = $uiSchemaFactory;
   }
 
   public function handle(ApplicationFormNewCreateCommand $command): RemoteFormInterface {
     $jsonSchema = $this->jsonSchemaFactory->createJsonSchemaInitial(
-      $command->getContactId(),
+      $this->requestContext->getContactId(),
       $command->getFundingCaseType(),
       $command->getFundingProgram(),
     );

Civi/Funding/ApplicationProcess/Handler/ApplicationFormNewValidateHandler.php

@@ -46,7 +46,6 @@ public function __construct(
 
   public function handle(ApplicationFormNewValidateCommand $command): ApplicationFormValidationResult {
     $form = $this->formCreateHandler->handle(new ApplicationFormNewCreateCommand(
-      $command->getContactId(),
       $command->getFundingCaseType(),
       $command->getFundingProgram()
     ));

Civi/Funding/ApplicationProcess/Remote/Api4/ActionHandler/GetAddFormActionHandler.php

@@ -92,7 +92,7 @@ public function getAddForm(GetAddFormAction $action): array {
       $applicationProcessBundle = $this->applicationProcessBundleLoader->get($action->getCopyDataFromId());
       Assert::notNull(
         $applicationProcessBundle,
-        sprintf('Application process with ID %d not found', $action->getCopyDataFromId())
+        sprintf('Application process with ID "%d" not found', $action->getCopyDataFromId())
       );
       Assert::same(
         $fundingCaseType->getId(),