123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178 |
- <?php
- namespace Braintree;
- use InvalidArgumentException;
- /**
- * Braintree PayPalAccountGateway module
- *
- * @package Braintree
- * @category Resources
- */
- /**
- * Manages Braintree PayPalAccounts
- *
- * <b>== More information ==</b>
- *
- *
- * @package Braintree
- * @category Resources
- */
- class PayPalAccountGateway
- {
- private $_gateway;
- private $_config;
- private $_http;
- public function __construct($gateway)
- {
- $this->_gateway = $gateway;
- $this->_config = $gateway->config;
- $this->_config->assertHasAccessTokenOrKeys();
- $this->_http = new Http($gateway->config);
- }
- /**
- * find a paypalAccount by token
- *
- * @access public
- * @param string $token paypal accountunique id
- * @return PayPalAccount
- * @throws Exception\NotFound
- */
- public function find($token)
- {
- $this->_validateId($token);
- try {
- $path = $this->_config->merchantPath() . '/payment_methods/paypal_account/' . $token;
- $response = $this->_http->get($path);
- return PayPalAccount::factory($response['paypalAccount']);
- } catch (Exception\NotFound $e) {
- throw new Exception\NotFound(
- 'paypal account with token ' . $token . ' not found'
- );
- }
- }
- /**
- * updates the paypalAccount record
- *
- * if calling this method in context, $token
- * is the 2nd attribute. $token is not sent in object context.
- *
- * @access public
- * @param array $attributes
- * @param string $token (optional)
- * @return Result\Successful or Result\Error
- */
- public function update($token, $attributes)
- {
- Util::verifyKeys(self::updateSignature(), $attributes);
- $this->_validateId($token);
- return $this->_doUpdate('put', '/payment_methods/paypal_account/' . $token, ['paypalAccount' => $attributes]);
- }
- public function delete($token)
- {
- $this->_validateId($token);
- $path = $this->_config->merchantPath() . '/payment_methods/paypal_account/' . $token;
- $this->_http->delete($path);
- return new Result\Successful();
- }
- /**
- * create a new sale for the current PayPal account
- *
- * @param string $token
- * @param array $transactionAttribs
- * @return Result\Successful|Result\Error
- * @see Transaction::sale()
- */
- public function sale($token, $transactionAttribs)
- {
- $this->_validateId($token);
- return Transaction::sale(
- array_merge(
- $transactionAttribs,
- ['paymentMethodToken' => $token]
- )
- );
- }
- public static function updateSignature()
- {
- return [
- 'token',
- ['options' => ['makeDefault']]
- ];
- }
- /**
- * sends the update request to the gateway
- *
- * @ignore
- * @param string $subPath
- * @param array $params
- * @return mixed
- */
- private function _doUpdate($httpVerb, $subPath, $params)
- {
- $fullPath = $this->_config->merchantPath() . $subPath;
- $response = $this->_http->$httpVerb($fullPath, $params);
- return $this->_verifyGatewayResponse($response);
- }
- /**
- * generic method for validating incoming gateway responses
- *
- * creates a new PayPalAccount object and encapsulates
- * it inside a Result\Successful object, or
- * encapsulates a Errors object inside a Result\Error
- * alternatively, throws an Unexpected exception if the response is invalid.
- *
- * @ignore
- * @param array $response gateway response values
- * @return Result\Successful|Result\Error
- * @throws Exception\Unexpected
- */
- private function _verifyGatewayResponse($response)
- {
- if (isset($response['paypalAccount'])) {
- // return a populated instance of PayPalAccount
- return new Result\Successful(
- PayPalAccount::factory($response['paypalAccount'])
- );
- } else if (isset($response['apiErrorResponse'])) {
- return new Result\Error($response['apiErrorResponse']);
- } else {
- throw new Exception\Unexpected(
- 'Expected paypal account or apiErrorResponse'
- );
- }
- }
- /**
- * verifies that a valid paypal account identifier is being used
- * @ignore
- * @param string $identifier
- * @param Optional $string $identifierType type of identifier supplied, default 'token'
- * @throws InvalidArgumentException
- */
- private function _validateId($identifier = null, $identifierType = 'token')
- {
- if (empty($identifier)) {
- throw new InvalidArgumentException(
- 'expected paypal account id to be set'
- );
- }
- if (!preg_match('/^[0-9A-Za-z_-]+$/', $identifier)) {
- throw new InvalidArgumentException(
- $identifier . ' is an invalid paypal account ' . $identifierType . '.'
- );
- }
- }
- }
- class_alias('Braintree\PayPalAccountGateway', 'Braintree_PayPalAccountGateway');
|