Class Zend_Gdata_AuthSub

Description

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

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


	
			
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, [ $client = null])
 static void getAuthSubSessionToken (string $token, [ $client = null])
 static void getAuthSubTokenInfo (string $token, [ $client = null])
 static void getAuthSubTokenUri (string $next, string $scope, [int $secure = 0], [int $session = 0])
 static void getHttpClient ( $token, [ $client = null])
Methods
static AuthSubRevokeToken (line 132)

Revoke a token

  • throws: Zend_Gdata_HttpException
  • access: public
static boolean AuthSubRevokeToken (string $token, [ $client = null])
  • string $token
  • $client
static getAuthSubSessionToken (line 91)

Upgrades a single use token to a session token

  • throws: Zend_Gdata_AuthException
  • throws: Zend_Gdata_HttpException
  • access: public
static void getAuthSubSessionToken (string $token, [ $client = null])
  • string $token
  • $client
static getAuthSubTokenInfo (line 164)

get token information

  • access: public
static void getAuthSubTokenInfo (string $token, [ $client = null])
  • string $token
  • $client
static getAuthSubTokenUri (line 74)

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 $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).
static getHttpClient (line 185)
  • access: public
static void getHttpClient ( $token, [ $client = null])
  • $token
  • $client
Class Constants
AUTHSUB_REQUEST_URI = 'https://www.google.com/accounts/AuthSubRequest' (line 51)
AUTHSUB_REVOKE_TOKEN_URI = 'https://www.google.com/accounts/AuthSubRevokeToken' (line 55)
AUTHSUB_SESSION_TOKEN_URI = 'https://www.google.com/accounts/AuthSubSessionToken' (line 53)
AUTHSUB_TOKEN_INFO_URI = 'https://www.google.com/accounts/AuthSubTokenInfo' (line 57)

Documentation generated on Sat, 05 May 2007 11:52:31 -0700 by phpDocumentor 1.3.2