This repository has been archived on 2026-04-06. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
PayPal-PHP-SDK/lib/PayPal/Auth/OAuthTokenCredential.php
Moritz Spindelhirn 71bd99c0e6 fixed namespace of PPConfigurationException
the PPConfigurationException class is not in the used \PayPal\Auth namespace
2013-04-29 19:05:14 +03:00

134 lines
3.9 KiB
PHP

<?php
namespace PayPal\Auth;
/**
* Oauth Token credential
*
*/
use PayPal\Rest\RestHandler;
use PayPal\Common\UserAgent;
class OAuthTokenCredential {
private static $expiryBufferTime = 120;
private $logger;
/**
* Client ID as obtained from the developer portal
*/
private $clientId;
/**
* Client secret as obtained from the developer portal
*/
private $clientSecret;
/**
* Generated Access Token
*/
private $accessToken;
/**
* Seconds for with access token is valid
*/
private $tokenExpiresIn;
/**
* Last time (in milliseconds) when access token was generated
*/
private $tokenCreateTime;
/**
*
* @param string $clientId client id obtained from the developer portal
* @param string $clientSecret client secret obtained from the developer portal
*/
public function __construct($clientId, $clientSecret) {
$this->clientId = $clientId;
$this->clientSecret = $clientSecret;
}
/**
* @return the accessToken
*/
public function getAccessToken($config) {
$this->logger = new \PPLoggingManager(__CLASS__, $config);
// Check if Access Token is not null and has not expired.
// The API returns expiry time as a relative time unit
// We use a buffer time when checking for token expiry to account
// for API call delays and any delay between the time the token is
// retrieved and subsequently used
if ($this->accessToken != null &&
(time() - $this->tokenCreateTime) > ($this->tokenExpiresIn - self::$expiryBufferTime)) {
$this->accessToken = null;
}
// If accessToken is Null, obtain a new token
if ($this->accessToken == null) {
$this->_generateAccessToken($config);
}
return $this->accessToken;
}
/**
* Generates a new access token
*/
private function _generateAccessToken($config) {
$base64ClientID = base64_encode($this->clientId . ":" . $this->clientSecret);
$headers = array(
"User-Agent" => \PPUserAgent::getValue(RestHandler::$sdkName, RestHandler::$sdkVersion),
"Authorization" => "Basic " . $base64ClientID,
"Accept" => "*/*"
);
$httpConfiguration = $this->getOAuthHttpConfiguration($config);
$httpConfiguration->setHeaders($headers);
$connection = \PPConnectionManager::getInstance()->getConnection($httpConfiguration, $config);
$res = $connection->execute("grant_type=client_credentials");
$jsonResponse = json_decode($res, true);
if($jsonResponse == NULL ||
!isset($jsonResponse["access_token"]) || !isset($jsonResponse["expires_in"]) ) {
$this->accessToken = NULL;
$this->tokenExpiresIn = NULL;
$this->logger->warning("Could not generate new Access token. Invalid response from server: " . $jsonResponse);
} else {
$this->accessToken = $jsonResponse["access_token"];
$this->tokenExpiresIn = $jsonResponse["expires_in"];
}
$this->tokenCreateTime = time();
return $this->accessToken;
}
/*
* Get HttpConfiguration object for OAuth API
*/
private function getOAuthHttpConfiguration($config) {
if (isset($config['oauth.EndPoint'])) {
$baseEndpoint = $config['oauth.EndPoint'];
} else if (isset($config['service.EndPoint'])) {
$baseEndpoint = $config['service.EndPoint'];
} else if (isset($config['mode'])) {
switch (strtoupper($config['mode'])) {
case 'SANDBOX':
$baseEndpoint = \PPConstants::REST_SANDBOX_ENDPOINT;
break;
case 'LIVE':
$baseEndpoint = \PPConstants::REST_LIVE_ENDPOINT;
break;
default:
throw new \PPConfigurationException('The mode config parameter must be set to either sandbox/live');
}
} else {
throw new \PPConfigurationException('You must set one of service.endpoint or mode parameters in your configuration');
}
$baseEndpoint = rtrim(trim($baseEndpoint), '/');
return new \PPHttpConfig($baseEndpoint . "/v1/oauth2/token", "POST");
}
}