JezK

Edit File: StoreController.php

<?php

namespace WeDevs\Dokan\REST;

use WeDevs\Dokan\Traits\VendorAuthorizable;
use WeDevs\Dokan\Vendor\Vendor;
use WP_Error;
use WP_Query;
use WP_REST_Controller;
use WP_REST_Request;
use WP_REST_Response;
use WP_REST_Server;

/**
 * Store API Controller
 *
 * @package dokan
 *
 * @author weDevs <info@wedevs.com>
 */
class StoreController extends WP_REST_Controller {
    use VendorAuthorizable;

/**
     * Endpoint namespace
     *
     * @var string
     */
    protected $namespace = 'dokan/v1';

/**
     * Route name
     *
     * @var string
     */
    protected $base = 'stores';

/**
     * Register all routes releated with stores
     *
     * @return void
     */
    public function register_routes() {
        register_rest_route(
            $this->namespace, '/' . $this->base, [
                [
                    'methods'             => WP_REST_Server::READABLE,
                    'callback'            => [ $this, 'get_stores' ],
                    'args'                => apply_filters( 'dokan_rest_api_store_collection_params', $this->get_store_collection_params() ),
                    'permission_callback' => '__return_true',
                ],
                [
                    'methods'             => WP_REST_Server::CREATABLE,
                    'callback'            => [ $this, 'create_store' ],
                    'permission_callback' => [ $this, 'permission_check_for_manageable_part' ],
                ],
            ]
        );

register_rest_route(
            $this->namespace, '/' . $this->base . '/(?P<id>[\d]+)', [
                'args' => [
                    'id' => [
                        'description'       => __( 'Unique identifier for the object.', 'dokan-lite' ),
                        'type'              => 'integer',
                        'sanitize_callback' => 'absint',
                        'validate_callback' => [ $this, 'validate_store_id' ],
                    ],
                ],
                [
                    'methods'             => WP_REST_Server::READABLE,
                    'callback'            => [ $this, 'get_store' ],
                    'permission_callback' => '__return_true',
                ],
                [
                    'methods'             => WP_REST_Server::DELETABLE,
                    'callback'            => [ $this, 'delete_store' ],
                    'permission_callback' => [ $this, 'permission_check_for_manageable_part' ],
                    'args'                => [
                        'reassign' => [
                            'type'        => 'integer',
                            'description' => __( 'Reassign the deleted user\'s posts and links to this user ID.', 'dokan-lite' ),
                            'required'    => true,
                        ],
                    ],
                ],
                [
                    'methods'             => WP_REST_Server::EDITABLE,
                    'callback'            => [ $this, 'update_store' ],
                    'permission_callback' => [ $this, 'update_store_permissions_check' ],
                    'args'                => $this->get_store_update_params(),
                ],
            ]
        );

register_rest_route(
            $this->namespace, '/' . $this->base . '/(?P<id>[\d]+)/products', [
                'args' => [
                    'id' => [
                        'description' => __( 'Unique identifier for the object.', 'dokan-lite' ),
                        'type'        => 'integer',
                    ],
                ],
                [
                    'methods'             => WP_REST_Server::READABLE,
                    'callback'            => [ $this, 'get_store_products' ],
                    'args'                => $this->get_collection_params(),
                    'permission_callback' => '__return_true',
                ],
            ]
        );

register_rest_route(
            $this->namespace, '/' . $this->base . '/(?P<id>[\d]+)/reviews', [
                'args' => [
                    'id' => [
                        'description' => __( 'Unique identifier for the object.', 'dokan-lite' ),
                        'type'        => 'integer',
                    ],
                ],
                [
                    'methods'             => WP_REST_Server::READABLE,
                    'callback'            => [ $this, 'get_store_reviews' ],
                    'args'                => $this->get_collection_params(),
                    'permission_callback' => '__return_true',
                ],
            ]
        );

register_rest_route(
            $this->namespace, '/' . $this->base . '/check', [
                [
                    'methods'             => WP_REST_Server::READABLE,
                    'callback'            => [ $this, 'check_store_availability' ],
                    'permission_callback' => '__return_true',
                ],
            ]
        );

register_rest_route(
            $this->namespace, '/' . $this->base . '/(?P<id>[\d]+)/contact', [
                'args' => [
                    'id' => [
                        'description' => __( 'Unique identifier for the object.', 'dokan-lite' ),
                        'type'        => 'integer',
                    ],
                ],
                [
                    'methods'             => WP_REST_Server::CREATABLE,
                    'callback'            => [ $this, 'send_email' ],
                    'args'                => [
                        'name'    => [
                            'type'        => 'string',
                            'description' => __( 'Your Name', 'dokan-lite' ),
                            'required'    => true,
                        ],
                        'email'   => [
                            'type'        => 'string',
                            'format'      => 'email',
                            'description' => __( 'Your email', 'dokan-lite' ),
                            'required'    => true,
                        ],
                        'message' => [
                            'type'        => 'string',
                            'description' => __( 'Your Message', 'dokan-lite' ),
                            'required'    => true,
                        ],
                    ],
                    'permission_callback' => '__return_true',
                ],
            ]
        );

register_rest_route(
            $this->namespace, '/' . $this->base . '/(?P<id>[\d]+)/status', [
                'args' => [
                    'id'     => [
                        'description' => __( 'Unique identifier for the object.', 'dokan-lite' ),
                        'type'        => 'integer',
                        'required'    => true,
                    ],
                    'status' => [
                        'description' => __( 'Status for the store object.', 'dokan-lite' ),
                        'type'        => 'string',
                        'required'    => true,
                    ],
                ],
                [
                    'methods'             => WP_REST_Server::EDITABLE,
                    'callback'            => [ $this, 'update_vendor_status' ],
                    'permission_callback' => [ $this, 'permission_check_for_manageable_part' ],
                ],
            ]
        );

register_rest_route(
            $this->namespace, '/' . $this->base . '/batch', [
                [
                    'methods'             => WP_REST_Server::EDITABLE,
                    'callback'            => [ $this, 'batch_update' ],
                    'permission_callback' => [ $this, 'permission_check_for_manageable_part' ],
                ],
            ]
        );

register_rest_route(
            $this->namespace, '/' . $this->base . '/(?P<id>[\d]+)/categories', [
                'args' => [
                    'id' => [
                        'description' => __( 'Unique identifier for the object.', 'dokan-lite' ),
                        'type'        => 'integer',
                    ],
                    'best_selling' => [
                        'description' => __( 'Get Best Selling Products Category.', 'dokan-lite' ),
                        'type'        => 'boolean',
                        'default'     => false,
                        'required'    => false,
                    ],
                ],
                [
                    'methods'             => WP_REST_Server::READABLE,
                    'callback'            => [ $this, 'get_store_category' ],
                    'permission_callback' => '__return_true',
                ],
            ]
        );
    }

/**
     * Get stores
     *
     * @since 1.0.0
     *
     * @param $request
     *
     * @return object|WP_Error|WP_REST_Response
     */
    public function get_stores( $request ) {
        $params = $request->get_params();

$args = [
            'number' => (int) $params['per_page'],
            'offset' => (int) ( $params['page'] - 1 ) * $params['per_page'],
            'status' => 'all',
        ];

// To avoid args overriding, we are settings filter here. Then setting args changed from parameter.
        $args = apply_filters( 'dokan_seller_listing_args', $args, $request );

if ( ! empty( $params['search'] ) ) {
            $args['search']         = '*' . sanitize_text_field( ( $params['search'] ) ) . '*';
            $args['search_columns'] = [ 'user_login', 'user_email', 'display_name', 'user_nicename' ];
        }

if ( ! empty( $params['status'] ) ) {
            $args['status'] = sanitize_text_field( $params['status'] );
        }

if ( ! empty( $params['orderby'] ) ) {
            $args['orderby'] = sanitize_sql_orderby( $params['orderby'] );
        }

if ( ! empty( $params['order'] ) ) {
            $args['order'] = sanitize_text_field( $params['order'] );
        }

if ( ! empty( $params['featured'] ) ) {
            $args['featured'] = sanitize_text_field( $params['featured'] );
        }

$args = apply_filters( 'dokan_rest_get_stores_args', $args, $request );

$stores = dokan()->vendor->get_vendors( $args );

$search_text = isset( $params['search'] ) ? sanitize_text_field( $params['search'] ) : '';

// if no stores found in then we are searching again with meta value. here need to remove search and search_columns, because with this args meta_query is not working
        if ( ! count( $stores ) && ! empty( $search_text ) ) {
            unset( $args['search'] );
            unset( $args['search_columns'] );

$args['meta_query'] = [ // phpcs:ignore
                [
                    'key'     => 'dokan_store_name',
                    'value'   => $search_text,
                    'compare' => 'LIKE',
                ],
            ];

$stores = dokan()->vendor->get_vendors( $args );
        }

$data_objects = [];

foreach ( $stores as $store ) {
            $stores_data    = $this->prepare_item_for_response( $store, $request );
            $data_objects[] = $this->prepare_response_for_collection( $stores_data );
        }

$response = rest_ensure_response( $data_objects );
        $response = $this->format_collection_response( $response, $request, dokan()->vendor->get_total() );

return $response;
    }

/**
     * Get singe store
     *
     * Public endpoint: Returns public data for all users/guests (respecting admin settings).
     * Sensitive data is only returned for authorized users (vendor, vendor staff, or admin).
     *
     * For vendor staff accessing via their own ID, the vendor ID is resolved to show their vendor's store.
     * Vendors and vendor staff attempting to access another vendor's store will be blocked (403).
     *
     * @since 1.0.0
     *
     * @param $request
     *
     * @return WP_Error|WP_REST_Response
     */
    public function get_store( $request ) {
        $requested_id = absint( $request->get_param( 'id' ) );

$store_id = $this->get_vendor_id_for_user( $requested_id );
		$store = dokan()->vendor->get( $store_id );

if ( ! $store || ! $store->get_id() ) {
            return new WP_Error(
                'dokan_rest_store_not_found',
                __( 'Store not found.', 'dokan-lite' ),
                [ 'status' => 404 ]
            );
        }

$stores_data = $this->prepare_item_for_response( $store, $request );
        $response    = rest_ensure_response( $stores_data );

return $response;
    }

/**
     * Delete store
     *
     * @since 2.8.0
     *
     * @param $request
     *
     * @return WP_Error|WP_REST_Response
     */
    public function delete_store( $request ) {
        $store_id = $request['id'];
        $reassign = false === $request['reassign'] ? null : absint( $request['reassign'] );

if ( ! empty( $reassign ) ) {
            if ( $reassign === $store_id || ! get_userdata( $reassign ) ) {
                return new WP_Error( 'rest_user_invalid_reassign', __( 'Invalid user ID for reassignment.', 'dokan-lite' ), [ 'status' => 400 ] );
            }
        }

$vendor   = dokan()->vendor->delete( $store_id, $reassign );
        $response = rest_ensure_response( $vendor );
        $response->add_links( $this->prepare_links( $vendor, $request ) );

return $response;
    }

/**
     * Update store permission check method
     *
     * @param $request
     *
     * @since 2.9.2
     *
     * @return bool
     */
    public function update_store_permissions_check( $request ) {
        $requested_id = absint( $request->get_param( 'id' ) );

// Resolve vendor ID: handles both vendor IDs and vendor staff IDs
        $store_id = $this->get_vendor_id_for_user( $requested_id );

return $this->can_access_vendor_store( $store_id );
    }

/**
     * Update Store
     *
     * @since 2.9.2
     *
     * @param WP_REST_Request $request
     *
     * @return WP_Error|WP_REST_Response
     */
    public function update_store( $request ) {
        $requested_id = absint( $request->get_param( 'id' ) );

// Resolve vendor ID: handles both vendor IDs and vendor staff IDs
        $store_id = $this->get_vendor_id_for_user( $requested_id );

if ( ! $store_id ) {
            return new WP_Error(
                'dokan_rest_store_not_found',
                __( 'Store not found.', 'dokan-lite' ),
                [ 'status' => 404 ]
            );
        }

$store = dokan()->vendor->get( $store_id );

if ( ! $store || ! $store->get_id() ) {
            return new WP_Error(
                'dokan_rest_store_not_found',
                __( 'Store not found.', 'dokan-lite' ),
                [ 'status' => 404 ]
            );
        }
        if ( ! $this->can_access_vendor_store( $store->get_id() ) ) {
            return new WP_Error(
                'dokan_rest_store_cannot_access',
                __( 'You do not have permission to access this store.', 'dokan-lite' ),
                [ 'status' => 403 ]
            );
        }

$params = $request->get_params();

$restricted_fields = $this->get_restricted_fields_for_update( $store, $request );

foreach ( $restricted_fields as $field ) {
			if ( isset( $params[ $field ] ) ) {
				unset( $params[ $field ] );
			}
		}

$updated_store_id = dokan()->vendor->update( $store->get_id(), $params );

if ( is_wp_error( $updated_store_id ) ) {
            return new WP_Error( $updated_store_id->get_error_code(), $updated_store_id->get_error_message() );
        }

$store = dokan()->vendor->get( $updated_store_id );

do_action( 'dokan_rest_stores_update_store', $store, $request );

$stores_data = $this->prepare_item_for_response( $store, $request );
        $response    = rest_ensure_response( $stores_data );

return $response;
    }

/**
     * Get restricted fields for store update based on user role.
     *
     * @since 4.2.5
     *
     * @param \WeDevs\Dokan\Vendor\Vendor $store Store object.
     * @param \WP_REST_Request $request Request object.
     *
     * @return array Array of restricted field names.
     */
    protected function get_restricted_fields_for_update( $store, $request ) {
        $is_admin = current_user_can( 'manage_options' );
        $is_vendor = dokan_is_user_seller( get_current_user_id(), true );
        $restricted_fields = [];

if ( ! $is_admin && ! $is_vendor ) {
            $staff_restricted_fields = [
                'email',
                'password',
            ];
            array_push( $restricted_fields, ...$staff_restricted_fields );
        }

if ( ! $is_admin ) {
            $vendor_restricted_fields = [
                'dokan_admin_percentage',
                'dokan_admin_percentage_type',
                'dokan_admin_additional_fee',
                'admin_category_commission',
            ];

array_push( $restricted_fields, ...$vendor_restricted_fields );
        }

return apply_filters( 'dokan_rest_store_restricted_fields_for_update', $restricted_fields, $store, $request );
    }

/**
     * Create store
     *
     * @param $request
     *
     * @return WP_Error|WP_REST_Response
     */
    public function create_store( $request ) {
        $params = $request->get_params();

$store = dokan()->vendor->create( $params );

if ( is_wp_error( $store ) ) {
            return new WP_Error( $store->get_error_code(), $store->get_error_message() );
        }

do_action( 'dokan_rest_stores_create_store', $store, $request );

$stores_data = $this->prepare_item_for_response( $store, $request );
        $response    = rest_ensure_response( $stores_data );

return $response;
    }

/**
     * Undocumented function
     *
     * @since 1.0.0
     *
     * @return bool
     */
    public function permission_check_for_manageable_part() {
        return current_user_can( 'manage_woocommerce' );
    }

/**
     * Prepare links for the request.
     *
     * @param \WC_Data        $data    Object data.
     * @param WP_REST_Request $request Request object.
     *
     * @return array                   Links for the given post.
     */
    protected function prepare_links( $data, $request ) {
        $links = [
            'self'       => [
                'href' => rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->base, $data['id'] ) ),
            ],
            'collection' => [
                'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->base ) ),
            ],
        ];

