give / src / License / Repositories / LicenseRepository.php

LicenseRepository.php in GiveWP – Donation Plugin and Fundraising Platform 4.16.8.1, at src/License/Repositories/LicenseRepository.php

225 lines 5.4 KB

Raw Download Zip

1	<?php
2
3	namespace Give\License\Repositories;
4
5	use Give\License\DataTransferObjects\License;
6	use Give\License\ValueObjects\LicenseOptionKeys;
7
8	/**
9	* @since 4.3.0
10	*/
11	class LicenseRepository
12	{
13	/**
14	* Check if we have stored licenses in the database.
15	*
16	* @since 4.3.0
17	*/
18	public function hasStoredLicenses(): bool
19	{
20	return !empty($this->getStoredLicenses());
21	}
22
23	/**
24	* Gets the raw, stored licenses from the database.
25	*
26	* @since 4.3.0
27	*/
28	public function getStoredLicenses(): array
29	{
30	return (array)get_option(LicenseOptionKeys::LICENSES, []);
31	}
32
33	/**
34	* Gets the stored licenses from the database and converts them to License objects.
35	*
36	* @since 4.3.0
37	* @return License[]
38	*/
39	public function getLicenses(): array
40	{
41	if (!$this->hasStoredLicenses()) {
42	return [];
43	}
44
45	$storedLicenses = $this->getStoredLicenses();
46	$licenses = [];
47
48	foreach ($storedLicenses as $license) {
49	$licenses[] = License::fromData($license);
50	}
51
52	return $licenses;
53	}
54
55	/**
56	* Returns only the active licenses.
57	*
58	* @since 4.3.0
59	*/
60	public function getActiveLicenses(): array
61	{
62	if (!$this->hasStoredLicenses()) {
63	return [];
64	}
65
66	$licenses = $this->getLicenses();
67
68	return array_filter($licenses, static function(License $license) {
69	return $license->isActive;
70	});
71	}
72
73	/**
74	* Checks if we have any active licenses, including Harbor unified licenses.
75	*
76	* @since 4.15.0 add support for Harbor unified licenses
77	* @since 4.3.0
78	*/
79	public function hasActiveLicenses(): bool
80	{
81	return !empty($this->getActiveLicenses())
82	\|\| lw_harbor_is_product_license_active('give');
83	}
84
85	/**
86	* The platform fee percentage is used by gateways to calculate a platform fee.
87	*
88	* @since 4.8.0 add grace period
89	* @since 4.3.0
90	*/
91	public function getPlatformFeePercentage(): float
92	{
93	if (!$this->hasActiveLicenses()) {
94
95	if ($this->isLicenseInGracePeriod()) {
96	return 0.0;
97	}
98
99	return 2.0;
100	}
101
102	if (!$this->hasStoredPlatformFeePercentage()) {
103	return 0.0;
104	}
105
106	return $this->getStoredPlatformFeePercentage();
107	}
108
109	/**
110	* Check if licenses are in the grace period.
111	*
112	* @since 4.8.0
113	*/
114	private function isLicenseInGracePeriod(): bool
115	{
116	$currentTime = current_time('timestamp', true);
117	$lastActiveDate = $this->getLastActiveLicenseDate();
118
119	if ($lastActiveDate && $currentTime <= $lastActiveDate + $this->getGracePeriodInSeconds()) {
120	return true;
121	}
122
123	return false;
124	}
125
126	/**
127	* Returns the current timestamp if at least one active license is present.
128	* This is used to track the moment a license was last confirmed active,
129	*
130	* @since 4.8.0
131	*/
132	public function getCurrentActiveLicenseDate(): ?int
133	{
134	if (!$this->hasActiveLicenses()) {
135	return null;
136	}
137
138	$currentTime = current_time('timestamp', true);
139
140	return $currentTime;
141	}
142
143	/**
144	* Retrieves the timestamp of when a license was last active.
145	*
146	* @since 4.8.0
147	*/
148	public function getLastActiveLicenseDate(): ?int
149	{
150	$value = get_option(LicenseOptionKeys::LAST_ACTIVE_LICENSE_DATE);
151	return $value ?: null;
152	}
153
154	/**
155	* Grace period is 30 days after the last active license date with a 3 day buffer for the refresh system.
156	*
157	* @since 4.8.0
158	*/
159	public function getGracePeriodInSeconds(): ?int
160	{
161	return 33 * DAY_IN_SECONDS;
162	}
163
164	/**
165	* Check if we have an available platform fee percentage set.
166	* This can be used to determine if we can charge a platform fee.
167	*
168	* @since 4.3.0
169	*/
170	public function hasPlatformFeePercentage(): bool
171	{
172	return $this->getPlatformFeePercentage() > 0;
173	}
174
175	/**
176	* The stored platform fee percentage comes from License Server API.
177	* When licenses are activated and refreshed, this value is stored in the database.
178	*
179	* @since 4.3.0
180	*/
181	public function getStoredPlatformFeePercentage(): ?float
182	{
183	if (!get_option(LicenseOptionKeys::PLATFORM_FEE_PERCENTAGE)) {
184	return null;
185	}
186
187	return (float)get_option(LicenseOptionKeys::PLATFORM_FEE_PERCENTAGE);
188	}
189
190	/**
191	* Check if we have a stored platform fee percentage.
192	*
193	* @since 4.3.0
194	*/
195	public function hasStoredPlatformFeePercentage(): bool
196	{
197	return !is_null($this->getStoredPlatformFeePercentage());
198	}
199
200	/**
201	* Find the lowest platform fee percentage from active licenses.
202	* Since there can be multiple licenses, we need to find the lowest fee from all active licenses.
203	* Once we have the lowest fee, we store it in the database for future use.
204	*
205	* @since 4.3.0
206	*/
207	public function findLowestPlatformFeePercentageFromActiveLicenses(): ?float
208	{
209	if (!$this->hasActiveLicenses()) {
210	return null;
211	}
212
213	$fees = array_map(static function(License $license) {
214	return $license->gatewayFee;
215
216	}, $this->getActiveLicenses());
217
218	if (empty($fees)) {
219	return null;
220	}
221
222	return (float)min($fees);
223	}
224	}
225