Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace NinjaForms\Includes\Contracts;

[2] Fix | Delete

[3] Fix | Delete

use NinjaForms\Includes\Entities\SingleSubmission;

[4] Fix | Delete

use NinjaForms\Includes\Entities\SubmissionFilter;

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Contract to retrieve a collection of single submissions from a data source

[8] Fix | Delete

[9] Fix | Delete

* Note that the collection has two parts - the submission meta and the

[10] Fix | Delete

* submission values.

[11] Fix | Delete

[12] Fix | Delete

* The meta describes details about the submission such as timestamp, NF form

[13] Fix | Delete

* id, data storage location, and a record id.

[14] Fix | Delete

[15] Fix | Delete

* The values portion is a collection of submission values associated with a

[16] Fix | Delete

* given submission.

[17] Fix | Delete

[18] Fix | Delete

* The two are retrieved separately. This enables fast filtering of submissions

[19] Fix | Delete

* to generate a collection of submission records; then, after initial

[20] Fix | Delete

* filtering, the submission values for just the intended records can be

[21] Fix | Delete

* retrieved.

[22] Fix | Delete

[23] Fix | Delete

interface SubmissionDataSource

[24] Fix | Delete

{

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* Retrieve a collection of submissions meta given filtering args

[28] Fix | Delete

[29] Fix | Delete

* @param array $args

[30] Fix | Delete

* @return SingleSubmission[]

[31] Fix | Delete

[32] Fix | Delete

public function retrieveSubmissionMeta(SubmissionFilter $submissionFilter): array;

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* Populate with submission values a single submission in a collection

[36] Fix | Delete

[37] Fix | Delete

* Submission collection may initially only contain submission meta to save

[38] Fix | Delete

* time/memory. When called, this method retrieves the complete submission

[39] Fix | Delete

* values for the provided SingleSubmision

[40] Fix | Delete

[41] Fix | Delete

* @param SingleSubmission $singleSubmission

[42] Fix | Delete

* @return SingleSubmission

[43] Fix | Delete

[44] Fix | Delete

public function retrieveSubmissionValues(SingleSubmission $singleSubmission): SingleSubmission;

[45] Fix | Delete

[46] Fix | Delete

/**

[47] Fix | Delete

* Retrieve a single submission with values

[48] Fix | Delete

[49] Fix | Delete

* Absent a previously filtered collection of single submissions within the

[50] Fix | Delete

* aggregate, request a single submission, fully populate it, and return.

[51] Fix | Delete

[52] Fix | Delete

* @param SingleSubmission $singleSubmission

[53] Fix | Delete

* @return SingleSubmission

[54] Fix | Delete

[55] Fix | Delete

public function retrieveSingleSubmission(SingleSubmission $singleSubmission): SingleSubmission;

[56] Fix | Delete

[57] Fix | Delete

[58] Fix | Delete

/**

[59] Fix | Delete

* Delete a submission from the data source

[60] Fix | Delete

[61] Fix | Delete

* @param SingleSubmission $singleSubmission

[62] Fix | Delete

* @return SubmissionDataSource

[63] Fix | Delete

[64] Fix | Delete

public function deleteSubmission(SingleSubmission $singleSubmission): SubmissionDataSource;

[65] Fix | Delete

[66] Fix | Delete

/**

[67] Fix | Delete

* Restore a submission from the data source

[68] Fix | Delete

[69] Fix | Delete

* @param SingleSubmission $singleSubmission

[70] Fix | Delete

* @return SubmissionDataSource

[71] Fix | Delete

[72] Fix | Delete

public function restoreSubmission(SingleSubmission $singleSubmission): SubmissionDataSource;

[73] Fix | Delete

[74] Fix | Delete

/**

[75] Fix | Delete

* Update a submission from the data source

[76] Fix | Delete

[77] Fix | Delete

* @param SingleSubmission $singleSubmission

[78] Fix | Delete

* @return SubmissionDataSource

[79] Fix | Delete

[80] Fix | Delete

public function updateSubmission(SingleSubmission $singleSubmission): SubmissionDataSource;

[81] Fix | Delete

[82] Fix | Delete

/**

[83] Fix | Delete

* Return the dataSource id

[84] Fix | Delete

[85] Fix | Delete

* Identifies the implementing class, enabling retrieval of submission

[86] Fix | Delete

* specifics by calling the implementing class

[87] Fix | Delete

[88] Fix | Delete

* @return string

[89] Fix | Delete

[90] Fix | Delete

public function getDataSource( ): string;

[91] Fix | Delete

}

[92] Fix | Delete

[93] Fix | Delete