return $links;
    }

/**
     * Format item's collection for response
     *
     * @param object $response
     * @param object $request
     * @param int $total_items
     *
     * @return object
     */
    public function format_collection_response( $response, $request, $total_items ) {
        // Store pagination values for headers then unset for count query.
        $per_page  = (int) ( ! empty( $request['per_page'] ) ? $request['per_page'] : 20 );
        $page      = (int) ( ! empty( $request['page'] ) ? $request['page'] : 1 );
        $max_pages = ceil( $total_items / $per_page );

if ( function_exists( 'dokan_get_seller_status_count' ) && current_user_can( 'manage_woocommerce' ) ) {
            $counts = dokan_get_seller_status_count();
            $response->header( 'X-Status-Pending', (int) $counts['inactive'] );
            $response->header( 'X-Status-Approved', (int) $counts['active'] );
            $response->header( 'X-Status-All', (int) $counts['total'] );
        }

$response->header( 'X-WP-Total', (int) $total_items );
        $response->header( 'X-WP-TotalPages', (int) $max_pages );

if ( $total_items === 0 ) {
            return $response;
        }

$base = add_query_arg( $request->get_query_params(), rest_url( sprintf( '/%s/%s', $this->namespace, $this->base ) ) );

if ( $page > 1 ) {
            $prev_page = $page - 1;

if ( $prev_page > $max_pages ) {
                $prev_page = $max_pages;
            }

$prev_link = add_query_arg( 'page', $prev_page, $base );
            $response->link_header( 'prev', $prev_link );
        }

if ( $max_pages > $page ) {
            $next_page = $page + 1;
            $next_link = add_query_arg( 'page', $next_page, $base );
            $response->link_header( 'next', $next_link );
        }

return $response;
    }

