Donation.php
189 lines
| 1 | <?php |
| 2 | namespace Give\Session\SessionDonation\SessionObjects; |
| 3 | |
| 4 | use DateTime; |
| 5 | use Give\Helpers\ArrayDataSet; |
| 6 | use Give\Session\Objects; |
| 7 | use Give\ValueObjects\CardInfo; |
| 8 | use Give\ValueObjects\DonorInfo; |
| 9 | use Give\ValueObjects\ValueObjects; |
| 10 | use Give\Framework\Exceptions\Primitives\InvalidArgumentException; |
| 11 | |
| 12 | |
| 13 | /** |
| 14 | * Class Donation |
| 15 | * |
| 16 | * This class is use to represent donation session data as object. |
| 17 | * You can add custom data but that data only store momentarily because of donation session time limit. |
| 18 | * This does not represent actual Donation model instead of that it has few donation related information which required for donation processing. |
| 19 | * |
| 20 | * @package Give\Session\SessionDonation\SessionObjects |
| 21 | */ |
| 22 | class Donation implements Objects { |
| 23 | /** |
| 24 | * Donation id. |
| 25 | * |
| 26 | * @since 2.7.0 |
| 27 | * @var array |
| 28 | */ |
| 29 | public $id; |
| 30 | |
| 31 | /** |
| 32 | * Sanitized donation total amount. |
| 33 | * |
| 34 | * @since 2.7.0 |
| 35 | * @var string |
| 36 | */ |
| 37 | public $totalAmount; |
| 38 | |
| 39 | /** |
| 40 | * Donation purchase key. |
| 41 | * |
| 42 | * @since 2.7.0 |
| 43 | * @var string |
| 44 | */ |
| 45 | public $purchaseKey; |
| 46 | |
| 47 | /** |
| 48 | * Donor email. |
| 49 | * |
| 50 | * @since 2.7.0 |
| 51 | * @var string |
| 52 | */ |
| 53 | public $donorEmail; |
| 54 | |
| 55 | /** |
| 56 | * Donor email. |
| 57 | * |
| 58 | * @since 2.7.0 |
| 59 | * @var DateTime |
| 60 | */ |
| 61 | public $createdAt; |
| 62 | |
| 63 | /** |
| 64 | * Payment gateway id. |
| 65 | * |
| 66 | * @since 2.7.0 |
| 67 | * @var array |
| 68 | */ |
| 69 | public $paymentGateway; |
| 70 | |
| 71 | /** |
| 72 | * Array of properties and their cast type. |
| 73 | * |
| 74 | * @var ValueObjects[] |
| 75 | */ |
| 76 | private $caseTo = [ |
| 77 | 'formEntry' => FormEntry::class, |
| 78 | 'donorInfo' => DonorInfo::class, |
| 79 | 'cardInfo' => CardInfo::class, |
| 80 | ]; |
| 81 | |
| 82 | /** |
| 83 | * Take array and return object. |
| 84 | * |
| 85 | * @param $array |
| 86 | * |
| 87 | * @return Donation |
| 88 | */ |
| 89 | public static function fromArray( $array ) { |
| 90 | $expectedKeys = [ 'id', 'totalAmount', 'purchaseKey', 'donorEmail', 'createdAt', 'paymentGateway', 'formEntry', 'cardInfo', 'donorInfo' ]; |
| 91 | |
| 92 | if ( ! ArrayDataSet::hasRequiredKeys( $array, $expectedKeys ) ) { |
| 93 | throw new InvalidArgumentException( |
| 94 | 'Invalid Donation object, must have the exact following keys: ' . implode( ', ', $expectedKeys ) |
| 95 | ); |
| 96 | } |
| 97 | |
| 98 | $donation = new self(); |
| 99 | |
| 100 | $array['donorInfo'] = $donation->renameKeyInDonorInfo( $array['donorInfo'] ); |
| 101 | $array['cardInfo'] = $donation->filterCardInfoKeys( $array['cardInfo'] ); |
| 102 | |
| 103 | foreach ( $array as $key => $value ) { |
| 104 | if ( array_key_exists( $key, $donation->caseTo ) ) { |
| 105 | $class = $donation->caseTo[ $key ]; |
| 106 | $donation->{$key} = $class::fromArray( $value ); |
| 107 | continue; |
| 108 | } |
| 109 | |
| 110 | $donation->{$key} = is_array( $value ) ? |
| 111 | json_decode( json_encode( $value ) ) // Convert unlisted array type session data to stdClass object |
| 112 | : $value; |
| 113 | } |
| 114 | |
| 115 | return $donation; |
| 116 | } |
| 117 | |
| 118 | /** |
| 119 | * Rename array key in donor info |
| 120 | * |
| 121 | * @since 2.7.0 |
| 122 | * @param array $array |
| 123 | * |
| 124 | * @return array |
| 125 | */ |
| 126 | private function renameKeyInDonorInfo( $array ) { |
| 127 | return ArrayDataSet::renameKeys( |
| 128 | $array, |
| 129 | [ |
| 130 | 'id' => 'wpUserId', |
| 131 | 'title' => 'honorific', |
| 132 | ] |
| 133 | ); |
| 134 | } |
| 135 | |
| 136 | /** |
| 137 | * Filter array keys in card info |
| 138 | * |
| 139 | * @since 2.7.0 |
| 140 | * @param $array |
| 141 | * @return array |
| 142 | */ |
| 143 | private function filterCardInfoKeys( $array ) { |
| 144 | $array = $this->removePrefixFromArrayKeys( $array, [ 'card' ] ); |
| 145 | $array = ArrayDataSet::renameKeys( |
| 146 | $array, |
| 147 | [ |
| 148 | 'address' => 'line1', |
| 149 | 'address2' => 'line2', |
| 150 | ] |
| 151 | ); |
| 152 | $array = ArrayDataSet::moveArrayItemsUnderArrayKey( $array, [ 'line1', 'line2', 'city', 'state', 'country', 'zip' ], 'address' ); |
| 153 | |
| 154 | // Rename zip to postal code. |
| 155 | $array['address']['postalCode'] = $array['address']['zip']; |
| 156 | unset( $array['address']['zip'] ); |
| 157 | |
| 158 | return $array; |
| 159 | } |
| 160 | |
| 161 | /** |
| 162 | * Remove prefix from array key. |
| 163 | * |
| 164 | * @param array $array |
| 165 | * @param array $prefixes |
| 166 | * |
| 167 | * @return array |
| 168 | */ |
| 169 | private function removePrefixFromArrayKeys( $array, $prefixes ) { |
| 170 | foreach ( $array as $key => $value ) { |
| 171 | $newKey = lcfirst( str_replace( (array) $prefixes, '', $key ) ); |
| 172 | |
| 173 | if ( $key !== $newKey ) { |
| 174 | unset( $array[ $key ] ); |
| 175 | } |
| 176 | |
| 177 | if ( is_array( $value ) ) { |
| 178 | $array[ $newKey ] = $this->removePrefixFromArrayKeys( $value, $prefixes ); |
| 179 | continue; |
| 180 | } |
| 181 | |
| 182 | $array[ $newKey ] = $value; |
| 183 | |
| 184 | } |
| 185 | |
| 186 | return $array; |
| 187 | } |
| 188 | } |
| 189 |