Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace NinjaForms\Includes\Handlers;

[2] Fix | Delete

[3] Fix | Delete

use NinjaForms\Includes\Contracts\SubmissionDataSource;

[4] Fix | Delete

use NinjaForms\Includes\Entities\SingleSubmission;

[5] Fix | Delete

use NinjaForms\Includes\Entities\SubmissionField;

[6] Fix | Delete

use NinjaForms\Includes\Entities\SubmissionFilter;

[7] Fix | Delete

use NinjaForms\Includes\Handlers\Field;

[8] Fix | Delete

[9] Fix | Delete

/**

[10] Fix | Delete

* Aggregates submissions from all provided data sources

[11] Fix | Delete

[12] Fix | Delete

* Data sources include NF submissions stored as posts; may include pre-existing

[13] Fix | Delete

* Caldera Forms submissions

[14] Fix | Delete

[15] Fix | Delete

class SubmissionAggregate

[16] Fix | Delete

{

[17] Fix | Delete

[18] Fix | Delete

/**

[19] Fix | Delete

* NF Id of the master form

[20] Fix | Delete

[21] Fix | Delete

* There can be multiple forms in the aggregate; the master form defines the

[22] Fix | Delete

* fields and the data within the aggregate.

[23] Fix | Delete

[24] Fix | Delete

* @var string

[25] Fix | Delete

[26] Fix | Delete

protected $masterFormId = '';

[27] Fix | Delete

[28] Fix | Delete

/** @var SubmissionFilter */

[29] Fix | Delete

protected $submissionFilter;

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* Collection of submission data sources

[33] Fix | Delete

[34] Fix | Delete

* @var SubmissionDataSource[];

[35] Fix | Delete

[36] Fix | Delete

protected $dataSourceCollection = [];

[37] Fix | Delete

[38] Fix | Delete

