give / src / API / REST / V3 / Routes / Subscriptions / Permissions / SubscriptionPermissions.php

SubscriptionPermissions.php in GiveWP – Donation Plugin and Fundraising Platform 4.16.8.1, at src/API/REST/V3/Routes/Subscriptions/Permissions/SubscriptionPermissions.php

130 lines 3.3 KB

Raw Download Zip

1	<?php
2
3	namespace Give\API\REST\V3\Routes\Subscriptions\Permissions;
4
5	use Give\API\REST\V3\Routes\Donors\ValueObjects\DonorAnonymousMode;
6	use Give\Framework\Permissions\Facades\UserPermissions;
7	use WP_Error;
8	use WP_REST_Request;
9
10	/**
11	* @since 4.8.0
12	*/
13	class SubscriptionPermissions
14	{
15	/**
16	* Check if current user can edit subscriptions.
17	*
18	* @since 4.8.0
19	*/
20	public static function canEdit(): bool
21	{
22	return UserPermissions::subscriptions()->canEdit();
23	}
24
25	/**
26	* Check if current user can view subscriptions.
27	*
28	* @since 4.14.0
29	*/
30	public static function canView(): bool
31	{
32	return UserPermissions::subscriptions()->canView();
33	}
34
35	/**
36	* Check if current user can delete subscriptions.
37	*
38	* @since 4.14.0 update permission capability to use facade
39	*
40	* @since 4.8.0
41	*/
42	public static function canDelete(): bool
43	{
44	return UserPermissions::subscriptions()->canDelete();
45	}
46
47	/**
48	* @since 4.8.0
49	*/
50	public static function authorizationStatusCode(): int
51	{
52	return is_user_logged_in() ? 403 : 401;
53	}
54
55	/**
56	* @since 4.14.0 updated to use canView method
57	* @since 4.8.0
58	*
59	* @param WP_REST_Request $request
60	*
61	* @return true\|WP_Error
62	*/
63	public static function validationForGetMethods(WP_REST_Request $request)
64	{
65	$isAdmin = self::canView();
66
67	$includeSensitiveData = $request->get_param('includeSensitiveData');
68	if ( ! $isAdmin && $includeSensitiveData) {
69	return new WP_Error(
70	'rest_forbidden',
71	__('You do not have permission to include sensitive data.', 'give'),
72	['status' => self::authorizationStatusCode()]
73	);
74	}
75
76	if ($request->get_param('anonymousDonors') !== null) {
77	$donorAnonymousMode = new DonorAnonymousMode($request->get_param('anonymousDonors'));
78	if ( ! $isAdmin && $donorAnonymousMode->isIncluded()) {
79	return new WP_Error(
80	'rest_forbidden',
81	__('You do not have permission to include anonymous donors.', 'give'),
82	['status' => self::authorizationStatusCode()]
83	);
84	}
85	}
86
87	return true;
88	}
89
90	/**
91	* @since 4.8.0
92	*
93	* @param WP_REST_Request $request
94	*
95	* @return true\|WP_Error
96	*/
97	public static function validationForUpdateMethod(WP_REST_Request $request)
98	{
99	if (! self::canEdit()) {
100	return new WP_Error(
101	'rest_forbidden',
102	__('You do not have permission to update subscriptions.', 'give'),
103	['status' => self::authorizationStatusCode()]
104	);
105	}
106
107	return true;
108	}
109
110	/**
111	* @since 4.8.0
112	*
113	* @param WP_REST_Request $request
114	*
115	* @return true\|WP_Error
116	*/
117	public static function validationForDeleteMethods(WP_REST_Request $request)
118	{
119	if ( ! self::canDelete()) {
120	return new WP_Error(
121	'rest_forbidden',
122	__('You do not have permission to delete subscriptions.', 'give'),
123	['status' => self::authorizationStatusCode()]
124	);
125	}
126
127	return true;
128	}
129	}
130