DonationReceipt.php — GiveWP – Donation Plugin and Fundraising Platform 2.22.3

give / src / Receipt / DonationReceipt.php

give / src / Receipt Last commit date

DonationReceipt.php 4 years ago LineItem.php 4 years ago Receipt.php 4 years ago Section.php 4 years ago UpdateReceipt.php 4 years ago

DonationReceipt.php

209 lines

1	<?php
2
3	namespace Give\Receipt;
4
5	use Give\Framework\Exceptions\Primitives\InvalidArgumentException;
6	use Give_Payment;
7
8	class DonationReceipt extends Receipt
9	{
10	/**
11	* Receipt donor section id.
12	*/
13	const DONORSECTIONID = 'Donor';
14
15	/**
16	* Receipt donation section id.
17	*/
18	const DONATIONSECTIONID = 'Donation';
19
20	/**
21	* Receipt additional information section id.
22	*/
23	const ADDITIONALINFORMATIONSECTIONID = 'AdditionalInformation';
24
25	/**
26	* Donation id.
27	*
28	* @since 2.7.0
29	* @var int $donationId
30	*/
31	public $donationId;
32
33	/**
34	* @var Give_Payment
35	* @since 2.18.0
36	*/
37	protected $donation;
38
39	/**
40	* Receipt constructor.
41	*
42	* @param $donationId
43	*
44	* @since 2.7.0
45	*/
46	public function __construct($donationId)
47	{
48	$this->donationId = $donationId;
49	$this->donation = new Give_Payment($donationId);
50
51	$this->addDonorSection();
52	$this->addDonationSection();
53	$this->addAdditionalInformationSection();
54	}
55
56	/**
57	* Add donor section.
58	*
59	* @since 2.7.0
60	*/
61	private function addDonorSection()
62	{
63	$donorSection = $this->addSection([
64	'id' => self::DONORSECTIONID,
65	'label' => esc_html__('Donor Details', 'give'),
66	]);
67
68	$donorSection->addLineItem([
69	'id' => 'fullName',
70	'label' => esc_html__('Donor Name', 'give'),
71	'value' => trim("{$this->donation->first_name} {$this->donation->last_name}"),
72	'icon' => '<i class="fas fa-user"></i>',
73	]);
74
75	$donorSection->addLineItem([
76	'id' => 'emailAddress',
77	'label' => esc_html__('Email Address', 'give'),
78	'value' => $this->donation->email,
79	'icon' => '<i class="fas fa-envelope"></i>',
80	]);
81
82	if ($address = $this->getDonorBillingAddress()) {
83	$donorSection->addLineItem([
84	'id' => 'billingAddress',
85	'label' => esc_html__('Billing Address', 'give'),
86	'value' => $address,
87	'icon' => '<i class="fas fa-globe-americas"></i>',
88	]);
89	}
90	}
91
92	/**
93	* Add donation section.
94	*
95	* @since 2.7.0
96	*/
97	private function addDonationSection()
98	{
99	$donationSection = $this->addSection([
100	'id' => self::DONATIONSECTIONID,
101	'label' => esc_html__('Donation Details', 'give'),
102	]);
103
104	$donationSection->addLineItem([
105	'id' => 'paymentStatus',
106	'label' => esc_html__('Payment Status', 'give'),
107	'value' => give_get_payment_statuses()[ $this->donation->post_status ],
108	]);
109
110	$donationSection->addLineItem([
111	'id' => 'paymentMethod',
112	'label' => esc_html__('Payment Method', 'give'),
113	'value' => give_get_gateway_checkout_label($this->donation->gateway),
114	]);
115
116	$donationSection->addLineItem([
117	'id' => 'amount',
118	'label' => esc_html__('Donation Amount', 'give'),
119	'value' => give_currency_filter(
120	give_format_amount($this->donation->total, [ 'donation_id' => $this->donation->ID ]),
121	[
122	'currency_code' => $this->donation->currency,
123	'form_id' => $this->donation->form_id,
124	'decode_currency' => true,
125	]
126	),
127	]);
128
129	$donationSection->addLineItem([
130	'id' => 'totalAmount',
131	'label' => esc_html__('Donation Total', 'give'),
132	'value' => give_currency_filter(
133	give_format_amount($this->donation->total, [ 'donation_id' => $this->donation->ID ]),
134	[
135	'currency_code' => $this->donation->currency,
136	'form_id' => $this->donation->form_id,
137	'decode_currency' => true,
138	]
139	),
140	]);
141	}
142
143	/**
144	* Add Additional Information Section
145	*/
146	private function addAdditionalInformationSection()
147	{
148	$this->addSection([
149	'id' => self::ADDITIONALINFORMATIONSECTIONID,
150	'label' => esc_html__('Additional Information', 'give'),
151	]);
152	}
153
154	/**
155	* Get donor billing address
156	*
157	* @return string\|null
158	*/
159	private function getDonorBillingAddress()
160	{
161	$address = give_get_donation_address($this->donationId);
162	$formatted = sprintf(
163	'%1$s%7$s%2$s%3$s, %4$s%5$s%7$s%6$s',
164	$address[ 'line1' ],
165	! empty($address[ 'line2' ]) ? $address[ 'line2' ] . "\r\n" : '',
166	$address[ 'city' ],
167	$address[ 'state' ],
168	$address[ 'zip' ],
169	$address[ 'country' ],
170	"\r\n"
171	);
172
173	$hasAddress = (bool) trim(str_replace(',', '', strip_tags($formatted)));
174
175	if ($hasAddress) {
176	return $formatted;
177	}
178
179	return null;
180	}
181
182	/**
183	* Set iterator position to zero when rewind.
184	*
185	* @since 2.7.0
186	*/
187	public function rewind()
188	{
189	$this->position = 0;
190	}
191
192	/**
193	* Validate section.
194	*
195	* @param array $array
196	*
197	* @since 2.7.0
198	*/
199	protected function validateSection($array)
200	{
201	$required = [ 'id' ];
202	$array = array_filter($array); // Remove empty values.
203
204	if (array_diff($required, array_keys($array))) {
205	throw new InvalidArgumentException(esc_html__('Invalid receipt section. Please provide valid section id', 'give'));
206	}
207	}
208	}
209