Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace NinjaForms\Includes\Handlers;

[2] Fix | Delete

[3] Fix | Delete

use NinjaForms\Includes\Entities\SubmissionField;

[4] Fix | Delete

use NinjaForms\Includes\Entities\SingleSubmission;

[5] Fix | Delete

[6] Fix | Delete

use NinjaForms\Includes\Handlers\SubmissionAggregate;

[7] Fix | Delete

use NinjaForms\Includes\Handlers\Field;

[8] Fix | Delete

[9] Fix | Delete

/**

[10] Fix | Delete

* Adapts SubmissionAggregate to provide data required by CSV Export

[11] Fix | Delete

[12] Fix | Delete

* CSV Export requires specific structuring of submission data, too specialized

[13] Fix | Delete

* to be included in the SubmissionAggregate. This class structures submission

[14] Fix | Delete

* data as needed for CSV export

[15] Fix | Delete

[16] Fix | Delete

class SubmissionAggregateCsvExportAdapter

[17] Fix | Delete

{

[18] Fix | Delete

[19] Fix | Delete

/**

[20] Fix | Delete

* Field labels, keyed on field key

[21] Fix | Delete

[22] Fix | Delete

* @var array

[23] Fix | Delete

[24] Fix | Delete

protected $labels;

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* Admin field labels, keyed on field key

[28] Fix | Delete

[29] Fix | Delete

* @var array

[30] Fix | Delete

[31] Fix | Delete

protected $adminLabels;

[32] Fix | Delete

[33] Fix | Delete

/**

[34] Fix | Delete

* Indexed array of field types to be omitted in output

[35] Fix | Delete

* @var array

[36] Fix | Delete

[37] Fix | Delete

protected $hiddenFieldTypes;

[38] Fix | Delete

[39] Fix | Delete

/**

[40] Fix | Delete

* Array of field types keyed on field key

[41] Fix | Delete

* @var array

[42] Fix | Delete

[43] Fix | Delete

protected $fieldTypes = [];

[44] Fix | Delete

[45] Fix | Delete

/**

[46] Fix | Delete

* Array of field Ids keyed on field key

[47] Fix | Delete

* @var array

[48] Fix | Delete

[49] Fix | Delete

protected $fieldIds = [];

[50] Fix | Delete

[51] Fix | Delete

/**

[52] Fix | Delete

* Array of column values keyed on field key

[53] Fix | Delete

[54] Fix | Delete

* Property is reset and reused for each request; column count must equal

[55] Fix | Delete

* that of $labels, $adminLabels, $fieldtypes, and $fieldIds

[56] Fix | Delete

[57] Fix | Delete

* @var array

[58] Fix | Delete

[59] Fix | Delete

protected $columnValues = [];

[60] Fix | Delete

[61] Fix | Delete

/**

[62] Fix | Delete

* @var SubmissionAggregate

[63] Fix | Delete

[64] Fix | Delete

public $submissionAggregate;

[65] Fix | Delete

[66] Fix | Delete

/**

[67] Fix | Delete

* Construct with SubmissionAggregate

[68] Fix | Delete

[69] Fix | Delete

* Lookup array properties are not populated until the first request for

[70] Fix | Delete

* either fieldTypes, label/adminLable, or fieldIds.

[71] Fix | Delete

[72] Fix | Delete

* @param SubmissionAggregate $submissionAggregate

[73] Fix | Delete

[74] Fix | Delete

public function __construct(SubmissionAggregate $submissionAggregate)

[75] Fix | Delete

{

[76] Fix | Delete

$this->submissionAggregate = $submissionAggregate;

[77] Fix | Delete

}

[78] Fix | Delete

[79] Fix | Delete

[80] Fix | Delete

/**

[81] Fix | Delete

* Return array of field labels keyed on field keys

[82] Fix | Delete

[83] Fix | Delete

* If hiddenFieldTypes array is set, labels filtered to hide those types

[84] Fix | Delete

[85] Fix | Delete

* @param bool $useAdminLabels Optionally use admin_labels

[86] Fix | Delete

* @return array

[87] Fix | Delete

[88] Fix | Delete

public function getLabels(?bool $useAdminLabels = false): array

[89] Fix | Delete

{

[90] Fix | Delete

if (!isset($this->labels)) {

[91] Fix | Delete

$this->constructFieldLookups();

[92] Fix | Delete

}

[93] Fix | Delete

[94] Fix | Delete

if ($useAdminLabels) {

[95] Fix | Delete

$return = $this->adminLabels;

[96] Fix | Delete

} else {

[97] Fix | Delete

$return = $this->labels;

[98] Fix | Delete

}

[99] Fix | Delete

[100] Fix | Delete

return $return;

[101] Fix | Delete

}

[102] Fix | Delete

[103] Fix | Delete

/**

[104] Fix | Delete

* Return array of field types keyed on field keys

[105] Fix | Delete

[106] Fix | Delete

* @return array

[107] Fix | Delete

[108] Fix | Delete

public function getFieldTypes(): array

[109] Fix | Delete

{

[110] Fix | Delete

if (!isset($this->fieldTypes)) {

[111] Fix | Delete

$this->constructFieldLookups();

[112] Fix | Delete

}

[113] Fix | Delete

[114] Fix | Delete

return $this->fieldTypes;

[115] Fix | Delete

}

[116] Fix | Delete

[117] Fix | Delete

/**

[118] Fix | Delete

* Return array of field Ids keyed on field keys

[119] Fix | Delete

[120] Fix | Delete

public function getFieldIds(): array

[121] Fix | Delete

{

[122] Fix | Delete

if (!isset($this->fieldIds)) {

[123] Fix | Delete

$this->constructFieldLookups();

[124] Fix | Delete

}

[125] Fix | Delete

[126] Fix | Delete

return $this->fieldIds;

[127] Fix | Delete

}

[128] Fix | Delete

[129] Fix | Delete

/**

[130] Fix | Delete

* Return array of submission Ids in the collection

[131] Fix | Delete

[132] Fix | Delete

* Generated at time of request to ensure it is up to date after last

[133] Fix | Delete

* query / construction

[134] Fix | Delete

* @return array

[135] Fix | Delete

[136] Fix | Delete

public function getSubmissionIds(): array

[137] Fix | Delete

{

[138] Fix | Delete

$idArray = [];

[139] Fix | Delete

[140] Fix | Delete

/** @var SingleSubmission $singleSubmission */

