Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

if (!defined('ABSPATH'))

[2] Fix | Delete

exit;

[3] Fix | Delete

use NF_Exports_Interfaces_SubmissionCollectionInterface as SubmissionCollectionInterface;

[4] Fix | Delete

use NF_Exports_SingleSubmissionCPT as SingleSubmission;

[5] Fix | Delete

/**

[6] Fix | Delete

* Provides and stores collection of submissions for a single form using CPT

[7] Fix | Delete

[8] Fix | Delete

final class NF_Exports_SubmissionCollectionCPT implements SubmissionCollectionInterface {

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* Form Id

[12] Fix | Delete

* @var string

[13] Fix | Delete

[14] Fix | Delete

protected $formId = '';

[15] Fix | Delete

[16] Fix | Delete

/**

[17] Fix | Delete

* Array of NF field objects for the form id

[18] Fix | Delete

[19] Fix | Delete

* Constructed once, on first request requiring fields; after that, use

[20] Fix | Delete

* previously retrieved property that can be filtered or adjusted as

[21] Fix | Delete

* needed, reducing DB calls

[22] Fix | Delete

[23] Fix | Delete

* @var array

[24] Fix | Delete

[25] Fix | Delete

protected $fields = [];

[26] Fix | Delete

[27] Fix | Delete

/**

[28] Fix | Delete

* Array of labels keyed on field key

[29] Fix | Delete

[30] Fix | Delete

* Option to use admin_label set on request

[31] Fix | Delete

[32] Fix | Delete

* @var array

[33] Fix | Delete

[34] Fix | Delete

protected $labels = [];

[35] Fix | Delete

[36] Fix | Delete

/**

[37] Fix | Delete

* Array of field types keyed on field key

[38] Fix | Delete

* @var array

[39] Fix | Delete

[40] Fix | Delete

protected $fieldTypes = [];

[41] Fix | Delete

[42] Fix | Delete

/**

[43] Fix | Delete

* Array of field Ids keyed on field key

[44] Fix | Delete

* @var array

[45] Fix | Delete

[46] Fix | Delete

protected $fieldIds = [];

[47] Fix | Delete

[48] Fix | Delete

/**

[49] Fix | Delete

* Indexed array collection of single submissions

[50] Fix | Delete

* @var SingleSubmission[]

[51] Fix | Delete

[52] Fix | Delete

protected $submissionCollection = [];

[53] Fix | Delete

[54] Fix | Delete

/**

[55] Fix | Delete

* Indexed array of field types to be omitted in output

[56] Fix | Delete

* @var array

[57] Fix | Delete

[58] Fix | Delete

protected $hiddenFieldTypes = [];

[59] Fix | Delete

[60] Fix | Delete

/**

[61] Fix | Delete

* Starting date for filtering submissions

[62] Fix | Delete

[63] Fix | Delete

* @var int|null

[64] Fix | Delete

[65] Fix | Delete

protected $startDate = null;

[66] Fix | Delete

[67] Fix | Delete

/**

[68] Fix | Delete

* Ending date for filtering submissions

[69] Fix | Delete

[70] Fix | Delete

* @var int|null

[71] Fix | Delete

[72] Fix | Delete

protected $endDate = null;

[73] Fix | Delete

[74] Fix | Delete

/**

[75] Fix | Delete

* Boolean to filter submissions by `isUnread?`

[76] Fix | Delete

* @var bool

[77] Fix | Delete

[78] Fix | Delete

protected $isUnread = null;

[79] Fix | Delete

[80] Fix | Delete

/**

[81] Fix | Delete

* Boolean to filter submissions by `previouslyExported?`

[82] Fix | Delete

* @var bool

[83] Fix | Delete

[84] Fix | Delete

protected $previouslyExported = null;

[85] Fix | Delete

[86] Fix | Delete

/**

[87] Fix | Delete

* Maximum amount of submissions to return in a single request

[88] Fix | Delete

[89] Fix | Delete

* @var int

[90] Fix | Delete

[91] Fix | Delete

protected $maxReturnCount = null;

[92] Fix | Delete

[93] Fix | Delete

/**

[94] Fix | Delete

* Total count of submissions

[95] Fix | Delete

* @var int

[96] Fix | Delete

[97] Fix | Delete

protected $totalCount;

[98] Fix | Delete

[99] Fix | Delete

/**

[100] Fix | Delete

* Count of submissions that have been marked `Unread`

[101] Fix | Delete

* @var int

[102] Fix | Delete

[103] Fix | Delete

protected $isUnreadCount;

[104] Fix | Delete

[105] Fix | Delete

/**

[106] Fix | Delete

* Count of submissions that have been previously exported

[107] Fix | Delete

* @var int

[108] Fix | Delete

[109] Fix | Delete

protected $previouslyExportedCount;

[110] Fix | Delete

[111] Fix | Delete

/**

[112] Fix | Delete

* Construct submission collection with provided form Id

[113] Fix | Delete

* @param string|int $form_id

[114] Fix | Delete

[115] Fix | Delete

public function __construct($form_id) {

[116] Fix | Delete

$this->formId = $form_id;

[117] Fix | Delete

}

[118] Fix | Delete

[119] Fix | Delete

/**

[120] Fix | Delete

* Return form Id

[121] Fix | Delete

* @return int

[122] Fix | Delete

[123] Fix | Delete

public function getFormId() {

[124] Fix | Delete

return intval($this->formId);

[125] Fix | Delete

}

[126] Fix | Delete

[127] Fix | Delete

/**

[128] Fix | Delete

* Return form title

[129] Fix | Delete

* @return string

[130] Fix | Delete

[131] Fix | Delete

public function getFormTitle() {

[132] Fix | Delete

$form = Ninja_Forms()->form($this->formId)->get();

[133] Fix | Delete

return $form->get_setting('title');

[134] Fix | Delete

}

[135] Fix | Delete

[136] Fix | Delete

[137] Fix | Delete

[138] Fix | Delete

/**

[139] Fix | Delete

* Set start and end dates to filter submissions

[140] Fix | Delete

* @param int|null $startDate Starting date

[141] Fix | Delete

* @param int|null $endDate Ending date

[142] Fix | Delete

[143] Fix | Delete

public function setDateParameters($startDate = null, $endDate = null) {

[144] Fix | Delete

[145] Fix | Delete

if (!is_null($startDate)) {

[146] Fix | Delete

$this->startDate = $this->formatDate($startDate);

[147] Fix | Delete

}

[148] Fix | Delete

[149] Fix | Delete

if (!is_null($endDate)) {

[150] Fix | Delete

$this->endDate = $this->formatDate($endDate);

[151] Fix | Delete

}

[152] Fix | Delete

[153] Fix | Delete

return $this;

[154] Fix | Delete

}

[155] Fix | Delete

[156] Fix | Delete

/**

[157] Fix | Delete

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

[158] Fix | Delete

[159] Fix | Delete

* @param bool $isUnread

[160] Fix | Delete

[161] Fix | Delete

public function setIsUnreadParameter(bool $isUnread=null)/* :SubmissionCollectionInterface */ {

[162] Fix | Delete

$this->isUnread = $isUnread;

[163] Fix | Delete

[164] Fix | Delete

return $this;

[165] Fix | Delete

}

