Gdata/ClientLogin.php
inherited
Classes
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 [email protected] 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: ClientLogin.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Gdata_ClientLogin
Class to facilitate Google's "Account Authentication for Installed Applications" also known as "ClientLogin".
- See
- \global\http://code.google.com/apis/accounts/AuthForInstalledApps.html
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants
CLIENTLOGIN_URI
= 'https://www.google.com/accounts/ClientLogin'The Google client login URI
DEFAULT_SOURCE
= 'Zend-ZendFramework'The default 'source' parameter to send to Google
Methods
getHttpClient(string $email, string $password, string $service = 'xapi', \Zend_Gdata_HttpClient $client = null, string $source = self::DEFAULT_SOURCE, string $loginToken = null, string $loginCaptcha = null, $loginUri = self::CLIENTLOGIN_URI, string $accountType = 'HOSTED_OR_GOOGLE') : \Zend_Gdata_HttpClientSet Google authentication credentials.
Must be done before trying to do any Google Data operations that require authentication. For example, viewing private data, or posting or deleting entries.
| Name | Type | Description |
|---|---|---|
| string | ||
| $password | string | |
| $service | string | |
| $client | \Zend_Gdata_HttpClient | |
| $source | string | |
| $loginToken | string | The token identifier as provided by the server. |
| $loginCaptcha | string | The user's response to the CAPTCHA challenge. |
| $loginUri | ||
| $accountType | string | An optional string to identify whether the account to be authenticated is a google or a hosted account. Defaults to 'HOSTED_OR_GOOGLE'. See: http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html#Request |
| Type | Description |
|---|---|
| \Zend_Gdata_HttpClient |
| Exception | Description |
|---|---|
| \Zend_Gdata_App_AuthException | |
| \Zend_Gdata_App_HttpException | |
| \Zend_Gdata_App_CaptchaRequiredException |