Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace NinjaForms\Includes\Entities;

[2] Fix | Delete

[3] Fix | Delete

use NinjaForms\Includes\Entities\SubmissionField;

[4] Fix | Delete

use NinjaForms\Includes\Entities\SimpleEntity;

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Entity defining Single Submission data structure

[8] Fix | Delete

[9] Fix | Delete

class SingleSubmission extends SimpleEntity

[10] Fix | Delete

{

[11] Fix | Delete

[12] Fix | Delete

const TIMESTAMP_FORMAT = 'Y-m-d H:i:s';

[13] Fix | Delete

[14] Fix | Delete

/**

[15] Fix | Delete

* Submission Id

[16] Fix | Delete

[17] Fix | Delete

* @var string

[18] Fix | Delete

[19] Fix | Delete

protected $submissionRecordId = '';

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* Submission time stamp

[23] Fix | Delete

[24] Fix | Delete

[25] Fix | Delete

* @var string

[26] Fix | Delete

[27] Fix | Delete

protected $timestamp = '';

[28] Fix | Delete

[29] Fix | Delete

/**

[30] Fix | Delete

* Form Id to which the submission belongs

[31] Fix | Delete

[32] Fix | Delete

* @var string

[33] Fix | Delete

[34] Fix | Delete

protected $formId = '';

[35] Fix | Delete

[36] Fix | Delete

/**

[37] Fix | Delete

* Identifier of where submission is stored

[38] Fix | Delete

[39] Fix | Delete

* It is a programmatic name to uniquely identify any given storage

[40] Fix | Delete

* location, such as NF post, CF table

[41] Fix | Delete

[42] Fix | Delete

* @var string

[43] Fix | Delete

[44] Fix | Delete

protected $dataSource = '';

[45] Fix | Delete

[46] Fix | Delete

/**

[47] Fix | Delete

* Submission status

[48] Fix | Delete

[49] Fix | Delete

* @var array

[50] Fix | Delete

[51] Fix | Delete

protected $status = [];

[52] Fix | Delete

/**

[53] Fix | Delete

* Collection of submitted values stored as SubmissionField entities

[54] Fix | Delete

[55] Fix | Delete

* Keyed on field slug within the collection. The collection may be empty

[56] Fix | Delete

* if the submission data has not been retrieved yet.

[57] Fix | Delete

[58] Fix | Delete

* @var SubmissionField[]

[59] Fix | Delete

[60] Fix | Delete

protected $submissionFieldCollection = [];

[61] Fix | Delete

[62] Fix | Delete

/**

[63] Fix | Delete

* Extra data values stored with submission

[64] Fix | Delete

[65] Fix | Delete

* Data structured as indexed array of MetaboxOutputEntity->toArray()

[66] Fix | Delete

* @var array

[67] Fix | Delete

[68] Fix | Delete

protected $extraValues=[];

[69] Fix | Delete

[70] Fix | Delete

[71] Fix | Delete

/**

[72] Fix | Delete

* Associative array (string) of classes providing additional submission handling

[73] Fix | Delete

[74] Fix | Delete

* @var array

[75] Fix | Delete

[76] Fix | Delete

protected $submissionHandlers=[];

[77] Fix | Delete

[78] Fix | Delete

/**

[79] Fix | Delete

* Sequence number

[80] Fix | Delete

[81] Fix | Delete

* @var int

[82] Fix | Delete

[83] Fix | Delete

protected $seq_num;

[84] Fix | Delete

[85] Fix | Delete

/**

[86] Fix | Delete

* User ID of the submitter, "0" if user non logged-in

[87] Fix | Delete

[88] Fix | Delete

* @var string

[89] Fix | Delete

[90] Fix | Delete

protected $submitterId = "";

[91] Fix | Delete

[92] Fix | Delete

/**

[93] Fix | Delete

* Get a field value by the field slug

[94] Fix | Delete

[95] Fix | Delete

* @param string $fieldSlug

[96] Fix | Delete

* @return void

[97] Fix | Delete

[98] Fix | Delete

public function getSubmissionFieldValue(string $fieldSlug)

[99] Fix | Delete

{

[100] Fix | Delete

$return = null;

[101] Fix | Delete

[102] Fix | Delete

if (isset($this->submissionFieldCollection[$fieldSlug])) {

[103] Fix | Delete

$submissionField = $this->submissionFieldCollection[$fieldSlug];

[104] Fix | Delete

$return = $submissionField->getValue();

[105] Fix | Delete

}

[106] Fix | Delete

[107] Fix | Delete

return $return;

[108] Fix | Delete

}

[109] Fix | Delete

[110] Fix | Delete

/**

[111] Fix | Delete

* Construct entity from associative array

[112] Fix | Delete

[113] Fix | Delete

* @param array $items

[114] Fix | Delete

* @return SingleSubmission

[115] Fix | Delete

[116] Fix | Delete

public static function fromArray(array $items): SingleSubmission

[117] Fix | Delete

{

[118] Fix | Delete

$obj = new static();

[119] Fix | Delete

[120] Fix | Delete

foreach ($items as $property => $value) {

[121] Fix | Delete

[122] Fix | Delete

// Pass field value through entity to validate, then add, keyed on slug

[123] Fix | Delete

if ('submissionFieldCollection' === $property) {

[124] Fix | Delete

foreach ($value as $fieldValueArray) {

[125] Fix | Delete

$fieldValueObject = SubmissionField::fromArray($fieldValueArray);

[126] Fix | Delete

$obj->submissionFieldCollection[$fieldValueObject->getSlug()] = $fieldValueObject;

[127] Fix | Delete

}

[128] Fix | Delete

} else {

[129] Fix | Delete

[130] Fix | Delete

$obj = $obj->__set($property, $value);

[131] Fix | Delete

}

[132] Fix | Delete

}

[133] Fix | Delete

return $obj;

[134] Fix | Delete

}

[135] Fix | Delete

[136] Fix | Delete

/**

[137] Fix | Delete

* Constructs an array representation

[138] Fix | Delete

[139] Fix | Delete

public function toArray(): array

[140] Fix | Delete

{

[141] Fix | Delete

$vars = get_object_vars($this);

[142] Fix | Delete

[143] Fix | Delete

$array = ['submissionFieldCollection' => []];

[144] Fix | Delete

[145] Fix | Delete

foreach ($vars as $property => $value) {

[146] Fix | Delete

if ('submissionFieldCollection' === $property) {

[147] Fix | Delete

foreach ($value as $submissionField) {

[148] Fix | Delete

$submissionFieldArray = $submissionField->toArray();

[149] Fix | Delete

$array['submissionFieldCollection'][$submissionField->getSlug()] = $submissionFieldArray;

[150] Fix | Delete

}

[151] Fix | Delete

} else {

[152] Fix | Delete

$array[$property] = $value;

[153] Fix | Delete

}

[154] Fix | Delete

}

[155] Fix | Delete

return $array;

[156] Fix | Delete

}

[157] Fix | Delete

[158] Fix | Delete

/**

[159] Fix | Delete

* Get submission Id

[160] Fix | Delete

[161] Fix | Delete

* @return string

[162] Fix | Delete

[163] Fix | Delete

public function getSubmissionRecordId(): string

[164] Fix | Delete

{

[165] Fix | Delete

return $this->submissionRecordId;

[166] Fix | Delete

}

[167] Fix | Delete

[168] Fix | Delete

/**

[169] Fix | Delete

* Set submission Id

[170] Fix | Delete

[171] Fix | Delete

* @param string $submissionRecordId Submission Id

[172] Fix | Delete

[173] Fix | Delete

* @return self

[174] Fix | Delete

[175] Fix | Delete

public function setSubmissionId(string $submissionRecordId): SingleSubmission

[176] Fix | Delete

{

[177] Fix | Delete

$this->submissionRecordId = $submissionRecordId;

[178] Fix | Delete

[179] Fix | Delete

return $this;

[180] Fix | Delete

}

[181] Fix | Delete

[182] Fix | Delete

[183] Fix | Delete

/**

[184] Fix | Delete

* Get submission time stamp

[185] Fix | Delete

[186] Fix | Delete

* @return string

[187] Fix | Delete

[188] Fix | Delete

public function getTimestamp(): string

[189] Fix | Delete

{

[190] Fix | Delete

return $this->timestamp;

[191] Fix | Delete

}

[192] Fix | Delete

[193] Fix | Delete

/**

[194] Fix | Delete

* Set submission time stamp

[195] Fix | Delete

[196] Fix | Delete

* Force standard format

[197] Fix | Delete

* @param string $timestamp Submission time stamp

[198] Fix | Delete

[199] Fix | Delete

* @return self

[200] Fix | Delete

[201] Fix | Delete

public function setTimestamp(string $timestamp)

[202] Fix | Delete

{

[203] Fix | Delete

$this->timestamp = date(self::TIMESTAMP_FORMAT, \strtotime($timestamp));

[204] Fix | Delete

[205] Fix | Delete

return $this;

[206] Fix | Delete

}

[207] Fix | Delete

[208] Fix | Delete

/**

[209] Fix | Delete

* Get form Id to which the submission belongs

[210] Fix | Delete

[211] Fix | Delete

* @return string

[212] Fix | Delete

[213] Fix | Delete

public function getFormId(): string

[214] Fix | Delete

{

[215] Fix | Delete

return $this->formId;

[216] Fix | Delete

}

[217] Fix | Delete

[218] Fix | Delete

/**

[219] Fix | Delete

* Set form Id to which the submission belongs

[220] Fix | Delete

[221] Fix | Delete

* @param string $formId Form Id to which the submission belongs

[222] Fix | Delete

[223] Fix | Delete

* @return self

[224] Fix | Delete

[225] Fix | Delete

public function setFormId(string $formId): SingleSubmission

[226] Fix | Delete

{

[227] Fix | Delete

$this->formId = $formId;

[228] Fix | Delete

[229] Fix | Delete

return $this;

[230] Fix | Delete

}

[231] Fix | Delete

[232] Fix | Delete

[233] Fix | Delete

/**

[234] Fix | Delete

* Get dataSource

[235] Fix | Delete

[236] Fix | Delete

* Typical locations include NF post, CF table

[237] Fix | Delete

[238] Fix | Delete

* @return string

[239] Fix | Delete

[240] Fix | Delete

public function getDataSource(): string

[241] Fix | Delete

{

[242] Fix | Delete

return $this->dataSource;

[243] Fix | Delete

}

[244] Fix | Delete

[245] Fix | Delete

/**

[246] Fix | Delete

* Set submitted values as collection of SubmissionField entities

[247] Fix | Delete

[248] Fix | Delete

* @param array $submissionFieldCollection SubmissionField entities keyed on field slug

[249] Fix | Delete

[250] Fix | Delete

* @return SingleSubmission

[251] Fix | Delete

[252] Fix | Delete

public function setSubmissionFieldCollection(array $submissionFieldCollection): SingleSubmission

[253] Fix | Delete

{

[254] Fix | Delete

$this->submissionFieldCollection = $submissionFieldCollection;

[255] Fix | Delete

[256] Fix | Delete

return $this;

[257] Fix | Delete

}

[258] Fix | Delete

[259] Fix | Delete

/**

[260] Fix | Delete

* Get submitted values as collection of SubmissionField entities

[261] Fix | Delete

[262] Fix | Delete

* @return array

[263] Fix | Delete

[264] Fix | Delete

public function getSubmissionFieldCollection(): array

[265] Fix | Delete

{

[266] Fix | Delete

return $this->submissionFieldCollection;

[267] Fix | Delete

}

[268] Fix | Delete

[269] Fix | Delete

/**

[270] Fix | Delete

* Return array of field slugs for submissionFieldCollection

[271] Fix | Delete

* @return array

[272] Fix | Delete

[273] Fix | Delete

public function getFieldSlugs(): array

[274] Fix | Delete

{

[275] Fix | Delete

$return = \array_keys($this->submissionFieldCollection);

[276] Fix | Delete

[277] Fix | Delete

return $return;

[278] Fix | Delete

}

[279] Fix | Delete

[280] Fix | Delete

/**

[281] Fix | Delete

* Get extra data values stored with submission

[282] Fix | Delete

[283] Fix | Delete

* @return array

[284] Fix | Delete

[285] Fix | Delete

public function getExtraValues():array

[286] Fix | Delete

{

[287] Fix | Delete

return $this->extraValues;

[288] Fix | Delete

}

[289] Fix | Delete

[290] Fix | Delete

/**

[291] Fix | Delete

* Set extra data values stored with submission

[292] Fix | Delete

[293] Fix | Delete

* @param array $extraValues Extra data values stored with submission

[294] Fix | Delete

[295] Fix | Delete

* @return SingleSubmission

[296] Fix | Delete

[297] Fix | Delete

public function setExtraValues(array $extraValues):SingleSubmission

[298] Fix | Delete

{

[299] Fix | Delete

$this->extraValues = $extraValues;

[300] Fix | Delete

[301] Fix | Delete

return $this;

[302] Fix | Delete

}

[303] Fix | Delete

[304] Fix | Delete

/**

[305] Fix | Delete

* Get associative array (string) of classes providing additional submission handling

[306] Fix | Delete

[307] Fix | Delete

* [slug]=>(string)ClassName implements SubmissionHandler

[308] Fix | Delete

* @return array

[309] Fix | Delete

[310] Fix | Delete

public function getSubmissionHandlers():array

[311] Fix | Delete

{

[312] Fix | Delete

return $this->submissionHandlers;

[313] Fix | Delete

}

[314] Fix | Delete

[315] Fix | Delete

/**

[316] Fix | Delete

* Set associative array (string) of classes providing additional submission handling

[317] Fix | Delete

[318] Fix | Delete

* @param array $submissionHandlers Associative array (string) of classes providing additional submission handling

[319] Fix | Delete

[320] Fix | Delete

* @return SingleSubmission

[321] Fix | Delete

[322] Fix | Delete

public function setSubmissionHandlers(array $submissionHandlers):SingleSubmission

[323] Fix | Delete

{

[324] Fix | Delete

$this->submissionHandlers = $submissionHandlers;

[325] Fix | Delete

[326] Fix | Delete

return $this;

[327] Fix | Delete

}

[328] Fix | Delete

[329] Fix | Delete

/**

[330] Fix | Delete

* Get submission status

[331] Fix | Delete

[332] Fix | Delete

* @return array

[333] Fix | Delete

[334] Fix | Delete

public function getStatus():array

[335] Fix | Delete

{

[336] Fix | Delete

return $this->status;

[337] Fix | Delete

}

[338] Fix | Delete

[339] Fix | Delete

/**

[340] Fix | Delete

* Set submission status

[341] Fix | Delete

[342] Fix | Delete

* @param array $status Submission status

[343] Fix | Delete

[344] Fix | Delete

* @return SingleSubmission

[345] Fix | Delete

[346] Fix | Delete

public function setStatus(array $status):SingleSubmission

[347] Fix | Delete

{

[348] Fix | Delete

$this->status = $status;

[349] Fix | Delete

[350] Fix | Delete

return $this;

[351] Fix | Delete

}

[352] Fix | Delete

}

[353] Fix | Delete

[354] Fix | Delete