/**
     * Get store Products
     *
     * @param WP_REST_Request|array $request
     *
     * @return WP_Error|WP_REST_Response
     */
    public function get_store_products( $request ) {
        $product_controller = new ProductController();

$request->set_param( 'status', [ 'publish' ] );
        $request->set_param( 'author', $request['id'] );
        $request->set_param( 'per_page', $request['per_page'] );
        $request->set_param( 'paged', $request['page'] );

$response = $product_controller->get_items( $request );

return $response;
    }

/**
     * Get store reviews
     *
     * @since 2.8.0
     *
     * @return object|WP_Error|WP_REST_Response
     */
    public function get_store_reviews( $request ) {
        $params = $request->get_params();

$store_id = (int) $params['id'];

if ( empty( $store_id ) ) {
            return new WP_Error( 'no_store_found', __( 'No store found', 'dokan-lite' ), [ 'status' => 404 ] );
        }

if ( dokan()->is_pro_exists() ) {
            if ( dokan_pro()->module->is_active( 'store_reviews' ) ) {
                $args = [
                    'post_type'      => 'dokan_store_reviews',
                    'meta_key'       => 'store_id', //phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key
                    'meta_value'     => $store_id, //phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_value
                    'post_status'    => 'publish',
                    'posts_per_page' => (int) $request['per_page'],
                    'paged'          => (int) $request['page'],
                    'author__not_in' => [ get_current_user_id(), $store_id ],
                ];

$query = new WP_Query( $args );

if ( empty( $query->posts ) ) {
                    return new WP_Error( 'no_reviews_found', __( 'No reviews found', 'dokan-lite' ), [ 'status' => 404 ] );
                }

$data = [];

foreach ( $query->posts as $post ) {
                    $data[] = $this->prepare_reviews_for_response( $post, $request );
                }

$total_count = $query->found_posts;
            } else {
                $dokan_template_reviews = dokan_pro()->review;
                $post_type              = 'product';
                $limit                  = (int) $params['per_page'];
                $paged                  = (int) ( $params['page'] - 1 ) * $params['per_page'];
                $status                 = '1';
                $comments               = $dokan_template_reviews->comment_query( $store_id, $post_type, $limit, $status, $paged );

if ( empty( $comments ) ) {
                    return new WP_Error( 'no_reviews_found', __( 'No reviews found', 'dokan-lite' ), [ 'status' => 404 ] );
                }

$data = [];

foreach ( $comments as $comment ) {
                    $data[] = $this->prepare_reviews_for_response( $comment, $request );
                }

$total_count = $this->get_total_review_count( $store_id, $post_type, $status );
            }
        }

$response = rest_ensure_response( $data );
        $response = $this->format_collection_response( $response, $request, $total_count );

return $response;
    }

