give / src / Subscriptions / Repositories / SubscriptionNotesRepository.php

SubscriptionNotesRepository.php in GiveWP – Donation Plugin and Fundraising Platform 4.16.9, at src/Subscriptions/Repositories/SubscriptionNotesRepository.php

258 lines 7.8 KB

Raw Download Zip

1	<?php
2
3	namespace Give\Subscriptions\Repositories;
4
5	use Give\Framework\Database\DB;
6	use Give\Framework\Exceptions\Primitives\Exception;
7	use Give\Framework\Exceptions\Primitives\InvalidArgumentException;
8	use Give\Framework\Models\ModelQueryBuilder;
9	use Give\Framework\Support\Facades\DateTime\Temporal;
10	use Give\Helpers\Hooks;
11	use Give\Log\Log;
12	use Give\Subscriptions\Models\SubscriptionNote;
13	use Give\Subscriptions\ValueObjects\SubscriptionNoteMetaKeys;
14	use Give\Subscriptions\ValueObjects\SubscriptionNoteType;
15
16	/**
17	* NOTE: This repository is still using the old comments table.
18	* In the future, we will migrate to the new comments table.
19	*
20	* @since 4.8.0
21	*/
22	class SubscriptionNotesRepository
23	{
24	/**
25	* @since 4.8.0
26	*
27	* @var string[]
28	*/
29	private $requiredSubscriptionProperties = [
30	'subscriptionId',
31	'content',
32	];
33
34	/**
35	* @since 4.8.0
36	*/
37	private const COMMENT_TYPE = 'give_sub_note';
38
39	/**
40	* @since 4.8.0
41	*/
42	public function getById(int $noteId): ?SubscriptionNote
43	{
44	return $this->prepareQuery()
45	->where('comments.comment_ID', $noteId)
46	->get();
47	}
48
49	/**
50	* @since 4.8.0
51	*
52	* @throws Exception\|InvalidArgumentException
53	*/
54	public function insert(SubscriptionNote $subscriptionNote): void
55	{
56	if (! $subscriptionNote->type) {
57	$subscriptionNote->type = SubscriptionNoteType::ADMIN();
58	}
59
60	$this->validateSubscriptionNote($subscriptionNote);
61
62	Hooks::doAction('givewp_subscription_note_creating', $subscriptionNote);
63
64	$dateCreated = Temporal::withoutMicroseconds($subscriptionNote->createdAt ?: Temporal::getCurrentDateTime());
65	$dateCreatedFormatted = Temporal::getFormattedDateTime($dateCreated);
66
67	DB::query('START TRANSACTION');
68
69	try {
70	DB::table('comments')
71	->insert([
72	'comment_content' => $subscriptionNote->content,
73	'comment_date' => $dateCreatedFormatted,
74	'comment_date_gmt' => get_gmt_from_date($dateCreatedFormatted),
75	'comment_post_ID' => $subscriptionNote->subscriptionId,
76	'comment_type' => self::COMMENT_TYPE,
77	'user_id' => is_admin() ? get_current_user_id() : 0,
78	]);
79
80	$commentId = DB::last_insert_id();
81
82	if ($subscriptionNote->type->isDonor()) {
83	DB::table('commentmeta')
84	->insert([
85	'comment_ID' => $commentId,
86	'meta_key' => SubscriptionNoteMetaKeys::TYPE,
87	'meta_value' => SubscriptionNoteType::DONOR,
88	]);
89	}
90	} catch (Exception $exception) {
91	DB::query('ROLLBACK');
92
93	Log::error('Failed creating a subscription note', compact('subscriptionNote'));
94
95	throw new $exception('Failed creating a subscription note');
96	}
97
98	DB::query('COMMIT');
99
100	$subscriptionNote->id = $commentId;
101	$subscriptionNote->createdAt = $dateCreated;
102
103	Hooks::doAction('givewp_subscription_note_created', $subscriptionNote);
104	}
105
106	/**
107	* @since 4.8.0
108	*
109	* @throws Exception\|InvalidArgumentException
110	*/
111	public function update(SubscriptionNote $subscriptionNote): void
112	{
113	$this->validateSubscriptionNote($subscriptionNote);
114
115	Hooks::doAction('givewp_subscription_note_updating', $subscriptionNote);
116
117	DB::query('START TRANSACTION');
118
119	try {
120	DB::table('comments')
121	->where('comment_ID', $subscriptionNote->id)
122	->update([
123	'comment_content' => $subscriptionNote->content,
124	'comment_post_ID' => $subscriptionNote->subscriptionId,
125	'comment_type' => self::COMMENT_TYPE,
126	'user_id' => is_admin() ? get_current_user_id() : 0,
127	]);
128
129	if ($subscriptionNote->isDirty('type') && $subscriptionNote->type->isDonor()) {
130	$this->upsertSubscriptionNoteType($subscriptionNote);
131	}
132	} catch (Exception $exception) {
133	DB::query('ROLLBACK');
134
135	Log::error('Failed updating a subscription note', compact('subscriptionNote'));
136
137	throw new $exception('Failed updating a subscription note');
138	}
139
140	DB::query('COMMIT');
141
142	Hooks::doAction('givewp_subscription_note_updated', $subscriptionNote);
143	}
144
145	/**
146	* @since 4.8.0
147	*
148	* @throws Exception
149	*/
150	public function delete(SubscriptionNote $subscriptionNote): bool
151	{
152	DB::query('START TRANSACTION');
153
154	Hooks::doAction('givewp_subscription_note_deleting', $subscriptionNote);
155
156	try {
157	DB::table('comments')
158	->where('comment_ID', $subscriptionNote->id)
159	->delete();
160
161	DB::table('commentmeta')
162	->where('comment_ID', $subscriptionNote->id)
163	->delete();
164	} catch (Exception $exception) {
165	DB::query('ROLLBACK');
166
167	Log::error('Failed deleting a subscription note', compact('subscriptionNote'));
168
169	throw new $exception('Failed deleting a subscription note');
170	}
171
172	DB::query('COMMIT');
173
174	Hooks::doAction('givewp_subscription_note_deleted', $subscriptionNote);
175
176	return true;
177	}
178
179	/**
180	* @since 4.8.0
181	*/
182	public function queryBySubscriptionId(int $subscriptionId): ModelQueryBuilder
183	{
184	return $this->prepareQuery()
185	->where('comments.comment_post_ID', $subscriptionId)
186	->orderBy('comments.comment_ID', 'DESC');
187	}
188
189	/**
190	* @since 4.8.0
191	*/
192	private function validateSubscriptionNote(SubscriptionNote $subscriptionNote): void
193	{
194	foreach ($this->requiredSubscriptionProperties as $key) {
195	if (! isset($subscriptionNote->$key)) {
196	throw new InvalidArgumentException("'$key' is required.");
197	}
198	}
199
200	if (! $subscriptionNote->subscription) {
201	throw new InvalidArgumentException('Invalid subscriptionId, Subscription does not exist');
202	}
203	}
204
205	/**
206	* @since 4.8.0
207	*
208	* @return ModelQueryBuilder<SubscriptionNote>
209	*/
210	public function prepareQuery(): ModelQueryBuilder
211	{
212	$builder = new ModelQueryBuilder(SubscriptionNote::class);
213
214	return $builder->from('comments', 'comments')
215	->select(
216	['comments.comment_ID', 'id'],
217	['comments.comment_post_ID', 'subscriptionId'],
218	['comments.comment_content', 'content'],
219	['comments.comment_date', 'createdAt']
220	)
221	->attachMeta(
222	'commentmeta',
223	'comments.comment_ID',
224	'comment_ID',
225	...SubscriptionNoteMetaKeys::getColumnsForAttachMetaQuery()
226	)
227	->where('comments.comment_type', self::COMMENT_TYPE);
228	}
229
230	/**
231	* @since 4.8.0
232	*/
233	private function upsertSubscriptionNoteType(SubscriptionNote $subscriptionNote): void
234	{
235	$table = DB::table('commentmeta');
236
237	$query = $table
238	->where('comment_ID', $subscriptionNote->id)
239	->where('meta_key', SubscriptionNoteMetaKeys::TYPE)
240	->get();
241
242	if (! $query) {
243	$table->insert([
244	'comment_ID' => $subscriptionNote->id,
245	'meta_key' => SubscriptionNoteMetaKeys::TYPE,
246	'meta_value' => $subscriptionNote->type->getValue(),
247	]);
248	} else {
249	$table
250	->where('comment_ID', $subscriptionNote->id)
251	->where('meta_key', SubscriptionNoteMetaKeys::TYPE)
252	->update([
253	'meta_value' => $subscriptionNote->type->getValue(),
254	]);
255	}
256	}
257	}
258