give / src / MultiFormGoals / ProgressBar / Model.php

Model.php in GiveWP – Donation Plugin and Fundraising Platform 4.16.8.1, at src/MultiFormGoals/ProgressBar/Model.php

351 lines 8.2 KB

Raw Download Zip

1	<?php
2
3	namespace Give\MultiFormGoals\ProgressBar;
4
5	use Give\DonationForms\DonationQuery;
6
7	/**
8	* @since 3.16.0 Add $statusList property
9	* @since 2.9.0
10	*/
11	class Model
12	{
13
14	// Settings
15	protected $ids;
16	protected $tags;
17	protected $categories;
18	protected $goal;
19	protected $enddate;
20	protected $color;
21
22	// Internal
23	protected $forms = [];
24	protected $donationRevenueResults;
25
26	protected $statusList = [];
27
28	/**
29	* Constructs and sets up setting variables for a new Progress Bar model
30	*
31	* @since 3.16.0 Add statusList support for $args
32	* @since 2.9.0
33	**@param array $args Arguments for new Progress Bar, including 'ids'
34	*/
35	public function __construct(array $args)
36	{
37	isset($args['ids']) ? $this->ids = $args['ids'] : $this->ids = [];
38	isset($args['tags']) ? $this->tags = $args['tags'] : $this->tags = [];
39	isset($args['categories']) ? $this->categories = $args['categories'] : $this->categories = [];
40	isset($args['goal']) ? $this->goal = $args['goal'] : $this->goal = '1000';
41	isset($args['enddate']) ? $this->enddate = $args['enddate'] : $this->enddate = '';
42	isset($args['color']) ? $this->color = $args['color'] : $this->color = '#28c77b';
43	isset($args['statusList']) ? $this->statusList = $args['statusList'] : $this->statusList = ['publish'];
44	}
45
46	/**
47	* Get forms associated with Progress Bar
48	*
49	* @since 3.16.0 Use $statusList property
50	* @since 3.0.3 Return empty array instead of false
51	* @since 2.9.0
52	*/
53	public function getForms(): array
54	{
55	if ( ! empty($this->forms)) {
56	return $this->forms;
57	}
58
59	$query_args = [
60	'post_type' => 'give_forms',
61	'post_status' => $this->statusList,
62	'post__in' => $this->ids,
63	'posts_per_page' => -1,
64	'fields' => 'ids',
65	'tax_query' => [
66	'relation' => 'AND',
67	],
68	];
69
70	if ( ! empty($this->tags)) {
71	$query_args['tax_query'][] = [
72	'taxonomy' => 'give_forms_tag',
73	'terms' => $this->tags,
74	];
75	}
76
77	if ( ! empty($this->categories)) {
78	$query_args['tax_query'][] = [
79	'taxonomy' => 'give_forms_category',
80	'terms' => $this->categories,
81	];
82	}
83
84	$query = new \WP_Query($query_args);
85
86	if ($query->posts) {
87	$this->forms = $query->posts;
88
89	return $query->posts;
90	} else {
91	return [];
92	}
93	}
94
95	/**
96	* @since 2.9.0
97	*/
98	public function getDonations(): array
99	{
100	$query_args = [
101	'post_status' => [
102	'publish',
103	'give_subscription',
104	],
105	'number' => -1,
106	'give_forms' => $this->getForms(),
107	];
108	$query = new \Give_Payments_Query($query_args);
109
110	return $query->get_payments();
111	}
112
113	/**
114	* Get output markup for Progress Bar
115	*
116	* @since 2.9.0
117	*/
118	public function getOutput(): string
119	{
120	ob_start();
121	$output = '';
122	require $this->getTemplatePath();
123	return ob_get_clean();
124	}
125
126	/**
127	* Returns query results for Donation Revenue.
128	* @since 2.9.0
129	* @return stdClass seem MultiFormGoals/ProgressBar/Query.php
130	*/
131	public function getDonationRevenueResults()
132	{
133	if ( ! $this->donationRevenueResults) {
134	$query = new Query($this->getForms());
135	$this->donationRevenueResults = $query->getResults();
136	}
137
138	return $this->donationRevenueResults;
139	}
140
141	/**
142	* Get raw earnings value for Progress Bar
143	*
144	* @since 3.12.0 use DonationQuery
145	* @since 2.9.0
146	*/
147	public function getTotal(): string
148	{
149	return (new DonationQuery())->forms($this->getForms())->sumIntendedAmount();
150	}
151
152	/**
153	* Get number of donations for Progress Bar
154	*
155	* @since 2.9.0
156	*/
157	public function getDonationCount(): int
158	{
159	$results = $this->getDonationRevenueResults();
160
161	return $results->count;
162	}
163
164	/**
165	* Get formatted number of donations
166	*
167	* @since 3.19.1
168	*/
169	public function getFormattedDonationCount(): string
170	{
171	return give_format_amount(
172	$this->getDonationCount(),
173	[
174	'sanitize' => false,
175	'decimal' => false,
176	'currency' => false,
177	]
178	);
179	}
180
181	/**
182	* Get formatted total remaining (ex: $75)
183	*
184	* @since 2.9.0
185	*/
186	protected function getFormattedTotalRemaining()
187	{
188	$total_remaining = ($this->getGoal() - $this->getTotal()) > 0 ? ($this->getGoal() - $this->getTotal()) : 0;
189
190	return give_currency_filter(
191	give_format_amount(
192	$total_remaining,
193	[
194	'sanitize' => false,
195	'decimal' => false,
196	]
197	)
198	);
199	}
200
201	/**
202	* Get goal for Progress Bar
203	*
204	* @since 2.9.0
205	*/
206	public function getGoal(): string
207	{
208	return $this->goal;
209	}
210
211	/**
212	* Get goal color for Progress Bar
213	*
214	* @since 2.9.0
215	*/
216	public function getColor(): string
217	{
218	return $this->color;
219	}
220
221	/**
222	* Get template path for Progress Bar component template
223	* @since 2.9.0
224	**/
225	public function getTemplatePath()
226	{
227	return GIVE_PLUGIN_DIR . '/src/MultiFormGoals/resources/views/progressbar.php';
228	}
229
230	/**
231	* @since 2.24.0
232	*
233	* @return mixed\|string
234	*/
235	public function getFormattedTotal()
236	{
237	return give_currency_filter(
238	give_format_amount(
239	$this->getTotal(),
240	[
241	'sanitize' => false,
242	'decimal' => false,
243	]
244	)
245	);
246	}
247
248	/**
249	* @since 2.24.0
250	*
251	* @return mixed\|string
252	*/
253	public function getFormattedGoal()
254	{
255	return give_currency_filter(
256	give_format_amount(
257	$this->getGoal(),
258	[
259	'sanitize' => false,
260	'decimal' => false,
261	]
262	)
263	);
264	}
265
266	/**
267	* Get end date for Progress Bar
268	*
269	* @since 2.9.0
270	*/
271	public function getEndDate(): string
272	{
273	return $this->enddate;
274	}
275
276	/**
277	* Get minutes remaining before Progress Bar end date
278	*
279	* @since 2.9.0
280	*/
281	public function getMinutesRemaining(): string
282	{
283	$enddate = strtotime($this->getEndDate());
284	if ($enddate) {
285	$now = current_time('timestamp', false);
286
287	return $now < $enddate ? ($enddate - $now) / 60 : 0;
288	} else {
289	return false;
290	}
291	}
292
293	/**
294	* Get time remaining before Progress Bar end date
295	*
296	* @since 2.9.0
297	*
298	* @return float\|int
299	*/
300	public function getTimeToGo()
301	{
302	$minutes = $this->getMinutesRemaining();
303
304	switch ($minutes) {
305	case $minutes > 1440:
306	{
307	return round($minutes / 1440);
308	}
309	case $minutes < 1440 && $minutes > 60:
310	{
311	return round($minutes / 60);
312	}
313	case $minutes < 60:
314	{
315	return round($minutes);
316	}
317	default:
318	{
319	return 0;
320	}
321	}
322	}
323
324	/**
325	* Get time remaining before Progress Bar end date
326	*
327	* @since 2.9.0
328	*/
329	public function getTimeToGoLabel(): string
330	{
331	$minutes = $this->getMinutesRemaining();
332
333	switch ($minutes) {
334	case $minutes > 1440:
335	{
336	return _n('day to go', 'days to go', $this->getTimeToGo(), 'give');
337	}
338	case $minutes < 1440 && $minutes > 60:
339	{
340	return _n('hour to go', 'hours to go', $this->getTimeToGo(), 'give');
341	}
342	case $minutes < 60:
343	{
344	return _n('minute to go', 'minutes to go', $this->getTimeToGo(), 'give');
345	}
346	default:
347	return '';
348	}
349	}
350	}
351