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\Payments\Payments;

[4] Fix | Delete

[5] Fix | Delete

/**

[6] Fix | Delete

* Generic functionality for interacting with the Coupons data.

[7] Fix | Delete

[8] Fix | Delete

* @since 1.8.4

[9] Fix | Delete

[10] Fix | Delete

class Coupon {

[11] Fix | Delete

[12] Fix | Delete

/**

[13] Fix | Delete

* Initialize the Coupon class.

[14] Fix | Delete

[15] Fix | Delete

* @since 1.8.4

[16] Fix | Delete

[17] Fix | Delete

public function init() {

[18] Fix | Delete

[19] Fix | Delete

$this->hooks();

[20] Fix | Delete

}

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* Attach hooks for filtering payments by coupon ID.

[24] Fix | Delete

[25] Fix | Delete

* @since 1.8.4

[26] Fix | Delete

[27] Fix | Delete

private function hooks() {

[28] Fix | Delete

[29] Fix | Delete

// This filter has been added for backward compatibility with older versions of the Coupons addon.

[30] Fix | Delete

add_filter( 'wpforms_admin_payments_views_overview_table_get_columns', [ $this, 'remove_legacy_coupon_column' ], 99, 1 );

[31] Fix | Delete

[32] Fix | Delete

// Bail early if the current page is not the Payments page

[33] Fix | Delete

// or if no coupon ID is given in the URL.

[34] Fix | Delete

if ( ! self::is_coupon() ) {

[35] Fix | Delete

return;

[36] Fix | Delete

}

[37] Fix | Delete

[38] Fix | Delete

add_filter( 'wpforms_db_payments_payment_get_payments_query_after_where', [ $this, 'filter_by_coupon_id' ], 10, 2 );

[39] Fix | Delete

add_filter( 'wpforms_db_payments_queries_count_all_query_after_where', [ $this, 'filter_by_coupon_id' ], 10, 2 );

[40] Fix | Delete

add_filter( 'wpforms_admin_payments_views_overview_filters_renewals_by_subscription_id_query_after_where', [ $this, 'filter_by_coupon_id' ], 10, 2 );

[41] Fix | Delete

add_filter( 'wpforms_admin_payments_views_overview_search_inner_join_query', [ $this, 'join_search_by_coupon_id' ], 10, 2 );

[42] Fix | Delete

}

[43] Fix | Delete

[44] Fix | Delete

/**

[45] Fix | Delete

* Remove the legacy coupon column from the Payments page.

[46] Fix | Delete

[47] Fix | Delete

* This function has been added for backward compatibility with older versions of the Coupons addon.

[48] Fix | Delete

* The legacy coupon column is no longer used by the Coupons addon.

[49] Fix | Delete

[50] Fix | Delete

* @since 1.8.4

[51] Fix | Delete

[52] Fix | Delete

* @param array $columns List of columns to be displayed on the Payments page.

[53] Fix | Delete

[54] Fix | Delete

* @return array

[55] Fix | Delete

[56] Fix | Delete

public function remove_legacy_coupon_column( $columns ) {

[57] Fix | Delete

[58] Fix | Delete

// Bail early if the Coupons addon is not active.

[59] Fix | Delete

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

[60] Fix | Delete

return $columns;

[61] Fix | Delete

}

[62] Fix | Delete

[63] Fix | Delete

// Remove the legacy coupon column from the Payments page.

[64] Fix | Delete

unset( $columns['coupon_id'] );

[65] Fix | Delete

[66] Fix | Delete

return $columns;

[67] Fix | Delete

}

[68] Fix | Delete

[69] Fix | Delete

/**

[70] Fix | Delete

* Retrieve payment entries based on a given coupon ID.

[71] Fix | Delete

[72] Fix | Delete

* @since 1.8.4

[73] Fix | Delete

[74] Fix | Delete

* @param string $after_where SQL query after the WHERE clause.

[75] Fix | Delete

* @param array $args Query arguments.

[76] Fix | Delete

[77] Fix | Delete

* @return string

[78] Fix | Delete

[79] Fix | Delete

public function filter_by_coupon_id( $after_where, $args ) {

[80] Fix | Delete

[81] Fix | Delete

// Check if the query is for the Payments Overview table.

[82] Fix | Delete

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

[83] Fix | Delete

if ( empty( $args['table_query'] ) ) {

[84] Fix | Delete

return $after_where;

[85] Fix | Delete

}

[86] Fix | Delete

[87] Fix | Delete

// Retrieve the coupon ID from the URL.

[88] Fix | Delete

// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotValidated, WordPress.Security.NonceVerification.Recommended

[89] Fix | Delete

$coupon_id = absint( $_GET['coupon_id'] );

[90] Fix | Delete

[91] Fix | Delete

global $wpdb;

[92] Fix | Delete

[93] Fix | Delete

$table_name = wpforms()->get( 'payment_meta' )->table_name;

[94] Fix | Delete

[95] Fix | Delete

// Prepare and return the modified SQL query.

[96] Fix | Delete

// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared

[97] Fix | Delete

return $wpdb->prepare(

[98] Fix | Delete

" AND EXISTS (

[99] Fix | Delete

SELECT 1 FROM {$table_name} AS pm_coupon

[100] Fix | Delete

WHERE pm_coupon.payment_id = p.id AND pm_coupon.meta_key = 'coupon_id' AND pm_coupon.meta_value = %d

[101] Fix | Delete

)",

[102] Fix | Delete

$coupon_id

[103] Fix | Delete

);

[104] Fix | Delete

}

[105] Fix | Delete

[106] Fix | Delete

/**

[107] Fix | Delete

* Further filter down the search results by coupon ID.

[108] Fix | Delete

[109] Fix | Delete

* @since 1.8.4

[110] Fix | Delete

[111] Fix | Delete

* @param string $query The SQL JOIN clause.

[112] Fix | Delete

* @param int $n The number of the JOIN clause.

[113] Fix | Delete

[114] Fix | Delete

* @return string

[115] Fix | Delete

[116] Fix | Delete

public function join_search_by_coupon_id( $query, $n ) {

[117] Fix | Delete

[118] Fix | Delete

// Retrieve the coupon ID from the URL.

[119] Fix | Delete

// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotValidated, WordPress.Security.NonceVerification.Recommended

[120] Fix | Delete

$coupon_id = absint( $_GET['coupon_id'] );

[121] Fix | Delete

[122] Fix | Delete

// Retrieve the global database instance.

[123] Fix | Delete

global $wpdb;

[124] Fix | Delete

[125] Fix | Delete

$n = absint( $n );

[126] Fix | Delete

$table_name = wpforms()->get( 'payment_meta' )->table_name;

[127] Fix | Delete

[128] Fix | Delete

// Build the derived query using a prepared statement.

[129] Fix | Delete

// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared

[130] Fix | Delete

$derived_query = $wpdb->prepare(

[131] Fix | Delete

"RIGHT JOIN (

[132] Fix | Delete

SELECT payment_id, meta_key, meta_value FROM {$table_name}

[133] Fix | Delete

WHERE meta_key = 'coupon_id' AND meta_value = %d

[134] Fix | Delete

) AS pm_coupon{$n} ON p.id = pm_coupon{$n}.payment_id",

[135] Fix | Delete

$coupon_id

[136] Fix | Delete

);

[137] Fix | Delete

// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared

[138] Fix | Delete

[139] Fix | Delete

// Combine the original query and the derived query.

[140] Fix | Delete

return "$query $derived_query";

[141] Fix | Delete

}

[142] Fix | Delete

[143] Fix | Delete

/**

[144] Fix | Delete

* Determine if the overview page is being viewed, and coupon ID is given.

[145] Fix | Delete

[146] Fix | Delete

* @since 1.8.4

[147] Fix | Delete

[148] Fix | Delete

* @return bool

[149] Fix | Delete

[150] Fix | Delete

public static function is_coupon() {

[151] Fix | Delete

[152] Fix | Delete

// Check if the URL parameters contain a coupon ID and if the current page is the Payments page.

[153] Fix | Delete

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

[154] Fix | Delete

return ! empty( $_GET['coupon_id'] ) && ! empty( $_GET['page'] ) && $_GET['page'] === Payments::SLUG;

[155] Fix | Delete

}

[156] Fix | Delete

[157] Fix | Delete

/**

[158] Fix | Delete

* Determine whether the addon is activated.

[159] Fix | Delete

[160] Fix | Delete

* @since 1.8.4

[161] Fix | Delete

[162] Fix | Delete

* @return bool

[163] Fix | Delete

[164] Fix | Delete

private function is_addon_active() {

[165] Fix | Delete

[166] Fix | Delete

return function_exists( 'wpforms_coupons' );

[167] Fix | Delete

}

[168] Fix | Delete

}

[169] Fix | Delete

[170] Fix | Delete