<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Admin\Payments\Views\Overview;

[2] Fix | Delete

[3] Fix | Delete

use WPForms\Admin\Helpers\Datepicker;

[4] Fix | Delete

use WPForms\Db\Payments\ValueValidator;

[5] Fix | Delete

use WPForms\Admin\Payments\Payments;

[6] Fix | Delete

use WPForms\Admin\Payments\Views\PaymentsViewsInterface;

[7] Fix | Delete

use WPForms\Integrations\Stripe\Helpers as StripeHelpers;

[8] Fix | Delete

[9] Fix | Delete

/**

[10] Fix | Delete

* Payments Overview Page class.

[11] Fix | Delete

*

[12] Fix | Delete

* @since 1.8.2

[13] Fix | Delete

*/

[14] Fix | Delete

class Page implements PaymentsViewsInterface {

[15] Fix | Delete

[16] Fix | Delete

/**

[17] Fix | Delete

* Payments table.

[18] Fix | Delete

*

[19] Fix | Delete

* @since 1.8.2

[20] Fix | Delete

*

[21] Fix | Delete

* @var Table

[22] Fix | Delete

*/

[23] Fix | Delete

private $table;

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* Payments chart.

[27] Fix | Delete

*

[28] Fix | Delete

* @since 1.8.2

[29] Fix | Delete

*

[30] Fix | Delete

* @var Chart

[31] Fix | Delete

*/

[32] Fix | Delete

private $chart;

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* Initialize class.

[36] Fix | Delete

*

[37] Fix | Delete

* @since 1.8.2

[38] Fix | Delete

*/

[39] Fix | Delete

public function init() {

[40] Fix | Delete

[41] Fix | Delete

if ( ! $this->has_any_mode_payment() ) {

[42] Fix | Delete

return;

[43] Fix | Delete

}

[44] Fix | Delete

[45] Fix | Delete

$this->chart = new Chart();

[46] Fix | Delete

$this->table = new Table();

[47] Fix | Delete

[48] Fix | Delete

$this->table->prepare_items();

[49] Fix | Delete

$this->clean_request_uri();

[50] Fix | Delete

$this->hooks();

[51] Fix | Delete

}

[52] Fix | Delete

[53] Fix | Delete

/**

[54] Fix | Delete

* Register hooks.

[55] Fix | Delete

*

[56] Fix | Delete

* @since 1.8.2

[57] Fix | Delete

*/

[58] Fix | Delete

private function hooks() {

[59] Fix | Delete

[60] Fix | Delete

add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_assets' ] );

[61] Fix | Delete

}

[62] Fix | Delete

[63] Fix | Delete

/**

[64] Fix | Delete

* Get the tab label.

[65] Fix | Delete

*

[66] Fix | Delete

* @since 1.8.2.2

[67] Fix | Delete

*

[68] Fix | Delete

* @return string

[69] Fix | Delete

*/

[70] Fix | Delete

public function get_tab_label() {

[71] Fix | Delete

[72] Fix | Delete

return __( 'Overview', 'wpforms-lite' );

[73] Fix | Delete

}

[74] Fix | Delete

[75] Fix | Delete

/**

[76] Fix | Delete

* Enqueue scripts and styles.

[77] Fix | Delete

*

[78] Fix | Delete

* @since 1.8.2

[79] Fix | Delete

*/

[80] Fix | Delete

public function enqueue_assets() {

[81] Fix | Delete

[82] Fix | Delete

$min = wpforms_get_min_suffix();

[83] Fix | Delete

[84] Fix | Delete

wp_enqueue_style(

[85] Fix | Delete

'wpforms-flatpickr',

[86] Fix | Delete

WPFORMS_PLUGIN_URL . 'assets/lib/flatpickr/flatpickr.min.css',

[87] Fix | Delete

[],

[88] Fix | Delete

'4.6.9'

[89] Fix | Delete

);

[90] Fix | Delete

[91] Fix | Delete

wp_enqueue_script(

[92] Fix | Delete

'wpforms-flatpickr',

[93] Fix | Delete

WPFORMS_PLUGIN_URL . 'assets/lib/flatpickr/flatpickr.min.js',

[94] Fix | Delete

[ 'jquery' ],

[95] Fix | Delete

'4.6.9',

[96] Fix | Delete

true

[97] Fix | Delete

);

[98] Fix | Delete

[99] Fix | Delete

wp_enqueue_style(

[100] Fix | Delete

'wpforms-multiselect-checkboxes',

[101] Fix | Delete

WPFORMS_PLUGIN_URL . 'assets/lib/wpforms-multiselect/wpforms-multiselect-checkboxes.min.css',

[102] Fix | Delete

[],

[103] Fix | Delete

'1.0.0'

[104] Fix | Delete

);

[105] Fix | Delete

[106] Fix | Delete

wp_enqueue_script(

[107] Fix | Delete

'wpforms-multiselect-checkboxes',

[108] Fix | Delete

WPFORMS_PLUGIN_URL . 'assets/lib/wpforms-multiselect/wpforms-multiselect-checkboxes.min.js',

[109] Fix | Delete

[],

[110] Fix | Delete

'1.0.0',

[111] Fix | Delete

true

[112] Fix | Delete

);

[113] Fix | Delete

[114] Fix | Delete

wp_enqueue_script(

[115] Fix | Delete

'wpforms-chart',

[116] Fix | Delete

WPFORMS_PLUGIN_URL . 'assets/lib/chart.min.js',

[117] Fix | Delete

[ 'moment' ],

[118] Fix | Delete

'2.9.4',

[119] Fix | Delete

true

[120] Fix | Delete

);

[121] Fix | Delete

[122] Fix | Delete

wp_enqueue_script(

[123] Fix | Delete

'wpforms-admin-payments-overview',

[124] Fix | Delete

WPFORMS_PLUGIN_URL . "assets/js/admin/payments/overview{$min}.js",

[125] Fix | Delete

[ 'jquery', 'wpforms-flatpickr', 'wpforms-chart' ],

[126] Fix | Delete

WPFORMS_VERSION,

[127] Fix | Delete

true

[128] Fix | Delete

);

[129] Fix | Delete

[130] Fix | Delete

$admin_l10n = [

[131] Fix | Delete

'settings' => $this->chart->get_chart_settings(),

[132] Fix | Delete

'locale' => sanitize_key( wpforms_get_language_code() ),

[133] Fix | Delete

'nonce' => wp_create_nonce( 'wpforms_payments_overview_nonce' ),

[134] Fix | Delete

'date_format' => sanitize_text_field( Datepicker::get_wp_date_format_for_momentjs() ),

[135] Fix | Delete

'delimiter' => Datepicker::TIMESPAN_DELIMITER,

[136] Fix | Delete

'report' => Chart::ACTIVE_REPORT,

[137] Fix | Delete

'currency' => sanitize_text_field( wpforms_get_currency() ),

[138] Fix | Delete

'decimals' => absint( wpforms_get_currency_decimals( wpforms_get_currency() ) ),

[139] Fix | Delete

'i18n' => [

[140] Fix | Delete

'label' => esc_html__( 'Payments', 'wpforms-lite' ),

[141] Fix | Delete

'delete_button' => esc_html__( 'Delete', 'wpforms-lite' ),

[142] Fix | Delete

'subscription_delete_confirm' => $this->get_subscription_delete_confirmation_message(),

[143] Fix | Delete

'no_dataset' => [

[144] Fix | Delete

'total_payments' => esc_html__( 'No payments for selected period', 'wpforms-lite' ),

[145] Fix | Delete

'total_sales' => esc_html__( 'No sales for selected period', 'wpforms-lite' ),

[146] Fix | Delete

'total_refunded' => esc_html__( 'No refunds for selected period', 'wpforms-lite' ),

[147] Fix | Delete

'total_subscription' => esc_html__( 'No new subscriptions for selected period', 'wpforms-lite' ),

[148] Fix | Delete

'total_renewal_subscription' => esc_html__( 'No subscription renewals for the selected period', 'wpforms-lite' ),

[149] Fix | Delete

'total_coupons' => esc_html__( 'No coupons applied during the selected period', 'wpforms-lite' ),

[150] Fix | Delete

],

[151] Fix | Delete

],

[152] Fix | Delete

'page_uri' => $this->get_current_uri(),

[153] Fix | Delete

];

[154] Fix | Delete

[155] Fix | Delete

wp_localize_script(

[156] Fix | Delete

'wpforms-admin-payments-overview', // Script handle the data will be attached to.

[157] Fix | Delete

'wpforms_admin_payments_overview', // Name for the JavaScript object.

[158] Fix | Delete

$admin_l10n

[159] Fix | Delete

);

[160] Fix | Delete

}

[161] Fix | Delete

[162] Fix | Delete

/**

[163] Fix | Delete

* Retrieve a Payment Overview URI.

[164] Fix | Delete

*

[165] Fix | Delete

* @since 1.8.2

[166] Fix | Delete

*

[167] Fix | Delete

* @return string

[168] Fix | Delete

*/

[169] Fix | Delete

private function get_current_uri() {

[170] Fix | Delete

[171] Fix | Delete

// phpcs:ignore WordPress.Security.NonceVerification.Recommended

[172] Fix | Delete

$query = $_GET;

[173] Fix | Delete

[174] Fix | Delete

unset( $query['mode'], $query['paged'] );

[175] Fix | Delete

[176] Fix | Delete

return add_query_arg( $query, self::get_url() );

[177] Fix | Delete

}

[178] Fix | Delete

[179] Fix | Delete

/**

[180] Fix | Delete

* Determine whether the current user has the capability to view the page.

[181] Fix | Delete

*

[182] Fix | Delete

* @since 1.8.2

[183] Fix | Delete

*

[184] Fix | Delete

* @return bool

[185] Fix | Delete

*/

[186] Fix | Delete

public function current_user_can() {

[187] Fix | Delete

[188] Fix | Delete

return wpforms_current_user_can();

[189] Fix | Delete

}

[190] Fix | Delete

[191] Fix | Delete

/**

[192] Fix | Delete

* Page heading.

[193] Fix | Delete

*

[194] Fix | Delete

* @since 1.8.2

[195] Fix | Delete

*/

[196] Fix | Delete

public function heading() {

[197] Fix | Delete

[198] Fix | Delete

Helpers::get_default_heading();

[199] Fix | Delete

}

[200] Fix | Delete

[201] Fix | Delete

/**

[202] Fix | Delete

* Page content.

[203] Fix | Delete

*

[204] Fix | Delete

* @since 1.8.2

[205] Fix | Delete

*/

[206] Fix | Delete

public function display() {

[207] Fix | Delete

[208] Fix | Delete

// If there are no payments at all, display an empty state.

[209] Fix | Delete

if ( ! $this->has_any_mode_payment() ) {

[210] Fix | Delete

$this->display_empty_state();

[211] Fix | Delete

[212] Fix | Delete

return;

[213] Fix | Delete

}

[214] Fix | Delete

[215] Fix | Delete

// Display the page content, including the chart and the table.

[216] Fix | Delete

$this->chart->display();

[217] Fix | Delete

$this->table->display();

[218] Fix | Delete

}

[219] Fix | Delete

[220] Fix | Delete

/**

[221] Fix | Delete

* Get the URL of the page.

[222] Fix | Delete

*

[223] Fix | Delete

* @since 1.8.2

[224] Fix | Delete

*

[225] Fix | Delete

* @return string

[226] Fix | Delete

*/

[227] Fix | Delete

public static function get_url() {

[228] Fix | Delete

[229] Fix | Delete

static $url;

[230] Fix | Delete

[231] Fix | Delete

if ( $url ) {

[232] Fix | Delete

return $url;

[233] Fix | Delete

}

[234] Fix | Delete

[235] Fix | Delete

$url = add_query_arg(

[236] Fix | Delete

[

[237] Fix | Delete

'page' => Payments::SLUG,

[238] Fix | Delete

],

[239] Fix | Delete

admin_url( 'admin.php' )

[240] Fix | Delete

);

[241] Fix | Delete

[242] Fix | Delete

return $url;

[243] Fix | Delete

}

[244] Fix | Delete

[245] Fix | Delete

/**

[246] Fix | Delete

* Get payment mode.

[247] Fix | Delete

*

[248] Fix | Delete

* Use only for logged-in users. Returns mode from user meta data or from the $_GET['mode'] parameter.

[249] Fix | Delete

*

[250] Fix | Delete

* @since 1.8.2

[251] Fix | Delete

*

[252] Fix | Delete

* @return string

[253] Fix | Delete

*/

[254] Fix | Delete

public static function get_mode() {

[255] Fix | Delete

[256] Fix | Delete

static $mode;

[257] Fix | Delete

[258] Fix | Delete

$default_mode = 'live';

[259] Fix | Delete

[260] Fix | Delete

if ( ! wpforms_is_admin_ajax() && ! wpforms_is_admin_page( 'payments' ) && ! wpforms_is_admin_page( 'entries' ) ) {

[261] Fix | Delete

return $default_mode;

[262] Fix | Delete

}

[263] Fix | Delete

[264] Fix | Delete

if ( $mode ) {

[265] Fix | Delete

return $mode;

[266] Fix | Delete

}

[267] Fix | Delete

[268] Fix | Delete

// phpcs:ignore WordPress.Security.NonceVerification.Recommended

[269] Fix | Delete

$mode = isset( $_GET['mode'] ) ? sanitize_key( $_GET['mode'] ) : '';

[270] Fix | Delete

$user_id = get_current_user_id();

[271] Fix | Delete

$meta_key = 'wpforms-payments-mode';

[272] Fix | Delete

[273] Fix | Delete

if ( ValueValidator::is_valid( $mode, 'mode' ) ) {

[274] Fix | Delete

update_user_meta( $user_id, $meta_key, $mode );

[275] Fix | Delete

[276] Fix | Delete

return $mode;

[277] Fix | Delete

}

[278] Fix | Delete

[279] Fix | Delete

$mode = get_user_meta( $user_id, $meta_key, true );

[280] Fix | Delete

[281] Fix | Delete

return ! empty( $mode ) ? $mode : $default_mode;

[282] Fix | Delete

}

[283] Fix | Delete

[284] Fix | Delete

/**

[285] Fix | Delete

* Display one of the empty states.

[286] Fix | Delete

*

[287] Fix | Delete

* @since 1.8.2

[288] Fix | Delete

*/

[289] Fix | Delete

private function display_empty_state() {

[290] Fix | Delete

[291] Fix | Delete

// If a payment gateway is configured, output no payments state.

[292] Fix | Delete

if ( $this->is_gateway_configured() ) {

[293] Fix | Delete

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

[294] Fix | Delete

echo wpforms_render(

[295] Fix | Delete

'admin/empty-states/payments/no-payments',

[296] Fix | Delete

[

[297] Fix | Delete

'cta_url' => add_query_arg(

[298] Fix | Delete

[

[299] Fix | Delete

'page' => 'wpforms-overview',

[300] Fix | Delete

],

[301] Fix | Delete

'admin.php'

[302] Fix | Delete

),

[303] Fix | Delete

],

[304] Fix | Delete

true

[305] Fix | Delete

);

[306] Fix | Delete

[307] Fix | Delete

return;

[308] Fix | Delete

}

[309] Fix | Delete

[310] Fix | Delete

// Otherwise, output get started state.

[311] Fix | Delete

$is_upgraded = StripeHelpers::is_allowed_license_type();

[312] Fix | Delete

$message = __( "First you need to set up a payment gateway. We've partnered with <strong>Stripe</strong> to bring easy payment forms to everyone.&nbsp;", 'wpforms-lite' );

[313] Fix | Delete

$message .= $is_upgraded

[314] Fix | Delete

? sprintf( /* translators: %s - WPForms Addons admin page URL. */

[315] Fix | Delete

__( 'Other payment gateways such as <strong>PayPal</strong> and <strong>Square</strong> can be installed from the <a href="%s">Addons screen</a>.', 'wpforms-lite' ),

[316] Fix | Delete

esc_url(

[317] Fix | Delete

add_query_arg(

[318] Fix | Delete

[

[319] Fix | Delete

'page' => 'wpforms-addons',

[320] Fix | Delete

],

[321] Fix | Delete

admin_url( 'admin.php' )

[322] Fix | Delete

)

[323] Fix | Delete

)

[324] Fix | Delete

)

[325] Fix | Delete

: sprintf( /* translators: %s - WPForms.com Upgrade page URL. */

[326] Fix | Delete

__( "If you'd like to use another payment gateway, please consider <a href='%s'>upgrading to WPForms Pro</a>.", 'wpforms-lite' ),

[327] Fix | Delete

esc_url( wpforms_admin_upgrade_link( 'Payments Dashboard', 'Splash - Upgrade to Pro Text' ) )

[328] Fix | Delete

);

[329] Fix | Delete

[330] Fix | Delete

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

[331] Fix | Delete

echo wpforms_render(

[332] Fix | Delete

'admin/empty-states/payments/get-started',

[333] Fix | Delete

[

[334] Fix | Delete

'message' => $message,

[335] Fix | Delete

'version' => $is_upgraded ? 'pro' : 'lite',

[336] Fix | Delete

'cta_url' => add_query_arg(

[337] Fix | Delete

[

[338] Fix | Delete

'page' => 'wpforms-settings',

[339] Fix | Delete

'view' => 'payments',

[340] Fix | Delete

],

[341] Fix | Delete

admin_url( 'admin.php' )

[342] Fix | Delete

),

[343] Fix | Delete

],

[344] Fix | Delete

true

[345] Fix | Delete

);

[346] Fix | Delete

}

[347] Fix | Delete

[348] Fix | Delete

/**

[349] Fix | Delete

* Determine whether a payment gateway is configured.

[350] Fix | Delete

*

[351] Fix | Delete

* @since 1.8.2

[352] Fix | Delete

*

[353] Fix | Delete

* @return bool

[354] Fix | Delete

*/

[355] Fix | Delete

private function is_gateway_configured() {

[356] Fix | Delete

[357] Fix | Delete

/**

[358] Fix | Delete

* Allow to modify a status whether a payment gateway is configured.

[359] Fix | Delete

*

[360] Fix | Delete

* @since 1.8.2

[361] Fix | Delete

*

[362] Fix | Delete

* @param bool $is_configured True if a payment gateway is configured.

[363] Fix | Delete

*/

[364] Fix | Delete

return (bool) apply_filters( 'wpforms_admin_payments_views_overview_page_gateway_is_configured', StripeHelpers::has_stripe_keys() );

[365] Fix | Delete

}

[366] Fix | Delete

[367] Fix | Delete

/**

[368] Fix | Delete

* Determine whether there are payments of any modes.

[369] Fix | Delete

*

[370] Fix | Delete

* @since 1.8.2

[371] Fix | Delete

*

[372] Fix | Delete

* @return bool

[373] Fix | Delete

*/

[374] Fix | Delete

private function has_any_mode_payment() {

[375] Fix | Delete

[376] Fix | Delete

static $has_any_mode_payment;

[377] Fix | Delete

[378] Fix | Delete

if ( $has_any_mode_payment !== null ) {

[379] Fix | Delete

return $has_any_mode_payment;

[380] Fix | Delete

}

[381] Fix | Delete

[382] Fix | Delete

$has_any_mode_payment = count(

[383] Fix | Delete

wpforms()->get( 'payment' )->get_payments(

[384] Fix | Delete

[

[385] Fix | Delete

'mode' => 'any',

[386] Fix | Delete

'number' => 1,

[387] Fix | Delete

]

[388] Fix | Delete

)

[389] Fix | Delete

) > 0;

[390] Fix | Delete

[391] Fix | Delete

// Check on trashed payments.

[392] Fix | Delete

if ( ! $has_any_mode_payment ) {

[393] Fix | Delete

$has_any_mode_payment = count(

[394] Fix | Delete

wpforms()->get( 'payment' )->get_payments(

[395] Fix | Delete

[

[396] Fix | Delete

'mode' => 'any',

[397] Fix | Delete

'number' => 1,

[398] Fix | Delete

'is_published' => 0,

[399] Fix | Delete

]

[400] Fix | Delete

)

[401] Fix | Delete

) > 0;

[402] Fix | Delete

}

[403] Fix | Delete

[404] Fix | Delete

return $has_any_mode_payment;

[405] Fix | Delete

}

[406] Fix | Delete

[407] Fix | Delete

/**

[408] Fix | Delete

* To avoid recursively, remove the previous variables from the REQUEST_URI.

[409] Fix | Delete

*

[410] Fix | Delete

* @since 1.8.2

[411] Fix | Delete

*/

[412] Fix | Delete

private function clean_request_uri() {

[413] Fix | Delete

[414] Fix | Delete

if ( isset( $_SERVER['REQUEST_URI'] ) ) {

[415] Fix | Delete

// phpcs:disable WordPress.Security.ValidatedSanitizedInput.InputNotSanitized, WordPress.Security.NonceVerification.Recommended

[416] Fix | Delete

$_SERVER['REQUEST_URI'] = remove_query_arg( [ '_wpnonce', '_wp_http_referer', 'action', 'action2', 'payment_id' ], wp_unslash( $_SERVER['REQUEST_URI'] ) );

[417] Fix | Delete

[418] Fix | Delete

if ( empty( $_GET['s'] ) ) {

[419] Fix | Delete

$_SERVER['REQUEST_URI'] = remove_query_arg( [ 'search_where', 'search_mode', 's' ], wp_unslash( $_SERVER['REQUEST_URI'] ) );

[420] Fix | Delete

}

[421] Fix | Delete

// phpcs:enable WordPress.Security.ValidatedSanitizedInput.InputNotSanitized, WordPress.Security.NonceVerification.Recommended

[422] Fix | Delete

}

[423] Fix | Delete

}

[424] Fix | Delete

[425] Fix | Delete

/**

[426] Fix | Delete

* Get the subscription delete confirmation message.

[427] Fix | Delete

* The returned message is used in the JavaScript file and shown in a "Heads up!" modal.

[428] Fix | Delete

*

[429] Fix | Delete

* @since 1.8.4

[430] Fix | Delete

*

[431] Fix | Delete

* @return string

[432] Fix | Delete

*/

[433] Fix | Delete

private function get_subscription_delete_confirmation_message() {

[434] Fix | Delete

[435] Fix | Delete

$help_link = wpforms_utm_link(

[436] Fix | Delete

'https://wpforms.com/docs/viewing-and-managing-payments/#deleting-parent-subscription',

[437] Fix | Delete

'Delete Payment',

[438] Fix | Delete

'Learn More'

[439] Fix | Delete

);

[440] Fix | Delete

[441] Fix | Delete

return sprintf(

[442] Fix | Delete

wp_kses( /* translators: WPForms.com docs page URL. */

[443] Fix | Delete

__( 'Deleting one or more selected payments may prevent processing of future subscription renewals. Payment filtering may also be affected. <a href="%1$s" rel="noopener" target="_blank">Learn More</a>', 'wpforms-lite' ),

[444] Fix | Delete

[

[445] Fix | Delete

'a' => [

[446] Fix | Delete

'href' => [],

[447] Fix | Delete

'rel' => [],

[448] Fix | Delete

'target' => [],

[449] Fix | Delete

],

[450] Fix | Delete

]

[451] Fix | Delete

),

[452] Fix | Delete

esc_url( $help_link )

[453] Fix | Delete

);

[454] Fix | Delete

}

[455] Fix | Delete

}

[456] Fix | Delete

[457] Fix | Delete