<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* REST API Payment Gateway Suggestions Controller

[2] Fix | Delete

*

[3] Fix | Delete

* Handles requests to install and activate dependent plugins.

[4] Fix | Delete

*/

[5] Fix | Delete

[6] Fix | Delete

namespace Automattic\WooCommerce\Admin\API;

[7] Fix | Delete

[8] Fix | Delete

use Automattic\WooCommerce\Admin\Features\PaymentGatewaySuggestions\DefaultPaymentGateways;

[9] Fix | Delete

use Automattic\WooCommerce\Admin\Features\PaymentGatewaySuggestions\Init as Suggestions;

[10] Fix | Delete

[11] Fix | Delete

defined( 'ABSPATH' ) || exit;

[12] Fix | Delete

[13] Fix | Delete

/**

[14] Fix | Delete

* PaymentGatewaySuggetsions Controller.

[15] Fix | Delete

*

[16] Fix | Delete

* @internal

[17] Fix | Delete

* @extends WC_REST_Data_Controller

[18] Fix | Delete

*/

[19] Fix | Delete

class PaymentGatewaySuggestions extends \WC_REST_Data_Controller {

[20] Fix | Delete

/**

[21] Fix | Delete

* Endpoint namespace.

[22] Fix | Delete

*

[23] Fix | Delete

* @var string

[24] Fix | Delete

*/

[25] Fix | Delete

protected $namespace = 'wc-admin';

[26] Fix | Delete

[27] Fix | Delete

/**

[28] Fix | Delete

* Route base.

[29] Fix | Delete

*

[30] Fix | Delete

* @var string

[31] Fix | Delete

*/

[32] Fix | Delete

protected $rest_base = 'payment-gateway-suggestions';

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* Register routes.

[36] Fix | Delete

*/

[37] Fix | Delete

public function register_routes() {

[38] Fix | Delete

[39] Fix | Delete

register_rest_route(

[40] Fix | Delete

$this->namespace,

[41] Fix | Delete

'/' . $this->rest_base,

[42] Fix | Delete

array(

[43] Fix | Delete

array(

[44] Fix | Delete

'methods' => \WP_REST_Server::READABLE,

[45] Fix | Delete

'callback' => array( $this, 'get_suggestions' ),

[46] Fix | Delete

'permission_callback' => array( $this, 'user_can_manage_woocommerce' ),

[47] Fix | Delete

'args' => array(

[48] Fix | Delete

'force_default_suggestions' => array(

[49] Fix | Delete

'type' => 'boolean',

[50] Fix | Delete

'description' => __( 'Return the default payment suggestions when woocommerce_show_marketplace_suggestions and woocommerce_setting_payments_recommendations_hidden options are set to no', 'woocommerce' ),

[51] Fix | Delete

),

[52] Fix | Delete

),

[53] Fix | Delete

),

[54] Fix | Delete

'schema' => array( $this, 'get_item_schema' ),

[55] Fix | Delete

)

[56] Fix | Delete

);

[57] Fix | Delete

[58] Fix | Delete

register_rest_route(

[59] Fix | Delete

$this->namespace,

[60] Fix | Delete

'/' . $this->rest_base . '/dismiss',

[61] Fix | Delete

array(

[62] Fix | Delete

array(

[63] Fix | Delete

'methods' => \WP_REST_Server::CREATABLE,

[64] Fix | Delete

'callback' => array( $this, 'dismiss_payment_gateway_suggestion' ),

[65] Fix | Delete

'permission_callback' => array( $this, 'get_permission_check' ),

[66] Fix | Delete

),

[67] Fix | Delete

'schema' => array( $this, 'get_item_schema' ),

[68] Fix | Delete

)

[69] Fix | Delete

);

[70] Fix | Delete

[71] Fix | Delete

}

[72] Fix | Delete

[73] Fix | Delete

/**

[74] Fix | Delete

* Check if a given request has access to manage plugins.

[75] Fix | Delete

*

[76] Fix | Delete

* @param WP_REST_Request $request Full details about the request.

[77] Fix | Delete

* @return WP_Error|boolean

[78] Fix | Delete

*/

[79] Fix | Delete

public function get_permission_check( $request ) {

[80] Fix | Delete

if ( ! current_user_can( 'install_plugins' ) ) {

[81] Fix | Delete

return new \WP_Error( 'woocommerce_rest_cannot_update', __( 'Sorry, you cannot manage plugins.', 'woocommerce' ), array( 'status' => rest_authorization_required_code() ) );

[82] Fix | Delete

}

[83] Fix | Delete

return true;

[84] Fix | Delete

}

[85] Fix | Delete

[86] Fix | Delete

/**

[87] Fix | Delete

* Check if a given request has access to manage woocommerce.

[88] Fix | Delete

*

[89] Fix | Delete

* @return \WP_Error|boolean

[90] Fix | Delete

*/

[91] Fix | Delete

public function user_can_manage_woocommerce() {

[92] Fix | Delete

if ( current_user_can( 'manage_woocommerce' ) ) {

[93] Fix | Delete

return true;

[94] Fix | Delete

}

[95] Fix | Delete

[96] Fix | Delete

return new \WP_Error( 'woocommerce_rest_invalid_user', __( 'You are not allowed to make this request.', 'woocommerce' ), array( 'status' => rest_authorization_required_code() ) );

[97] Fix | Delete

}

[98] Fix | Delete

[99] Fix | Delete

/**

[100] Fix | Delete

* Return suggested payment gateways.

[101] Fix | Delete

*

[102] Fix | Delete

* @param WP_REST_Request $request Full details about the request.

[103] Fix | Delete

* @return \WP_Error|\WP_HTTP_Response|\WP_REST_Response

[104] Fix | Delete

*/

[105] Fix | Delete

public function get_suggestions( $request ) {

[106] Fix | Delete

[107] Fix | Delete

$should_display = Suggestions::should_display();

[108] Fix | Delete

$force_default = $request->get_param( 'force_default_suggestions' );

[109] Fix | Delete

[110] Fix | Delete

if ( $should_display ) {

[111] Fix | Delete

return Suggestions::get_suggestions();

[112] Fix | Delete

} elseif ( false === $should_display && true === $force_default ) {

[113] Fix | Delete

return rest_ensure_response( Suggestions::get_suggestions( DefaultPaymentGateways::get_all() ) );

[114] Fix | Delete

}

[115] Fix | Delete

[116] Fix | Delete

return rest_ensure_response( array() );

[117] Fix | Delete

}

[118] Fix | Delete

[119] Fix | Delete

/**

[120] Fix | Delete

* Dismisses suggested payment gateways.

[121] Fix | Delete

*

[122] Fix | Delete

* @return \WP_Error|\WP_HTTP_Response|\WP_REST_Response

[123] Fix | Delete

*/

[124] Fix | Delete

public function dismiss_payment_gateway_suggestion() {

[125] Fix | Delete

$success = Suggestions::dismiss();

[126] Fix | Delete

return rest_ensure_response( $success );

[127] Fix | Delete

}

[128] Fix | Delete

[129] Fix | Delete

/**

[130] Fix | Delete

* Get the schema, conforming to JSON Schema.

[131] Fix | Delete

*

[132] Fix | Delete

* @return array

[133] Fix | Delete

*/

[134] Fix | Delete

public function get_item_schema() {

[135] Fix | Delete

$schema = array(

[136] Fix | Delete

'$schema' => 'http://json-schema.org/draft-04/schema#',

[137] Fix | Delete

'title' => 'payment-gateway-suggestions',

[138] Fix | Delete

'type' => 'object',

[139] Fix | Delete

'properties' => array(

[140] Fix | Delete

'content' => array(

[141] Fix | Delete

'description' => __( 'Suggestion description.', 'woocommerce' ),

[142] Fix | Delete

'type' => 'string',

[143] Fix | Delete

'context' => array( 'view', 'edit' ),

[144] Fix | Delete

'readonly' => true,

[145] Fix | Delete

),

[146] Fix | Delete

'id' => array(

[147] Fix | Delete

'description' => __( 'Suggestion ID.', 'woocommerce' ),

[148] Fix | Delete

'type' => 'string',

[149] Fix | Delete

'context' => array( 'view', 'edit' ),

[150] Fix | Delete

'readonly' => true,

[151] Fix | Delete

),

[152] Fix | Delete

'image' => array(

[153] Fix | Delete

'description' => __( 'Gateway image.', 'woocommerce' ),

[154] Fix | Delete

'type' => 'string',

[155] Fix | Delete

'context' => array( 'view', 'edit' ),

[156] Fix | Delete

'readonly' => true,

[157] Fix | Delete

),

[158] Fix | Delete

'is_visible' => array(

[159] Fix | Delete

'description' => __( 'Suggestion visibility.', 'woocommerce' ),

[160] Fix | Delete

'type' => 'boolean',

[161] Fix | Delete

'context' => array( 'view', 'edit' ),

[162] Fix | Delete

'readonly' => true,

[163] Fix | Delete

),

[164] Fix | Delete

'plugins' => array(

[165] Fix | Delete

'description' => __( 'Array of plugin slugs.', 'woocommerce' ),

[166] Fix | Delete

'type' => 'array',

[167] Fix | Delete

'context' => array( 'view', 'edit' ),

[168] Fix | Delete

'readonly' => true,

[169] Fix | Delete

),

[170] Fix | Delete

'recommendation_priority' => array(

[171] Fix | Delete

'description' => __( 'Priority of recommendation.', 'woocommerce' ),

[172] Fix | Delete

'type' => 'integer',

[173] Fix | Delete

'context' => array( 'view', 'edit' ),

[174] Fix | Delete

'readonly' => true,

[175] Fix | Delete

),

[176] Fix | Delete

'title' => array(

[177] Fix | Delete

'description' => __( 'Gateway title.', 'woocommerce' ),

[178] Fix | Delete

'type' => 'string',

[179] Fix | Delete

'context' => array( 'view', 'edit' ),

[180] Fix | Delete

'readonly' => true,

[181] Fix | Delete

),

[182] Fix | Delete

'transaction_processors' => array(

[183] Fix | Delete

'description' => __( 'Array of transaction processors and their images.', 'woocommerce' ),

[184] Fix | Delete

'type' => 'object',

[185] Fix | Delete

'addtionalProperties' => array(

[186] Fix | Delete

'type' => 'string',

[187] Fix | Delete

'format' => 'uri',

[188] Fix | Delete

),

[189] Fix | Delete

'context' => array( 'view', 'edit' ),

[190] Fix | Delete

'readonly' => true,

[191] Fix | Delete

),

[192] Fix | Delete

),

[193] Fix | Delete

);

[194] Fix | Delete

[195] Fix | Delete

return $this->add_additional_fields_schema( $schema );

[196] Fix | Delete

}

[197] Fix | Delete

}

[198] Fix | Delete

[199] Fix | Delete