initial commit
This commit is contained in:
327
packages/woocommerce-admin/src/API/NavigationFavorites.php
Normal file
327
packages/woocommerce-admin/src/API/NavigationFavorites.php
Normal file
@ -0,0 +1,327 @@
|
||||
<?php
|
||||
/**
|
||||
* REST API Navigation Favorites controller
|
||||
*
|
||||
* Handles requests to the navigation favorites endpoint
|
||||
*/
|
||||
|
||||
namespace Automattic\WooCommerce\Admin\API;
|
||||
|
||||
defined( 'ABSPATH' ) || exit;
|
||||
|
||||
use Automattic\WooCommerce\Admin\Features\Navigation\Favorites;
|
||||
|
||||
/**
|
||||
* REST API Favorites controller class.
|
||||
*
|
||||
* @extends WC_REST_CRUD_Controller
|
||||
*/
|
||||
class NavigationFavorites extends \WC_REST_Data_Controller {
|
||||
|
||||
/**
|
||||
* Endpoint namespace.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $namespace = 'wc-admin';
|
||||
|
||||
/**
|
||||
* Route base.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $rest_base = 'navigation/favorites';
|
||||
|
||||
/**
|
||||
* Error code to status code mapping.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $error_to_status_map = array(
|
||||
'woocommerce_favorites_invalid_request' => 400,
|
||||
'woocommerce_favorites_already_exists' => 409,
|
||||
'woocommerce_favorites_does_not_exist' => 404,
|
||||
'woocommerce_favorites_invalid_user' => 400,
|
||||
'woocommerce_favorites_unauthenticated' => 401,
|
||||
);
|
||||
|
||||
/**
|
||||
* Register the routes
|
||||
*/
|
||||
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' => array(
|
||||
'user_id' => array(
|
||||
'required' => true,
|
||||
'validate_callback' => function( $param, $request, $key ) {
|
||||
return is_numeric( $param );
|
||||
},
|
||||
),
|
||||
),
|
||||
),
|
||||
array(
|
||||
'methods' => \WP_REST_Server::CREATABLE,
|
||||
'callback' => array( $this, 'add_item' ),
|
||||
'permission_callback' => array( $this, 'add_item_permissions_check' ),
|
||||
'args' => array(
|
||||
'item_id' => array(
|
||||
'required' => true,
|
||||
),
|
||||
'user_id' => array(
|
||||
'required' => true,
|
||||
'validate_callback' => function( $param, $request, $key ) {
|
||||
return is_numeric( $param );
|
||||
},
|
||||
),
|
||||
),
|
||||
),
|
||||
array(
|
||||
'methods' => \WP_REST_Server::DELETABLE,
|
||||
'callback' => array( $this, 'delete_item' ),
|
||||
'permission_callback' => array( $this, 'delete_item_permissions_check' ),
|
||||
'args' => array(
|
||||
'item_id' => array(
|
||||
'required' => true,
|
||||
),
|
||||
'user_id' => array(
|
||||
'required' => true,
|
||||
'validate_callback' => function( $param, $request, $key ) {
|
||||
return is_numeric( $param );
|
||||
},
|
||||
),
|
||||
),
|
||||
),
|
||||
'schema' => array( $this, 'get_public_item_schema' ),
|
||||
)
|
||||
);
|
||||
|
||||
register_rest_route(
|
||||
$this->namespace,
|
||||
'/' . $this->rest_base . '/me',
|
||||
array(
|
||||
array(
|
||||
'methods' => \WP_REST_Server::READABLE,
|
||||
'callback' => array( $this, 'get_items_by_current_user' ),
|
||||
'permission_callback' => array( $this, 'current_user_permissions_check' ),
|
||||
),
|
||||
array(
|
||||
'methods' => \WP_REST_Server::CREATABLE,
|
||||
'callback' => array( $this, 'add_item_by_current_user' ),
|
||||
'permission_callback' => array( $this, 'current_user_permissions_check' ),
|
||||
'args' => array(
|
||||
'item_id' => array(
|
||||
'required' => true,
|
||||
),
|
||||
),
|
||||
),
|
||||
array(
|
||||
'methods' => \WP_REST_Server::DELETABLE,
|
||||
'callback' => array( $this, 'delete_item_by_current_user' ),
|
||||
'permission_callback' => array( $this, 'current_user_permissions_check' ),
|
||||
'args' => array(
|
||||
'item_id' => array(
|
||||
'required' => true,
|
||||
),
|
||||
),
|
||||
),
|
||||
'schema' => array( $this, 'get_public_item_schema' ),
|
||||
)
|
||||
);
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all favorites.
|
||||
*
|
||||
* @param WP_REST_Request $request Request data.
|
||||
* @return WP_REST_Response
|
||||
*/
|
||||
public function get_items( $request ) {
|
||||
$user_id = $request->get_param( 'user_id' );
|
||||
|
||||
$response = Favorites::get_all( $user_id );
|
||||
|
||||
if ( is_wp_error( $response ) || ! $response ) {
|
||||
return rest_ensure_response( $this->prepare_error( $response ) );
|
||||
}
|
||||
|
||||
return rest_ensure_response(
|
||||
array_map( 'stripslashes', $response )
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all favorites of current user.
|
||||
*
|
||||
* @param WP_REST_Request $request Request data.
|
||||
* @return WP_REST_Response
|
||||
*/
|
||||
public function get_items_by_current_user( $request ) {
|
||||
$current_user = get_current_user_id();
|
||||
|
||||
if ( ! $current_user ) {
|
||||
return $this->prepare_error(
|
||||
new \WP_Error(
|
||||
'woocommerce_favorites_unauthenticated',
|
||||
__( 'You must be authenticated to use this endpoint', 'woocommerce' )
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
$request->set_param( 'user_id', $current_user );
|
||||
|
||||
return $this->get_items( $request );
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a favorite.
|
||||
*
|
||||
* @param WP_REST_Request $request Request data.
|
||||
* @return WP_REST_Response
|
||||
*/
|
||||
public function add_item( $request ) {
|
||||
$user_id = $request->get_param( 'user_id' );
|
||||
$fav_id = $request->get_param( 'item_id' );
|
||||
$user = get_userdata( $user_id );
|
||||
|
||||
if ( false === $user ) {
|
||||
return $this->prepare_error(
|
||||
new \WP_Error(
|
||||
'woocommerce_favorites_invalid_user',
|
||||
__( 'Invalid user_id provided', 'woocommerce' )
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
$response = Favorites::add_item( $fav_id, $user_id );
|
||||
|
||||
if ( is_wp_error( $response ) || ! $response ) {
|
||||
return rest_ensure_response( $this->prepare_error( $response ) );
|
||||
}
|
||||
|
||||
return rest_ensure_response( Favorites::get_all( $user_id ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a favorite for current user.
|
||||
*
|
||||
* @param WP_REST_Request $request Request data.
|
||||
* @return WP_REST_Response
|
||||
*/
|
||||
public function add_item_by_current_user( $request ) {
|
||||
$current_user = get_current_user_id();
|
||||
|
||||
if ( ! $current_user ) {
|
||||
return $this->prepare_error(
|
||||
new \WP_Error(
|
||||
'woocommerce_favorites_unauthenticated',
|
||||
__( 'You must be authenticated to use this endpoint', 'woocommerce' )
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
$request->set_param( 'user_id', get_current_user_id() );
|
||||
return $this->add_item( $request );
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete a favorite.
|
||||
*
|
||||
* @param WP_REST_Request $request Request data.
|
||||
* @return WP_REST_Response
|
||||
*/
|
||||
public function delete_item( $request ) {
|
||||
$user_id = $request->get_param( 'user_id' );
|
||||
$fav_id = $request->get_param( 'item_id' );
|
||||
|
||||
$response = Favorites::remove_item( $fav_id, $user_id );
|
||||
|
||||
if ( is_wp_error( $response ) || ! $response ) {
|
||||
return rest_ensure_response( $this->prepare_error( $response ) );
|
||||
}
|
||||
|
||||
return rest_ensure_response( Favorites::get_all( $user_id ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete a favorite for current user.
|
||||
*
|
||||
* @param WP_REST_Request $request Request data.
|
||||
* @return WP_REST_Response
|
||||
*/
|
||||
public function delete_item_by_current_user( $request ) {
|
||||
$current_user = get_current_user_id();
|
||||
|
||||
if ( ! $current_user ) {
|
||||
return $this->prepare_error(
|
||||
new \WP_Error(
|
||||
'woocommerce_favorites_unauthenticated',
|
||||
__( 'You must be authenticated to use this endpoint', 'woocommerce' )
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
$request->set_param( 'user_id', $current_user );
|
||||
|
||||
return $this->delete_item( $request );
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Check whether a given request has permission to create favorites.
|
||||
*
|
||||
* @param WP_REST_Request $request Full details about the request.
|
||||
* @return WP_Error|boolean
|
||||
*/
|
||||
public function add_item_permissions_check( $request ) {
|
||||
return current_user_can( 'edit_users' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Check whether a given request has permission to delete notes.
|
||||
*
|
||||
* @param WP_REST_Request $request Full details about the request.
|
||||
* @return WP_Error|boolean
|
||||
*/
|
||||
public function delete_item_permissions_check( $request ) {
|
||||
return current_user_can( 'edit_users' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Always allow for operations that only impact current user
|
||||
*
|
||||
* @param WP_REST_Request $request Full details about the request.
|
||||
* @return WP_Error|boolean
|
||||
*/
|
||||
public function current_user_permissions_check( $request ) {
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Accept an instance of WP_Error and add the appropriate data for REST transit.
|
||||
*
|
||||
* @param WP_Error $error Error to prepare.
|
||||
* @return WP_Error
|
||||
*/
|
||||
protected function prepare_error( $error ) {
|
||||
if ( ! is_wp_error( $error ) ) {
|
||||
return $error;
|
||||
}
|
||||
|
||||
$error->add_data(
|
||||
array(
|
||||
'status' => $this->error_to_status_map[ $error->get_error_code() ] ?? 500,
|
||||
)
|
||||
);
|
||||
|
||||
return $error;
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user