CreateCoupon.php — SureCart – Ecommerce Made Easy For Selling Physical Products, Digital Downloads, Subscriptions, Donations, & Payments 4.7.1

surecart / app / src / Abilities / Abilities / CreateCoupon.php

surecart / app / src / Abilities / Abilities Last commit date

CreateCoupon.php

190 lines

1	<?php
2
3	namespace SureCart\Abilities\Abilities;
4
5	use SureCart\Models\Coupon;
6
7	/**
8	* Create a new coupon/discount.
9	*/
10	class CreateCoupon extends AbstractAbility {
11
12	/**
13	* {@inheritDoc}
14	*/
15	public function get_name(): string {
16	return 'surecart/create-coupon';
17	}
18
19	/**
20	* {@inheritDoc}
21	*/
22	public function get_label(): string {
23	return __( 'Create Coupon', 'surecart' );
24	}
25
26	/**
27	* {@inheritDoc}
28	*/
29	public function get_description(): string {
30	return __( 'Create a new SureCart coupon with a discount amount or percentage, duration, and optional redemption limits. Coupons define the discount logic and can be linked to one or more promotion codes.', 'surecart' );
31	}
32
33	/**
34	* {@inheritDoc}
35	*/
36	public function get_annotations(): array {
37	return array(
38	'readonly' => false,
39	'destructive' => false,
40	'idempotent' => false,
41	);
42	}
43
44	/**
45	* {@inheritDoc}
46	*/
47	public function get_instructions(): string {
48	return 'Set either amount_off (in smallest currency unit) or percent_off (0-100), not both. Duration can be once, repeating, or forever. For repeating, also set duration_in_months. Each call creates a new coupon.';
49	}
50
51	/**
52	* {@inheritDoc}
53	*/
54	public function check_permission(): bool {
55	return current_user_can( 'publish_sc_coupons' );
56	}
57
58	/**
59	* {@inheritDoc}
60	*/
61	public function get_input_schema(): array {
62	return array(
63	'type' => 'object',
64	'properties' => array(
65	'name' => array(
66	'type' => 'string',
67	'description' => __( 'Coupon name displayed to customers.', 'surecart' ),
68	),
69	'percent_off' => array(
70	'type' => 'number',
71	'description' => __( 'Percentage discount (e.g., 10 for 10% off). Use this or amount_off, not both.', 'surecart' ),
72	),
73	'amount_off' => array(
74	'type' => 'integer',
75	'description' => __( 'Fixed amount discount in smallest currency unit (e.g., cents). Use this or percent_off, not both.', 'surecart' ),
76	),
77	'currency' => array(
78	'type' => 'string',
79	'description' => __( 'Three-letter ISO currency code for amount_off (e.g., usd).', 'surecart' ),
80	'default' => 'usd',
81	),
82	'duration' => array(
83	'type' => 'string',
84	'description' => __( 'Coupon duration: once, repeating, or forever.', 'surecart' ),
85	'enum' => array( 'once', 'repeating', 'forever' ),
86	'default' => 'once',
87	),
88	'duration_in_months' => array(
89	'type' => 'integer',
90	'description' => __( 'Number of months the coupon applies when duration is repeating.', 'surecart' ),
91	),
92	'max_redemptions' => array(
93	'type' => 'integer',
94	'description' => __( 'Maximum total redemptions across all customers.', 'surecart' ),
95	),
96	'max_redemptions_per_customer' => array(
97	'type' => 'integer',
98	'description' => __( 'Maximum redemptions per individual customer.', 'surecart' ),
99	),
100	'min_subtotal_amount' => array(
101	'type' => 'integer',
102	'description' => __( 'Minimum checkout subtotal required in smallest currency unit.', 'surecart' ),
103	),
104	'max_subtotal_amount' => array(
105	'type' => 'integer',
106	'description' => __( 'Maximum checkout subtotal allowed in smallest currency unit.', 'surecart' ),
107	),
108	'product_ids' => array(
109	'type' => 'array',
110	'items' => array( 'type' => 'string' ),
111	'description' => __( 'Product IDs this coupon applies to. Empty means all products.', 'surecart' ),
112	),
113	'redeem_by' => array(
114	'type' => 'integer',
115	'description' => __( 'Unix timestamp after which the coupon expires.', 'surecart' ),
116	),
117	),
118	'required' => array( 'name' ),
119	);
120	}
121
122	/**
123	* {@inheritDoc}
124	*/
125	public function get_output_schema(): array {
126	return array(
127	'type' => 'object',
128	'properties' => array(
129	'success' => array( 'type' => 'boolean' ),
130	'coupon' => array( 'type' => 'object' ),
131	),
132	);
133	}
134
135	/**
136	* {@inheritDoc}
137	*/
138	public function execute( array $input ) {
139	$allowed_durations = array( 'once', 'repeating', 'forever' );
140	$duration = sanitize_text_field( $input['duration'] ?? 'once' );
141	if ( ! in_array( $duration, $allowed_durations, true ) ) {
142	return $this->error(
143	'invalid_duration',
144	/* translators: %s: comma-separated list of valid duration values */
145	sprintf( __( 'Invalid duration. Allowed values: %s', 'surecart' ), implode( ', ', $allowed_durations ) )
146	);
147	}
148
149	$data = array(
150	'name' => sanitize_text_field( $input['name'] ),
151	'duration' => $duration,
152	);
153
154	if ( ! empty( $input['percent_off'] ) && ! empty( $input['amount_off'] ) ) {
155	return $this->error( 'invalid_input', __( 'You cannot set both percent_off and amount_off. Please use one or the other.', 'surecart' ) );
156	}
157
158	if ( ! empty( $input['percent_off'] ) ) {
159	$data['percent_off'] = floatval( $input['percent_off'] );
160	} elseif ( ! empty( $input['amount_off'] ) ) {
161	$data['amount_off'] = absint( $input['amount_off'] );
162	$data['currency'] = sanitize_text_field( $input['currency'] ?? 'usd' );
163	}
164
165	// Optional integer fields.
166	$int_fields = array( 'duration_in_months', 'max_redemptions', 'max_redemptions_per_customer', 'min_subtotal_amount', 'max_subtotal_amount', 'redeem_by' );
167	foreach ( $int_fields as $field ) {
168	if ( isset( $input[ $field ] ) ) {
169	$data[ $field ] = absint( $input[ $field ] );
170	}
171	}
172
173	// Product restrictions.
174	if ( isset( $input['product_ids'] ) && is_array( $input['product_ids'] ) ) {
175	$data['product_ids'] = array_map( 'sanitize_text_field', $input['product_ids'] );
176	}
177
178	$coupon = Coupon::create( $data );
179	if ( is_wp_error( $coupon ) ) {
180	return $coupon;
181	}
182
183	return $this->success(
184	array(
185	'coupon' => $this->model_to_array( $coupon ),
186	)
187	);
188	}
189	}
190