/**

[39] Fix | Delete

* Collection of all SingleSubmissions

[40] Fix | Delete

[41] Fix | Delete

* Indexed collection of submissions meeting the filtering parameters

[42] Fix | Delete

[43] Fix | Delete

* @var SingleSubmission[]

[44] Fix | Delete

[45] Fix | Delete

protected $aggregatedSubmissions = [];

[46] Fix | Delete

[47] Fix | Delete

/**

[48] Fix | Delete

* Collection of SubmissionFields defining the form

[49] Fix | Delete

[50] Fix | Delete

* @var SubmissionField[]

[51] Fix | Delete

[52] Fix | Delete

protected $submissionFieldCollection = [];

[53] Fix | Delete

[54] Fix | Delete

/**

[55] Fix | Delete

* Filter submissions to return a collection of SingleSubmission meta data only

[56] Fix | Delete

[57] Fix | Delete

* @param string $formId

[58] Fix | Delete

* @return array

[59] Fix | Delete

[60] Fix | Delete

public function filterSubmissions(SubmissionFilter $submissionFilter): array

[61] Fix | Delete

{

[62] Fix | Delete

$this->submissionFilter = $submissionFilter;

[63] Fix | Delete

[64] Fix | Delete

$formIdCollection = $this->submissionFilter->getNfFormIds();

[65] Fix | Delete

[66] Fix | Delete

if (!empty($formIdCollection)) {

[67] Fix | Delete

$masterFormId = $formIdCollection[0];

[68] Fix | Delete

$this->constructFieldDefinitionCollection($masterFormId);

[69] Fix | Delete

}

[70] Fix | Delete

[71] Fix | Delete

$aggregated = [];

[72] Fix | Delete

[73] Fix | Delete

if (!empty($this->dataSourceCollection)) {

[74] Fix | Delete

foreach ($this->dataSourceCollection as $dataSource) {

[75] Fix | Delete

[76] Fix | Delete

$submissionsFromDataSource = $dataSource->retrieveSubmissionMeta($this->submissionFilter);

[77] Fix | Delete

[78] Fix | Delete

$aggregated = array_merge($aggregated, $submissionsFromDataSource);

[79] Fix | Delete

}

[80] Fix | Delete

}

[81] Fix | Delete

[82] Fix | Delete

foreach ($aggregated as $singleSubmission) {

[83] Fix | Delete

$key = $this->constructUniqueAgreggatedSubmissionKey($singleSubmission);

[84] Fix | Delete

[85] Fix | Delete

$submissionIDs = $this->submissionFilter->getSubmissionsIDs();

[86] Fix | Delete

[87] Fix | Delete

//Add singleSubmission to aggregated collection if no submissions IDs were set or if it has correct ID

[88] Fix | Delete

if( in_array( $singleSubmission->submissionRecordId, $submissionIDs ) || empty( $submissionIDs ) ){

[89] Fix | Delete

$this->aggregatedSubmissions[$key] = $singleSubmission;

[90] Fix | Delete

}

[91] Fix | Delete

}

[92] Fix | Delete

[93] Fix | Delete

uasort($this->aggregatedSubmissions, function ($a, $b) {

[94] Fix | Delete

return $b->getTimestamp() <=> $a->getTimestamp();

[95] Fix | Delete

});

[96] Fix | Delete

[97] Fix | Delete

return $this->aggregatedSubmissions;

[98] Fix | Delete

}

[99] Fix | Delete

[100] Fix | Delete

/**

[101] Fix | Delete

* Retrieve a single submission populated with submission/extra values

[102] Fix | Delete

[103] Fix | Delete

* Also populates the submissionAggregate such that the aggregate can be

[104] Fix | Delete

* passed for handling elsewhere

[105] Fix | Delete

[106] Fix | Delete

* @param SingleSubmission $singleSubmission

[107] Fix | Delete

* @return SingleSubmission

[108] Fix | Delete

[109] Fix | Delete

public function requestSingleSubmission(SingleSubmission $singleSubmission): SingleSubmission

[110] Fix | Delete

{

[111] Fix | Delete

$this->masterFormId = $singleSubmission->getFormId();

[112] Fix | Delete

[113] Fix | Delete

$this->constructFieldDefinitionCollection($this->masterFormId);

[114] Fix | Delete

[115] Fix | Delete

$singleSubmission->setSubmissionFieldCollection($this->submissionFieldCollection);

[116] Fix | Delete

[117] Fix | Delete

$dataSourceKey = $singleSubmission->getDataSource();

[118] Fix | Delete

[119] Fix | Delete

if(isset($this->dataSourceCollection[$dataSourceKey])){

[120] Fix | Delete

[121] Fix | Delete

$dataSource=$this->dataSourceCollection[$dataSourceKey];

[122] Fix | Delete

[123] Fix | Delete

$singleSubmission = $dataSource->retrieveSingleSubmission($singleSubmission);

[124] Fix | Delete

[125] Fix | Delete

}

[126] Fix | Delete

[127] Fix | Delete

$key = $this->constructUniqueAgreggatedSubmissionKey($singleSubmission);

[128] Fix | Delete

[129] Fix | Delete

$this->aggregatedSubmissions[$key] = $singleSubmission;

[130] Fix | Delete

[131] Fix | Delete

return $singleSubmission;

[132] Fix | Delete

}

[133] Fix | Delete

[134] Fix | Delete

/**

[135] Fix | Delete

* Retrieve a submissions by precise list of submissions IDs

[136] Fix | Delete

[137] Fix | Delete

* @param SubmissionFilter $submissionFilter

[138] Fix | Delete

* @return SubmissionFilter

[139] Fix | Delete

[140] Fix | Delete

public function requestSubmissionsByIds(SubmissionFilter $submissionFilter): SubmissionFilter

[141] Fix | Delete

{

[142] Fix | Delete

$this->masterFormId = $singleSubmission->getFormId();

[143] Fix | Delete

[144] Fix | Delete

$this->constructFieldDefinitionCollection($this->masterFormId);

[145] Fix | Delete

[146] Fix | Delete

$submissions->setSubmissionFieldCollection($this->submissionFieldCollection);

[147] Fix | Delete

[148] Fix | Delete

$dataSourceKey = $singleSubmission->getDataSource();

[149] Fix | Delete

[150] Fix | Delete

if(isset($this->dataSourceCollection[$dataSourceKey])){

[151] Fix | Delete

[152] Fix | Delete

$dataSource=$this->dataSourceCollection[$dataSourceKey];

[153] Fix | Delete

[154] Fix | Delete

$singleSubmission = $dataSource->retrieveSingleSubmission($singleSubmission);

[155] Fix | Delete

[156] Fix | Delete

}

[157] Fix | Delete

[158] Fix | Delete

$key = $this->constructUniqueAgreggatedSubmissionKey($singleSubmission);

[159] Fix | Delete

[160] Fix | Delete

$this->aggregatedSubmissions[$key] = $singleSubmission;

[161] Fix | Delete

[162] Fix | Delete

return $singleSubmission;

[163] Fix | Delete

}

[164] Fix | Delete

[165] Fix | Delete

/**

[166] Fix | Delete

* Retrieve submissionValues from submission at a given aggregated key

[167] Fix | Delete

[168] Fix | Delete

* @param string $key

[169] Fix | Delete

* @return SingleSubmission

[170] Fix | Delete

* @see constructUniqueAgreggatedSubmissionKey()

[171] Fix | Delete

[172] Fix | Delete

public function getSubmissionValuesByAggregatedKey(string $key): SingleSubmission

[173] Fix | Delete

{

[174] Fix | Delete

/** @var SubmissionDataSource $dataSource */

