Property | Type | Description | |
---|---|---|---|
$path | |||
$sbs |
Method | Description | |
---|---|---|
__construct ( string $APIKey = "", string $sharedSecret = "" ) : OAuthSimple | Constructor | |
getHeaderString ( array $args = [] ) : string | Return a formatted "header" string | |
reset ( ) : OAuthSimple | Reset the parameters and URL | |
setAction ( string $action ) : OAuthSimple | Set the "action" for the url, (e.g. GET,POST, DELETE, etc.) | |
setParameters ( string | array | object $parameters = [] ) : OAuthSimple | Set the parameters either from a hash or a string | |
setPath ( string $path ) : mixed | Convenience method for setURL | |
setQueryString ( $parameters ) : OAuthSimple | Convenience method for setParameters | |
setSignatureMethod ( string $method = "" ) : string | Set the signature method (currently only Plaintext or SHA-MAC1) | |
setTokensAndSecrets ( $signatures ) : OAuthSimple | ||
setURL ( string $path ) : OAuthSimple | Set the target URL (does not include the parameters) | |
sign ( array $args = [] ) : array | sign the request | |
signatures ( $signatures ) : OAuthSimple | Set the signatures (as well as validate the ones you have) |
Method | Description | |
---|---|---|
_generateSignature ( $parameters = "" ) | ||
_getAccessToken ( ) | ||
_getApiKey ( ) | ||
_getNonce ( $length = 5 ) | ||
_getTimeStamp ( ) | ||
_normalizedParameters ( ) | ||
_oauthEscape ( $string ) | ||
_parseParameterString ( $paramString ) |
public __construct ( string $APIKey = "", string $sharedSecret = "" ) : OAuthSimple | ||
$APIKey | string | The API Key (sometimes referred to as the consumer key) This value is usually supplied by the site you wish to use. |
$sharedSecret | string | The shared secret. This value is also usually provided by the site you wish to use. |
return | OAuthSimple |
public getHeaderString ( array $args = [] ) : string | ||
$args | array | |
return | string |
public reset ( ) : OAuthSimple | ||
return | OAuthSimple |
public setQueryString ( $parameters ) : OAuthSimple | ||
$parameters | ||
return | OAuthSimple |
public setSignatureMethod ( string $method = "" ) : string | ||
$method | string | Method of signing the transaction (only PLAINTEXT and SHA-MAC1 allowed for now) |
return | string | OAuthSimple |
public setTokensAndSecrets ( $signatures ) : OAuthSimple | ||
$signatures | ||
return | OAuthSimple |
public signatures ( $signatures ) : OAuthSimple | ||
$signatures | (object) object/hash of the token/signature pairs {api_key:, shared_secret:, oauth_token: oauth_secret:} | |
return | OAuthSimple |