PHP Класс PayPal\Auth\OAuthTokenCredential

Наследование: extends PayPal\Common\PayPalResourceModel
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$AUTH_HANDLER Default Auth Handler
$CACHE_PATH
$expiryBufferTime integer Private Variable

Открытые методы

Метод Описание
__construct ( string $clientId, string $clientSecret ) Construct
decrypt ( $data ) : string Helper method to decrypt data using clientSecret as key
encrypt ( $data ) : string Helper method to encrypt data using clientSecret as key
getAccessToken ( $config ) : null | string Get AccessToken
getClientId ( ) : string Get Client ID
getClientSecret ( ) : string Get Client Secret
getRefreshToken ( $config, $authorizationCode = null, array $params = [] ) : string | null Get a Refresh Token from Authorization Code
updateAccessToken ( array $config, string | null $refreshToken = null ) : string Updates Access Token based on given input

Защищенные методы

Метод Описание
getToken ( array $config, string $clientId, string $clientSecret, string $payload ) : mixed Retrieves the token based on the input configuration

Приватные методы

Метод Описание
generateAccessToken ( array $config, null | string $refreshToken = null ) : null Generates a new access token

Описание методов

__construct() публичный Метод

Construct
public __construct ( string $clientId, string $clientSecret )
$clientId string client id obtained from the developer portal
$clientSecret string client secret obtained from the developer portal

decrypt() публичный Метод

Helper method to decrypt data using clientSecret as key
public decrypt ( $data ) : string
$data
Результат string

encrypt() публичный Метод

Helper method to encrypt data using clientSecret as key
public encrypt ( $data ) : string
$data
Результат string

getAccessToken() публичный Метод

Get AccessToken
public getAccessToken ( $config ) : null | string
$config
Результат null | string

getClientId() публичный Метод

Get Client ID
public getClientId ( ) : string
Результат string

getClientSecret() публичный Метод

Get Client Secret
public getClientSecret ( ) : string
Результат string

getRefreshToken() публичный Метод

Get a Refresh Token from Authorization Code
public getRefreshToken ( $config, $authorizationCode = null, array $params = [] ) : string | null
$config
$authorizationCode
$params array optional arrays to override defaults
Результат string | null

getToken() защищенный Метод

Retrieves the token based on the input configuration
protected getToken ( array $config, string $clientId, string $clientSecret, string $payload ) : mixed
$config array
$clientId string
$clientSecret string
$payload string
Результат mixed

updateAccessToken() публичный Метод

Updates Access Token based on given input
public updateAccessToken ( array $config, string | null $refreshToken = null ) : string
$config array
$refreshToken string | null
Результат string

Описание свойств

$AUTH_HANDLER публичное статическое свойство

Default Auth Handler
public static $AUTH_HANDLER

$CACHE_PATH публичное статическое свойство

public static $CACHE_PATH

$expiryBufferTime публичное статическое свойство

Private Variable
public static int $expiryBufferTime
Результат integer