[166] Fix | Delete

[167] Fix | Delete

/**

[168] Fix | Delete

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

[169] Fix | Delete

[170] Fix | Delete

* @param bool $previouslyExported

[171] Fix | Delete

[172] Fix | Delete

public function setPreviouslyExportedParameter(bool $previouslyExported=null)/* :SubmissionCollectionInterface */ {

[173] Fix | Delete

$this->previouslyExported = $previouslyExported;

[174] Fix | Delete

[175] Fix | Delete

return $this;

[176] Fix | Delete

}

[177] Fix | Delete

[178] Fix | Delete

/**

[179] Fix | Delete

* Set max number of submissions to return in a request

[180] Fix | Delete

[181] Fix | Delete

* @param int $maxReturnCount

[182] Fix | Delete

[183] Fix | Delete

public function setMaxReturnCount($maxReturnCount=null)/* :SubmissionCollectionInterface */ {

[184] Fix | Delete

$this->maxReturnCount = $maxReturnCount;

[185] Fix | Delete

[186] Fix | Delete

return $this;

[187] Fix | Delete

}

[188] Fix | Delete

[189] Fix | Delete

/**

[190] Fix | Delete

* Set all parameters using NF_Database_Models_SubmissionCollectionInterfaceParameters

[191] Fix | Delete

[192] Fix | Delete

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

[193] Fix | Delete

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

[194] Fix | Delete

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

[195] Fix | Delete

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

[196] Fix | Delete

* immediately run the filter.

[197] Fix | Delete

[198] Fix | Delete

* @param NF_Database_Models_SubmissionCollectionInterfaceParameters $params

[199] Fix | Delete

* @return SubmissionCollectionInterface

[200] Fix | Delete

[201] Fix | Delete

public function filterByParameters(/* NF_Database_Models_SubmissionCollectionInterfaceParameters*/ $params)/* :SubmissionCollectionInterface */ {

[202] Fix | Delete

/** @var NF_Database_Models_SubmissionCollectionInterfaceParameters $params */

[203] Fix | Delete

[204] Fix | Delete

$this->setDateParameters($params->getStartDate(),$params->getEndDate());

[205] Fix | Delete

$this->setIsUnreadParameter($params->getIsUnread());

[206] Fix | Delete

$this->setPreviouslyExportedParameter($params->getPreviouslyExported());

[207] Fix | Delete

$this->setMaxReturnCount($params->getMaxReturnCount());

[208] Fix | Delete

$this->setHiddenFieldTypes($params->getHiddenFieldTypes());

[209] Fix | Delete

$this->filterSubmissions();

[210] Fix | Delete

return $this;

[211] Fix | Delete

}

