API Documentation

Zend/Oauth/Consumer.php

Show: inherited
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 license@zend.com 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 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Oauth_Consumer

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  

Properties

Propertyprotected\Zend_Oauth_Token_Access  $_accessToken= 'null'

Access token retrieved from OAuth Provider

Default valuenullDetails
Type
\Zend_Oauth_Token_Access
Propertyprotected\Zend_Oauth_Config  $_config= 'null'

Default valuenullDetails
Type
\Zend_Oauth_Config
Propertyprotected\Zend_Oauth_Token_Request  $_requestToken= 'null'

Request Token retrieved from OAuth Provider

Default valuenullDetails
Type
\Zend_Oauth_Token_Request
Propertypublic  $switcheroo= 'false'
Default valuefalseDetails
Type

Methods

methodpublic__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
methodpublic__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
methodpublicgetAccessToken( 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
methodpublicgetLastAccessToken( ) : \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
methodpublicgetLastRequestToken( ) : \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
methodpublicgetRedirectUrl( 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
methodpublicgetRequestToken( 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
methodpublicgetToken( ) : \Zend_Oauth_Token_Access

Alias to self::getLastAccessToken()

Returns
Type Description
\Zend_Oauth_Token_Access
methodpublicredirect( 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
Documentation was generated by DocBlox 0.15.1.