[141] Fix | Delete

foreach ($this->submissionAggregate->getAggregatedSubmissions() as $singleSubmission) {

[142] Fix | Delete

$idArray[] = $singleSubmission->getSubmissionRecordId();

[143] Fix | Delete

}

[144] Fix | Delete

[145] Fix | Delete

return $idArray;

[146] Fix | Delete

}

[147] Fix | Delete

[148] Fix | Delete

/**

[149] Fix | Delete

* Get column values for a given submission aggregated key

[150] Fix | Delete

[151] Fix | Delete

* @param string $aggregatedKey

[152] Fix | Delete

* @return array

[153] Fix | Delete

[154] Fix | Delete

public function getColumnValuesByAggregatedKey(string $aggregatedKey): array

[155] Fix | Delete

{

[156] Fix | Delete

$this->columnValues = [];

[157] Fix | Delete

$singleSubmission = $this->submissionAggregate->getSubmissionValuesByAggregatedKey($aggregatedKey);

[158] Fix | Delete

[159] Fix | Delete

$populatedfieldDefinitionCollection = $singleSubmission->getSubmissionFieldCollection();

[160] Fix | Delete

[161] Fix | Delete

foreach($populatedfieldDefinitionCollection as $populatedSubmissionField){

[162] Fix | Delete

$this->extractSubmissionFieldData($populatedSubmissionField,false);

[163] Fix | Delete

}

[164] Fix | Delete

[165] Fix | Delete

return $this->columnValues;

[166] Fix | Delete

}

[167] Fix | Delete

[168] Fix | Delete

/**

[169] Fix | Delete

* Construct labels/adminLabels from submission aggregate

[170] Fix | Delete

[171] Fix | Delete

* @return void

[172] Fix | Delete

[173] Fix | Delete

protected function constructFieldLookups(): void

[174] Fix | Delete

{

[175] Fix | Delete

// Initializee;

[176] Fix | Delete

$this->labels = [];

[177] Fix | Delete

$this->adminLabels = [];

[178] Fix | Delete

$this->fieldTypes = [];

[179] Fix | Delete

[180] Fix | Delete

$fieldDefinitionCollection = $this->submissionAggregate->getFieldDefinitionCollection();

[181] Fix | Delete

[182] Fix | Delete

/** @var SubmissionField $submissionField */

