Oauth/Consumer.php

Show:

inherited

Classes
- \Zend_Oauth_Consumer

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Oauth
Version: $Id: Consumer.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Oauth_Consumer
jump to top

Package: Zend\Oauth

Parent(s): \Zend_Oauth
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                REQUEST_SCHEME_HEADER
                = 'header'

inheritedInherited from: \Zend_Oauth::REQUEST_SCHEME_HEADER

Inherited_from: \Zend_Oauth::REQUEST_SCHEME_HEADER

 
                REQUEST_SCHEME_POSTBODY
                = 'postbody'

inheritedInherited from: \Zend_Oauth::REQUEST_SCHEME_POSTBODY

Inherited_from: \Zend_Oauth::REQUEST_SCHEME_POSTBODY

 
                REQUEST_SCHEME_QUERYSTRING
                = 'querystring'

inheritedInherited from: \Zend_Oauth::REQUEST_SCHEME_QUERYSTRING

Inherited_from: \Zend_Oauth::REQUEST_SCHEME_QUERYSTRING

 
                GET
                = 'GET'

inheritedInherited from: \Zend_Oauth::GET

Inherited_from: \Zend_Oauth::GET

 
                POST
                = 'POST'

inheritedInherited from: \Zend_Oauth::POST

Inherited_from: \Zend_Oauth::POST

 
                PUT
                = 'PUT'

inheritedInherited from: \Zend_Oauth::PUT

Inherited_from: \Zend_Oauth::PUT

 
                DELETE
                = 'DELETE'

inheritedInherited from: \Zend_Oauth::DELETE

Inherited_from: \Zend_Oauth::DELETE

 
                HEAD
                = 'HEAD'

inheritedInherited from: \Zend_Oauth::HEAD

Inherited_from: \Zend_Oauth::HEAD

 
                OPTIONS
                = 'OPTIONS'

inheritedInherited from: \Zend_Oauth::OPTIONS

Inherited_from: \Zend_Oauth::OPTIONS

Properties

\Zend_Oauth_Token_Access $_accessToken = null

Access token retrieved from OAuth Provider

Default valuenullDetails

Type: \Zend_Oauth_Token_Access

\Zend_Oauth_Config $_config = null

Default valuenullDetails

Type: \Zend_Oauth_Config

\Zend_Oauth_Token_Request $_requestToken = null

Request Token retrieved from OAuth Provider

Default valuenullDetails

Type: \Zend_Oauth_Token_Request

\Zend_Http_Client $httpClient = null

staticinherited

Singleton instance if required of the HTTP client

Inherited from: \Zend_Oauth::$$httpClient

Default valuenullDetails

Type: \Zend_Http_Client
Inherited_from: \Zend_Oauth::$$httpClient

$switcheroo = false

Default valuefalseDetails

Type: n/a

Methods

__call(string $method, array $args) : mixed

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

Name	Type	Description
$method	string
$args	array

Returns

Type	Description
mixed

Throws

Exception	Description
\Zend_Oauth_Exception	if method does not exist in config object

__construct(array | \Zend_Config $options = null) : void

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

Parameters

Name	Type	Description
$options	array \| \Zend_Config

clearHttpClient() : void

staticinherited

Simple mechanism to delete the entire singleton HTTP Client instance which forces an new instantiation for subsequent requests.

Inherited from: \Zend_Oauth::clearHttpClient()

getAccessToken(array $queryData, \Zend_Oauth_Token_Request $token, string $httpMethod = null, \Zend_Oauth_Http_AccessToken $request = null) : \Zend_Oauth_Token_Access

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

Parameters

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

Returns

Type	Description
\Zend_Oauth_Token_Access

Throws

Exception	Description
\Zend_Oauth_Exception	on invalid authorization token, non-matching response authorization token, or unprovided authorization token

getHttpClient() : \Zend_Http_Client

staticinherited

Return the singleton instance of the HTTP Client.

Inherited from: \Zend_Oauth::getHttpClient()

Note that the instance is reset and cleared of previous parameters and Authorization header values.

Returns

Type	Description
\Zend_Http_Client

getLastAccessToken() : \Zend_Oauth_Token_Access

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

Returns

Type	Description
\Zend_Oauth_Token_Access

getLastRequestToken() : \Zend_Oauth_Token_Request

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

Returns

Type	Description
\Zend_Oauth_Token_Request

getRedirectUrl(null | array $customServiceParameters = null, null | \Zend_Oauth_Token_Request $token = null, null | \Zend_OAuth_Http_UserAuthorization $redirect = null) : string

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

Name	Type	Description
$customServiceParameters	null \| array
$token	null \| \Zend_Oauth_Token_Request
$redirect	null \| \Zend_OAuth_Http_UserAuthorization

Returns

Type	Description
string

getRequestToken(null | array $customServiceParameters = null, null | string $httpMethod = null, null | \Zend_Oauth_Http_RequestToken $request = null) : \Zend_Oauth_Token_Request

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

Name	Type	Description
$customServiceParameters	null \| array	Non-OAuth Provider-specified parameters
$httpMethod	null \| string
$request	null \| \Zend_Oauth_Http_RequestToken

Returns

Type	Description
\Zend_Oauth_Token_Request

getToken() : \Zend_Oauth_Token_Access

Alias to self::getLastAccessToken()

Returns

Type	Description
\Zend_Oauth_Token_Access

redirect(null | array $customServiceParameters = null, null | \Zend_Oauth_Token_Request $token = null, null | \Zend_Oauth_Http_UserAuthorization $request = null) : void

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

Name	Type	Description
$customServiceParameters	null \| array
$token	null \| \Zend_Oauth_Token_Request
$request	null \| \Zend_Oauth_Http_UserAuthorization

setHttpClient(\Zend_Http_Client $httpClient) : void

staticinherited

Allows the external environment to make Zend_Oauth use a specific Client instance.

Inherited from: \Zend_Oauth::setHttpClient()

Parameters

Name	Type	Description
$httpClient	\Zend_Http_Client

Oauth/Consumer.php

\Zend_Oauth_Consumerjump to top

Constants

Properties

Methods

\Zend_Oauth_Consumer
jump to top