Edit File by line

<?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

[5] Fix | Delete

/**

[6] Fix | Delete

* Payment Overview Chart class.

[7] Fix | Delete

[8] Fix | Delete

* @since 1.8.2

[9] Fix | Delete

[10] Fix | Delete

class Chart {

[11] Fix | Delete

[12] Fix | Delete

/**

[13] Fix | Delete

* Default payments summary report stat card.

[14] Fix | Delete

[15] Fix | Delete

* @since 1.8.2

[16] Fix | Delete

[17] Fix | Delete

const ACTIVE_REPORT = 'total_payments';

[18] Fix | Delete

[19] Fix | Delete

/**

[20] Fix | Delete

* Whether the chart should be displayed.

[21] Fix | Delete

[22] Fix | Delete

* @since 1.8.2

[23] Fix | Delete

[24] Fix | Delete

* @return bool

[25] Fix | Delete

[26] Fix | Delete

private function allow_load() {

[27] Fix | Delete

[28] Fix | Delete

$disallowed_views = [

[29] Fix | Delete

's', // Search.

[30] Fix | Delete

'type', // Payment type.

[31] Fix | Delete

'status', // Payment status.

[32] Fix | Delete

'gateway', // Payment gateway.

[33] Fix | Delete

'subscription_status', // Subscription status.

[34] Fix | Delete

'form_id', // Form ID.

[35] Fix | Delete

'coupon_id', // Coupon ID.

[36] Fix | Delete

];

[37] Fix | Delete

[38] Fix | Delete

// Avoid displaying the chart when filtering of payment records is performed.

[39] Fix | Delete

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

[40] Fix | Delete

return array_reduce(

[41] Fix | Delete

array_keys( $_GET ),

[42] Fix | Delete

static function ( $carry, $key ) use ( $disallowed_views ) {

[43] Fix | Delete

[44] Fix | Delete

if ( ! $carry ) {

[45] Fix | Delete

return false;

[46] Fix | Delete

}

[47] Fix | Delete

[48] Fix | Delete

return ! in_array( $key, $disallowed_views, true ) || empty( $_GET[ $key ] );

[49] Fix | Delete

[50] Fix | Delete

true

[51] Fix | Delete

);

[52] Fix | Delete

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

[53] Fix | Delete

}

[54] Fix | Delete

[55] Fix | Delete

/**

[56] Fix | Delete

* Display the chart.

[57] Fix | Delete

[58] Fix | Delete

* @since 1.8.2

[59] Fix | Delete

[60] Fix | Delete

public function display() {

[61] Fix | Delete

[62] Fix | Delete

// If the chart should not be displayed, leave early.

[63] Fix | Delete

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

[64] Fix | Delete

return;

[65] Fix | Delete

}

[66] Fix | Delete

[67] Fix | Delete

// Output HTML elements on the page.

[68] Fix | Delete

$this->output_top_bar();

[69] Fix | Delete

$this->output_test_mode_banner();

[70] Fix | Delete

$this->output_chart();

[71] Fix | Delete

}

[72] Fix | Delete

[73] Fix | Delete

/**

[74] Fix | Delete

* Handles output of the overview page top-bar.

[75] Fix | Delete

[76] Fix | Delete

* Includes:

[77] Fix | Delete

* 1. Heading.

[78] Fix | Delete

* 2. Datepicker filter.

[79] Fix | Delete

* 3. Chart theme customization settings.

[80] Fix | Delete

[81] Fix | Delete

* @since 1.8.2

[82] Fix | Delete

[83] Fix | Delete

private function output_top_bar() {

[84] Fix | Delete

[85] Fix | Delete

list( $choices, $chosen_filter, $value ) = Datepicker::process_datepicker_choices();

[86] Fix | Delete

[87] Fix | Delete

[88] Fix | Delete

[89] Fix | Delete

[90] Fix | Delete

[91] Fix | Delete

</div>

[92] Fix | Delete

[93] Fix | Delete

[94] Fix | Delete

<?php

[95] Fix | Delete

// Output "Mode Toggle" template.

[96] Fix | Delete

( new ModeToggle() )->display();

[97] Fix | Delete

[98] Fix | Delete

// Output "Datepicker" form template.

[99] Fix | Delete

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

[100] Fix | Delete

echo wpforms_render(

[101] Fix | Delete

'admin/components/datepicker',

[102] Fix | Delete

[

[103] Fix | Delete

'id' => 'payments',

[104] Fix | Delete

'action' => Page::get_url(),

[105] Fix | Delete

'chosen_filter' => $chosen_filter,

[106] Fix | Delete

'choices' => $choices,

[107] Fix | Delete

'value' => $value,

[108] Fix | Delete

'hidden_fields' => [ 'statcard' ],

[109] Fix | Delete

[110] Fix | Delete

true

[111] Fix | Delete

);

[112] Fix | Delete

[113] Fix | Delete

[114] Fix | Delete

<?php

[115] Fix | Delete

// Output "Settings" template.

[116] Fix | Delete

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

[117] Fix | Delete

echo wpforms_render(

[118] Fix | Delete

'admin/dashboard/widget/settings',

[119] Fix | Delete

array_merge( $this->get_chart_settings(), [ 'enabled' => true ] ),

[120] Fix | Delete

true

[121] Fix | Delete

);

[122] Fix | Delete

[123] Fix | Delete

</div>

[124] Fix | Delete

</div>

[125] Fix | Delete

</div>

[126] Fix | Delete

<?php

[127] Fix | Delete

}

[128] Fix | Delete

[129] Fix | Delete

/**

[130] Fix | Delete

* Display a banner when viewing test data.

[131] Fix | Delete

[132] Fix | Delete

* @since 1.8.2

[133] Fix | Delete

[134] Fix | Delete

* @return void

[135] Fix | Delete

[136] Fix | Delete

private function output_test_mode_banner() {

[137] Fix | Delete

[138] Fix | Delete

// Determine if we are viewing test data.

[139] Fix | Delete

if ( Page::get_mode() !== 'test' ) {

[140] Fix | Delete

return;

[141] Fix | Delete

}

[142] Fix | Delete

[143] Fix | Delete

[144] Fix | Delete

<p>

[145] Fix | Delete

<?php esc_html_e( 'Viewing Test Data', 'wpforms-lite' ); ?>

[146] Fix | Delete

</p>

[147] Fix | Delete

</div>

[148] Fix | Delete

<?php

[149] Fix | Delete

}

[150] Fix | Delete

[151] Fix | Delete

/**

[152] Fix | Delete

* Handles output of the overview page chart (graph).

[153] Fix | Delete

[154] Fix | Delete

* @since 1.8.2

[155] Fix | Delete

[156] Fix | Delete

private function output_chart() {

[157] Fix | Delete

[158] Fix | Delete

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

[159] Fix | Delete

echo '<div class="wpforms-payments-overview-stats">';

[160] Fix | Delete

[161] Fix | Delete

echo wpforms_render(

[162] Fix | Delete

'admin/components/chart',

[163] Fix | Delete

[

[164] Fix | Delete

'id' => 'payments',

[165] Fix | Delete

'notice' => [

[166] Fix | Delete

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

[167] Fix | Delete

'description' => esc_html__( 'Please select a different period or check back later.', 'wpforms-lite' ),

[168] Fix | Delete

[169] Fix | Delete

[170] Fix | Delete

true

[171] Fix | Delete

);

[172] Fix | Delete

[173] Fix | Delete

echo wpforms_render(

[174] Fix | Delete

'admin/payments/reports',

[175] Fix | Delete

$this->get_reports_template_args(),

[176] Fix | Delete

true

[177] Fix | Delete

);

[178] Fix | Delete

[179] Fix | Delete

echo '</div>';

[180] Fix | Delete

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

[181] Fix | Delete

}

[182] Fix | Delete

[183] Fix | Delete

/**

[184] Fix | Delete

* Get the user’s preferences for displaying of the graph.

[185] Fix | Delete

[186] Fix | Delete

* @since 1.8.2

[187] Fix | Delete

[188] Fix | Delete

* @return array

[189] Fix | Delete

[190] Fix | Delete

public function get_chart_settings() {

[191] Fix | Delete

[192] Fix | Delete

$graph_style = get_user_meta( get_current_user_id(), 'wpforms_dash_widget_graph_style', true );

[193] Fix | Delete

[194] Fix | Delete

return [

[195] Fix | Delete

'graph_style' => $graph_style ? absint( $graph_style ) : 2, // Line.

[196] Fix | Delete

];

[197] Fix | Delete

}

[198] Fix | Delete

[199] Fix | Delete

/**

[200] Fix | Delete

* Get the stat cards for the payment summary report.

[201] Fix | Delete

[202] Fix | Delete

* Note that "funnel" is used to filter the payments, and can take the following values:

[203] Fix | Delete

* - in: payments that match the given criteria.

[204] Fix | Delete

* - not_in: payments that do not match the given criteria.

[205] Fix | Delete

[206] Fix | Delete

* @since 1.8.2

[207] Fix | Delete

[208] Fix | Delete

* @return array

[209] Fix | Delete

[210] Fix | Delete

public static function stat_cards() {

[211] Fix | Delete

[212] Fix | Delete

return [

[213] Fix | Delete

'total_payments' => [

[214] Fix | Delete

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

[215] Fix | Delete

'button_classes' => [

[216] Fix | Delete

'total-payments',

[217] Fix | Delete

[218] Fix | Delete

[219] Fix | Delete

'total_sales' => [

[220] Fix | Delete

'label' => esc_html__( 'Total Sales', 'wpforms-lite' ),

[221] Fix | Delete

'funnel' => [

[222] Fix | Delete

'not_in' => [

[223] Fix | Delete

'status' => [ 'failed' ],

[224] Fix | Delete

'subscription_status' => [ 'failed' ],

[225] Fix | Delete

[226] Fix | Delete

[227] Fix | Delete

'button_classes' => [

[228] Fix | Delete

'total-sales',

[229] Fix | Delete

'is-amount',

[230] Fix | Delete

[231] Fix | Delete

[232] Fix | Delete

'total_refunded' => [

[233] Fix | Delete

'label' => esc_html__( 'Total Refunded', 'wpforms-lite' ),

[234] Fix | Delete

'has_count' => true,

[235] Fix | Delete

'meta_key' => 'refunded_amount', // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key

[236] Fix | Delete

'button_classes' => [

[237] Fix | Delete

'total-refunded',

[238] Fix | Delete

'is-amount',

[239] Fix | Delete

[240] Fix | Delete

[241] Fix | Delete

'total_subscription' => [

[242] Fix | Delete

'label' => esc_html__( 'New Subscriptions', 'wpforms-lite' ),

[243] Fix | Delete

'condition' => wpforms()->get( 'payment_queries' )->has_subscription(),

[244] Fix | Delete

'has_count' => true,

[245] Fix | Delete

'funnel' => [

[246] Fix | Delete

'in' => [

[247] Fix | Delete

'type' => [ 'subscription' ],

[248] Fix | Delete

[249] Fix | Delete

'not_in' => [

[250] Fix | Delete

'subscription_status' => [ 'failed' ],

[251] Fix | Delete

[252] Fix | Delete

[253] Fix | Delete

'button_classes' => [

[254] Fix | Delete

'total-subscription',

[255] Fix | Delete

'is-amount',

[256] Fix | Delete

[257] Fix | Delete

[258] Fix | Delete

'total_renewal_subscription' => [

[259] Fix | Delete

'label' => esc_html__( 'Subscription Renewals', 'wpforms-lite' ),

[260] Fix | Delete

'condition' => wpforms()->get( 'payment_queries' )->has_subscription(),

[261] Fix | Delete

'has_count' => true,

[262] Fix | Delete

'funnel' => [

[263] Fix | Delete

'in' => [

[264] Fix | Delete

'type' => [ 'renewal' ],

[265] Fix | Delete

[266] Fix | Delete

'not_in' => [

[267] Fix | Delete

'subscription_status' => [ 'failed' ],

[268] Fix | Delete

[269] Fix | Delete

[270] Fix | Delete

'button_classes' => [

[271] Fix | Delete

'total-renewal-subscription',

[272] Fix | Delete

'is-amount',

[273] Fix | Delete

[274] Fix | Delete

[275] Fix | Delete

'total_coupons' => [

[276] Fix | Delete

'label' => esc_html__( 'Coupons Redeemed', 'wpforms-lite' ),

[277] Fix | Delete

'meta_key' => 'coupon_id', // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key

[278] Fix | Delete

'funnel' => [

[279] Fix | Delete

'not_in' => [

[280] Fix | Delete

'status' => [ 'failed' ],

[281] Fix | Delete

'subscription_status' => [ 'failed' ],

[282] Fix | Delete

[283] Fix | Delete

[284] Fix | Delete

'button_classes' => [

[285] Fix | Delete

'total-coupons',

[286] Fix | Delete

[287] Fix | Delete

[288] Fix | Delete

];

[289] Fix | Delete

}

[290] Fix | Delete

[291] Fix | Delete

/**

[292] Fix | Delete

* Retrieves the arguments for the reports template.

[293] Fix | Delete

[294] Fix | Delete

* @since 1.8.8

[295] Fix | Delete

[296] Fix | Delete

* @return array

[297] Fix | Delete

[298] Fix | Delete

private function get_reports_template_args(): array {

[299] Fix | Delete

[300] Fix | Delete

// Retrieve the stat cards.

[301] Fix | Delete

$stat_cards = self::stat_cards();

[302] Fix | Delete

[303] Fix | Delete

// Set default arguments.

[304] Fix | Delete

$args = [

[305] Fix | Delete

'current' => self::ACTIVE_REPORT,

[306] Fix | Delete

'statcards' => $stat_cards,

[307] Fix | Delete

];

[308] Fix | Delete

[309] Fix | Delete

// Check if the statcard is set in the URL.

[310] Fix | Delete

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

[311] Fix | Delete

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

[312] Fix | Delete

return $args;

[313] Fix | Delete

}

[314] Fix | Delete

[315] Fix | Delete

// Sanitize and retrieve the tab value from the URL.

[316] Fix | Delete

$active_report = sanitize_text_field( wp_unslash( $_GET['statcard'] ) );

[317] Fix | Delete

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

[318] Fix | Delete

[319] Fix | Delete

// If the statcard is not valid, return default arguments.

[320] Fix | Delete

if ( ! isset( $stat_cards[ $active_report ] ) ) {

[321] Fix | Delete

return $args;

[322] Fix | Delete

}

[323] Fix | Delete

[324] Fix | Delete

// If the statcard is not going to be displayed, return default arguments.

[325] Fix | Delete

if ( isset( $stat_cards[ $active_report ]['condition'] ) && ! $stat_cards[ $active_report ]['condition'] ) {

[326] Fix | Delete

return $args;

[327] Fix | Delete

}

[328] Fix | Delete

[329] Fix | Delete

// Set the current statcard.

[330] Fix | Delete

$args['current'] = $active_report;

[331] Fix | Delete

[332] Fix | Delete

return $args;

[333] Fix | Delete

}

[334] Fix | Delete

}

[335] Fix | Delete

[336] Fix | Delete