API Documentation

Gdata/AuthSub.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Gdata
subpackage
Gdata
version
$Id: AuthSub.php 24061 2011-05-28 17:25:04Z adamlundrigan $
Classes
Zend_Gdata_AuthSub

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_Gdata_AuthSub
jump to top

category
Zend
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Gdata
see
http://code.google.com/apis/accounts/AuthForWebApps.html
subpackage
Gdata
Constants
AUTHSUB_REQUEST_URI
AUTHSUB_SESSION_TOKEN_URI
AUTHSUB_REVOKE_TOKEN_URI
AUTHSUB_TOKEN_INFO_URI
Methods
getAuthSubTokenUri
getAuthSubSessionToken
AuthSubRevokeToken
getAuthSubTokenInfo
getHttpClient

Description

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

Constants

AUTHSUB_REQUEST_URI
jump to class

 AUTHSUB_REQUEST_URI = 'https://www.google.com/accounts/AuthSubRequest'

Details

value
https://www.google.com/accounts/AuthSubRequest

AUTHSUB_SESSION_TOKEN_URI
jump to class

 AUTHSUB_SESSION_TOKEN_URI = 'https://www.google.com/accounts/AuthSubSessionToken'

Details

value
https://www.google.com/accounts/AuthSubSessionToken

AUTHSUB_REVOKE_TOKEN_URI
jump to class

 AUTHSUB_REVOKE_TOKEN_URI = 'https://www.google.com/accounts/AuthSubRevokeToken'

Details

value
https://www.google.com/accounts/AuthSubRevokeToken

AUTHSUB_TOKEN_INFO_URI
jump to class

 AUTHSUB_TOKEN_INFO_URI = 'https://www.google.com/accounts/AuthSubTokenInfo'

Details

value
https://www.google.com/accounts/AuthSubTokenInfo

Methods

AuthSubRevokeToken
jump to class

AuthSubRevokeToken( string $token, Zend_Http_Client $client = null, string $request_uri = self ) : boolean

Revoke a token

Arguments
$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
Output
boolean
Whether the revokation was successful
Details
visibility
public
final
false
static
true
throws

getAuthSubSessionToken
jump to class

getAuthSubSessionToken( string $token, Zend_Http_Client $client = null, string $request_uri = self ) : string

Upgrades a single use token to a session token

Arguments
$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
Output
string
The upgraded token value
Details
visibility
public
final
false
static
true
throws
throws

getAuthSubTokenInfo
jump to class

getAuthSubTokenInfo( string $token, Zend_Http_Client $client = null, string $request_uri = self ) :

get token information

Arguments
$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
Details
visibility
public
final
false
static
true

getAuthSubTokenUri
jump to class

getAuthSubTokenUri( string $next, string $scope, int $secure = 0, int $session = 0, string $request_uri = self ) :

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

Arguments
$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.
Details
visibility
public
final
false
static
true

getHttpClient
jump to class

getHttpClient( string $token, Zend_Gdata_HttpClient $client = null ) :

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

Arguments
$token
string
The token to retrieve information about
$client
Zend_Gdata_HttpClient
(optional) HTTP client to use to make the request
Details
visibility
public
final
false
static
true
Documentation was generated by DocBlox.