/**
     * Get total counting for store review
     *
     * @param integer $id [hold store id]
     * @param string $post_type
     * @param string $status
     *
     * @since 2.8.0
     *
     * @return integer
     */
    public function get_total_review_count( $id, $post_type, $status ) {
        global $wpdb;

$total = $wpdb->get_var(
            $wpdb->prepare(
                "SELECT COUNT(*)
            FROM $wpdb->comments, $wpdb->posts
            WHERE $wpdb->posts.post_author=%d AND
            $wpdb->posts.post_status='publish' AND
            $wpdb->comments.comment_post_ID=$wpdb->posts.ID AND
            $wpdb->comments.comment_approved=%s AND
            $wpdb->posts.post_type=%s", $id, $status, $post_type
            )
        );

return intval( $total );
    }

/**
     * Prepare a single user output for response
     *
     * Public data is returned for all users/guests (respecting admin settings for hiding vendor info).
     * Sensitive data is only returned for authorized users (vendor, vendor staff, or admin).
     *
     * @param Vendor $store
     * @param WP_REST_Request $request Request object.
     * @param array $additional_fields (optional)
     * @param bool $is_authorized (optional) Whether the current user is authorized to view sensitive data.
     *
     * @return WP_REST_Response $response Response data.
     */
    public function prepare_item_for_response( $store, $request, $additional_fields = [] ) {
        $data = $store->to_array();

$is_authorized = $this->can_access_vendor_store( $store->get_id() );

if ( $is_authorized ) {
            $dashboard    = dokan_get_container()->get( 'dashboard' );
            $methods_data = $dashboard->templates->settings->get_seller_payment_methods( $store->get_id() ) ?? [];

$data['admin_category_commission']    = $store->get_commission_settings()->get_category_commissions();
            $data['admin_commission']             = $store->get_commission_settings()->get_percentage();
            $data['admin_additional_fee']         = $store->get_commission_settings()->get_flat();
            $data['admin_commission_type']        = $store->get_commission_settings()->get_type();
            $data['bank_payment_required_fields'] = dokan_bank_payment_required_fields();
            $data['active_payment_methods']       = $methods_data['active_methods'] ?? [];
            $data['connected_methods']            = $methods_data['connected_methods'] ?? [];
            $data['disconnected_methods']         = $methods_data['disconnected_methods'] ?? [];
            $data['withdraw_options']             = dokan_withdraw_get_methods();
            $data['fields_placeholders']          = dokan_bank_payment_fields_placeholders();
            $data['chargeable_methods']           = dokan_withdraw_get_chargeable_methods();
        }

$restricted_fields = $this->get_restricted_fields_for_view( $store, $request );

foreach ( $restricted_fields as $field ) {
            unset( $data[ $field ] );
        }

$data     = array_merge( $data, apply_filters( 'dokan_rest_store_additional_fields', $additional_fields, $store, $request, $is_authorized ) );
        $response = rest_ensure_response( $data );
        $response->add_links( $this->prepare_links( $data, $request ) );

return apply_filters( 'dokan_rest_prepare_store_item_for_response', $response );
    }