[212] Fix | Delete

/**

[213] Fix | Delete

* Filter collection of submissions based on previously set parameters

[214] Fix | Delete

[215] Fix | Delete

* @return array

[216] Fix | Delete

[217] Fix | Delete

public function filterSubmissions()/* :SubmissionCollectionInterface */ {

[218] Fix | Delete

[219] Fix | Delete

$defaultFilter = $this->constructDefaultFilter();

[220] Fix | Delete

[221] Fix | Delete

$filter = $this->addMetaFilters($defaultFilter);

[222] Fix | Delete

[223] Fix | Delete

[224] Fix | Delete

// set max number values to return

[225] Fix | Delete

if (!is_null($this->maxReturnCount)) {

[226] Fix | Delete

$filter['posts_per_page'] = $this->maxReturnCount;

[227] Fix | Delete

}

[228] Fix | Delete

[229] Fix | Delete

$dateQuery = $this->constructDateQuery();

[230] Fix | Delete

if (!empty($dateQuery)) {

[231] Fix | Delete

$filter['date_query'] = $dateQuery;

[232] Fix | Delete

}

[233] Fix | Delete

[234] Fix | Delete

$subs = get_posts($filter);

[235] Fix | Delete

[236] Fix | Delete

$this->submissionCollection = [];

[237] Fix | Delete

[238] Fix | Delete

foreach ($subs as $sub) {

[239] Fix | Delete

$this->submissionCollection[$sub->ID] = new SingleSubmission($sub->ID);

[240] Fix | Delete

}

[241] Fix | Delete

[242] Fix | Delete

return $this;

[243] Fix | Delete

}

[244] Fix | Delete

[245] Fix | Delete

