AccountDetail.php
164 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\PaymentGateways\Stripe\Models; |
| 4 | |
| 5 | use Give\Helpers\ArrayDataSet; |
| 6 | use Give\PaymentGateways\Exceptions\InvalidPropertyName; |
| 7 | use Give\PaymentGateways\Stripe\Traits\HasStripeStatementDescriptorText; |
| 8 | |
| 9 | /** |
| 10 | * Class AccountDetail |
| 11 | * |
| 12 | * @package Give\PaymentGateways\Stripe\Models |
| 13 | * @since 2.10.2 |
| 14 | * |
| 15 | * @property-read string $type |
| 16 | * @property-read string $accountName |
| 17 | * @property-read string $accountSlug |
| 18 | * @property-read string $accountEmail |
| 19 | * @property-read string $accountCountry |
| 20 | * @property-read string $accountId |
| 21 | * @property-read string $liveSecretKey |
| 22 | * @property-read string $livePublishableKey |
| 23 | * @property-read string $testSecretKey |
| 24 | * @property-read string $testPublishableKey |
| 25 | * @property-read string $statementDescriptor |
| 26 | */ |
| 27 | class AccountDetail |
| 28 | { |
| 29 | use HasStripeStatementDescriptorText; |
| 30 | |
| 31 | protected $args; |
| 32 | protected $propertiesArgs; |
| 33 | protected $requiredArgs = [ |
| 34 | 'type', |
| 35 | 'account_name', |
| 36 | 'account_slug', |
| 37 | 'account_email', |
| 38 | 'account_country', |
| 39 | 'account_id', |
| 40 | 'live_secret_key', |
| 41 | 'live_publishable_key', |
| 42 | 'test_secret_key', |
| 43 | 'test_publishable_key', |
| 44 | 'statement_descriptor', |
| 45 | ]; |
| 46 | |
| 47 | /** |
| 48 | * AccountDetail constructor. |
| 49 | * |
| 50 | * @since 2.10.2 |
| 51 | * |
| 52 | * @param array $args |
| 53 | * |
| 54 | * @throws InvalidPropertyName |
| 55 | */ |
| 56 | public function __construct(array $args) |
| 57 | { |
| 58 | $this->args = $args; |
| 59 | $args = $this->addSupportFormNewStatementDescriptorParam($args); |
| 60 | $this->propertiesArgs = ArrayDataSet::camelCaseKeys($args); |
| 61 | $this->validate($args); |
| 62 | } |
| 63 | |
| 64 | /** |
| 65 | * @since 2.13.0 |
| 66 | * @throws InvalidPropertyName |
| 67 | */ |
| 68 | public static function fromArray($array) |
| 69 | { |
| 70 | return new static($array); |
| 71 | } |
| 72 | |
| 73 | /** |
| 74 | * @since 2.13.0 |
| 75 | * |
| 76 | * @return array |
| 77 | */ |
| 78 | public function toArray() |
| 79 | { |
| 80 | return [ |
| 81 | 'type' => $this->type, |
| 82 | 'account_id' => $this->accountId, |
| 83 | 'account_slug' => $this->accountSlug, |
| 84 | 'account_name' => $this->accountName, |
| 85 | 'account_country' => $this->accountCountry, |
| 86 | 'account_email' => $this->accountEmail, |
| 87 | 'live_secret_key' => $this->liveSecretKey, |
| 88 | 'test_secret_key' => $this->testSecretKey, |
| 89 | 'live_publishable_key' => $this->livePublishableKey, |
| 90 | 'test_publishable_key' => $this->testPublishableKey, |
| 91 | 'statement_descriptor' => $this->statementDescriptor, |
| 92 | ]; |
| 93 | } |
| 94 | |
| 95 | /** |
| 96 | * @since 2.10.2 |
| 97 | * |
| 98 | * @param string $key |
| 99 | * |
| 100 | * @return mixed |
| 101 | * @throws InvalidPropertyName |
| 102 | */ |
| 103 | public function __get($key) |
| 104 | { |
| 105 | if (!array_key_exists($key, $this->propertiesArgs)) { |
| 106 | throw new InvalidPropertyName( |
| 107 | sprintf( |
| 108 | '$1%s property does not exist in %2$s class', |
| 109 | $key, |
| 110 | __CLASS__ |
| 111 | ) |
| 112 | ); |
| 113 | } |
| 114 | |
| 115 | return $this->propertiesArgs[$key]; |
| 116 | } |
| 117 | |
| 118 | /** |
| 119 | * Validate array format. |
| 120 | * |
| 121 | * @since 2.10.2 |
| 122 | * |
| 123 | * @param array $array |
| 124 | * |
| 125 | * @throws InvalidPropertyName |
| 126 | */ |
| 127 | private function validate($array) |
| 128 | { |
| 129 | if (array_diff($this->requiredArgs, array_keys($array))) { |
| 130 | throw new InvalidPropertyName( |
| 131 | sprintf( |
| 132 | 'To create a %1$s object, please provide valid: %2$s', |
| 133 | __CLASS__, |
| 134 | implode(' , ', $this->requiredArgs) |
| 135 | ) |
| 136 | ); |
| 137 | } |
| 138 | } |
| 139 | |
| 140 | /** |
| 141 | * We decided to define statement descriptor per stripe account. |
| 142 | * Statement descriptor default text for each account will be set to blog title. |
| 143 | * @see: https://github.com/impress-org/givewp/issues/6021 |
| 144 | * |
| 145 | * @since 2.19.0 |
| 146 | * @deprecated |
| 147 | * |
| 148 | * @param array $args |
| 149 | * |
| 150 | * @return array |
| 151 | */ |
| 152 | private function addSupportFormNewStatementDescriptorParam($args) |
| 153 | { |
| 154 | $propertyName = 'statement_descriptor'; |
| 155 | if (!array_key_exists($propertyName, $args) || empty($args[$propertyName])) { |
| 156 | $statementDescriptor = give_get_option('stripe_statement_descriptor', get_bloginfo('name')); |
| 157 | $this->validateStatementDescriptor($statementDescriptor); |
| 158 | $args[$propertyName] = $statementDescriptor; |
| 159 | } |
| 160 | |
| 161 | return $args; |
| 162 | } |
| 163 | } |
| 164 |