Oauth/Consumer.php
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Oauth
- Version
- $Id$
Package: Zend_Oauth- Parent(s)
- \Zend_Oauth
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
$switcheroo = falseDefault valuefalseDetails- Type
- n/a
Methods
__call(string $method, array $args) : mixedSimple 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 | |
|---|
ReturnsThrows getAccessToken(array $queryData, $token, string $httpMethod = null, \Zend_Oauth_Http_AccessToken $request = null) : \Zend_Oauth_Token_AccessRetrieve 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 | | |
|---|
| $httpMethod | string | |
|---|
| $request | \Zend_Oauth_Http_AccessToken | |
|---|
ReturnsThrows| Exception | Description |
|---|
| \Zend_Oauth_Exception | on invalid authorization token, non-matching response authorization token, or unprovided authorization token |
getRedirectUrl(null | array $customServiceParameters = null, null | \Zend_Oauth_Token_Request $token = null, null | \Zend_OAuth_Http_UserAuthorization $redirect = null) : stringAfter 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.
ParametersReturnsgetRequestToken(null | array $customServiceParameters = null, null | string $httpMethod = null, null | \Zend_Oauth_Http_RequestToken $request = null) : \Zend_Oauth_Token_RequestAttempts 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 redirect(null | array $customServiceParameters = null, null | \Zend_Oauth_Token_Request $token = null, null | \Zend_Oauth_Http_UserAuthorization $request = null) : voidRather 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 
inherited
Classes