Docs For Class Zend_Oauth

Description

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
abstract:
license: New BSD License

Direct descendents

Class	Description
Zend_Oauth_Token_AuthorizedRequest
Zend_Oauth_Token_Access
Zend_Oauth_Token_Request

Class Constant Summary

TOKEN_PARAM_CALLBACK_CONFIRMED = 'oauth_callback_confirmed'

TOKEN_PARAM_KEY = 'oauth_token'

TOKEN_SECRET_PARAM_KEY = 'oauth_token_secret'

Variable Summary

Zend_Oauth_Http_Utility $_httpUtility

array $_params

Zend_Http_Response $_response

Method Summary

void __construct ([ $response = null], [Zend_Oauth_Http_Utility $utility = null])

mixed getParam (string $key)

Zend_Http_Response getResponse ()

string getToken ()

string getTokenSecret ()

bool isValid ()

Zend_Oauth_Token setParam (string $key, string $value)

Zend_Oauth_Token setParams ( $params)

Zend_Oauth_Token setToken (string $token)

Zend_Oauth_Token setTokenSecret (string $secret)

string toString ()

array _parseParameters ( $response)

string __get ( $key)

void __set (string $key, string $value)

void __sleep ()

string __toString ()

void __wakeup ()

Variables

Zend_Oauth_Http_Utility $_httpUtility = null (line 58)

access: protected

array $_params = array() (line 46)

Token parameters

access: protected

Zend_Http_Response $_response = null (line 53)

OAuth response object

access: protected

Methods

Constructor __construct (line 67)

Constructor; basic setup for any Token subclass.

access: public

void __construct ([ $response = null], [Zend_Oauth_Http_Utility $utility = null])

null|Zend_Http_Response $response
null|Zend_Oauth_Http_Utility $utility

Redefined in descendants as:

Zend_Oauth_Token_AuthorizedRequest::__construct() : Constructor
Zend_Oauth_Token_Request::__construct() : Constructor

getParam (line 171)

Get the value for a parameter (e.g. token secret or other).

access: public

mixed getParam (string $key)

string $key

getResponse (line 107)

Return the HTTP response object used to initialise this instance.

access: public

Zend_Http_Response getResponse ()

getToken (line 196)

Gets the value for a Token.

access: public

string getToken ()

getTokenSecret (line 131)

Retrieve this Token's secret which may be used when signing requests with this Token.

access: public

string getTokenSecret ()

isValid (line 91)

Attempts to validate the Token parsed from the HTTP response - really it's just very basic existence checks which are minimal.

access: public

bool isValid ()

Redefined in descendants as:

Zend_Oauth_Token_AuthorizedRequest::isValid() : Indicate if token is valid

setParam (line 144)

Sets the value for a parameter (e.g. token secret or other) and run a simple filter to remove any trailing newlines.

access: public

Zend_Oauth_Token setParam (string $key, string $value)

string $key
string $value

setParams (line 157)

Sets the value for some parameters (e.g. token secret or other) and run a simple filter to remove any trailing newlines.

access: public

Zend_Oauth_Token setParams ( $params)

array $params

setToken (line 185)

Sets the value for a Token.

access: public

Zend_Oauth_Token setToken (string $token)

string $token

setTokenSecret (line 119)

Sets the value for the this Token's secret which may be used when signing requests with this Token.

access: public

Zend_Oauth_Token setTokenSecret (string $secret)

string $secret

toString (line 228)

Convert Token to a string, specifically a raw encoded query string.

access: public

string toString ()

_parseParameters (line 251)

Parse a HTTP response body and collect returned parameters as raw url decoded key-value pairs in an associative array.

access: protected

array _parseParameters ( $response)

Zend_Http_Response $response

__get (line 206)

Generic accessor to enable access as public properties.

access: public

string __get ( $key)

$key

__set (line 218)

Generic mutator to enable access as public properties.

access: public

void __set (string $key, string $value)

string $key
string $value

__sleep (line 271)

Limit serialisation stored data to the parameters

access: public

void __sleep ()

__toString (line 239)

Convert Token to a string, specifically a raw encoded query string.

Aliases to self::toString()

access: public

string __toString ()

__wakeup (line 279)

After serialisation, re-instantiate a HTTP utility class for use

access: public

void __wakeup ()

Class Constants

TOKEN_PARAM_CALLBACK_CONFIRMED = 'oauth_callback_confirmed' (line 38)

TOKEN_PARAM_KEY = 'oauth_token' (line 36)

TOKEN_SECRET_PARAM_KEY = 'oauth_token_secret' (line 37)