462 lines
15 KiB
PHP
462 lines
15 KiB
PHP
<?php
|
|
/**
|
|
* REST API WC Payment gateways controller
|
|
*
|
|
* Handles requests to the /payment_gateways endpoint.
|
|
*
|
|
* @author WooThemes
|
|
* @category API
|
|
* @package WooCommerce/API
|
|
* @since 3.0.0
|
|
*/
|
|
|
|
if ( ! defined( 'ABSPATH' ) ) {
|
|
exit;
|
|
}
|
|
|
|
/**
|
|
* @package WooCommerce/API
|
|
* @extends WC_REST_Controller
|
|
*/
|
|
class WC_REST_Payment_Gateways_Controller extends WC_REST_Controller {
|
|
|
|
/**
|
|
* Endpoint namespace.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $namespace = 'wc/v2';
|
|
|
|
/**
|
|
* Route base.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $rest_base = 'payment_gateways';
|
|
|
|
/**
|
|
* Register the route for /payment_gateways and /payment_gateways/<id>
|
|
*/
|
|
public function register_routes() {
|
|
register_rest_route( $this->namespace, '/' . $this->rest_base, array(
|
|
array(
|
|
'methods' => WP_REST_Server::READABLE,
|
|
'callback' => array( $this, 'get_items' ),
|
|
'permission_callback' => array( $this, 'get_items_permissions_check' ),
|
|
'args' => $this->get_collection_params(),
|
|
),
|
|
'schema' => array( $this, 'get_public_item_schema' ),
|
|
) );
|
|
register_rest_route( $this->namespace, '/' . $this->rest_base . '/(?P<id>[\w-]+)', array(
|
|
'args' => array(
|
|
'id' => array(
|
|
'description' => __( 'Unique identifier for the resource.', 'woocommerce' ),
|
|
'type' => 'string',
|
|
),
|
|
),
|
|
array(
|
|
'methods' => WP_REST_Server::READABLE,
|
|
'callback' => array( $this, 'get_item' ),
|
|
'permission_callback' => array( $this, 'get_item_permissions_check' ),
|
|
'args' => array(
|
|
'context' => $this->get_context_param( array( 'default' => 'view' ) ),
|
|
),
|
|
),
|
|
array(
|
|
'methods' => WP_REST_Server::EDITABLE,
|
|
'callback' => array( $this, 'update_item' ),
|
|
'permission_callback' => array( $this, 'update_items_permissions_check' ),
|
|
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
|
|
),
|
|
'schema' => array( $this, 'get_public_item_schema' ),
|
|
) );
|
|
}
|
|
|
|
/**
|
|
* Check whether a given request has permission to view payment gateways.
|
|
*
|
|
* @param WP_REST_Request $request Full details about the request.
|
|
* @return WP_Error|boolean
|
|
*/
|
|
public function get_items_permissions_check( $request ) {
|
|
if ( ! wc_rest_check_manager_permissions( 'payment_gateways', 'read' ) ) {
|
|
return new WP_Error( 'woocommerce_rest_cannot_view', __( 'Sorry, you cannot list resources.', 'woocommerce' ), array( 'status' => rest_authorization_required_code() ) );
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Check if a given request has access to read a payment gateway.
|
|
*
|
|
* @param WP_REST_Request $request Full details about the request.
|
|
* @return WP_Error|boolean
|
|
*/
|
|
public function get_item_permissions_check( $request ) {
|
|
if ( ! wc_rest_check_manager_permissions( 'payment_gateways', 'read' ) ) {
|
|
return new WP_Error( 'woocommerce_rest_cannot_view', __( 'Sorry, you cannot view this resource.', 'woocommerce' ), array( 'status' => rest_authorization_required_code() ) );
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Check whether a given request has permission to edit payment gateways.
|
|
*
|
|
* @param WP_REST_Request $request Full details about the request.
|
|
* @return WP_Error|boolean
|
|
*/
|
|
public function update_items_permissions_check( $request ) {
|
|
if ( ! wc_rest_check_manager_permissions( 'payment_gateways', 'edit' ) ) {
|
|
return new WP_Error( 'woocommerce_rest_cannot_edit', __( 'Sorry, you are not allowed to edit this resource.', 'woocommerce' ), array( 'status' => rest_authorization_required_code() ) );
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Get payment gateways.
|
|
*
|
|
* @param WP_REST_Request $request Full details about the request.
|
|
* @return WP_Error|WP_REST_Response
|
|
*/
|
|
public function get_items( $request ) {
|
|
$payment_gateways = WC()->payment_gateways->payment_gateways();
|
|
$response = array();
|
|
foreach ( $payment_gateways as $payment_gateway_id => $payment_gateway ) {
|
|
$payment_gateway->id = $payment_gateway_id;
|
|
$gateway = $this->prepare_item_for_response( $payment_gateway, $request );
|
|
$gateway = $this->prepare_response_for_collection( $gateway );
|
|
$response[] = $gateway;
|
|
}
|
|
return rest_ensure_response( $response );
|
|
}
|
|
|
|
/**
|
|
* Get a single payment gateway.
|
|
*
|
|
* @param WP_REST_Request $request
|
|
* @return WP_REST_Response|WP_Error
|
|
*/
|
|
public function get_item( $request ) {
|
|
$gateway = $this->get_gateway( $request );
|
|
|
|
if ( is_null( $gateway ) ) {
|
|
return new WP_Error( 'woocommerce_rest_payment_gateway_invalid', __( 'Resource does not exist.', 'woocommerce' ), array( 'status' => 404 ) );
|
|
}
|
|
|
|
$gateway = $this->prepare_item_for_response( $gateway, $request );
|
|
return rest_ensure_response( $gateway );
|
|
}
|
|
|
|
/**
|
|
* Update A Single Payment Method.
|
|
*
|
|
* @param WP_REST_Request $request
|
|
* @return WP_REST_Response|WP_Error
|
|
*/
|
|
public function update_item( $request ) {
|
|
$gateway = $this->get_gateway( $request );
|
|
|
|
if ( is_null( $gateway ) ) {
|
|
return new WP_Error( 'woocommerce_rest_payment_gateway_invalid', __( 'Resource does not exist.', 'woocommerce' ), array( 'status' => 404 ) );
|
|
}
|
|
|
|
// Get settings.
|
|
$gateway->init_form_fields();
|
|
$settings = $gateway->settings;
|
|
|
|
// Update settings.
|
|
if ( isset( $request['settings'] ) ) {
|
|
$errors_found = false;
|
|
foreach ( $gateway->form_fields as $key => $field ) {
|
|
if ( isset( $request['settings'][ $key ] ) ) {
|
|
if ( is_callable( array( $this, 'validate_setting_' . $field['type'] . '_field' ) ) ) {
|
|
$value = $this->{'validate_setting_' . $field['type'] . '_field'}( $request['settings'][ $key ], $field );
|
|
} else {
|
|
$value = $this->validate_setting_text_field( $request['settings'][ $key ], $field );
|
|
}
|
|
if ( is_wp_error( $value ) ) {
|
|
$errors_found = true;
|
|
break;
|
|
}
|
|
$settings[ $key ] = $value;
|
|
}
|
|
}
|
|
|
|
if ( $errors_found ) {
|
|
return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'woocommerce' ), array( 'status' => 400 ) );
|
|
}
|
|
}
|
|
|
|
// Update if this method is enabled or not.
|
|
if ( isset( $request['enabled'] ) ) {
|
|
$gateway->enabled = $settings['enabled'] = wc_bool_to_string( $request['enabled'] );
|
|
}
|
|
|
|
// Update title.
|
|
if ( isset( $request['title'] ) ) {
|
|
$gateway->title = $settings['title'] = $request['title'];
|
|
}
|
|
|
|
// Update description.
|
|
if ( isset( $request['description'] ) ) {
|
|
$gateway->description = $settings['description'] = $request['description'];
|
|
}
|
|
|
|
// Update options.
|
|
$gateway->settings = $settings;
|
|
update_option( $gateway->get_option_key(), apply_filters( 'woocommerce_gateway_' . $gateway->id . '_settings_values', $settings, $gateway ) );
|
|
|
|
// Update order
|
|
if ( isset( $request['order'] ) ) {
|
|
$order = (array) get_option( 'woocommerce_gateway_order' );
|
|
$order[ $gateway->id ] = $request['order'];
|
|
update_option( 'woocommerce_gateway_order', $order );
|
|
$gateway->order = absint( $request['order'] );
|
|
}
|
|
|
|
$gateway = $this->prepare_item_for_response( $gateway, $request );
|
|
return rest_ensure_response( $gateway );
|
|
}
|
|
|
|
/**
|
|
* Get a gateway based on the current request object.
|
|
*
|
|
* @param WP_REST_Request $request
|
|
* @return WP_REST_Response|null
|
|
*/
|
|
public function get_gateway( $request ) {
|
|
$gateway = null;
|
|
$payment_gateways = WC()->payment_gateways->payment_gateways();
|
|
foreach ( $payment_gateways as $payment_gateway_id => $payment_gateway ) {
|
|
if ( $request['id'] !== $payment_gateway_id ) {
|
|
continue;
|
|
}
|
|
$payment_gateway->id = $payment_gateway_id;
|
|
$gateway = $payment_gateway;
|
|
}
|
|
return $gateway;
|
|
}
|
|
|
|
/**
|
|
* Prepare a payment gateway for response.
|
|
*
|
|
* @param WC_Payment_Gateway $gateway Payment gateway object.
|
|
* @param WP_REST_Request $request Request object.
|
|
* @return WP_REST_Response $response Response data.
|
|
*/
|
|
public function prepare_item_for_response( $gateway, $request ) {
|
|
$order = (array) get_option( 'woocommerce_gateway_order' );
|
|
$item = array(
|
|
'id' => $gateway->id,
|
|
'title' => $gateway->title,
|
|
'description' => $gateway->description,
|
|
'order' => isset( $order[ $gateway->id ] ) ? $order[ $gateway->id ] : '',
|
|
'enabled' => ( 'yes' === $gateway->enabled ),
|
|
'method_title' => $gateway->get_method_title(),
|
|
'method_description' => $gateway->get_method_description(),
|
|
'settings' => $this->get_settings( $gateway ),
|
|
);
|
|
|
|
$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
|
|
$data = $this->add_additional_fields_to_object( $item, $request );
|
|
$data = $this->filter_response_by_context( $data, $context );
|
|
|
|
$response = rest_ensure_response( $data );
|
|
$response->add_links( $this->prepare_links( $gateway, $request ) );
|
|
|
|
/**
|
|
* Filter payment gateway objects returned from the REST API.
|
|
*
|
|
* @param WP_REST_Response $response The response object.
|
|
* @param WC_Payment_Gateway $gateway Payment gateway object.
|
|
* @param WP_REST_Request $request Request object.
|
|
*/
|
|
return apply_filters( 'woocommerce_rest_prepare_payment_gateway', $response, $gateway, $request );
|
|
}
|
|
|
|
/**
|
|
* Return settings associated with this payment gateway.
|
|
*
|
|
* @param WC_Payment_Gateway $gateway
|
|
*
|
|
* @return array
|
|
*/
|
|
public function get_settings( $gateway ) {
|
|
$settings = array();
|
|
$gateway->init_form_fields();
|
|
foreach ( $gateway->form_fields as $id => $field ) {
|
|
// Make sure we at least have a title and type
|
|
if ( empty( $field['title'] ) || empty( $field['type'] ) ) {
|
|
continue;
|
|
}
|
|
// Ignore 'title' settings/fields -- they are UI only
|
|
if ( 'title' === $field['type'] ) {
|
|
continue;
|
|
}
|
|
// Ignore 'enabled' and 'description' which get included elsewhere.
|
|
if ( in_array( $id, array( 'enabled', 'description' ) ) ) {
|
|
continue;
|
|
}
|
|
$data = array(
|
|
'id' => $id,
|
|
'label' => empty( $field['label'] ) ? $field['title'] : $field['label'],
|
|
'description' => empty( $field['description'] ) ? '' : $field['description'],
|
|
'type' => $field['type'],
|
|
'value' => empty( $gateway->settings[ $id ] ) ? '' : $gateway->settings[ $id ],
|
|
'default' => empty( $field['default'] ) ? '' : $field['default'],
|
|
'tip' => empty( $field['description'] ) ? '' : $field['description'],
|
|
'placeholder' => empty( $field['placeholder'] ) ? '' : $field['placeholder'],
|
|
);
|
|
if ( ! empty( $field['options'] ) ) {
|
|
$data['options'] = $field['options'];
|
|
}
|
|
$settings[ $id ] = $data;
|
|
}
|
|
return $settings;
|
|
}
|
|
|
|
/**
|
|
* Prepare links for the request.
|
|
*
|
|
* @param WC_Payment_Gateway $gateway Payment gateway object.
|
|
* @param WP_REST_Request $request Request object.
|
|
* @return array
|
|
*/
|
|
protected function prepare_links( $gateway, $request ) {
|
|
$links = array(
|
|
'self' => array(
|
|
'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $gateway->id ) ),
|
|
),
|
|
'collection' => array(
|
|
'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
|
|
),
|
|
);
|
|
|
|
return $links;
|
|
}
|
|
|
|
/**
|
|
* Get the payment gateway schema, conforming to JSON Schema.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function get_item_schema() {
|
|
$schema = array(
|
|
'$schema' => 'http://json-schema.org/draft-04/schema#',
|
|
'title' => 'payment_gateway',
|
|
'type' => 'object',
|
|
'properties' => array(
|
|
'id' => array(
|
|
'description' => __( 'Payment gateway ID.', 'woocommerce' ),
|
|
'type' => 'string',
|
|
'context' => array( 'view', 'edit' ),
|
|
'readonly' => true,
|
|
),
|
|
'title' => array(
|
|
'description' => __( 'Payment gateway title on checkout.', 'woocommerce' ),
|
|
'type' => 'string',
|
|
'context' => array( 'view', 'edit' ),
|
|
),
|
|
'description' => array(
|
|
'description' => __( 'Payment gateway description on checkout.', 'woocommerce' ),
|
|
'type' => 'string',
|
|
'context' => array( 'view', 'edit' ),
|
|
),
|
|
'order' => array(
|
|
'description' => __( 'Payment gateway sort order.', 'woocommerce' ),
|
|
'type' => 'integer',
|
|
'context' => array( 'view', 'edit' ),
|
|
'arg_options' => array(
|
|
'sanitize_callback' => 'absint',
|
|
),
|
|
),
|
|
'enabled' => array(
|
|
'description' => __( 'Payment gateway enabled status.', 'woocommerce' ),
|
|
'type' => 'boolean',
|
|
'context' => array( 'view', 'edit' ),
|
|
),
|
|
'method_title' => array(
|
|
'description' => __( 'Payment gateway method title.', 'woocommerce' ),
|
|
'type' => 'string',
|
|
'context' => array( 'view', 'edit' ),
|
|
'readonly' => true,
|
|
),
|
|
'method_description' => array(
|
|
'description' => __( 'Payment gateway method description.', 'woocommerce' ),
|
|
'type' => 'string',
|
|
'context' => array( 'view', 'edit' ),
|
|
'readonly' => true,
|
|
),
|
|
'settings' => array(
|
|
'description' => __( 'Payment gateway settings.', 'woocommerce' ),
|
|
'type' => 'object',
|
|
'context' => array( 'view', 'edit' ),
|
|
'properties' => array(
|
|
'id' => array(
|
|
'description' => __( 'A unique identifier for the setting.', 'woocommerce' ),
|
|
'type' => 'string',
|
|
'context' => array( 'view', 'edit' ),
|
|
'readonly' => true,
|
|
),
|
|
'label' => array(
|
|
'description' => __( 'A human readable label for the setting used in interfaces.', 'woocommerce' ),
|
|
'type' => 'string',
|
|
'context' => array( 'view', 'edit' ),
|
|
'readonly' => true,
|
|
),
|
|
'description' => array(
|
|
'description' => __( 'A human readable description for the setting used in interfaces.', 'woocommerce' ),
|
|
'type' => 'string',
|
|
'context' => array( 'view', 'edit' ),
|
|
'readonly' => true,
|
|
),
|
|
'type' => array(
|
|
'description' => __( 'Type of setting.', 'woocommerce' ),
|
|
'type' => 'string',
|
|
'context' => array( 'view', 'edit' ),
|
|
'enum' => array( 'text', 'email', 'number', 'color', 'password', 'textarea', 'select', 'multiselect', 'radio', 'image_width', 'checkbox' ),
|
|
'readonly' => true,
|
|
),
|
|
'value' => array(
|
|
'description' => __( 'Setting value.', 'woocommerce' ),
|
|
'type' => 'string',
|
|
'context' => array( 'view', 'edit' ),
|
|
),
|
|
'default' => array(
|
|
'description' => __( 'Default value for the setting.', 'woocommerce' ),
|
|
'type' => 'string',
|
|
'context' => array( 'view', 'edit' ),
|
|
'readonly' => true,
|
|
),
|
|
'tip' => array(
|
|
'description' => __( 'Additional help text shown to the user about the setting.', 'woocommerce' ),
|
|
'type' => 'string',
|
|
'context' => array( 'view', 'edit' ),
|
|
'readonly' => true,
|
|
),
|
|
'placeholder' => array(
|
|
'description' => __( 'Placeholder text to be displayed in text inputs.', 'woocommerce' ),
|
|
'type' => 'string',
|
|
'context' => array( 'view', 'edit' ),
|
|
'readonly' => true,
|
|
),
|
|
),
|
|
),
|
|
),
|
|
);
|
|
|
|
return $this->add_additional_fields_schema( $schema );
|
|
}
|
|
|
|
/**
|
|
* Get any query params needed.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function get_collection_params() {
|
|
return array(
|
|
'context' => $this->get_context_param( array( 'default' => 'view' ) ),
|
|
);
|
|
}
|
|
|
|
}
|