/**

[246] Fix | Delete

* Return count of submissions, exported, and unread

[247] Fix | Delete

[248] Fix | Delete

public function getCounts():array {

[249] Fix | Delete

$defaultFilter = $this->constructDefaultFilter();

[250] Fix | Delete

[251] Fix | Delete

$subs = get_posts($defaultFilter);

[252] Fix | Delete

[253] Fix | Delete

$allSubmissions=[];

[254] Fix | Delete

$previouslyExported=[];

[255] Fix | Delete

$isUnread=[];

[256] Fix | Delete

[257] Fix | Delete

foreach ($subs as $sub) {

[258] Fix | Delete

$singleSubmission = new SingleSubmission($sub->ID);

[259] Fix | Delete

[260] Fix | Delete

$allSubmissions[] = $singleSubmission->getId();

[261] Fix | Delete

[262] Fix | Delete

if ($singleSubmission->wasExported()) {

[263] Fix | Delete

$previouslyExported[] = $singleSubmission->getId();

[264] Fix | Delete

}

[265] Fix | Delete

[266] Fix | Delete

if ($singleSubmission->isUnread()) {

[267] Fix | Delete

$isUnread[] = $singleSubmission->getId();

[268] Fix | Delete

}

[269] Fix | Delete

}

[270] Fix | Delete

[271] Fix | Delete

$return = [

[272] Fix | Delete

'totalCount' => count($allSubmissions),

[273] Fix | Delete

'previouslyExported' => count($previouslyExported),

[274] Fix | Delete

'isUnread' => count($isUnread)

[275] Fix | Delete

];

[276] Fix | Delete

return $return;

[277] Fix | Delete

}

[278] Fix | Delete

[279] Fix | Delete

/**

[280] Fix | Delete

* Add meta query filters

[281] Fix | Delete

[282] Fix | Delete

* @param array $filter

[283] Fix | Delete

* @return array

[284] Fix | Delete

[285] Fix | Delete

protected function addMetaFilters($filter)/* :array */ {

[286] Fix | Delete

// add previously exported criterion to meta query

[287] Fix | Delete

$previouslyExportedQuery = $this->constructPreviouslyExportedQuery();

[288] Fix | Delete

[289] Fix | Delete

if (!empty($previouslyExportedQuery)) {

[290] Fix | Delete

$filter['meta_query'][] = $previouslyExportedQuery;

[291] Fix | Delete

}

[292] Fix | Delete

[293] Fix | Delete

// add is unread criterion to meta query

[294] Fix | Delete

$isUnreadQuery = $this->constructIsUnreadQuery();

[295] Fix | Delete

if (!empty($isUnreadQuery)) {

[296] Fix | Delete

$filter['meta_query'][] = $isUnreadQuery;

[297] Fix | Delete

}

[298] Fix | Delete

[299] Fix | Delete

// add condition for multiple meta queries

[300] Fix | Delete

if (1 < count($filter['meta_query'])) {

[301] Fix | Delete

$filter['meta_query']['relation'] = 'AND';

[302] Fix | Delete

}

[303] Fix | Delete

[304] Fix | Delete

return $filter;

[305] Fix | Delete

}

[306] Fix | Delete

[307] Fix | Delete

/**

[308] Fix | Delete

* Construct/return default filter args array for WP's get_post

[309] Fix | Delete

* @return array

[310] Fix | Delete

[311] Fix | Delete

protected function constructDefaultFilter()/* :array */ {

[312] Fix | Delete

[313] Fix | Delete

$filter = [

[314] Fix | Delete

'post_type' => 'nf_sub',

[315] Fix | Delete

'posts_per_page' => -1, // return all

[316] Fix | Delete

'paged' => 1,

[317] Fix | Delete

'orderby' => 'ID',

[318] Fix | Delete

'order' => 'ASC',

[319] Fix | Delete

'meta_query' => [

[320] Fix | Delete

[

[321] Fix | Delete

'key' => '_form_id',

[322] Fix | Delete

'compare' => '=',

[323] Fix | Delete

'value' => $this->formId

[324] Fix | Delete

]

[325] Fix | Delete

]

[326] Fix | Delete

];

[327] Fix | Delete

[328] Fix | Delete

return $filter;

[329] Fix | Delete

}

