Actions
4 years ago
CommandHandlers
4 years ago
Commands
4 years ago
Contracts
4 years ago
DataTransferObjects
4 years ago
Exceptions
4 years ago
Log
4 years ago
Routes
4 years ago
Traits
4 years ago
DonationSummary.php
4 years ago
PaymentGateway.php
4 years ago
PaymentGatewayRegister.php
4 years ago
PaymentGatewayRegister.php
143 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Framework\PaymentGateways; |
| 4 | |
| 5 | use Give\Container\Container; |
| 6 | use Give\Framework\Exceptions\Primitives\Exception; |
| 7 | use Give\Framework\Exceptions\Primitives\InvalidArgumentException; |
| 8 | use Give\Framework\LegacyPaymentGateways\Adapters\LegacyPaymentGatewayRegisterAdapter; |
| 9 | use Give\Framework\PaymentGateways\Contracts\PaymentGatewaysIterator; |
| 10 | use Give\Framework\PaymentGateways\Exceptions\OverflowException; |
| 11 | |
| 12 | /** |
| 13 | * @since 2.18.0 |
| 14 | */ |
| 15 | class PaymentGatewayRegister extends PaymentGatewaysIterator |
| 16 | { |
| 17 | protected $gateways = []; |
| 18 | |
| 19 | /** |
| 20 | * Get Gateways |
| 21 | * |
| 22 | * @since 2.18.0 |
| 23 | * |
| 24 | * @return array |
| 25 | */ |
| 26 | public function getPaymentGateways() |
| 27 | { |
| 28 | return $this->gateways; |
| 29 | } |
| 30 | |
| 31 | /** |
| 32 | * Get Gateway |
| 33 | * |
| 34 | * @since 2.18.0 |
| 35 | * |
| 36 | * @param string $id |
| 37 | * |
| 38 | * @return string |
| 39 | */ |
| 40 | public function getPaymentGateway($id) |
| 41 | { |
| 42 | if (!$this->hasPaymentGateway($id)) { |
| 43 | throw new InvalidArgumentException("No gateway exists with the ID {$id}"); |
| 44 | } |
| 45 | |
| 46 | return $this->gateways[$id]; |
| 47 | } |
| 48 | |
| 49 | /** |
| 50 | * @since 2.18.0 |
| 51 | * |
| 52 | * @param string $id |
| 53 | * |
| 54 | * @return bool |
| 55 | */ |
| 56 | public function hasPaymentGateway($id) |
| 57 | { |
| 58 | return isset($this->gateways[$id]); |
| 59 | } |
| 60 | |
| 61 | /** |
| 62 | * Register Gateway |
| 63 | * |
| 64 | * @since 2.18.0 |
| 65 | * |
| 66 | * @param string $gatewayClass |
| 67 | * |
| 68 | * @throws OverflowException|InvalidArgumentException|Exception |
| 69 | */ |
| 70 | public function registerGateway($gatewayClass) |
| 71 | { |
| 72 | if (!is_subclass_of($gatewayClass, PaymentGateway::class)) { |
| 73 | throw new InvalidArgumentException( |
| 74 | sprintf( |
| 75 | '%1$s must extend %2$s', |
| 76 | $gatewayClass, |
| 77 | PaymentGateway::class |
| 78 | ) |
| 79 | ); |
| 80 | } |
| 81 | |
| 82 | $gatewayId = $gatewayClass::id(); |
| 83 | |
| 84 | if ($this->hasPaymentGateway($gatewayId)) { |
| 85 | throw new OverflowException("Cannot register a gateway with an id that already exists: $gatewayId"); |
| 86 | } |
| 87 | |
| 88 | $this->gateways[$gatewayId] = $gatewayClass; |
| 89 | |
| 90 | $this->registerGatewayWithServiceContainer($gatewayClass, $gatewayId); |
| 91 | |
| 92 | $this->afterGatewayRegister($gatewayClass); |
| 93 | } |
| 94 | |
| 95 | /** |
| 96 | * Unregister Gateway |
| 97 | * |
| 98 | * @since 2.18.0 |
| 99 | * |
| 100 | * @param $gatewayId |
| 101 | */ |
| 102 | public function unregisterGateway($gatewayId) |
| 103 | { |
| 104 | if (isset($this->gateways[$gatewayId])) { |
| 105 | unset($this->gateways[$gatewayId]); |
| 106 | } |
| 107 | } |
| 108 | |
| 109 | /** |
| 110 | * |
| 111 | * Register Gateway with Service Container as Singleton |
| 112 | * with option of adding Subscription Module through filter "give_gateway_{$gatewayId}_subscription_module" |
| 113 | * |
| 114 | * @since 2.18.0 |
| 115 | * |
| 116 | * @param string $gatewayClass |
| 117 | * @param string $gatewayId |
| 118 | * |
| 119 | * @return void |
| 120 | */ |
| 121 | private function registerGatewayWithServiceContainer($gatewayClass, $gatewayId) |
| 122 | { |
| 123 | give()->singleton($gatewayClass, function (Container $container) use ($gatewayClass, $gatewayId) { |
| 124 | $subscriptionModule = apply_filters("give_gateway_{$gatewayId}_subscription_module", null); |
| 125 | |
| 126 | return new $gatewayClass($subscriptionModule ? $container->make($subscriptionModule) : null); |
| 127 | }); |
| 128 | } |
| 129 | |
| 130 | /** |
| 131 | * After gateway is registered, connect to legacy payment gateway adapter |
| 132 | * |
| 133 | * @param string $gatewayClass |
| 134 | */ |
| 135 | private function afterGatewayRegister($gatewayClass) |
| 136 | { |
| 137 | /** @var LegacyPaymentGatewayRegisterAdapter $legacyPaymentGatewayRegisterAdapter */ |
| 138 | $legacyPaymentGatewayRegisterAdapter = give(LegacyPaymentGatewayRegisterAdapter::class); |
| 139 | |
| 140 | $legacyPaymentGatewayRegisterAdapter->connectGatewayToLegacyPaymentGatewayAdapter($gatewayClass); |
| 141 | } |
| 142 | } |
| 143 |