GatewayRouteData.php
89 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Framework\PaymentGateways\DataTransferObjects; |
| 4 | |
| 5 | /** |
| 6 | * Class GatewayRouteData |
| 7 | * @since 2.18.0 |
| 8 | * @since 2.23.1 Make class final to avoid unsafe usage of `new static()`. |
| 9 | */ |
| 10 | final class GatewayRouteData |
| 11 | { |
| 12 | /** |
| 13 | * @var string |
| 14 | */ |
| 15 | public $gatewayId; |
| 16 | /** |
| 17 | * @var string |
| 18 | */ |
| 19 | public $gatewayMethod; |
| 20 | /** |
| 21 | * @var array |
| 22 | */ |
| 23 | public $queryParams; |
| 24 | /** |
| 25 | * @var string|null |
| 26 | */ |
| 27 | public $routeSignature; |
| 28 | /** |
| 29 | * @var string|null |
| 30 | */ |
| 31 | public $routeSignatureId; |
| 32 | /** |
| 33 | * @var string|null |
| 34 | */ |
| 35 | public $routeSignatureExpiration; |
| 36 | /** |
| 37 | * Keys of the query args the signature covers. |
| 38 | * |
| 39 | * @since 4.16.8 |
| 40 | * @var string[] |
| 41 | */ |
| 42 | public $routeSignatureArgKeys = []; |
| 43 | |
| 44 | /** |
| 45 | * Query args the route framework itself sets. A gateway arg with one of these names would be |
| 46 | * overwritten on the URL and excluded from queryParams on the way back, so a signature covering |
| 47 | * it could never validate. |
| 48 | * |
| 49 | * @since 4.16.8 |
| 50 | */ |
| 51 | const ROUTE_PARAMS = [ |
| 52 | 'give-listener', |
| 53 | 'give-gateway-id', |
| 54 | 'give-gateway-method', |
| 55 | 'give-route-signature', |
| 56 | 'give-route-signature-id', |
| 57 | 'give-route-signature-expiration', |
| 58 | 'give-route-signature-args', |
| 59 | ]; |
| 60 | |
| 61 | /** |
| 62 | * Convert data from request into DTO |
| 63 | * |
| 64 | * @since 4.16.8 add routeSignatureArgKeys |
| 65 | * @since 2.19.5 add routeSignatureExpiration |
| 66 | * @since 2.19.4 add give-route-signature-id |
| 67 | * @since 2.18.0 |
| 68 | * |
| 69 | * @return self |
| 70 | */ |
| 71 | public static function fromRequest(array $request) |
| 72 | { |
| 73 | $self = new static(); |
| 74 | |
| 75 | $self->gatewayId = $request['give-gateway-id']; |
| 76 | $self->gatewayMethod = $request['give-gateway-method']; |
| 77 | $self->routeSignature = isset($request['give-route-signature']) ? $request['give-route-signature'] : null; |
| 78 | $self->routeSignatureId = isset($request['give-route-signature-id']) ? $request['give-route-signature-id'] : null; |
| 79 | $self->routeSignatureExpiration = isset($request['give-route-signature-expiration']) ? $request['give-route-signature-expiration'] : null; |
| 80 | $self->routeSignatureArgKeys = empty($request['give-route-signature-args']) |
| 81 | ? [] |
| 82 | : explode(',', $request['give-route-signature-args']); |
| 83 | |
| 84 | $self->queryParams = array_diff_key($request, array_flip(self::ROUTE_PARAMS)); |
| 85 | |
| 86 | return $self; |
| 87 | } |
| 88 | } |
| 89 |