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.
Wrapper around Zend_Http_Client to facilitate Google's "Account Authentication Proxy for Web-Based Applications".

AuthSubRevokeToken( string $token, \Zend_Http_Client $client
= null, string $request_uri = self ) : boolean
Revoke a token
Name | Type | Description |
---|---|---|
$token | string | The token to revoke |
$client | \Zend_Http_Client |
(optional) HTTP client to use to make the request |
$request_uri | string |
(optional) URI to which to direct the revokation request |
Type | Description |
---|---|
boolean | Whether the revokation was successful |
Exception | Description |
---|---|
\Zend_Gdata_App_HttpException |

getAuthSubSessionToken( string $token, \Zend_Http_Client $client
= null, string $request_uri = self ) : string
Upgrades a single use token to a session token
Name | Type | Description |
---|---|---|
$token | string | The single use token which is to be upgraded |
$client | \Zend_Http_Client |
(optional) HTTP client to use to make the request |
$request_uri | string |
(optional) URI to which to direct the session token upgrade |
Type | Description |
---|---|
string | The upgraded token value |
Exception | Description |
---|---|
\Zend_Gdata_App_AuthException | |
\Zend_Gdata_App_HttpException |

getAuthSubTokenInfo( string $token, \Zend_Http_Client $client
= null, string $request_uri = self ) : void
get token information
Name | Type | Description |
---|---|---|
$token | string | The token to retrieve information about |
$client | \Zend_Http_Client |
(optional) HTTP client to use to make the request |
$request_uri | string |
(optional) URI to which to direct the information request |

getAuthSubTokenUri( string $next, string $scope, int $secure
= 0, int $session = 0, string $request_uri = self ) : void
Creates a URI to request a single-use AuthSub token.
Name | Type | Description |
---|---|---|
$next | string |
(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. |
$scope | string |
(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. |
$secure | int |
(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. |
$session | int |
(optional) Boolean flag indicating whether the one-time-use token may be exchanged for a session token (1) or not (0). |
$request_uri | string |
(optional) URI to which to direct the authentication request. |

getHttpClient( string $token, \Zend_Gdata_HttpClient $client
= null ) : void
Retrieve a HTTP client object with AuthSub credentials attached as the Authorization header
Name | Type | Description |
---|---|---|
$token | string | The token to retrieve information about |
$client | \Zend_Gdata_HttpClient |
(optional) HTTP client to use to make the request |