<?php

[0] Fix | Delete

use NF_Exports_Interfaces_SubmissionCsvExportInterface As SubmissionCsvExportInterface;

[1] Fix | Delete

use NF_Exports_Interfaces_SubmissionCollectionInterface As SubmissionCollectionInterface;

[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\SubmissionAggregateCsvExportAdapter;

[7] Fix | Delete

use NinjaForms\Includes\Handlers\SubmissionAggregate;

[8] Fix | Delete

/**

[9] Fix | Delete

*

[10] Fix | Delete

*/

[11] Fix | Delete

class NF_Exports_SubmissionCsvExport implements SubmissionCsvExportInterface {

[12] Fix | Delete

[13] Fix | Delete

/**

[14] Fix | Delete

* Submission Collection

[15] Fix | Delete

* @var SubmissionCollectionInterface

[16] Fix | Delete

*/

[17] Fix | Delete

public $submissionCollection;

[18] Fix | Delete

[19] Fix | Delete

/** @var SubmissionAggregate */

[20] Fix | Delete

protected $submissionAggregate;

[21] Fix | Delete

[22] Fix | Delete

/** @var SubmissionAggregateCsvExportAdapter */

[23] Fix | Delete

protected $submissionAggregateCsvExportAdapter;

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* Use admin labels boolean

[27] Fix | Delete

* @var bool

[28] Fix | Delete

*/

[29] Fix | Delete

protected $useAdminLabels = false;

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* Date format

[33] Fix | Delete

* @var string

[34] Fix | Delete

*/

[35] Fix | Delete

protected $dateFormat = 'm/d/Y';

[36] Fix | Delete

[37] Fix | Delete

/**

[38] Fix | Delete

* Array of submission ids contained in collection

[39] Fix | Delete

*

[40] Fix | Delete

* @var array

[41] Fix | Delete

*/

[42] Fix | Delete

protected $submissionIds;

[43] Fix | Delete

[44] Fix | Delete

/**

[45] Fix | Delete

* Lookup of NF submission SeqNum by collection Index

[46] Fix | Delete

*

[47] Fix | Delete

* @var array

[48] Fix | Delete

*/

[49] Fix | Delete

protected $seqNumLookup;

[50] Fix | Delete

[51] Fix | Delete

/**

[52] Fix | Delete

* Field labels keyed on field key

[53] Fix | Delete

* @var array

[54] Fix | Delete

*/

[55] Fix | Delete

protected $fieldLabels = [];

[56] Fix | Delete

[57] Fix | Delete

/**

[58] Fix | Delete

* Field types keyed on field key

[59] Fix | Delete

* @var array

[60] Fix | Delete

*/

[61] Fix | Delete

protected $fieldTypes = [];

[62] Fix | Delete

[63] Fix | Delete

/**

[64] Fix | Delete

* Field Ids keyed on field key

[65] Fix | Delete

* @var array

[66] Fix | Delete

*/

[67] Fix | Delete

protected $fieldIds = [];

[68] Fix | Delete

[69] Fix | Delete

/**

[70] Fix | Delete

* Labels row for CSV

[71] Fix | Delete

* @var array

[72] Fix | Delete

*/

[73] Fix | Delete

protected $csvLabels = [];

[74] Fix | Delete

[75] Fix | Delete

/**

[76] Fix | Delete

* Complete array for CSV, including labels row

[77] Fix | Delete

* @var array

[78] Fix | Delete

*/

[79] Fix | Delete

protected $csvValuesCollection = [];

[80] Fix | Delete

[81] Fix | Delete

/**

[82] Fix | Delete

* Generate CSV output and return

[83] Fix | Delete

* @return string

[84] Fix | Delete

*/

[85] Fix | Delete

public function handle(): string

[86] Fix | Delete

{

[87] Fix | Delete

$this->constructLabels();

[88] Fix | Delete

[89] Fix | Delete

$this->csvValuesCollection[0][0] = $this->csvLabels;

[90] Fix | Delete

[91] Fix | Delete

$this->appendRows();

[92] Fix | Delete

[93] Fix | Delete

$returned = $this->prepareCsv();

[94] Fix | Delete

[95] Fix | Delete

return $returned;

[96] Fix | Delete

}

[97] Fix | Delete

[98] Fix | Delete

/**

[99] Fix | Delete

* Append each submission from the collection as a row

[100] Fix | Delete

*/

[101] Fix | Delete

protected function appendRows()

[102] Fix | Delete

{

[103] Fix | Delete

$indices = $this->reverseSubmissionOrder();

[104] Fix | Delete

// populate submission values for each submission in the collection, then append

[105] Fix | Delete

foreach ($indices as $index) {

[106] Fix | Delete

[107] Fix | Delete

$row = $this->constructRow($index);

[108] Fix | Delete

//Catch reference to an array or repeated fieldsets of repeater field to display each entry as a row

[109] Fix | Delete

if (array_key_exists('repeater', $row) && is_array($row['repeater'])) {

[110] Fix | Delete

foreach ($row['repeater'] as $eachRow) {

[111] Fix | Delete

$this->csvValuesCollection[1][0][] = $eachRow;

[112] Fix | Delete

}

[113] Fix | Delete

} else {

[114] Fix | Delete

$this->csvValuesCollection[1][0][] = $row;

[115] Fix | Delete

}

[116] Fix | Delete

}

[117] Fix | Delete

}

[118] Fix | Delete

[119] Fix | Delete

/** @inheritDoc */

[120] Fix | Delete

public function reverseSubmissionOrder(): array

[121] Fix | Delete

{

[122] Fix | Delete

$submissionCollection = $this->submissionAggregateCsvExportAdapter->submissionAggregate->getAggregatedSubmissions();

[123] Fix | Delete

[124] Fix | Delete

$indicesOriginalOrder= array_keys($submissionCollection);

[125] Fix | Delete

[126] Fix | Delete

$return = array_reverse($indicesOriginalOrder);

[127] Fix | Delete

[128] Fix | Delete

return $return;

[129] Fix | Delete

}

[130] Fix | Delete

[131] Fix | Delete

/** @inheritDoc */

[132] Fix | Delete

public function constructRow( $aggregatedKey):array

[133] Fix | Delete

{

[134] Fix | Delete

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

[135] Fix | Delete

[136] Fix | Delete

$this->constructSeqNumLookup($aggregatedKey, $singleSubmission);

[137] Fix | Delete

[138] Fix | Delete

$row = $this->constructSubmissionRow($aggregatedKey, $singleSubmission);

[139] Fix | Delete

//Can be array of $rows since repeaters are divided by rows for each fieldset

[140] Fix | Delete

return $row;

[141] Fix | Delete

}

[142] Fix | Delete

[143] Fix | Delete

/**

[144] Fix | Delete

* Construct string output from previously set params, mark submissions read

[145] Fix | Delete

* @return string

[146] Fix | Delete

*/

[147] Fix | Delete

protected function prepareCsv()

[148] Fix | Delete

{

[149] Fix | Delete

$nfSubs = [];

[150] Fix | Delete

foreach($this->submissionIds as $submissionId){

[151] Fix | Delete

$nfSubs[]=Ninja_Forms()->form( )->get_sub( $submissionId );

[152] Fix | Delete

$subIds[]=$submissionId;

[153] Fix | Delete

}

[154] Fix | Delete

[155] Fix | Delete

$reversedOrderNfSubs = \array_reverse($nfSubs);

[156] Fix | Delete

[157] Fix | Delete

// Get any extra data from our other plugins...

[158] Fix | Delete

$csv_array = apply_filters( 'nf_subs_csv_extra_values', $this->csvValuesCollection, $reversedOrderNfSubs, $this->submissionAggregateCsvExportAdapter->submissionAggregate->getMasterFormId() );

[159] Fix | Delete

[160] Fix | Delete

$output = WPN_Helper::str_putcsv( $csv_array,

[161] Fix | Delete

apply_filters( 'nf_sub_csv_delimiter', ',' ),

[162] Fix | Delete

apply_filters( 'nf_sub_csv_enclosure', '"' ),

[163] Fix | Delete

apply_filters( 'nf_sub_csv_terminator', "\n" )

[164] Fix | Delete

);

[165] Fix | Delete

[166] Fix | Delete

return $output;

[167] Fix | Delete

}

[168] Fix | Delete

[169] Fix | Delete

[170] Fix | Delete

[171] Fix | Delete

/**

[172] Fix | Delete

* For NF CPT, construct lookup from index for SeqNum

[173] Fix | Delete

*

[174] Fix | Delete

* @param string $aggregatedKey

[175] Fix | Delete

* @param SingleSubmission $singleSubmission

[176] Fix | Delete

* @return void

[177] Fix | Delete

*/

[178] Fix | Delete

protected function constructSeqNumLookup(string $aggregatedKey, SingleSubmission $singleSubmission): void

[179] Fix | Delete

{

[180] Fix | Delete

$dataSource = $singleSubmission->getDataSource();

[181] Fix | Delete

[182] Fix | Delete

// only add seq number for NF CPT

[183] Fix | Delete

if('nf_post'!== $dataSource){

[184] Fix | Delete

return;

[185] Fix | Delete

}

[186] Fix | Delete

[187] Fix | Delete

$this->seqNumLookup[$aggregatedKey]= get_post_meta($singleSubmission->getSubmissionRecordId(), '_seq_num', TRUE);

[188] Fix | Delete

}

[189] Fix | Delete

[190] Fix | Delete

/**

[191] Fix | Delete

* Construct a single row in the CSV from a submission

[192] Fix | Delete

*

[193] Fix | Delete

* @todo Refactor to remove DB call for NF()->form()->field() on each iteration

[194] Fix | Delete

* @param SingleSubmission $submission

[195] Fix | Delete

* @return array

[196] Fix | Delete

*/

[197] Fix | Delete

protected function constructSubmissionRow(string $aggregatedKey, SingleSubmission $submission)/* :array */ {

[198] Fix | Delete

[199] Fix | Delete

// Add the standard fields

[200] Fix | Delete

$seqNum = '';

[201] Fix | Delete

[202] Fix | Delete

if(isset($this->seqNumLookup[$aggregatedKey])){

[203] Fix | Delete

$seqNum = $this->seqNumLookup[$aggregatedKey];

[204] Fix | Delete

}

[205] Fix | Delete

[206] Fix | Delete

$row['_seq_num'] = $seqNum;

[207] Fix | Delete

[208] Fix | Delete

$row['_date_submitted'] = $this->formatTimestamp($submission->getTimestamp());

[209] Fix | Delete

[210] Fix | Delete

$columnValues = $this->submissionAggregateCsvExportAdapter->getColumnValuesByAggregatedKey($aggregatedKey);

[211] Fix | Delete

[212] Fix | Delete

if( array_key_exists('repeater', $columnValues) ){

[213] Fix | Delete

$strippedRows = [];

[214] Fix | Delete

$newColumnValues = $columnValues;

[215] Fix | Delete

$repeaterValuesArray = [];

[216] Fix | Delete

unset($newColumnValues['repeater']);

[217] Fix | Delete

$row = array_merge($row, $newColumnValues);

[218] Fix | Delete

//Extract Repeater rows

[219] Fix | Delete

foreach($columnValues['repeater'] as $repeaterFieldID => $repeaterFieldsetRowValue){

[220] Fix | Delete

foreach($repeaterFieldsetRowValue as $index => $fieldsetValue){

[221] Fix | Delete

$repeaterValuesArray[$index][$repeaterFieldID] = $fieldsetValue;

[222] Fix | Delete

}

[223] Fix | Delete

}

[224] Fix | Delete

//insert global row data in repeater rows

[225] Fix | Delete

foreach($repeaterValuesArray as $rowIncludingRepeaterData){

[226] Fix | Delete

$row = array_merge($row, $rowIncludingRepeaterData);

[227] Fix | Delete

$strippedRows["repeater"][] = WPN_Helper::stripslashes($row);

[228] Fix | Delete

}

[229] Fix | Delete

[230] Fix | Delete

return $strippedRows;

[231] Fix | Delete

[232] Fix | Delete

} else {

[233] Fix | Delete

$row = array_merge($row,$columnValues);

[234] Fix | Delete

[235] Fix | Delete

$strippedRow = WPN_Helper::stripslashes($row);

[236] Fix | Delete

[237] Fix | Delete

return $strippedRow;

[238] Fix | Delete

}

[239] Fix | Delete

[240] Fix | Delete

[241] Fix | Delete

}

[242] Fix | Delete

[243] Fix | Delete

/**

[244] Fix | Delete

* Format timestamp for output

[245] Fix | Delete

*

[246] Fix | Delete

* @param string $timestamp

[247] Fix | Delete

* @return string

[248] Fix | Delete

*/

[249] Fix | Delete

protected function formatTimestamp(string $timestamp): string

[250] Fix | Delete

{

[251] Fix | Delete

$dt = DateTime::createFromFormat('Y-m-d H:i:s',$timestamp);

[252] Fix | Delete

[253] Fix | Delete

$return = $dt->format($this->dateFormat);

[254] Fix | Delete

[255] Fix | Delete

return $return;

[256] Fix | Delete

}

[257] Fix | Delete

[258] Fix | Delete

/**

[259] Fix | Delete

* Construct labels array

[260] Fix | Delete

*

[261] Fix | Delete

* Indexed array of labels, which serves as the column headers

[262] Fix | Delete

*/

[263] Fix | Delete

protected function constructLabels()

[264] Fix | Delete

{

[265] Fix | Delete

$this->csvLabels = array_merge($this->getFieldLabelsBeforeFields(), array_values($this->fieldLabels));

[266] Fix | Delete

}

[267] Fix | Delete

[268] Fix | Delete

/**

[269] Fix | Delete

* Return labels for the CSV, including SeqNum and Date

[270] Fix | Delete

*

[271] Fix | Delete

* @return array

[272] Fix | Delete

*/

[273] Fix | Delete

public function getLabels( ): array

[274] Fix | Delete

{

[275] Fix | Delete

if(empty($this->csvLabels)){

[276] Fix | Delete

$this->constructLabels();

[277] Fix | Delete

}

[278] Fix | Delete

return $this->csvLabels;

[279] Fix | Delete

}

[280] Fix | Delete

/**

[281] Fix | Delete

* Return array of labels preceding fields

[282] Fix | Delete

*

[283] Fix | Delete

* @return array

[284] Fix | Delete

*/

[285] Fix | Delete

protected function getFieldLabelsBeforeFields()/* :array */ {

[286] Fix | Delete

$labels = array(

[287] Fix | Delete

'_seq_num' => '#',

[288] Fix | Delete

'_date_submitted' => esc_html__('Date Submitted', 'ninja-forms')

[289] Fix | Delete

);

[290] Fix | Delete

[291] Fix | Delete

return $labels;

[292] Fix | Delete

}

[293] Fix | Delete

[294] Fix | Delete

/**

[295] Fix | Delete

* Set submission collection used in generating the CSV

[296] Fix | Delete

*

[297] Fix | Delete

* @todo Investigate reason for commented out type declarations

[298] Fix | Delete

* @param SubmissionCollectionInterface $submissionCollection

[299] Fix | Delete

* @return SubmissionCsvExportInterface

[300] Fix | Delete

*/

[301] Fix | Delete

public function setSubmissionCollection(SubmissionCollectionInterface $submissionCollection): SubmissionCsvExportInterface

[302] Fix | Delete

{

[303] Fix | Delete

return $this;

[304] Fix | Delete

}

[305] Fix | Delete

[306] Fix | Delete

/**

[307] Fix | Delete

* Set SubmissionAggregateCsvExport Adapter used in generating the CSV

[308] Fix | Delete

*

[309] Fix | Delete

* @param SubmissionAggregateCsvExportAdapter $submissionAggregateCsvExportAdapter

[310] Fix | Delete

* @return SubmissionCsvExportInterface

[311] Fix | Delete

*/

[312] Fix | Delete

public function setSubmissionAggregateCsvExportAdapter(SubmissionAggregateCsvExportAdapter $submissionAggregateCsvExportAdapter) :SubmissionCsvExportInterface

[313] Fix | Delete

{

[314] Fix | Delete

$this->setDateFormat();

[315] Fix | Delete

[316] Fix | Delete

$this->submissionAggregateCsvExportAdapter = $submissionAggregateCsvExportAdapter;

[317] Fix | Delete

[318] Fix | Delete

$this->submissionAggregateCsvExportAdapter->setHiddenFieldTypes([

[319] Fix | Delete

'html', 'submit', 'divider', 'hr', 'note', 'unknown', 'button', 'confirm'

[320] Fix | Delete

]);

[321] Fix | Delete

[322] Fix | Delete

$this->fieldLabels = $this->submissionAggregateCsvExportAdapter->getLabels($this->useAdminLabels);

[323] Fix | Delete

[324] Fix | Delete

$this->fieldTypes = $this->submissionAggregateCsvExportAdapter->getFieldTypes();

[325] Fix | Delete

[326] Fix | Delete

$this->fieldIds = $this->submissionAggregateCsvExportAdapter->getFieldIds();

[327] Fix | Delete

[328] Fix | Delete

$this->submissionIds = $this->submissionAggregateCsvExportAdapter->getSubmissionIds();

[329] Fix | Delete

[330] Fix | Delete

return $this;

[331] Fix | Delete

}

[332] Fix | Delete

[333] Fix | Delete

/**

[334] Fix | Delete

* Set boolean useAdminLabels

[335] Fix | Delete

*

[336] Fix | Delete

* @param bool $useAdminLabels

[337] Fix | Delete

* @return SubmissionCsvExportInterface

[338] Fix | Delete

*/

[339] Fix | Delete

public function setUseAdminLabels($useAdminLabels) :SubmissionCsvExportInterface {

[340] Fix | Delete

$this->useAdminLabels = $useAdminLabels;

[341] Fix | Delete

return $this;

[342] Fix | Delete

}

[343] Fix | Delete

[344] Fix | Delete

/**

[345] Fix | Delete

* Set date format

[346] Fix | Delete

*

[347] Fix | Delete

* @param string $dateFormat

[348] Fix | Delete

* @return SubmissionCsvExportInterface

[349] Fix | Delete

*/

[350] Fix | Delete

public function setDateFormat(string $dateFormat = null): SubmissionCsvExportInterface

[351] Fix | Delete

{

[352] Fix | Delete

if(!empty($dateFormat)) {

[353] Fix | Delete

//Set new date format

[354] Fix | Delete

$date_format = $dateFormat;

[355] Fix | Delete

} else if( !empty( Ninja_Forms()->get_setting( 'date_format' ) ) ) {

[356] Fix | Delete

//Or get NF Date format set

[357] Fix | Delete

$date_format = Ninja_Forms()->get_setting( 'date_format' );

[358] Fix | Delete

} else if(!empty( get_option('date_format'))) {

[359] Fix | Delete

//Or get WP date format set

[360] Fix | Delete

$date_format = get_option('date_format');

[361] Fix | Delete

} else {

[362] Fix | Delete

//Or leave default

[363] Fix | Delete

$date_format = $this->dateFormat;

[364] Fix | Delete

}

[365] Fix | Delete

[366] Fix | Delete

$this->dateFormat = $date_format;

[367] Fix | Delete

[368] Fix | Delete

return $this;

[369] Fix | Delete

}

[370] Fix | Delete

[371] Fix | Delete

}

[372] Fix | Delete

[373] Fix | Delete