Version 5.0.0 beta 1

applications/nexus/data/defaults/extensions/Gateway.txt

@@ -0,0 +1,118 @@
+<?php
+/**
+ * @brief		{class}
+ * @author		<a href='https://www.invisioncommunity.com'>Invision Power Services, Inc.</a>
+ * @copyright	(c) Invision Power Services, Inc.
+ * @license		https://www.invisioncommunity.com/legal/standards/
+ * @package		Invision Community
+{subpackage}
+ * @since		{date}
+ */
+
+namespace IPS\{app}\extensions\nexus\Gateway;
+
+/* To prevent PHP errors (extending class does not exist) revealing path */
+
+use IPS\nexus\Customer;
+use IPS\nexus\Gateway;
+use IPS\nexus\Invoice;
+use IPS\nexus\Money;
+use IPS\nexus\Transaction;
+use IPS\Helpers\Form;
+use Exception;
+use InvalidArgumentException;
+use LogicException;
+use function defined;
+
+if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
+{
+	header( ( $_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.0' ) . ' 403 Forbidden' );
+	exit;
+}
+
+/**
+ * {class}
+ */
+class {class} extends Gateway
+{
+    public static string $gatewayKey = '{class}';
+
+	/* !Features */
+
+    const SUPPORTS_REFUNDS = TRUE;
+    const SUPPORTS_PARTIAL_REFUNDS = TRUE;
+
+  	/**
+  	 * Capture
+  	 *
+  	 * @param Transaction $transaction	Transaction
+  	 * @return    void
+  	 * @throws	LogicException
+  	 */
+  	public function capture( Transaction $transaction ): void
+  	{
+  	
+  	}
+
+  	/**
+  	 * Refund
+  	 *
+  	 * @param Transaction $transaction	Transaction to be refunded
+  	 * @param mixed|NULL $amount			Amount to refund (NULL for full amount - always in same currency as transaction)
+  	 * @param string|null $reason
+  	 * @return    mixed                                    Gateway reference ID for refund, if applicable
+  	 * @throws	Exception
+   	 */
+  	 public function refund( Transaction $transaction, mixed $amount = NULL, ?string $reason = NULL): mixed
+  	 {
+  	 		return NULL;
+  	 }
+
+  	/**
+  	 * Refund Reasons that the gateway understands, if the gateway supports this
+  	 *
+  	 * @return    array
+   	 */
+  	public static function refundReasons(): array
+	{
+		return [];
+	}
+
+  	/**
+  	 * Settings
+  	 *
+  	 * @param Form $form	The form
+  	 * @return    void
+  	 */
+	public function settings( Form $form  ): void
+	{
+
+	}
+
+  	/**
+  	 * Test Settings
+  	 *
+  	 * @param array $settings	Settings
+  	 * @return    array
+  	 * @throws	InvalidArgumentException
+  	 */
+  	public function testSettings( array $settings=array() ): array
+  	{
+		return $settings;
+  	}
+
+	/**
+	 * Payment Screen Fields
+	 *
+	 * @param Invoice $invoice	Invoice
+	 * @param Money $amount		The amount to pay now
+	 * @param Customer|null $member		The member the payment screen is for (if in the ACP charging to a member's card) or NULL for currently logged in member
+	 * @param array $recurrings	Details about recurring costs
+	 * @param string $type		'checkout' means the cusotmer is doing this on the normal checkout screen, 'admin' means the admin is doing this in the ACP, 'card' means the user is just adding a card
+	 * @return    array
+	 */
+	public function paymentScreen( Invoice $invoice, Money $amount, ?Customer $member = NULL, array $recurrings = [], string $type = 'checkout' ): array
+	{
+		return [];
+	}
+}