Discounts extends Base_Route implements Route Uses Api_Provide_Error_Response

Registers the discounts route.

Tags
author

Barn2 Plugins support@barn2.com

license

GPL-3.0

copyright

Barn2 Media Ltd

Interfaces, Classes and Traits

Route

Table of Contents

$rest_base  : mixed
create()  : WP_REST_Response
Create a discount.
delete()  : WP_REST_Response
Delete discounts via the api.
duplicate()  : WP_REST_Response
Duplicate a discount.
get_discounts()  : WP_REST_Response
Returns the list of discounts from the database.
permission_callback()  : bool
Determine if route can be accessed.
register_routes()  : void
Register routes.
reorder()  : WP_REST_Response
Reorder discount rules.
send_error_response()  : WP_REST_Response
Send an error response via `WP_Rest_Response`.
toggle()  : WP_REST_Response
Set the discout as enabled or disabled.
update()  : WP_REST_Response
Update a discount.
clean_cache()  : void
Clean the cached list of discounts.
is_temporary_id()  : bool
Determine if the given ID is a temporary ID.
prepare_submitted_settings()  : array<string|int, mixed>
Prepare submitted settings by merging them with the defaults before saving.

Properties

$rest_base

protected mixed $rest_base = 'discounts'

Methods

create()

Create a discount.

public create(WP_REST_Request $request) : WP_REST_Response
Parameters
$request : WP_REST_Request
Return values
WP_REST_Response

delete()

Delete discounts via the api.

public delete(WP_REST_Request $request) : WP_REST_Response
Parameters
$request : WP_REST_Request
Return values
WP_REST_Response

duplicate()

Duplicate a discount.

public duplicate(WP_REST_Request $request) : WP_REST_Response
Parameters
$request : WP_REST_Request
Return values
WP_REST_Response

get_discounts()

Returns the list of discounts from the database.

public get_discounts() : WP_REST_Response
Return values
WP_REST_Response

permission_callback()

Determine if route can be accessed.

public permission_callback() : bool
Return values
bool

register_routes()

Register routes.

public register_routes() : void
Return values
void

reorder()

Reorder discount rules.

public reorder(WP_REST_Request $request) : WP_REST_Response
Parameters
$request : WP_REST_Request
Return values
WP_REST_Response

send_error_response()

Send an error response via `WP_Rest_Response`.

public send_error_response(string $message) : WP_REST_Response
Parameters
$message : string

the message to display as an error.

Return values
WP_REST_Response

toggle()

Set the discout as enabled or disabled.

public toggle(WP_REST_Request $request) : WP_REST_Response
Parameters
$request : WP_REST_Request
Return values
WP_REST_Response

update()

Update a discount.

public update(WP_REST_Request $request) : WP_REST_Response
Parameters
$request : WP_REST_Request
Return values
WP_REST_Response

clean_cache()

Clean the cached list of discounts.

private clean_cache() : void
Return values
void

is_temporary_id()

Determine if the given ID is a temporary ID.

private is_temporary_id(string|int $id) : bool
Parameters
$id : string|int
Return values
bool

prepare_submitted_settings()

Prepare submitted settings by merging them with the defaults before saving.

private prepare_submitted_settings(array<string|int, mixed> $submitted_settings) : array<string|int, mixed>
Parameters
$submitted_settings : array<string|int, mixed>

The submitted settings.

Return values
array<string|int, mixed>

The prepared settings.

Search results