Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace NinjaForms\Includes\Database;

[2] Fix | Delete

[3] Fix | Delete

use NinjaForms\Includes\Contracts\SubmissionDataSource as ContractsSubmissionDataSource;

[4] Fix | Delete

use NinjaForms\Includes\Entities\SingleSubmission;

[5] Fix | Delete

use NinjaForms\Includes\Entities\SubmissionFilter;

[6] Fix | Delete

use NinjaForms\Includes\Entities\SubmissionField;

[7] Fix | Delete

use NinjaForms\Includes\Handlers\DateTimeConverter;

[8] Fix | Delete

[9] Fix | Delete

use \NF_Database_Models_Submission;

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* Retrieves a CPT Ninja Forms submission by its form id

[13] Fix | Delete

[14] Fix | Delete

* CPT indicates NF submissions stored as custom post type

[15] Fix | Delete

[16] Fix | Delete

class CptSubmissionDataSource implements ContractsSubmissionDataSource

[17] Fix | Delete

{

[18] Fix | Delete

[19] Fix | Delete

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

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* Identifier of where submission is stored

[23] Fix | Delete

[24] Fix | Delete

* @var string

[25] Fix | Delete

[26] Fix | Delete

protected $dataSource = 'nf_post';

[27] Fix | Delete

[28] Fix | Delete

/**

[29] Fix | Delete

* Collection of submissions

[30] Fix | Delete

[31] Fix | Delete

* @var SingleSubmission[]

[32] Fix | Delete

[33] Fix | Delete

protected $submissionCollection = [];

[34] Fix | Delete

[35] Fix | Delete

/** @var SubmissionFilter */

[36] Fix | Delete

protected $submissionFilter;

[37] Fix | Delete

[38] Fix | Delete

/**

[39] Fix | Delete

* Form Id of the primary form

[40] Fix | Delete

[41] Fix | Delete

* Form Id used to define fields; other forms can be included in results.

[42] Fix | Delete

[43] Fix | Delete

* @var [type]

[44] Fix | Delete

[45] Fix | Delete

protected $formId = null;

[46] Fix | Delete

[47] Fix | Delete

/** @inheritDoc */

[48] Fix | Delete

public function retrieveSubmissionMeta(SubmissionFilter $submissionFilter): array

[49] Fix | Delete

{

[50] Fix | Delete

$this->submissionFilter = $submissionFilter;

[51] Fix | Delete

[52] Fix | Delete

$this->submissionCollection = [];

[53] Fix | Delete

[54] Fix | Delete

if ([] !== $submissionFilter->getNfFormIds()) {

[55] Fix | Delete

[56] Fix | Delete

$formIdCollection = $submissionFilter->getNfFormIds();

[57] Fix | Delete

[58] Fix | Delete

$this->formId = $formIdCollection[0];

[59] Fix | Delete

[60] Fix | Delete

foreach ($formIdCollection as $formIdFromCollection) {

[61] Fix | Delete

[62] Fix | Delete

$this->retrieveSubmissionMetaByNfFormId($formIdFromCollection);

[63] Fix | Delete

}

[64] Fix | Delete

}

[65] Fix | Delete

[66] Fix | Delete

if(''!==$this->submissionFilter->getSearchString()){

[67] Fix | Delete

$this->applySearchCriterion();

[68] Fix | Delete

}

[69] Fix | Delete

[70] Fix | Delete

return $this->submissionCollection;

[71] Fix | Delete

}

[72] Fix | Delete

[73] Fix | Delete

/** @inheritDoc */

[74] Fix | Delete

public function retrieveSingleSubmission(SingleSubmission $singleSubmission): SingleSubmission

[75] Fix | Delete

{

[76] Fix | Delete

/** @var NF_Database_Models_Submission $nfSub */

[77] Fix | Delete

$nfSub = $this->getNfSub($singleSubmission);

[78] Fix | Delete

[79] Fix | Delete

$subDate = $nfSub->get_sub_date(SingleSubmission::TIMESTAMP_FORMAT);

[80] Fix | Delete

$singleSubmission->setTimestamp($subDate);

[81] Fix | Delete

[82] Fix | Delete

$singleSubmission = $this->fullyPopulateSingleSubmission($singleSubmission, $nfSub);

[83] Fix | Delete

[84] Fix | Delete

return $singleSubmission;

[85] Fix | Delete

}

[86] Fix | Delete

[87] Fix | Delete

/** @inheritDoc */

[88] Fix | Delete

public function retrieveSubmissionValues(SingleSubmission $singleSubmission): SingleSubmission

[89] Fix | Delete

{

[90] Fix | Delete

$submissionRecordId = $singleSubmission->getSubmissionRecordId();

[91] Fix | Delete

[92] Fix | Delete

if (isset($this->submissionCollection[$submissionRecordId])) {

[93] Fix | Delete

[94] Fix | Delete

$nfSub = $this->getNfSub($singleSubmission);

[95] Fix | Delete

[96] Fix | Delete

$singleSubmission = $this->fullyPopulateSingleSubmission($singleSubmission, $nfSub);

[97] Fix | Delete

[98] Fix | Delete

$this->submissionCollection[$submissionRecordId] = $singleSubmission;

[99] Fix | Delete

}

[100] Fix | Delete

[101] Fix | Delete

return $singleSubmission;

[102] Fix | Delete

}

[103] Fix | Delete

[104] Fix | Delete

/** @inheritDoc */

[105] Fix | Delete

public function deleteSubmission(SingleSubmission $singleSubmission): ContractsSubmissionDataSource

[106] Fix | Delete

{

[107] Fix | Delete

$submissionId = $singleSubmission->getSubmissionRecordId();

[108] Fix | Delete

[109] Fix | Delete

$submission = Ninja_Forms()->form()->get_sub( $submissionId );

[110] Fix | Delete

[111] Fix | Delete

$status = ["publish"];

[112] Fix | Delete

if( in_array($submission->get_status(), $status) ){

[113] Fix | Delete

$submission->trash();

[114] Fix | Delete

} else {

[115] Fix | Delete

$submission->delete();

[116] Fix | Delete

}

[117] Fix | Delete

[118] Fix | Delete

return $this;

[119] Fix | Delete

}

[120] Fix | Delete

[121] Fix | Delete

/** @inheritDoc */

[122] Fix | Delete

public function restoreSubmission(SingleSubmission $singleSubmission): ContractsSubmissionDataSource

[123] Fix | Delete

{

[124] Fix | Delete

$submissionId = $singleSubmission->getSubmissionRecordId();

[125] Fix | Delete

[126] Fix | Delete

wp_update_post([

[127] Fix | Delete

"ID" => $submissionId,

[128] Fix | Delete

"post_status" => "publish"

[129] Fix | Delete

]);

[130] Fix | Delete

[131] Fix | Delete

return $this;

[132] Fix | Delete

}

[133] Fix | Delete

[134] Fix | Delete

/** @inheritDoc */

[135] Fix | Delete

public function updateSubmission(SingleSubmission $singleSubmission): ContractsSubmissionDataSource

[136] Fix | Delete

{

[137] Fix | Delete

$submissionId = $singleSubmission->getSubmissionRecordId();

[138] Fix | Delete

[139] Fix | Delete

$submission = Ninja_Forms()->form()->get_sub( $submissionId );

[140] Fix | Delete

[141] Fix | Delete

$updatedFieldsCollection = [];

[142] Fix | Delete

[143] Fix | Delete

/** @var SubmissionField $submissionField */

[144] Fix | Delete

foreach($singleSubmission->getSubmissionFieldCollection() as $submissionField){

[145] Fix | Delete

$updatedFieldsCollection[$submissionField->getSlug()]=$submissionField->getValue();

[146] Fix | Delete

}

[147] Fix | Delete

[148] Fix | Delete

$submission->update_field_values($updatedFieldsCollection)->save();

[149] Fix | Delete

[150] Fix | Delete

$submission->save();

[151] Fix | Delete

[152] Fix | Delete

return $this;

[153] Fix | Delete

}

[154] Fix | Delete

[155] Fix | Delete

/**

[156] Fix | Delete

* Get the NF_Submission for a SingleSubmission entity

[157] Fix | Delete

[158] Fix | Delete

protected function getNfSub(SingleSubmission $singleSubmission): NF_Database_Models_Submission

[159] Fix | Delete

{

[160] Fix | Delete

$nfSub = Ninja_Forms()->form()->get_sub($singleSubmission->getSubmissionRecordId(), null);

[161] Fix | Delete

[162] Fix | Delete

return $nfSub;

[163] Fix | Delete

}

[164] Fix | Delete

[165] Fix | Delete

/**

[166] Fix | Delete

* Populate submission values, extra values, handlers

[167] Fix | Delete

[168] Fix | Delete

* @param SingleSubmission $singleSubmission

[169] Fix | Delete

* @param NF_Database_Models_Submission $nfSub

[170] Fix | Delete

* @return SingleSubmission

[171] Fix | Delete

[172] Fix | Delete

protected function fullyPopulateSingleSubmission(SingleSubmission $singleSubmission, NF_Database_Models_Submission $nfSub): SingleSubmission

[173] Fix | Delete

{

[174] Fix | Delete

$singleSubmission = $this->populateSubmissionValues($singleSubmission, $nfSub);

[175] Fix | Delete

[176] Fix | Delete

$extraValues = $this->retrieveExtraValues($nfSub, $this->getExtraValueHandlers());

[177] Fix | Delete

[178] Fix | Delete

$singleSubmission->setExtraValues($extraValues);

[179] Fix | Delete

[180] Fix | Delete

$submissionHandlers = \apply_filters('nf_react_table_submission_handlers',[],$singleSubmission);

[181] Fix | Delete

[182] Fix | Delete

$singleSubmission->setSubmissionHandlers($submissionHandlers);

[183] Fix | Delete

[184] Fix | Delete

return $singleSubmission;

[185] Fix | Delete

}

[186] Fix | Delete

[187] Fix | Delete

/**

[188] Fix | Delete

* Populate a single submissin with submitted values

[189] Fix | Delete

[190] Fix | Delete

* @param SingleSubmission $singleSubmission

[191] Fix | Delete

* @param NF_Database_Models_Submission $nfSub

[192] Fix | Delete

* @return SingleSubmission

[193] Fix | Delete

[194] Fix | Delete

protected function populateSubmissionValues(SingleSubmission $singleSubmission,NF_Database_Models_Submission $nfSub): SingleSubmission

[195] Fix | Delete

{

[196] Fix | Delete

$updatedFieldValueCollection = [];

[197] Fix | Delete

[198] Fix | Delete

foreach ($singleSubmission->getSubmissionFieldCollection() as $fieldSlug => $submissionField) {

[199] Fix | Delete

[200] Fix | Delete

$value = $nfSub->get_field_value($fieldSlug);

[201] Fix | Delete

$submissionField->setValue($value);

[202] Fix | Delete

[203] Fix | Delete

$updatedFieldValueCollection[$fieldSlug] = $submissionField;

[204] Fix | Delete

}

[205] Fix | Delete

[206] Fix | Delete

$singleSubmission->setSubmissionFieldCollection($updatedFieldValueCollection);

[207] Fix | Delete

[208] Fix | Delete

return $singleSubmission;

[209] Fix | Delete

}

[210] Fix | Delete

[211] Fix | Delete

/**

[212] Fix | Delete

* Provide a filtered list of extra value keys storing extra data

[213] Fix | Delete

[214] Fix | Delete

* Non-core actions can filter the list to provide their keys for retrieval

[215] Fix | Delete

[216] Fix | Delete

* @return array

[217] Fix | Delete

[218] Fix | Delete

protected function getExtraValueHandlers( ): array

[219] Fix | Delete

{

[220] Fix | Delete

$metaboxHandlers = [];

[221] Fix | Delete

[222] Fix | Delete

$return = \apply_filters('nf_react_table_extra_value_keys',$metaboxHandlers);

[223] Fix | Delete

[224] Fix | Delete

// Example of adding an extraValue handler

[225] Fix | Delete

// $metaboxHandlers['nfacds']='\NinjaForms\ActiveCampaign\Admin\MetaboxEntityConstructor';

[226] Fix | Delete

[227] Fix | Delete

return $return;

[228] Fix | Delete

}

[229] Fix | Delete

[230] Fix | Delete

/**

[231] Fix | Delete

* Retrieve extraValues as constructed into MetaboxOutputEntities

[232] Fix | Delete

[233] Fix | Delete

* @param NF_Database_Models_Submission $nfSub

[234] Fix | Delete

* @param array $extraValueHandlers

[235] Fix | Delete

* @return array

[236] Fix | Delete

[237] Fix | Delete

protected function retrieveExtraValues($nfSub, array $extraValueHandlers): array

[238] Fix | Delete

{

[239] Fix | Delete

$return =[];

[240] Fix | Delete

[241] Fix | Delete

foreach($extraValueHandlers as $extraValueKey=>$extraValueHandler){

[242] Fix | Delete

[243] Fix | Delete

$extraValue =$nfSub->get_extra_value($extraValueKey);

[244] Fix | Delete

[245] Fix | Delete

if(\class_exists($extraValueHandler)){

[246] Fix | Delete

[247] Fix | Delete

$structured = (new $extraValueHandler())->handle($extraValue, $nfSub);

[248] Fix | Delete

[249] Fix | Delete

if(!is_null($structured)){

[250] Fix | Delete

$return[$extraValueKey]=$structured;

[251] Fix | Delete

}

[252] Fix | Delete

[253] Fix | Delete

}

[254] Fix | Delete

}

[255] Fix | Delete

return $return;

[256] Fix | Delete

}

[257] Fix | Delete

[258] Fix | Delete

/**

[259] Fix | Delete

* Apply search string filter to submission collection

[260] Fix | Delete

[261] Fix | Delete

* Runs a WP Query to search for all post Ids with both a form Id from the

[262] Fix | Delete

* submission filter and also a search string in any meta value of the same

[263] Fix | Delete

* form. It then filters the submission collection to only those

[264] Fix | Delete

* submissions that meet these additional requirements.

[265] Fix | Delete

[266] Fix | Delete

* @return void

[267] Fix | Delete

[268] Fix | Delete

protected function applySearchCriterion(): void

[269] Fix | Delete

{

[270] Fix | Delete

$searchQuery = new \WP_Query(

[271] Fix | Delete

[

[272] Fix | Delete

'post_type' => 'nf_sub',

[273] Fix | Delete

'posts_per_page' => -1,

[274] Fix | Delete

'meta_query' => [

[275] Fix | Delete

'relation' => 'AND', // both of below conditions must match

[276] Fix | Delete

[

[277] Fix | Delete

'key' => '_form_id',

[278] Fix | Delete

'value' => $this->submissionFilter->getNfFormIds()

[279] Fix | Delete

[280] Fix | Delete

[

[281] Fix | Delete

'value' => $this->submissionFilter->getSearchString(),

[282] Fix | Delete

'compare' => 'LIKE'

[283] Fix | Delete

]

[284] Fix | Delete

]

[285] Fix | Delete

]

[286] Fix | Delete

);

[287] Fix | Delete

[288] Fix | Delete

/** @var array $searchCollection Array of submission Ids that match both form Id and search criterion */

[289] Fix | Delete

$searchCollection = [];

[290] Fix | Delete

[291] Fix | Delete

foreach ($searchQuery->posts as $post) {

[292] Fix | Delete

$searchCollection[] = $post->ID;

[293] Fix | Delete

}

[294] Fix | Delete

[295] Fix | Delete

$this->submissionCollection = \array_intersect_key($this->submissionCollection, \array_flip($searchCollection));

[296] Fix | Delete

}