[330] Fix | Delete

[331] Fix | Delete

/**

[332] Fix | Delete

* Construct meta query for isUnread; empty array if null param

[333] Fix | Delete

[334] Fix | Delete

* @return array

[335] Fix | Delete

[336] Fix | Delete

protected function constructIsUnreadQuery() {

[337] Fix | Delete

[338] Fix | Delete

$query = [];

[339] Fix | Delete

if (!is_null($this->isUnread)) {

[340] Fix | Delete

[341] Fix | Delete

$query['key'] = SingleSubmission::UNREAD_KEY;

[342] Fix | Delete

[343] Fix | Delete

$query['compare'] = 'LIKE';

[344] Fix | Delete

[345] Fix | Delete

$query['value'] = $this->isUnread;

[346] Fix | Delete

}

[347] Fix | Delete

[348] Fix | Delete

return $query;

[349] Fix | Delete

}

[350] Fix | Delete

[351] Fix | Delete

/**

[352] Fix | Delete

* Construct meta query for previously exported; empty array if null parameter

[353] Fix | Delete

[354] Fix | Delete

* @param bool|null $previouslyExported

[355] Fix | Delete

* @return array

[356] Fix | Delete

[357] Fix | Delete

protected function constructPreviouslyExportedQuery() {

[358] Fix | Delete

[359] Fix | Delete

$query = [];

[360] Fix | Delete

if (!is_null($this->previouslyExported)) {

[361] Fix | Delete

$query['key'] = SingleSubmission::EXPORT_TIMESTAMP_KEY;

[362] Fix | Delete

[363] Fix | Delete

if ($this->previouslyExported) {

[364] Fix | Delete

[365] Fix | Delete

$query['compare'] = 'EXISTS';

[366] Fix | Delete

} else {

[367] Fix | Delete

[368] Fix | Delete

$query['compare'] = 'NOT EXISTS';

[369] Fix | Delete

}

[370] Fix | Delete

}

[371] Fix | Delete

[372] Fix | Delete

return $query;

[373] Fix | Delete

}

[374] Fix | Delete

[375] Fix | Delete

/**

[376] Fix | Delete

* Construct meta query for start/end dates; empty array if null parameters

[377] Fix | Delete

[378] Fix | Delete

* @return array

[379] Fix | Delete

[380] Fix | Delete

protected function constructDateQuery() {

[381] Fix | Delete

[382] Fix | Delete

$query = [];

[383] Fix | Delete

[384] Fix | Delete

if (!is_null($this->endDate)) {

[385] Fix | Delete

$query['before'] = $this->endDate;

[386] Fix | Delete

}

[387] Fix | Delete

[388] Fix | Delete

if (!is_null($this->startDate)) {

[389] Fix | Delete

$query['after'] = $this->startDate;

[390] Fix | Delete

}

[391] Fix | Delete

[392] Fix | Delete

return $query;

[393] Fix | Delete

}

[394] Fix | Delete

[395] Fix | Delete

/**

[396] Fix | Delete

* Return submission collection array

[397] Fix | Delete

* @return \NF_Database_Models_SingleSubmissionInterface[]

[398] Fix | Delete

[399] Fix | Delete

public function getSubmissions()/*: SingleSubmission[]*/ {

[400] Fix | Delete

[401] Fix | Delete

if(empty($this->submissionCollection)){

[402] Fix | Delete

$this->filterSubmissions();

[403] Fix | Delete

}

[404] Fix | Delete

return $this->submissionCollection;

[405] Fix | Delete

}

[406] Fix | Delete

[407] Fix | Delete