[175] Fix | Delete

[176] Fix | Delete

if (isset($this->aggregatedSubmissions[$key])) {

[177] Fix | Delete

[178] Fix | Delete

$singleSubmission = $this->aggregatedSubmissions[$key];

[179] Fix | Delete

[180] Fix | Delete

if (empty($singleSubmission->getSubmissionFieldCollection())) {

[181] Fix | Delete

[182] Fix | Delete

$singleSubmission->setSubmissionFieldCollection($this->submissionFieldCollection);

[183] Fix | Delete

$dataSource = $this->dataSourceCollection[$singleSubmission->getDataSource()];

[184] Fix | Delete

[185] Fix | Delete

$populatedSingleSubmission = $dataSource->retrieveSubmissionValues($singleSubmission);

[186] Fix | Delete

} else {

[187] Fix | Delete

[188] Fix | Delete

$populatedSingleSubmission = $singleSubmission;

[189] Fix | Delete

}

[190] Fix | Delete

} else {

[191] Fix | Delete

[192] Fix | Delete

$populatedSingleSubmission = SingleSubmission::fromArray([]);

[193] Fix | Delete

}

[194] Fix | Delete

[195] Fix | Delete

// create a new object to avoid object-by-reference that updates all submissions in the collection

[196] Fix | Delete

$this->aggregatedSubmissions[$key] = SingleSubmission::fromArray($populatedSingleSubmission->toArray());

[197] Fix | Delete

[198] Fix | Delete

return $this->aggregatedSubmissions[$key];

[199] Fix | Delete

}

[200] Fix | Delete

[201] Fix | Delete

/**

[202] Fix | Delete

* Delete a single submission

[203] Fix | Delete

[204] Fix | Delete

* @param SingleSubmission $singleSubmission

[205] Fix | Delete

* @return SubmissionAggregate

[206] Fix | Delete

[207] Fix | Delete

public function deleteSingleSubmission(SingleSubmission $singleSubmission): SubmissionAggregate

[208] Fix | Delete

{

[209] Fix | Delete

$dataSourceKey = $singleSubmission->getDataSource();

[210] Fix | Delete

[211] Fix | Delete

if(isset($this->dataSourceCollection[$dataSourceKey])){

[212] Fix | Delete

[213] Fix | Delete

$dataSource = $this->dataSourceCollection[$dataSourceKey];

[214] Fix | Delete

[215] Fix | Delete

$dataSource->deleteSubmission($singleSubmission);

[216] Fix | Delete

}

[217] Fix | Delete

[218] Fix | Delete

return $this;

[219] Fix | Delete

}

[220] Fix | Delete

[221] Fix | Delete

/**

[222] Fix | Delete

* Restore a single submission

[223] Fix | Delete

[224] Fix | Delete

* @param SingleSubmission $singleSubmission

[225] Fix | Delete

* @return SubmissionAggregate

[226] Fix | Delete

[227] Fix | Delete

public function restoreSingleSubmission(SingleSubmission $singleSubmission): SubmissionAggregate

[228] Fix | Delete

{

[229] Fix | Delete

$dataSourceKey = $singleSubmission->getDataSource();

[230] Fix | Delete

[231] Fix | Delete

if(isset($this->dataSourceCollection[$dataSourceKey])){

[232] Fix | Delete

[233] Fix | Delete

$dataSource = $this->dataSourceCollection[$dataSourceKey];

[234] Fix | Delete

[235] Fix | Delete

$dataSource->restoreSubmission($singleSubmission);

[236] Fix | Delete

}

[237] Fix | Delete

[238] Fix | Delete

return $this;

[239] Fix | Delete

}

[240] Fix | Delete

[241] Fix | Delete

/**

[242] Fix | Delete

* Update a single submission

[243] Fix | Delete

[244] Fix | Delete

* @param SingleSubmission $singleSubmission

[245] Fix | Delete

* @return SubmissionAggregate

[246] Fix | Delete

[247] Fix | Delete

public function updateSingleSubmission(SingleSubmission $singleSubmission): SubmissionAggregate

[248] Fix | Delete

{

[249] Fix | Delete

$dataSourceKey = $singleSubmission->getDataSource();

[250] Fix | Delete

[251] Fix | Delete

if(isset($this->dataSourceCollection[$dataSourceKey])){

[252] Fix | Delete

[253] Fix | Delete

$dataSource = $this->dataSourceCollection[$dataSourceKey];

[254] Fix | Delete

[255] Fix | Delete

$dataSource->updateSubmission($singleSubmission);

[256] Fix | Delete

}

[257] Fix | Delete

[258] Fix | Delete

return $this;

[259] Fix | Delete

}

[260] Fix | Delete

[261] Fix | Delete

[262] Fix | Delete

/**

[263] Fix | Delete

* Construct field definition collection from formId

[264] Fix | Delete

[265] Fix | Delete

* @param string $formId

[266] Fix | Delete

* @return void

[267] Fix | Delete

[268] Fix | Delete

protected function constructFieldDefinitionCollection(string $formId): void

[269] Fix | Delete

{

[270] Fix | Delete

$nfFieldsCollection = $this->getFieldsCollection($formId);

[271] Fix | Delete

[272] Fix | Delete

if (!empty($nfFieldsCollection)) {

[273] Fix | Delete

[274] Fix | Delete

/** @var Field $nfField */

