Pricing_Controller

• Full name: \BigCommerce\Rest\Pricing_Controller
• Parent class: \BigCommerce\Rest\Rest_Controller

Methods

__construct

Rest_Controller constructor.

public __construct(mixed $namespace_base, mixed $version, mixed $rest_base, \BigCommerce\Api\v3\Api\PricingApi $pricing_api): mixed

Parameters:

js_config

Add data to the JS config to support pricing requests

public js_config(array $config): array

Parameters:

is_nonce_enabled

Nonce should always be on non-headless setup or if it is enabled via Customizer

public is_nonce_enabled(): bool

register_routes

public register_routes(): mixed

get_items

Retrieves a collection of products.

public get_items(\WP_REST_Request $request): \WP_REST_Response|\WP_Error

Parameters:

Return Value:

Response object on success, or WP_Error object on failure.

get_items_permissions_check

Checks if a given request has access to read pricing.

public get_items_permissions_check(\WP_REST_Request $request): true|\WP_Error

Parameters:

Return Value:

True if the request has read access, WP_Error object otherwise.

get_collection_params

Get the query params for collections.

public get_collection_params(): array

Inherited methods

__construct

Rest_Controller constructor.

public __construct(string $namespace_base, string $version, string $rest_base): mixed

Parameters:

get_namespace

protected get_namespace(): mixed

get_base_url

public get_base_url(): mixed

parse_result

protected parse_result(mixed $response, mixed $client, mixed $rest_response = true): mixed

Parameters:

format_currency

Formats a numeric value as a currency string.

protected format_currency(float $value, string $empty_value = ''): string

Parameters:

Return Value:

The formatted currency string or the empty value.

Automatically generated on 2025-01-21