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

Public Member Functions

 toHeader ($url, Zend_Oauth_Config_ConfigInterface $config, array $customParams=null, $realm=null)
 Cast to HTTP header.
 
 toQueryString ($url, Zend_Oauth_Config_ConfigInterface $config, array $params=null)
 Cast to HTTP query string.
 
 getHttpClient (array $oauthOptions, $uri=null, $config=null, $excludeCustomParamsFromHeader=true)
 Get OAuth client.
 
- Public Member Functions inherited from Zend_Oauth_Token
 __construct (Zend_Http_Response $response=null, Zend_Oauth_Http_Utility $utility=null)
 Constructor; basic setup for any Token subclass.
 
 isValid ()
 Attempts to validate the Token parsed from the HTTP response - really it's just very basic existence checks which are minimal.
 
 getResponse ()
 Return the HTTP response object used to initialise this instance.
 
 setTokenSecret ($secret)
 Sets the value for the this Token's secret which may be used when signing requests with this Token.
 
 getTokenSecret ()
 Retrieve this Token's secret which may be used when signing requests with this Token.
 
 setParam ($key, $value)
 Sets the value for a parameter (e.g.
 
 setParams (array $params)
 Sets the value for some parameters (e.g.
 
 getParam ($key)
 Get the value for a parameter (e.g.
 
 setToken ($token)
 Sets the value for a Token.
 
 getToken ()
 Gets the value for a Token.
 
 __get ($key)
 Generic accessor to enable access as public properties.
 
 __set ($key, $value)
 Generic mutator to enable access as public properties.
 
 toString ()
 Convert Token to a string, specifically a raw encoded query string.
 
 __toString ()
 Convert Token to a string, specifically a raw encoded query string.
 
 __sleep ()
 Limit serialisation stored data to the parameters.
 
 __wakeup ()
 After serialisation, re-instantiate a HTTP utility class for use.
 

Additional Inherited Members

- Public Attributes inherited from Zend_Oauth_Token
const TOKEN_PARAM_KEY = 'oauth_token'
 @+ Token constants
 
const TOKEN_SECRET_PARAM_KEY = 'oauth_token_secret'
 
const TOKEN_PARAM_CALLBACK_CONFIRMED = 'oauth_callback_confirmed'
 
- Protected Member Functions inherited from Zend_Oauth_Token
 _parseParameters (Zend_Http_Response $response)
 Parse a HTTP response body and collect returned parameters as raw url decoded key-value pairs in an associative array.
 
- Protected Attributes inherited from Zend_Oauth_Token
 $_params = array()
 
 $_response = null
 
 $_httpUtility = null
 

Member Function Documentation

getHttpClient ( array  $oauthOptions,
  $uri = null,
  $config = null,
  $excludeCustomParamsFromHeader = true 
)

Get OAuth client.

Parameters
array$oauthOptions
null | string$uri
null | array | Zend_Config$config
bool$excludeCustomParamsFromHeader
Returns
Zend_Oauth_Client
toHeader (   $url,
Zend_Oauth_Config_ConfigInterface  $config,
array  $customParams = null,
  $realm = null 
)

Cast to HTTP header.

Parameters
string$url
Zend_Oauth_Config_ConfigInterface$config
null | array$customParams
null | string$realm
Returns
string
toQueryString (   $url,
Zend_Oauth_Config_ConfigInterface  $config,
array  $params = null 
)

Cast to HTTP query string.

Parameters
mixed$url
Zend_Oauth_Config_ConfigInterface$config
null | array$params
Returns
string