From 06f945f27840b53e57795dadbc38e76f7e11ab1c Mon Sep 17 00:00:00 2001 From: Horus3 Date: Mon, 24 Feb 2014 16:42:14 +0100 Subject: init --- .../api/core/files/Gdata.AuthSub.html | 79 ++++++++++++++++++++++ 1 file changed, 79 insertions(+) create mode 100644 zend/documentation/api/core/files/Gdata.AuthSub.html (limited to 'zend/documentation/api/core/files/Gdata.AuthSub.html') diff --git a/zend/documentation/api/core/files/Gdata.AuthSub.html b/zend/documentation/api/core/files/Gdata.AuthSub.html new file mode 100644 index 0000000..a8aeadc --- /dev/null +++ b/zend/documentation/api/core/files/Gdata.AuthSub.html @@ -0,0 +1,79 @@ + +Zend Gdata API Documentation

Gdata/AuthSub.php

+ Show: + PublicProtectedPrivateinherited
+ Table of Contents +
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.

Category
Zend +   +
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com) +   +
License
New BSD License +   +
Package
Zend_Gdata +   +
Subpackage
Gdata +   +
Version
$Id: AuthSub.php 24593 2012-01-05 20:35:02Z matthew $ +   +

\Zend_Gdata_AuthSub
jump to top

Package: Zend\Gdata\Gdata
Wrapper around Zend_Http_Client to facilitate Google's "Account Authentication +Proxy for Web-Based Applications".
See
\global\http://code.google.com/apis/accounts/AuthForWebApps.html +   +
Category
Zend +   +
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com) +   +
License
New BSD License +   +

Constants

>VConstant  + AUTHSUB_REQUEST_URI + = 'https://www.google.com/accounts/AuthSubRequest'
>VConstant  + AUTHSUB_SESSION_TOKEN_URI + = 'https://www.google.com/accounts/AuthSubSessionToken'
>VConstant  + AUTHSUB_REVOKE_TOKEN_URI + = 'https://www.google.com/accounts/AuthSubRevokeToken'
>VConstant  + AUTHSUB_TOKEN_INFO_URI + = 'https://www.google.com/accounts/AuthSubTokenInfo'

Methods

methodpublicAuthSubRevokeToken(string $token, \Zend_Http_Client $client = null, string $request_uri = self::AUTHSUB_REVOKE_TOKEN_URI) : boolean
static

Revoke a token

Parameters
NameTypeDescription
$tokenstring

The token to revoke

$client\Zend_Http_Client

(optional) HTTP client to use to make the request

+
$request_uristring

(optional) URI to which to direct the revokation request

+
Returns
TypeDescription
booleanWhether the revokation was successful
Throws
ExceptionDescription
\Zend_Gdata_App_HttpException
methodpublicgetAuthSubSessionToken(string $token, \Zend_Http_Client $client = null, string $request_uri = self::AUTHSUB_SESSION_TOKEN_URI) : string
static

Upgrades a single use token to a session token

Parameters
NameTypeDescription
$tokenstring

The single use token which is to be upgraded

$client\Zend_Http_Client

(optional) HTTP client to use to + make the request

+
$request_uristring

(optional) URI to which to direct + the session token upgrade

+
Returns
TypeDescription
stringThe upgraded token value
Throws
ExceptionDescription
\Zend_Gdata_App_AuthException
\Zend_Gdata_App_HttpException
methodpublicgetAuthSubTokenInfo(string $token, \Zend_Http_Client $client = null, string $request_uri = self::AUTHSUB_TOKEN_INFO_URI) : void
static

get token information

Parameters
NameTypeDescription
$tokenstring

The token to retrieve information about

$client\Zend_Http_Client

(optional) HTTP client to use to + make the request

+
$request_uristring

(optional) URI to which to direct + the information request

+
methodpublicgetAuthSubTokenUri(string $next, string $scope, int $secure = 0, int $session = 0, string $request_uri = self::AUTHSUB_REQUEST_URI) : void
static

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

Parameters
NameTypeDescription
$nextstring

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

+
$scopestring

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

+
$secureint

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

+
$sessionint

(optional) Boolean flag indicating whether + the one-time-use token may be exchanged for + a session token (1) or not (0).

+
$request_uristring

(optional) URI to which to direct the + authentication request.

+
methodpublicgetHttpClient(string $token, \Zend_Gdata_HttpClient $client = null) : void
static

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

Parameters
NameTypeDescription
$tokenstring

The token to retrieve information about

$client\Zend_Gdata_HttpClient

(optional) HTTP client to use to make the request

+
+ Documentation was generated by + phpDocumentor + 2.0.0a12. + -- cgit v1.2.3