give / src / Tracking / TrackingData / DonationFormsData.php

DonationFormsData.php in GiveWP – Donation Plugin and Fundraising Platform 4.16.8.1, at src/Tracking/TrackingData/DonationFormsData.php

267 lines 7.1 KB

Raw Download Zip

1	<?php
2
3	namespace Give\Tracking\TrackingData;
4
5	use Give\DonationForms\Models\DonationForm;
6	use Give\Framework\Database\DB;
7	use Give\Helpers\ArrayDataSet;
8	use Give\Helpers\Form\Template;
9	use Give\Helpers\Form\Utils;
10	use Give\Tracking\Contracts\TrackData;
11	use Give\Tracking\Helpers\DonationStatuses;
12	use Give\Tracking\Helpers\FormBlocks;
13	use Give\Tracking\Repositories\TrackEvents;
14
15	/**
16	* Class DonationFormsData
17	*
18	* Represents donation forms data
19	*
20	* @package Give\Tracking\TrackingData
21	* @since 2.10.0
22	*/
23	class DonationFormsData implements TrackData
24	{
25	protected $formIds = [];
26	protected $formRevenues = [];
27	protected $formDonorCounts = [];
28
29	/**
30	* @var TrackEvents
31	*/
32	protected $trackEvents;
33
34	/**
35	* DonationFormsData constructor.
36	*
37	* @param TrackEvents $trackEvents
38	*/
39	public function __construct(TrackEvents $trackEvents)
40	{
41	$this->trackEvents = $trackEvents;
42	}
43
44	/**
45	* @inheritdoc
46	*/
47	public function get()
48	{
49	$this->setFormIds();
50
51	if (! $this->formIds) {
52	return [];
53	}
54
55	$this->setRevenues()
56	->setDonorCounts();
57
58	return $this->getData();
59	}
60
61	/**
62	* Get forms data.
63	*
64	* @since 3.10.0 Add check for event block.
65	* @since 3.0.0 Add support for v3 forms
66	* @since 2.10.0
67	* @return array
68	*/
69	protected function getData()
70	{
71	if (! $this->formIds) {
72	return [];
73	}
74
75	$data = [];
76
77	foreach ($this->formIds as $formId) {
78	$temp = [
79	'form_id' => (int)$formId,
80	'form_url' => untrailingslashit(get_permalink($formId)),
81	'form_name' => get_post_field('post_name', $formId, 'db'),
82	'form_type' => give()->form_meta->get_meta($formId, '_give_price_option', true),
83	'form_template' => $this->getFormTemplate($formId),
84	'donor_count' => $this->formDonorCounts[$formId],
85	'revenue' => $this->formRevenues[$formId],
86	'event_block' => (int) FormBlocks::formId($formId)->hasBlock('givewp/event-tickets'),
87	];
88	$this->addAddonsInformation($temp, $formId);
89	$data[] = $temp;
90	}
91
92	return $data;
93	}
94
95	/**
96	* Set form ids.
97	*
98	* @since 2.10.0
99	* @return self
100	*/
101	protected function setFormIds()
102	{
103	global $wpdb;
104
105	$statues = DonationStatuses::getCompletedDonationsStatues(true);
106	$time = $this->trackEvents->getRequestTime();
107
108	$this->formIds = DB::get_col(
109	"
110	SELECT DISTINCT dm.meta_value
111	FROM {$wpdb->donationmeta} as dm
112	INNER JOIN {$wpdb->posts} as p ON dm.donation_id = p.ID
113	INNER JOIN {$wpdb->donationmeta} as dm2 ON dm.donation_id = dm2.donation_id
114	WHERE p.post_status IN ({$statues})
115	AND p.post_date>='{$time}'
116	AND p.post_type='give_payment'
117	AND dm2.meta_key='_give_payment_mode'
118	AND dm2.meta_value='live'
119	AND dm.meta_key='_give_payment_form_id'
120	"
121	);
122
123	return $this;
124	}
125
126	/**
127	* Set forms revenues.
128	*
129	* @since 2.10.0
130	* @return self
131	*/
132	protected function setRevenues()
133	{
134	global $wpdb;
135
136	$formIds = ArrayDataSet::getStringSeparatedByCommaEnclosedWithSingleQuote($this->formIds);
137	$defaultResult = array_combine(
138	$this->formIds,
139	array_fill(0, count($this->formIds), 0) // Set default revenue to 0
140	);
141
142	$result = DB::get_results(
143	"
144	SELECT SUM(r.amount) as amount, r.form_id
145	FROM {$wpdb->give_revenue} as r
146	INNER JOIN {$wpdb->donationmeta} as dm ON r.donation_id = dm.donation_id
147	WHERE dm.meta_key='_give_payment_mode'
148	AND dm.meta_value='live'
149	AND r.form_id IN ({$formIds})
150	GROUP BY form_id
151	",
152	ARRAY_A
153	);
154
155	if ($result) {
156	$result = array_map(
157	'absint',
158	array_combine(
159	wp_list_pluck($result, 'form_id'),
160	wp_list_pluck($result, 'amount')
161	)
162	);
163	}
164
165	$this->formRevenues = array_replace($defaultResult, $result);
166
167	return $this;
168	}
169
170	/**
171	* Set forms revenues till current date.
172	*
173	* @since 2.10.0
174	*
175	* @return self
176	*/
177	protected function setDonorCounts()
178	{
179	global $wpdb;
180
181	$formIds = ArrayDataSet::getStringSeparatedByCommaEnclosedWithSingleQuote($this->formIds);
182	$statues = DonationStatuses::getCompletedDonationsStatues(true);
183	$defaultResult = array_combine(
184	$this->formIds,
185	array_fill(0, count($this->formIds), 0) // Set default donor count to 0
186	);
187
188	$result = DB::get_results(
189	"
190	SELECT COUNT(DISTINCT dm2.meta_value) as donor_count, dm.meta_value as form_id
191	FROM {$wpdb->donationmeta} as dm
192	INNER JOIN {$wpdb->posts} as p ON donation_id = p.ID
193	INNER JOIN {$wpdb->donationmeta} as dm2 ON dm.donation_id = dm2.donation_id
194	INNER JOIN {$wpdb->donors} as donor ON dm2.meta_value = donor.id
195	INNER JOIN {$wpdb->donationmeta} as dm3 ON dm.donation_id = dm3.donation_id
196	WHERE p.post_status IN ({$statues})
197	AND dm3.meta_key='_give_payment_mode'
198	AND dm3.meta_value='live'
199	AND dm.meta_key='_give_payment_form_id'
200	AND dm.meta_value IN ({$formIds})
201	AND dm2.meta_key='_give_payment_donor_id'
202	AND donor.purchase_value > 0
203	GROUP BY dm.meta_value
204	",
205	ARRAY_A
206	);
207
208	if ($result) {
209	$result = array_map(
210	'absint',
211	array_combine(
212	wp_list_pluck($result, 'form_id'),
213	wp_list_pluck($result, 'donor_count')
214	)
215	);
216	}
217
218	$this->formDonorCounts = array_replace($defaultResult, $result);
219
220	return $this;
221	}
222
223	/**
224	* Add addon information whether or not they active for donation form.
225	*
226	* @since 2.10.0
227	*
228	* @param array $array
229	* @param int $formId
230	*/
231	private function addAddonsInformation(&$array, $formId)
232	{
233	$array = array_merge(
234	$array,
235	[
236	'recurring_donations' => (int)apply_filters('give_telemetry_form_uses_addon_recurring', false, $formId),
237	'fee_recovery' => (int)apply_filters('give_telemetry_form_uses_addon_fee_recovery', false, $formId),
238	'form_field_manager' => (int)apply_filters(
239	'give_telemetry_form_uses_addon_form_field_manager',
240	false,
241	$formId
242	),
243	]
244	);
245	}
246
247	/**
248	* This function is used to get the form template.
249	*
250	* @since 3.0.0
251	*/
252	private function getFormTemplate(int $formId): string
253	{
254	if (Utils::isV3Form($formId)) {
255	/* @var DonationForm $form */
256	$form = DonationForm::find($formId);
257
258	return $form->settings->designId . ' (V3)';
259	}
260
261	$formTemplate = Template::getActiveID($formId);
262	return ( ! $formTemplate \|\| 'legacy' === $formTemplate )
263	? 'legacy'
264	: $formTemplate;
265	}
266	}
267