PHP Класс RakutenRws_Client

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$accessToken
$accessTokenInfo
$affiliateId
$developerId
$httpClient
$options
$redirectUrl
$secret

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

Метод Описание
__construct ( RakutenRws_HttpClient $httpClient = null, $options = [] ) Constructor.
execute ( string $operation, array $parameter = [], string $version = null ) Executes API
fetchAccessTokenFromCode ( string $code = null ) : string Fetches OAuth2 AccessToken from Code
getAccessToken ( ) : string | null Gets the fetched AccessToken
getAccessTokenUrl ( ) : string Gets OAuth2 Access Token URL
getAffiliateId ( ) : string | null Gets AffilateID
getApplicationId ( ) : string | null Gets DeveloperID
getAuthorizeUrl ( string $scope ) : string Gets OAuth2 Authorize URL
getHttpClient ( ) : RakutenRws_HttpClient Gets Http Client instance
setAffiliateId ( string $affiliateId ) Sets the AffiliateID
setApplicationId ( string $developerId ) Sets the DeveloperID
setProxy ( string $proxy ) Sets the proxy to use connect rakuten service
setRedirectUrl ( string $redirectUrl ) Sets Redirect Url
setSecret ( string $secret ) Sets Application Secret

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

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

Constructor.
public __construct ( RakutenRws_HttpClient $httpClient = null, $options = [] )
$httpClient RakutenRws_HttpClient HTTP Client instance

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

Executes API
public execute ( string $operation, array $parameter = [], string $version = null )
$operation string The operation name
$parameter array The request parameter
$version string The API version

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

Fetches OAuth2 AccessToken from Code
public fetchAccessTokenFromCode ( string $code = null ) : string
$code string The Code
Результат string The Access Token, If response is invalid return null

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

Gets the fetched AccessToken
public getAccessToken ( ) : string | null
Результат string | null The AccessToken

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

Gets OAuth2 Access Token URL
public getAccessTokenUrl ( ) : string
Результат string The OAuth2 Access Token URL

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

Gets AffilateID
public getAffiliateId ( ) : string | null
Результат string | null The AffiliateID

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

Gets DeveloperID
public getApplicationId ( ) : string | null
Результат string | null The DeveloperID

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

Gets OAuth2 Authorize URL
public getAuthorizeUrl ( string $scope ) : string
$scope string The scopes that is separated by ','
Результат string The Authorize URL

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

Gets Http Client instance
public getHttpClient ( ) : RakutenRws_HttpClient
Результат RakutenRws_HttpClient The Http Client

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

Sets the AffiliateID
public setAffiliateId ( string $affiliateId )
$affiliateId string The AffiliateID

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

Sets the DeveloperID
public setApplicationId ( string $developerId )
$developerId string The DeveloperID

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

Sets the proxy to use connect rakuten service
public setProxy ( string $proxy )
$proxy string The proxy

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

Sets Redirect Url
public setRedirectUrl ( string $redirectUrl )
$redirectUrl string The Redirect URL

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

Sets Application Secret
public setSecret ( string $secret )
$secret string The Application Secret

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

$accessToken защищенное свойство

protected $accessToken

$accessTokenInfo защищенное свойство

protected $accessTokenInfo

$affiliateId защищенное свойство

protected $affiliateId

$developerId защищенное свойство

protected $developerId

$httpClient защищенное свойство

protected $httpClient

$options защищенное свойство

protected $options

$redirectUrl защищенное свойство

protected $redirectUrl

$secret защищенное свойство

protected $secret