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

surecart / app / src / Abilities / Abilities / GetSubscription.php

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

GetSubscription.php

108 lines

1	<?php
2
3	namespace SureCart\Abilities\Abilities;
4
5	use SureCart\Models\Subscription;
6
7	/**
8	* Get a single subscription with details.
9	*/
10	class GetSubscription extends AbstractAbility {
11
12	/**
13	* {@inheritDoc}
14	*/
15	public function get_name(): string {
16	return 'surecart/get-subscription';
17	}
18
19	/**
20	* {@inheritDoc}
21	*/
22	public function get_label(): string {
23	return __( 'Get Subscription', 'surecart' );
24	}
25
26	/**
27	* {@inheritDoc}
28	*/
29	public function get_description(): string {
30	return __( 'Retrieve a single SureCart subscription by its ID, including the associated price, product, and billing details. Returns the full subscription object with related data expanded.', '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 when you need full details about a specific subscription including its current status, billing period, and associated product/price.';
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	'id' => array(
66	'type' => 'string',
67	'description' => __( 'The subscription ID.', 'surecart' ),
68	),
69	),
70	'required' => array( 'id' ),
71	);
72	}
73
74	/**
75	* {@inheritDoc}
76	*/
77	public function get_output_schema(): array {
78	return array(
79	'type' => 'object',
80	'properties' => array(
81	'success' => array( 'type' => 'boolean' ),
82	'subscription' => array( 'type' => 'object' ),
83	),
84	);
85	}
86
87	/**
88	* {@inheritDoc}
89	*/
90	public function execute( array $input ) {
91	$id = sanitize_text_field( $input['id'] ?? '' );
92	if ( empty( $id ) ) {
93	return $this->error( 'missing_id', __( 'A subscription ID is required.', 'surecart' ) );
94	}
95
96	$subscription = Subscription::with( array( 'price', 'price.product' ) )->find( $id );
97	if ( is_wp_error( $subscription ) ) {
98	return $subscription;
99	}
100
101	return $this->success(
102	array(
103	'subscription' => $this->model_to_array( $subscription ),
104	)
105	);
106	}
107	}
108