Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

if (!defined('ABSPATH'))

[2] Fix | Delete

exit;

[3] Fix | Delete

[4] Fix | Delete

use NF_Exports_Interfaces_SingleSubmissionInterface as SingleSubmissionInterface;

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Provides and stores single submission data using Custom Post Type

[8] Fix | Delete

[9] Fix | Delete

[10] Fix | Delete

[11] Fix | Delete

final class NF_Exports_SingleSubmissionCPT implements SingleSubmissionInterface {

[12] Fix | Delete

[13] Fix | Delete

/**

[14] Fix | Delete

* Key under which export timestamp is stored

[15] Fix | Delete

[16] Fix | Delete

* Submissions without this value set are considered `not exported`

[17] Fix | Delete

[18] Fix | Delete

const EXPORT_TIMESTAMP_KEY = 'export_timestamp';

[19] Fix | Delete

[20] Fix | Delete

/**

[21] Fix | Delete

* Key under which isRead boolean is stored

[22] Fix | Delete

[23] Fix | Delete

* `true` indicates submission is unread; `false` indicates submission has

[24] Fix | Delete

* been read

[25] Fix | Delete

[26] Fix | Delete

const UNREAD_KEY = 'is_unread';

[27] Fix | Delete

[28] Fix | Delete

/**

[29] Fix | Delete

* Submission Id

[30] Fix | Delete

* @var string

[31] Fix | Delete

[32] Fix | Delete

protected $subId = '';

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* Status of the submission

[36] Fix | Delete

[37] Fix | Delete

* Modeled after Wordpress' post status. Such modeling is required when

[38] Fix | Delete

* using Wordpress' custom post type, but not required in other

[39] Fix | Delete

* database structures

[40] Fix | Delete

[41] Fix | Delete

* @var string

[42] Fix | Delete

[43] Fix | Delete

protected $_status = '';

[44] Fix | Delete

[45] Fix | Delete

/**

[46] Fix | Delete

* User Id of the submission

[47] Fix | Delete

[48] Fix | Delete

* Not sure where this is used.

[49] Fix | Delete

* @var string

[50] Fix | Delete

[51] Fix | Delete

protected $_user_id = '';

[52] Fix | Delete

[53] Fix | Delete

/**

[54] Fix | Delete

* Form Id for the submission

[55] Fix | Delete

* @var string

[56] Fix | Delete

[57] Fix | Delete

protected $_form_id = '';

[58] Fix | Delete

[59] Fix | Delete

/**

[60] Fix | Delete

* Submission sequence number

[61] Fix | Delete

* @var string

[62] Fix | Delete

[63] Fix | Delete

protected $_seq_num = '';

[64] Fix | Delete

[65] Fix | Delete

/**

[66] Fix | Delete

* Submission date

[67] Fix | Delete

* @var string

[68] Fix | Delete

[69] Fix | Delete

protected $_sub_date = '';

[70] Fix | Delete

[71] Fix | Delete

/**

[72] Fix | Delete

* Submission Modified on date

[73] Fix | Delete

* @var string

[74] Fix | Delete

[75] Fix | Delete

protected $_mod_date = '';

[76] Fix | Delete

[77] Fix | Delete

/**

[78] Fix | Delete

* Array of field submission values using NF_Database_Models_Submission

[79] Fix | Delete

[80] Fix | Delete

[81] Fix | Delete

* @var array

[82] Fix | Delete

[83] Fix | Delete

protected $_field_values = array();

[84] Fix | Delete

[85] Fix | Delete

/**

[86] Fix | Delete

* Array of non-field data stored with submission

[87] Fix | Delete

* @var array

[88] Fix | Delete

[89] Fix | Delete

protected $extraValues = array();

[90] Fix | Delete

[91] Fix | Delete

/**

[92] Fix | Delete

[93] Fix | Delete

* @param string|int $id

[94] Fix | Delete

[95] Fix | Delete

public function __construct($id) {

[96] Fix | Delete

$this->subId = $id;

[97] Fix | Delete

$this->_seq_num = get_post_meta($this->subId, '_seq_num', TRUE);

[98] Fix | Delete

$this->_form_id = get_post_meta($this->subId, '_form_id', TRUE);

[99] Fix | Delete

[100] Fix | Delete

$sub = get_post($this->subId);

[101] Fix | Delete

[102] Fix | Delete

if ($sub) {

[103] Fix | Delete

$this->_status = $sub->post_status;

[104] Fix | Delete

$this->_user_id = $sub->post_author;

[105] Fix | Delete

$this->_sub_date = $sub->post_date;

[106] Fix | Delete

$this->_mod_date = $sub->post_modified;

[107] Fix | Delete

}

[108] Fix | Delete

}

[109] Fix | Delete

[110] Fix | Delete

/**

[111] Fix | Delete

* Get Submission ID

[112] Fix | Delete

[113] Fix | Delete

* @return int

[114] Fix | Delete

[115] Fix | Delete

public function getId() {

[116] Fix | Delete

return intval($this->subId);

[117] Fix | Delete

}

[118] Fix | Delete

[119] Fix | Delete

/**

[120] Fix | Delete

* @inheritDoc

[121] Fix | Delete

* @return int

[122] Fix | Delete

[123] Fix | Delete

public function getSeqNum() {

[124] Fix | Delete

return intval($this->_seq_num);

[125] Fix | Delete

}

[126] Fix | Delete

[127] Fix | Delete

/**

[128] Fix | Delete

* @inheritDoc

[129] Fix | Delete

* @param string $format

[130] Fix | Delete

* @return string

[131] Fix | Delete

[132] Fix | Delete

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

[133] Fix | Delete

return date($format, strtotime($this->_sub_date));

[134] Fix | Delete

}

[135] Fix | Delete

[136] Fix | Delete

/**

[137] Fix | Delete

* Filter field values to return only provided keys

[138] Fix | Delete

[139] Fix | Delete

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

[140] Fix | Delete

* enables use of a previously generated `field labels` array, which is

[141] Fix | Delete

* keyed off the same field keys as the submission for perfect matching

[142] Fix | Delete

* of array columns.

[143] Fix | Delete

[144] Fix | Delete

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

[145] Fix | Delete

* @return array

[146] Fix | Delete

[147] Fix | Delete

public function filterFieldValues($fieldKeys) {

[148] Fix | Delete

[149] Fix | Delete

$fieldValues = $this->getFieldValues();

[150] Fix | Delete

[151] Fix | Delete

$filtered = array_intersect_key($fieldValues, $fieldKeys);

[152] Fix | Delete

[153] Fix | Delete

return $filtered;

[154] Fix | Delete

}

[155] Fix | Delete

[156] Fix | Delete

/**

[157] Fix | Delete

* Get Field Value

[158] Fix | Delete

[159] Fix | Delete

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

[160] Fix | Delete

[161] Fix | Delete

* @param int|string $field_ref

[162] Fix | Delete

* @return string

[163] Fix | Delete

[164] Fix | Delete

public function getFieldValue($field_ref) {

[165] Fix | Delete

$field_id = ( is_numeric($field_ref) ) ? $field_ref : $this->getFieldIdByKey($field_ref);

[166] Fix | Delete

[167] Fix | Delete

$field = '_field_' . $field_id;

[168] Fix | Delete

[169] Fix | Delete

if (isset($this->_field_values[$field]))

[170] Fix | Delete

return $this->_field_values[$field];

[171] Fix | Delete

[172] Fix | Delete

$this->_field_values[$field] = get_post_meta($this->subId, $field, TRUE);

[173] Fix | Delete

$this->_field_values[$field_ref] = get_post_meta($this->subId, $field, TRUE);

[174] Fix | Delete

[175] Fix | Delete

return WPN_Helper::htmlspecialchars($this->_field_values[$field]);

[176] Fix | Delete

}

[177] Fix | Delete

[178] Fix | Delete

/**

[179] Fix | Delete

* Get Field Values - from existing NF_Database_Models_Submission

[180] Fix | Delete

[181] Fix | Delete

* Returns all post meta

[182] Fix | Delete

[183] Fix | Delete

* @return array|mixed

[184] Fix | Delete

[185] Fix | Delete

public function getFieldValues() {

[186] Fix | Delete

if (!empty($this->_field_values))

[187] Fix | Delete

return $this->_field_values;

[188] Fix | Delete

[189] Fix | Delete

$field_values = get_post_meta($this->subId, '');

[190] Fix | Delete

[191] Fix | Delete

foreach ($field_values as $field_id => $field_value) {

[192] Fix | Delete

$this->_field_values[$field_id] = implode(', ', $field_value);

[193] Fix | Delete

[194] Fix | Delete

if (0 === strpos($field_id, '_field_')) {

[195] Fix | Delete

$field_id = substr($field_id, 7);

[196] Fix | Delete

}

[197] Fix | Delete

[198] Fix | Delete

if (!is_numeric($field_id))

[199] Fix | Delete

continue;

[200] Fix | Delete

[201] Fix | Delete

$field = Ninja_Forms()->form()->get_field($field_id);

[202] Fix | Delete

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

[203] Fix | Delete

if ($key) {

[204] Fix | Delete

$this->_field_values[$key] = implode(', ', $field_value);

[205] Fix | Delete

}

[206] Fix | Delete

}

[207] Fix | Delete

[208] Fix | Delete

return $this->_field_values;

[209] Fix | Delete

}

[210] Fix | Delete

[211] Fix | Delete

[212] Fix | Delete

public function getExtraValue($key) {

[213] Fix | Delete

if (!isset($this->extraValues[$key]) || !$this->extraValues[$key]) {

[214] Fix | Delete

$id = ( $this->subId ) ? $this->subId : 0;

[215] Fix | Delete

$this->extraValues[$key] = get_post_meta($id, $key, TRUE);

[216] Fix | Delete

}

[217] Fix | Delete

[218] Fix | Delete

return $this->extraValues[$key];

[219] Fix | Delete

}

[220] Fix | Delete

[221] Fix | Delete

/**

[222] Fix | Delete

* Get Field ID By Key

[223] Fix | Delete

[224] Fix | Delete

* @param $field_key

[225] Fix | Delete

* @return mixed

[226] Fix | Delete

[227] Fix | Delete

protected function getFieldIdByKey($field_key) {

[228] Fix | Delete

global $wpdb;

[229] Fix | Delete

[230] Fix | Delete

$field_id = $wpdb->get_var("SELECT id FROM {$wpdb->prefix}nf3_fields WHERE `key` = '{$field_key}' AND `parent_id` = {$this->_form_id}");

[231] Fix | Delete

[232] Fix | Delete

return $field_id;

[233] Fix | Delete

}

[234] Fix | Delete

[235] Fix | Delete

[236] Fix | Delete

/**

[237] Fix | Delete

* Set timestamp of export

[238] Fix | Delete

[239] Fix | Delete

* @param int $unixTimestamp

[240] Fix | Delete

* @return NF_Database_Models_SingleSubmissionInterface

[241] Fix | Delete

[242] Fix | Delete

public function setExportDatetime(int $unixTimestamp) {

[243] Fix | Delete

update_post_meta($this->subId, self::EXPORT_TIMESTAMP_KEY, $unixTimestamp);

[244] Fix | Delete

[245] Fix | Delete

return $this;

[246] Fix | Delete

}

[247] Fix | Delete

[248] Fix | Delete

/**

[249] Fix | Delete

* Return bool true if submission has exported datetime set

[250] Fix | Delete

* @return bool

[251] Fix | Delete

[252] Fix | Delete

public function wasExported() {

[253] Fix | Delete

$bool = false;

[254] Fix | Delete

[255] Fix | Delete

$test = $this->getExtraValue(self::EXPORT_TIMESTAMP_KEY);

[256] Fix | Delete

[257] Fix | Delete

if ($test) {

[258] Fix | Delete

$bool = true;

[259] Fix | Delete

}

[260] Fix | Delete

return $bool;

[261] Fix | Delete

}

[262] Fix | Delete

[263] Fix | Delete

/**

[264] Fix | Delete

* Return bool `is submission unread?`

[265] Fix | Delete

[266] Fix | Delete

* If not set, default is false (submission has been read). Thus new

[267] Fix | Delete

* submissions must be explicitly set as unread. Without this, all

[268] Fix | Delete

* preexisting submissions will be marked as unread and can confuse

[269] Fix | Delete

* existing installations.

[270] Fix | Delete

[271] Fix | Delete

* @return boolean

[272] Fix | Delete

[273] Fix | Delete

public function isUnread() {

[274] Fix | Delete

$default = false;

[275] Fix | Delete

[276] Fix | Delete

$return = $this->getExtraValue(self::UNREAD_KEY);

[277] Fix | Delete

[278] Fix | Delete

if (true != $return) {

[279] Fix | Delete

$return = $default;

[280] Fix | Delete

}

[281] Fix | Delete

[282] Fix | Delete

return $return;

[283] Fix | Delete

}

[284] Fix | Delete

[285] Fix | Delete

/**

[286] Fix | Delete

* Mark the submission as `unread` via post_meta

[287] Fix | Delete

[288] Fix | Delete

public function markAsRead() {

[289] Fix | Delete

update_post_meta($this->subId, self::UNREAD_KEY, false);

[290] Fix | Delete

}

[291] Fix | Delete

[292] Fix | Delete

/**

[293] Fix | Delete

* Mark the submission as `read` via post_meta

[294] Fix | Delete

[295] Fix | Delete

public function markAsUnread() {

[296] Fix | Delete

update_post_meta($this->subId, self::UNREAD_KEY, true);

[297] Fix | Delete

}

[298] Fix | Delete

[299] Fix | Delete

}

[300] Fix | Delete

[301] Fix | Delete