Zend Framework  1.12
Public Member Functions | Static Public Member Functions | List of all members
Zend_Oauth_Http_Utility Class Reference

Public Member Functions

 assembleParams ($url, Zend_Oauth_Config_ConfigInterface $config, array $serviceProviderParams=null)
 Assemble all parameters for a generic OAuth request - i.e.
 
 toEncodedQueryString (array $params, $customParamsOnly=false)
 Given both OAuth parameters and any custom parametere, generate an encoded query string.
 
 toAuthorizationHeader (array $params, $realm=null, $excludeCustomParams=true)
 Cast to authorization header.
 
 sign (array $params, $signatureMethod, $consumerSecret, $tokenSecret=null, $method=null, $url=null)
 Sign request.
 
 parseQueryString ($query)
 Parse query string.
 
 generateNonce ()
 Generate nonce.
 
 generateTimestamp ()
 Generate timestamp.
 

Static Public Member Functions

static urlEncode ($value)
 urlencode a value
 

Member Function Documentation

assembleParams (   $url,
Zend_Oauth_Config_ConfigInterface  $config,
array  $serviceProviderParams = null 
)

Assemble all parameters for a generic OAuth request - i.e.

no special params other than the defaults expected for any OAuth query.

Parameters
string$url
Zend_Oauth_Config_ConfigInterface$config
null | array$serviceProviderParams
Returns
array
generateNonce ( )

Generate nonce.

Returns
string
generateTimestamp ( )

Generate timestamp.

Returns
int
parseQueryString (   $query)

Parse query string.

Parameters
mixed$query
Returns
array
sign ( array  $params,
  $signatureMethod,
  $consumerSecret,
  $tokenSecret = null,
  $method = null,
  $url = null 
)

Sign request.

Parameters
array$params
string$signatureMethod
string$consumerSecret
null | string$tokenSecret
null | string$method
null | string$url
Returns
string
toAuthorizationHeader ( array  $params,
  $realm = null,
  $excludeCustomParams = true 
)

Cast to authorization header.

Parameters
array$params
null | string$realm
bool$excludeCustomParams
Returns
void
toEncodedQueryString ( array  $params,
  $customParamsOnly = false 
)

Given both OAuth parameters and any custom parametere, generate an encoded query string.

This method expects parameters to have been assembled and signed beforehand.

Parameters
array$params
bool$customParamsOnlyIgnores OAuth params e.g. for requests using OAuth Header
Returns
string
static urlEncode (   $value)
static

urlencode a value

Parameters
string$value
Returns
string