category Zend
package Zend_Oauth
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
inherited_from \Zend_Oauth_Token

 Methods

Constructor

__construct(null|\Zend_Http_Response $response = null, null|\Zend_Oauth_Http_Utility $utility = null
inherited_from \Zend_Oauth_Token::__construct()

Parameters

$response

null\Zend_Http_Response

$utility

null\Zend_Oauth_Http_Utility

Constructor; basic setup for any Token subclass.

__construct(null|\Zend_Http_Response $response = null, null|\Zend_Oauth_Http_Utility $utility = null) : void
Inherited

Parameters

$response

null\Zend_Http_Response

$utility

null\Zend_Oauth_Http_Utility

Generic accessor to enable access as public properties.

__get($key) : string
Inherited

Parameters

$key

Returns

string

Generic mutator to enable access as public properties.

__set(string $key, string $value) : void
Inherited

Parameters

$key

string

$value

string

Limit serialisation stored data to the parameters

__sleep() 
Inherited

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

__toString() : string
Inherited

Aliases to self::toString()

Returns

string

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

__wakeup() 
Inherited

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

getParam(string $key) : mixed
Inherited

Parameters

$key

string

Returns

mixed

Return the HTTP response object used to initialise this instance.

getResponse() : \Zend_Http_Response
Inherited

Returns

\Zend_Http_Response

Gets the value for a Token.

getToken() : string
Inherited

Returns

string

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

getTokenSecret() : string
Inherited

Returns

string

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

isValid() : boolean
Inherited

Returns

boolean

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

setParam(string $key, string $value) : \Zend_Oauth_Token
Inherited

Parameters

$key

string

$value

string

Returns

\Zend_Oauth_Token

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

setParams(array $params) : \Zend_Oauth_Token
Inherited

Parameters

$params

array

Returns

\Zend_Oauth_Token

Sets the value for a Token.

setToken(string $token) : \Zend_Oauth_Token
Inherited

Parameters

$token

string

Returns

\Zend_Oauth_Token

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

setTokenSecret(string $secret) : \Zend_Oauth_Token
Inherited

Parameters

$secret

string

Returns

\Zend_Oauth_Token

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

toString() : string
Inherited

Returns

string

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

_parseParameters(\Zend_Http_Response $response) : array
Inherited

Parameters

$response

\Zend_Http_Response

Returns

array

 Properties

 

$_httpUtility

$_httpUtility : \Zend_Oauth_Http_Utility

Default

null
 

Token parameters

$_params : array

Default

array()
 

OAuth response object

$_response : \Zend_Http_Response

Default

null

 Constants

 

TOKEN_PARAM_CALLBACK_CONFIRMED

TOKEN_PARAM_CALLBACK_CONFIRMED = 'oauth_callback_confirmed' 
 

TOKEN_PARAM_KEY

TOKEN_PARAM_KEY = 'oauth_token' 
 

TOKEN_SECRET_PARAM_KEY

TOKEN_SECRET_PARAM_KEY = 'oauth_token_secret'