/**
     * Get restricted fields for store view based on user authorization.
     *
     * Determines which fields should be hidden from the store data response based on:
     * - User authorization status (authorized users see more data)
     * - User role (vendor staff cannot see admin commission data)
     * - Admin settings (for hiding vendor info like address, phone, email)
     * - Vendor preferences (vendor can choose to hide email)
     *
     * @since 4.2.5
     *
     * @param \WeDevs\Dokan\Vendor\Vendor $store Store object.
     * @param \WP_REST_Request $request Request object.
     *
     * @return array Array of restricted field names that should be removed from the response.
     */
    protected function get_restricted_fields_for_view( $store, $request ) {
        $restricted_fields = [];

$is_authorized = $this->can_access_vendor_store( $store->get_id() );

$is_admin = current_user_can( 'manage_options' );

// Restrict admin commission fields for all except admins and vendor only
        if ( ! $is_admin && ! dokan_is_user_seller( get_current_user_id(), true ) ) {
            $restricted_fields[] = 'admin_category_commission';
            $restricted_fields[] = 'admin_commission';
            $restricted_fields[] = 'admin_additional_fee';
            $restricted_fields[] = 'admin_commission_type';
        }

// Additional restrictions for unauthorized users (public access)
        if ( ! $is_authorized ) {
            // Respect admin settings for hiding vendor info
            if ( dokan_is_vendor_info_hidden( 'address' ) ) {
                $restricted_fields[] = 'address';
            }

if ( dokan_is_vendor_info_hidden( 'phone' ) ) {
                $restricted_fields[] = 'phone';
            }

// Hide email if admin setting hides it OR vendor doesn't want to show it
            if ( dokan_is_vendor_info_hidden( 'email' ) || ! $store->show_email() ) {
                $restricted_fields[] = 'email';
            }

// Always hide sensitive payment and store status data from public
            $restricted_fields[] = 'payment';
            $restricted_fields[] = 'enabled';
        }

return apply_filters( 'dokan_rest_store_restricted_fields_for_view', $restricted_fields, $store, $request );
    }

