<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Admin\Payments\Views\Overview;

[2] Fix | Delete

[3] Fix | Delete

use WPForms\Admin\Notice;

[4] Fix | Delete

[5] Fix | Delete

/**

[6] Fix | Delete

* Bulk actions on the Payments Overview page.

[7] Fix | Delete

*

[8] Fix | Delete

* @since 1.8.2

[9] Fix | Delete

*/

[10] Fix | Delete

class BulkActions {

[11] Fix | Delete

[12] Fix | Delete

/**

[13] Fix | Delete

* Allowed actions.

[14] Fix | Delete

*

[15] Fix | Delete

* @since 1.8.2

[16] Fix | Delete

*

[17] Fix | Delete

* @const array

[18] Fix | Delete

*/

[19] Fix | Delete

const ALLOWED_ACTIONS = [

[20] Fix | Delete

'trash',

[21] Fix | Delete

'restore',

[22] Fix | Delete

'delete',

[23] Fix | Delete

];

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* Payments ids.

[27] Fix | Delete

*

[28] Fix | Delete

* @since 1.8.2

[29] Fix | Delete

*

[30] Fix | Delete

* @var array

[31] Fix | Delete

*/

[32] Fix | Delete

private $ids;

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* Current action.

[36] Fix | Delete

*

[37] Fix | Delete

* @since 1.8.2

[38] Fix | Delete

*

[39] Fix | Delete

* @var string

[40] Fix | Delete

*/

[41] Fix | Delete

private $action;

[42] Fix | Delete

[43] Fix | Delete

/**

[44] Fix | Delete

* Init.

[45] Fix | Delete

*

[46] Fix | Delete

* @since 1.8.2

[47] Fix | Delete

*/

[48] Fix | Delete

public function init() {

[49] Fix | Delete

[50] Fix | Delete

$this->process();

[51] Fix | Delete

}

[52] Fix | Delete

[53] Fix | Delete

/**

[54] Fix | Delete

* Get the current action selected from the bulk actions dropdown.

[55] Fix | Delete

*

[56] Fix | Delete

* @since 1.8.2

[57] Fix | Delete

*

[58] Fix | Delete

* @return string|false The action name or False if no action was selected

[59] Fix | Delete

*/

[60] Fix | Delete

private function current_action() {

[61] Fix | Delete

[62] Fix | Delete

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

[63] Fix | Delete

if ( isset( $_REQUEST['action'] ) && $_REQUEST['action'] !== '-1' ) {

[64] Fix | Delete

return sanitize_key( $_REQUEST['action'] );

[65] Fix | Delete

}

[66] Fix | Delete

[67] Fix | Delete

if ( isset( $_REQUEST['action2'] ) && $_REQUEST['action2'] !== '-1' ) {

[68] Fix | Delete

return sanitize_key( $_REQUEST['action2'] );

[69] Fix | Delete

}

[70] Fix | Delete

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

[71] Fix | Delete

[72] Fix | Delete

return false;

[73] Fix | Delete

}

[74] Fix | Delete

[75] Fix | Delete

/**

[76] Fix | Delete

* Process bulk actions.

[77] Fix | Delete

*

[78] Fix | Delete

* @since 1.8.2

[79] Fix | Delete

*/

[80] Fix | Delete

private function process() {

[81] Fix | Delete

[82] Fix | Delete

if ( empty( $_GET['_wpnonce'] ) || empty( $_GET['payment_id'] ) ) {

[83] Fix | Delete

return;

[84] Fix | Delete

}

[85] Fix | Delete

[86] Fix | Delete

if ( ! wp_verify_nonce( sanitize_key( $_GET['_wpnonce'] ), 'bulk-wpforms_page_wpforms-payments' ) ) {

[87] Fix | Delete

wp_die( esc_html__( 'Your session expired. Please reload the page.', 'wpforms-lite' ) );

[88] Fix | Delete

}

[89] Fix | Delete

[90] Fix | Delete

$this->ids = array_map( 'absint', (array) $_GET['payment_id'] );

[91] Fix | Delete

$this->action = $this->current_action();

[92] Fix | Delete

[93] Fix | Delete

if ( empty( $this->ids ) || ! $this->action || ! $this->is_allowed_action( $this->action ) ) {

[94] Fix | Delete

return;

[95] Fix | Delete

}

[96] Fix | Delete

[97] Fix | Delete

$this->process_action();

[98] Fix | Delete

}

[99] Fix | Delete

[100] Fix | Delete

/**

[101] Fix | Delete

* Process a bulk action.

[102] Fix | Delete

*

[103] Fix | Delete

* @since 1.8.2

[104] Fix | Delete

*/

[105] Fix | Delete

private function process_action() {

[106] Fix | Delete

[107] Fix | Delete

$method = "process_action_{$this->action}";

[108] Fix | Delete

[109] Fix | Delete

// Check that we have a method for this action.

[110] Fix | Delete

if ( ! method_exists( $this, $method ) ) {

[111] Fix | Delete

return;

[112] Fix | Delete

}

[113] Fix | Delete

[114] Fix | Delete

$processed = 0;

[115] Fix | Delete

[116] Fix | Delete

foreach ( $this->ids as $id ) {

[117] Fix | Delete

$processed = $this->$method( $id ) ? $processed + 1 : $processed;

[118] Fix | Delete

}

[119] Fix | Delete

[120] Fix | Delete

if ( ! $processed ) {

[121] Fix | Delete

return;

[122] Fix | Delete

}

[123] Fix | Delete

[124] Fix | Delete

$this->display_bulk_action_message( $processed );

[125] Fix | Delete

}

[126] Fix | Delete

[127] Fix | Delete

/**

[128] Fix | Delete

* Trash the payment.

[129] Fix | Delete

*

[130] Fix | Delete

* @since 1.8.2

[131] Fix | Delete

*

[132] Fix | Delete

* @param int $id Payment ID to trash.

[133] Fix | Delete

*

[134] Fix | Delete

* @return bool

[135] Fix | Delete

*/

[136] Fix | Delete

private function process_action_trash( $id ) {

[137] Fix | Delete

[138] Fix | Delete

return wpforms()->get( 'payment' )->update( $id, [ 'is_published' => 0 ] );

[139] Fix | Delete

}

[140] Fix | Delete

[141] Fix | Delete

/**

[142] Fix | Delete

* Restore the payment.

[143] Fix | Delete

*

[144] Fix | Delete

* @since 1.8.2

[145] Fix | Delete

*

[146] Fix | Delete

* @param int $id Payment ID to restore from trash.

[147] Fix | Delete

*

[148] Fix | Delete

* @return bool

[149] Fix | Delete

*/

[150] Fix | Delete

private function process_action_restore( $id ) {

[151] Fix | Delete

[152] Fix | Delete

return wpforms()->get( 'payment' )->update( $id, [ 'is_published' => 1 ] );

[153] Fix | Delete

}

[154] Fix | Delete

[155] Fix | Delete

/**

[156] Fix | Delete

* Delete the payment.

[157] Fix | Delete

*

[158] Fix | Delete

* @since 1.8.2

[159] Fix | Delete

*

[160] Fix | Delete

* @param int $id Payment ID to delete.

[161] Fix | Delete

*

[162] Fix | Delete

* @return bool

[163] Fix | Delete

*/

[164] Fix | Delete

private function process_action_delete( $id ) {

[165] Fix | Delete

[166] Fix | Delete

return wpforms()->get( 'payment' )->delete( $id );

[167] Fix | Delete

}

[168] Fix | Delete

[169] Fix | Delete

/**

[170] Fix | Delete

* Display a bulk action message.

[171] Fix | Delete

*

[172] Fix | Delete

* @since 1.8.2

[173] Fix | Delete

*

[174] Fix | Delete

* @param int $count Count of processed payment IDs.

[175] Fix | Delete

*/

[176] Fix | Delete

private function display_bulk_action_message( $count ) {

[177] Fix | Delete

[178] Fix | Delete

switch ( $this->action ) {

[179] Fix | Delete

case 'delete':

[180] Fix | Delete

/* translators: %d - number of deleted payments. */

[181] Fix | Delete

$message = sprintf( _n( '%d payment was successfully permanently deleted.', '%d payments were successfully permanently deleted.', $count, 'wpforms-lite' ), number_format_i18n( $count ) );

[182] Fix | Delete

break;

[183] Fix | Delete

[184] Fix | Delete

case 'restore':

[185] Fix | Delete

/* translators: %d - number of restored payments. */

[186] Fix | Delete

$message = sprintf( _n( '%d payment was successfully restored.', '%d payments were successfully restored.', $count, 'wpforms-lite' ), number_format_i18n( $count ) );

[187] Fix | Delete

break;

[188] Fix | Delete

[189] Fix | Delete

case 'trash':

[190] Fix | Delete

/* translators: %d - number of trashed payments. */

[191] Fix | Delete

$message = sprintf( _n( '%d payment was successfully moved to the Trash.', '%d payments were successfully moved to the Trash.', $count, 'wpforms-lite' ), number_format_i18n( $count ) );

[192] Fix | Delete

break;

[193] Fix | Delete

[194] Fix | Delete

default:

[195] Fix | Delete

$message = '';

[196] Fix | Delete

}

[197] Fix | Delete

[198] Fix | Delete

if ( empty( $message ) ) {

[199] Fix | Delete

return;

[200] Fix | Delete

}

[201] Fix | Delete

[202] Fix | Delete

Notice::success( $message );

[203] Fix | Delete

}

[204] Fix | Delete

[205] Fix | Delete

/**

[206] Fix | Delete

* Determine whether the action is allowed.

[207] Fix | Delete

*

[208] Fix | Delete

* @since 1.8.2

[209] Fix | Delete

*

[210] Fix | Delete

* @param string $action Action name.

[211] Fix | Delete

*

[212] Fix | Delete

* @return bool

[213] Fix | Delete

*/

[214] Fix | Delete

private function is_allowed_action( $action ) {

[215] Fix | Delete

[216] Fix | Delete

return in_array( $action, self::ALLOWED_ACTIONS, true );

[217] Fix | Delete

}

[218] Fix | Delete

}

[219] Fix | Delete

[220] Fix | Delete