blob: 58b8f01ab759c200ae74eba44d45913e747b5d0f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Zend Gdata API Documentation</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta><link rel="stylesheet" href="../css/template.css" type="text/css"></link><script type="text/javascript" src="../js/jquery-1.4.2.min.js"></script><script type="text/javascript" src="../js/jquery.tools.min.js"></script><script type="text/javascript" src="../js/jquery-ui-1.8.2.custom.min.js"></script><script type="text/javascript" src="../js/template.js"></script></head><body><div id="content"><h1 class="file">Gdata/ClientLogin.php</h1><div id="file-nav-box"><div id="file-nav-options">
Show:
<img src="../images/icons/visibility_public.png" alt="Public" id="show-public"></img><img src="../images/icons/visibility_protected.png" alt="Protected" id="show-protected"></img><img src="../images/icons/visibility_private.png" alt="Private" id="show-private"></img><span class="attribute" id="show-inherited">inherited</span></div><div id="file-nav-container"><ul id="file-nav"><li><a href="#classes"><img src="../images/icons/class.png" alt="Class" height="14"></img>
Classes
</a><ul><li><a href="#\Zend_Gdata_ClientLogin">\Zend_Gdata_ClientLogin</a></li></ul></li></ul><div style="clear: left;"></div></div><div id="file-nav-tab">
Table of Contents
</div></div><a name="top" class="anchor"></a><div id="file-description"><div class="short-description">Zend Framework</div><div class="long-description"><p>LICENSE</p>
<p>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.</p></div></div><dl class="file-info"><dt>Category</dt><dd>Zend
</dd><dt>Copyright</dt><dd>Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
</dd><dt>License</dt><dd><a href="http://framework.zend.com/license/new-bsd">New BSD License</a>
</dd><dt>Package</dt><dd>Zend_Gdata
</dd><dt>Subpackage</dt><dd>Gdata
</dd><dt>Version</dt><dd>$Id: ClientLogin.php 24593 2012-01-05 20:35:02Z matthew $
</dd></dl><a name="classes" class="anchor"></a><a id="\Zend_Gdata_ClientLogin" class="anchor"></a><h2 class="class">\Zend_Gdata_ClientLogin<div class="to-top"><a href="#top">jump to top</a></div></h2><div class="class"><small class="package"><b>Package: </b>Zend\Gdata\Gdata</small><div class="short-description">Class to facilitate Google's "Account Authentication
for Installed Applications" also known as "ClientLogin".</div><div class="long-description"></div><dl class="class-info"><dt>See</dt><dd>\global\http://code.google.com/apis/accounts/AuthForInstalledApps.html
</dd><dt>Category</dt><dd>Zend
</dd><dt>Copyright</dt><dd>Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
</dd><dt>License</dt><dd><a href="http://framework.zend.com/license/new-bsd">New BSD License</a>
</dd></dl><h3>Constants</h3><div><a id="\Zend_Gdata_ClientLogin::CLIENTLOGIN_URI" class="anchor"></a><div class="constant publicC"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/constant.png" alt="Constant"></img>
<span class="highlight">CLIENTLOGIN_URI</span>
= 'https://www.google.com/accounts/ClientLogin'</code><div class="description"><div class="short-description">The Google client login URI</div></div><div class="code-tabs"><div class="long-description"></div></div><div class="clear"></div></div><a id="\Zend_Gdata_ClientLogin::DEFAULT_SOURCE" class="anchor"></a><div class="constant publicC"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/constant.png" alt="Constant"></img>
<span class="highlight">DEFAULT_SOURCE</span>
= 'Zend-ZendFramework'</code><div class="description"><div class="short-description">The default 'source' parameter to send to Google</div></div><div class="code-tabs"><div class="long-description"></div></div><div class="clear"></div></div></div><h3>Methods</h3><div><a id="\Zend_Gdata_ClientLogin::getHttpClient()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getHttpClient</span><span class="nb-faded-text">(string $email, string $password, string $service = 'xapi', <a href="../files/Gdata.HttpClient.html#\Zend_Gdata_HttpClient">\Zend_Gdata_HttpClient</a> $client = null, string $source = self::DEFAULT_SOURCE, string $loginToken = null, string $loginCaptcha = null, $loginUri = self::CLIENTLOGIN_URI, string $accountType = 'HOSTED_OR_GOOGLE')</span> : <a href="../files/Gdata.HttpClient.html#\Zend_Gdata_HttpClient">\Zend_Gdata_HttpClient</a></code><div class="description"><span class="attribute">static</span><p class="short_description">Set Google authentication credentials.</p></div><div class="code-tabs"><div class="long-description"><p>Must be done before trying to do any Google Data operations that
require authentication.
For example, viewing private data, or posting or deleting entries.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$email</th><td>string</td><td><em></em></td></tr><tr><th>$password</th><td>string</td><td><em></em></td></tr><tr><th>$service</th><td>string</td><td><em></em></td></tr><tr><th>$client</th><td><a href="../files/Gdata.HttpClient.html#\Zend_Gdata_HttpClient">\Zend_Gdata_HttpClient</a></td><td><em></em></td></tr><tr><th>$source</th><td>string</td><td><em></em></td></tr><tr><th>$loginToken</th><td>string</td><td><em><p>The token identifier as provided by the server.</p></em></td></tr><tr><th>$loginCaptcha</th><td>string</td><td><em><p>The user's response to the CAPTCHA challenge.</p>
</em></td></tr><tr><th>$loginUri</th><td></td><td><em></em></td></tr><tr><th>$accountType</th><td>string</td><td><em><p>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</p>
</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.HttpClient.html#\Zend_Gdata_HttpClient">\Zend_Gdata_HttpClient</a></td><td></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.AuthException.html#\Zend_Gdata_App_AuthException">\Zend_Gdata_App_AuthException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.CaptchaRequiredException.html#\Zend_Gdata_App_CaptchaRequiredException">\Zend_Gdata_App_CaptchaRequiredException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div></div></div></div><small class="footer">
Documentation was generated by
<a href="http://phpdoc.org">phpDocumentor
2.0.0a12</a>.
</small></body></html>
|
