Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/cartforge.co/vendor/braintree/braintree_php/lib/Braintree/ |
<?php
namespace Braintree;
use InvalidArgumentException;
/**
* Braintree SubscriptionGateway module
*
* // phpcs:ignore Generic.Files.LineLength
* For more detailed information on Subscriptions, see {@link https://developer.paypal.com/braintree/docs/reference/response/subscription/php our developer docs}
*/
class SubscriptionGateway
{
private $_gateway;
private $_config;
private $_http;
// phpcs:ignore PEAR.Commenting.FunctionComment.Missing
public function __construct($gateway)
{
$this->_gateway = $gateway;
$this->_config = $gateway->config;
$this->_config->assertHasAccessTokenOrKeys();
$this->_http = new Http($gateway->config);
}
/*
* Request a new subscription be created
*
* @param array $attributes containing request params
*
* @return Result\Sucessful|Result\Error
*/
public function create($attributes)
{
Util::verifyKeys(self::_createSignature(), $attributes);
$path = $this->_config->merchantPath() . '/subscriptions';
$response = $this->_http->post($path, ['subscription' => $attributes]);
return $this->_verifyGatewayResponse($response);
}
/*
* Look up a single subscription
*
* @param string $id of the subscription to find
*
* @return Subscription|Exception\NotFound
*/
public function find($id)
{
$this->_validateId($id);
try {
$path = $this->_config->merchantPath() . '/subscriptions/' . $id;
$response = $this->_http->get($path);
return Subscription::factory($response['subscription']);
} catch (Exception\NotFound $e) {
throw new Exception\NotFound('subscription with id ' . $id . ' not found');
}
}
/*
* Search for subscriptions using a variety of criteria
*
* @param mixed $query of search fields
*
* @return ResourceCollection of Subscription objects
*/
public function search($query)
{
$criteria = [];
foreach ($query as $term) {
$criteria[$term->name] = $term->toparam();
}
$path = $this->_config->merchantPath() . '/subscriptions/advanced_search_ids';
$response = $this->_http->post($path, ['search' => $criteria]);
$pager = [
'object' => $this,
'method' => 'fetch',
'methodArgs' => [$query]
];
return new ResourceCollection($response, $pager);
}
/*
* Fetch subscriptions using a variety of criteria
*
* @param mixed $query of search fields
* @param array $ids to be fetched
*
* @return ResourceCollection of Subscription objects
*/
public function fetch($query, $ids)
{
$criteria = [];
foreach ($query as $term) {
$criteria[$term->name] = $term->toparam();
}
$criteria["ids"] = SubscriptionSearch::ids()->in($ids)->toparam();
$path = $this->_config->merchantPath() . '/subscriptions/advanced_search';
$response = $this->_http->post($path, ['search' => $criteria]);
return Util::extractAttributeAsArray(
$response['subscriptions'],
'subscription'
);
}
/*
* Updates a specific subscription with given details
*
* @param string $subscriptionId the ID of the subscription to be updated
* @param mixed $attributes
*
* @return Subscription|Exception\NotFound
*/
public function update($subscriptionId, $attributes)
{
Util::verifyKeys(self::_updateSignature(), $attributes);
$path = $this->_config->merchantPath() . '/subscriptions/' . $subscriptionId;
$response = $this->_http->put($path, ['subscription' => $attributes]);
return $this->_verifyGatewayResponse($response);
}
/*
* Manually retry charging a past due subscription
*
* @param string $subscriptionId the ID of the subscription with a charge being retried
* @param string $amount optional
* @param bool $submitForSettlement defaults to false unless specified true
*
* @return Transaction
*/
public function retryCharge($subscriptionId, $amount = null, $submitForSettlement = false)
{
$transaction_params = ['type' => Transaction::SALE,
'subscriptionId' => $subscriptionId];
if (isset($amount)) {
$transaction_params['amount'] = $amount;
}
if ($submitForSettlement) {
$transaction_params['options'] = ['submitForSettlement' => $submitForSettlement];
}
$path = $this->_config->merchantPath() . '/transactions';
$response = $this->_http->post($path, ['transaction' => $transaction_params]);
return $this->_verifyGatewayResponse($response);
}
/*
* Stops billing a payment method for a subscription. Cannot be reactivated
*
* @param string $subscriptionId to be canceled
*
* @return Subscription|Exception\NotFound
*/
public function cancel($subscriptionId)
{
$path = $this->_config->merchantPath() . '/subscriptions/' . $subscriptionId . '/cancel';
$response = $this->_http->put($path);
return $this->_verifyGatewayResponse($response);
}
private static function _createSignature()
{
return array_merge(
[
'billingDayOfMonth',
'firstBillingDate',
'createdAt',
'updatedAt',
'id',
'merchantAccountId',
'neverExpires',
'numberOfBillingCycles',
'paymentMethodToken',
'paymentMethodNonce',
'planId',
'price',
'trialDuration',
'trialDurationUnit',
'trialPeriod',
['descriptor' => ['name', 'phone', 'url']],
['options' => [
'doNotInheritAddOnsOrDiscounts',
'startImmediately',
['paypal' => ['description']]
]],
],
self::_addOnDiscountSignature()
);
}
private static function _updateSignature()
{
return array_merge(
[
'merchantAccountId', 'numberOfBillingCycles', 'paymentMethodToken', 'planId',
'paymentMethodNonce', 'id', 'neverExpires', 'price',
['descriptor' => ['name', 'phone', 'url']],
['options' => [
'prorateCharges',
'replaceAllAddOnsAndDiscounts',
'revertSubscriptionOnProrationFailure',
['paypal' => ['description']]
]],
],
self::_addOnDiscountSignature()
);
}
private static function _addOnDiscountSignature()
{
return [
[
'addOns' => [
['add' => ['amount', 'inheritedFromId', 'neverExpires', 'numberOfBillingCycles', 'quantity']],
['update' => ['amount', 'existingId', 'neverExpires', 'numberOfBillingCycles', 'quantity']],
['remove' => ['_anyKey_']],
]
],
[
'discounts' => [
['add' => ['amount', 'inheritedFromId', 'neverExpires', 'numberOfBillingCycles', 'quantity']],
['update' => ['amount', 'existingId', 'neverExpires', 'numberOfBillingCycles', 'quantity']],
['remove' => ['_anyKey_']],
]
]
];
}
private function _validateId($id = null)
{
if (empty($id)) {
throw new InvalidArgumentException(
'expected subscription id to be set'
);
}
if (!preg_match('/^[0-9A-Za-z_-]+$/', $id)) {
throw new InvalidArgumentException(
$id . ' is an invalid subscription id.'
);
}
}
private function _verifyGatewayResponse($response)
{
if (isset($response['subscription'])) {
return new Result\Successful(
Subscription::factory($response['subscription'])
);
} elseif (isset($response['transaction'])) {
// return a populated instance of Transaction, for subscription retryCharge
return new Result\Successful(
Transaction::factory($response['transaction'])
);
} elseif (isset($response['apiErrorResponse'])) {
return new Result\Error($response['apiErrorResponse']);
} else {
throw new Exception\Unexpected(
"Expected subscription, transaction, or apiErrorResponse"
);
}
}
}