Fuman
\

\OAuthSimple

OAuthSimple - A simpler version of OAuth

https://github.com/jrconlin/oauthsimple

Summary

Methods
Properties
Constants
__construct()
reset()
setParameters()
setQueryString()
setURL()
setPath()
setAction()
signatures()
setTokensAndSecrets()
setSignatureMethod()
sign()
getHeaderString()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
_parseParameterString()
_oauthEscape()
_getNonce()
_getApiKey()
_getAccessToken()
_getTimeStamp()
_normalizedParameters()
_generateSignature()
$_secrets
$_default_signature_method
$_action
$_nonce_chars
N/A

Properties

$_secrets

$_secrets :

Type

$_default_signature_method

$_default_signature_method :

Type

$_action

$_action :

Type

$_nonce_chars

$_nonce_chars :

Type

Methods

__construct()

__construct(  $APIKey = "",   $sharedSecret = "") : \OAuthSimple

Constructor

Parameters

$APIKey
$sharedSecret

Returns

\OAuthSimple —

(Object)

reset()

reset() : \OAuthSimple

Reset the parameters and URL

Returns

\OAuthSimple —

(Object)

setParameters()

setParameters(  $parameters = array()) : \OAuthSimple

Set the parameters either from a hash or a string

Parameters

$parameters

Returns

\OAuthSimple —

(Object)

setQueryString()

setQueryString(  $parameters)

Convenience method for setParameters

Parameters

$parameters

setURL()

setURL(  $path) : \OAuthSimple

Set the target URL (does not include the parameters)

Parameters

$path

Returns

\OAuthSimple —

(Object)

setPath()

setPath(  $path)

Convenience method for setURL

Parameters

$path

setAction()

setAction(  $action) : \OAuthSimple

Set the "action" for the url, (e.g. GET,POST, DELETE, etc.)

Parameters

$action

Returns

\OAuthSimple —

(Object)

signatures()

signatures(  $signatures) : \OAuthSimple

Set the signatures (as well as validate the ones you have)

Parameters

$signatures

Returns

\OAuthSimple —

(Object)

setTokensAndSecrets()

setTokensAndSecrets(  $signatures)

Parameters

$signatures

setSignatureMethod()

setSignatureMethod(  $method = "") : \OAuthSimple

Set the signature method (currently only Plaintext or SHA-MAC1)

Parameters

$method

Returns

\OAuthSimple —

(Object)

sign()

sign(  $args = array()) : \(Array)

sign the request

note: all arguments are optional, provided you've set them using the other helper functions.

Parameters

$args

Returns

\(Array) —

signed values

getHeaderString()

getHeaderString(  $args = array()) : \$result

Return a formatted "header" string

NOTE: This doesn't set the "Authorization: " prefix, which is required. It's not set because various set header functions prefer different ways to do that.

Parameters

$args

Returns

\$result —

(String)

_parseParameterString()

_parseParameterString(  $paramString)

Parameters

$paramString

_oauthEscape()

_oauthEscape(  $string)

Parameters

$string

_getNonce()

_getNonce(  $length = 5)

Parameters

$length

_getApiKey()

_getApiKey()

_getAccessToken()

_getAccessToken()

_getTimeStamp()

_getTimeStamp()

_normalizedParameters()

_normalizedParameters()

_generateSignature()

_generateSignature()