/**
     * Prepare a single user output for response
     *
     * @param object $item
     * @param WP_REST_Request $request Request object.
     * @param array $additional_fields (optional)
     *
     * @return array $response Response data.
     */
    public function prepare_reviews_for_response( $item, $request, $additional_fields = [] ) {
        if ( dokan()->is_pro_exists() && dokan_pro()->module->is_active( 'store_reviews' ) ) {
            $user          = get_user_by( 'id', $item->post_author );
            $user_gravatar = get_avatar_url( $user->user_email );

$data = [
                'id'         => (int) $item->ID,
                'author'     => [
                    'id'     => $user->ID,
                    'name'   => $user->display_name,
                    'url'    => $user->user_url,
                    'avatar' => $user_gravatar,
                ],
                'title'      => $item->post_title,
                'content'    => $item->post_content,
                'permalink'  => null,
                'product_id' => null,
                'approved'   => true,
                'date'       => mysql_to_rfc3339( $item->post_date ),
                'rating'     => intval( get_post_meta( $item->ID, 'rating', true ) ),
            ];
        } else {
            $comment_author_img_url = get_avatar_url( $item->comment_author_email );
            $data                   = [
                'id'         => (int) $item->comment_ID,
                'author'     => [
                    'id'     => $item->user_id,
                    'name'   => $item->comment_author,
                    'url'    => $item->comment_author_url,
                    'avatar' => $comment_author_img_url,
                ],
                'title'      => null,
                'content'    => $item->comment_content,
                'permalink'  => get_comment_link( $item ),
                'product_id' => $item->comment_post_ID,
                'approved'   => (bool) $item->comment_approved,
                'date'       => mysql_to_rfc3339( $item->comment_date ),
                'rating'     => intval( get_comment_meta( $item->comment_ID, 'rating', true ) ),
            ];
        }

$data = array_merge( $data, $additional_fields );

return $data;
    }

/**
     * Check store availability
     *
     * @param WP_REST_Request $request
     *
     * @since 2.9.13
     *
     * @return WP_REST_Response
     */
    public function check_store_availability( $request ) {
        $params = $request->get_params();

// check whether store name is available or not
        if ( ! empty( $params['store_slug'] ) ) {
            $store_slug = sanitize_text_field( $params['store_slug'] );

if ( get_user_by( 'slug', $store_slug ) ) {
                $response = [
                    'url'       => $store_slug,
                    'available' => false,
                ];

return rest_ensure_response( $response );
            }

$response = [
                'url'       => sanitize_title( $store_slug ),
                'available' => true,
            ];

return rest_ensure_response( $response );
        }

// check whether username is available or not
        if ( ! empty( $params['username'] ) ) {
            $username = sanitize_user( $params['username'] );

if ( get_user_by( 'login', $username ) ) {
                $response = [
                    'username'  => $username,
                    'available' => false,
                ];

return rest_ensure_response( $response );
            }

$response = [
                'username'  => $username,
                'available' => true,
            ];

return rest_ensure_response( $response );
        }

// check whether email is available or not
        if ( ! empty( $params['email'] ) ) {
            $user_email = $params['email'];

if ( ! is_email( $user_email ) ) {
                $response = [
                    'email'     => $user_email,
                    'available' => false,
                    'message'   => __( 'This email address is not valid', 'dokan-lite' ),
                ];

return rest_ensure_response( $response );
            }

if ( email_exists( $user_email ) ) {
                $response = [
                    'email'     => $user_email,
                    'available' => false,
                ];

return rest_ensure_response( $response );
            }

$response = [
                'email'     => $user_email,
                'available' => true,
            ];

return rest_ensure_response( $response );
        }

return rest_ensure_response( [] );
    }

/**
     * Send email to vendor
     *
     * @param WP_REST_Request
     *
     * @since 2.9.23
     *
     * @return WP_REST_Response
     */
    public function send_email( $request ) {
        $params = $request->get_params();
        $vendor = dokan()->vendor->get( $params['id'] );

if ( ! $vendor instanceof Vendor || ! $vendor->get_id() ) {
            return rest_ensure_response(
                new WP_Error(
                    'vendor_not_found',
                    __( 'No vendor is found to be send an email.', 'dokan-lite' ),
                    [
                        'status' => 404,
                    ]
                )
            );
        }

/**
         * Fires before sending email to vendor via the REST API.
         *
         * @param WP_REST_Request $request Request object.
         * @param boolean $creating True when creating object, false when updating.
         *
         * @since  2.9.23
         */
        do_action( "dokan_rest_pre_{$this->base}_send_email", $request, true );

$vendor_email   = $vendor->get_email();
        $sender_name    = $params['name'];
        $sender_email   = $params['email'];
        $sender_message = $params['message'];

WC()->mailer()->emails['Dokan_Email_Contact_Seller']->trigger( $vendor_email, $sender_name, $sender_email, $sender_message );

$response = apply_filters(
            "dokan_{$this->base}_send_email_response", [
                'store_id'       => $vendor->get_id(),
                'data'           => __( 'Email sent successfully!', 'dokan-lite' ),
                'sender_name'    => $sender_name,
                'sender_email'   => $sender_email,
                'sender_message' => $sender_message,
            ]
        );

return rest_ensure_response( $response );
    }