[275] Fix | Delete

foreach ($nfFieldsCollection as $id => $nfField) {

[276] Fix | Delete

$slug = $nfField->get_setting('key');

[277] Fix | Delete

$fieldSettings = $nfField->get_settings();

[278] Fix | Delete

[279] Fix | Delete

$fieldOptionDefinition = $nfField->get_setting('options',[]);

[280] Fix | Delete

$fieldsetRepeaterFields = $nfField->get_setting('fields',[]);

[281] Fix | Delete

[282] Fix | Delete

if(!empty($fieldOptionDefinition)){

[283] Fix | Delete

foreach($fieldOptionDefinition as $optionDefinition){

[284] Fix | Delete

$options = $this->extractOptionsFromDefinition($optionDefinition);

[285] Fix | Delete

[286] Fix | Delete

$optionsCollection[]=$options;

[287] Fix | Delete

}

[288] Fix | Delete

[289] Fix | Delete

}else{

[290] Fix | Delete

$optionsCollection = [];

[291] Fix | Delete

}

[292] Fix | Delete

[293] Fix | Delete

$array = [

[294] Fix | Delete

'id' => (string)$id,

[295] Fix | Delete

'slug' => $slug,

[296] Fix | Delete

'label' => $nfField->get_setting('label'),

[297] Fix | Delete

'adminLabel' => $nfField->get_setting('admin_label'),

[298] Fix | Delete

'type' => $nfField->get_setting('type'),

[299] Fix | Delete

'options' => $optionsCollection,

[300] Fix | Delete

'fieldsetRepeaterFields'=>$fieldsetRepeaterFields,

[301] Fix | Delete

'original' => $fieldSettings

[302] Fix | Delete

];

[303] Fix | Delete

[304] Fix | Delete

$this->submissionFieldCollection[$slug] = SubmissionField::fromArray($array);

[305] Fix | Delete

}

[306] Fix | Delete

[307] Fix | Delete

}

[308] Fix | Delete

}

[309] Fix | Delete

[310] Fix | Delete

