## Zend_Gdata_AuthSub

Description

Wrapper around Zend_Http_Client to facilitate Google's "Account Authentication Proxy for Web-Based Applications".

- copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- see: http://code.google.com/apis/accounts/AuthForWebApps.html
- license: New BSD License

Located in /Gdata/AuthSub.php (line 46)

Class Constant Summary
AUTHSUB_REQUEST_URI = 'https://www.google.com/accounts/AuthSubRequest'
AUTHSUB_REVOKE_TOKEN_URI = 'https://www.google.com/accounts/AuthSubRevokeToken'
AUTHSUB_SESSION_TOKEN_URI = 'https://www.google.com/accounts/AuthSubSessionToken'
AUTHSUB_TOKEN_INFO_URI = 'https://www.google.com/accounts/AuthSubTokenInfo'
Method Summary
static boolean AuthSubRevokeToken (string $token, [Zend_Http_Client $client = null], [string $request_uri = self::AUTHSUB_REVOKE_TOKEN_URI])
static string getAuthSubSessionToken (string $token, [Zend_Http_Client $client = null], [string $request_uri = self::AUTHSUB_SESSION_TOKEN_URI])
static void getAuthSubTokenInfo (string $token, [Zend_Http_Client $client = null], [string $request_uri = self::AUTHSUB_TOKEN_INFO_URI])
static void getAuthSubTokenUri (string $next, string $scope, [int $secure = 0], [int $session = 0], [string $request_uri = self::AUTHSUB_REQUEST_URI])
static void getHttpClient (string $token, [Zend_Gdata_HttpClient $client = null])
Methods
static AuthSubRevokeToken (line 152)

Revoke a token

- return: Whether the revokation was successful
- throws: Zend_Gdata_App_HttpException
- access: public

static boolean AuthSubRevokeToken (string $token, [Zend_Http_Client $client = null], [string $request_uri = self::AUTHSUB_REVOKE_TOKEN_URI])

- string $token: The token to revoke
- Zend_Http_Client $client: (optional) HTTP client to use to make the request
- string $request_uri: (optional) URI to which to direct the revokation request

static getAuthSubSessionToken (line 102)

Upgrades a single use token to a session token

- return: The upgraded token value
- throws: Zend_Gdata_App_AuthException
- throws: Zend_Gdata_App_HttpException
- access: public

static string getAuthSubSessionToken (string $token, [Zend_Http_Client $client = null], [string $request_uri = self::AUTHSUB_SESSION_TOKEN_URI])

- string $token: The single use token which is to be upgraded
- Zend_Http_Client $client: (optional) HTTP client to use to make the request
- string $request_uri: (optional) URI to which to direct the session token upgrade

static getAuthSubTokenInfo (line 194)

get token information

- access: public

static void getAuthSubTokenInfo (string $token, [Zend_Http_Client $client = null], [string $request_uri = self::AUTHSUB_TOKEN_INFO_URI])

- string $token: The token to retrieve information about
- Zend_Http_Client $client: (optional) HTTP client to use to make the request
- string $request_uri: (optional) URI to which to direct the information request

static getAuthSubTokenUri (line 79)

Creates a URI to request a single-use AuthSub token.

- access: public

static void getAuthSubTokenUri (string $next, string $scope, [int $secure = 0], [int $session = 0], [string $request_uri = self::AUTHSUB_REQUEST_URI])

- string $next: (required) URL identifying the service to be accessed. The resulting token will enable access to the specified service only. Some services may limit scope further, such as read-only access.
- string $scope: (required) URL identifying the service to be accessed. The resulting token will enable access to the specified service only. Some services may limit scope further, such as read-only access.
- int $secure: (optional) Boolean flag indicating whether the authentication transaction should issue a secure token (1) or a non-secure token (0). Secure tokens are available to registered applications only.
- int $session: (optional) Boolean flag indicating whether the one-time-use token may be exchanged for a session token (1) or not (0).
- string $request_uri: (optional) URI to which to direct the authentication request.

static getHttpClient (line 227)

Retrieve a HTTP client object with AuthSub credentials attached as the Authorization header

- access: public

static void getHttpClient (string $token, [Zend_Gdata_HttpClient $client = null])

- string $token: The token to retrieve information about
- Zend_Gdata_HttpClient $client: (optional) HTTP client to use to make the request

Class Constants
AUTHSUB_REQUEST_URI = 'https://www.google.com/accounts/AuthSubRequest' (line 49)
AUTHSUB_REVOKE_TOKEN_URI = 'https://www.google.com/accounts/AuthSubRevokeToken' (line 53)
AUTHSUB_SESSION_TOKEN_URI = 'https://www.google.com/accounts/AuthSubSessionToken' (line 51)
AUTHSUB_TOKEN_INFO_URI = 'https://www.google.com/accounts/AuthSubTokenInfo' (line 55)

Documentation generated on Tue, 26 Oct 2010 20:08:25 +0400 by phpDocumentor 1.4.2