\Zend_Oauth_Token
- Copyright: Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
- License: http://framework.zend.com/license/new-bsd New BSD License
Synopsis
class Zend_Oauth_Token
{
- // constants
- const TOKEN_PARAM_KEY = 'oauth_token';
- const TOKEN_SECRET_PARAM_KEY = 'oauth_token_secret';
- const TOKEN_PARAM_CALLBACK_CONFIRMED = 'oauth_callback_confirmed';
- // members
- protected array $_params = ;
- protected Zend_Http_Response $_response = NULL;
- protected Zend_Oauth_Http_Utility $_httpUtility = NULL;
- // methods
- public void __construct()
- public bool isValid()
- public Zend_Http_Response getResponse()
- public Zend_Oauth_Token setTokenSecret()
- public string getTokenSecret()
- public Zend_Oauth_Token setParam()
- public Zend_Oauth_Token setParams()
- public mixed getParam()
- public Zend_Oauth_Token setToken()
- public string getToken()
- public string __get()
- public void __set()
- public string toString()
- public string __toString()
- protected array _parseParameters()
- public void __sleep()
- public void __wakeup()
Constants
Name | Value |
---|---|
TOKEN_PARAM_KEY | 'oauth_token' |
TOKEN_SECRET_PARAM_KEY | 'oauth_token_secret' |
TOKEN_PARAM_CALLBACK_CONFIRMED | 'oauth_callback_confirmed' |
Members
protected
- $_httpUtility — Zend_Oauth_Http_Utility
- $_params
—
array
Token parameters - $_response
—
Zend_Http_Response
OAuth response object
Methods
protected
- _parseParameters() — Parse a HTTP response body and collect returned parameters as raw url decoded key-value pairs in an associative array.
public
- __construct() — Constructor; basic setup for any Token subclass.
- __get() — Generic accessor to enable access as public properties.
- __set() — Generic mutator to enable access as public properties.
- __sleep() — Limit serialisation stored data to the parameters
- __toString() — Convert Token to a string, specifically a raw encoded query string.
- __wakeup() — After serialisation, re-instantiate a HTTP utility class for use
- getParam() — Get the value for a parameter (e.g. token secret or other).
- getResponse() — Return the HTTP response object used to initialise this instance.
- getToken() — Gets the value for a Token.
- getTokenSecret() — Retrieve this Token's secret which may be used when signing requests with this Token.
- isValid() — Attempts to validate the Token parsed from the HTTP response - really it's just very basic existence checks which are minimal.
- setParam() — Sets the value for a parameter (e.g. token secret or other) and run a simple filter to remove any trailing newlines.
- setParams() — Sets the value for some parameters (e.g. token secret or other) and run a simple filter to remove any trailing newlines.
- setToken() — Sets the value for a Token.
- setTokenSecret() — Sets the value for the this Token's secret which may be used when signing requests with this Token.
- toString() — Convert Token to a string, specifically a raw encoded query string.