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

surecart / app / src / Abilities / Abilities / ListSubscriptions.php

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

ListSubscriptions.php

150 lines

1	<?php
2
3	namespace SureCart\Abilities\Abilities;
4
5	use SureCart\Models\Subscription;
6
7	/**
8	* List subscriptions with filters.
9	*/
10	class ListSubscriptions extends AbstractAbility {
11
12	/**
13	* {@inheritDoc}
14	*/
15	public function get_name(): string {
16	return 'surecart/list-subscriptions';
17	}
18
19	/**
20	* {@inheritDoc}
21	*/
22	public function get_label(): string {
23	return __( 'List Subscriptions', 'surecart' );
24	}
25
26	/**
27	* {@inheritDoc}
28	*/
29	public function get_description(): string {
30	return __( 'Retrieve a paginated list of SureCart subscriptions. Supports filtering by status, customer, price, and product. Returns subscription summaries with IDs, statuses, and billing details.', 'surecart' );
31	}
32
33	/**
34	* {@inheritDoc}
35	*/
36	public function get_annotations(): array {
37	return array(
38	'readonly' => true,
39	'destructive' => false,
40	'idempotent' => true,
41	);
42	}
43
44	/**
45	* {@inheritDoc}
46	*/
47	public function get_instructions(): string {
48	return 'Use this to browse or filter subscriptions. Common status values: active, trialing, past_due, canceled, completed. For full details on a single subscription, use get-subscription instead. Only known parameters are accepted: status, customer, price, product, page, per_page.';
49	}
50
51	/**
52	* {@inheritDoc}
53	*/
54	public function check_permission(): bool {
55	return current_user_can( 'read_sc_subscriptions' );
56	}
57
58	/**
59	* {@inheritDoc}
60	*/
61	public function get_input_schema(): array {
62	return array(
63	'type' => 'object',
64	'properties' => array(
65	'status' => array(
66	'type' => 'string',
67	'description' => __( 'Filter by subscription status (active, trialing, past_due, canceled, completed).', 'surecart' ),
68	),
69	'customer_id' => array(
70	'type' => 'string',
71	'description' => __( 'Filter by customer ID.', 'surecart' ),
72	),
73	'page' => array(
74	'type' => 'integer',
75	'description' => __( 'Page number for pagination.', 'surecart' ),
76	'default' => 1,
77	),
78	'per_page' => array(
79	'type' => 'integer',
80	'description' => __( 'Number of subscriptions per page (max 100).', 'surecart' ),
81	'default' => 10,
82	),
83	),
84	);
85	}
86
87	/**
88	* {@inheritDoc}
89	*/
90	public function get_output_schema(): array {
91	return array(
92	'type' => 'object',
93	'properties' => array(
94	'success' => array( 'type' => 'boolean' ),
95	'subscriptions' => array(
96	'type' => 'array',
97	'items' => array( 'type' => 'object' ),
98	),
99	'pagination' => array(
100	'type' => 'object',
101	'properties' => array(
102	'count' => array( 'type' => 'integer' ),
103	'page' => array( 'type' => 'integer' ),
104	'limit' => array( 'type' => 'integer' ),
105	),
106	),
107	),
108	);
109	}
110
111	/**
112	* {@inheritDoc}
113	*/
114	public function execute( array $input ) {
115	$page = absint( $input['page'] ?? 1 );
116	$per_page = max( 1, min( absint( $input['per_page'] ?? 10 ), 100 ) );
117
118	$args = array();
119
120	if ( ! empty( $input['status'] ) ) {
121	$args['status'] = array( sanitize_text_field( $input['status'] ) );
122	}
123
124	if ( ! empty( $input['customer_id'] ) ) {
125	$args['customer_ids'] = array( sanitize_text_field( $input['customer_id'] ) );
126	}
127
128	$subscriptions = Subscription::where( $args )->paginate(
129	array(
130	'page' => $page,
131	'per_page' => $per_page,
132	)
133	);
134	if ( is_wp_error( $subscriptions ) ) {
135	return $subscriptions;
136	}
137
138	return $this->success(
139	array(
140	'subscriptions' => array_map( array( $this, 'model_to_array' ), $subscriptions->data ?? array() ),
141	'pagination' => array(
142	'count' => $subscriptions->pagination->count ?? 0,
143	'page' => $page,
144	'limit' => $per_page,
145	),
146	)
147	);
148	}
149	}
150