[183] Fix | Delete

foreach ($fieldDefinitionCollection as $submissionField) {

[184] Fix | Delete

[185] Fix | Delete

$this->extractSubmissionFieldData($submissionField, true);

[186] Fix | Delete

}

[187] Fix | Delete

}

[188] Fix | Delete

[189] Fix | Delete

/**

[190] Fix | Delete

* Given submission field, extract labels + meta, or submission values

[191] Fix | Delete

[192] Fix | Delete

* @param SubmissionField $submissionField

[193] Fix | Delete

* @param boolean|null $labelsOnly

[194] Fix | Delete

* @return void

[195] Fix | Delete

[196] Fix | Delete

protected function extractSubmissionFieldData(SubmissionField $submissionField, ?bool $labelsOnly = false): void

[197] Fix | Delete

{

[198] Fix | Delete

// omit from collection if type is part of hidden field type collection

[199] Fix | Delete

if (

[200] Fix | Delete

isset($this->hiddenFieldTypes) &&

[201] Fix | Delete

in_array($submissionField->getType(), $this->hiddenFieldTypes)

[202] Fix | Delete

) {

[203] Fix | Delete

return;

[204] Fix | Delete

}

[205] Fix | Delete

[206] Fix | Delete

if ('repeater' === $submissionField->getType()) {

[207] Fix | Delete

[208] Fix | Delete

$this->extractRepeaterFieldColumns($submissionField, $labelsOnly);

[209] Fix | Delete

return;

[210] Fix | Delete

}

[211] Fix | Delete

[212] Fix | Delete

if ($labelsOnly) {

[213] Fix | Delete

[214] Fix | Delete

$this->setFieldMetaData($submissionField);

[215] Fix | Delete

[216] Fix | Delete

$this->setFieldLabels($submissionField);

[217] Fix | Delete

return;

[218] Fix | Delete

}

[219] Fix | Delete

[220] Fix | Delete

$key = $submissionField->getSlug();

[221] Fix | Delete

[222] Fix | Delete

if(''==$key){

[223] Fix | Delete

$key=$submissionField->getId();

[224] Fix | Delete

}

[225] Fix | Delete

[226] Fix | Delete

$rawValue = $submissionField->getValue();

[227] Fix | Delete

[228] Fix | Delete

$nfField = $this->convertSubmissionFieldToNfField($submissionField);

[229] Fix | Delete

[230] Fix | Delete

$filteredValue = $this->filterRawValue($key,$rawValue, $nfField);

[231] Fix | Delete

[232] Fix | Delete

if(\is_array($filteredValue)){

[233] Fix | Delete

$filteredValue = \implode(',',$filteredValue);

[234] Fix | Delete

}

[235] Fix | Delete

[236] Fix | Delete

$this->setColumnValue($key,$filteredValue);

[237] Fix | Delete

}

[238] Fix | Delete

[239] Fix | Delete

[240] Fix | Delete

/**

[241] Fix | Delete

* Construct NF Field from SubmissionField

[242] Fix | Delete

[243] Fix | Delete

* NF Field is needed to apply existing NF filters

[244] Fix | Delete

[245] Fix | Delete

[246] Fix | Delete

* @param SubmissionField $submissionField

[247] Fix | Delete

* @return Field

[248] Fix | Delete

[249] Fix | Delete

protected function convertSubmissionFieldToNfField(SubmissionField $submissionField):Field

[250] Fix | Delete

{

[251] Fix | Delete

$nfField = Field::fromArray(

[252] Fix | Delete

[

[253] Fix | Delete

'id'=>$submissionField->getId(),

[254] Fix | Delete

'type'=>$submissionField->getType(),

[255] Fix | Delete

'settings'=>$submissionField->getOriginal() ]

[256] Fix | Delete

);

[257] Fix | Delete

[258] Fix | Delete

return $nfField;

[259] Fix | Delete

}

[260] Fix | Delete

[261] Fix | Delete

/**

[262] Fix | Delete

* Extract repeater field column headers

[263] Fix | Delete

[264] Fix | Delete

* @todo Enable external setting of in-CSV delimiter

[265] Fix | Delete

* @todo ~L258 - adjust deconstructed value to handle listmultiselect arrays (other fields may also have arrays)

[266] Fix | Delete

* @param SubmissionField $submissionField

[267] Fix | Delete

* @return void

[268] Fix | Delete

[269] Fix | Delete

protected function extractRepeaterFieldColumns(SubmissionField $submissionField, bool $labelsOnly): void

[270] Fix | Delete

{

[271] Fix | Delete

$repeaterFieldsCollection =$this->extractRepeaterFieldsFromSubmisionField($submissionField);

[272] Fix | Delete

[273] Fix | Delete

if (empty($repeaterFieldsCollection)) {

[274] Fix | Delete

return;

[275] Fix | Delete

}

[276] Fix | Delete

[277] Fix | Delete

$deconstructedValues = $this->deconstructRepeaterFieldValue((array)$submissionField->getValue());

[278] Fix | Delete

[279] Fix | Delete

// iterate each SubmissionField within the repeater fields collection

[280] Fix | Delete

foreach ($repeaterFieldsCollection as $repeaterField) {

[281] Fix | Delete

[282] Fix | Delete

if( !in_array($repeaterField->type, $this->hiddenFieldTypes) ){

[283] Fix | Delete

[284] Fix | Delete

if($labelsOnly){

[285] Fix | Delete

[286] Fix | Delete

$this->setFieldMetaData($repeaterField);

[287] Fix | Delete

$this->setFieldLabels($repeaterField);

[288] Fix | Delete

continue;

[289] Fix | Delete

}

[290] Fix | Delete

[291] Fix | Delete

$nfField = $this->convertSubmissionFieldToNfField($repeaterField);

[292] Fix | Delete

[293] Fix | Delete

$filteredValues = [];

[294] Fix | Delete

$filteredValue = "";

[295] Fix | Delete

$id = $repeaterField->getId();

[296] Fix | Delete

$key = $repeaterField->getSlug();

[297] Fix | Delete

[298] Fix | Delete

if(''==$key){

[299] Fix | Delete

$key=$repeaterField->getId();

[300] Fix | Delete

}

[301] Fix | Delete

[302] Fix | Delete

if(isset($deconstructedValues[$id])){

[303] Fix | Delete

[304] Fix | Delete

foreach($deconstructedValues[$id] as $rawRepeatedValueArray){

[305] Fix | Delete

[306] Fix | Delete

$rawRepeatedValue = $rawRepeatedValueArray['value'];

[307] Fix | Delete

[308] Fix | Delete

$filteredValue = $this->filterRawValue($key,$rawRepeatedValue, $nfField);

[309] Fix | Delete

[310] Fix | Delete

if(\is_array($filteredValue)){

[311] Fix | Delete

$filteredValue = \implode(',',$filteredValue);

[312] Fix | Delete

}

[313] Fix | Delete

[314] Fix | Delete

$filteredValues[] = $filteredValue;

[315] Fix | Delete

[316] Fix | Delete

}

[317] Fix | Delete

}

[318] Fix | Delete

[319] Fix | Delete

//Construct an array of rows instead of column value if repeater was repeated (index that array by "repeater" for later reference)

[320] Fix | Delete

if( count($filteredValues) > 0){

[321] Fix | Delete

$this->setColumnValue("repeater", [$key, $filteredValues]);

[322] Fix | Delete

} else {

[323] Fix | Delete

$this->setColumnValue($key, $filteredValue);

[324] Fix | Delete

}

[325] Fix | Delete

[326] Fix | Delete

}

[327] Fix | Delete

}

[328] Fix | Delete

}

[329] Fix | Delete

[330] Fix | Delete

/**

[331] Fix | Delete

* Extracts collection of SubmissionFields within a fieldset repeater

[332] Fix | Delete

[333] Fix | Delete

* @param SubmissionField $submissionField

[334] Fix | Delete

* @return SubmissionField[]

[335] Fix | Delete

[336] Fix | Delete

protected function extractRepeaterFieldsFromSubmisionField(SubmissionField $submissionField): array

[337] Fix | Delete

{

[338] Fix | Delete

$return =[];

[339] Fix | Delete

[340] Fix | Delete

$repeaterFieldsArray = $submissionField->getFieldsetRepeaterFields();

[341] Fix | Delete

$keyedFieldSettings = $this->constructRepeaterFieldSettingsLookup($submissionField);

[342] Fix | Delete

[343] Fix | Delete

// iterate each SubmissionField within the repeater fields collection

[344] Fix | Delete

foreach ($repeaterFieldsArray as $repeaterFieldArray) {

[345] Fix | Delete

[346] Fix | Delete

if (isset($repeaterFieldArray['key'])) {

[347] Fix | Delete

$repeaterFieldArray['slug'] = $repeaterFieldArray['key'];

[348] Fix | Delete

unset($repeaterFieldArray['key']);

[349] Fix | Delete

}

[350] Fix | Delete

[351] Fix | Delete

if (isset($repeaterFieldArray['admin_label'])) {

[352] Fix | Delete

$repeaterFieldArray['adminLabel'] = $repeaterFieldArray['admin_label'];

[353] Fix | Delete

unset($repeaterFieldArray['admin_label']);

[354] Fix | Delete

}

[355] Fix | Delete

[356] Fix | Delete

$id = isset($repeaterFieldArray)?$repeaterFieldArray['id']:'';

[357] Fix | Delete

[358] Fix | Delete

if (isset($keyedFieldSettings[$id])) {

[359] Fix | Delete

$repeaterFieldArray['original'] = $keyedFieldSettings[$id];

[360] Fix | Delete

} else {

[361] Fix | Delete

$repeaterFieldArray['original'] = [];

[362] Fix | Delete

}

[363] Fix | Delete

[364] Fix | Delete

[365] Fix | Delete

$repeaterField = SubmissionField::fromArray($repeaterFieldArray);

[366] Fix | Delete

[367] Fix | Delete

$return[] = $repeaterField;

[368] Fix | Delete

}

[369] Fix | Delete

[370] Fix | Delete

return $return;

[371] Fix | Delete

}

[372] Fix | Delete

[373] Fix | Delete

[374] Fix | Delete

/**

[375] Fix | Delete

* Construct lookup of field settings for fields within fieldset repeater field

[376] Fix | Delete

[377] Fix | Delete

* @param SubmissionField $submissionField

[378] Fix | Delete

* @return array

[379] Fix | Delete

[380] Fix | Delete

protected function constructRepeaterFieldSettingsLookup(SubmissionField $submissionField): array

[381] Fix | Delete

{

[382] Fix | Delete

$keyedFieldSettings = [];

[383] Fix | Delete

[384] Fix | Delete

$originalFieldSettings = $submissionField->getOriginal();

[385] Fix | Delete

[386] Fix | Delete

if (!empty($originalFieldSettings['fields'])) {

[387] Fix | Delete

[388] Fix | Delete

$nestedFieldKeys = \array_column($originalFieldSettings['fields'], 'id');

[389] Fix | Delete

[390] Fix | Delete

$keyedFieldSettings = \array_combine($nestedFieldKeys, $originalFieldSettings['fields']);

[391] Fix | Delete

}

[392] Fix | Delete

[393] Fix | Delete

return $keyedFieldSettings;

[394] Fix | Delete

}

[395] Fix | Delete

[396] Fix | Delete

/**

[397] Fix | Delete

* Ensure each repeater field value is a string

[398] Fix | Delete

[399] Fix | Delete

* @param SubmissionField $submissionField

[400] Fix | Delete

* @param array $deconstructedValue

[401] Fix | Delete

* @param string $repeatedValueDelimiter

[402] Fix | Delete

* @return string

[403] Fix | Delete

[404] Fix | Delete

protected function getStringedValue(SubmissionField $submissionField, array $deconstructedValue, string $repeatedValueDelimiter): string

[405] Fix | Delete

{

[406] Fix | Delete

$arrayTypes =['listmultiselect'];

[407] Fix | Delete

[408] Fix | Delete

$valueColumn = \array_column( $deconstructedValue,'value');

[409] Fix | Delete

[410] Fix | Delete

if(\in_array($submissionField->getType(),$arrayTypes)){

[411] Fix | Delete

[412] Fix | Delete

foreach($valueColumn as &$value){

[413] Fix | Delete

$value=implode(',',$value);

[414] Fix | Delete

}

[415] Fix | Delete

}

[416] Fix | Delete

$return = implode($repeatedValueDelimiter,$valueColumn);

[417] Fix | Delete

[418] Fix | Delete

return $return;

[419] Fix | Delete

}

[420] Fix | Delete

[421] Fix | Delete

/**

[422] Fix | Delete

* Deconstruct repeater field array by repeated fields

[423] Fix | Delete

[424] Fix | Delete

[425] Fix | Delete

* @todo Add exception handling for unexpected key structure

[426] Fix | Delete

* @param array $constructedValue

[427] Fix | Delete

* @return array

[428] Fix | Delete

[429] Fix | Delete

protected function deconstructRepeaterFieldValue(array $constructedValue): array

[430] Fix | Delete

{

[431] Fix | Delete

$delimiter = '_';

[432] Fix | Delete

[433] Fix | Delete

$return = [];

[434] Fix | Delete

foreach ($constructedValue as $constructedKey => $submissionValue) {

[435] Fix | Delete

[436] Fix | Delete

$exploded = explode($delimiter,$constructedKey);

[437] Fix | Delete

[438] Fix | Delete

if(isset($exploded[1])){

[439] Fix | Delete

[440] Fix | Delete

$return[$exploded[0]][$exploded[1]]=$submissionValue;

[441] Fix | Delete

}

[442] Fix | Delete

}

[443] Fix | Delete

[444] Fix | Delete

return $return;

[445] Fix | Delete

}

[446] Fix | Delete

[447] Fix | Delete

/**

[448] Fix | Delete

* Add key value lookups for labels and admin labels

[449] Fix | Delete

[450] Fix | Delete

* @param string $slug

[451] Fix | Delete

* @param string $label

[452] Fix | Delete

* @param string $adminLabel

[453] Fix | Delete

* @return void

[454] Fix | Delete

[455] Fix | Delete

protected function setFieldLabels(SubmissionField $submissionField): void

[456] Fix | Delete

{

[457] Fix | Delete

$slug = $submissionField->getSlug();

[458] Fix | Delete

[459] Fix | Delete

if(''==$slug){

[460] Fix | Delete

$slug=$submissionField->getId();

[461] Fix | Delete

}

[462] Fix | Delete

[463] Fix | Delete

$label = $submissionField->getLabel();

[464] Fix | Delete

[465] Fix | Delete

$adminLabel = $submissionField->getAdminLabel();

[466] Fix | Delete

[467] Fix | Delete

$this->labels[$slug] = \WPN_Helper::maybe_escape_csv_column( $label );

[468] Fix | Delete

[469] Fix | Delete

if ('' !== $adminLabel) {

[470] Fix | Delete

$this->adminLabels[$slug] = \WPN_Helper::maybe_escape_csv_column( $adminLabel );

[471] Fix | Delete

} else {

[472] Fix | Delete

// set adminLabel default as field label

[473] Fix | Delete

$this->adminLabels[$slug] = $this->labels[$slug];

[474] Fix | Delete

}

[475] Fix | Delete

}

[476] Fix | Delete

[477] Fix | Delete

/**

[478] Fix | Delete

* Add key value lookups for Id and type on all fields in collection

[479] Fix | Delete

[480] Fix | Delete

* This includes hidden fields and parent fieldset repeater fields

[481] Fix | Delete

[482] Fix | Delete

* @param SubmissionField $submissionField

[483] Fix | Delete

* @return void

[484] Fix | Delete

[485] Fix | Delete

protected function setFieldMetaData(SubmissionField $submissionField): void

[486] Fix | Delete

{

[487] Fix | Delete

$slug = $submissionField->getSlug();

[488] Fix | Delete

[489] Fix | Delete

if(''==$slug){

[490] Fix | Delete

$slug = $submissionField->getId();

[491] Fix | Delete

}

[492] Fix | Delete

[493] Fix | Delete

$this->fieldTypes[$slug] = $submissionField->getType();

[494] Fix | Delete

$this->fieldIds[$slug] = $submissionField->getId();

[495] Fix | Delete

}

[496] Fix | Delete

[497] Fix | Delete

/**

[498] Fix | Delete

* Set column value for a given field

[499] Fix | Delete