/**

[311] Fix | Delete

* Extract option array from a given array

[312] Fix | Delete

[313] Fix | Delete

* Ensures that required defaults are set if missing in incoming array

[314] Fix | Delete

[315] Fix | Delete

* @param array $optionDefinition

[316] Fix | Delete

* @return array

[317] Fix | Delete

[318] Fix | Delete

protected function extractOptionsFromDefinition(array $optionDefinition): array

[319] Fix | Delete

{

[320] Fix | Delete

$defaults = [

[321] Fix | Delete

'label' => '',

[322] Fix | Delete

'value' => '',

[323] Fix | Delete

'calc' => '',

[324] Fix | Delete

'selected' => 0,

[325] Fix | Delete

'order' => 0

[326] Fix | Delete

];

[327] Fix | Delete

[328] Fix | Delete

$return = array_merge($defaults, \array_intersect_key($optionDefinition, $defaults));

[329] Fix | Delete

[330] Fix | Delete

return $return;

[331] Fix | Delete

}

[332] Fix | Delete

[333] Fix | Delete

/**

[334] Fix | Delete

* Return the Ninja Forms field collection

[335] Fix | Delete

[336] Fix | Delete

* @param string $formId

[337] Fix | Delete

* @return array

[338] Fix | Delete

[339] Fix | Delete

protected function getFieldsCollection(string $formId): array

[340] Fix | Delete

{

[341] Fix | Delete

$return = \Ninja_Forms()->form($formId)->get_fields();

[342] Fix | Delete

[343] Fix | Delete

return $return;

[344] Fix | Delete

}

[345] Fix | Delete

[346] Fix | Delete

/**

[347] Fix | Delete

* Construct a unique aggregated submission key for each submission

[348] Fix | Delete

[349] Fix | Delete

* Uses the dataSource's id plus the submission record id. Each submission

[350] Fix | Delete

* is is unique within its dataSource, and each dataSource is unique, thus

[351] Fix | Delete

* the combined string is unique

[352] Fix | Delete

[353] Fix | Delete

* @param SingleSubmission $singleSubmission

[354] Fix | Delete

* @return string

[355] Fix | Delete

[356] Fix | Delete

protected function constructUniqueAgreggatedSubmissionKey(SingleSubmission $singleSubmission): string

[357] Fix | Delete

{

[358] Fix | Delete

$key = $singleSubmission->getDataSource() . '__' . $singleSubmission->getSubmissionRecordId();

[359] Fix | Delete

[360] Fix | Delete

return $key;

[361] Fix | Delete

}

[362] Fix | Delete

[363] Fix | Delete

/**

[364] Fix | Delete

* Set collection of submission data sources

[365] Fix | Delete

[366] Fix | Delete

* @param SubmissionDataSource $dataSource Submission data source

[367] Fix | Delete

[368] Fix | Delete

* @return SubmissionAggregate

[369] Fix | Delete

[370] Fix | Delete

public function addDataSource(SubmissionDataSource $dataSource): SubmissionAggregate

[371] Fix | Delete

{

[372] Fix | Delete

$this->dataSourceCollection[$dataSource->getDataSource()] = $dataSource;

[373] Fix | Delete

[374] Fix | Delete

return $this;

[375] Fix | Delete

}

[376] Fix | Delete

[377] Fix | Delete

/**

[378] Fix | Delete

* Get collection of SubmissionFields

[379] Fix | Delete

[380] Fix | Delete

* @return SubmissionField[]

[381] Fix | Delete

[382] Fix | Delete

public function getFieldDefinitionCollection(): array

[383] Fix | Delete

{

[384] Fix | Delete

return $this->submissionFieldCollection;

[385] Fix | Delete

}

[386] Fix | Delete

[387] Fix | Delete

/**

[388] Fix | Delete

* Get submission count

[389] Fix | Delete

[390] Fix | Delete

* @return integer

[391] Fix | Delete

[392] Fix | Delete

public function getSubmissionCount(): int

[393] Fix | Delete

{

[394] Fix | Delete

return count($this->aggregatedSubmissions);

[395] Fix | Delete

}

[396] Fix | Delete

[397] Fix | Delete

/**

[398] Fix | Delete

* Get indexed collection of submissions meeting the filtering parameters

[399] Fix | Delete

[400] Fix | Delete

* @return SingleSubmission[]

[401] Fix | Delete

[402] Fix | Delete

public function getAggregatedSubmissions(): array

[403] Fix | Delete

{

[404] Fix | Delete

return $this->aggregatedSubmissions;

[405] Fix | Delete

}

[406] Fix | Delete

[407] Fix | Delete

/**

[408] Fix | Delete

* Get fields and the data within the aggregate.

[409] Fix | Delete

[410] Fix | Delete

* @return string

[411] Fix | Delete

[412] Fix | Delete

public function getMasterFormId(): string

[413] Fix | Delete

{

[414] Fix | Delete

return $this->masterFormId;

[415] Fix | Delete

}

[416] Fix | Delete

[417] Fix | Delete

/**

[418] Fix | Delete

* Set keyed collection of submissions

[419] Fix | Delete

[420] Fix | Delete

* This method enables re-setting the aggregated submissions after

[421] Fix | Delete

* performing array methods on it. This is useful to get a subset of the

[422] Fix | Delete

* collection without needing to re-filter and run DB requests

[423] Fix | Delete

[424] Fix | Delete

* @param Array $aggregatedSubmissions Keyed collection of

[425] Fix | Delete

* submissions meeting the filtering parameters

[426] Fix | Delete

[427] Fix | Delete

* @return self

[428] Fix | Delete

[429] Fix | Delete

public function setAggregatedSubmissions(Array $aggregatedSubmissions)

[430] Fix | Delete

{

[431] Fix | Delete

$this->aggregatedSubmissions = $aggregatedSubmissions;

[432] Fix | Delete

[433] Fix | Delete

return $this;

[434] Fix | Delete

}

[435] Fix | Delete

}

[436] Fix | Delete

[437] Fix | Delete