give / src / FormBuilder / BlockModels / DonationAmountBlockModel.php

DonationAmountBlockModel.php in GiveWP – Donation Plugin and Fundraising Platform 4.16.9, at src/FormBuilder/BlockModels/DonationAmountBlockModel.php

296 lines 7.4 KB

Raw Download Zip

1	<?php
2
3	namespace Give\FormBuilder\BlockModels;
4
5	use Give\Framework\Blocks\BlockModel;
6	use Give\Subscriptions\ValueObjects\SubscriptionPeriod;
7
8	/**
9	* This is a decorator for the Block Model block "givewp/donation-amount".
10	*
11	* @since 3.0.0
12	*/
13	class DonationAmountBlockModel
14	{
15	/**
16	* @var BlockModel
17	*/
18	public $block;
19
20	/**
21	* @since 3.0.0
22	*/
23	public function __construct(BlockModel $block)
24	{
25	$this->block = $block;
26	}
27
28	/**
29	* @since 3.0.0
30	*/
31	public function getAttribute($name)
32	{
33	return $this->block->getAttribute($name);
34	}
35
36	/**
37	* @since 3.0.0
38	*/
39	public function hasAttribute($name): bool
40	{
41	return $this->block->hasAttribute($name);
42	}
43
44	/**
45	* @since 3.0.0
46	*/
47	public function setAttribute(string $name, $value): self
48	{
49	$this->block->setAttribute($name, $value);
50
51	return $this;
52	}
53
54	/**
55	* @since 3.0.0
56	*/
57	public function getLabel(): string
58	{
59	return $this->block->getAttribute('label');
60	}
61
62	/**
63	* @since 3.12.0 Changed the return type to an array of OptionsProps
64	* @since 3.0.0
65	*
66	* @return array ['label' => string, 'value' => string, 'checked' => bool][]
67	*/
68	public function getLevels(): array
69	{
70	return array_map(static function ($level) {
71	return [
72	'label' => htmlspecialchars($level['label'] ?? ''),
73	'value' => (float)filter_var(
74	$level['value'] ?? '',
75	FILTER_SANITIZE_NUMBER_FLOAT,
76	FILTER_FLAG_ALLOW_FRACTION
77	),
78	'checked' => (bool)filter_var($level['checked'] ?? false, FILTER_VALIDATE_BOOLEAN),
79	];
80	}, $this->block->getAttribute('levels'));
81	}
82
83	/**
84	* @since 3.12.0
85	*/
86	public function isDescriptionEnabled(): bool
87	{
88	return $this->block->getAttribute('descriptionsEnabled') === true;
89	}
90
91	/**
92	* @return bool
93	*/
94	public function isRecurringFixed(): bool
95	{
96	return count($this->block->getAttribute('recurringBillingPeriodOptions')) === 1 && $this->block->getAttribute(
97	'recurringEnableOneTimeDonations'
98	) === false;
99	}
100
101	/**
102	* @since 3.0.0
103	*/
104	public function getRecurringBillingInterval(): int
105	{
106	return (int)$this->block->getAttribute('recurringBillingInterval');
107	}
108
109	/**
110	* @since 3.0.0
111	*/
112	public function getRecurringLengthOfTime(): int
113	{
114	return (int)$this->block->getAttribute('recurringLengthOfTime');
115	}
116
117	/**
118	* @since 3.0.0
119	*/
120	public function getRecurringOptInDefaultBillingPeriod(): string
121	{
122	return $this->block->getAttribute('recurringOptInDefaultBillingPeriod');
123	}
124
125	/**
126	* @since 3.0.0
127	*/
128	public function getRecurringBillingPeriodOptions(): array
129	{
130	return $this->block->getAttribute('recurringBillingPeriodOptions');
131	}
132
133	/**
134	* @since 3.0.0
135	*/
136	public function isRecurringEnableOneTimeDonations(): bool
137	{
138	return $this->block->getAttribute('recurringEnableOneTimeDonations') === true;
139	}
140
141	/**
142	* @since 3.0.0
143	*/
144	public function isRecurringEnabled(): bool
145	{
146	return $this->block->getAttribute('recurringEnabled') === true;
147	}
148
149	/**
150	* @since 3.0.0
151	*/
152	public function setRecurringEnabled(bool $enabled = true): self
153	{
154	return $this->setAttribute('recurringEnabled', $enabled);
155	}
156
157	/**
158	* @since 3.0.0
159	*/
160	public function setRecurringEnableOneTimeDonations(bool $enabled = true): self
161	{
162	return $this->setAttribute('recurringEnableOneTimeDonations', $enabled);
163	}
164
165	/**
166	* @since 3.0.0
167	*/
168	public function setRecurringBillingInterval(int $interval): self
169	{
170	return $this->setAttribute('recurringBillingInterval', $interval);
171	}
172
173	/**
174	* @since 3.0.0
175	*/
176	public function setRecurringLengthOfTime(int $lengthOfTime): self
177	{
178	return $this->setAttribute('recurringLengthOfTime', $lengthOfTime);
179	}
180
181	/**
182	* @since 3.0.0
183	*/
184	public function setRecurringBillingPeriodOptions(SubscriptionPeriod ...$options): self
185	{
186	return $this->setAttribute(
187	'recurringBillingPeriodOptions',
188	array_values(
189	array_map(static function (SubscriptionPeriod $option) {
190	return $option->getValue();
191	}, $options)
192	)
193	);
194	}
195
196	/**
197	* @since 3.0.0
198	*/
199	public function setRecurringOptInDefaultBillingPeriod(SubscriptionPeriod $period): self
200	{
201	return $this->setAttribute('recurringOptInDefaultBillingPeriod', $period->getValue());
202	}
203
204	/**
205	* @since 3.0.0
206	*/
207	public function isCustomAmountEnabled(): bool
208	{
209	return $this->block->getAttribute('customAmount') === true;
210	}
211
212	/**
213	* @since 3.0.0
214	*/
215	public function getPriceOption(): string
216	{
217	return $this->block->getAttribute('priceOption');
218	}
219
220	/**
221	* @since 3.0.0
222	*/
223	public function getSetPrice(): int
224	{
225	return $this->block->getAttribute('setPrice');
226	}
227
228	/**
229	* The lowest amount a donor may type into the custom amount input, or zero when the block does not
230	* define one.
231	*
232	* @since 4.16.8
233	*/
234	public function getCustomAmountMin(): float
235	{
236	return $this->hasAttribute('customAmountMin') ? (float)$this->getAttribute('customAmountMin') : 0.0;
237	}
238
239	/**
240	* The highest amount a donor may type into the custom amount input, or zero when the block does not
241	* define one.
242	*
243	* @since 4.16.8
244	*/
245	public function getCustomAmountMax(): float
246	{
247	return $this->hasAttribute('customAmountMax') ? (float)$this->getAttribute('customAmountMax') : 0.0;
248	}
249
250	/**
251	* The amounts the admin configured on the block: the donation levels, or the fixed set price. The
252	* custom amount minimum and maximum never apply to these.
253	*
254	* @since 4.16.8
255	*
256	* @return float[]
257	*/
258	public function getAdminDefinedAmounts(): array
259	{
260	$amounts = $this->getPriceOption() === 'multi'
261	? array_column($this->getLevels(), 'value')
262	: [$this->getSetPrice()];
263
264	// An unset level or set price sanitizes to 0, which must never be exempt from the minimum.
265	return array_values(
266	array_filter(
267	array_map('floatval', $amounts),
268	static function (float $amount): bool {
269	return $amount > 0;
270	}
271	)
272	);
273	}
274
275	/**
276	* The custom amount minimum, falling back to the lowest amount the admin configured. Without that
277	* fallback a form that leaves the minimum empty accepts any amount, which is a donation spam and card
278	* testing vector.
279	*
280	* @since 4.16.8
281	*
282	* @return float\|null Null when the block defines neither a minimum nor an amount to derive one from.
283	*/
284	public function getMinimumAmount(): ?float
285	{
286	if ($this->isCustomAmountEnabled() && $this->getCustomAmountMin() > 0) {
287	return $this->getCustomAmountMin();
288	}
289
290	$adminDefinedAmounts = $this->getAdminDefinedAmounts();
291	$lowestAmount = $adminDefinedAmounts ? min($adminDefinedAmounts) : 0.0;
292
293	return $lowestAmount > 0 ? $lowestAmount : null;
294	}
295	}
296