Oauth/Consumer.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Oauth
version: $Id: Consumer.php 22475 2010-06-20 18:25:36Z padraic $
Classes: Zend_Oauth_Consumer

Description

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.

Zend_Oauth_Consumer
jump to top

Extends from: Zend_Oauth
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Oauth
Properties: $switcheroo; $_requestToken; $_accessToken; $_config
Methods: __construct; getRequestToken; getRedirectUrl; redirect; getAccessToken; getLastRequestToken; getLastAccessToken; getToken; __call

Description

Properties

$_accessToken
jump to class

Zend_Oauth_Token_Access $_accessToken = 'null'

Access token retrieved from OAuth Provider

Details

$_accessToken: Zend_Oauth_Token_Access
visibility: protected
default: null
final: false
static: false

$_config
jump to class

Zend_Oauth_Config $_config = 'null'

Details

$_config: Zend_Oauth_Config
visibility: protected
default: null
final: false
static: false

$_requestToken
jump to class

Zend_Oauth_Token_Request $_requestToken = 'null'

Request Token retrieved from OAuth Provider

Details

$_requestToken: Zend_Oauth_Token_Request
visibility: protected
default: null
final: false
static: false

$switcheroo
jump to class

$switcheroo = 'false'

Details

visibility: public
default: false
final: false
static: false

Methods

__call
jump to class

__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.

Arguments

$method: string
$args: array

Output

mixed

Details

visibility: public
final: false
static: false
throws: if method does not exist in config object

__construct
jump to class

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

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

Arguments

$options: arrayZend_Config

Details

visibility: public
final: false
static: false

getAccessToken
jump to class

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.

Arguments

$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

Output

Zend_Oauth_Token_Access

Details

visibility: public
final: false
static: false
throws: on invalid authorization token, non-matching response authorization token, or unprovided authorization token

getLastAccessToken
jump to class

getLastAccessToken(
          
          )
        
        :
        Zend_Oauth_Token_Access

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

Output

Zend_Oauth_Token_Access

Details

visibility: public
final: false
static: false

getLastRequestToken
jump to class

getLastRequestToken(
          
          )
        
        :
        Zend_Oauth_Token_Request

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

Output

Zend_Oauth_Token_Request

Details

visibility: public
final: false
static: false

getRedirectUrl
jump to class

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.

Arguments

$customServiceParameters: nullarray
$token: nullZend_Oauth_Token_Request
$redirect: nullZend_OAuth_Http_UserAuthorization

Output

string

Details

visibility: public
final: false
static: false

getRequestToken
jump to class

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.

Arguments

$customServiceParameters: nullarray
Non-OAuth Provider-specified parameters
$httpMethod: nullstring
$request: nullZend_Oauth_Http_RequestToken

Output

Zend_Oauth_Token_Request

Details

visibility: public
final: false
static: false

getToken
jump to class

getToken(
          
          )
        
        :
        Zend_Oauth_Token_Access

Alias to self::getLastAccessToken()

Output

Zend_Oauth_Token_Access

Details

visibility: public
final: false
static: false

redirect
jump to class

redirect(
          null|array $customServiceParameters
              =
              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.

Arguments

$customServiceParameters: nullarray
$request: nullZend_Oauth_Http_UserAuthorization

Details

visibility: public
final: false
static: false

API Documentation

Oauth/Consumer.php

Description

Zend_Oauth_Consumerjump to top

Description

Properties

$_accessTokenjump to class

Details

$_configjump to class

Details

$_requestTokenjump to class

Details

$switcheroojump to class

Details

Methods

__calljump to class

Arguments

Output

Details

__constructjump to class

Arguments

Details

getAccessTokenjump to class

Arguments

Output

Details

getLastAccessTokenjump to class

Output

Details

getLastRequestTokenjump to class

Output

Details

getRedirectUrljump to class

Arguments

Output

Details

getRequestTokenjump to class

Arguments

Output

Details

getTokenjump to class

Output

Details

redirectjump to class

Arguments

Details

Zend_Oauth_Consumer
jump to top

$_accessToken
jump to class

$_config
jump to class

$_requestToken
jump to class

$switcheroo
jump to class

__call
jump to class

__construct
jump to class

getAccessToken
jump to class

getLastAccessToken
jump to class

getLastRequestToken
jump to class

getRedirectUrl
jump to class

getRequestToken
jump to class

getToken
jump to class

redirect
jump to class