API Documentation
\

\Horde_Oauth_Request

OAuth request class

Summary

Methods
Properties
Constants
__construct()
sign()
getSignatureBaseString()
buildHttpQuery()
buildAuthorizationHeader()
No public properties found
VERSION
_generateNonce()
_getSignableParameters()
_getNormalizedHttpMethod()
_getNormalizedUrl()
$_params
$_url
$_method
N/A
No private methods found
No private properties found
N/A

Constants

VERSION

VERSION

Properties

$_params

$_params :

Type

$_url

$_url :

Type

$_method

$_method :

Type

Methods

__construct()

__construct(  $url,   $params = array(),   $method = 'POST')

Parameters

$url
$params
$method

sign()

sign(  $signatureMethod,   $consumer,   $token = null) : \unknown_type

Sign this request in accordance with OAuth

Parameters

$signatureMethod
$consumer
$token

Returns

\unknown_type

getSignatureBaseString()

getSignatureBaseString()

Returns the signable string of this request

The base string is defined as the method, the url and the parameters (normalized), each urlencoded and concatenated with &.

buildHttpQuery()

buildHttpQuery()

Get a query string suitable for use in a URL or as POST data.

buildAuthorizationHeader()

buildAuthorizationHeader(  $realm = '')

Parameters

$realm

_generateNonce()

_generateNonce()

Generate a nonce.

_getSignableParameters()

_getSignableParameters() : string

Returns the normalized parameters of the request

This will be all parameters except oauth_signature, sorted first by key, and if there are duplicate keys, then by value.

The returned string will be all the key=value pairs concatenated by &.

Returns

string

_getNormalizedHttpMethod()

_getNormalizedHttpMethod()

Uppercases the HTTP method

_getNormalizedUrl()

_getNormalizedUrl()

Parse the url and rebuilds it to be scheme://host/path