woocommerce-paypal-payments/modules/ppcp-settings/src/Endpoint/StylingRestEndpoint.php

171 lines
3.8 KiB
PHP
Raw Normal View History

<?php
/**
* REST endpoint to manage the styling page.
*
* @package WooCommerce\PayPalCommerce\Settings\Endpoint
*/
declare( strict_types = 1 );
namespace WooCommerce\PayPalCommerce\Settings\Endpoint;
use WP_REST_Server;
use WP_REST_Response;
use WP_REST_Request;
use WooCommerce\PayPalCommerce\Settings\Data\StylingSettings;
use WooCommerce\PayPalCommerce\Settings\DTO\LocationStylingDTO;
use WooCommerce\PayPalCommerce\Settings\Service\DataSanitizer;
/**
* REST controller for the "Styling" settings tab.
*
* This API acts as the intermediary between the "external world" and our
* internal data model.
*/
class StylingRestEndpoint extends RestEndpoint {
/**
* The base path for this REST controller.
*
* @var string
*/
protected $rest_base = 'styling';
/**
* The settings instance.
*
* @var StylingSettings
*/
protected StylingSettings $settings;
/**
* Data sanitizer service.
*
* @var DataSanitizer
*/
protected DataSanitizer $sanitizer;
/**
* Field mapping for request to profile transformation.
*
* @var array
*/
private array $field_map = array(
'cart' => array(
'js_name' => 'cart',
),
'classic_checkout' => array(
'js_name' => 'classicCheckout',
),
'express_checkout' => array(
'js_name' => 'expressCheckout',
),
'mini_cart' => array(
'js_name' => 'miniCart',
),
'product' => array(
'js_name' => 'product',
),
);
/**
* Constructor.
*
* @param StylingSettings $settings The settings instance.
* @param DataSanitizer $sanitizer Data sanitizer service.
*/
public function __construct( StylingSettings $settings, DataSanitizer $sanitizer ) {
$this->settings = $settings;
$this->sanitizer = $sanitizer;
$this->field_map['cart']['sanitize'] = array(
$this->sanitizer,
'sanitize_location_style',
);
$this->field_map['classic_checkout']['sanitize'] = array(
$this->sanitizer,
'sanitize_location_style',
);
$this->field_map['express_checkout']['sanitize'] = array(
$this->sanitizer,
'sanitize_location_style',
);
$this->field_map['mini_cart']['sanitize'] = array(
$this->sanitizer,
'sanitize_location_style',
);
$this->field_map['product']['sanitize'] = array(
$this->sanitizer,
'sanitize_location_style',
);
}
/**
* Configure REST API routes.
*/
public function register_routes() : void {
/**
* GET wc/v3/wc_paypal/styling
*/
register_rest_route(
$this->namespace,
'/' . $this->rest_base,
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_details' ),
'permission_callback' => array( $this, 'check_permission' ),
)
);
/**
* POST wc/v3/wc_paypal/styling
* {
* // Fields mentioned in $field_map[]['js_name']
* }
*/
register_rest_route(
$this->namespace,
'/' . $this->rest_base,
array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => array( $this, 'update_details' ),
'permission_callback' => array( $this, 'check_permission' ),
)
);
}
/**
* Returns all styling details.
*
* @return WP_REST_Response The current styling details.
*/
public function get_details() : WP_REST_Response {
$js_data = $this->sanitize_for_javascript(
$this->settings->to_array(),
$this->field_map
);
return $this->return_success(
$js_data
);
}
/**
* Updates styling details based on the request.
*
* @param WP_REST_Request $request Full data about the request.
*
* @return WP_REST_Response The updated styling details.
*/
public function update_details( WP_REST_Request $request ) : WP_REST_Response {
$wp_data = $this->sanitize_for_wordpress(
$request->get_params(),
$this->field_map
);
$this->settings->from_array( $wp_data );
$this->settings->save();
return $this->get_details();
}
}