Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

/**

[2] Fix | Delete

* Class NF_Database_Models_Submission

[3] Fix | Delete

[4] Fix | Delete

class NF_Database_Models_Submission

[5] Fix | Delete

{

[6] Fix | Delete

protected $_id = '';

[7] Fix | Delete

[8] Fix | Delete

protected $_status = '';

[9] Fix | Delete

[10] Fix | Delete

protected $_user_id = '';

[11] Fix | Delete

[12] Fix | Delete

protected $_form_id = '';

[13] Fix | Delete

[14] Fix | Delete

protected $_seq_num = '';

[15] Fix | Delete

[16] Fix | Delete

protected $_sub_date = '';

[17] Fix | Delete

[18] Fix | Delete

protected $_mod_date = '';

[19] Fix | Delete

[20] Fix | Delete

protected $_field_values = array();

[21] Fix | Delete

[22] Fix | Delete

protected $_extra_values = array();

[23] Fix | Delete

[24] Fix | Delete

/**

[25] Fix | Delete

* Delimiter that uniquely identifies a field as type 'repeater'

[26] Fix | Delete

[27] Fix | Delete

* Requests for a field can be made by either an (int) field id or a

[28] Fix | Delete

* (string) field reference, which prior to fieldset repeaters had been

[29] Fix | Delete

* for the field key only. For disambiguation, a fieldset repeater field

[30] Fix | Delete

* request for a specific field within the fieldset is in the form of:

[31] Fix | Delete

* {fieldsetFieldId}{delimiter}{fieldIdOfFieldWithinFieldset}

[32] Fix | Delete

[33] Fix | Delete

* @var string

[34] Fix | Delete

[35] Fix | Delete

protected $_fieldsetDelimiter='.';

[36] Fix | Delete

[37] Fix | Delete

/**

[38] Fix | Delete

* Delimiter that uniquely identifies multiple fieldset repeater submissions

[39] Fix | Delete

[40] Fix | Delete

* Fieldset Repeaters can have multiple values submitted on any given

[41] Fix | Delete

* submission. Each repeated value for a field in the fieldset is

[42] Fix | Delete

* delimited in the submission data with an incremented index value

[43] Fix | Delete

* @var string

[44] Fix | Delete

[45] Fix | Delete

protected $_fieldsetRepetitionDelimiter='_';

[46] Fix | Delete

[47] Fix | Delete

public function __construct( $id = '', $form_id = '' )

[48] Fix | Delete

{

[49] Fix | Delete

$this->_id = $id;

[50] Fix | Delete

$this->_form_id = $form_id;

[51] Fix | Delete

[52] Fix | Delete

if( $this->_id ){

[53] Fix | Delete

$sub = $this->retrieveSub($this->_id);

[54] Fix | Delete

[55] Fix | Delete

if ($sub) {

[56] Fix | Delete

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

[57] Fix | Delete

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

[58] Fix | Delete

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

[59] Fix | Delete

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

[60] Fix | Delete

}

[61] Fix | Delete

}

[62] Fix | Delete

[63] Fix | Delete

if( $this->_id && ! $this->_form_id ){

[64] Fix | Delete

$this->_form_id = $this->retrieveFormId($this->_id);

[65] Fix | Delete

}

[66] Fix | Delete

[67] Fix | Delete

if( $this->_id && $this->_form_id ){

[68] Fix | Delete

$this->_seq_num = $this->retrieveSeqNum($this->_id);

[69] Fix | Delete

}

[70] Fix | Delete

}

[71] Fix | Delete

[72] Fix | Delete

/**

[73] Fix | Delete

* Get post object

[74] Fix | Delete

[75] Fix | Delete

* Uses WP functionality

[76] Fix | Delete

[77] Fix | Delete

* @param string $id

[78] Fix | Delete

* @return object

[79] Fix | Delete

[80] Fix | Delete

protected function retrieveSub($id)

[81] Fix | Delete

{

[82] Fix | Delete

$return = get_post( $id );

[83] Fix | Delete

[84] Fix | Delete

return $return;

[85] Fix | Delete

}

[86] Fix | Delete

[87] Fix | Delete

/**

[88] Fix | Delete

* Get the Form Id

[89] Fix | Delete

[90] Fix | Delete

* Uses WP functionality

[91] Fix | Delete

[92] Fix | Delete

* @return int

[93] Fix | Delete

[94] Fix | Delete

protected function retrieveFormId( $id)

[95] Fix | Delete

{

[96] Fix | Delete

$return = $this->getPostMeta( $id, '_form_id', TRUE );

[97] Fix | Delete

return $return;

[98] Fix | Delete

}

[99] Fix | Delete

[100] Fix | Delete

/**

[101] Fix | Delete

* Get the sequence number

[102] Fix | Delete

[103] Fix | Delete

* Uses WP functionality

[104] Fix | Delete

[105] Fix | Delete

* @return int

[106] Fix | Delete

[107] Fix | Delete

protected function retrieveSeqNum($id)

[108] Fix | Delete

{

[109] Fix | Delete

$return = $this->getPostMeta( $id, '_seq_num', TRUE );

[110] Fix | Delete

return $return;

[111] Fix | Delete

}

[112] Fix | Delete

[113] Fix | Delete

/**

[114] Fix | Delete

* Get post meta value for given post Id and key

[115] Fix | Delete

[116] Fix | Delete

* @param int $id

[117] Fix | Delete

* @param string $key

[118] Fix | Delete

* @param bool $bool

[119] Fix | Delete

* @return mixed

[120] Fix | Delete

[121] Fix | Delete

protected function getPostMeta($id, $key, $bool = TRUE)

[122] Fix | Delete

{

[123] Fix | Delete

$return = get_post_meta( $id, $key, $bool );

[124] Fix | Delete

[125] Fix | Delete

return $return;

[126] Fix | Delete

}

[127] Fix | Delete

[128] Fix | Delete

/**

[129] Fix | Delete

* Get Submission ID

[130] Fix | Delete

[131] Fix | Delete

* @return int

[132] Fix | Delete

[133] Fix | Delete

public function get_id()

[134] Fix | Delete

{

[135] Fix | Delete

return intval( $this->_id );

[136] Fix | Delete

}

[137] Fix | Delete

[138] Fix | Delete

public function get_status()

[139] Fix | Delete

{

[140] Fix | Delete

return $this->_status;

[141] Fix | Delete

}

[142] Fix | Delete

[143] Fix | Delete

public function get_user()

[144] Fix | Delete

{

[145] Fix | Delete

return get_user_by( 'id', $this->_user_id );

[146] Fix | Delete

}

[147] Fix | Delete

[148] Fix | Delete

public function get_form_id()

[149] Fix | Delete

{

[150] Fix | Delete

return intval( $this->_form_id );

[151] Fix | Delete

}

[152] Fix | Delete

[153] Fix | Delete

public function get_form_title()

[154] Fix | Delete

{

[155] Fix | Delete

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

[156] Fix | Delete

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

[157] Fix | Delete

}

[158] Fix | Delete

[159] Fix | Delete

public function get_seq_num()

[160] Fix | Delete

{

[161] Fix | Delete

return intval( $this->_seq_num );

[162] Fix | Delete

}

[163] Fix | Delete

[164] Fix | Delete

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

[165] Fix | Delete

{

[166] Fix | Delete

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

[167] Fix | Delete

}

[168] Fix | Delete

[169] Fix | Delete

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

[170] Fix | Delete

{

[171] Fix | Delete

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

[172] Fix | Delete

}

[173] Fix | Delete

[174] Fix | Delete

/**

[175] Fix | Delete

* Get Field Value

[176] Fix | Delete

[177] Fix | Delete

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

[178] Fix | Delete

[179] Fix | Delete

* @param int|string $field_ref

[180] Fix | Delete

* @return string

[181] Fix | Delete

[182] Fix | Delete

public function get_field_value( $field_ref )

[183] Fix | Delete

{

[184] Fix | Delete

// Bypass existing method if fieldset repeater

[185] Fix | Delete

if(Ninja_Forms()->fieldsetRepeater->isRepeaterFieldByFieldReference($field_ref) ){

[186] Fix | Delete

[187] Fix | Delete

$parsedField = Ninja_Forms()->fieldsetRepeater

[188] Fix | Delete

->parseFieldsetFieldReference($field_ref);

[189] Fix | Delete

[190] Fix | Delete

$return = $this->get_field_value_for_fieldset_child($parsedField['fieldId'], $parsedField['fieldsetFieldId']);

[191] Fix | Delete

[192] Fix | Delete

return $return;

[193] Fix | Delete

}

[194] Fix | Delete

[195] Fix | Delete

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

[196] Fix | Delete

[197] Fix | Delete

$field = '_field_' . $field_id;

[198] Fix | Delete

[199] Fix | Delete

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

[200] Fix | Delete

[201] Fix | Delete

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

[202] Fix | Delete

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

[203] Fix | Delete

[204] Fix | Delete

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

[205] Fix | Delete

}

[206] Fix | Delete

[207] Fix | Delete

/**

[208] Fix | Delete

* Get field values of a single child field within a fieldset repeater field

[209] Fix | Delete

[210] Fix | Delete

* get_field_value(), which calls this method, is expected to return a

[211] Fix | Delete

* string. Fieldset Repeater child fields have a unique field reference,

[212] Fix | Delete

* differentiated by their delimiter that ensures that the requesting

[213] Fix | Delete

* external caller knows that it is requesting a fieldset repeater field.

[214] Fix | Delete

* This this method returns a serialized string of values, honoring the

[215] Fix | Delete

* get_field_value() method with the expectation that the external

[216] Fix | Delete

* caller will unserialize this value.

[217] Fix | Delete

[218] Fix | Delete

* @param int $fieldsetId

[219] Fix | Delete

* @param int $childFieldId

[220] Fix | Delete

[221] Fix | Delete

protected function get_field_value_for_fieldset_child($fieldsetId, $childFieldId) {

[222] Fix | Delete

[223] Fix | Delete

[224] Fix | Delete

if (!isset($this->_field_values[$fieldsetId])) {

[225] Fix | Delete

$this->_field_values[$fieldsetId] = get_post_meta($this->_id, '_field_' . $fieldsetId, true);

[226] Fix | Delete

}

[227] Fix | Delete

[228] Fix | Delete

$valueCollection = [];

[229] Fix | Delete

[230] Fix | Delete

if(!empty($this->_field_values[$fieldsetId] )){

[231] Fix | Delete

foreach ($this->_field_values[$fieldsetId] as $submissionKey => $value) {

[232] Fix | Delete

[233] Fix | Delete

$explodedFieldset = explode($this->_fieldsetDelimiter, $submissionKey);

[234] Fix | Delete

[235] Fix | Delete

if (!isset($explodedFieldset[1])) {

[236] Fix | Delete

// data is corrupted as we cannot determine field id construct

[237] Fix | Delete

break;

[238] Fix | Delete

}

[239] Fix | Delete

[240] Fix | Delete

$explodedChildField = explode($this->_fieldsetRepetitionDelimiter, $explodedFieldset[1]);

[241] Fix | Delete

[242] Fix | Delete

if (!isset($explodedChildField[1])) {

[243] Fix | Delete

// data is corrupted as we cannote determine child field id construct

[244] Fix | Delete

break;

[245] Fix | Delete

}

[246] Fix | Delete

[247] Fix | Delete

$submissionChildFieldId = $explodedChildField[0];

[248] Fix | Delete

$submissionIndex = $explodedChildField[1];

[249] Fix | Delete

[250] Fix | Delete

if ($submissionChildFieldId === $childFieldId) {

[251] Fix | Delete

[252] Fix | Delete

$valueCollection[$submissionIndex] = WPN_Helper::htmlspecialchars($value);

[253] Fix | Delete

}

[254] Fix | Delete

}

[255] Fix | Delete

}

[256] Fix | Delete

[257] Fix | Delete

$return = serialize($valueCollection);

[258] Fix | Delete

[259] Fix | Delete

return $return;

[260] Fix | Delete

}

[261] Fix | Delete

[262] Fix | Delete

/**

[263] Fix | Delete

* Get Field Values

[264] Fix | Delete

[265] Fix | Delete

* @return array|mixed

[266] Fix | Delete

[267] Fix | Delete

public function get_field_values()

[268] Fix | Delete

{

[269] Fix | Delete

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

[270] Fix | Delete

[271] Fix | Delete

$field_values = $this->getPostMeta( $this->_id, '' );

[272] Fix | Delete

[273] Fix | Delete

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

[274] Fix | Delete

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

[275] Fix | Delete

[276] Fix | Delete

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

[277] Fix | Delete

$field_id = substr( $field_id, 7 );

[278] Fix | Delete

}

[279] Fix | Delete

[280] Fix | Delete

if( ! is_numeric( $field_id ) ) continue;

[281] Fix | Delete

[282] Fix | Delete

if($this->_form_id){

[283] Fix | Delete

[284] Fix | Delete

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

[285] Fix | Delete

}else{

[286] Fix | Delete

[287] Fix | Delete

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

[288] Fix | Delete

}

[289] Fix | Delete

[290] Fix | Delete

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

[291] Fix | Delete

if( $key ) {

[292] Fix | Delete

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

[293] Fix | Delete

}

[294] Fix | Delete

}

[295] Fix | Delete

[296] Fix | Delete

return $this->_field_values;

[297] Fix | Delete

}

[298] Fix | Delete

[299] Fix | Delete

/**

[300] Fix | Delete

* Update Field Value

[301] Fix | Delete

[302] Fix | Delete

* @param $field_ref

[303] Fix | Delete

* @param $value

[304] Fix | Delete

* @return $this

[305] Fix | Delete

[306] Fix | Delete

public function update_field_value( $field_ref, $value )

[307] Fix | Delete

{

[308] Fix | Delete

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

[309] Fix | Delete

[310] Fix | Delete

$this->_field_values[ $field_id ] = WPN_Helper::kses_post( $value );

[311] Fix | Delete

[312] Fix | Delete

return $this;

[313] Fix | Delete

}

[314] Fix | Delete

[315] Fix | Delete

/**

[316] Fix | Delete

* Update Field Values

[317] Fix | Delete

[318] Fix | Delete

* @param $data

[319] Fix | Delete

* @return $this

[320] Fix | Delete

[321] Fix | Delete

public function update_field_values( $data )

[322] Fix | Delete

{

[323] Fix | Delete

foreach( $data as $field_ref => $value )

[324] Fix | Delete

{

[325] Fix | Delete

$this->update_field_value( $field_ref, $value );

[326] Fix | Delete

}

[327] Fix | Delete

[328] Fix | Delete

return $this;

[329] Fix | Delete

}

[330] Fix | Delete

[331] Fix | Delete

public function get_extra_value( $key )

[332] Fix | Delete

{

[333] Fix | Delete

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

[334] Fix | Delete

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

[335] Fix | Delete

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

[336] Fix | Delete

}

[337] Fix | Delete

[338] Fix | Delete

return $this->_extra_values[ $key ];

[339] Fix | Delete

}

[340] Fix | Delete

[341] Fix | Delete

public function get_extra_values( $keys )

[342] Fix | Delete

{

[343] Fix | Delete

$values = array();

[344] Fix | Delete

[345] Fix | Delete

foreach( $keys as $key ) {

[346] Fix | Delete

$values[ $key ] = $this->get_extra_value( $key );

[347] Fix | Delete

}

[348] Fix | Delete

[349] Fix | Delete

return $values;

[350] Fix | Delete

}

[351] Fix | Delete

[352] Fix | Delete

public function update_extra_value( $key, $value )

[353] Fix | Delete

{

[354] Fix | Delete

if( property_exists( $this, $key ) ) return FALSE;

[355] Fix | Delete

[356] Fix | Delete

return $this->_extra_values[ $key ] = $value;

[357] Fix | Delete

}

[358] Fix | Delete

[359] Fix | Delete

public function update_extra_values( $values )

[360] Fix | Delete

{

[361] Fix | Delete

foreach( $values as $key => $value ){

[362] Fix | Delete

$this->update_extra_value( $key, $value );

[363] Fix | Delete

}

[364] Fix | Delete

}

[365] Fix | Delete

[366] Fix | Delete

/**

[367] Fix | Delete

* Find Submissions

[368] Fix | Delete

[369] Fix | Delete

* @param $form_id

[370] Fix | Delete

* @param array $where

[371] Fix | Delete

* @return array

[372] Fix | Delete

[373] Fix | Delete

public function find( $form_id, array $where = array(), array $ids = array() )

[374] Fix | Delete

{

[375] Fix | Delete

[376] Fix | Delete

$this->_form_id = $form_id;

[377] Fix | Delete

[378] Fix | Delete

$args = array(

[379] Fix | Delete

'post_type' => 'nf_sub',

[380] Fix | Delete

'posts_per_page' => -1,

[381] Fix | Delete

'meta_query' => $this->format_meta_query( $where )

[382] Fix | Delete

);

[383] Fix | Delete

[384] Fix | Delete

if ( ! empty ( $ids ) ) {

[385] Fix | Delete

$args[ 'post__in' ] = $ids;

[386] Fix | Delete

}

[387] Fix | Delete

[388] Fix | Delete

$subs = get_posts( $args );

[389] Fix | Delete

[390] Fix | Delete

$class = get_class( $this );

[391] Fix | Delete

[392] Fix | Delete

$return = array();

[393] Fix | Delete

foreach( $subs as $sub ){

[394] Fix | Delete

$return[] = new $class( $sub->ID, $this->_form_id );

[395] Fix | Delete

}

[396] Fix | Delete

[397] Fix | Delete

return $return;

[398] Fix | Delete

}

[399] Fix | Delete

[400] Fix | Delete

/**

[401] Fix | Delete

* Delete Submission

[402] Fix | Delete

[403] Fix | Delete

public function delete()

[404] Fix | Delete

{

[405] Fix | Delete

if( ! $this->_id ) return;

[406] Fix | Delete

[407] Fix | Delete

wp_delete_post( $this->_id );

[408] Fix | Delete

}

[409] Fix | Delete

[410] Fix | Delete

/**

[411] Fix | Delete

* Trash Submission

[412] Fix | Delete

[413] Fix | Delete

public function trash()

[414] Fix | Delete

{

[415] Fix | Delete

if( ! $this->_id ) return;

[416] Fix | Delete

[417] Fix | Delete

wp_trash_post( $this->_id );

[418] Fix | Delete

}

[419] Fix | Delete

[420] Fix | Delete

/**

[421] Fix | Delete

* Save Submission

[422] Fix | Delete

[423] Fix | Delete

* @return $this|NF_Database_Models_Submission|void

[424] Fix | Delete

[425] Fix | Delete

public function save()

[426] Fix | Delete

{

[427] Fix | Delete

if( ! $this->_id ){

[428] Fix | Delete

[429] Fix | Delete

$sub = array(

[430] Fix | Delete

'post_type' => 'nf_sub',

[431] Fix | Delete

'post_status' => 'publish'

[432] Fix | Delete

);

[433] Fix | Delete

[434] Fix | Delete

$this->_id = wp_insert_post( $sub );

[435] Fix | Delete

[436] Fix | Delete

// Log Error

[437] Fix | Delete

if( ! $this->_id ) return;

[438] Fix | Delete

}

[439] Fix | Delete

[440] Fix | Delete

if( ! $this->_seq_num && $this->_form_id ){

[441] Fix | Delete

[442] Fix | Delete

$this->_seq_num = NF_Database_Models_Form::get_next_sub_seq( $this->_form_id );

[443] Fix | Delete

}

[444] Fix | Delete

[445] Fix | Delete

$this->_save_extra_values();

[446] Fix | Delete

[447] Fix | Delete

return $this->_save_field_values();

[448] Fix | Delete

}

[449] Fix | Delete

[450] Fix | Delete

public static function export( $form_id, array $sub_ids = array(), $return = FALSE )

[451] Fix | Delete

{

[452] Fix | Delete

$date_format = Ninja_Forms()->get_setting( 'date_format' );

[453] Fix | Delete

[454] Fix | Delete

[455] Fix | Delete

* Labels

[456] Fix | Delete

[457] Fix | Delete

[458] Fix | Delete

$field_labels = array(

[459] Fix | Delete

'_seq_num' => '#',

[460] Fix | Delete

'_date_submitted' => esc_html__( 'Date Submitted', 'ninja-forms' )

[461] Fix | Delete

);

[462] Fix | Delete

[463] Fix | Delete

$fields = Ninja_Forms()->form( $form_id )->get_fields();

[464] Fix | Delete

[465] Fix | Delete

[466] Fix | Delete

* If we are using an add-on that filters our field order, we don't want to call sort again.

[467] Fix | Delete

[468] Fix | Delete

* TODO: This is probably not the most effecient way to handle this. It should be re-thought.

[469] Fix | Delete

[470] Fix | Delete

if ( ! has_filter( 'ninja_forms_get_fields_sorted' ) ) {

[471] Fix | Delete

uasort( $fields, array( 'NF_Database_Models_Submission', 'sort_fields' ) );

[472] Fix | Delete

}

[473] Fix | Delete

[474] Fix | Delete

$hidden_field_types = apply_filters( 'nf_sub_hidden_field_types', array() );

[475] Fix | Delete

[476] Fix | Delete

[477] Fix | Delete

* Submissions

[478] Fix | Delete

[479] Fix | Delete

[480] Fix | Delete

$subs = Ninja_Forms()->form( $form_id )->get_subs( array(), FALSE, $sub_ids );

[481] Fix | Delete

[482] Fix | Delete

foreach( $subs as $sub ){

[483] Fix | Delete

[484] Fix | Delete

$value[ '_seq_num' ] = $sub->get_seq_num();

[485] Fix | Delete

$value[ '_date_submitted' ] = $sub->get_sub_date( $date_format );

[486] Fix | Delete

[487] Fix | Delete

// boolean - does this submission use a repeater

[488] Fix | Delete

$hasRepeater = false;

[489] Fix | Delete

// How many repeater submissions does this submission have

[490] Fix | Delete

$submissionCount = 0;

[491] Fix | Delete

// Ids of fields in the repeater

[492] Fix | Delete

$fieldsetFieldIds=[];

[493] Fix | Delete

[494] Fix | Delete

foreach ($fields as $field_id => $field) {

[495] Fix | Delete

// Bypass existing method if fieldset repeater

[496] Fix | Delete

if('repeater'===$field->get_setting('type')){

[497] Fix | Delete

$hasRepeater = true;

[498] Fix | Delete

[499] Fix | Delete