DonationReceipt.php
4 years ago
LineItem.php
6 years ago
Receipt.php
6 years ago
Section.php
5 years ago
UpdateReceipt.php
6 years ago
DonationReceipt.php
278 lines
| 1 | <?php |
| 2 | namespace Give\Receipt; |
| 3 | |
| 4 | use Give\Framework\Exceptions\Primitives\InvalidArgumentException; |
| 5 | use function give_get_payment_meta as getDonationMetaData; |
| 6 | use function give_get_gateway_checkout_label as getGatewayLabel; |
| 7 | use function give_get_donation_donor_email as getDonationDonorEmail; |
| 8 | use function give_get_donation_address as getDonationDonorAddress; |
| 9 | use function give_format_amount as formatAmount; |
| 10 | use function give_currency_filter as filterCurrency; |
| 11 | |
| 12 | class DonationReceipt extends Receipt { |
| 13 | /** |
| 14 | * Receipt donor section id. |
| 15 | */ |
| 16 | const DONORSECTIONID = 'Donor'; |
| 17 | |
| 18 | /** |
| 19 | * Receipt donation section id. |
| 20 | */ |
| 21 | const DONATIONSECTIONID = 'Donation'; |
| 22 | |
| 23 | /** |
| 24 | * Receipt additional information section id. |
| 25 | */ |
| 26 | const ADDITIONALINFORMATIONSECTIONID = 'AdditionalInformation'; |
| 27 | |
| 28 | /** |
| 29 | * Donation id. |
| 30 | * |
| 31 | * @since 2.7.0 |
| 32 | * @var int $donationId |
| 33 | */ |
| 34 | public $donationId; |
| 35 | |
| 36 | /** |
| 37 | * Receipt constructor. |
| 38 | * |
| 39 | * @since 2.7.0 |
| 40 | * @param $donationId |
| 41 | */ |
| 42 | public function __construct( $donationId ) { |
| 43 | $this->donationId = $donationId; |
| 44 | |
| 45 | $this->addDonorSection(); |
| 46 | $this->addDonationSection(); |
| 47 | $this->addSection( $this->getAdditionInformationSection() ); // Additional Information Section |
| 48 | } |
| 49 | |
| 50 | /** |
| 51 | * Add donor section. |
| 52 | * |
| 53 | * @since 2.7.0 |
| 54 | */ |
| 55 | private function addDonorSection() { |
| 56 | $billingAddressLineItem = $this->getDonorBillingAddressLineItem(); |
| 57 | $hasAddress = (bool) trim( str_replace( ',', '', strip_tags( $billingAddressLineItem['value'] ) ) ); // Remove formatting from address. |
| 58 | |
| 59 | $section = $this->addSection( $this->getDonorSection() ); |
| 60 | $section->addLineItem( $this->getDonorNameLineItem() ); |
| 61 | $section->addLineItem( $this->getDonorEmailLineItem() ); |
| 62 | |
| 63 | // Add billing address line item only if donor has billing address. |
| 64 | if ( $hasAddress ) { |
| 65 | $section->addLineItem( $billingAddressLineItem ); |
| 66 | } |
| 67 | } |
| 68 | |
| 69 | /** |
| 70 | * Add donation section. |
| 71 | * |
| 72 | * @since 2.7.0 |
| 73 | */ |
| 74 | private function addDonationSection() { |
| 75 | $section = $this->addSection( $this->getDonationSection() ); |
| 76 | $section->addLineItem( $this->getDonationPaymentGatewayLineItem() ); |
| 77 | $section->addLineItem( $this->getDonationStatusLineItem() ); |
| 78 | $section->addLineItem( $this->getDonationAmountLineItem() ); |
| 79 | $section->addLineItem( $this->getDonationTotalAmountLineItem() ); |
| 80 | } |
| 81 | |
| 82 | /** |
| 83 | * Get donor section. |
| 84 | * |
| 85 | * @return array |
| 86 | * @since 2.7.0 |
| 87 | */ |
| 88 | private function getDonorSection() { |
| 89 | return [ |
| 90 | 'id' => self::DONORSECTIONID, |
| 91 | 'label' => esc_html__( 'Donation Details', 'give' ), |
| 92 | ]; |
| 93 | } |
| 94 | |
| 95 | /** |
| 96 | * Get donor name line item. |
| 97 | * |
| 98 | * @return array |
| 99 | * @since 2.7.0 |
| 100 | */ |
| 101 | private function getDonorNameLineItem() { |
| 102 | $firstName = getDonationMetaData( $this->donationId, '_give_donor_billing_first_name', true ); |
| 103 | $lastName = getDonationMetaData( $this->donationId, '_give_donor_billing_last_name', true ); |
| 104 | |
| 105 | return [ |
| 106 | 'id' => 'fullName', |
| 107 | 'label' => esc_html__( 'Donor Name', 'give' ), |
| 108 | 'value' => trim( "{$firstName} {$lastName}" ), |
| 109 | 'icon' => '<i class="fas fa-user"></i>', |
| 110 | ]; |
| 111 | } |
| 112 | |
| 113 | /** |
| 114 | * Get donor email line item. |
| 115 | * |
| 116 | * @return array |
| 117 | * @since 2.7.0 |
| 118 | */ |
| 119 | private function getDonorEmailLineItem() { |
| 120 | return [ |
| 121 | 'id' => 'emailAddress', |
| 122 | 'label' => esc_html__( 'Email Address', 'give' ), |
| 123 | 'value' => getDonationDonorEmail( $this->donationId ), |
| 124 | 'icon' => '<i class="fas fa-envelope"></i>', |
| 125 | ]; |
| 126 | } |
| 127 | |
| 128 | /** |
| 129 | * Get donor address line item. |
| 130 | * |
| 131 | * @return array |
| 132 | * @since 2.7.0 |
| 133 | */ |
| 134 | private function getDonorBillingAddressLineItem() { |
| 135 | $address = getDonationDonorAddress( $this->donationId ); |
| 136 | $address = sprintf( |
| 137 | '%1$s%7$s%2$s%3$s, %4$s%5$s%7$s%6$s', |
| 138 | $address['line1'], |
| 139 | ! empty( $address['line2'] ) ? $address['line2'] . "\r\n" : '', |
| 140 | $address['city'], |
| 141 | $address['state'], |
| 142 | $address['zip'], |
| 143 | $address['country'], |
| 144 | "\r\n" |
| 145 | ); |
| 146 | |
| 147 | return [ |
| 148 | 'id' => 'billingAddress', |
| 149 | 'label' => esc_html__( 'Billing Address', 'give' ), |
| 150 | 'value' => $address, |
| 151 | 'icon' => '<i class="fas fa-globe-americas"></i>', |
| 152 | ]; |
| 153 | } |
| 154 | |
| 155 | /** |
| 156 | * Get donor section. |
| 157 | * |
| 158 | * @return array |
| 159 | * @since 2.7.0 |
| 160 | */ |
| 161 | private function getDonationSection() { |
| 162 | return [ |
| 163 | 'id' => self::DONATIONSECTIONID, |
| 164 | ]; |
| 165 | } |
| 166 | |
| 167 | /** |
| 168 | * Get donation payment gateway line ite. |
| 169 | * |
| 170 | * @return array |
| 171 | * @since 2.7.0 |
| 172 | */ |
| 173 | private function getDonationPaymentGatewayLineItem() { |
| 174 | return [ |
| 175 | 'id' => 'paymentMethod', |
| 176 | 'label' => esc_html__( 'Payment Method', 'give' ), |
| 177 | 'value' => getGatewayLabel( getDonationMetaData( $this->donationId, '_give_payment_gateway', true ) ), |
| 178 | ]; |
| 179 | } |
| 180 | |
| 181 | /** |
| 182 | * Get donation status line item. |
| 183 | * |
| 184 | * @return array |
| 185 | * @since 2.7.0 |
| 186 | */ |
| 187 | private function getDonationStatusLineItem() { |
| 188 | return [ |
| 189 | 'id' => 'paymentStatus', |
| 190 | 'label' => esc_html__( 'Payment Status', 'give' ), |
| 191 | 'value' => give_get_payment_statuses()[ get_post_status( $this->donationId ) ], |
| 192 | ]; |
| 193 | } |
| 194 | |
| 195 | /** |
| 196 | * Get donation amount line item. |
| 197 | * |
| 198 | * @return array |
| 199 | * @since 2.7.0 |
| 200 | */ |
| 201 | private function getDonationAmountLineItem() { |
| 202 | $value = filterCurrency( |
| 203 | formatAmount( getDonationMetaData( $this->donationId, '_give_payment_total', true ), [ 'donation_id' => $this->donationId ] ), |
| 204 | [ |
| 205 | 'currency_code' => getDonationMetaData( $this->donationId, '_give_payment_currency', true ), |
| 206 | 'decode_currency' => true, |
| 207 | 'form_id' => getDonationMetaData( $this->donationId, '_give_payment_form_id', true ), |
| 208 | ] |
| 209 | ); |
| 210 | |
| 211 | return [ |
| 212 | 'id' => 'amount', |
| 213 | 'label' => esc_html__( 'Donation Amount', 'give' ), |
| 214 | 'value' => $value, |
| 215 | ]; |
| 216 | } |
| 217 | |
| 218 | /** |
| 219 | * Get donation total amount line item. |
| 220 | * |
| 221 | * @return array |
| 222 | * @since 2.7.0 |
| 223 | */ |
| 224 | private function getDonationTotalAmountLineItem() { |
| 225 | $value = filterCurrency( |
| 226 | formatAmount( getDonationMetaData( $this->donationId, '_give_payment_total', true ), [ 'donation_id' => $this->donationId ] ), |
| 227 | [ |
| 228 | 'currency_code' => getDonationMetaData( $this->donationId, '_give_payment_currency', true ), |
| 229 | 'decode_currency' => true, |
| 230 | 'form_id' => getDonationMetaData( $this->donationId, '_give_payment_form_id', true ), |
| 231 | ] |
| 232 | ); |
| 233 | |
| 234 | return [ |
| 235 | 'id' => 'totalAmount', |
| 236 | 'label' => esc_html__( 'Donation Total', 'give' ), |
| 237 | 'value' => $value, |
| 238 | ]; |
| 239 | } |
| 240 | |
| 241 | /** |
| 242 | * Get additional information section. |
| 243 | * |
| 244 | * @return array |
| 245 | * @since 2.7.0 |
| 246 | */ |
| 247 | private function getAdditionInformationSection() { |
| 248 | return [ |
| 249 | 'id' => self::ADDITIONALINFORMATIONSECTIONID, |
| 250 | 'label' => esc_html__( 'Additional Information', 'give' ), |
| 251 | ]; |
| 252 | } |
| 253 | |
| 254 | /** |
| 255 | * Set iterator position to zero when rewind. |
| 256 | * |
| 257 | * @since 2.7.0 |
| 258 | */ |
| 259 | public function rewind() { |
| 260 | $this->position = 0; |
| 261 | } |
| 262 | |
| 263 | /** |
| 264 | * Validate section. |
| 265 | * |
| 266 | * @param array $array |
| 267 | * @since 2.7.0 |
| 268 | */ |
| 269 | protected function validateSection( $array ) { |
| 270 | $required = [ 'id' ]; |
| 271 | $array = array_filter( $array ); // Remove empty values. |
| 272 | |
| 273 | if ( array_diff( $required, array_keys( $array ) ) ) { |
| 274 | throw new InvalidArgumentException( esc_html__( 'Invalid receipt section. Please provide valid section id', 'give' ) ); |
| 275 | } |
| 276 | } |
| 277 | } |
| 278 |