<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Admin\Education\Builder;

[2] Fix | Delete

[3] Fix | Delete

use WPForms\Admin\Education\AddonsItemBase;

[4] Fix | Delete

use WPForms\Admin\Education\Helpers;

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Builder/Calculations Education feature for Lite and Pro.

[8] Fix | Delete

*

[9] Fix | Delete

* @since 1.8.4.1

[10] Fix | Delete

*/

[11] Fix | Delete

class Calculations extends AddonsItemBase {

[12] Fix | Delete

[13] Fix | Delete

/**

[14] Fix | Delete

* Support calculations in these field types.

[15] Fix | Delete

*

[16] Fix | Delete

* @since 1.8.4.1

[17] Fix | Delete

*

[18] Fix | Delete

* @var array

[19] Fix | Delete

*/

[20] Fix | Delete

const ALLOWED_FIELD_TYPES = [ 'text', 'textarea', 'number', 'hidden', 'payment-single' ];

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* Field types that should display educational notice in the basic field options tab.

[24] Fix | Delete

*

[25] Fix | Delete

* @since 1.8.4.1

[26] Fix | Delete

*

[27] Fix | Delete

* @var array

[28] Fix | Delete

*/

[29] Fix | Delete

const BASIC_OPTIONS_NOTICE_FIELD_TYPES = [ 'number', 'payment-single' ];

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* Indicate if current Education feature is allowed to load.

[33] Fix | Delete

*

[34] Fix | Delete

* @since 1.8.4.1

[35] Fix | Delete

*

[36] Fix | Delete

* @return bool

[37] Fix | Delete

*/

[38] Fix | Delete

public function allow_load() {

[39] Fix | Delete

[40] Fix | Delete

return wpforms_is_admin_page( 'builder' ) || wpforms_is_admin_ajax();

[41] Fix | Delete

}

[42] Fix | Delete

[43] Fix | Delete

/**

[44] Fix | Delete

* Hooks.

[45] Fix | Delete

*

[46] Fix | Delete

* @since 1.8.4.1

[47] Fix | Delete

*/

[48] Fix | Delete

public function hooks() {

[49] Fix | Delete

[50] Fix | Delete

add_action( 'wpforms_field_options_bottom_basic-options', [ $this, 'basic_options' ], 20, 2 );

[51] Fix | Delete

add_action( 'wpforms_field_options_bottom_advanced-options', [ $this, 'advanced_options' ], 20, 2 );

[52] Fix | Delete

}

[53] Fix | Delete

[54] Fix | Delete

/**

[55] Fix | Delete

* Display notice on basic options.

[56] Fix | Delete

*

[57] Fix | Delete

* @since 1.8.4.1

[58] Fix | Delete

*

[59] Fix | Delete

* @param array $field Field data.

[60] Fix | Delete

* @param object $instance Builder instance.

[61] Fix | Delete

*

[62] Fix | Delete

* @noinspection HtmlUnknownTarget

[63] Fix | Delete

* @noinspection PhpUnusedParameterInspection

[64] Fix | Delete

*/

[65] Fix | Delete

public function basic_options( $field, $instance ) {

[66] Fix | Delete

[67] Fix | Delete

// Display notice in basic options only in numbers and payment-single fields.

[68] Fix | Delete

if ( ! in_array( $field['type'], self::BASIC_OPTIONS_NOTICE_FIELD_TYPES, true ) ) {

[69] Fix | Delete

return;

[70] Fix | Delete

}

[71] Fix | Delete

[72] Fix | Delete

$dismissed = get_user_meta( get_current_user_id(), 'wpforms_dismissed', true );

[73] Fix | Delete

$form_id = $instance->form_id ?? 0;

[74] Fix | Delete

$dismiss_section = "builder-form-$form_id-field-options-calculations-notice";

[75] Fix | Delete

[76] Fix | Delete

// Check whether it is dismissed.

[77] Fix | Delete

if ( ! empty( $dismissed[ 'edu-' . $dismiss_section ] ) ) {

[78] Fix | Delete

return;

[79] Fix | Delete

}

[80] Fix | Delete

[81] Fix | Delete

// Display notice only if Calculations addon is released (available in `addons.json` file).

[82] Fix | Delete

$addon = $this->addons->get_addon( 'calculations' );

[83] Fix | Delete

[84] Fix | Delete

if ( ! $addon ) {

[85] Fix | Delete

return;

[86] Fix | Delete

}

[87] Fix | Delete

[88] Fix | Delete

$notice = sprintf(

[89] Fix | Delete

wp_kses( /* translators: %1$s - link to the WPForms.com doc article. */

[90] Fix | Delete

__( 'Easily perform calculations based on user input. Head over to the <a href="#advanced-tab">Advanced Tab</a> to get started or read <a href="%1$s" target="_blank" rel="noopener noreferrer">our documentation</a> to learn more.', 'wpforms-lite' ),

[91] Fix | Delete

[

[92] Fix | Delete

'a' => [

[93] Fix | Delete

'href' => [],

[94] Fix | Delete

'rel' => [],

[95] Fix | Delete

'target' => [],

[96] Fix | Delete

],

[97] Fix | Delete

]

[98] Fix | Delete

),

[99] Fix | Delete

esc_url( wpforms_utm_link( 'https://wpforms.com/docs/calculations-addon/', 'Calculations Education', 'Calculations Documentation' ) )

[100] Fix | Delete

);

[101] Fix | Delete

[102] Fix | Delete

printf(

[103] Fix | Delete

'<div class="wpforms-alert-info wpforms-alert wpforms-educational-alert wpforms-calculations wpforms-dismiss-container">

[104] Fix | Delete

<button type="button" class="wpforms-dismiss-button" title="%1$s" data-section="%2$s"></button>

[105] Fix | Delete

<span class="wpforms-educational-badge wpforms-educational-badge-green">%3$s</span>

[106] Fix | Delete

<h4>%4$s</h4>

[107] Fix | Delete

<p>%5$s</p>

[108] Fix | Delete

</div>',

[109] Fix | Delete

esc_html__( 'Dismiss this notice.', 'wpforms-lite' ),

[110] Fix | Delete

esc_attr( $dismiss_section ),

[111] Fix | Delete

esc_html__( 'New feature', 'wpforms-lite' ),

[112] Fix | Delete

esc_html__( 'Calculations Are Here!', 'wpforms-lite' ),

[113] Fix | Delete

$notice // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped

[114] Fix | Delete

);

[115] Fix | Delete

}

[116] Fix | Delete

[117] Fix | Delete

/**

[118] Fix | Delete

* Display advanced options.

[119] Fix | Delete

*

[120] Fix | Delete

* @since 1.8.4.1

[121] Fix | Delete

*

[122] Fix | Delete

* @param array $field Field data.

[123] Fix | Delete

* @param object $instance Builder instance.

[124] Fix | Delete

*/

[125] Fix | Delete

public function advanced_options( $field, $instance ) {

[126] Fix | Delete

[127] Fix | Delete

if ( ! in_array( $field['type'], self::ALLOWED_FIELD_TYPES, true ) ) {

[128] Fix | Delete

return;

[129] Fix | Delete

}

[130] Fix | Delete

[131] Fix | Delete

$addon = $this->addons->get_addon( 'calculations' );

[132] Fix | Delete

[133] Fix | Delete

if ( ! $this->is_edu_required_by_status( $addon ) ) {

[134] Fix | Delete

return;

[135] Fix | Delete

}

[136] Fix | Delete

[137] Fix | Delete

$row_args = $this->get_row_attributes( $addon );

[138] Fix | Delete

$row_args['content'] = $instance->field_element(

[139] Fix | Delete

'toggle',

[140] Fix | Delete

$field,

[141] Fix | Delete

$this->get_field_attributes( $field, $addon ),

[142] Fix | Delete

false

[143] Fix | Delete

);

[144] Fix | Delete

[145] Fix | Delete

$instance->field_element( 'row', $field, $row_args );

[146] Fix | Delete

}

[147] Fix | Delete

[148] Fix | Delete

/**

[149] Fix | Delete

* Get row attributes.

[150] Fix | Delete

*

[151] Fix | Delete

* @since 1.8.4.1

[152] Fix | Delete

*

[153] Fix | Delete

* @param array $addon Addon data.

[154] Fix | Delete

*

[155] Fix | Delete

* @return array

[156] Fix | Delete

*/

[157] Fix | Delete

private function get_row_attributes( $addon ) {

[158] Fix | Delete

[159] Fix | Delete

$default = [

[160] Fix | Delete

'slug' => 'calculation_is_enabled',

[161] Fix | Delete

];

[162] Fix | Delete

[163] Fix | Delete

if ( $addon['plugin_allow'] && $addon['action'] === 'install' ) {

[164] Fix | Delete

return wp_parse_args(

[165] Fix | Delete

[

[166] Fix | Delete

'data' => [

[167] Fix | Delete

'action' => 'install',

[168] Fix | Delete

'name' => $addon['modal_name'],

[169] Fix | Delete

'url' => $addon['url'],

[170] Fix | Delete

'nonce' => wp_create_nonce( 'wpforms-admin' ),

[171] Fix | Delete

'license' => $addon['license_level'],

[172] Fix | Delete

],

[173] Fix | Delete

'class' => 'education-modal',

[174] Fix | Delete

],

[175] Fix | Delete

$default

[176] Fix | Delete

);

[177] Fix | Delete

}

[178] Fix | Delete

[179] Fix | Delete

if ( $addon['plugin_allow'] && $addon['action'] === 'activate' ) {

[180] Fix | Delete

return wp_parse_args(

[181] Fix | Delete

[

[182] Fix | Delete

'data' => [

[183] Fix | Delete

'action' => 'activate',

[184] Fix | Delete

'name' => sprintf( /* translators: %s - addon name. */

[185] Fix | Delete

esc_html__( '%s addon', 'wpforms-lite' ),

[186] Fix | Delete

$addon['title']

[187] Fix | Delete

),

[188] Fix | Delete

'path' => $addon['path'],

[189] Fix | Delete

'nonce' => wp_create_nonce( 'wpforms-admin' ),

[190] Fix | Delete

],

[191] Fix | Delete

'class' => 'education-modal',

[192] Fix | Delete

],

[193] Fix | Delete

$default

[194] Fix | Delete

);

[195] Fix | Delete

}

[196] Fix | Delete

[197] Fix | Delete

return wp_parse_args(

[198] Fix | Delete

[

[199] Fix | Delete

'data' => [

[200] Fix | Delete

'action' => 'upgrade',

[201] Fix | Delete

'name' => esc_html__( 'Calculations', 'wpforms-lite' ),

[202] Fix | Delete

'utm-content' => 'Enable Calculations',

[203] Fix | Delete

'license' => $addon['license_level'],

[204] Fix | Delete

],

[205] Fix | Delete

'class' => 'education-modal',

[206] Fix | Delete

],

[207] Fix | Delete

$default

[208] Fix | Delete

);

[209] Fix | Delete

}

[210] Fix | Delete

[211] Fix | Delete

/**

[212] Fix | Delete

* Get attributes for address autocomplete field.

[213] Fix | Delete

*

[214] Fix | Delete

* @since 1.8.4.1

[215] Fix | Delete

*

[216] Fix | Delete

* @param array $field Field data.

[217] Fix | Delete

* @param array $addon Addon data.

[218] Fix | Delete

*

[219] Fix | Delete

* @return array

[220] Fix | Delete

* @noinspection PhpUnusedParameterInspection

[221] Fix | Delete

*/

[222] Fix | Delete

private function get_field_attributes( $field, $addon ) {

[223] Fix | Delete

[224] Fix | Delete

$default = [

[225] Fix | Delete

'slug' => 'calculation_is_enabled',

[226] Fix | Delete

'value' => '0',

[227] Fix | Delete

'desc' => esc_html__( 'Enable Calculation', 'wpforms-lite' ),

[228] Fix | Delete

];

[229] Fix | Delete

[230] Fix | Delete

if ( $addon['plugin_allow'] ) {

[231] Fix | Delete

return $default;

[232] Fix | Delete

}

[233] Fix | Delete

[234] Fix | Delete

return wp_parse_args(

[235] Fix | Delete

[

[236] Fix | Delete

'desc' => sprintf(

[237] Fix | Delete

'%1$s%2$s',

[238] Fix | Delete

esc_html__( 'Enable Calculation', 'wpforms-lite' ),

[239] Fix | Delete

Helpers::get_badge( $addon['license_level'], 'sm', 'inline', 'slate' )

[240] Fix | Delete

),

[241] Fix | Delete

'attrs' => [

[242] Fix | Delete

'disabled' => 'disabled',

[243] Fix | Delete

],

[244] Fix | Delete

],

[245] Fix | Delete

$default

[246] Fix | Delete

);

[247] Fix | Delete

}

[248] Fix | Delete

[249] Fix | Delete

/**

[250] Fix | Delete

* Determine if we require to display educational items according to the addon status.

[251] Fix | Delete

*

[252] Fix | Delete

* @since 1.8.4.1

[253] Fix | Delete

*

[254] Fix | Delete

* @param array $addon Addon data.

[255] Fix | Delete

*

[256] Fix | Delete

* @return bool

[257] Fix | Delete

* @noinspection PhpUnusedParameterInspection

[258] Fix | Delete

*/

[259] Fix | Delete

private function is_edu_required_by_status( $addon ) {

[260] Fix | Delete

[261] Fix | Delete

return ! (

[262] Fix | Delete

empty( $addon ) ||

[263] Fix | Delete

empty( $addon['action'] ) ||

[264] Fix | Delete

empty( $addon['status'] ) || (

[265] Fix | Delete

$addon['status'] === 'active' && $addon['action'] !== 'upgrade'

[266] Fix | Delete

)

[267] Fix | Delete

);

[268] Fix | Delete

}

[269] Fix | Delete

}

[270] Fix | Delete

[271] Fix | Delete