DonorStatisticsQuery.php — GiveWP – Donation Plugin and Fundraising Platform 4.4.0

give / src / Donors / DonorStatisticsQuery.php

give / src / Donors Last commit date

Actions 1 year ago CustomFields 1 year ago DataTransferObjects 1 year ago Endpoints 1 year ago Exceptions 2 years ago Factories 1 year ago ListTable 1 year ago Migrations 1 year ago Models 1 year ago Repositories 1 year ago ValueObjects 1 year ago ViewModels 1 year ago resources 1 year ago DonorStatisticsQuery.php 1 year ago DonorsAdminPage.php 1 year ago DonorsQuery.php 1 year ago ServiceProvider.php 1 year ago

DonorStatisticsQuery.php

230 lines

1	<?php
2
3	namespace Give\Donors;
4
5	use Give\Campaigns\Models\Campaign;
6	use Give\Donations\ValueObjects\DonationMetaKeys;
7	use Give\Donors\Models\Donor;
8	use Give\Donors\Repositories\DonorRepository;
9	use Give\Framework\QueryBuilder\JoinQueryBuilder;
10	use Give\Framework\QueryBuilder\QueryBuilder;
11	use Give\Donors\ValueObjects\DonorType;
12
13	/**
14	* @since 4.4.0
15	*/
16	class DonorStatisticsQuery extends QueryBuilder
17	{
18	/**
19	* @since 4.4.0
20	*/
21	private Donor $donor;
22
23	/**
24	* @since 4.4.0
25	*/
26	public function __construct(Donor $donor, $mode = '')
27	{
28	$this->donor = $donor;
29
30	$this->from('posts', 'donation');
31	$this->where('post_type', 'give_payment');
32
33	// Include only valid statuses
34	$this->whereIn('donation.post_status', ['publish', 'give_subscription']);
35
36	// Include only current payment "mode"
37	if (empty($mode)) {
38	$mode = give_is_test_mode() ? 'test' : 'live';
39	}
40	$this->joinDonationMeta(DonationMetaKeys::MODE, 'paymentMode');
41	$this->where('paymentMode.meta_value', $mode);
42
43	// Include only donations associated with the Donor.
44	$this->joinDonationMeta(DonationMetaKeys::DONOR_ID, 'donorId');
45	$this->where('donorId.meta_value', $donor->id);
46
47	$this->joinDonationMeta(DonationMetaKeys::AMOUNT, 'amount');
48	$this->joinDonationMeta(DonationMetaKeys::FEE_AMOUNT_RECOVERED, 'feeAmountRecovered');
49	}
50
51	/**
52	* @since 4.4.0
53	*/
54	public function filterByCampaign(Campaign $campaign): self
55	{
56	$query = clone $this;
57
58	$query->joinDonationMeta(DonationMetaKeys::CAMPAIGN_ID, 'campaignId');
59	$query->where('campaignId.meta_value', $campaign->id);
60
61	return $query;
62	}
63
64	/**
65	* @since 4.4.0
66	*
67	* @return int\|float
68	*/
69	public function getLifetimeDonationsAmount()
70	{
71	$query = clone $this;
72
73	return $query->sum(
74	'IFNULL(amount.meta_value, 0) - IFNULL(feeAmountRecovered.meta_value, 0)'
75	);
76	}
77
78	/**
79	* @since 4.4.0
80	*/
81	public function getHighestDonationAmount()
82	{
83	$query = clone $this;
84
85	$query->select('IFNULL(amount.meta_value, 0) - IFNULL(feeAmountRecovered.meta_value, 0) as highestDonationAmount');
86	$query->orderBy('CAST(amount.meta_value AS DECIMAL)', 'DESC');
87	$query->limit(1);
88	$result = $query->get();
89
90	if ( ! $result) {
91	return null;
92	}
93
94	return (float)$result->highestDonationAmount;
95	}
96
97	/**
98	* @since 4.4.0
99	*/
100	public function getAverageDonationAmount()
101	{
102	$query = clone $this;
103
104	$donationsCount = $this->getDonationsCount();
105	$lifetimeDonationsAmount = $query->getLifetimeDonationsAmount();
106
107	return $donationsCount > 0 ? $lifetimeDonationsAmount / $donationsCount : $lifetimeDonationsAmount;
108	}
109
110	/**
111	* @since 4.4.0
112	*/
113	public function getDonationsCount(): int
114	{
115	$query = clone $this;
116
117	return $query->count('donation.ID');
118	}
119
120
121	/**
122	* @since 4.4.0
123	*/
124	public function getFirstDonation()
125	{
126	$query = clone $this;
127	$query->select(
128	'donation.post_date',
129	'IFNULL(amount.meta_value, 0) - IFNULL(feeAmountRecovered.meta_value, 0) as amount'
130	);
131	$query->orderBy('post_date', 'ASC');
132	$query->limit(1);
133	$result = $query->get();
134
135	if (!$result) {
136	return null;
137	}
138
139	return [
140	'amount' => (float)$result->amount,
141	'date' => date('Y-m-d H:i:s', strtotime($result->post_date))
142	];
143	}
144
145	/**
146	* @since 4.4.0
147	*/
148	public function getLastDonation()
149	{
150	$query = clone $this;
151	$query->select(
152	'donation.post_date',
153	'IFNULL(amount.meta_value, 0) - IFNULL(feeAmountRecovered.meta_value, 0) as amount'
154	);
155	$query->orderBy('post_date', 'DESC');
156	$query->limit(1);
157	$result = $query->get();
158
159	if (!$result) {
160	return null;
161	}
162
163	return [
164	'amount' => (float)$result->amount,
165	'date' => date('Y-m-d H:i:s', strtotime($result->post_date)),
166	];
167	}
168
169	/**
170	* @since 4.4.0
171	*/
172	public function getDonorType()
173	{
174	$donorRepository = give(DonorRepository::class);
175	$donorType = $donorRepository->getDonorType($this->donor->id);
176
177	if (!$donorType) {
178	return null;
179	}
180
181	switch ($donorType->getValue()) {
182	case DonorType::NEW:
183	return __('No Donations', 'give');
184	case DonorType::SUBSCRIBER:
185	return __('Subscriber', 'give');
186	case DonorType::REPEAT:
187	return __('Repeat', 'give');
188	case DonorType::SINGLE:
189	return __('One-time', 'give');
190	default:
191	return $donorType->label();
192	}
193	}
194
195	/**
196	* @since 4.4.0
197	*/
198	public function preferredPaymentMethod(): string
199	{
200	$query = clone $this;
201	$query->joinDonationMeta(DonationMetaKeys::GATEWAY, 'gateway');
202	$query->select('gateway.meta_value as gateway');
203	$query->groupBy('gateway.meta_value');
204	$query->orderBy('COUNT(gateway.meta_value)', 'DESC');
205	$query->limit(1);
206	$result = $query->get();
207
208	if (!$result) {
209	return '';
210	}
211
212	return give_get_gateway_checkout_label($result->gateway) ?? $result->gateway;
213	}
214
215	/**
216	* @since 4.4.0
217	*/
218	public function joinDonationMeta($key, $alias): self
219	{
220	$this->join(function (JoinQueryBuilder $builder) use ($key, $alias) {
221	$builder
222	->leftJoin('give_donationmeta', $alias)
223	->on('donation.ID', $alias . '.donation_id')
224	->andOn($alias . '.meta_key', $key, true);
225	});
226
227	return $this;
228	}
229	}
230