Zend_Oauth_Token Class Reference

Inheritance diagram for Zend_Oauth_Token:

Public Member Functions
	__construct (Zend_Http_Response $response=null, Zend_Oauth_Http_Utility $utility=null)
	isValid ()
	getResponse ()
	setTokenSecret ($secret)
	getTokenSecret ()
	setParam ($key, $value)
	setParams (array $params)
	getParam ($key)
	setToken ($token)
	getToken ()
	__get ($key)
	__set ($key, $value)
	toString ()
	__toString ()
	__sleep ()
	__wakeup ()

Data Fields
const	TOKEN_PARAM_KEY = 'oauth_token'
const	TOKEN_SECRET_PARAM_KEY = 'oauth_token_secret'
const	TOKEN_PARAM_CALLBACK_CONFIRMED = 'oauth_callback_confirmed'

Protected Member Functions
	_parseParameters (Zend_Http_Response $response)

Protected Attributes
	$_params = array()
	$_response = null
	$_httpUtility = null

Detailed Description

Definition at line 31 of file Token.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Zend_Http_Response	$response = null,
		Zend_Oauth_Http_Utility	$utility = null
	)

Constructor; basic setup for any Token subclass.

Parameters

null | Zend_Http_Response	$response
null | Zend_Oauth_Http_Utility	$utility

Returns

void

Definition at line 67 of file Token.php.

      {
        if ($response !== null) {
            $this->_response = $response;
            $params = $this->_parseParameters($response);
            if (count($params) > 0) {
                $this->setParams($params);
            }
        }
        if ($utility !== null) {
            $this->_httpUtility = $utility;
        } else {
            $this->_httpUtility = new Zend_Oauth_Http_Utility;
        }
    }

Member Function Documentation

__get()

__get

(

$key

)

Generic accessor to enable access as public properties.

Returns

string

Definition at line 206 of file Token.php.

    {
        return $this->getParam($key);
    }

__set()

__set	(		$key,
			$value
	)

Generic mutator to enable access as public properties.

Parameters

string	$key
string	$value

Returns

void

Definition at line 218 of file Token.php.

    {
        $this->setParam($key, $value);
    }

__sleep()

__sleep

(

)

Limit serialisation stored data to the parameters

Definition at line 271 of file Token.php.

    {
        return array('_params');
    }

__toString()

__toString

(

)

Convert Token to a string, specifically a raw encoded query string. Aliases to self::toString()

Returns

string

Definition at line 239 of file Token.php.

    {
        return $this->toString();
    }

__wakeup()

__wakeup

(

)

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

Definition at line 279 of file Token.php.

    {
        if ($this->_httpUtility === null) {
            $this->_httpUtility = new Zend_Oauth_Http_Utility;
        }
    }

_parseParameters()

_parseParameters ( Zend_Http_Response  $response )

protected

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

Parameters

Zend_Http_Response

$response

Returns

array

Definition at line 251 of file Token.php.

    {
        $params = array();
        $body   = $response->getBody();
        if (empty($body)) {
            return;
        }

        // validate body based on acceptable characters...todo
        $parts = explode('&', $body);
        foreach ($parts as $kvpair) {
            $pair = explode('=', $kvpair);
            $params[rawurldecode($pair[0])] = rawurldecode($pair[1]);
        }
        return $params;
    }

getParam()

getParam

(

$key

)

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

Parameters

string

$key

Returns

mixed

Definition at line 171 of file Token.php.

    {
        if (isset($this->_params[$key])) {
            return $this->_params[$key];
        }
        return null;
    }

getResponse()

getResponse

(

)

Return the HTTP response object used to initialise this instance.

Returns

Zend_Http_Response

Definition at line 107 of file Token.php.

    {
        return $this->_response;
    }

getToken()

getToken

(

)

Gets the value for a Token.

Returns

string

Definition at line 196 of file Token.php.

    {
        return $this->getParam(self::TOKEN_PARAM_KEY);
    }

getTokenSecret()

getTokenSecret

(

)

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

Returns

string

Definition at line 131 of file Token.php.

    {
        return $this->getParam(self::TOKEN_SECRET_PARAM_KEY);
    }

isValid()

isValid

(

)

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

Returns

bool

Definition at line 91 of file Token.php.

    {
        if (isset($this->_params[self::TOKEN_PARAM_KEY])
            && !empty($this->_params[self::TOKEN_PARAM_KEY])
            && isset($this->_params[self::TOKEN_SECRET_PARAM_KEY])
        ) {
            return true;
        }
        return false;
    }

setParam()

setParam	(		$key,
			$value
	)

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

Parameters

string	$key
string	$value

Returns

Zend_Oauth_Token

Definition at line 144 of file Token.php.

    {
        $this->_params[$key] = trim($value, "\n");
        return $this;
    }

setParams()

setParams

(

array

$params

)

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

Parameters

array

$params

Returns

Zend_Oauth_Token

Definition at line 157 of file Token.php.

    {
        foreach ($params as $key=>$value) {
            $this->setParam($key, $value);
        }
        return $this;
    }

setToken()

setToken

(

$token

)

Sets the value for a Token.

Parameters

string

$token

Returns

Zend_Oauth_Token

Definition at line 185 of file Token.php.

    {
        $this->setParam(self::TOKEN_PARAM_KEY, $token);
        return $this;
    }

setTokenSecret()

setTokenSecret

(

$secret

)

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

Parameters

string

$secret

Returns

Zend_Oauth_Token

Definition at line 119 of file Token.php.

    {
        $this->setParam(self::TOKEN_SECRET_PARAM_KEY, $secret);
        return $this;
    }

toString()

toString

(

)

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

Returns

string

Definition at line 228 of file Token.php.

    {
        return $this->_httpUtility->toEncodedQueryString($this->_params);
    }

Field Documentation

$_httpUtility

$_httpUtility = null

protected

Definition at line 58 of file Token.php.

$_params

$_params = array()

protected

Definition at line 46 of file Token.php.

$_response

$_response = null

protected

Definition at line 53 of file Token.php.

TOKEN_PARAM_CALLBACK_CONFIRMED

const TOKEN_PARAM_CALLBACK_CONFIRMED = 'oauth_callback_confirmed'

Definition at line 38 of file Token.php.

TOKEN_PARAM_KEY

const TOKEN_PARAM_KEY = 'oauth_token'

+ Token constants

Definition at line 36 of file Token.php.

TOKEN_SECRET_PARAM_KEY

const TOKEN_SECRET_PARAM_KEY = 'oauth_token_secret'

Definition at line 37 of file Token.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Oauth/Token.php