CalderaSubmissionDataSource.php
9.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
<?php
namespace NinjaForms\Includes\Database;
use NinjaForms\Includes\Contracts\SubmissionDataSource as ContractsSubmissionDataSource;
use NinjaForms\Includes\Entities\SingleSubmission;
use NinjaForms\Includes\Entities\SubmissionFilter;
use Caldera_Forms_Entry_Update;
use Caldera_Forms_Entry_Bulk;
use Caldera_Forms;
/**
* Retrieves a single Caldera Forms submission by its entry id
*/
class CalderaSubmissionDataSource implements ContractsSubmissionDataSource
{
const TIMESTAMP_FORMAT = 'Y-m-d H:i:s';
/**
* Identifier of where submission is stored
*
* @var string
*/
protected $dataSource = 'cf_form_entries';
/**
* Collection of submissions keyed on Submission Record Id
*
* @var SingleSubmission[]
*/
protected $submissionCollection = [];
/** @var SubmissionFilter */
protected $submissionFilter;
/**
* Cross reference from NF Form Id to the CF form Id
*
* Array is in format:
* [
* nfFormId => cfFormId,
* ex: '174' => 'CF60b547cfac102'
* ]
* @var array
*/
protected $formIdLookup = [];
/** @inheritDoc */
public function retrieveSubmissionMeta(SubmissionFilter $submissionFilter): array
{
$this->submissionFilter = $submissionFilter;
if ([] !== $this->submissionFilter->getNfFormIds()) {
$formIdCollection = $this->submissionFilter->getNfFormIds();
$this->formId = $formIdCollection[0];
foreach ($formIdCollection as $nfFormId) {
$this->lookupCfFormIdByNfFormId($nfFormId);
if (!\is_null($this->formIdLookup[$nfFormId])) {
$this->retrieveSubmissionMetaByCfFormId($this->formIdLookup[$nfFormId]);
}
}
}
if(''!==$this->submissionFilter->getSearchString()){
$this->applySearchCriterion();
}
return $this->submissionCollection;
}
/** @inheritDoc */
public function retrieveSingleSubmission(SingleSubmission $singleSubmission): SingleSubmission{
$submissionRecordId = $singleSubmission->getSubmissionRecordId();
// Initialize submission collection b/c retrievals only happen on submissions in collection
$this->submissionCollection[$submissionRecordId]=$singleSubmission;
// Populate values
$singleSubmission = $this->retrieveSubmissionValues($singleSubmission);
return $singleSubmission;
}
/**
* Apply search string filter to submission collection
*
* Runs a WP Query to search for all post Ids with both a form Id from the
* submission filter and also a search string in any meta value of the same
* form. It then filters the submission collection to only those
* submissions that meet these additional requirements.
*
* @return void
*/
protected function applySearchCriterion(): void
{
global $wpdb;
$entriesTable = $wpdb->prefix . 'cf_form_entries';
$valuesTable = $wpdb->prefix . 'cf_form_entry_values';
$searchString = '%'.$this->submissionFilter->getSearchString() .'%';
/** @var array $searchCollection Array of submission Ids that match both form Id and search criterion */
$searchCollection = [];
foreach ($this->submissionFilter->getNfFormIds() as $nfFormId) {
if (\is_null($this->formIdLookup[$nfFormId])) {
continue;
}
$cfFormId = $this->formIdLookup[$nfFormId];
$searchResultIds = $wpdb->get_results(
$wpdb->prepare(
"SELECT
$entriesTable.id
FROM
$entriesTable
INNER JOIN $valuesTable ON
($entriesTable.id = $valuesTable.entry_id)
WHERE
$entriesTable.form_id = '%s' AND $valuesTable.value LIKE '%s'
GROUP BY
$entriesTable.id
",
$cfFormId,
$searchString
),
ARRAY_A
);
$submissionIds = \array_column($searchResultIds, 'id');
$searchCollection = array_merge($searchCollection,$submissionIds);
}
$this->submissionCollection = \array_intersect_key($this->submissionCollection, \array_flip($searchCollection));
}
/**
* Adds CF lookup for given NF form id
*
* If given NF id lookup is not set, checks to see if there is a
* corresponding CF form. If not, the value is set to `null` so that
* the instance knows that the form id has been checked.
*
* @param string $nfFormId
* @return void
*/
protected function lookupCfFormIdByNfFormId(string $nfFormId): void
{
if(isset($this->formIdLookup[$nfFormId])){
return;
}
$form =Ninja_Forms()->form( $nfFormId )->get();
$cfFormId= $form->get_setting('key',null);
$this->formIdLookup[$nfFormId]=$cfFormId;
}
/** @inheritDoc */
public function retrieveSubmissionValues(SingleSubmission $singleSubmission): SingleSubmission
{
$submissionRecordId = $singleSubmission->getSubmissionRecordId();
global $wpdb;
$table = $wpdb->prefix . 'cf_form_entry_values';
$r = $wpdb->get_results($wpdb->prepare("SELECT `slug`,`value` FROM $table WHERE `entry_id` = '%s'", $submissionRecordId), ARRAY_A);
$cfSub = array_combine(array_column($r, 'slug'), array_column($r, 'value'));
$updatedFieldValueCollection = [];
foreach ($singleSubmission->getSubmissionFieldCollection() as $fieldSlug => $submissionField) {
$value = isset($cfSub[$fieldSlug]) ? $cfSub[$fieldSlug] : null;
$submissionField->setValue($value);
$updatedFieldValueCollection[$fieldSlug] = $submissionField;
}
$singleSubmission->setSubmissionFieldCollection($updatedFieldValueCollection);
// only populate collection if submission is already present
if (isset($this->submissionCollection[$submissionRecordId])) {
$this->submissionCollection[$submissionRecordId] = $singleSubmission;
}
return $singleSubmission;
}
/** @inheritDoc */
public function deleteSubmission(SingleSubmission $singleSubmission): ContractsSubmissionDataSource
{
$submissionId = $singleSubmission->getSubmissionRecordId();
$entry = Caldera_Forms::get_entry_detail( $submissionId );
if($entry['status'] === "active"){
Caldera_Forms_Entry_Update::update_entry_status( "trash", $submissionId);
} else {
Caldera_Forms_Entry_Bulk::delete_entries([$submissionId]);
}
return $this;
}
/** @inheritDoc */
public function restoreSubmission(SingleSubmission $singleSubmission): ContractsSubmissionDataSource
{
$submissionId = $singleSubmission->getSubmissionRecordId();
Caldera_Forms_Entry_Update::update_entry_status( "active", $submissionId);
return $this;
}
/** @inheritDoc */
public function updateSubmission(SingleSubmission $singleSubmission): ContractsSubmissionDataSource
{
// @TODO: Use CF API to delete submission
return $this;
}
/**
* Retrieve submissions for a given CF form Id
* @return void
*/
protected function retrieveSubmissionMetaByCfFormId(string $formId): void
{
global $wpdb;
$submissionRecordIdQuery = "select * from " . $wpdb->prefix . "cf_form_entries posts where form_id=%s";
$args[] = $formId;
$userId = $this->submissionFilter->getUserId();
// Filter on post author as submitter's user id
if (!\is_null($userId)) {
$submissionRecordIdQuery .= " AND user_id = %d";
$args[]=$userId;
}
$recordCollection = $wpdb->get_results($wpdb->prepare($submissionRecordIdQuery, $args));
$statuses = $this->submissionFilter->getStatus();
foreach ($recordCollection as $queryObject) {
//filter by status
if( empty($statuses) || in_array( $queryObject->status, $statuses ) ){
$submissionRecordId = $queryObject->id;
$subDate = $queryObject->datestamp;
$status = $queryObject->status;
$submitterId = $queryObject->user_id;
$include = $this->includeByDateFilter($subDate);
if (!$include) {
continue;
}
$this->submissionCollection[$submissionRecordId] = SingleSubmission::fromArray([
'submissionRecordId' => $submissionRecordId,
'timestamp' => $subDate,
'formId' => $formId,
'dataSource' => $this->dataSource,
'status' => $status,
'submitterId' => $submitterId
]);
}
}
}
/**
* Boolean to include as per date filter
*
* true=>include, false=>omit
*
* @return boolean
*/
protected function includeByDateFilter($subDate): bool
{
$include = true;
$startDateUnix = $this->submissionFilter->getStartDate();
$startDate = (new \DateTime())->setTimestamp($startDateUnix)->format(self::TIMESTAMP_FORMAT);
$endDateUnix = $this->submissionFilter->getEndDate();
$endDate = (new \DateTime())->setTimestamp($endDateUnix)->format(self::TIMESTAMP_FORMAT);
if ('' !== $startDate && $subDate < $startDate) {
$include = false;
}
if ('' !== $endDate && $subDate > $endDate) {
$include = false;
}
return $include;
}
/** @inheritDoc */
public function getDataSource(): string
{
return $this->dataSource;
}
}