/**

[408] Fix | Delete

* Return array of submission Ids in the collection

[409] Fix | Delete

[410] Fix | Delete

* Generated at time of request to ensure it is up to date after last

[411] Fix | Delete

* query / construction

[412] Fix | Delete

* @return array

[413] Fix | Delete

[414] Fix | Delete

public function getSubmissionIds() {

[415] Fix | Delete

$idArray = [];

[416] Fix | Delete

[417] Fix | Delete

if (!empty($this->submissionCollection)) {

[418] Fix | Delete

[419] Fix | Delete

foreach ($this->submissionCollection as $submission) {

[420] Fix | Delete

$idArray[] = $submission->getId();

[421] Fix | Delete

}

[422] Fix | Delete

}

[423] Fix | Delete

[424] Fix | Delete

return $idArray;

[425] Fix | Delete

}

[426] Fix | Delete

[427] Fix | Delete

/**

[428] Fix | Delete

* Return array of field labels keyed on field key

[429] Fix | Delete

[430] Fix | Delete

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

[431] Fix | Delete

[432] Fix | Delete

* @param bool|null $useAdminLabels

[433] Fix | Delete

* @return array

[434] Fix | Delete

[435] Fix | Delete

public function getLabels($useAdminLabels = null)/* : array */ {

[436] Fix | Delete

[437] Fix | Delete

$this->getFields();

[438] Fix | Delete

[439] Fix | Delete

// if not explicitly requesting admin labels and labels previously

[440] Fix | Delete

// retrieved, use those, otherwise generate labels array

[441] Fix | Delete

if (is_null($useAdminLabels) && !empty($this->labels)) {

[442] Fix | Delete

return $this->labels;

[443] Fix | Delete

}

[444] Fix | Delete

[445] Fix | Delete

foreach ($this->fields as $field) {

[446] Fix | Delete

// omit hidden field types

[447] Fix | Delete

if (!is_null($this->hiddenFieldTypes) &&

[448] Fix | Delete

in_array($field->get_setting('type'), $this->hiddenFieldTypes)) {

[449] Fix | Delete

continue;

[450] Fix | Delete

}

[451] Fix | Delete

[452] Fix | Delete

if ($useAdminLabels && '' !== $field->get_setting('admin_label')) {

[453] Fix | Delete

$labels[$field->get_setting('key')] = $field->get_setting('admin_label');

[454] Fix | Delete

} else {

[455] Fix | Delete

$labels[$field->get_setting('key')] = $field->get_setting('label');

[456] Fix | Delete

}

[457] Fix | Delete

}

[458] Fix | Delete

[459] Fix | Delete

$this->labels = $labels;

[460] Fix | Delete

[461] Fix | Delete

return $this->labels;

[462] Fix | Delete

}

[463] Fix | Delete

[464] Fix | Delete

/**

[465] Fix | Delete

* Return array of field types keyed on field key

[466] Fix | Delete

[467] Fix | Delete

* @return array

[468] Fix | Delete

[469] Fix | Delete

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

[470] Fix | Delete

[471] Fix | Delete

if (empty($this->fieldTypes)) {

[472] Fix | Delete

$this->getFields();

[473] Fix | Delete

[474] Fix | Delete

foreach ($this->fields as $field) {

[475] Fix | Delete

$key = $field->get_setting('key');

[476] Fix | Delete

$type = $field->get_setting('type');

[477] Fix | Delete

$this->fieldTypes[$key] = $type;

[478] Fix | Delete

}

[479] Fix | Delete

}

[480] Fix | Delete

[481] Fix | Delete

return $this->fieldTypes;

[482] Fix | Delete

}

[483] Fix | Delete

/**

[484] Fix | Delete

* Return array of field Ids keyed on field keys

[485] Fix | Delete

[486] Fix | Delete

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

[487] Fix | Delete

if (empty($this->fieldIds)) {

[488] Fix | Delete

$this->getFields();

[489] Fix | Delete

[490] Fix | Delete

foreach ($this->fields as $field) {

[491] Fix | Delete

$key = $field->get_setting('key');

[492] Fix | Delete

$id = $field->get_id();

[493] Fix | Delete

$this->fieldIds[$key] = $id;

[494] Fix | Delete

}

[495] Fix | Delete

}

[496] Fix | Delete

[497] Fix | Delete

return $this->fieldIds;

[498] Fix | Delete

[499] Fix | Delete