doc: add comments about DTO

impress-org · Sep 6, 2024 · f66bc2c · f66bc2c
1 parent 6944f85
commit f66bc2c
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/src/OffSiteGateway/DataTransferObjects/OffSiteGatewayPayment.php b/src/OffSiteGateway/DataTransferObjects/OffSiteGatewayPayment.php
@@ -3,6 +3,11 @@
 namespace GiveAddon\OffSiteGateway\DataTransferObjects;
 
 /**
+ * This Data Transfer Object class converts the gateway API response (when creating a new payment) to a local
+ * object where we know what properties can be accessed. The fromArray() method is where the conversion from
+ * the gateway API response to an object of this class is made. You should edit this method according to the
+ * gateway you are integrating since the API response probably should differ.
+ *
  * @unreleased
  */
 class OffSiteGatewayPayment

diff --git a/src/OffSiteGateway/DataTransferObjects/OffSiteGatewayWebhookNotification.php b/src/OffSiteGateway/DataTransferObjects/OffSiteGatewayWebhookNotification.php
@@ -3,6 +3,11 @@
 namespace GiveAddon\OffSiteGateway\DataTransferObjects;
 
 /**
+ * This Data Transfer Object class converts the gateway webhook notification to a local object where we know
+ * what properties can be accessed. The fromRequest() method is where the conversion from the gateway webhook
+ * notification to an object of this class is made. You should edit this method according to the gateway you
+ * are integrating since the webhook notification attributes probably should differ.
+ *
  * @unreleased
  */
 class OffSiteGatewayWebhookNotification