Zend_Oauth_Consumer Class Reference

Inheritance diagram for Zend_Oauth_Consumer:

Public Member Functions
	__construct ($options=null)
	getRequestToken (array $customServiceParameters=null, $httpMethod=null, Zend_Oauth_Http_RequestToken $request=null)
	getRedirectUrl (array $customServiceParameters=null, Zend_Oauth_Token_Request $token=null, Zend_Oauth_Http_UserAuthorization $redirect=null)
	redirect (array $customServiceParameters=null, Zend_Oauth_Token_Request $token=null, Zend_Oauth_Http_UserAuthorization $request=null)
	getAccessToken ( $queryData, Zend_Oauth_Token_Request $token, $httpMethod=null, Zend_Oauth_Http_AccessToken $request=null)
	getLastRequestToken ()
	getLastAccessToken ()
	getToken ()
	__call ($method, array $args)

Data Fields
	$switcheroo = false
Data Fields inherited from Zend_Oauth
const	REQUEST_SCHEME_HEADER = 'header'
const	REQUEST_SCHEME_POSTBODY = 'postbody'
const	REQUEST_SCHEME_QUERYSTRING = 'querystring'
const	GET = 'GET'
const	POST = 'POST'
const	PUT = 'PUT'
const	DELETE = 'DELETE'
const	HEAD = 'HEAD'
const	OPTIONS = 'OPTIONS'

Protected Attributes
	$_requestToken = null
	$_accessToken = null
	$_config = null

Additional Inherited Members
Static Public Member Functions inherited from Zend_Oauth
static	setHttpClient (Zend_Http_Client $httpClient)
static	getHttpClient ()
static	clearHttpClient ()
Static Protected Attributes inherited from Zend_Oauth
static	$httpClient = null

Detailed Description

Definition at line 49 of file Consumer.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = null

)

Constructor; create a new object with an optional array|Zend_Config instance containing initialising options.

Parameters

array | Zend_Config

$options

Returns

void

Definition at line 79 of file Consumer.php.

    {
        $this->_config = new Zend_Oauth_Config;
        if ($options !== null) {
            if ($options instanceof Zend_Config) {
                $options = $options->toArray();
            }
            $this->_config->setOptions($options);
        }
    }

Member Function Documentation

__call()

__call	(		$method,
		array	$args
	)

Simple Proxy to the current Zend_Oauth_Config method. It's that instance which holds all configuration methods and values this object also presents as it's API.

Parameters

string	$method
array	$args

Returns

mixed

Exceptions

Zend_Oauth_Exception

if method does not exist in config object

Definition at line 271 of file Consumer.php.

    {
        if (!method_exists($this->_config, $method)) {
            #require_once 'Zend/Oauth/Exception.php';
            throw new Zend_Oauth_Exception('Method does not exist: '.$method);
        }
        return call_user_func_array(array($this->_config,$method), $args);
    }

getAccessToken()

getAccessToken	(		$queryData,
		Zend_Oauth_Token_Request	$token,
			$httpMethod = null,
		Zend_Oauth_Http_AccessToken	$request = null
	)

Retrieve an Access Token in exchange for a previously received/authorized Request Token.

Parameters

array	$queryData	GET data returned in user's redirect from Provider
	Zend_Oauth_Token_Request	Request Token information
string	$httpMethod
Zend_Oauth_Http_AccessToken	$request

Returns

Zend_Oauth_Token_Access

Exceptions

Zend_Oauth_Exception

on invalid authorization token, non-matching response authorization token, or unprovided authorization token

Definition at line 184 of file Consumer.php.

      {
        $authorizedToken = new Zend_Oauth_Token_AuthorizedRequest($queryData);
        if (!$authorizedToken->isValid()) {
            #require_once 'Zend/Oauth/Exception.php';
            throw new Zend_Oauth_Exception(
                'Response from Service Provider is not a valid authorized request token');
        }
        if ($request === null) {
            $request = new Zend_Oauth_Http_AccessToken($this);
        }

        // OAuth 1.0a Verifier
        if ($authorizedToken->getParam('oauth_verifier') !== null) {
            $params = array_merge($request->getParameters(), array(
                'oauth_verifier' => $authorizedToken->getParam('oauth_verifier')
            ));
            $request->setParameters($params);
        }
        if ($httpMethod !== null) {
            $request->setMethod($httpMethod);
        } else {
            $request->setMethod($this->getRequestMethod());
        }
        if (isset($token)) {
            if ($authorizedToken->getToken() !== $token->getToken()) {
                #require_once 'Zend/Oauth/Exception.php';
                throw new Zend_Oauth_Exception(
                    'Authorized token from Service Provider does not match'
                    . ' supplied Request Token details'
                );
            }
        } else {
            #require_once 'Zend/Oauth/Exception.php';
            throw new Zend_Oauth_Exception('Request token must be passed to method');
        }
        $this->_requestToken = $token;
        $this->_accessToken = $request->execute();
        return $this->_accessToken;
    }

