<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* REST API MarketingRecommendations Controller

[2] Fix | Delete

*

[3] Fix | Delete

* Handles requests to /marketing/recommendations.

[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\MarketingRecommendations\Init as MarketingRecommendationsInit;

[9] Fix | Delete

use WC_REST_Controller;

[10] Fix | Delete

use WP_Error;

[11] Fix | Delete

use WP_REST_Request;

[12] Fix | Delete

use WP_REST_Response;

[13] Fix | Delete

[14] Fix | Delete

defined( 'ABSPATH' ) || exit;

[15] Fix | Delete

[16] Fix | Delete

/**

[17] Fix | Delete

* MarketingRecommendations Controller.

[18] Fix | Delete

*

[19] Fix | Delete

* @internal

[20] Fix | Delete

* @extends WC_REST_Controller

[21] Fix | Delete

* @since x.x.x

[22] Fix | Delete

*/

[23] Fix | Delete

class MarketingRecommendations extends WC_REST_Controller {

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* Endpoint namespace.

[27] Fix | Delete

*

[28] Fix | Delete

* @var string

[29] Fix | Delete

*/

[30] Fix | Delete

protected $namespace = 'wc-admin';

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* Route base.

[34] Fix | Delete

*

[35] Fix | Delete

* @var string

[36] Fix | Delete

*/

[37] Fix | Delete

protected $rest_base = 'marketing/recommendations';

[38] Fix | Delete

[39] Fix | Delete

/**

[40] Fix | Delete

* Register routes.

[41] Fix | Delete

*/

[42] Fix | Delete

public function register_routes() {

[43] Fix | Delete

register_rest_route(

[44] Fix | Delete

$this->namespace,

[45] Fix | Delete

'/' . $this->rest_base,

[46] Fix | Delete

[

[47] Fix | Delete

[

[48] Fix | Delete

'methods' => \WP_REST_Server::READABLE,

[49] Fix | Delete

'callback' => [ $this, 'get_items' ],

[50] Fix | Delete

'permission_callback' => [ $this, 'get_items_permissions_check' ],

[51] Fix | Delete

'args' => [

[52] Fix | Delete

'category' => [

[53] Fix | Delete

'type' => 'string',

[54] Fix | Delete

'validate_callback' => 'rest_validate_request_arg',

[55] Fix | Delete

'sanitize_callback' => 'sanitize_title_with_dashes',

[56] Fix | Delete

'enum' => [ 'channels', 'extensions' ],

[57] Fix | Delete

'required' => true,

[58] Fix | Delete

],

[59] Fix | Delete

],

[60] Fix | Delete

],

[61] Fix | Delete

'schema' => [ $this, 'get_public_item_schema' ],

[62] Fix | Delete

]

[63] Fix | Delete

);

[64] Fix | Delete

}

[65] Fix | Delete

[66] Fix | Delete

/**

[67] Fix | Delete

* Check whether a given request has permission to view marketing recommendations.

[68] Fix | Delete

*

[69] Fix | Delete

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

[70] Fix | Delete

*

[71] Fix | Delete

* @return WP_Error|boolean

[72] Fix | Delete

*/

[73] Fix | Delete

public function get_items_permissions_check( $request ) {

[74] Fix | Delete

if ( ! current_user_can( 'install_plugins' ) ) {

[75] Fix | Delete

return new WP_Error( 'woocommerce_rest_cannot_view', __( 'Sorry, you cannot view marketing channels.', 'woocommerce' ), array( 'status' => rest_authorization_required_code() ) );

[76] Fix | Delete

}

[77] Fix | Delete

[78] Fix | Delete

return true;

[79] Fix | Delete

}

[80] Fix | Delete

[81] Fix | Delete

/**

[82] Fix | Delete

* Retrieves a collection of recommendations.

[83] Fix | Delete

*

[84] Fix | Delete

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

[85] Fix | Delete

*

[86] Fix | Delete

* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.

[87] Fix | Delete

*/

[88] Fix | Delete

public function get_items( $request ) {

[89] Fix | Delete

$category = $request->get_param( 'category' );

[90] Fix | Delete

if ( 'channels' === $category ) {

[91] Fix | Delete

$items = MarketingRecommendationsInit::get_recommended_marketing_channels();

[92] Fix | Delete

} elseif ( 'extensions' === $category ) {

[93] Fix | Delete

$items = MarketingRecommendationsInit::get_recommended_marketing_extensions_excluding_channels();

[94] Fix | Delete

} else {

[95] Fix | Delete

return new WP_Error( 'woocommerce_rest_invalid_category', __( 'The specified category for recommendations is invalid. Allowed values: "channels", "extensions".', 'woocommerce' ), array( 'status' => 400 ) );

[96] Fix | Delete

}

[97] Fix | Delete

[98] Fix | Delete

$responses = [];

[99] Fix | Delete

foreach ( $items as $item ) {

[100] Fix | Delete

$response = $this->prepare_item_for_response( $item, $request );

[101] Fix | Delete

$responses[] = $this->prepare_response_for_collection( $response );

[102] Fix | Delete

}

[103] Fix | Delete

[104] Fix | Delete

return rest_ensure_response( $responses );

[105] Fix | Delete

}

[106] Fix | Delete

[107] Fix | Delete

/**

[108] Fix | Delete

* Prepares the item for the REST response.

[109] Fix | Delete

*

[110] Fix | Delete

* @param array $item WordPress representation of the item.

[111] Fix | Delete

* @param WP_REST_Request $request Request object.

[112] Fix | Delete

*

[113] Fix | Delete

* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.

[114] Fix | Delete

*/

[115] Fix | Delete

public function prepare_item_for_response( $item, $request ) {

[116] Fix | Delete

$context = ! empty( $request['context'] ) ? $request['context'] : 'view';

[117] Fix | Delete

$data = $this->add_additional_fields_to_object( $item, $request );

[118] Fix | Delete

$data = $this->filter_response_by_context( $data, $context );

[119] Fix | Delete

[120] Fix | Delete

return rest_ensure_response( $data );

[121] Fix | Delete

}

[122] Fix | Delete

[123] Fix | Delete

/**

[124] Fix | Delete

* Retrieves the item's schema, conforming to JSON Schema.

[125] Fix | Delete

*

[126] Fix | Delete

* @return array Item schema data.

[127] Fix | Delete

*/

[128] Fix | Delete

public function get_item_schema() {

[129] Fix | Delete

$schema = [

[130] Fix | Delete

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

[131] Fix | Delete

'title' => 'marketing_recommendation',

[132] Fix | Delete

'type' => 'object',

[133] Fix | Delete

'properties' => [

[134] Fix | Delete

'title' => [

[135] Fix | Delete

'type' => 'string',

[136] Fix | Delete

'context' => [ 'view' ],

[137] Fix | Delete

'readonly' => true,

[138] Fix | Delete

],

[139] Fix | Delete

'description' => [

[140] Fix | Delete

'type' => 'string',

[141] Fix | Delete

'context' => [ 'view' ],

[142] Fix | Delete

'readonly' => true,

[143] Fix | Delete

],

[144] Fix | Delete

'url' => [

[145] Fix | Delete

'type' => 'string',

[146] Fix | Delete

'context' => [ 'view' ],

[147] Fix | Delete

'readonly' => true,

[148] Fix | Delete

],

[149] Fix | Delete

'direct_install' => [

[150] Fix | Delete

'type' => 'string',

[151] Fix | Delete

'context' => [ 'view' ],

[152] Fix | Delete

'readonly' => true,

[153] Fix | Delete

],

[154] Fix | Delete

'icon' => [

[155] Fix | Delete

'type' => 'string',

[156] Fix | Delete

'context' => [ 'view' ],

[157] Fix | Delete

'readonly' => true,

[158] Fix | Delete

],

[159] Fix | Delete

'product' => [

[160] Fix | Delete

'type' => 'string',

[161] Fix | Delete

'context' => [ 'view' ],

[162] Fix | Delete

'readonly' => true,

[163] Fix | Delete

],

[164] Fix | Delete

'plugin' => [

[165] Fix | Delete

'type' => 'string',

[166] Fix | Delete

'context' => [ 'view' ],

[167] Fix | Delete

'readonly' => true,

[168] Fix | Delete

],

[169] Fix | Delete

'categories' => [

[170] Fix | Delete

'type' => 'array',

[171] Fix | Delete

'context' => [ 'view' ],

[172] Fix | Delete

'readonly' => true,

[173] Fix | Delete

'items' => [

[174] Fix | Delete

'type' => 'string',

[175] Fix | Delete

],

[176] Fix | Delete

],

[177] Fix | Delete

'subcategories' => [

[178] Fix | Delete

'type' => 'array',

[179] Fix | Delete

'context' => [ 'view' ],

[180] Fix | Delete

'readonly' => true,

[181] Fix | Delete

'items' => [

[182] Fix | Delete

'type' => 'object',

[183] Fix | Delete

'context' => [ 'view' ],

[184] Fix | Delete

'readonly' => true,

[185] Fix | Delete

'properties' => [

[186] Fix | Delete

'slug' => [

[187] Fix | Delete

'type' => 'string',

[188] Fix | Delete

'context' => [ 'view' ],

[189] Fix | Delete

'readonly' => true,

[190] Fix | Delete

],

[191] Fix | Delete

'name' => [

[192] Fix | Delete

'type' => 'string',

[193] Fix | Delete

'context' => [ 'view' ],

[194] Fix | Delete

'readonly' => true,

[195] Fix | Delete

],

[196] Fix | Delete

],

[197] Fix | Delete

],

[198] Fix | Delete

],

[199] Fix | Delete

'tags' => [

[200] Fix | Delete

'type' => 'array',

[201] Fix | Delete

'context' => [ 'view' ],

[202] Fix | Delete

'readonly' => true,

[203] Fix | Delete

'items' => [

[204] Fix | Delete

'type' => 'object',

[205] Fix | Delete

'context' => [ 'view' ],

[206] Fix | Delete

'readonly' => true,

[207] Fix | Delete

'properties' => [

[208] Fix | Delete

'slug' => [

[209] Fix | Delete

'type' => 'string',

[210] Fix | Delete

'context' => [ 'view' ],

[211] Fix | Delete

'readonly' => true,

[212] Fix | Delete

],

[213] Fix | Delete

'name' => [

[214] Fix | Delete

'type' => 'string',

[215] Fix | Delete

'context' => [ 'view' ],

[216] Fix | Delete

'readonly' => true,

[217] Fix | Delete

],

[218] Fix | Delete

],

[219] Fix | Delete

],

[220] Fix | Delete

],

[221] Fix | Delete

],

[222] Fix | Delete

];

[223] Fix | Delete

[224] Fix | Delete

return $this->add_additional_fields_schema( $schema );

[225] Fix | Delete

}

[226] Fix | Delete

}

[227] Fix | Delete

[228] Fix | Delete