[297] Fix | Delete

[298] Fix | Delete

/**

[299] Fix | Delete

* Retrieve submissions Ids for a given NF form Id

[300] Fix | Delete

[301] Fix | Delete

* User Id is conditionally added if submission filter's property is

[302] Fix | Delete

* explicityly set (-1 is default value, indicating that no filtering on

[303] Fix | Delete

* User Id).

[304] Fix | Delete

[305] Fix | Delete

* WPDB query args is changed from individual args to being passed as array;

[306] Fix | Delete

* this makes for cleaner structure when sequence of arguments is variable.

[307] Fix | Delete

[308] Fix | Delete

[309] Fix | Delete

* @return void

[310] Fix | Delete

[311] Fix | Delete

protected function retrieveSubmissionMetaByNfFormId(string $formId): void

[312] Fix | Delete

{

[313] Fix | Delete

global $wpdb;

[314] Fix | Delete

[315] Fix | Delete

$startDate = DateTimeConverter::localizeEpochIntoString( $this->submissionFilter->getStartDate());

[316] Fix | Delete

$endDate = DateTimeConverter::localizeEpochIntoString( $this->submissionFilter->getEndDate());

[317] Fix | Delete

[318] Fix | Delete

$userId = $this->submissionFilter->getUserId();

[319] Fix | Delete

[320] Fix | Delete

$statuses = $this->submissionFilter->getStatus();

[321] Fix | Delete

[322] Fix | Delete

$status = !empty($statuses) && in_array( "trash", $statuses ) ? "trash" : "publish";

[323] Fix | Delete

[324] Fix | Delete

$wpdbPrepareArgs = [];

[325] Fix | Delete

[326] Fix | Delete

$submissionRecordIdQuery = "SELECT p.ID, p.post_author, p.post_date, mm.meta_value AS seq"

[327] Fix | Delete

." FROM `" . $wpdb->prefix . "posts` AS p"

[328] Fix | Delete

." INNER JOIN `" . $wpdb->prefix . "postmeta` AS m"

[329] Fix | Delete

." ON p.ID = m.post_id"

[330] Fix | Delete

." INNER JOIN `" . $wpdb->prefix . "postmeta` AS mm"

[331] Fix | Delete

." ON p.ID = mm.post_id"

[332] Fix | Delete

." WHERE p.post_type = 'nf_sub'";

[333] Fix | Delete

[334] Fix | Delete

[335] Fix | Delete

// Filter on post author as submitter's user id

[336] Fix | Delete

if (!\is_null($userId)) {

[337] Fix | Delete

[338] Fix | Delete

$submissionRecordIdQuery .= "AND p.post_author = %d";

[339] Fix | Delete

$wpdbPrepareArgs[]=$userId;

[340] Fix | Delete

}

[341] Fix | Delete

[342] Fix | Delete

// Filter on post status

[343] Fix | Delete

$submissionRecordIdQuery .= " AND p.post_status = %s";

[344] Fix | Delete

$wpdbPrepareArgs[]=$status;

[345] Fix | Delete

[346] Fix | Delete

// Filter on form id meta key/value

[347] Fix | Delete

$submissionRecordIdQuery .= " AND m.meta_key = '_form_id' AND m.meta_value = %s";

[348] Fix | Delete

$wpdbPrepareArgs[]=$formId;

[349] Fix | Delete

[350] Fix | Delete

$submissionRecordIdQuery .= " AND mm.meta_key = '_seq_num'";

[351] Fix | Delete

[352] Fix | Delete

$submissionRecordIdQuery .= " AND CAST(p.post_modified AS DATETIME) BETWEEN %s AND %s";

[353] Fix | Delete

$wpdbPrepareArgs[]=$startDate;

[354] Fix | Delete

$wpdbPrepareArgs[]=$endDate;

[355] Fix | Delete

[356] Fix | Delete

$recordCollection = $wpdb->get_results($wpdb->prepare($submissionRecordIdQuery, $wpdbPrepareArgs));

[357] Fix | Delete

[358] Fix | Delete

foreach ($recordCollection as $queryObject) {

[359] Fix | Delete

$submissionRecordId = $queryObject->ID;

[360] Fix | Delete

$subDate = $queryObject->post_date;

[361] Fix | Delete

$seq = $queryObject->seq;

[362] Fix | Delete

$submitterId = $queryObject->post_author;

[363] Fix | Delete

$this->submissionCollection[$submissionRecordId] = SingleSubmission::fromArray([

[364] Fix | Delete

'submissionRecordId' => $submissionRecordId,

[365] Fix | Delete

'timestamp' => $subDate,

[366] Fix | Delete

'formId' => $formId,

[367] Fix | Delete

'dataSource' => $this->dataSource,

[368] Fix | Delete

'status' => $status,

[369] Fix | Delete

'seq_num' => $seq,

[370] Fix | Delete

'submitterId' => $submitterId

[371] Fix | Delete

]);

[372] Fix | Delete

}

[373] Fix | Delete

}

[374] Fix | Delete

[375] Fix | Delete

/**

[376] Fix | Delete

* Boolean to include as per date filter

[377] Fix | Delete

[378] Fix | Delete

* true=>include, false=>omit

[379] Fix | Delete

[380] Fix | Delete

* @return boolean

[381] Fix | Delete

[382] Fix | Delete

protected function includeByDateFilter($subDate): bool

[383] Fix | Delete

{

[384] Fix | Delete

$include = true;

[385] Fix | Delete

[386] Fix | Delete

$startDateUnix = $this->submissionFilter->getStartDate();

[387] Fix | Delete

$startDate = (new \DateTime())->setTimestamp($startDateUnix)->format(self::TIMESTAMP_FORMAT);

[388] Fix | Delete

[389] Fix | Delete

$endDateUnix = $this->submissionFilter->getEndDate();

[390] Fix | Delete

$endDate = (new \DateTime())->setTimestamp($endDateUnix)->format(self::TIMESTAMP_FORMAT);

[391] Fix | Delete

[392] Fix | Delete

if(''!==$startDate && $subDate<$startDate){

[393] Fix | Delete

$include=false;

[394] Fix | Delete

}

[395] Fix | Delete

[396] Fix | Delete

if(''!==$endDate && $subDate>$endDate){

[397] Fix | Delete

$include=false;

[398] Fix | Delete

}

[399] Fix | Delete

[400] Fix | Delete

return $include;

[401] Fix | Delete

}

[402] Fix | Delete

[403] Fix | Delete

/** @inheritDoc */

[404] Fix | Delete

public function getDataSource(): string

[405] Fix | Delete

{

[406] Fix | Delete

return $this->dataSource;

[407] Fix | Delete

}

[408] Fix | Delete

}

[409] Fix | Delete

[410] Fix | Delete