<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Handles requests for shipping partner suggestions.

[2] Fix | Delete

*/

[3] Fix | Delete

[4] Fix | Delete

namespace Automattic\WooCommerce\Admin\API;

[5] Fix | Delete

[6] Fix | Delete

use Automattic\WooCommerce\Admin\Features\ShippingPartnerSuggestions\DefaultShippingPartners;

[7] Fix | Delete

use Automattic\WooCommerce\Admin\Features\ShippingPartnerSuggestions\ShippingPartnerSuggestions as Suggestions;

[8] Fix | Delete

[9] Fix | Delete

defined( 'ABSPATH' ) || exit;

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* ShippingPartnerSuggestions Controller.

[13] Fix | Delete

*

[14] Fix | Delete

* @internal

[15] Fix | Delete

* @extends WC_REST_Data_Controller

[16] Fix | Delete

*/

[17] Fix | Delete

class ShippingPartnerSuggestions extends \WC_REST_Data_Controller {

[18] Fix | Delete

/**

[19] Fix | Delete

* Endpoint namespace.

[20] Fix | Delete

*

[21] Fix | Delete

* @var string

[22] Fix | Delete

*/

[23] Fix | Delete

protected $namespace = 'wc-admin';

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* Route base.

[27] Fix | Delete

*

[28] Fix | Delete

* @var string

[29] Fix | Delete

*/

[30] Fix | Delete

protected $rest_base = 'shipping-partner-suggestions';

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* Register routes.

[34] Fix | Delete

*/

[35] Fix | Delete

public function register_routes() {

[36] Fix | Delete

[37] Fix | Delete

register_rest_route(

[38] Fix | Delete

$this->namespace,

[39] Fix | Delete

'/' . $this->rest_base,

[40] Fix | Delete

array(

[41] Fix | Delete

array(

[42] Fix | Delete

'methods' => \WP_REST_Server::READABLE,

[43] Fix | Delete

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

[44] Fix | Delete

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

[45] Fix | Delete

'args' => array(

[46] Fix | Delete

'force_default_suggestions' => array(

[47] Fix | Delete

'type' => 'boolean',

[48] Fix | Delete

'description' => __( 'Return the default shipping partner suggestions when woocommerce_show_marketplace_suggestions option is set to no', 'woocommerce' ),

[49] Fix | Delete

),

[50] Fix | Delete

),

[51] Fix | Delete

),

[52] Fix | Delete

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

[53] Fix | Delete

)

[54] Fix | Delete

);

[55] Fix | Delete

[56] Fix | Delete

}

[57] Fix | Delete

[58] Fix | Delete

/**

[59] Fix | Delete

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

[60] Fix | Delete

*

[61] Fix | Delete

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

[62] Fix | Delete

* @return WP_Error|boolean

[63] Fix | Delete

*/

[64] Fix | Delete

public function get_permission_check( $request ) {

[65] Fix | Delete

if ( ! current_user_can( 'install_plugins' ) ) {

[66] Fix | Delete

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

[67] Fix | Delete

}

[68] Fix | Delete

return true;

[69] Fix | Delete

}

[70] Fix | Delete

[71] Fix | Delete

/**

[72] Fix | Delete

* Check if suggestions should be shown in the settings screen.

[73] Fix | Delete

*

[74] Fix | Delete

* @return bool

[75] Fix | Delete

*/

[76] Fix | Delete

private function should_display() {

[77] Fix | Delete

if ( 'no' === get_option( 'woocommerce_show_marketplace_suggestions', 'yes' ) ) {

[78] Fix | Delete

return false;

[79] Fix | Delete

}

[80] Fix | Delete

[81] Fix | Delete

/**

[82] Fix | Delete

* The return value can be controlled via woocommerce_allow_shipping_partner_suggestions filter.

[83] Fix | Delete

*

[84] Fix | Delete

* @since 7.4.1

[85] Fix | Delete

*/

[86] Fix | Delete

return apply_filters( 'woocommerce_allow_shipping_partner_suggestions', true );

[87] Fix | Delete

}

[88] Fix | Delete

[89] Fix | Delete

/**

[90] Fix | Delete

* Return suggested shipping partners.

[91] Fix | Delete

*

[92] Fix | Delete

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

[93] Fix | Delete

* @return \WP_Error|\WP_HTTP_Response|\WP_REST_Response

[94] Fix | Delete

*/

[95] Fix | Delete

public function get_suggestions( $request ) {

[96] Fix | Delete

$should_display = $this->should_display();

[97] Fix | Delete

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

[98] Fix | Delete

[99] Fix | Delete

if ( $should_display ) {

[100] Fix | Delete

return Suggestions::get_suggestions();

[101] Fix | Delete

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

[102] Fix | Delete

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

[103] Fix | Delete

}

[104] Fix | Delete

[105] Fix | Delete

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

[106] Fix | Delete

}

[107] Fix | Delete

[108] Fix | Delete

/**

[109] Fix | Delete

* Get the schema, conforming to JSON Schema.

[110] Fix | Delete

*

[111] Fix | Delete

* @return array

[112] Fix | Delete

*/

[113] Fix | Delete

public static function get_suggestions_schema() {

[114] Fix | Delete

$feature_def = array(

[115] Fix | Delete

'type' => 'array',

[116] Fix | Delete

'items' => array(

[117] Fix | Delete

'type' => 'object',

[118] Fix | Delete

'properties' => array(

[119] Fix | Delete

'icon' => array(

[120] Fix | Delete

'type' => 'string',

[121] Fix | Delete

),

[122] Fix | Delete

'title' => array(

[123] Fix | Delete

'type' => 'string',

[124] Fix | Delete

),

[125] Fix | Delete

'description' => array(

[126] Fix | Delete

'type' => 'string',

[127] Fix | Delete

),

[128] Fix | Delete

),

[129] Fix | Delete

),

[130] Fix | Delete

);

[131] Fix | Delete

$layout_def = array(

[132] Fix | Delete

'type' => 'object',

[133] Fix | Delete

'properties' => array(

[134] Fix | Delete

'image' => array(

[135] Fix | Delete

'type' => 'string',

[136] Fix | Delete

'description' => '',

[137] Fix | Delete

),

[138] Fix | Delete

'features' => $feature_def,

[139] Fix | Delete

),

[140] Fix | Delete

);

[141] Fix | Delete

[142] Fix | Delete

$item_schema = array(

[143] Fix | Delete

'type' => 'object',

[144] Fix | Delete

'required' => array( 'name', 'is_visible', 'available_layouts' ),

[145] Fix | Delete

// require layout_row or layout_column. One of them must exist.

[146] Fix | Delete

'anyOf' => array(

[147] Fix | Delete

array(

[148] Fix | Delete

'required' => 'layout_row',

[149] Fix | Delete

),

[150] Fix | Delete

array(

[151] Fix | Delete

'required' => 'layout_column',

[152] Fix | Delete

),

[153] Fix | Delete

),

[154] Fix | Delete

'properties' => array(

[155] Fix | Delete

'name' => array(

[156] Fix | Delete

'description' => __( 'Plugin name.', 'woocommerce' ),

[157] Fix | Delete

'type' => 'string',

[158] Fix | Delete

'required' => true,

[159] Fix | Delete

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

[160] Fix | Delete

'readonly' => true,

[161] Fix | Delete

),

[162] Fix | Delete

'slug' => array(

[163] Fix | Delete

'description' => __( 'Plugin slug used in https://wordpress.org/plugins/{slug}.', 'woocommerce' ),

[164] Fix | Delete

'type' => 'string',

[165] Fix | Delete

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

[166] Fix | Delete

'readonly' => true,

[167] Fix | Delete

),

[168] Fix | Delete

'layout_row' => $layout_def,

[169] Fix | Delete

'layout_column' => $layout_def,

[170] Fix | Delete

'description' => array(

[171] Fix | Delete

'description' => __( 'Description', 'woocommerce' ),

[172] Fix | Delete

'type' => 'string',

[173] Fix | Delete

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

[174] Fix | Delete

'readonly' => true,

[175] Fix | Delete

),

[176] Fix | Delete

'learn_more_link' => array(

[177] Fix | Delete

'description' => __( 'Learn more link .', 'woocommerce' ),

[178] Fix | Delete

'type' => 'string',

[179] Fix | Delete

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

[180] Fix | Delete

'readonly' => true,

[181] Fix | Delete

),

[182] Fix | Delete

'is_visible' => array(

[183] Fix | Delete

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

[184] Fix | Delete

'type' => 'boolean',

[185] Fix | Delete

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

[186] Fix | Delete

'readonly' => true,

[187] Fix | Delete

),

[188] Fix | Delete

'available_layouts' => array(

[189] Fix | Delete

'description' => __( 'Available layouts -- single, dual, or both', 'woocommerce' ),

[190] Fix | Delete

'type' => 'array',

[191] Fix | Delete

'items' => array(

[192] Fix | Delete

'type' => 'string',

[193] Fix | Delete

'enum' => array( 'row', 'column' ),

[194] Fix | Delete

),

[195] Fix | Delete

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

[196] Fix | Delete

'readonly' => true,

[197] Fix | Delete

),

[198] Fix | Delete

),

[199] Fix | Delete

);

[200] Fix | Delete

[201] Fix | Delete

$schema = array(

[202] Fix | Delete

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

[203] Fix | Delete

'title' => 'shipping-partner-suggestions',

[204] Fix | Delete

'type' => 'array',

[205] Fix | Delete

'items' => array( $item_schema ),

[206] Fix | Delete

);

[207] Fix | Delete

[208] Fix | Delete

return $schema;

[209] Fix | Delete

}

[210] Fix | Delete

}

[211] Fix | Delete

[212] Fix | Delete