Zend_Oauth_Token_Access Class Reference

Inheritance diagram for Zend_Oauth_Token_Access:

Public Member Functions
	toHeader ( $url, Zend_Oauth_Config_ConfigInterface $config, array $customParams=null, $realm=null)
	toQueryString ($url, Zend_Oauth_Config_ConfigInterface $config, array $params=null)
	getHttpClient (array $oauthOptions, $uri=null, $config=null, $excludeCustomParamsFromHeader=true)
Public Member Functions inherited from Zend_Oauth_Token
	__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 ()

Additional Inherited Members
Data Fields inherited from Zend_Oauth_Token
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 inherited from Zend_Oauth_Token
	_parseParameters (Zend_Http_Response $response)
Protected Attributes inherited from Zend_Oauth_Token
	$_params = array()
	$_response = null
	$_httpUtility = null

Detailed Description

Definition at line 40 of file Access.php.

Member Function Documentation

getHttpClient()

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

Definition at line 93 of file Access.php.

    {
        $client = new Zend_Oauth_Client($oauthOptions, $uri, $config, $excludeCustomParamsFromHeader);
        $client->setToken($this);
        return $client;
    }

toHeader()

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

Definition at line 51 of file Access.php.

      {
        if (!Zend_Uri::check($url)) {
            #require_once 'Zend/Oauth/Exception.php';
            throw new Zend_Oauth_Exception(
                '\'' . $url . '\' is not a valid URI'
            );
        }
        $params = $this->_httpUtility->assembleParams($url, $config, $customParams);
        return $this->_httpUtility->toAuthorizationHeader($params, $realm);
    }

toQueryString()

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

Definition at line 72 of file Access.php.

    {
        if (!Zend_Uri::check($url)) {
            #require_once 'Zend/Oauth/Exception.php';
            throw new Zend_Oauth_Exception(
                '\'' . $url . '\' is not a valid URI'
            );
        }
        $params = $this->_httpUtility->assembleParams($url, $config, $params);
        return $this->_httpUtility->toEncodedQueryString($params);
    }

---

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

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