Edit File by line

<?php

[0] Fix | Delete

use NF_Exports_SubmissionCollectionFilterParameters as SubmissionCollectionFilterParameters;

[1] Fix | Delete

use NF_Exports_Interfaces_SingleSubmissionInterface as SingleSubmissionInterface;

[2] Fix | Delete

/**

[3] Fix | Delete

* Contract defining required methods for handling submission collection

[4] Fix | Delete

[5] Fix | Delete

[6] Fix | Delete

interface NF_Exports_Interfaces_SubmissionCollectionInterface {

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Return the form Id

[10] Fix | Delete

* @return int

[11] Fix | Delete

[12] Fix | Delete

public function getFormId();

[13] Fix | Delete

[14] Fix | Delete

/**

[15] Fix | Delete

* Return the form title

[16] Fix | Delete

* @return string

[17] Fix | Delete

[18] Fix | Delete

public function getFormTitle();

[19] Fix | Delete

[20] Fix | Delete

/**

[21] Fix | Delete

* Return count of submissions, exported, and unread

[22] Fix | Delete

[23] Fix | Delete

public function getCounts():array ;

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* Set all parameters using NF_Database_Models_SubmissionCollectionInterfaceParameters

[27] Fix | Delete

[28] Fix | Delete

* Using the object ensures all properties are set, with known defaults;

[29] Fix | Delete

* this enables the requesting class to set only values that concerns it

[30] Fix | Delete

* without needing to set any other value or default. The Submission

[31] Fix | Delete

* Collection class knows that all values have valid parameters and can

[32] Fix | Delete

* immediately run the filter.

[33] Fix | Delete

[34] Fix | Delete

* @param SubmissionCollectionFilterParameters $params

[35] Fix | Delete

[36] Fix | Delete

public function filterByParameters(/* SubmissionCollectionFilterParameters */ $params)/* :NF_Database_Models_SubmissionCollectionInterface*/ ;

[37] Fix | Delete

/**

[38] Fix | Delete

* Set start and end dates to filter submissions

[39] Fix | Delete

* @param int|null $startDate Starting date

[40] Fix | Delete

* @param int|null $endDate Ending date

[41] Fix | Delete

[42] Fix | Delete

public function setDateParameters($startDate = null, $endDate = null)/* :NF_Exports_Interfaces_SubmissionCollectionInterface */;

[43] Fix | Delete

[44] Fix | Delete

/**

[45] Fix | Delete

* Set parameter to filter submissions by `isUnread` = true or false

[46] Fix | Delete

[47] Fix | Delete

* @param bool $isUnread

[48] Fix | Delete

[49] Fix | Delete

public function setIsUnreadParameter(bool $isUnread=null)/* :NF_Exports_Interfaces_SubmissionCollectionInterface */;

[50] Fix | Delete

[51] Fix | Delete

/**

[52] Fix | Delete

* Set parameter to filter submissions by `previouslyExported` = true or false

[53] Fix | Delete

[54] Fix | Delete

* @param bool $previouslyExported

[55] Fix | Delete

[56] Fix | Delete

public function setPreviouslyExportedParameter(bool $previouslyExported=null)/* :NF_Exports_Interfaces_SubmissionCollectionInterface */;

[57] Fix | Delete

[58] Fix | Delete

/**

[59] Fix | Delete

* Set max number of submissions to return in a request

[60] Fix | Delete

[61] Fix | Delete

* @param int $maxReturnCount

[62] Fix | Delete

[63] Fix | Delete

public function setMaxReturnCount($maxReturnCount=null)/* :NF_Exports_Interfaces_SubmissionCollectionInterface */;

[64] Fix | Delete

[65] Fix | Delete

/**

[66] Fix | Delete

* Filter collection of submissions based on previously set parameters

[67] Fix | Delete

[68] Fix | Delete

* @return array

[69] Fix | Delete

[70] Fix | Delete

public function filterSubmissions()/* :NF_Exports_Interfaces_SubmissionCollectionInterface */;

[71] Fix | Delete

[72] Fix | Delete

/**

[73] Fix | Delete

* Return submission collection array

[74] Fix | Delete

* @return SingleSubmissionInterface[]

[75] Fix | Delete

[76] Fix | Delete

public function getSubmissions() /* : SingleSubmissionInterface[] */;

[77] Fix | Delete

[78] Fix | Delete

/**

[79] Fix | Delete

* Return array of submission Ids in the collection

[80] Fix | Delete

[81] Fix | Delete

public function getSubmissionIds() /* :array */;

[82] Fix | Delete

[83] Fix | Delete

/**

[84] Fix | Delete

* Return array of field labels keyed on field keys

[85] Fix | Delete

[86] Fix | Delete

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

[87] Fix | Delete

[88] Fix | Delete

* @param bool $useAdminLabels Optionally use admin_labels

[89] Fix | Delete

* @return array

[90] Fix | Delete

[91] Fix | Delete

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

[92] Fix | Delete

[93] Fix | Delete

/**

[94] Fix | Delete

* Return array of field types keyed on field keys

[95] Fix | Delete

[96] Fix | Delete

* @return array

[97] Fix | Delete

[98] Fix | Delete

public function getFieldTypes()/* : array */;

[99] Fix | Delete

[100] Fix | Delete

/**

[101] Fix | Delete

* Return array of field Ids keyed on field keys

[102] Fix | Delete

[103] Fix | Delete

public function getFieldIds()/* :array */;

[104] Fix | Delete

[105] Fix | Delete

/**

[106] Fix | Delete

* Set field types to be removed before output

[107] Fix | Delete

[108] Fix | Delete

* Provided as indexed array of NF field types

[109] Fix | Delete

[110] Fix | Delete

* @param array $hidden

[111] Fix | Delete

[112] Fix | Delete

public function setHiddenFieldTypes(array $hidden)/* : NF_Exports_Interfaces_SubmissionCollectionInterface */;

[113] Fix | Delete

}

[114] Fix | Delete

[115] Fix | Delete