getLastAccessToken()

getLastAccessToken

(

)

Return whatever the last Access Token retrieved was while using the current Consumer instance.

Returns

Zend_Oauth_Token_Access

Definition at line 246 of file Consumer.php.

    {
        return $this->_accessToken;
    }

getLastRequestToken()

getLastRequestToken

(

)

Return whatever the last Request Token retrieved was while using the current Consumer instance.

Returns

Zend_Oauth_Token_Request

Definition at line 235 of file Consumer.php.

    {
        return $this->_requestToken;
    }

getRedirectUrl()

getRedirectUrl	(	array	$customServiceParameters = null,
		Zend_Oauth_Token_Request	$token = null,
		Zend_Oauth_Http_UserAuthorization	$redirect = null
	)

After a Request Token is retrieved, the user may be redirected to the OAuth Provider to authorize the application's access to their protected resources - the redirect URL being provided by this method. Once the user has authorized the application for access, they are redirected back to the application which can now exchange the previous Request Token for a fully authorized Access Token.

Parameters

null | array	$customServiceParameters
null | Zend_Oauth_Token_Request	$token
null | Zend_OAuth_Http_UserAuthorization	$redirect

Returns

string

Definition at line 132 of file Consumer.php.

      {
        if ($redirect === null) {
            $redirect = new Zend_Oauth_Http_UserAuthorization($this, $customServiceParameters);
        } elseif($customServiceParameters !== null) {
            $redirect->setParameters($customServiceParameters);
        }
        if ($token !== null) {
            $this->_requestToken = $token;
        }
        return $redirect->getUrl();
    }

getRequestToken()

getRequestToken	(	array	$customServiceParameters = null,
			$httpMethod = null,
		Zend_Oauth_Http_RequestToken	$request = null
	)

Attempts to retrieve a Request Token from an OAuth Provider which is later exchanged for an authorized Access Token used to access the protected resources exposed by a web service API.

Parameters

null | array	$customServiceParameters	Non-OAuth Provider-specified parameters
null | string	$httpMethod
null | Zend_Oauth_Http_RequestToken	$request

Returns

Zend_Oauth_Token_Request

Definition at line 100 of file Consumer.php.

      {
        if ($request === null) {
            $request = new Zend_Oauth_Http_RequestToken($this, $customServiceParameters);
        } elseif($customServiceParameters !== null) {
            $request->setParameters($customServiceParameters);
        }
        if ($httpMethod !== null) {
            $request->setMethod($httpMethod);
        } else {
            $request->setMethod($this->getRequestMethod());
        }
        $this->_requestToken = $request->execute();
        return $this->_requestToken;
    }

getToken()

getToken

(

)

Alias to self::getLastAccessToken()

Returns

Zend_Oauth_Token_Access

Definition at line 256 of file Consumer.php.

    {
        return $this->_accessToken;
    }

redirect()

redirect	(	array	$customServiceParameters = null,
		Zend_Oauth_Token_Request	$token = null,
		Zend_Oauth_Http_UserAuthorization	$request = null
	)

Rather than retrieve a redirect URL for use, e.g. from a controller, one may perform an immediate redirect.

Sends headers and exit()s on completion.

Parameters

null | array	$customServiceParameters
null | Zend_Oauth_Token_Request	$token
null | Zend_Oauth_Http_UserAuthorization	$request

Returns

void

Definition at line 159 of file Consumer.php.

      {
        if ($token instanceof Zend_Oauth_Http_UserAuthorization) {
            $request = $token;
            $token = null;
        }
        $redirectUrl = $this->getRedirectUrl($customServiceParameters, $token, $request);
        header('Location: ' . $redirectUrl);
        exit(1);
    }

Field Documentation

$_accessToken

$_accessToken = null

protected

Definition at line 65 of file Consumer.php.

$_config

$_config = null

protected

Definition at line 70 of file Consumer.php.

$_requestToken

$_requestToken = null

protected

Definition at line 58 of file Consumer.php.

$switcheroo

$switcheroo = false

Definition at line 51 of file Consumer.php.

---

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

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