<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Forms;

[2] Fix | Delete

[3] Fix | Delete

/**

[4] Fix | Delete

* Class Submission.

[5] Fix | Delete

*

[6] Fix | Delete

* @since 1.7.4

[7] Fix | Delete

*/

[8] Fix | Delete

class Submission {

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* The form fields.

[12] Fix | Delete

*

[13] Fix | Delete

* @since 1.7.4

[14] Fix | Delete

*

[15] Fix | Delete

* @var array

[16] Fix | Delete

*/

[17] Fix | Delete

protected $fields;

[18] Fix | Delete

[19] Fix | Delete

/**

[20] Fix | Delete

* The form entry.

[21] Fix | Delete

*

[22] Fix | Delete

* @since 1.7.4

[23] Fix | Delete

*

[24] Fix | Delete

* @var array

[25] Fix | Delete

*/

[26] Fix | Delete

private $entry;

[27] Fix | Delete

[28] Fix | Delete

/**

[29] Fix | Delete

* The form ID.

[30] Fix | Delete

*

[31] Fix | Delete

* @since 1.7.4

[32] Fix | Delete

*

[33] Fix | Delete

* @var int

[34] Fix | Delete

*/

[35] Fix | Delete

private $form_id;

[36] Fix | Delete

[37] Fix | Delete

/**

[38] Fix | Delete

* The form data.

[39] Fix | Delete

*

[40] Fix | Delete

* @since 1.7.4

[41] Fix | Delete

*

[42] Fix | Delete

* @var array

[43] Fix | Delete

*/

[44] Fix | Delete

protected $form_data;

[45] Fix | Delete

[46] Fix | Delete

/**

[47] Fix | Delete

* The date.

[48] Fix | Delete

*

[49] Fix | Delete

* @since 1.7.4

[50] Fix | Delete

*

[51] Fix | Delete

* @var string

[52] Fix | Delete

*/

[53] Fix | Delete

private $date;

[54] Fix | Delete

[55] Fix | Delete

/**

[56] Fix | Delete

* Register the submission data.

[57] Fix | Delete

*

[58] Fix | Delete

* @since 1.7.4

[59] Fix | Delete

* @since 1.8.2 Added a return of instance.

[60] Fix | Delete

*

[61] Fix | Delete

* @param array $fields The form fields.

[62] Fix | Delete

* @param array $entry The form entry.

[63] Fix | Delete

* @param int $form_id The form ID.

[64] Fix | Delete

* @param array $form_data The form data.

[65] Fix | Delete

*

[66] Fix | Delete

* @return Submission

[67] Fix | Delete

*/

[68] Fix | Delete

public function register( array $fields, array $entry, $form_id, array $form_data = [] ) {

[69] Fix | Delete

[70] Fix | Delete

$this->fields = $fields;

[71] Fix | Delete

$this->entry = $entry;

[72] Fix | Delete

$this->form_id = $form_id;

[73] Fix | Delete

$this->form_data = $form_data;

[74] Fix | Delete

$this->date = gmdate( 'Y-m-d H:i:s' );

[75] Fix | Delete

[76] Fix | Delete

return $this;

[77] Fix | Delete

}

[78] Fix | Delete

[79] Fix | Delete

/**

[80] Fix | Delete

* Prepare the submission data.

[81] Fix | Delete

*

[82] Fix | Delete

* @since 1.7.4

[83] Fix | Delete

*

[84] Fix | Delete

* @return array|void

[85] Fix | Delete

*/

[86] Fix | Delete

public function prepare_entry_data() {

[87] Fix | Delete

[88] Fix | Delete

/**

[89] Fix | Delete

* Provide the opportunity to disable entry saving.

[90] Fix | Delete

*

[91] Fix | Delete

* @since 1.0.0

[92] Fix | Delete

*

[93] Fix | Delete

* @param bool $entry_save Entry save flag. Defaults to true.

[94] Fix | Delete

* @param array $fields Fields data.

[95] Fix | Delete

* @param array $entry Entry data.

[96] Fix | Delete

* @param array $form_data Form data.

[97] Fix | Delete

*/

[98] Fix | Delete

if ( ! apply_filters( 'wpforms_entry_save', true, $this->fields, $this->entry, $this->form_data ) ) { // phpcs:ignore WPForms.PHP.ValidateHooks.InvalidHookName

[99] Fix | Delete

return;

[100] Fix | Delete

}

[101] Fix | Delete

[102] Fix | Delete

$submitted_fields = $this->get_fields();

[103] Fix | Delete

$user_info = $this->get_user_info( $submitted_fields );

[104] Fix | Delete

[105] Fix | Delete

/**

[106] Fix | Delete

* Information about the entry, that is ready to be saved into the main entries table,

[107] Fix | Delete

* which is used for displaying a list of entries and partially for search.

[108] Fix | Delete

*

[109] Fix | Delete

* @since 1.5.9

[110] Fix | Delete

*

[111] Fix | Delete

* @param array $entry_data Information about the entry, that will be saved into the DB.

[112] Fix | Delete

* @param array $form_data Form data.

[113] Fix | Delete

*/

[114] Fix | Delete

return (array) apply_filters( // phpcs:ignore WPForms.PHP.ValidateHooks.InvalidHookName

[115] Fix | Delete

'wpforms_entry_save_args',

[116] Fix | Delete

[

[117] Fix | Delete

'form_id' => absint( $this->form_id ),

[118] Fix | Delete

'user_id' => absint( $user_info['user_id'] ),

[119] Fix | Delete

'fields' => wp_json_encode( $submitted_fields ),

[120] Fix | Delete

'ip_address' => sanitize_text_field( $user_info['user_ip'] ),

[121] Fix | Delete

'user_agent' => sanitize_text_field( $user_info['user_agent'] ),

[122] Fix | Delete

'date' => $this->date,

[123] Fix | Delete

'user_uuid' => sanitize_text_field( $user_info['user_uuid'] ),

[124] Fix | Delete

],

[125] Fix | Delete

$this->form_data

[126] Fix | Delete

);

[127] Fix | Delete

}

[128] Fix | Delete

[129] Fix | Delete

/**

[130] Fix | Delete

* Prepare the payment submission data.

[131] Fix | Delete

*

[132] Fix | Delete

* @since 1.8.2

[133] Fix | Delete

*

[134] Fix | Delete

* @return array

[135] Fix | Delete

*/

[136] Fix | Delete

public function prepare_payment_data() {

[137] Fix | Delete

[138] Fix | Delete

$submitted_fields = $this->get_fields();

[139] Fix | Delete

$total_amount = wpforms_get_total_payment( $submitted_fields );

[140] Fix | Delete

[141] Fix | Delete

/**

[142] Fix | Delete

* Information about the payment, that is ready to be saved into the main payments table,

[143] Fix | Delete

* which is used for displaying a list of payments and partially for search.

[144] Fix | Delete

*

[145] Fix | Delete

* @since 1.8.2

[146] Fix | Delete

*

[147] Fix | Delete

* @param array $payment_data Information about the payment, that will be saved into the DB.

[148] Fix | Delete

* @param array $fields Final/sanitized submitted field data.

[149] Fix | Delete

* @param array $form_data Form data and settings.

[150] Fix | Delete

*/

[151] Fix | Delete

$payment_data = (array) apply_filters(

[152] Fix | Delete

'wpforms_forms_submission_prepare_payment_data',

[153] Fix | Delete

[

[154] Fix | Delete

'form_id' => absint( $this->form_id ),

[155] Fix | Delete

'subtotal_amount' => $total_amount,

[156] Fix | Delete

'total_amount' => $total_amount,

[157] Fix | Delete

'currency' => wpforms_get_currency(),

[158] Fix | Delete

'entry_id' => absint( $this->entry['entry_id'] ),

[159] Fix | Delete

'date_created_gmt' => $this->date,

[160] Fix | Delete

'date_updated_gmt' => $this->date,

[161] Fix | Delete

],

[162] Fix | Delete

$submitted_fields,

[163] Fix | Delete

$this->form_data

[164] Fix | Delete

);

[165] Fix | Delete

[166] Fix | Delete

if ( empty( $payment_data['type'] ) ) {

[167] Fix | Delete

$payment_data['type'] = ! empty( $payment_data['subscription_id'] ) ? 'subscription' : 'one-time';

[168] Fix | Delete

}

[169] Fix | Delete

[170] Fix | Delete

return $payment_data;

[171] Fix | Delete

}

[172] Fix | Delete

[173] Fix | Delete

/**

[174] Fix | Delete

* Prepare the payment meta data for each payment.

[175] Fix | Delete

*

[176] Fix | Delete

* @since 1.8.2

[177] Fix | Delete

*

[178] Fix | Delete

* @return array

[179] Fix | Delete

*/

[180] Fix | Delete

public function prepare_payment_meta() {

[181] Fix | Delete

[182] Fix | Delete

$submitted_fields = $this->get_fields();

[183] Fix | Delete

$user_info = $this->get_user_info( $submitted_fields );

[184] Fix | Delete

[185] Fix | Delete

/**

[186] Fix | Delete

* Payment meta that is ready to be saved into the payments_meta table.

[187] Fix | Delete

*

[188] Fix | Delete

* @since 1.8.2

[189] Fix | Delete

*

[190] Fix | Delete

* @param array $payment_meta Payment meta that will be saved into the DB.

[191] Fix | Delete

* @param array $fields Final/sanitized submitted field data.

[192] Fix | Delete

* @param array $form_data Form data and settings.

[193] Fix | Delete

*/

[194] Fix | Delete

return (array) apply_filters(

[195] Fix | Delete

'wpforms_forms_submission_prepare_payment_meta',

[196] Fix | Delete

[

[197] Fix | Delete

'fields' => ! $this->entry['entry_id'] ? wp_json_encode( $submitted_fields ) : '',

[198] Fix | Delete

'user_id' => absint( $user_info['user_id'] ),

[199] Fix | Delete

'user_agent' => sanitize_text_field( $user_info['user_agent'] ),

[200] Fix | Delete

'user_uuid' => sanitize_text_field( $user_info['user_uuid'] ),

[201] Fix | Delete

'ip_address' => sanitize_text_field( $user_info['user_ip'] ),

[202] Fix | Delete

],

[203] Fix | Delete

$submitted_fields,

[204] Fix | Delete

$this->form_data

[205] Fix | Delete

);

[206] Fix | Delete

}

[207] Fix | Delete

[208] Fix | Delete

/**

[209] Fix | Delete

* Get entry fields.

[210] Fix | Delete

*

[211] Fix | Delete

* @since 1.8.2

[212] Fix | Delete

*

[213] Fix | Delete

* @return array

[214] Fix | Delete

*/

[215] Fix | Delete

private function get_fields() {

[216] Fix | Delete

[217] Fix | Delete

/**

[218] Fix | Delete

* Filter the entry data before saving.

[219] Fix | Delete

*

[220] Fix | Delete

* @since 1.0.0

[221] Fix | Delete

*

[222] Fix | Delete

* @param array $fields Fields data.

[223] Fix | Delete

* @param array $entry Entry data.

[224] Fix | Delete

* @param array $form_data Form data.

[225] Fix | Delete

*/

[226] Fix | Delete

return (array) apply_filters( 'wpforms_entry_save_data', $this->fields, $this->entry, $this->form_data ); // phpcs:ignore WPForms.PHP.ValidateHooks.InvalidHookName

[227] Fix | Delete

}

[228] Fix | Delete

[229] Fix | Delete

/**

[230] Fix | Delete

* Get user info.

[231] Fix | Delete

*

[232] Fix | Delete

* @since 1.8.2

[233] Fix | Delete

*

[234] Fix | Delete

* @param array $fields Fields data.

[235] Fix | Delete

*

[236] Fix | Delete

* @return array

[237] Fix | Delete

*/

[238] Fix | Delete

private function get_user_info( $fields ) {

[239] Fix | Delete

[240] Fix | Delete

$user_info = [

[241] Fix | Delete

'user_ip' => '',

[242] Fix | Delete

'user_agent' => '',

[243] Fix | Delete

'user_id' => is_user_logged_in() ? get_current_user_id() : 0,

[244] Fix | Delete

'user_uuid' => wpforms_is_collecting_cookies_allowed() && ! empty( $_COOKIE['_wpfuuid'] ) ? sanitize_key( $_COOKIE['_wpfuuid'] ) : '',

[245] Fix | Delete

];

[246] Fix | Delete

[247] Fix | Delete

/**

[248] Fix | Delete

* Allow developers disable saving user IP and User Agent within the entry.

[249] Fix | Delete

*

[250] Fix | Delete

* @since 1.5.1

[251] Fix | Delete

*

[252] Fix | Delete

* @param bool $disable True if you need to disable storing IP and UA within the entry. Defaults to false.

[253] Fix | Delete

* @param array $fields Fields data.

[254] Fix | Delete

* @param array $form_data Form data.

[255] Fix | Delete

*/

[256] Fix | Delete

// phpcs:ignore WPForms.PHP.ValidateHooks.InvalidHookName

[257] Fix | Delete

$is_ip_disabled = apply_filters( 'wpforms_disable_entry_user_ip', '__return_false', $fields, $this->form_data );

[258] Fix | Delete

[259] Fix | Delete

// If GDPR enhancements are enabled and user details are disabled

[260] Fix | Delete

// globally or in the form settings, discard the IP and UA.

[261] Fix | Delete

if (

[262] Fix | Delete

! $is_ip_disabled ||

[263] Fix | Delete

! wpforms_is_collecting_ip_allowed( $this->form_data )

[264] Fix | Delete

) {

[265] Fix | Delete

return $user_info;

[266] Fix | Delete

}

[267] Fix | Delete

[268] Fix | Delete

$user_info['user_ip'] = wpforms_get_ip();

[269] Fix | Delete

[270] Fix | Delete

if ( empty( $_SERVER['HTTP_USER_AGENT'] ) ) {

[271] Fix | Delete

return $user_info;

[272] Fix | Delete

}

[273] Fix | Delete

[274] Fix | Delete

$user_info['user_agent'] = substr( sanitize_text_field( wp_unslash( $_SERVER['HTTP_USER_AGENT'] ) ), 0, 256 );

[275] Fix | Delete

[276] Fix | Delete

return $user_info;

[277] Fix | Delete

}

[278] Fix | Delete

}

[279] Fix | Delete

[280] Fix | Delete