ActivationPermissionsController.php
2 years ago
BalanceTransactionPermissionsController.php
3 years ago
ChargePermissionsController.php
3 years ago
CheckoutPermissionsController.php
1 year ago
CustomerPermissionsController.php
2 years ago
InvoicePermissionsController.php
3 years ago
LicensePermissionsController.php
3 years ago
MediaPermissionsController.php
3 years ago
ModelPermissionsController.php
1 year ago
OrderPermissionsController.php
3 years ago
PaymentMethodPermissionsController.php
3 years ago
PurchasePermissionsController.php
3 years ago
RefundPermissionsController.php
3 years ago
SubscriptionPermissionsController.php
2 years ago
SubscriptionPermissionsController.php
241 lines
| 1 | <?php |
| 2 | namespace SureCart\Permissions\Models; |
| 3 | |
| 4 | use SureCart\Models\Subscription; |
| 5 | |
| 6 | /** |
| 7 | * Handle various permissions. |
| 8 | */ |
| 9 | class SubscriptionPermissionsController extends ModelPermissionsController { |
| 10 | /** |
| 11 | * Subscription cancelation. |
| 12 | * |
| 13 | * @param \SureCart\Models\User $user User model. |
| 14 | * @param array $args { |
| 15 | * Arguments that accompany the requested capability check. |
| 16 | * @type string $0 Requested capability. |
| 17 | * @type int $1 Concerned user ID. |
| 18 | * @type mixed ...$2 The quantity to update. |
| 19 | * } |
| 20 | * @param bool[] $allcaps Array of key/value pairs where keys represent a capability name |
| 21 | * and boolean values represent whether the user has that capability. |
| 22 | * |
| 23 | * @return boolean |
| 24 | */ |
| 25 | public function cancel_sc_subscription( $user, $args, $allcaps ) { |
| 26 | if ( ! empty( $allcaps['edit_sc_subscriptions'] ) ) { |
| 27 | return true; |
| 28 | } |
| 29 | |
| 30 | // It's disabled on the account. |
| 31 | if ( empty( \SureCart::account()->portal_protocol->subscription_cancellations_enabled ) ) { |
| 32 | return false; |
| 33 | } |
| 34 | |
| 35 | // if we should delay cancellation. |
| 36 | $subscription = Subscription::find( $args[2] ); |
| 37 | if ( $subscription->shouldDelayCancellation() ) { |
| 38 | return false; |
| 39 | } |
| 40 | |
| 41 | return $this->belongsToUser( Subscription::class, $args[2], $user ); |
| 42 | } |
| 43 | |
| 44 | /** |
| 45 | * Subscription restoring. |
| 46 | * |
| 47 | * @param \SureCart\Models\User $user User model. |
| 48 | * @param array $args { |
| 49 | * Arguments that accompany the requested capability check. |
| 50 | * @type string $0 Requested capability. |
| 51 | * @type int $1 Concerned user ID. |
| 52 | * @type mixed ...$2 The quantity to update. |
| 53 | * } |
| 54 | * @param bool[] $allcaps Array of key/value pairs where keys represent a capability name |
| 55 | * and boolean values represent whether the user has that capability. |
| 56 | * |
| 57 | * @return boolean |
| 58 | */ |
| 59 | public function restore_sc_subscription( $user, $args, $allcaps ) { |
| 60 | if ( ! empty( $allcaps['edit_sc_subscriptions'] ) ) { |
| 61 | return true; |
| 62 | } |
| 63 | |
| 64 | return $this->belongsToUser( Subscription::class, $args[2], $user ); |
| 65 | } |
| 66 | |
| 67 | /** |
| 68 | * Subscription Update Quantity. |
| 69 | * |
| 70 | * @param \SureCart\Models\User $user User model. |
| 71 | * @param array $args { |
| 72 | * Arguments that accompany the requested capability check. |
| 73 | * @type string $0 Requested capability. |
| 74 | * @type int $1 Concerned user ID. |
| 75 | * @type mixed ...$2 The quantity to update. |
| 76 | * } |
| 77 | * @param bool[] $allcaps Array of key/value pairs where keys represent a capability name |
| 78 | * and boolean values represent whether the user has that capability. |
| 79 | * |
| 80 | * @return boolean |
| 81 | */ |
| 82 | public function update_sc_subscription_quantity( $user, $args, $allcaps ) { |
| 83 | if ( ! empty( $allcaps['edit_sc_subscriptions'] ) ) { |
| 84 | return true; |
| 85 | } |
| 86 | |
| 87 | $subscription = Subscription::find( $args[2] ); |
| 88 | |
| 89 | if ( empty( \SureCart::account()->portal_protocol->subscription_quantity_updates_enabled ) ) { |
| 90 | $subscription = Subscription::find( $args[2] ); |
| 91 | if ( is_wp_error( $subscription ) ) { |
| 92 | return false; |
| 93 | } |
| 94 | |
| 95 | $quantity = $args[3]; |
| 96 | |
| 97 | // quantities don't match. |
| 98 | if ( $subscription->quantity !== $quantity ) { |
| 99 | return false; |
| 100 | } |
| 101 | } |
| 102 | |
| 103 | return $this->belongsToUser( Subscription::class, $args[2], $user ); |
| 104 | } |
| 105 | |
| 106 | /** |
| 107 | * Subscription Switch. |
| 108 | * |
| 109 | * @param \SureCart\Models\User $user User model. |
| 110 | * @param array $args { |
| 111 | * Arguments that accompany the requested capability check. |
| 112 | * @type string $0 Requested capability. |
| 113 | * @type int $1 Concerned user ID. |
| 114 | * @type mixed ...$2 The quantity to update. |
| 115 | * } |
| 116 | * @param bool[] $allcaps Array of key/value pairs where keys represent a capability name |
| 117 | * and boolean values represent whether the user has that capability. |
| 118 | * @return boolean |
| 119 | */ |
| 120 | public function switch_sc_subscription( $user, $args, $allcaps ) { |
| 121 | if ( ! empty( $allcaps['edit_sc_subscriptions'] ) ) { |
| 122 | return true; |
| 123 | } |
| 124 | |
| 125 | if ( empty( $args[2] ) ) { |
| 126 | return false; |
| 127 | } |
| 128 | |
| 129 | // It's disabled on the account. |
| 130 | if ( empty( \SureCart::account()->portal_protocol->subscription_updates_enabled ) ) { |
| 131 | return false; |
| 132 | } |
| 133 | |
| 134 | return $this->belongsToUser( Subscription::class, $args[2], $user ); |
| 135 | } |
| 136 | |
| 137 | /** |
| 138 | * Can user read. |
| 139 | * |
| 140 | * @param \SureCart\Models\User $user User model. |
| 141 | * @param array $args { |
| 142 | * Arguments that accompany the requested capability check. |
| 143 | * @type string $0 Requested capability. |
| 144 | * @type int $1 Concerned user ID. |
| 145 | * @type mixed ...$2 Optional second and further parameters, typically object ID. |
| 146 | * } |
| 147 | * @param bool[] $allcaps Array of key/value pairs where keys represent a capability name |
| 148 | * and boolean values represent whether the user has that capability. |
| 149 | * |
| 150 | * @return boolean Does user have permission. |
| 151 | */ |
| 152 | public function read_sc_subscription( $user, $args, $allcaps ) { |
| 153 | if ( ! empty( $allcaps['read_sc_subscriptions'] ) ) { |
| 154 | return true; |
| 155 | } |
| 156 | return $this->belongsToUser( Subscription::class, $args[2], $user ); |
| 157 | } |
| 158 | |
| 159 | /** |
| 160 | * Can user list. |
| 161 | * |
| 162 | * @param \SureCart\Models\User $user User model. |
| 163 | * @param array $args { |
| 164 | * Arguments that accompany the requested capability check. |
| 165 | * @type string $0 Requested capability. |
| 166 | * @type int $1 Concerned user ID. |
| 167 | * @type string[] ...$2 The ids to list. |
| 168 | * } |
| 169 | * @param bool[] $allcaps Array of key/value pairs where keys represent a capability name |
| 170 | * and boolean values represent whether the user has that capability. |
| 171 | * |
| 172 | * @return boolean Does user have permission. |
| 173 | */ |
| 174 | public function read_sc_subscriptions( $user, $args, $allcaps ) { |
| 175 | if ( ! empty( $allcaps['read_sc_subscriptions'] ) ) { |
| 176 | return true; |
| 177 | } |
| 178 | return $this->isListingOwnCustomerIds( $user, $args[2]['customer_ids'] ?? array() ); |
| 179 | } |
| 180 | |
| 181 | /** |
| 182 | * Can user edit. |
| 183 | * |
| 184 | * @param \SureCart\Models\User $user User model. |
| 185 | * @param array $args { |
| 186 | * Arguments that accompany the requested capability check. |
| 187 | * @type string $0 Requested capability. |
| 188 | * @type int $1 Concerned user ID. |
| 189 | * @type string $2 The id of the subscription. |
| 190 | * @type array ...$4 The data that is being requested to update. |
| 191 | * } |
| 192 | * @param bool[] $allcaps Array of key/value pairs where keys represent a capability name |
| 193 | * and boolean values represent whether the user has that capability. |
| 194 | * @return boolean Does user have permission. |
| 195 | */ |
| 196 | public function edit_sc_subscription( $user, $args, $allcaps ) { |
| 197 | // user has full access. |
| 198 | if ( ! empty( $allcaps['edit_sc_subscriptions'] ) ) { |
| 199 | return true; |
| 200 | } |
| 201 | |
| 202 | // no user to check. |
| 203 | if ( empty( $user->ID ) ) { |
| 204 | return false; |
| 205 | } |
| 206 | |
| 207 | // user is not a customer. |
| 208 | if ( ! $user->isCustomer() ) { |
| 209 | return false; |
| 210 | } |
| 211 | |
| 212 | // no data provided to update. Make sure to at least pass an empty array. |
| 213 | if ( is_null( $args[3] ?? null ) ) { |
| 214 | return false; |
| 215 | } |
| 216 | |
| 217 | $params = $args[3]; |
| 218 | |
| 219 | // request has blacklisted keys. |
| 220 | if ( ! $this->requestOnlyHasKeys( $params, array( 'cancel_at_period_end', 'quantity', 'price', 'purge_pending_update', 'payment_method', 'manual_payment_method', 'manual_payment', 'cancellation_act', 'ad_hoc_amount', 'variant', 'discount' ) ) ) { |
| 221 | return false; |
| 222 | } |
| 223 | |
| 224 | // check if they can modify price. |
| 225 | if ( ! empty( $params['price'] ) && ! $this->switch_sc_subscription( $user, $args, $allcaps ) ) { |
| 226 | return false; |
| 227 | } |
| 228 | |
| 229 | if ( ! empty( $params['variant'] ) && ! $this->switch_sc_subscription( $user, $args, $allcaps ) ) { |
| 230 | return false; |
| 231 | } |
| 232 | |
| 233 | // check if user can modify quantity. |
| 234 | if ( ! empty( $params['quantity'] ) && $params['quantity'] > 1 && ! $this->update_sc_subscription_quantity( $user, $args, $allcaps ) ) { |
| 235 | return false; |
| 236 | } |
| 237 | |
| 238 | return $this->belongsToUser( Subscription::class, $args[2], $user ); |
| 239 | } |
| 240 | } |
| 241 |