/**
     * Update vendor status
     *
     * @since 2.9.23
     *
     * @return WP_REST_Response|WP_Error
     */
    public function update_vendor_status( $request ) {
        if ( ! in_array( $request['status'], [ 'active', 'inactive' ], true ) ) {
            return new WP_Error( 'no_valid_status', __( 'Status parameter must be active or inactive', 'dokan-lite' ), [ 'status' => 400 ] );
        }

$store_id = ! empty( $request['id'] ) ? $request['id'] : 0;

if ( empty( $store_id ) ) {
            return new WP_Error( 'no_vendor_found', __( 'No vendor found for updating status', 'dokan-lite' ), [ 'status' => 400 ] );
        }

if ( 'active' === $request['status'] ) {
            $user = dokan()->vendor->get( $store_id )->make_active();
        } else {
            $user = dokan()->vendor->get( $store_id )->make_inactive();
        }

$response = rest_ensure_response( $user );
        $response->add_links( $this->prepare_links( $user, $request ) );

return $response;
    }

/**
     * Batch update for vendor listing
     *
     * @param $request
     *
     * @since 2.9.23
     *
     * @return array|WP_Error
     */
    public function batch_update( $request ) {
        $params = $request->get_params();

if ( empty( $params ) ) {
            return new WP_Error( 'no_item_found', __( 'No items found for bulk updating', 'dokan-lite' ), [ 'status' => 404 ] );
        }

$allowed_status = [ 'approved', 'pending', 'delete' ];
        $response       = [];

foreach ( $params as $status => $value ) {
            if ( in_array( $status, $allowed_status, true ) ) {
                switch ( $status ) {
                    case 'approved':
                        foreach ( $value as $vendor_id ) {
                            $response['approved'][] = dokan()->vendor->get( $vendor_id )->make_active();
                        }
                        break;

case 'pending':
                        foreach ( $value as $vendor_id ) {
                            $response['pending'][] = dokan()->vendor->get( $vendor_id )->make_inactive();
                        }
                        break;

case 'delete':
                        foreach ( $value as $vendor_id ) {
                            $user                 = dokan()->vendor->get( $vendor_id )->delete();
                            $response['delete'][] = $user;
                        }
                        break;
                }
            }
        }

return $response;
    }

/**
     * Get singe store
     *
     * @since 3.2.11
     *
     * @param $request
     *
     * @return WP_Error|WP_REST_Response
     */
    public function get_store_category( $request ) {
        $store_id     = absint( $request['id'] );
        $best_selling = boolval( $request->get_param( 'best_selling' ) );

$store = dokan()->vendor->get( $store_id );

if ( empty( $store->id ) || ! $store instanceof Vendor ) {
            return new WP_Error( 'no_store_found', __( 'No store found', 'dokan-lite' ), [ 'status' => 404 ] );
        }

$category_data = $store->get_store_categories( $best_selling );
        $commission_settings = $store->get_commission_settings();
        $category_commissions = $commission_settings->get_category_commissions();

foreach ( $category_data as $term ) {
            $term->admin_commission_type = $commission_settings->get_type();

if ( isset( $category_commissions['items'][ $term->term_id ] ) ) {
                $term->commission = $category_commissions['items'][ $term->term_id ];
            } elseif ( $category_commissions['all'] ) {
                $term->commission = $category_commissions['all'];
            } else {
                $term->commission = [];
            }
        }

$response = rest_ensure_response( $category_data );

return $response;
    }

/**
     * Retrieves the query params for the collections.
     *
     * @since 3.7.22
     *
     * @return array Query parameters for the collection.
     */
    public function get_store_collection_params(): array {
        $params = array(
            'status'     => array(
                'description'       => __( 'Status of the store', 'dokan-lite' ),
                'type'              => 'string',
                'default'           => 'all',
                'sanitize_callback' => 'sanitize_text_field',
                'validate_callback' => 'rest_validate_request_arg',
            ),
            'orderby'     => array(
                'description'       => __( 'Store List Order By', 'dokan-lite' ),
                'type'              => 'string',
                'sanitize_callback' => 'sanitize_text_field',
                'validate_callback' => 'rest_validate_request_arg',
            ),
            'order'     => array(
                'description'       => __( 'Store List Order', 'dokan-lite' ),
                'type'              => 'string',
                'sanitize_callback' => 'sanitize_text_field',
                'validate_callback' => 'rest_validate_request_arg',
            ),
            'featured'     => array(
                'description'       => __( 'Store List Order', 'dokan-lite' ),
                'type'              => 'string',
                'sanitize_callback' => 'sanitize_text_field',
                'validate_callback' => 'rest_validate_request_arg',
            ),
        );

return array_merge( parent::get_collection_params(), $params );
    }

