Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

/**

[2] Fix | Delete

* Contract defining single submission storage and retrieval

[3] Fix | Delete

[4] Fix | Delete

* NOTE: File location would not permanently be in the Models folder; it

[5] Fix | Delete

* currently resides here during initial development.

[6] Fix | Delete

[7] Fix | Delete

interface NF_Exports_Interfaces_SingleSubmissionInterface {

[8] Fix | Delete

[9] Fix | Delete

/**

[10] Fix | Delete

* Get Field Value

[11] Fix | Delete

[12] Fix | Delete

* Return a single submission value by field ID or field key.

[13] Fix | Delete

[14] Fix | Delete

* @param int|string $field_ref

[15] Fix | Delete

* @return string

[16] Fix | Delete

[17] Fix | Delete

public function getFieldValue($field_ref);

[18] Fix | Delete

[19] Fix | Delete

/**

[20] Fix | Delete

* Get all submission field values for a single, pre-defined submission

[21] Fix | Delete

[22] Fix | Delete

* @return array|mixed

[23] Fix | Delete

[24] Fix | Delete

public function getFieldValues();

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* Return the submission Id

[28] Fix | Delete

* @return int

[29] Fix | Delete

[30] Fix | Delete

public function getId();

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* Return the Sequence Number of a predefined submission Id

[34] Fix | Delete

[35] Fix | Delete

public function getSeqNum();

[36] Fix | Delete

[37] Fix | Delete

/**

[38] Fix | Delete

* Return the submission date for predefined submission Id

[39] Fix | Delete

* @param string $format Optional date format

[40] Fix | Delete

[41] Fix | Delete

public function getSubmissionDate($format = 'm/d/Y');

[42] Fix | Delete

[43] Fix | Delete

/**

[44] Fix | Delete

* Filter field values to return only provided keys

[45] Fix | Delete

[46] Fix | Delete

* NOTE: filter is performed on array KEYS of incoming parameter. This

[47] Fix | Delete

* enables use of `field labels` array generated at the collection level,

[48] Fix | Delete

* which is keyed off the same field keys as the submission for perfect

[49] Fix | Delete

* matching of array columns.

[50] Fix | Delete

[51] Fix | Delete

* @param array $fieldKeys Array keyed on field keys with optional value

[52] Fix | Delete

* @return array

[53] Fix | Delete

[54] Fix | Delete

public function filterFieldValues($fieldKeys)/* :array */;

[55] Fix | Delete

[56] Fix | Delete

[57] Fix | Delete

/**

[58] Fix | Delete

* Set timestamp of export

[59] Fix | Delete

* @param int $unixTimestamp

[60] Fix | Delete

[61] Fix | Delete

public function setExportDatetime(int $unixTimestamp);

[62] Fix | Delete

[63] Fix | Delete

/**

[64] Fix | Delete

* Return true if submission has been exported

[65] Fix | Delete

[66] Fix | Delete

* @return bool

[67] Fix | Delete

[68] Fix | Delete

public function wasExported();

[69] Fix | Delete

[70] Fix | Delete

/**

[71] Fix | Delete

* Return bool `true` if submission is unread

[72] Fix | Delete

* @return bool

[73] Fix | Delete

[74] Fix | Delete

public function isUnread();

[75] Fix | Delete

}

[76] Fix | Delete

[77] Fix | Delete