274 lines
8.3 KiB
PHP
274 lines
8.3 KiB
PHP
|
<?php
|
||
|
|
/**
|
||
|
|
* REST API Product Reviews controller
|
||
|
|
*
|
||
|
|
* Handles requests to the /products/<product_id>/reviews endpoint.
|
||
|
|
*
|
||
|
|
* @author WooThemes
|
||
|
|
* @category API
|
||
|
|
* @package WooCommerce/API
|
||
|
|
* @since 2.6.0
|
||
|
|
*/
|
||
|
|
|
||
|
|
if ( ! defined( 'ABSPATH' ) ) {
|
||
|
|
exit;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* REST API Products controller class.
|
||
|
|
*
|
||
|
|
* @package WooCommerce/API
|
||
|
|
* @extends WP_REST_Controller
|
||
|
|
*/
|
||
|
|
class WC_REST_Product_Reviews_Controller extends WP_REST_Controller {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Endpoint namespace.
|
||
|
|
*
|
||
|
|
* @var string
|
||
|
|
*/
|
||
|
|
public $namespace = 'wc/v1';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Route base.
|
||
|
|
*
|
||
|
|
* @var string
|
||
|
|
*/
|
||
|
|
protected $rest_base = 'products/(?P<product_id>[\d]+)/reviews';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Register the routes for product reviews.
|
||
|
|
*/
|
||
|
|
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>[\d]+)', array(
|
||
|
|
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' ) ),
|
||
|
|
),
|
||
|
|
),
|
||
|
|
'schema' => array( $this, 'get_public_item_schema' ),
|
||
|
|
) );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Check whether a given request has permission to read webhook deliveries.
|
||
|
|
*
|
||
|
|
* @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_post_permissions( 'product', '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 webhook develivery.
|
||
|
|
*
|
||
|
|
* @param WP_REST_Request $request Full details about the request.
|
||
|
|
* @return WP_Error|boolean
|
||
|
|
*/
|
||
|
|
public function get_item_permissions_check( $request ) {
|
||
|
|
$post = get_post( (int) $request['product_id'] );
|
||
|
|
|
||
|
|
if ( $post && ! wc_rest_check_post_permissions( 'product', 'read', $post->ID ) ) {
|
||
|
|
return new WP_Error( 'woocommerce_rest_cannot_view', __( 'Sorry, you cannot view this resource.', 'woocommerce' ), array( 'status' => rest_authorization_required_code() ) );
|
||
|
|
}
|
||
|
|
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get all reviews from a product.
|
||
|
|
*
|
||
|
|
* @param WP_REST_Request $request
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
public function get_items( $request ) {
|
||
|
|
$product = get_post( (int) $request['product_id'] );
|
||
|
|
|
||
|
|
if ( empty( $product->post_type ) || 'product' !== $product->post_type ) {
|
||
|
|
return new WP_Error( 'woocommerce_rest_product_invalid_id', __( 'Invalid product id.', 'woocommerce' ), array( 'status' => 404 ) );
|
||
|
|
}
|
||
|
|
|
||
|
|
$reviews = get_approved_comments( $product->ID );
|
||
|
|
|
||
|
|
$data = array();
|
||
|
|
foreach ( $reviews as $review_data ) {
|
||
|
|
$review = $this->prepare_item_for_response( $review_data, $request );
|
||
|
|
$review = $this->prepare_response_for_collection( $review );
|
||
|
|
$data[] = $review;
|
||
|
|
}
|
||
|
|
|
||
|
|
return rest_ensure_response( $data );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get a single product review.
|
||
|
|
*
|
||
|
|
* @param WP_REST_Request $request Full details about the request.
|
||
|
|
* @return WP_Error|WP_REST_Response
|
||
|
|
*/
|
||
|
|
public function get_item( $request ) {
|
||
|
|
$id = (int) $request['id'];
|
||
|
|
$product = get_post( (int) $request['product_id'] );
|
||
|
|
|
||
|
|
if ( empty( $product->post_type ) || 'product' !== $product->post_type ) {
|
||
|
|
return new WP_Error( 'woocommerce_rest_product_invalid_id', __( 'Invalid product id.', 'woocommerce' ), array( 'status' => 404 ) );
|
||
|
|
}
|
||
|
|
|
||
|
|
$review = get_comment( $id );
|
||
|
|
|
||
|
|
if ( empty( $id ) || empty( $review ) || intval( $review->comment_post_ID ) !== intval( $product->ID ) ) {
|
||
|
|
return new WP_Error( 'woocommerce_rest_invalid_id', __( 'Invalid resource id.', 'woocommerce' ), array( 'status' => 404 ) );
|
||
|
|
}
|
||
|
|
|
||
|
|
$delivery = $this->prepare_item_for_response( $review, $request );
|
||
|
|
$response = rest_ensure_response( $delivery );
|
||
|
|
|
||
|
|
return $response;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Prepare a single product review output for response.
|
||
|
|
*
|
||
|
|
* @param WP_Comment $review Product review object.
|
||
|
|
* @param WP_REST_Request $request Request object.
|
||
|
|
* @return WP_REST_Response $response Response data.
|
||
|
|
*/
|
||
|
|
public function prepare_item_for_response( $review, $request ) {
|
||
|
|
$data = array(
|
||
|
|
'id' => (int) $review->comment_ID,
|
||
|
|
'date_created' => wc_rest_prepare_date_response( $review->comment_date_gmt ),
|
||
|
|
'review' => $review->comment_content,
|
||
|
|
'rating' => get_comment_meta( $review->comment_ID, 'rating', true ),
|
||
|
|
'reviewer_name' => $review->comment_author,
|
||
|
|
'reviewer_email' => $review->comment_author_email,
|
||
|
|
'verified' => wc_review_is_from_verified_owner( $review->comment_ID ),
|
||
|
|
);
|
||
|
|
|
||
|
|
$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
|
||
|
|
$data = $this->add_additional_fields_to_object( $data, $request );
|
||
|
|
$data = $this->filter_response_by_context( $data, $context );
|
||
|
|
|
||
|
|
// Wrap the data in a response object.
|
||
|
|
$response = rest_ensure_response( $data );
|
||
|
|
|
||
|
|
$response->add_links( $this->prepare_links( $review, $request ) );
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Filter webhook delivery object returned from the REST API.
|
||
|
|
*
|
||
|
|
* @param WP_REST_Response $response The response object.
|
||
|
|
* @param WP_Comment $review Product review object used to create response.
|
||
|
|
* @param WP_REST_Request $request Request object.
|
||
|
|
*/
|
||
|
|
return apply_filters( 'woocommerce_rest_prepare_product_review', $response, $review, $request );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Prepare links for the request.
|
||
|
|
*
|
||
|
|
* @param WP_Comment $review Product review object.
|
||
|
|
* @param WP_REST_Request $request Request object.
|
||
|
|
* @return array Links for the given product review.
|
||
|
|
*/
|
||
|
|
protected function prepare_links( $review, $request ) {
|
||
|
|
$product_id = (int) $request['product_id'];
|
||
|
|
$base = str_replace( '(?P<product_id>[\d]+)', $product_id, $this->rest_base );
|
||
|
|
|
||
|
|
$links = array(
|
||
|
|
'self' => array(
|
||
|
|
'href' => rest_url( sprintf( '/%s/%s/%d', $this->namespace, $base, $review->comment_ID ) ),
|
||
|
|
),
|
||
|
|
'collection' => array(
|
||
|
|
'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $base ) ),
|
||
|
|
),
|
||
|
|
'up' => array(
|
||
|
|
'href' => rest_url( sprintf( '/%s/products/%d', $this->namespace, $product_id ) ),
|
||
|
|
),
|
||
|
|
);
|
||
|
|
|
||
|
|
return $links;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the Product Review's schema, conforming to JSON Schema.
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
public function get_item_schema() {
|
||
|
|
$schema = array(
|
||
|
|
'$schema' => 'http://json-schema.org/draft-04/schema#',
|
||
|
|
'title' => 'product_review',
|
||
|
|
'type' => 'object',
|
||
|
|
'properties' => array(
|
||
|
|
'id' => array(
|
||
|
|
'description' => __( 'Unique identifier for the resource.', 'woocommerce' ),
|
||
|
|
'type' => 'integer',
|
||
|
|
'context' => array( 'view' ),
|
||
|
|
'readonly' => true,
|
||
|
|
),
|
||
|
|
'date_created' => array(
|
||
|
|
'description' => __( "The date the review was created, in the site's timezone.", 'woocommerce' ),
|
||
|
|
'type' => 'date-time',
|
||
|
|
'context' => array( 'view', 'edit' ),
|
||
|
|
'readonly' => true,
|
||
|
|
),
|
||
|
|
'rating' => array(
|
||
|
|
'description' => __( 'Review rating (0 to 5).', 'woocommerce' ),
|
||
|
|
'type' => 'string',
|
||
|
|
'context' => array( 'view' ),
|
||
|
|
'readonly' => true,
|
||
|
|
),
|
||
|
|
'reviewer_name' => array(
|
||
|
|
'description' => __( 'Reviewer name.', 'woocommerce' ),
|
||
|
|
'type' => 'string',
|
||
|
|
'context' => array( 'view' ),
|
||
|
|
'readonly' => true,
|
||
|
|
),
|
||
|
|
'reviewer_email' => array(
|
||
|
|
'description' => __( 'Reviewer email.', 'woocommerce' ),
|
||
|
|
'type' => 'string',
|
||
|
|
'context' => array( 'view' ),
|
||
|
|
'readonly' => true,
|
||
|
|
),
|
||
|
|
'verified' => array(
|
||
|
|
'description' => __( 'Shows if the reviewer bought the product or not.', 'woocommerce' ),
|
||
|
|
'type' => 'boolean',
|
||
|
|
'context' => array( 'view' ),
|
||
|
|
'readonly' => true,
|
||
|
|
),
|
||
|
|
),
|
||
|
|
);
|
||
|
|
|
||
|
|
return $this->add_additional_fields_schema( $schema );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the query params for collections.
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
public function get_collection_params() {
|
||
|
|
return array(
|
||
|
|
'context' => $this->get_context_param( array( 'default' => 'view' ) ),
|
||
|
|
);
|
||
|
|
}
|
||
|
|
}
|