/**
     * Updated query params for the store.
     *
     * @since 3.14.10
     *
     * @return array Query parameters for the store update.
     */
    public function get_store_update_params(): array {
        $params = [
            'id'                        => [
                'description'       => esc_html__( 'Unique identifier for the vendor.', 'dokan-lite' ),
                'type'              => 'integer',
                'required'          => true,
                'sanitize_callback' => 'absint',
            ],
            'first_name'                => [
                'description'       => esc_html__( 'Store owner first name.', 'dokan-lite' ),
                'type'              => 'string',
                'sanitize_callback' => 'sanitize_text_field',
            ],
            'last_name'                 => [
                'description'       => esc_html__( 'Store owner last name.', 'dokan-lite' ),
                'type'              => 'string',
                'sanitize_callback' => 'sanitize_text_field',
            ],
            'user_nicename'             => [
                'description'       => esc_html__( 'User nice name.', 'dokan-lite' ),
                'type'              => 'string',
                'sanitize_callback' => 'sanitize_text_field',
            ],
            'user_pass'                 => [
                'description' => esc_html__( 'User password.', 'dokan-lite' ),
                'type'        => 'string',
            ],
            'email'                     => [
                'description'       => esc_html__( 'Store email address.', 'dokan-lite' ),
                'type'              => 'string',
                'format'            => 'email',
                'validate_callback' => 'sanitize_email',
            ],
            'store_name'                => [
                'description'       => esc_html__( 'Store name.', 'dokan-lite' ),
                'type'              => 'string',
                'sanitize_callback' => 'sanitize_text_field',
            ],
            'phone'                     => [
                'description'       => esc_html__( 'Store phone number.', 'dokan-lite' ),
                'type'              => 'string',
                'sanitize_callback' => 'sanitize_text_field',
            ],
            'show_email'                => [
                'description' => esc_html__( 'Show email in store.', 'dokan-lite' ),
                'type'        => 'boolean',
                'default'     => false,
            ],
            'gravatar_id'               => [
                'description' => esc_html__( 'Gravatar ID.', 'dokan-lite' ),
                'type'        => 'integer',
            ],
            'banner_id'                 => [
                'description' => esc_html__( 'Banner ID.', 'dokan-lite' ),
                'type'        => 'integer',
            ],
            'enable_tnc'                => [
                'description' => esc_html__( 'Enable terms and conditions.', 'dokan-lite' ),
                'type'        => 'boolean',
            ],
            'store_tnc'                 => [
                'description' => esc_html__( 'Store terms and conditions.', 'dokan-lite' ),
                'type'        => 'string',
            ],
            'icon'                      => [
                'description' => esc_html__( 'Store icon.', 'dokan-lite' ),
                'type'        => 'string',
            ],
            'social'                    => [
                'description' => esc_html__( 'Social profiles.', 'dokan-lite' ),
                'type'        => 'object',
                'properties'  => [
                    'fb'        => [ 'type' => 'string' ],
                    'twitter'   => [ 'type' => 'string' ],
                    'pinterest' => [ 'type' => 'string' ],
                    'linkedin'  => [ 'type' => 'string' ],
                    'youtube'   => [ 'type' => 'string' ],
                    'instagram' => [ 'type' => 'string' ],
                ],
            ],
            'address'                   => [
                'description' => esc_html__( 'Store address.', 'dokan-lite' ),
                'type'        => 'object',
                'properties'  => [
                    'street_1' => [ 'type' => 'string' ],
                    'street_2' => [ 'type' => 'string' ],
                    'city'     => [ 'type' => 'string' ],
                    'zip'      => [ 'type' => 'string' ],
                    'state'    => [ 'type' => 'string' ],
                    'country'  => [ 'type' => 'string' ],
                ],
            ],
            // Admin only fields
            'enabled'                   => [
                'description' => esc_html__( 'Enable selling.', 'dokan-lite' ),
                'type'        => 'boolean',
            ],
            'featured'                  => [
                'description' => esc_html__( 'Featured vendor.', 'dokan-lite' ),
                'type'        => 'boolean',
            ],
            'trusted'                   => [
                'description' => esc_html__( 'Trusted vendor.', 'dokan-lite' ),
                'type'        => 'boolean',
            ],
            'admin_commission'          => [
                'description' => esc_html__( 'Admin commission amount.', 'dokan-lite' ),
                'type'        => [ 'number', 'string' ],
            ],
            'admin_additional_fee'      => [
                'description' => esc_html__( 'Admin additional fee.', 'dokan-lite' ),
                'type'        => [ 'number', 'string' ],
            ],
            'admin_category_commission' => [
                'description' => esc_html__( 'Category wise commission.', 'dokan-lite' ),
                'type'        => 'object',
            ],
        ];

return apply_filters( 'dokan_rest_api_store_update_params', $params );
    }
}